Replace meta version with galaxy_info.standalone (#387)

As ansible does not allow adding new properties as root of meta files,
we introduce a `galaxy_info.standalone` field, of type bool, so we
can distinguish between a standalone role and a collection one.

Author: ssbarnea

f/ansible-meta.json

@@ -400,8 +400,19 @@
       "title": "FreeBSDPlatformModel",
       "type": "object"
     },
-    "GalaxyInfoModel-v1": {
+    "GalaxyInfoModel": {
       "additionalProperties": false,
+      "else": {
+        "$comment": "If standalone is false, then we have a collection role and only description is required",
+        "required": ["description"]
+      },
+      "if": {
+        "properties": {
+          "standalone": {
+            "const": true
+          }
+        }
+      },
       "properties": {
         "author": {
           "title": "Author",
@@ -454,14 +465,23 @@
           "pattern": "^[a-z][a-z0-9_]+$",
           "title": "Role Name",
           "type": "string"
+        },
+        "standalone": {
+          "description:": "Set to true for old standalone roles, or false for new collection roles.",
+          "title": "Standalone",
+          "type": "boolean"
         }
       },
-      "required": [
-        "description",
-        "license",
-        "min_ansible_version",
-        "platforms"
-      ],
+      "then": {
+        "$comment": "Standalone role, so we require several fields.",
+        "required": [
+          "standalone",
+          "description",
+          "license",
+          "min_ansible_version",
+          "platforms"
+        ]
+      },
       "title": "GalaxyInfoModel for old standalone role (v1)",
       "type": "object"
     },
@@ -486,7 +506,8 @@
         },
         "platforms": {
           "$ref": "#/$defs/platforms"
-        }
+        },
+        "standalone": { "const": false }
       },
       "required": ["description"],
       "title": "GalaxyInfoModel for role within a collection (v2)",
@@ -1281,79 +1302,6 @@
       "title": "Platforms",
       "type": "array"
     },
-    "v1": {
-      "additionalProperties": false,
-      "properties": {
-        "allow_duplicates": {
-          "title": "Allow Duplicates",
-          "type": "boolean"
-        },
-        "cloud_platforms": {
-          "items": {
-            "enum": [
-              "amazon",
-              "azure",
-              "centurylink",
-              "google",
-              "openstack",
-              "ovirt",
-              "rackspace",
-              "vmware"
-            ],
-            "type": "string"
-          },
-          "markdownDescription": "Which cloud platforms are supported, existing values can be gathered using the [API](https://galaxy.ansible.com/api/v1/cloud_platforms/)",
-          "title": "Cloud Platforms",
-          "type": "array"
-        },
-        "collections": {
-          "$ref": "#/$defs/collections"
-        },
-        "dependencies": {
-          "items": {
-            "$ref": "#/$defs/DependencyModel"
-          },
-          "title": "Dependencies",
-          "type": "array"
-        },
-        "galaxy_info": {
-          "$ref": "#/$defs/GalaxyInfoModel-v1"
-        },
-        "version": {
-          "const": 1
-        }
-      },
-      "required": ["version"],
-      "title": "Meta Schema v1 (standalone role)",
-      "type": "object"
-    },
-    "v2": {
-      "additionalProperties": false,
-      "properties": {
-        "allow_duplicates": {
-          "title": "Allow Duplicates",
-          "type": "boolean"
-        },
-        "collections": {
-          "$ref": "#/$defs/collections"
-        },
-        "dependencies": {
-          "items": {
-            "$ref": "#/$defs/DependencyModel"
-          },
-          "title": "Dependencies",
-          "type": "array"
-        },
-        "galaxy_info": {
-          "$ref": "#/$defs/GalaxyInfoModel-v2"
-        },
-        "version": {
-          "const": 2
-        }
-      },
-      "title": "Meta Schema v2 (role inside collection)",
-      "type": "object"
-    },
     "vCenterPlatformModel": {
       "properties": {
         "name": {
@@ -1395,26 +1343,28 @@
   },
   "$id": "https://raw.githubusercontent.com/ansible/schemas/main/f/ansible-meta.json",
   "$schema": "http://json-schema.org/draft-07/schema",
-  "else": {
-    "$ref": "#/$defs/v2"
-  },
   "examples": ["meta/main.yml"],
-  "if": {
-    "properties": {
-      "version": {
-        "const": 1
-      }
-    }
-  },
   "properties": {
-    "version": {
-      "enum": [1, 2],
-      "type": "integer"
+    "additionalProperties": false,
+    "allow_duplicates": {
+      "title": "Allow Duplicates",
+      "type": "boolean"
+    },
+    "collections": {
+      "$ref": "#/$defs/collections"
+    },
+    "dependencies": {
+      "items": {
+        "$ref": "#/$defs/DependencyModel"
+      },
+      "title": "Dependencies",
+      "type": "array"
+    },
+    "galaxy_info": {
+      "$ref": "#/$defs/GalaxyInfoModel"
     }
   },
-  "then": {
-    "$ref": "#/$defs/v1"
-  },
+  "required": ["galaxy_info"],
   "title": "Ansible Meta Schema v1/v2",
   "type": "object"
 }

negative_test/roles/empty_meta/meta/main.yml.md

@@ -2,24 +2,6 @@
 
 ```json
 [
-  {
-    "instancePath": "",
-    "keyword": "type",
-    "message": "must be object",
-    "params": {
-      "type": "object"
-    },
-    "schemaPath": "#/type"
-  },
-  {
-    "instancePath": "",
-    "keyword": "if",
-    "message": "must match \"then\" schema",
-    "params": {
-      "failingKeyword": "then"
-    },
-    "schemaPath": "#/if"
-  },
   {
     "instancePath": "",
     "keyword": "type",
@@ -40,12 +22,6 @@ stdout:
 {
   "status": "fail",
   "errors": [
-    {
-      "filename": "negative_test/roles/empty_meta/meta/main.yml",
-      "path": "$",
-      "message": "None is not of type 'object'",
-      "has_sub_errors": false
-    },
     {
       "filename": "negative_test/roles/empty_meta/meta/main.yml",
       "path": "$",

negative_test/roles/meta/main.yml.md

@@ -3,22 +3,31 @@
 ```json
 [
   {
-    "instancePath": "/galaxy_info/galaxy_tags",
-    "keyword": "type",
-    "message": "must be array",
+    "instancePath": "/galaxy_info",
+    "keyword": "required",
+    "message": "must have required property 'standalone'",
     "params": {
-      "type": "array"
+      "missingProperty": "standalone"
     },
-    "schemaPath": "#/properties/galaxy_tags/type"
+    "schemaPath": "#/then/required"
   },
   {
-    "instancePath": "",
+    "instancePath": "/galaxy_info",
     "keyword": "if",
     "message": "must match \"then\" schema",
     "params": {
       "failingKeyword": "then"
     },
     "schemaPath": "#/if"
+  },
+  {
+    "instancePath": "/galaxy_info/galaxy_tags",
+    "keyword": "type",
+    "message": "must be array",
+    "params": {
+      "type": "array"
+    },
+    "schemaPath": "#/properties/galaxy_tags/type"
   }
 ]
 ```
@@ -31,6 +40,12 @@ stdout:
 {
   "status": "fail",
   "errors": [
+    {
+      "filename": "negative_test/roles/meta/main.yml",
+      "path": "$.galaxy_info",
+      "message": "'standalone' is a required property",
+      "has_sub_errors": false
+    },
     {
       "filename": "negative_test/roles/meta/main.yml",
       "path": "$.galaxy_info.galaxy_tags",

negative_test/roles/meta_invalid_collection/meta/main.yml.md

@@ -12,11 +12,29 @@
     "schemaPath": "#/$defs/collections/items/pattern"
   },
   {
-    "instancePath": "",
+    "instancePath": "/galaxy_info",
+    "keyword": "required",
+    "message": "must have required property 'standalone'",
+    "params": {
+      "missingProperty": "standalone"
+    },
+    "schemaPath": "#/then/required"
+  },
+  {
+    "instancePath": "/galaxy_info",
+    "keyword": "required",
+    "message": "must have required property 'min_ansible_version'",
+    "params": {
+      "missingProperty": "min_ansible_version"
+    },
+    "schemaPath": "#/then/required"
+  },
+  {
+    "instancePath": "/galaxy_info",
     "keyword": "if",
-    "message": "must match \"else\" schema",
+    "message": "must match \"then\" schema",
     "params": {
-      "failingKeyword": "else"
+      "failingKeyword": "then"
     },
     "schemaPath": "#/if"
   }
@@ -36,6 +54,18 @@ stdout:
       "path": "$.collections[0]",
       "message": "'foo' does not match '^[a-z_]+\\\\.[a-z_]+$'",
       "has_sub_errors": false
+    },
+    {
+      "filename": "negative_test/roles/meta_invalid_collection/meta/main.yml",
+      "path": "$.galaxy_info",
+      "message": "'standalone' is a required property",
+      "has_sub_errors": false
+    },
+    {
+      "filename": "negative_test/roles/meta_invalid_collection/meta/main.yml",
+      "path": "$.galaxy_info",
+      "message": "'min_ansible_version' is a required property",
+      "has_sub_errors": false
     }
   ],
   "parse_errors": []

negative_test/roles/meta_invalid_collections/meta/main.yml.md

@@ -12,11 +12,29 @@
     "schemaPath": "#/$defs/collections/items/pattern"
   },
   {
-    "instancePath": "",
+    "instancePath": "/galaxy_info",
+    "keyword": "required",
+    "message": "must have required property 'standalone'",
+    "params": {
+      "missingProperty": "standalone"
+    },
+    "schemaPath": "#/then/required"
+  },
+  {
+    "instancePath": "/galaxy_info",
+    "keyword": "required",
+    "message": "must have required property 'min_ansible_version'",
+    "params": {
+      "missingProperty": "min_ansible_version"
+    },
+    "schemaPath": "#/then/required"
+  },
+  {
+    "instancePath": "/galaxy_info",
     "keyword": "if",
-    "message": "must match \"else\" schema",
+    "message": "must match \"then\" schema",
     "params": {
-      "failingKeyword": "else"
+      "failingKeyword": "then"
     },
     "schemaPath": "#/if"
   }
@@ -36,6 +54,18 @@ stdout:
       "path": "$.collections[0]",
       "message": "'FOO.BAR' does not match '^[a-z_]+\\\\.[a-z_]+$'",
       "has_sub_errors": false
+    },
+    {
+      "filename": "negative_test/roles/meta_invalid_collections/meta/main.yml",
+      "path": "$.galaxy_info",
+      "message": "'standalone' is a required property",
+      "has_sub_errors": false
+    },
+    {
+      "filename": "negative_test/roles/meta_invalid_collections/meta/main.yml",
+      "path": "$.galaxy_info",
+      "message": "'min_ansible_version' is a required property",
+      "has_sub_errors": false
     }
   ],
   "parse_errors": []