#221: Added an empty manifest to script language containers (#222)

fixes #221

Author: tomuben

doc/changes/changelog.md

@@ -1,5 +1,6 @@
 # Changes
 
+* [0.21.0](changes_0.21.0.md)
 * [0.20.0](changes_0.20.0.md)
 * [0.19.0](changes_0.19.0.md)
 * [0.18.3](changes_0.18.3.md)

doc/changes/changes_0.21.0.md

@@ -0,0 +1,11 @@
+# Script-Languages-Container-Tool 0.21.0, released t.b.d.
+
+Code name: t.b.d.
+
+## Summary
+
+t.b.d.
+
+## Features
+
+#221: Added an empty manifest to script language containers

exasol_script_languages_container_tool/lib/tasks/export/export_container_base_task.py

@@ -152,9 +152,21 @@ def _export_container(self, container, release_image_name: str, temp_directory:
 
     def _pack_release_file(self, log_path: Path, extract_dir: str, release_file: Path):
         self.logger.info("Pack container file %s", release_file)
-        extract_content = " ".join("'%s'" % file for file in os.listdir(extract_dir))
-        command = f"""tar -C '{extract_dir}' -cvzf '{release_file}' {extract_content}"""
-        self.run_command(command, "packing container file %s" % release_file,
+        extract_content = " ".join(f"'{file}'" for file in os.listdir(extract_dir))
+        if not str(release_file).endswith("tar.gz"):
+            raise ValueError(f"Unexpected release file: '{release_file}'. Expected suffix 'tar.gz'.")
+        tmp_release_file = release_file.with_suffix("") #cut off ".gz" from ".tar.gz"
+        command = f"""tar -C '{extract_dir}' -vcf '{tmp_release_file}' {extract_content}"""
+        self.run_command(command, f"packing container file {tmp_release_file}",
+                         log_path.joinpath("pack_release_file.log"))
+        manifest_file = os.path.join(extract_dir, "exasol-manifest.json")
+        with open(manifest_file, "w") as f:
+            print("{}", file=f)
+        command = f"""tar -C '{extract_dir}' -rvf '{tmp_release_file}' exasol-manifest.json"""
+        self.run_command(command, f"adding manifest to '{tmp_release_file}'",
+                         log_path.joinpath("pack_release_file.log"))
+        command = f"""gzip {tmp_release_file}"""
+        self.run_command(command, f"Creating '{release_file}'",
                          log_path.joinpath("pack_release_file.log"))
 
     @staticmethod

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "exasol-script-languages-container-tool"
-version = "0.20.0"
+version = "0.21.0"
 description = "Script Languages Container Tool"
 
 license = "MIT"

test/test_docker_api_export.py

@@ -1,4 +1,5 @@
 import os
+import tarfile
 import unittest
 from pathlib import Path
 
@@ -29,6 +30,13 @@ def test_docker_export(self):
         export_path = Path(export_info.output_file)
         self.assertIn(export_path.name, exported_files)
 
+        # Verify that "exasol-manifest.json" is the last file in the Tar archive
+        with tarfile.open(export_path, "r:*") as tf:
+            tf_members = tf.getmembers()
+            last_tf_member = tf_members[-1]
+            assert last_tf_member.name == "exasol-manifest.json"
+            assert last_tf_member.path == "exasol-manifest.json"
+
 
 if __name__ == '__main__':
     unittest.main()

test/test_docker_export.py

@@ -1,4 +1,5 @@
 import os
+import tarfile
 import unittest
 
 import utils as exaslct_utils
@@ -24,6 +25,14 @@ def test_docker_export(self):
                          f"Did not found saved files for repository {self.test_environment.repository_name} "
                          f"in list {exported_files}")
 
+        #Verify that "exasol-manifest.json" is the last file in the Tar archive
+        with tarfile.open(os.path.join(self.export_path, 'test-flavor_release.tar.gz'), "r:*") as tf:
+            tf_members = tf.getmembers()
+            last_tf_member = tf_members[-1]
+            assert last_tf_member.name == "exasol-manifest.json"
+            assert last_tf_member.path == "exasol-manifest.json"
+
+
 
 if __name__ == '__main__':
     unittest.main()