1 files changed, 145 insertions, 0 deletions
diff --git a/tests/unittests/util.py b/tests/unittests/util.py
new file mode 100644
index 00000000..79a6e1d0
--- /dev/null
+++ b/tests/unittests/util.py
@@ -0,0 +1,145 @@
+# This file is part of cloud-init. See LICENSE file for license information.
+from cloudinit import cloud, distros, helpers
+from cloudinit.sources.DataSourceNone import DataSourceNone
+
+
+def get_cloud(distro=None, paths=None, sys_cfg=None, metadata=None):
+    """Obtain a "cloud" that can be used for testing.
+
+    Modules take a 'cloud' parameter to call into things that are
+    datasource/distro specific. In most cases, the specifics of this cloud
+    implementation aren't needed to test the module, so provide a fake
+    datasource/distro with stubbed calls to methods that may attempt to
+    read/write files or shell out. If a specific distro is needed, it can
+    be passed in as the distro parameter.
+    """
+    paths = paths or helpers.Paths({})
+    sys_cfg = sys_cfg or {}
+    cls = distros.fetch(distro) if distro else MockDistro
+    mydist = cls(distro, sys_cfg, paths)
+    myds = DataSourceTesting(sys_cfg, mydist, paths)
+    if metadata:
+        myds.metadata.update(metadata)
+    if paths:
+        paths.datasource = myds
+    return cloud.Cloud(myds, paths, sys_cfg, mydist, None)
+
+
+def abstract_to_concrete(abclass):
+    """Takes an abstract class and returns a concrete version of it."""
+
+    class concreteCls(abclass):
+        pass
+
+    concreteCls.__abstractmethods__ = frozenset()
+    return type("DummyConcrete" + abclass.__name__, (concreteCls,), {})
+
+
+class DataSourceTesting(DataSourceNone):
+    def get_hostname(self, fqdn=False, resolve_ip=False, metadata_only=False):
+        return "hostname"
+
+    def persist_instance_data(self):
+        return True
+
+    @property
+    def fallback_interface(self):
+        return None
+
+    @property
+    def cloud_name(self):
+        return "testing"
+
+
+class MockDistro(distros.Distro):
+    # MockDistro is here to test base Distro class implementations
+    def __init__(self, name="testingdistro", cfg=None, paths=None):
+        if not cfg:
+            cfg = {}
+        if not paths:
+            paths = {}
+        super(MockDistro, self).__init__(name, cfg, paths)
+
+    def install_packages(self, pkglist):
+        pass
+
+    def set_hostname(self, hostname, fqdn=None):
+        pass
+
+    def uses_systemd(self):
+        return True
+
+    def get_primary_arch(self):
+        return "i386"
+
+    def get_package_mirror_info(self, arch=None, data_source=None):
+        pass
+
+    def apply_network(self, settings, bring_up=True):
+        return False
+
+    def generate_fallback_config(self):
+        return {}
+
+    def apply_network_config(self, netconfig, bring_up=False) -> bool:
+        return False
+
+    def apply_network_config_names(self, netconfig):
+        pass
+
+    def apply_locale(self, locale, out_fn=None):
+        pass
+
+    def set_timezone(self, tz):
+        pass
+
+    def _read_hostname(self, filename, default=None):
+        raise NotImplementedError()
+
+    def _write_hostname(self, hostname, filename):
+        raise NotImplementedError()
+
+    def _read_system_hostname(self):
+        raise NotImplementedError()
+
+    def update_hostname(self, hostname, fqdn, prev_hostname_fn):
+        pass
+
+    def update_etc_hosts(self, hostname, fqdn):
+        pass
+
+    def add_user(self, name, **kwargs):
+        pass
+
+    def add_snap_user(self, name, **kwargs):
+        return "snap_user"
+
+    def create_user(self, name, **kwargs):
+        return True
+
+    def lock_passwd(self, name):
+        pass
+
+    def expire_passwd(self, user):
+        pass
+
+    def set_passwd(self, user, passwd, hashed=False):
+        return True
+
+    def ensure_sudo_dir(self, path, sudo_base="/etc/sudoers"):
+        pass
+
+    def write_sudo_rules(self, user, rules, sudo_file=None):
+        pass
+
+    def create_group(self, name, members=None):
+        pass
+
+    def shutdown_command(self, *, mode, delay, message):
+        pass
+
+    def package_command(self, command, args=None, pkgs=None):
+        pass
+
+    def update_package_sources(self):
+        return (True, "yay")