Validation Tool to follow the Catalog Structure

[PuneetPunamiya]

Expected Behavior

1. Each resource should follow the following structure

    ./task/         👈 the kind of the resource 
      
      /argocd       👈 definition file must have same name
        /0.1
          /OWNERS     👈 owners of this ressource
          /README.md     
          /argocd.yaml   👈 the file name must be resource name
          /samples/deploy-to-k8s.yaml
        /0.2/...
     
     /golang-build
        /0.1
          /README.md
          /golang-build.yaml
          /samples/golang-build.yaml

• NOTE : The resource name and the directory name should match

2. Resource YAML file should include the following changes

• Labels include the version of the resource.
• Annotations include
  • minimum pipeline version supported by the resource
  • tags associated with the resource
  • displayName of the resource

  
labels:
  app.kubernetes.io/version: "0.1"            👈 version of the resource
  
annotations:
  tekton.dev/pipelines.minVersion: "0.12.1"   👈 will work from x version  of pipeline
  tekton.dev/tags: "ansible, cli"                        👈 Comma separated list of tags 
  tekton.dev/displayName: "Ansible Tower Cli"  👈 displayName can be optional   
  
spec:
description: |-
  ansible-tower-cli task simplifies 
  workflow, jobs, manage users...   👈 # Summary
  
  Ansible Tower (formerly ‘AWX’) is a ...

Actual Behavior

• API breakage
• No concept of versions
• Are the Resources valid
• No field to mention Minimum Pipeline Version

[wumaxd]

@PuneetPunamiya Regarding 1.
How about creating a list of changed directories (./task/<dir>) based on the CHANGED_FILES in the presubmit-tests.sh (

catalog/vendor/github.com/tektoncd/plumbing/scripts/presubmit-tests.sh

Line 79 in a0e2d1e

CHANGED_FILES="$(list_changed_files)"

).
Based on this list check if for each version a task exists (./task/<dir>/<version>/<dir>.yml) and if a README exists (./task/<dir>/<version>/README.md). Would you want to see more enforced?

I would do this using a bash if/else like this

if [ ! -f "$FILE" ]; then
    echo "$FILE does not exist."
fi

If this is fine, I would be happy to take this task.

Regarding 2.
We could do a hack by transforming the yaml to json first and then apply a schema.

Something like

ruby -ryaml -rjson -e 'puts JSON.pretty_generate(YAML.load(ARGF))' < test.yml > test.json && ajv validate -s ./schema.json -d test.json; rm test.json

The solution would not be nice but a quick try to enforce some kind of schema on the yaml files.

[vdemeester]

/cc @sthaha who also started to work on this I think 😉