INT-7183: Use Docker CLI

.github/workflows/build.yml

@@ -9,13 +9,16 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.9]
+        python-version: [3.9, 3.11]
         os: [ubuntu-latest]
 
     steps:
     - name: Checkout
       uses: actions/checkout@v2
 
+    - name: Set up Docker
+      uses: docker/setup-buildx-action@v3
+
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v2
       with:

requirements.in

@@ -1,5 +1,4 @@
 Click
-docker-compose==1.29.2
 pyyaml>=5.4.1
 MarkupSafe
 jinja2

requirements.txt

@@ -1,5 +1,4 @@
 Click
-docker-compose>=1.26.2, <=1.29.2
 pyyaml>=5.4.1
 MarkupSafe
 jinja2

setup.cfg

@@ -3,5 +3,5 @@ universal = 1
 
 [metadata]
 description_file = README.md
-version = 1.0.2
+version = 1.1.0
 

stackconfig/cli.py

@@ -40,8 +40,7 @@
     help="Jinja2 template that needs to be a valid docker-compose file after being rendered.",
     default=[],
 )
-@click.option("--version", help="Set valid version for the final docker-compose file", default=None)
-def cli(file, output, j2template=None, j2data=None, version=None):
+def cli(file, output, j2template=None, j2data=None):
     try:
         jinja_files = []
         file = list(set(file))
@@ -52,7 +51,7 @@ def cli(file, output, j2template=None, j2data=None, version=None):
                 )
             jinja_files = render_jijnja2_compose(list(set(j2template)), j2data)
             file = file + jinja_files
-        stack_config = StackConfigCompose(file, output, version)
+        stack_config = StackConfigCompose(file, output)
         stack_config.merge_stack_compose()
         print(f"INFO: The docker-compose file was saved in: {output}")
     except Exception as exc:

stackconfig/stackconfig.py

@@ -1,40 +1,43 @@
 import tempfile
-
-from compose.config.serialize import serialize_config
-from compose.cli.command import get_config_from_options
-
+import subprocess
 
 from stackconfig.utils.yaml_utils import save_compose, load_compose, remove_files
 from stackconfig.utils.validate_compose import validate_docker_stack_compose
 
 
 class StackConfigCompose:
-    def __init__(self, files, output, version=None):
+    def __init__(self, files, output, **kwargs):
         self.files = files
         self.output = output
-        self.version = version
         self.compose_dict = dict()
 
     def merge_stack_compose(self):
         """
-        Merges docker-compose files using docker-compose library
+        Merges docker-compose files using docker-compose CLI
         """
-        # using docker-compose library merge process
-        compose_config = get_config_from_options(
-            ".", {"--file": self.files}, {"--no-interpolate": False}
-        )
-        compose_config_str = serialize_config(compose_config, None, escape_dollar=True)
-
+        # Build command: docker compose -f file1 -f file2 config
+        cmd = ["docker", "compose"]
+        for f in self.files:
+            cmd.extend(["-f", f])
+        cmd.append("config")
+        cmd.append("--no-interpolate")
+        try:
+            result = subprocess.run(
+                cmd,
+                capture_output=True,
+                text=True,
+                check=True
+            )
+        except subprocess.CalledProcessError as e:
+            raise Exception(e.stderr or str(e))
+        compose_config_str = result.stdout
         # tmp file
         name_tmp_file = tempfile.NamedTemporaryFile().name
         save_compose(compose_config_str, name_tmp_file, as_text=True)
         self.compose_dict = load_compose(name_tmp_file)
 
         remove_files(name_tmp_file)
 
-        if self.version and isinstance(self.version, str):
-            self.compose_dict["version"] = self.version
-
         # validate
         self.remove_invalid_options()
         validate_docker_stack_compose(self.compose_dict)
@@ -48,8 +51,8 @@ def remove_invalid_options(self):
         that are going to be ignored when deploying
         a docker stack
         """
-        if "version" in self.compose_dict and float(self.compose_dict["version"]) >= 3:
-            for s, sd in self.compose_dict["services"].items():
-                sd.pop("depends_on", None)
-                self.compose_dict["services"][s] = sd
+        # docker stack deploy ignores depends_on, so we need to remove it from the compose file.
+        for s, sd in self.compose_dict["services"].items():
+            sd.pop("depends_on", None)
+            self.compose_dict["services"][s] = sd
 

tests/test_stackconfig.py

@@ -23,7 +23,6 @@ def test_merge_compose_files(mock_success_subprocess):
         ["tests/example_compose.yml"] + templates, "/tmp/temp_result.yml"
     )
     c.merge_stack_compose()
-    assert c.compose_dict["version"] == "3.8"
     assert "deploy" in c.compose_dict["services"]["ui"]
     assert "placement" in c.compose_dict["services"]["ui"]["deploy"]
     assert "max_replicas_per_node" in c.compose_dict["services"]["ui"]["deploy"]["placement"]
@@ -39,28 +38,26 @@ def test_merge_compose_files_invalid_syntax(mock_success_subprocess):
     assert f"Please be sure the template {override_file} is valid" in str(err)
 
 
-@pytest.mark.parametrize("version", [(None), ("3.9")])
-def test_merge_compose_files_invalid(version, mock_success_subprocess):
+def test_merge_compose_files_invalid():
     c = StackConfigCompose(
-        ["tests/example_compose.yml"], "/tmp/temp_result_invalid.yml", version
+        ["tests/example_compose.yml"], "/tmp/temp_result_invalid.yml",
     )
     c.merge_stack_compose()
-    if not version:
-        version = "3.8"
-    assert c.compose_dict["version"] == version
     assert "depends_on" not in c.compose_dict["services"]["api"]
 
 
 def test_merge_compose_files_syntax_error(mock_success_subprocess):
     with open("/tmp/invalid-compose.yml", "+w") as file:
         file.writelines("{}\ntests: test_value".format("test"))
+    with open("/tmp/override_invalid.yml", "+w") as file:
+        file.writelines("{}\ntests: test_value".format("test"))
     with pytest.raises(Exception) as exc:
         c = StackConfigCompose(
             ["/tmp/invalid-compose.yml", "/tmp/override_invalid.yml"],
             "/tmp/temp_result_invalid.yml",
         )
         c.merge_stack_compose()
-    assert "mapping values are not allowed here" in str(exc)
+    assert "mapping values are not allowed in this context" in str(exc)
 
 
 def test_merge_compose_files_invalid_syntax_compose_validation(mock_error_subprocess):
@@ -73,4 +70,4 @@ def test_merge_compose_files_invalid_syntax_compose_validation(mock_error_subpro
             ["tests/example_compose.yml"] + templates, "/tmp/temp_result.yml"
         )
         c.merge_stack_compose()
-    assert f"services.service_custom.deploy.replicas contains an invalid type" in str(err)
+    assert f"services.service_custom.deploy.replicas must be a integer" in str(err)