Use composefile rather than docker-compose (#30)

Author: dboreham

src/stack/constants.py

@@ -14,11 +14,14 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http:#www.gnu.org/licenses/>.
 
+import os
+
 annotations_key = "annotations"
 cluster_id_key = "cluster-id"
 cluster_name_prefix = "bpi-"
 compose_deploy_type = "compose"
 compose_dir_name = "compose"
+compose_file_prefix = os.environ.get("BPI_COMPOSE_FILE_PREFIX", "composefile")
 config_file_name = "config.env"
 config_key = "config"
 configmaps_key = "configmaps"

…compose/docker-compose-test-database.yml …ta/compose/composefile-test-database.ymlsrc/stack/data/compose/docker-compose-test-database.yml renamed to src/stack/data/compose/composefile-test-database.yml src/stack/data/compose/docker-compose-test-database.yml renamed to src/stack/data/compose/composefile-test-database.yml

@@ -25,7 +25,7 @@
 from dataclasses import dataclass
 from importlib import resources
 from pathlib import Path
-from stack import constants
+from stack.constants import compose_file_prefix, cluster_name_prefix
 from stack.opts import opts
 from stack.util import (
     include_exclude_check,
@@ -220,7 +220,7 @@ def _make_default_cluster_name(deployment, compose_dir, stack, include, exclude)
     if opts.o.debug:
         print(f"pre-hash descriptor: {unique_cluster_descriptor}")
     hash = hashlib.md5(unique_cluster_descriptor.encode()).hexdigest()[:16]
-    cluster = f"{constants.cluster_name_prefix}{hash}"
+    cluster = f"{cluster_name_prefix}{hash}"
     if opts.o.debug:
         print(f"Using cluster name: {cluster}")
     return cluster
@@ -276,12 +276,12 @@ def _make_cluster_context(ctx, stack, include, exclude, cluster, env_file):
         if include_exclude_check(pod_name, include, exclude):
             if pod_repository is None or pod_repository == "internal":
                 if deployment:
-                    compose_file_name = os.path.join(compose_dir, f"docker-compose-{pod_path}.yml")
+                    compose_file_name = os.path.join(compose_dir, f"{compose_file_prefix}-{pod_path}.yml")
                 else:
                     compose_file_name = resolve_compose_file(stack, pod_name)
             else:
                 if deployment:
-                    compose_file_name = os.path.join(compose_dir, f"docker-compose-{pod_name}.yml")
+                    compose_file_name = os.path.join(compose_dir, f"{compose_file_prefix}-{pod_name}.yml")
                     pod_pre_start_command = pod.get("pre_start_command")
                     pod_post_start_command = pod.get("post_start_command")
                     script_dir = compose_dir.parent.joinpath("pods", pod_name, "scripts")
@@ -292,7 +292,7 @@ def _make_cluster_context(ctx, stack, include, exclude, cluster, env_file):
                 else:
                     # TODO: fix this code for external stack with scripts
                     pod_root_dir = os.path.join(dev_root_path, pod_repository.split("/")[-1], pod["path"])
-                    compose_file_name = os.path.join(pod_root_dir, f"docker-compose-{pod_name}.yml")
+                    compose_file_name = os.path.join(pod_root_dir, f"{compose_file_prefix}-{pod_name}.yml")
                     pod_pre_start_command = pod.get("pre_start_command")
                     pod_post_start_command = pod.get("post_start_command")
                     if pod_pre_start_command is not None:

…ack/data/compose/docker-compose-test.yml …/stack/data/compose/composefile-test.ymlsrc/stack/data/compose/docker-compose-test.yml renamed to src/stack/data/compose/composefile-test.yml src/stack/data/compose/docker-compose-test.yml renamed to src/stack/data/compose/composefile-test.yml

@@ -42,7 +42,7 @@ def get_compose_dir(self):
         return self.deployment_dir.joinpath(constants.compose_dir_name)
 
     def get_compose_files(self):
-        return glob.glob(f"{self.get_compose_dir()}/docker-compose-*.yml")
+        return glob.glob(f"{self.get_compose_dir()}/{constants.compose_file_prefix}-*.yml")
 
     def get_cluster_id(self):
         return self.id

…mpose/docker-compose-webapp-template.yml …/compose/composefile-webapp-template.ymlsrc/stack/data/compose/docker-compose-webapp-template.yml renamed to src/stack/data/compose/composefile-webapp-template.yml src/stack/data/compose/docker-compose-webapp-template.yml renamed to src/stack/data/compose/composefile-webapp-template.yml

@@ -574,7 +574,7 @@ def create_operation(deployment_command_context, parsed_spec: Spec | MergedSpec,
                 else:
                     service_info["env_file"] = [shared_cfg_file]
 
-        with open(destination_compose_dir.joinpath("docker-compose-%s.yml" % pod), "w") as output_file:
+        with open(destination_compose_dir.joinpath(f"{constants.compose_file_prefix}-%s.yml" % pod), "w") as output_file:
             yaml.dump(parsed_pod_file, output_file)
 
         parsed_stack = parsed_spec.stack_for_pod(pod) if isinstance(parsed_spec, MergedSpec) else parsed_spec.load_stack()

src/stack/deploy/deploy.py

@@ -20,6 +20,7 @@
 from urllib.parse import urlparse
 from tempfile import NamedTemporaryFile
 
+from stack import constants
 from stack.util import error_exit, global_options2
 from stack.deploy.deployment_create import init_operation, create_operation
 from stack.deploy.deploy import create_deploy_context
@@ -29,7 +30,7 @@
 
 def _fixup_container_tag(deployment_dir: str, image: str):
     deployment_dir_path = Path(deployment_dir)
-    compose_file = deployment_dir_path.joinpath("compose", "docker-compose-webapp-template.yml")
+    compose_file = deployment_dir_path.joinpath("compose", f"{constants.compose_file_prefix}-webapp-template.yml")
     # replace "bpi/webapp-container:stack" in the file with our image tag
     with open(compose_file) as rfile:
         contents = rfile.read()

src/stack/deploy/deployment_context.py

@@ -23,8 +23,7 @@
 from pathlib import Path
 from dotenv import dotenv_values
 from typing import Mapping
-
-from stack.constants import deployment_file_name
+from stack.constants import deployment_file_name, compose_file_prefix
 
 STACK_USE_BUILTIN_STACK = "true" == os.environ.get("STACK_USE_BUILTIN_STACK", "false")
 
@@ -87,12 +86,29 @@ def resolve_compose_file(stack, pod_name: str):
     if stack_is_external(stack):
         # First try looking in the external stack for the compose file
         compose_base = Path(stack).parent.parent.joinpath("compose")
-        proposed_file = compose_base.joinpath(f"docker-compose-{pod_name}.yml")
+        proposed_file = compose_base.joinpath(f"{compose_file_prefix}-{pod_name}.yml")
         if proposed_file.exists():
             return proposed_file
         # If we don't find it fall through to the internal case
     compose_base = get_internal_compose_file_dir()
-    return compose_base.joinpath(f"docker-compose-{pod_name}.yml")
+    return compose_base.joinpath(f"{compose_file_prefix}-{pod_name}.yml")
+
+
+def get_pod_file_path(stack, parsed_stack, pod_name: str):
+    result = None
+    pods = parsed_stack["pods"]
+    if type(pods[0]) is str:
+        result = resolve_compose_file(stack, pod_name)
+    else:
+        for pod in pods:
+            if pod["name"] == pod_name:
+                pod_root_dir = os.path.join(
+                    get_dev_root_path(None),
+                    pod["repository"].split("@")[0].split("/")[-1],
+                    pod["path"],
+                )
+                result = os.path.join(pod_root_dir, "{compose_file_prefix}.yml")
+    return result
 
 
 def get_pod_script_paths(parsed_stack, pod_name: str):