schema: version schema-cloud-config-v1.json

[blackboxsw]

Provide top-level versions.schema.cloud-config.json which will be
published to https://github.com/SchemaStore/schemastore/ and provided
for external json validator tools.

Move static JSON schema files into cloudinit/config/schemas/.
Rename cloud-init-schema.json to schema-cloud-config-v1.json to allow
space for providing static scoped schema definitions for vendor-data,
meta-data and network-config in the future.

Proposed Commit Message

Provide top-level version.schema.cloud-config.json which will be
consumed by https://github.com/SchemaStore/schemastore/ and provided
for json validator tooling.

Rename cloud-init-schema.json to schema-cloud-config-v1.json to allow
space for providing static scoped schema definitions for vendor-data,
meta-data and network-config in the future.

Additional Context

This PR follows the suggested naming conventions and versioning best-practices for adding an out-of-tree
schema definition for schemastore.org.

It attempts to follow the contributing guidelines for non-local schema definitions as well as guidance for multi-version support

Test Steps

tox -e py3
PYTHONPATH=. python3 -m cloudinit.cmd.main schema --docs all
echo > bogus.yaml << EOF
#cloud-config
users: somethingbroken
EOF
PYTHONPATH=. python3 -m cloudinit.cmd.main schema --annotate -c bogus.yaml

Checklist:

• My code follows the process laid out in the documentation
• I have updated or added any unit tests accordingly
• I have updated or added any documentation accordingly

[blackboxsw]

Thanks for the review @BigBlueHundids.

[TheRealFalcon]

Looks good, thanks!

[aciba90]

LGTM thank you.

As an optional nit, I think it would be more clear and concise if we refactor test_versioned_cloud_config_schema_is_valid_json to something like:

diff --git a/tests/unittests/config/test_schema.py b/tests/unittests/config/test_schema.py
index c75b7227..5a7cafce 100644
--- a/tests/unittests/config/test_schema.py
+++ b/tests/unittests/config/test_schema.py
@@ -106,11 +106,25 @@ class TestVersionedSchemas:
         full_path_schema["oneOf"][0]["allOf"][1]["$ref"] = file_ref
         return full_path_schema
 
+    def validate_cloudconfig_schema_safe(self, schema, version_schema):
+        try:
+            validate_cloudconfig_schema(
+                schema, schema=version_schema, strict=True
+            )
+        except jsonschema.exceptions.RefResolutionError:
+            full_path_schema = self._relative_ref_to_local_file_path(
+                version_schema
+            )
+            validate_cloudconfig_schema(
+                schema, schema=full_path_schema, strict=True
+            )
+
     @pytest.mark.parametrize(
         "schema,error_msg",
         (
             ({}, None),
             ({"version": "v1"}, None),
             ({"version": "v2"}, "is not valid"),
             ({"version": "v1", "final_message": -1}, "is not valid"),
             ({"version": "v1", "final_message": "some msg"}, None),
@@ -128,30 +142,10 @@ class TestVersionedSchemas:
         version_schema["$id"] = f"file://{version_schemafile}"
         if error_msg:
             with pytest.raises(SchemaValidationError) as context_mgr:
-                try:
-                    validate_cloudconfig_schema(
-                        schema, schema=version_schema, strict=True
-                    )
-                except jsonschema.exceptions.RefResolutionError:
-                    full_path_schema = self._relative_ref_to_local_file_path(
-                        version_schema
-                    )
-                    validate_cloudconfig_schema(
-                        schema, schema=full_path_schema, strict=True
-                    )
+                self.validate_cloudconfig_schema_safe(schema, version_schema)
             assert error_msg in str(context_mgr.value)
         else:
-            try:
-                validate_cloudconfig_schema(
-                    schema, schema=version_schema, strict=True
-                )
-            except jsonschema.exceptions.RefResolutionError:
-                full_path_schema = self._relative_ref_to_local_file_path(
-                    version_schema
-                )
-                validate_cloudconfig_schema(
-                    schema, schema=full_path_schema, strict=True
-                )
+            self.validate_cloudconfig_schema_safe(schema, version_schema)

[aciba90]

Could we also tests version == 22.2 please?

Suggested change

	({"version": "v1"}, None),
	({"version": "v1"}, None),
	({"version": "22.2"}, None),