From 4aec33275d56c398234af45ca1dc51dd7995360f Mon Sep 17 00:00:00 2001
From: sxt1001 <shixuantong1@huawei.com>
Date: Sun, 14 May 2023 23:24:15 +0800
Subject: [PATCH] remove schema errors from log for cloudinit/config/cc_*

---
 cloudinit/config/cc_bootcmd.py                        | 2 +-
 cloudinit/config/cc_ntp.py                            | 2 +-
 cloudinit/config/cc_resizefs.py                       | 2 +-
 cloudinit/config/cc_runcmd.py                         | 2 +-
 cloudinit/config/cc_snap.py                           | 2 +-
 cloudinit/config/cc_ubuntu_advantage.py               | 2 +-
 cloudinit/config/cc_ubuntu_drivers.py                 | 2 +-
 cloudinit/config/tests/test_snap.py                   | 5 ++---
 tests/unittests/test_handler/test_handler_bootcmd.py  | 8 ++++----
 tests/unittests/test_handler/test_handler_resizefs.py | 4 ++--
 tests/unittests/test_handler/test_handler_runcmd.py   | 8 ++++----
 11 files changed, 19 insertions(+), 20 deletions(-)

diff --git a/cloudinit/config/cc_bootcmd.py b/cloudinit/config/cc_bootcmd.py
index 6813f53..cee7585 100644
--- a/cloudinit/config/cc_bootcmd.py
+++ b/cloudinit/config/cc_bootcmd.py
@@ -83,7 +83,7 @@ def handle(name, cfg, cloud, log, _args):
                    " no 'bootcmd' key in configuration"), name)
         return
 
-    validate_cloudconfig_schema(cfg, schema)
+    validate_cloudconfig_schema(cfg, schema, log_details=False)
     with temp_utils.ExtendedTemporaryFile(suffix=".sh") as tmpf:
         try:
             content = util.shellify(cfg["bootcmd"])
diff --git a/cloudinit/config/cc_ntp.py b/cloudinit/config/cc_ntp.py
index 926dfea..5481f54 100644
--- a/cloudinit/config/cc_ntp.py
+++ b/cloudinit/config/cc_ntp.py
@@ -502,7 +502,7 @@ def handle(name, cfg, cloud, log, _args):
             "'ntp' key existed in config, but not a dictionary type,"
             " is a {_type} instead".format(_type=type_utils.obj_name(ntp_cfg)))
 
-    validate_cloudconfig_schema(cfg, schema)
+    validate_cloudconfig_schema(cfg, schema, log_details=False)
 
     # Allow users to explicitly enable/disable
     enabled = ntp_cfg.get('enabled', True)
diff --git a/cloudinit/config/cc_resizefs.py b/cloudinit/config/cc_resizefs.py
index 01dfc12..88fc89e 100644
--- a/cloudinit/config/cc_resizefs.py
+++ b/cloudinit/config/cc_resizefs.py
@@ -233,7 +233,7 @@ def handle(name, cfg, _cloud, log, args):
         resize_root = args[0]
     else:
         resize_root = util.get_cfg_option_str(cfg, "resize_rootfs", True)
-    validate_cloudconfig_schema(cfg, schema)
+    validate_cloudconfig_schema(cfg, schema, log_details=False)
     if not util.translate_bool(resize_root, addons=[NOBLOCK]):
         log.debug("Skipping module named %s, resizing disabled", name)
         return
diff --git a/cloudinit/config/cc_runcmd.py b/cloudinit/config/cc_runcmd.py
index 1f75d6c..6a2ff44 100644
--- a/cloudinit/config/cc_runcmd.py
+++ b/cloudinit/config/cc_runcmd.py
@@ -84,7 +84,7 @@ def handle(name, cfg, cloud, log, _args):
                    " no 'runcmd' key in configuration"), name)
         return
 
-    validate_cloudconfig_schema(cfg, schema)
+    validate_cloudconfig_schema(cfg, schema, log_details=False)
     out_fn = os.path.join(cloud.get_ipath('scripts'), "runcmd")
     cmd = cfg["runcmd"]
     try:
diff --git a/cloudinit/config/cc_snap.py b/cloudinit/config/cc_snap.py
index 90724b8..6e17595 100644
--- a/cloudinit/config/cc_snap.py
+++ b/cloudinit/config/cc_snap.py
@@ -220,7 +220,7 @@ def handle(name, cfg, cloud, log, args):
                    " no 'snap' key in configuration"), name)
         return
 
-    validate_cloudconfig_schema(cfg, schema)
+    validate_cloudconfig_schema(cfg, schema, log_details=False)
     if util.is_true(cfgin.get('squashfuse_in_container', False)):
         maybe_install_squashfuse(cloud)
     add_assertions(cfgin.get('assertions', []))
diff --git a/cloudinit/config/cc_ubuntu_advantage.py b/cloudinit/config/cc_ubuntu_advantage.py
index f846e9a..f7bb82d 100644
--- a/cloudinit/config/cc_ubuntu_advantage.py
+++ b/cloudinit/config/cc_ubuntu_advantage.py
@@ -164,7 +164,7 @@ def handle(name, cfg, cloud, log, args):
         LOG.debug("Skipping module named %s,"
                   " no 'ubuntu_advantage' configuration found", name)
         return
-    validate_cloudconfig_schema(cfg, schema)
+    validate_cloudconfig_schema(cfg, schema, log_details=False)
     if 'commands' in ua_section:
         msg = (
             'Deprecated configuration "ubuntu-advantage: commands" provided.'
diff --git a/cloudinit/config/cc_ubuntu_drivers.py b/cloudinit/config/cc_ubuntu_drivers.py
index 297451d..8b84501 100644
--- a/cloudinit/config/cc_ubuntu_drivers.py
+++ b/cloudinit/config/cc_ubuntu_drivers.py
@@ -156,5 +156,5 @@ def handle(name, cfg, cloud, log, _args):
         log.debug("Skipping module named %s, no 'drivers' key in config", name)
         return
 
-    validate_cloudconfig_schema(cfg, schema)
+    validate_cloudconfig_schema(cfg, schema, log_details=False)
     install_drivers(cfg['drivers'], cloud.distro.install_packages)
diff --git a/cloudinit/config/tests/test_snap.py b/cloudinit/config/tests/test_snap.py
index 3c47289..794e8e6 100644
--- a/cloudinit/config/tests/test_snap.py
+++ b/cloudinit/config/tests/test_snap.py
@@ -457,9 +457,8 @@ class TestHandle(CiTestCase):
             'cloudinit.config.cc_snap',
             {'ASSERTIONS_FILE': {'new': assert_file}},
             handle, 'snap', cfg=cfg, cloud=None, log=self.logger, args=None)
-        self.assertEqual(
-            "WARNING: Invalid config:\nsnap: Additional properties are not"
-            " allowed ('invalid' was unexpected)\n",
+        self.assertIn(
+            "Invalid config:Please run 'sudo cloud-init devel schema --system' or 'cloud-init devel schema -c config-file' to see the schema errors.",
             self.logs.getvalue())
 
 
diff --git a/tests/unittests/test_handler/test_handler_bootcmd.py b/tests/unittests/test_handler/test_handler_bootcmd.py
index a76760f..eb77252 100644
--- a/tests/unittests/test_handler/test_handler_bootcmd.py
+++ b/tests/unittests/test_handler/test_handler_bootcmd.py
@@ -79,7 +79,8 @@ class TestBootcmd(CiTestCase):
         with self.assertRaises(TypeError):
             handle('cc_bootcmd', invalid_config, cc, LOG, [])
         self.assertIn(
-            'Invalid config:\nbootcmd: 1 is not of type \'array\'',
+            "Invalid config:Please run 'sudo cloud-init devel schema --system' or"
+            " 'cloud-init devel schema -c config-file' to see the schema errors.",
             self.logs.getvalue())
         self.assertIn('Failed to shellify', self.logs.getvalue())
 
@@ -96,9 +97,8 @@ class TestBootcmd(CiTestCase):
         with self.assertRaises(TypeError) as context_manager:
             handle('cc_bootcmd', invalid_config, cc, LOG, [])
         expected_warnings = [
-            'bootcmd.1: 20 is not valid under any of the given schemas',
-            'bootcmd.3: {\'a\': \'n\'} is not valid under any of the given'
-            ' schema'
+            "Invalid config:Please run 'sudo cloud-init devel schema --system' or"
+            " 'cloud-init devel schema -c config-file' to see the schema errors.",
         ]
         logs = self.logs.getvalue()
         for warning in expected_warnings:
diff --git a/tests/unittests/test_handler/test_handler_resizefs.py b/tests/unittests/test_handler/test_handler_resizefs.py
index db9a041..eda27b4 100644
--- a/tests/unittests/test_handler/test_handler_resizefs.py
+++ b/tests/unittests/test_handler/test_handler_resizefs.py
@@ -82,8 +82,8 @@ class TestResizefs(CiTestCase):
         handle('cc_resizefs', cfg, _cloud=None, log=LOG, args=[])
         logs = self.logs.getvalue()
         self.assertIn(
-            "WARNING: Invalid config:\nresize_rootfs: 'junk' is not one of"
-            " [True, False, 'noblock']",
+            "Invalid config:Please run 'sudo cloud-init devel schema --system' or"
+            " 'cloud-init devel schema -c config-file' to see the schema errors.",
             logs)
         self.assertIn(
             'DEBUG: Skipping module named cc_resizefs, resizing disabled\n',
diff --git a/tests/unittests/test_handler/test_handler_runcmd.py b/tests/unittests/test_handler/test_handler_runcmd.py
index 9ce334a..5fea44e 100644
--- a/tests/unittests/test_handler/test_handler_runcmd.py
+++ b/tests/unittests/test_handler/test_handler_runcmd.py
@@ -62,7 +62,8 @@ class TestRuncmd(FilesystemMockingTestCase):
         cc = self._get_cloud('ubuntu')
         handle('cc_runcmd', invalid_config, cc, LOG, [])
         self.assertIn(
-            'Invalid config:\nruncmd: 1 is not of type \'array\'',
+            "Invalid config:Please run 'sudo cloud-init devel schema --system' or"
+            " 'cloud-init devel schema -c config-file' to see the schema errors.",
             self.logs.getvalue())
         self.assertIn('Failed to shellify', self.logs.getvalue())
 
@@ -78,9 +79,8 @@ class TestRuncmd(FilesystemMockingTestCase):
         cc = self._get_cloud('ubuntu')
         handle('cc_runcmd', invalid_config, cc, LOG, [])
         expected_warnings = [
-            'runcmd.1: 20 is not valid under any of the given schemas',
-            'runcmd.3: {\'a\': \'n\'} is not valid under any of the given'
-            ' schema'
+            "Invalid config:Please run 'sudo cloud-init devel schema --system' or"
+            " 'cloud-init devel schema -c config-file' to see the schema errors.",
         ]
         logs = self.logs.getvalue()
         for warning in expected_warnings:
-- 
2.33.0

