diff options
| author | Brett Holman <bholman.devel@gmail.com> | 2021-12-03 13:11:46 -0700 | 
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-12-03 13:11:46 -0700 | 
| commit | 039c40f9b3d88ee8158604bb18ca4bf2fb5d5e51 (patch) | |
| tree | 5f1b09486ccaf98ee8159de58d9a2a1ef0af5dc1 /tests/unittests/test_handler/test_handler_runcmd.py | |
| parent | ffa6fc88249aa080aa31811a45569a45e567418a (diff) | |
| download | vyos-cloud-init-039c40f9b3d88ee8158604bb18ca4bf2fb5d5e51.tar.gz vyos-cloud-init-039c40f9b3d88ee8158604bb18ca4bf2fb5d5e51.zip  | |
Reorganize unit test locations under tests/unittests (#1126)
This attempts to standardize unit test file location under test/unittests/
such that any source file located at cloudinit/path/to/file.py may have a
corresponding unit test file at test/unittests/path/to/test_file.py.
Noteworthy Comments:
====================
Four different duplicate test files existed:
test_{gpg,util,cc_mounts,cc_resolv_conf}.py
Each of these duplicate file pairs has been merged together. This is a
break in git history for these files.
The test suite appears to have a dependency on test order. Changing test
order causes some tests to fail. This should be rectified, but for now
some tests have been modified in
tests/unittests/config/test_set_passwords.py.
A helper class name starts with "Test" which causes pytest to try
executing it as a test case, which then throws warnings "due to Class
having __init__()".  Silence by changing the name of the class.
# helpers.py is imported in many test files, import paths change
cloudinit/tests/helpers.py -> tests/unittests/helpers.py
# Move directories:
cloudinit/distros/tests -> tests/unittests/distros
cloudinit/cmd/devel/tests -> tests/unittests/cmd/devel
cloudinit/cmd/tests -> tests/unittests/cmd/
cloudinit/sources/helpers/tests -> tests/unittests/sources/helpers
cloudinit/sources/tests -> tests/unittests/sources
cloudinit/net/tests -> tests/unittests/net
cloudinit/config/tests -> tests/unittests/config
cloudinit/analyze/tests/ -> tests/unittests/analyze/
# Standardize tests already in tests/unittests/
test_datasource -> sources
test_distros -> distros
test_vmware -> sources/vmware
test_handler -> config        # this contains cloudconfig module tests
test_runs -> runs
Diffstat (limited to 'tests/unittests/test_handler/test_handler_runcmd.py')
| -rw-r--r-- | tests/unittests/test_handler/test_handler_runcmd.py | 129 | 
1 files changed, 0 insertions, 129 deletions
diff --git a/tests/unittests/test_handler/test_handler_runcmd.py b/tests/unittests/test_handler/test_handler_runcmd.py deleted file mode 100644 index 672e8093..00000000 --- a/tests/unittests/test_handler/test_handler_runcmd.py +++ /dev/null @@ -1,129 +0,0 @@ -# This file is part of cloud-init. See LICENSE file for license information. -import logging -import os -import stat -from unittest.mock import patch - -from cloudinit.config.cc_runcmd import handle, schema -from cloudinit import (helpers, subp, util) -from cloudinit.tests.helpers import ( -    CiTestCase, FilesystemMockingTestCase, SchemaTestCaseMixin, -    skipUnlessJsonSchema) - -from tests.unittests.util import get_cloud - -LOG = logging.getLogger(__name__) - - -class TestRuncmd(FilesystemMockingTestCase): - -    with_logs = True - -    def setUp(self): -        super(TestRuncmd, self).setUp() -        self.subp = subp.subp -        self.new_root = self.tmp_dir() -        self.patchUtils(self.new_root) -        self.paths = helpers.Paths({'scripts': self.new_root}) - -    def test_handler_skip_if_no_runcmd(self): -        """When the provided config doesn't contain runcmd, skip it.""" -        cfg = {} -        mycloud = get_cloud(paths=self.paths) -        handle('notimportant', cfg, mycloud, LOG, None) -        self.assertIn( -            "Skipping module named notimportant, no 'runcmd' key", -            self.logs.getvalue()) - -    @patch('cloudinit.util.shellify') -    def test_runcmd_shellify_fails(self, cls): -        """When shellify fails throw exception""" -        cls.side_effect = TypeError("patched shellify") -        valid_config = {'runcmd': ['echo 42']} -        cc = get_cloud(paths=self.paths) -        with self.assertRaises(TypeError) as cm: -            with self.allow_subp(['/bin/sh']): -                handle('cc_runcmd', valid_config, cc, LOG, None) -        self.assertIn("Failed to shellify", str(cm.exception)) - -    def test_handler_invalid_command_set(self): -        """Commands which can't be converted to shell will raise errors.""" -        invalid_config = {'runcmd': 1} -        cc = get_cloud(paths=self.paths) -        with self.assertRaises(TypeError) as cm: -            handle('cc_runcmd', invalid_config, cc, LOG, []) -        self.assertIn( -            'Failed to shellify 1 into file' -            ' /var/lib/cloud/instances/iid-datasource-none/scripts/runcmd', -            str(cm.exception)) - -    @skipUnlessJsonSchema() -    def test_handler_schema_validation_warns_non_array_type(self): -        """Schema validation warns of non-array type for runcmd key. - -        Schema validation is not strict, so runcmd attempts to shellify the -        invalid content. -        """ -        invalid_config = {'runcmd': 1} -        cc = get_cloud(paths=self.paths) -        with self.assertRaises(TypeError) as cm: -            handle('cc_runcmd', invalid_config, cc, LOG, []) -        self.assertIn( -            'Invalid config:\nruncmd: 1 is not of type \'array\'', -            self.logs.getvalue()) -        self.assertIn('Failed to shellify', str(cm.exception)) - -    @skipUnlessJsonSchema() -    def test_handler_schema_validation_warns_non_array_item_type(self): -        """Schema validation warns of non-array or string runcmd items. - -        Schema validation is not strict, so runcmd attempts to shellify the -        invalid content. -        """ -        invalid_config = { -            'runcmd': ['ls /', 20, ['wget', 'http://stuff/blah'], {'a': 'n'}]} -        cc = get_cloud(paths=self.paths) -        with self.assertRaises(TypeError) as cm: -            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' -        ] -        logs = self.logs.getvalue() -        for warning in expected_warnings: -            self.assertIn(warning, logs) -        self.assertIn('Failed to shellify', str(cm.exception)) - -    def test_handler_write_valid_runcmd_schema_to_file(self): -        """Valid runcmd schema is written to a runcmd shell script.""" -        valid_config = {'runcmd': [['ls', '/']]} -        cc = get_cloud(paths=self.paths) -        handle('cc_runcmd', valid_config, cc, LOG, []) -        runcmd_file = os.path.join( -            self.new_root, -            'var/lib/cloud/instances/iid-datasource-none/scripts/runcmd') -        self.assertEqual("#!/bin/sh\n'ls' '/'\n", util.load_file(runcmd_file)) -        file_stat = os.stat(runcmd_file) -        self.assertEqual(0o700, stat.S_IMODE(file_stat.st_mode)) - - -@skipUnlessJsonSchema() -class TestSchema(CiTestCase, SchemaTestCaseMixin): -    """Directly test schema rather than through handle.""" - -    schema = schema - -    def test_duplicates_are_fine_array_array(self): -        """Duplicated commands array/array entries are allowed.""" -        self.assertSchemaValid( -            [["echo", "bye"], ["echo", "bye"]], -            "command entries can be duplicate.") - -    def test_duplicates_are_fine_array_string(self): -        """Duplicated commands array/string entries are allowed.""" -        self.assertSchemaValid( -            ["echo bye", "echo bye"], -            "command entries can be duplicate.") - -# vi: ts=4 expandtab  | 
