Merge ~smoser/cloud-init:bug/1675185-no-apt-on-snappy into cloud-init:master

[Scott Moser]

apt_configure: run only when needed.

Do not bother configuring apt if no 'apt' config is provided and either:
 a.) running on snappy
 b.) there is no 'apt' command (possibly a different distro)

If apt config is provided in either of the above situations, then config
will continue.

LP: #1675185

[Scott Moser (smoser)]

need some tests, and maybe some test case cleanups.

[Server Team CI bot (server-team-bot)]

FAILED: Continuous integration, rev:2643c41bd53b47ecf5f0a39b65ef771afdb4ebdf
https://jenkins.ubuntu.com/server/job/cloud-init-ci/172/
Executed test runs:
    FAILURE: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=metal-amd64/172/console
    FAILURE: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=metal-arm64/172/console
    FAILURE: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=metal-ppc64el/172/console
    FAILURE: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=metal-s390x/172/console
    FAILURE: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=vm-i386/172/console

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/server/job/cloud-init-ci/172/rebuild

review: Needs Fixing (continuous-integration)

[Server Team CI bot (server-team-bot)]

PASSED: Continuous integration, rev:b735652a9fa1e448027e62d6fe7d2560507650a8
https://jenkins.ubuntu.com/server/job/cloud-init-ci/173/
Executed test runs:
    SUCCESS: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=metal-amd64/173
    SUCCESS: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=metal-arm64/173
    SUCCESS: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=metal-ppc64el/173
    SUCCESS: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=metal-s390x/173
    SUCCESS: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=vm-i386/173

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/server/job/cloud-init-ci/173/rebuild

review: Approve (continuous-integration)

[Ryan Harper (raharper)]

review: Needs Fixing

[Scott Moser (smoser)]

The first thing that apply_debconf_selections does is:
    selsets = cfg.get('debconf_selections')
    if not selsets:
        LOG.debug("debconf_selections was not set in config")
        return

So if there is no 'debconf_selections' in the config, then it will just log and return.
If there *is* debconf_selections in the config, then it seems like the proper thing to do is fail trying.

That is slightly different than 'apt' configuration for 2 reasons
a.) apt config is more likely to just be there anyway (such as maas sending it)
b.) there is some "default" apt configuration that we do based on system config.

That said, I think that its probably best for us fail if 'apt' config is specifically given and we are on snappy or there is no 'apt'.

I'm going to update the proposal here to fail if apt config is given.
thoughts?

[Ryan Harper (raharper)]

I personally like an explicit disable; we have it in many other modules; it's simple and clean; even the debconf_selections does that (as you point out).

I agree that if someone puts in debconf_selections or an apt config in user-data, then we should fail; I'm fine with the apt config present failing if there's no apt or system_is_snappy.

Can we do both? (explicit config disable and checking for apt/snappy)?

[Server Team CI bot (server-team-bot)]

PASSED: Continuous integration, rev:e80dbb80987ba44be2899e34fbbbf7d48389b6b5
https://jenkins.ubuntu.com/server/job/cloud-init-ci/181/
Executed test runs:
    SUCCESS: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=metal-amd64/181
    SUCCESS: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=metal-arm64/181
    SUCCESS: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=metal-ppc64el/181
    SUCCESS: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=metal-s390x/181
    SUCCESS: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=vm-i386/181

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/server/job/cloud-init-ci/181/rebuild

review: Approve (continuous-integration)

[Ryan Harper (raharper)]

Looks good

review: Approve

diff --git a/cloudinit/config/cc_apt_configure.py b/cloudinit/config/cc_apt_configure.py
index 7f09c91..06804e8 100644
--- a/cloudinit/config/cc_apt_configure.py
+++ b/cloudinit/config/cc_apt_configure.py
@@ -278,15 +278,29 @@ def handle(name, ocfg, cloud, log, _):
         raise ValueError("Expected dictionary for 'apt' config, found %s",
                          type(cfg))
 
-    LOG.debug("handling apt (module %s) with apt config '%s'", name, cfg)
+    apply_debconf_selections(cfg, target)
+    apply_apt(cfg, cloud, target)
+
+
+def apply_apt(cfg, cloud, target):
+    # cfg is the 'apt' top level dictionary already in 'v3' format.
+    if not cfg:
+        # no config was provided.  If apt configuration does not seem
+        # necessary on this system, then return.
+        if util.system_is_snappy():
+            LOG.debug("Nothing to do: No apt config and running on snappy")
+            return
+        if not (util.which('apt-get') or util.which('apt')):
+            LOG.debug("Nothing to do: No apt config and no apt commands")
+            return
+
+    LOG.debug("handling apt config: %s", cfg)
 
     release = util.lsb_release(target=target)['codename']
     arch = util.get_architecture(target)
     mirrors = find_apt_mirror_info(cfg, cloud, arch=arch)
     LOG.debug("Apt Mirror info: %s", mirrors)
 
-    apply_debconf_selections(cfg, target)
-
     if util.is_false(cfg.get('preserve_sources_list', False)):
         generate_sources_list(cfg, release, mirrors, cloud)
         rename_apt_lists(mirrors, target)