Schema a d (#1211)

Migrate from legacy schema or define new schema in
cloud-init-schema.json, adding extensive schema tests for:
- cc_apt_configure
- cc_bootcmd
- cc_byobu
- cc_ca_certs
- cc_chef
- cc_debug
- cc_disable_ec2_metadata
- cc_disk_setup

Deprecate config hyphenated schema keys in favor of underscores:
  - ca_certs and ca_certs.remove_defaults instead of
    ca-certs and ca-certs.remove-defaults

- Continue to honor deprecated config keys but emit DEPRECATION
  warnings in logs for continued use of the deprecated keys:
  - apt_sources key
  - any apt v1 or v2 keys
  - use or ca-certs or ca_certs.remove-defaults

- Extend apt_configure schema
   - Define more strict schema below object opaque keys using
     patternProperties
  -  create common $def apt_configure.mirror for reuse in 'primary'
     and 'security' schema definitions within cc_apt_configure

 Co-Authored-by: James Falcon <james.falcon@canonical.com>

1 files changed, 202 insertions, 0 deletions

diff --git a/tests/unittests/config/test_cc_apt_configure.py b/tests/unittests/config/test_cc_apt_configure.py
new file mode 100644
index 00000000..bd1bb963
--- /dev/null
+++ b/tests/unittests/config/test_cc_apt_configure.py
@@ -0,0 +1,202 @@
+# This file is part of cloud-init. See LICENSE file for license information.
+
+""" Tests for cc_apt_configure module """
+
+import re
+
+import pytest
+
+from cloudinit.config.schema import (
+    SchemaValidationError,
+    get_schema,
+    validate_cloudconfig_schema,
+)
+from tests.unittests.helpers import skipUnlessJsonSchema
+
+
+class TestAPTConfigureSchema:
+    @pytest.mark.parametrize(
+        "config, error_msg",
+        (
+            # Supplement valid schemas from examples tested in test_schema
+            ({"apt": {"preserve_sources_list": True}}, None),
+            # Invalid schemas
+            (
+                {"apt": "nonobject"},
+                "apt: 'nonobject' is not of type 'object",
+            ),
+            (
+                {"apt": {"boguskey": True}},
+                re.escape(
+                    "apt: Additional properties are not allowed"
+                    " ('boguskey' was unexpected)"
+                ),
+            ),
+            ({"apt": {}}, "apt: {} does not have enough properties"),
+            (
+                {"apt": {"preserve_sources_list": 1}},
+                "apt.preserve_sources_list: 1 is not of type 'boolean'",
+            ),
+            (
+                {"apt": {"disable_suites": 1}},
+                "apt.disable_suites: 1 is not of type 'array'",
+            ),
+            (
+                {"apt": {"disable_suites": []}},
+                re.escape("apt.disable_suites: [] is too short"),
+            ),
+            (
+                {"apt": {"disable_suites": [1]}},
+                "apt.disable_suites.0: 1 is not of type 'string'",
+            ),
+            (
+                {"apt": {"disable_suites": ["a", "a"]}},
+                re.escape(
+                    "apt.disable_suites: ['a', 'a'] has non-unique elements"
+                ),
+            ),
+            # All apt: primary tests are applicable for "security" key too.
+            # Those apt:security tests are exercised in the unittest below
+            (
+                {"apt": {"primary": "nonlist"}},
+                "apt.primary: 'nonlist' is not of type 'array'",
+            ),
+            (
+                {"apt": {"primary": []}},
+                re.escape("apt.primary: [] is too short"),
+            ),
+            (
+                {"apt": {"primary": ["nonobj"]}},
+                "apt.primary.0: 'nonobj' is not of type 'object'",
+            ),
+            (
+                {"apt": {"primary": [{}]}},
+                "apt.primary.0: 'arches' is a required property",
+            ),
+            (
+                {"apt": {"primary": [{"boguskey": True}]}},
+                re.escape(
+                    "apt.primary.0: Additional properties are not allowed"
+                    " ('boguskey' was unexpected)"
+                ),
+            ),
+            (
+                {"apt": {"primary": [{"arches": True}]}},
+                "apt.primary.0.arches: True is not of type 'array'",
+            ),
+            (
+                {"apt": {"primary": [{"uri": True}]}},
+                "apt.primary.0.uri: True is not of type 'string'",
+            ),
+            (
+                {
+                    "apt": {
+                        "primary": [
+                            {"arches": ["amd64"], "search": "non-array"}
+                        ]
+                    }
+                },
+                "apt.primary.0.search: 'non-array' is not of type 'array'",
+            ),
+            (
+                {"apt": {"primary": [{"arches": ["amd64"], "search": []}]}},
+                re.escape("apt.primary.0.search: [] is too short"),
+            ),
+            (
+                {
+                    "apt": {
+                        "primary": [{"arches": ["amd64"], "search_dns": "a"}]
+                    }
+                },
+                "apt.primary.0.search_dns: 'a' is not of type 'boolean'",
+            ),
+            (
+                {"apt": {"primary": [{"arches": ["amd64"], "keyid": 1}]}},
+                "apt.primary.0.keyid: 1 is not of type 'string'",
+            ),
+            (
+                {"apt": {"primary": [{"arches": ["amd64"], "key": 1}]}},
+                "apt.primary.0.key: 1 is not of type 'string'",
+            ),
+            (
+                {"apt": {"primary": [{"arches": ["amd64"], "keyserver": 1}]}},
+                "apt.primary.0.keyserver: 1 is not of type 'string'",
+            ),
+            (
+                {"apt": {"add_apt_repo_match": True}},
+                "apt.add_apt_repo_match: True is not of type 'string'",
+            ),
+            (
+                {"apt": {"debconf_selections": True}},
+                "apt.debconf_selections: True is not of type 'object'",
+            ),
+            (
+                {"apt": {"debconf_selections": {}}},
+                "apt.debconf_selections: {} does not have enough properties",
+            ),
+            (
+                {"apt": {"sources_list": True}},
+                "apt.sources_list: True is not of type 'string'",
+            ),
+            (
+                {"apt": {"conf": True}},
+                "apt.conf: True is not of type 'string'",
+            ),
+            (
+                {"apt": {"http_proxy": True}},
+                "apt.http_proxy: True is not of type 'string'",
+            ),
+            (
+                {"apt": {"https_proxy": True}},
+                "apt.https_proxy: True is not of type 'string'",
+            ),
+            (
+                {"apt": {"proxy": True}},
+                "apt.proxy: True is not of type 'string'",
+            ),
+            (
+                {"apt": {"ftp_proxy": True}},
+                "apt.ftp_proxy: True is not of type 'string'",
+            ),
+            (
+                {"apt": {"sources": True}},
+                "apt.sources: True is not of type 'object'",
+            ),
+            (
+                {"apt": {"sources": {"opaquekey": True}}},
+                "apt.sources.opaquekey: True is not of type 'object'",
+            ),
+            (
+                {"apt": {"sources": {"opaquekey": {}}}},
+                "apt.sources.opaquekey: {} does not have enough properties",
+            ),
+            (
+                {"apt": {"sources": {"opaquekey": {"boguskey": True}}}},
+                re.escape(
+                    "apt.sources.opaquekey: Additional properties are not"
+                    " allowed ('boguskey' was unexpected)"
+                ),
+            ),
+        ),
+    )
+    @skipUnlessJsonSchema()
+    def test_schema_validation(self, config, error_msg):
+        schema = get_schema()
+        if error_msg is None:
+            validate_cloudconfig_schema(config, schema, strict=True)
+        else:
+            with pytest.raises(SchemaValidationError, match=error_msg):
+                validate_cloudconfig_schema(config, schema, strict=True)
+            # Note apt['primary'] and apt['security'] have same defition
+            # Avoid test setup duplicates by running same test using 'security'
+            if isinstance(config.get("apt"), dict) and config["apt"].get(
+                "primary"
+            ):
+                # To exercise security schema, rename test key from primary
+                config["apt"]["security"] = config["apt"].pop("primary")
+                error_msg = error_msg.replace("primary", "security")
+                with pytest.raises(SchemaValidationError, match=error_msg):
+                    validate_cloudconfig_schema(config, schema, strict=True)
+
+
+# vi: ts=4 expandtab