meta: make the standalone field optional (#389)

ansible · Sep 18, 2022 · 069dcca · 069dcca
1 parent 68da105
commit 069dcca
Show file tree

Hide file tree

Showing 16 changed files with 180 additions and 112 deletions.
diff --git a/f/ansible-meta.json b/f/ansible-meta.json
@@ -402,17 +402,54 @@
     },
     "GalaxyInfoModel": {
       "additionalProperties": false,
+      "allOf": [
+        {
+          "if": {
+            "properties": {
+              "standalone": {
+                "const": true
+              }
+            }
+          },
+          "then": {
+            "$comment": "Standalone role, so we require several fields.",
+            "required": [
+              "author",
+              "standalone",
+              "description",
+              "license",
+              "min_ansible_version"
+            ]
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "standalone": {
+                "const": false
+              }
+            }
+          },
+          "then": {
+            "$comment": "Collection roles do not use most galaxy fields.",
+            "not": {
+              "required": [
+                "cloud_platforms",
+                "galaxy_tags",
+                "min_ansible_version",
+                "namespace",
+                "platforms",
+                "role_name"
+              ]
+            },
+            "required": ["standalone", "description"]
+          }
+        }
+      ],
       "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",
@@ -472,17 +509,7 @@
           "type": "boolean"
         }
       },
-      "then": {
-        "$comment": "Standalone role, so we require several fields.",
-        "required": [
-          "standalone",
-          "description",
-          "license",
-          "min_ansible_version",
-          "platforms"
-        ]
-      },
-      "title": "GalaxyInfoModel for old standalone role (v1)",
+      "title": "GalaxyInfoModel",
       "type": "object"
     },
     "GalaxyInfoModel-v2": {

diff --git a/negative_test/roles/meta/main.yml b/negative_test/roles/meta/main.yml
@@ -1,4 +1,3 @@
-version: 1
 galaxy_info:
   description: bar
   min_ansible_version: "2.9"

diff --git a/negative_test/roles/meta/main.yml.md b/negative_test/roles/meta/main.yml.md
@@ -2,14 +2,23 @@
 
 ```json
 [
+  {
+    "instancePath": "/galaxy_info",
+    "keyword": "required",
+    "message": "must have required property 'author'",
+    "params": {
+      "missingProperty": "author"
+    },
+    "schemaPath": "#/allOf/0/then/required"
+  },
   {
     "instancePath": "/galaxy_info",
     "keyword": "required",
     "message": "must have required property 'standalone'",
     "params": {
       "missingProperty": "standalone"
     },
-    "schemaPath": "#/then/required"
+    "schemaPath": "#/allOf/0/then/required"
   },
   {
     "instancePath": "/galaxy_info",
@@ -18,7 +27,25 @@
     "params": {
       "failingKeyword": "then"
     },
-    "schemaPath": "#/if"
+    "schemaPath": "#/allOf/0/if"
+  },
+  {
+    "instancePath": "/galaxy_info",
+    "keyword": "required",
+    "message": "must have required property 'standalone'",
+    "params": {
+      "missingProperty": "standalone"
+    },
+    "schemaPath": "#/allOf/1/then/required"
+  },
+  {
+    "instancePath": "/galaxy_info",
+    "keyword": "if",
+    "message": "must match \"then\" schema",
+    "params": {
+      "failingKeyword": "then"
+    },
+    "schemaPath": "#/allOf/1/if"
   },
   {
     "instancePath": "/galaxy_info/galaxy_tags",
@@ -40,6 +67,18 @@ stdout:
 {
   "status": "fail",
   "errors": [
+    {
+      "filename": "negative_test/roles/meta/main.yml",
+      "path": "$.galaxy_info",
+      "message": "'author' is a required property",
+      "has_sub_errors": false
+    },
+    {
+      "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",

diff --git a/negative_test/roles/meta_invalid_collection/meta/main.yml b/negative_test/roles/meta_invalid_collection/meta/main.yml
@@ -1,7 +1,7 @@
-version: 2 # <-- role inside a collection
 collections:
   - foo # invalid pattern
 galaxy_info:
+  standalone: false # role inside a collection
   description: foo
   license: bar
   platforms:

diff --git a/negative_test/roles/meta_invalid_collection/meta/main.yml.md b/negative_test/roles/meta_invalid_collection/meta/main.yml.md
@@ -10,33 +10,6 @@
       "pattern": "^[a-z_]+\\.[a-z_]+$"
     },
     "schemaPath": "#/$defs/collections/items/pattern"
-  },
-  {
-    "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 \"then\" schema",
-    "params": {
-      "failingKeyword": "then"
-    },
-    "schemaPath": "#/if"
   }
 ]
 ```
@@ -54,18 +27,6 @@ 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": []

diff --git a/negative_test/roles/meta_invalid_collections/meta/main.yml b/negative_test/roles/meta_invalid_collections/meta/main.yml
@@ -1,7 +1,8 @@
-version: 2 # <-- role inside a collection
+# role inside a collection
 collections:
   - FOO.BAR # invalid pattern, need to use lowercase
 galaxy_info:
+  standalone: false
   description: foo
   license: bar
   platforms:

diff --git a/negative_test/roles/meta_invalid_collections/meta/main.yml.md b/negative_test/roles/meta_invalid_collections/meta/main.yml.md
@@ -10,33 +10,6 @@
       "pattern": "^[a-z_]+\\.[a-z_]+$"
     },
     "schemaPath": "#/$defs/collections/items/pattern"
-  },
-  {
-    "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 \"then\" schema",
-    "params": {
-      "failingKeyword": "then"
-    },
-    "schemaPath": "#/if"
   }
 ]
 ```
@@ -54,18 +27,6 @@ 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": []

diff --git a/negative_test/roles/meta_invalid_role_namespace/meta/main.yml b/negative_test/roles/meta_invalid_role_namespace/meta/main.yml
@@ -1,5 +1,5 @@
 ---
-version: 1 # <-- old standalone role
+# old standalone role
 galaxy_info:
   description: foo
   min_ansible_version: "2.9"

diff --git a/negative_test/roles/meta_invalid_role_namespace/meta/main.yml.md b/negative_test/roles/meta_invalid_role_namespace/meta/main.yml.md
@@ -2,14 +2,23 @@
 
 ```json
 [
+  {
+    "instancePath": "/galaxy_info",
+    "keyword": "required",
+    "message": "must have required property 'author'",
+    "params": {
+      "missingProperty": "author"
+    },
+    "schemaPath": "#/allOf/0/then/required"
+  },
   {
     "instancePath": "/galaxy_info",
     "keyword": "required",
     "message": "must have required property 'standalone'",
     "params": {
       "missingProperty": "standalone"
     },
-    "schemaPath": "#/then/required"
+    "schemaPath": "#/allOf/0/then/required"
   },
   {
     "instancePath": "/galaxy_info",
@@ -18,7 +27,25 @@
     "params": {
       "failingKeyword": "then"
     },
-    "schemaPath": "#/if"
+    "schemaPath": "#/allOf/0/if"
+  },
+  {
+    "instancePath": "/galaxy_info",
+    "keyword": "required",
+    "message": "must have required property 'standalone'",
+    "params": {
+      "missingProperty": "standalone"
+    },
+    "schemaPath": "#/allOf/1/then/required"
+  },
+  {
+    "instancePath": "/galaxy_info",
+    "keyword": "if",
+    "message": "must match \"then\" schema",
+    "params": {
+      "failingKeyword": "then"
+    },
+    "schemaPath": "#/allOf/1/if"
   },
   {
     "instancePath": "/galaxy_info/namespace",
@@ -40,6 +67,18 @@ stdout:
 {
   "status": "fail",
   "errors": [
+    {
+      "filename": "negative_test/roles/meta_invalid_role_namespace/meta/main.yml",
+      "path": "$.galaxy_info",
+      "message": "'author' is a required property",
+      "has_sub_errors": false
+    },
+    {
+      "filename": "negative_test/roles/meta_invalid_role_namespace/meta/main.yml",
+      "path": "$.galaxy_info",
+      "message": "'standalone' is a required property",
+      "has_sub_errors": false
+    },
     {
       "filename": "negative_test/roles/meta_invalid_role_namespace/meta/main.yml",
       "path": "$.galaxy_info",

diff --git a/negative_test/roles/role_with_bad_deps_in_meta/meta/main.yml b/negative_test/roles/role_with_bad_deps_in_meta/meta/main.yml
@@ -1,4 +1,4 @@
-version: 1 # <-- old standalone role
+# old standalone role
 galaxy_info:
   description: bar
   min_ansible_version: "2.9"