Investigate switching to jsonschema for validating the bundle in image-gather script

[kimwnasptd]

Context

This is a follow-up of #1038 (comment)

The current logic will validate the whole bundle beforehand by:

1. Parsing all the applications in the bundle
2. Check if it has the correct metadata

If not it will fail.

A proposal from @DnPlas was to use jsonschema instead for doing the validation which we can investigate.

What needs to get done

1. Create the most simple jsonschema for validating the necessary metadata
2. Understand when we should switch to this schema

With some hacky tinkering I managed to create the following schema:

schema = {
  "type": "object",
  "required": ["bundle", "name", "docs", "applications"],
  "properties": {
    "bundle": {"type": "string"},
    "name": {"type": "string"},
    "docs": {"type": "string", "format": "uri"},
    "applications": {
      "type": "object",
      "patternProperties": {
        "^.*": {
          "type": "object",
          "required": ["charm", "channel", "trust", "scale"],
          "properties": {
            "charm": {"type": "string"},
            "channel": {"type": "string"},
            "trust": {"type": "boolean"},
            "scale": {"type": "integer"},
            "_github_repo_name": {"type": "string"},
            "_github_repo_branch": {"type": "string"},
          },
          "oneOf": [
            {"required": ["_github_repo_name", "_github_repo_branch"]},
            {"required": ["_github_dependency_repo_name", "_github_dependency_repo_branch"]}
          ]
        }
      }
    }
  }
}

Definition of Done

We have a clear jsonschema for the bundle and decide if we want to switch to this approach

[syncronize-issues-to-jira]

Thank you for reporting us your feedback!

The internal ticket has been created: https://warthogs.atlassian.net/browse/KF-6210.

This message was autogenerated