Remove TemporaryDirectory inside another TemporaryDirectory.

Signed-off-by: dblock <[email protected]>

Author: dblock

src/assemble_workflow/bundle.py

@@ -29,7 +29,7 @@ def __enter__(self):
     def __exit__(self, exc_type, exc_value, exc_traceback):
         self.tmp_dir.__exit__(exc_type, exc_value, exc_traceback)
 
-    def __init__(self, build_manifest, artifacts_dir, bundle_recorder):
+    def __init__(self, build_manifest, artifacts_dir, bundle_recorder, keep=False):
         """
         Construct a new Bundle instance.
         :param build_manifest: A BuildManifest created from the build workflow.
@@ -39,7 +39,7 @@ def __init__(self, build_manifest, artifacts_dir, bundle_recorder):
         self.plugins = self.__get_plugins(build_manifest.components.values())
         self.artifacts_dir = artifacts_dir
         self.bundle_recorder = bundle_recorder
-        self.tmp_dir = TemporaryDirectory()
+        self.tmp_dir = TemporaryDirectory(keep=keep)
         self.min_dist = self.__get_min_dist(build_manifest.components.values())
         self.installed_plugins = []
 

src/assemble_workflow/bundles.py

@@ -22,6 +22,6 @@ def from_name(cls, name):
         return klass
 
     @classmethod
-    def create(cls, build_manifest, artifacts_dir, bundle_recorder):
+    def create(cls, build_manifest, artifacts_dir, bundle_recorder, keep):
         klass = cls.from_name(build_manifest.build.name)
-        return klass(build_manifest, artifacts_dir, bundle_recorder)
+        return klass(build_manifest, artifacts_dir, bundle_recorder, keep)

src/run_assemble.py

@@ -15,7 +15,6 @@
 from assemble_workflow.bundles import Bundles
 from manifests.build_manifest import BuildManifest
 from system import console
-from system.temporary_directory import TemporaryDirectory
 
 
 def main():
@@ -29,21 +28,20 @@ def main():
     output_dir = os.path.join(os.getcwd(), "dist")
     os.makedirs(output_dir, exist_ok=True)
 
-    with TemporaryDirectory(chdir=True, keep=args.keep):
-        logging.info(f"Bundling {build.name} ({build.architecture}) on {build.platform} into {output_dir} ...")
+    logging.info(f"Bundling {build.name} ({build.architecture}) on {build.platform} into {output_dir} ...")
 
-        bundle_recorder = BundleRecorder(build, output_dir, artifacts_dir, args.base_url)
+    bundle_recorder = BundleRecorder(build, output_dir, artifacts_dir, args.base_url)
 
-        with Bundles.create(build_manifest, artifacts_dir, bundle_recorder) as bundle:
-            bundle.install_min()
-            bundle.install_plugins()
-            logging.info(f"Installed plugins: {bundle.installed_plugins}")
+    with Bundles.create(build_manifest, artifacts_dir, bundle_recorder, args.keep) as bundle:
+        bundle.install_min()
+        bundle.install_plugins()
+        logging.info(f"Installed plugins: {bundle.installed_plugins}")
 
-            #  Save a copy of the manifest inside of the tar
-            bundle_recorder.write_manifest(bundle.min_dist.archive_path)
-            bundle.package(output_dir)
+        #  Save a copy of the manifest inside of the tar
+        bundle_recorder.write_manifest(bundle.min_dist.archive_path)
+        bundle.package(output_dir)
 
-            bundle_recorder.write_manifest(output_dir)
+        bundle_recorder.write_manifest(output_dir)
 
     logging.info("Done.")
 

tests/test_run_assemble.py

@@ -5,7 +5,6 @@
 # compatible open source license.
 
 import os
-import tempfile
 import unittest
 from unittest.mock import MagicMock, call, patch
 
@@ -31,14 +30,12 @@ def test_usage(self, *mocks):
 
     @patch("os.chdir")
     @patch("os.makedirs")
+    @patch("shutil.copy2")
     @patch("os.getcwd", return_value="curdir")
     @patch("argparse._sys.argv", ["run_assemble.py", BUILD_MANIFEST])
     @patch("run_assemble.Bundles.create")
     @patch("run_assemble.BundleRecorder", return_value=MagicMock())
-    @patch("run_assemble.TemporaryDirectory")
-    @patch("shutil.copy2")
-    def test_main(self, mock_copy, mock_temp, mock_recorder, mock_bundles, *mocks):
-        mock_temp.return_value.__enter__.return_value.name = tempfile.gettempdir()
+    def test_main(self, mock_recorder, mock_bundles, *mocks):
         mock_bundle = MagicMock(min_dist=MagicMock(archive_path="path"))
         mock_bundles.return_value.__enter__.return_value = mock_bundle
 
@@ -49,7 +46,4 @@ def test_main(self, mock_copy, mock_temp, mock_recorder, mock_bundles, *mocks):
 
         mock_bundle.package.assert_called_with(os.path.join("curdir", "dist"))
 
-        mock_recorder.return_value.write_manifest.assert_has_calls([
-            call("path"),
-            call(os.path.join("curdir", "dist"))
-        ])  # manifest included in package
+        mock_recorder.return_value.write_manifest.assert_has_calls([call("path"), call(os.path.join("curdir", "dist"))])  # manifest included in package

tests/tests_assemble_workflow/test_bundles.py

@@ -18,14 +18,21 @@ class TestBundles(unittest.TestCase):
     def test_bundle_opensearch(self):
         manifest_path = os.path.join(os.path.dirname(__file__), "data", "opensearch-build-linux-1.1.0.yml")
         artifacts_path = os.path.join(os.path.dirname(__file__), "data", "artifacts")
-        bundle = Bundles.create(BuildManifest.from_path(manifest_path), artifacts_path, MagicMock())
+        bundle = Bundles.create(BuildManifest.from_path(manifest_path), artifacts_path, MagicMock(), False)
         self.assertIs(type(bundle), BundleOpenSearch)
 
     def test_bundle_opensearch_dashboards(self):
         manifest_path = os.path.join(os.path.dirname(__file__), "data", "opensearch-dashboards-build-1.1.0.yml")
         artifacts_path = os.path.join(os.path.dirname(__file__), "data", "artifacts")
-        bundle = Bundles.create(BuildManifest.from_path(manifest_path), artifacts_path, MagicMock())
+        bundle = Bundles.create(BuildManifest.from_path(manifest_path), artifacts_path, MagicMock(), False)
         self.assertIs(type(bundle), BundleOpenSearchDashboards)
+        self.assertFalse(bundle.tmp_dir.keep)
+
+    def test_bundle_keep(self):
+        manifest_path = os.path.join(os.path.dirname(__file__), "data", "opensearch-build-linux-1.1.0.yml")
+        artifacts_path = os.path.join(os.path.dirname(__file__), "data", "artifacts")
+        bundle = Bundles.create(BuildManifest.from_path(manifest_path), artifacts_path, MagicMock(), True)
+        self.assertTrue(bundle.tmp_dir.keep)
 
     def test_bundle_opensearch_invalid(self):
         manifest = BuildManifest(
@@ -41,5 +48,5 @@ def test_bundle_opensearch_invalid(self):
             }
         )
         with self.assertRaises(ValueError) as ctx:
-            Bundles.create(manifest, "path", MagicMock())
+            Bundles.create(manifest, "path", MagicMock(), False)
         self.assertEqual(str(ctx.exception), "Unsupported bundle: invalid")