Merge ~oddbloke/cloud-init/+git/cloud-init:clean into cloud-init:master

[Dan Watkins]

clean: correctly determine the path for excluding seed directory

Previously, init.paths.cloud_dir has a trailing slash, which meant that
"/var/lib/cloud//seed" was being compared to "/var/lib/cloud/seed" and
(of course), never matching.

In this commit, switch to using os.path.join to avoid this case (and
update the tests to catch it in future).

LP: #1818571

[Ryan Harper (raharper)]

I manually applied your change to test_clean and it does trip the check that seed_dir is not removed.

======================================================================
FAIL: cloudinit.cmd.tests.test_clean.TestClean.test_remove_artifacts_removes_artifacts_skipping_seed
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/home/rharper/work/git/cloud-init/cloudinit/cmd/tests/test_clean.py", line 99, in test_remove_artifacts_removes_artifacts_skipping_seed
    'Missing {0} dir'.format(expected_dir))
AssertionError: False is not true : Missing /tmp/ci-TestClean.f5keq5q_/artifacts/seed dir
-------------------- >> begin captured logging << --------------------
cloudinit.util: DEBUG: Testing if a link exists for /tmp/ci-TestClean.f5keq5q_/artifacts/seed
cloudinit.util: DEBUG: Recursively deleting /tmp/ci-TestClean.f5keq5q_/artifacts/seed
cloudinit.util: DEBUG: Testing if a link exists for /tmp/ci-TestClean.f5keq5q_/artifacts/dir2
cloudinit.util: DEBUG: Recursively deleting /tmp/ci-TestClean.f5keq5q_/artifacts/dir2
cloudinit.util: DEBUG: Testing if a link exists for /tmp/ci-TestClean.f5keq5q_/artifacts/dir1
cloudinit.util: DEBUG: Recursively deleting /tmp/ci-TestClean.f5keq5q_/artifacts/dir1
--------------------- >> end captured logging << ---------------------

----------------------------------------------------------------------
Ran 8 tests in 0.012s

Approved if CI says yes as well.

review: Approve

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

PASSED: Continuous integration, rev:5d08d32fad4673515307b811b41e454368a052ab
https://jenkins.ubuntu.com/server/job/cloud-init-ci/609/
Executed test runs:
    SUCCESS: Checkout
    SUCCESS: Unit & Style Tests
    SUCCESS: Ubuntu LTS: Build
    SUCCESS: Ubuntu LTS: Integration
    IN_PROGRESS: Declarative: Post Actions

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

review: Approve (continuous-integration)

diff --git a/cloudinit/cmd/clean.py b/cloudinit/cmd/clean.py
index 28ee7b8..30e49de 100644
--- a/cloudinit/cmd/clean.py
+++ b/cloudinit/cmd/clean.py
@@ -62,8 +62,9 @@ def remove_artifacts(remove_logs, remove_seed=False):
 
     if not os.path.isdir(init.paths.cloud_dir):
         return 0  # Artifacts dir already cleaned
+    seed_path = os.path.join(init.paths.cloud_dir, 'seed')
     for path in glob.glob('%s/*' % init.paths.cloud_dir):
-        if path == '%s/seed' % init.paths.cloud_dir and not remove_seed:
+        if path == seed_path and not remove_seed:
             continue
         try:
             if os.path.isdir(path) and not is_link(path):
diff --git a/cloudinit/cmd/tests/test_clean.py b/cloudinit/cmd/tests/test_clean.py
index 15c3294..f092ab3 100644
--- a/cloudinit/cmd/tests/test_clean.py
+++ b/cloudinit/cmd/tests/test_clean.py
@@ -22,7 +22,8 @@ class TestClean(CiTestCase):
         class FakeInit(object):
             cfg = {'def_log_file': self.log1,
                    'output': {'all': '|tee -a {0}'.format(self.log2)}}
-            paths = mypaths(cloud_dir=self.artifact_dir)
+            # Ensure cloud_dir has a trailing slash, to match real behaviour
+            paths = mypaths(cloud_dir='{}/'.format(self.artifact_dir))
 
             def __init__(self, ds_deps):
                 pass