Rearrange files (#605)

app/deploy/compose/deploy_docker.py

@@ -0,0 +1,67 @@
+# Copyright © 2022, 2023 Vulcanize
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# 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/>.
+
+from python_on_whales import DockerClient, DockerException
+from app.deploy.deployer import Deployer, DeployerException
+
+
+class DockerDeployer(Deployer):
+    name: str = "compose"
+
+    def __init__(self, compose_files, compose_project_name, compose_env_file) -> None:
+        self.docker = DockerClient(compose_files=compose_files, compose_project_name=compose_project_name,
+                                   compose_env_file=compose_env_file)
+
+    def up(self, detach, services):
+        try:
+            return self.docker.compose.up(detach=detach, services=services)
+        except DockerException as e:
+            raise DeployerException(e)
+
+    def down(self, timeout, volumes):
+        try:
+            return self.docker.compose.down(timeout=timeout, volumes=volumes)
+        except DockerException as e:
+            raise DeployerException(e)
+
+    def ps(self):
+        try:
+            return self.docker.compose.ps()
+        except DockerException as e:
+            raise DeployerException(e)
+
+    def port(self, service, private_port):
+        try:
+            return self.docker.compose.port(service=service, private_port=private_port)
+        except DockerException as e:
+            raise DeployerException(e)
+
+    def execute(self, service, command, envs):
+        try:
+            return self.docker.compose.execute(service=service, command=command, envs=envs)
+        except DockerException as e:
+            raise DeployerException(e)
+
+    def logs(self, services, tail, follow, stream):
+        try:
+            return self.docker.compose.logs(services=services, tail=tail, follow=follow, stream=stream)
+        except DockerException as e:
+            raise DeployerException(e)
+
+    def run(self, image, command, user, volumes, entrypoint=None):
+        try:
+            return self.docker.run(image=image, command=command, user=user, volumes=volumes, entrypoint=entrypoint)
+        except DockerException as e:
+            raise DeployerException(e)

app/deploy/deploy.py

@@ -0,0 +1,433 @@
+# Copyright © 2022, 2023 Vulcanize
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# 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/>.
+
+# Deploys the system components using a deployer (either docker-compose or k8s)
+
+import hashlib
+import copy
+import os
+import sys
+from dataclasses import dataclass
+from importlib import resources
+import subprocess
+import click
+from pathlib import Path
+from app.util import include_exclude_check, get_parsed_stack_config, global_options2, get_dev_root_path
+from app.deploy.deployer import Deployer, DeployerException
+from app.deploy.deployer_factory import getDeployer
+from app.deploy.deploy_types import ClusterContext, DeployCommandContext
+from app.deploy.deployment_create import create as deployment_create
+from app.deploy.deployment_create import init as deployment_init
+from app.deploy.deployment_create import setup as deployment_setup
+
+
+@click.group()
+@click.option("--include", help="only start these components")
+@click.option("--exclude", help="don\'t start these components")
+@click.option("--env-file", help="env file to be used")
+@click.option("--cluster", help="specify a non-default cluster name")
+@click.option("--deploy-to", help="cluster system to deploy to (compose or k8s)")
+@click.pass_context
+def command(ctx, include, exclude, env_file, cluster, deploy_to):
+    '''deploy a stack'''
+
+    # Although in theory for some subcommands (e.g. deploy create) the stack can be inferred,
+    # Click doesn't allow us to know that here, so we make providing the stack mandatory
+    stack = global_options2(ctx).stack
+    if not stack:
+        print("Error: --stack option is required")
+        sys.exit(1)
+
+    if ctx.parent.obj.debug:
+        print(f"ctx.parent.obj: {ctx.parent.obj}")
+
+    if deploy_to is None:
+        deploy_to = "compose"
+
+    ctx.obj = create_deploy_context(global_options2(ctx), stack, include, exclude, cluster, env_file, deploy_to)
+    # Subcommand is executed now, by the magic of click
+
+
+def create_deploy_context(global_context, stack, include, exclude, cluster, env_file, deployer):
+    cluster_context = _make_cluster_context(global_context, stack, include, exclude, cluster, env_file)
+    # See: https://gabrieldemarmiesse.github.io/python-on-whales/sub-commands/compose/
+    deployer = getDeployer(deployer, compose_files=cluster_context.compose_files, compose_project_name=cluster_context.cluster,
+                           compose_env_file=cluster_context.env_file)
+    return DeployCommandContext(stack, cluster_context, deployer)
+
+
+def up_operation(ctx, services_list, stay_attached=False):
+    global_context = ctx.parent.parent.obj
+    deploy_context = ctx.obj
+    if not global_context.dry_run:
+        cluster_context = deploy_context.cluster_context
+        container_exec_env = _make_runtime_env(global_context)
+        for attr, value in container_exec_env.items():
+            os.environ[attr] = value
+        if global_context.verbose:
+            print(f"Running compose up with container_exec_env: {container_exec_env}, extra_args: {services_list}")
+        for pre_start_command in cluster_context.pre_start_commands:
+            _run_command(global_context, cluster_context.cluster, pre_start_command)
+        deploy_context.deployer.up(detach=not stay_attached, services=services_list)
+        for post_start_command in cluster_context.post_start_commands:
+            _run_command(global_context, cluster_context.cluster, post_start_command)
+        _orchestrate_cluster_config(global_context, cluster_context.config, deploy_context.deployer, container_exec_env)
+
+
+def down_operation(ctx, delete_volumes, extra_args_list):
+    global_context = ctx.parent.parent.obj
+    if not global_context.dry_run:
+        if global_context.verbose:
+            print("Running compose down")
+        timeout_arg = None
+        if extra_args_list:
+            timeout_arg = extra_args_list[0]
+        # Specify shutdown timeout (default 10s) to give services enough time to shutdown gracefully
+        ctx.obj.deployer.down(timeout=timeout_arg, volumes=delete_volumes)
+
+
+def ps_operation(ctx):
+    global_context = ctx.parent.parent.obj
+    if not global_context.dry_run:
+        if global_context.verbose:
+            print("Running compose ps")
+        container_list = ctx.obj.deployer.ps()
+        if len(container_list) > 0:
+            print("Running containers:")
+            for container in container_list:
+                print(f"id: {container.id}, name: {container.name}, ports: ", end="")
+                ports = container.network_settings.ports
+                comma = ""
+                for port_mapping in ports.keys():
+                    mapping = ports[port_mapping]
+                    print(comma, end="")
+                    if mapping is None:
+                        print(f"{port_mapping}", end="")
+                    else:
+                        print(f"{mapping[0]['HostIp']}:{mapping[0]['HostPort']}->{port_mapping}", end="")
+                    comma = ", "
+                print()
+        else:
+            print("No containers running")
+
+
+def port_operation(ctx, extra_args):
+    global_context = ctx.parent.parent.obj
+    extra_args_list = list(extra_args) or None
+    if not global_context.dry_run:
+        if extra_args_list is None or len(extra_args_list) < 2:
+            print("Usage: port <service> <exposed-port>")
+            sys.exit(1)
+        service_name = extra_args_list[0]
+        exposed_port = extra_args_list[1]
+        if global_context.verbose:
+            print(f"Running compose port {service_name} {exposed_port}")
+        mapped_port_data = ctx.obj.deployer.port(service_name, exposed_port)
+        print(f"{mapped_port_data[0]}:{mapped_port_data[1]}")
+
+
+def exec_operation(ctx, extra_args):
+    global_context = ctx.parent.parent.obj
+    extra_args_list = list(extra_args) or None
+    if not global_context.dry_run:
+        if extra_args_list is None or len(extra_args_list) < 2:
+            print("Usage: exec <service> <cmd>")
+            sys.exit(1)
+        service_name = extra_args_list[0]
+        command_to_exec = ["sh", "-c"] + extra_args_list[1:]
+        container_exec_env = _make_runtime_env(global_context)
+        if global_context.verbose:
+            print(f"Running compose exec {service_name} {command_to_exec}")
+        try:
+            ctx.obj.deployer.execute(service_name, command_to_exec, envs=container_exec_env)
+        except DeployerException:
+            print("container command returned error exit status")
+
+
+def logs_operation(ctx, tail: int, follow: bool, extra_args: str):
+    global_context = ctx.parent.parent.obj
+    extra_args_list = list(extra_args) or None
+    if not global_context.dry_run:
+        if global_context.verbose:
+            print("Running compose logs")
+        services_list = extra_args_list if extra_args_list is not None else []
+        logs_stream = ctx.obj.deployer.logs(services=services_list, tail=tail, follow=follow, stream=True)
+        for stream_type, stream_content in logs_stream:
+            print(stream_content.decode("utf-8"), end="")
+
+
+@command.command()
+@click.argument('extra_args', nargs=-1)  # help: command: up <service1> <service2>
+@click.pass_context
+def up(ctx, extra_args):
+    extra_args_list = list(extra_args) or None
+    up_operation(ctx, extra_args_list)
+
+
+@command.command()
+@click.option("--delete-volumes/--preserve-volumes", default=False, help="delete data volumes")
+@click.argument('extra_args', nargs=-1)  # help: command: down<service1> <service2>
+@click.pass_context
+def down(ctx, delete_volumes, extra_args):
+    extra_args_list = list(extra_args) or None
+    down_operation(ctx, delete_volumes, extra_args_list)
+
+
+@command.command()
+@click.pass_context
+def ps(ctx):
+    ps_operation(ctx)
+
+
+@command.command()
+@click.argument('extra_args', nargs=-1)  # help: command: port <service1> <service2>
+@click.pass_context
+def port(ctx, extra_args):
+    port_operation(ctx, extra_args)
+
+
+@command.command()
+@click.argument('extra_args', nargs=-1)  # help: command: exec <service> <command>
+@click.pass_context
+def exec(ctx, extra_args):
+    exec_operation(ctx, extra_args)
+
+
+@command.command()
+@click.option("--tail", "-n", default=None, help="number of lines to display")
+@click.option("--follow", "-f", is_flag=True, default=False, help="follow log output")
+@click.argument('extra_args', nargs=-1)  # help: command: logs <service1> <service2>
+@click.pass_context
+def logs(ctx, tail, follow, extra_args):
+    logs_operation(ctx, tail, follow, extra_args)
+
+
+def get_stack_status(ctx, stack):
+
+    ctx_copy = copy.copy(ctx)
+    ctx_copy.stack = stack
+
+    cluster_context = _make_cluster_context(ctx_copy, stack, None, None, None, None)
+    deployer = Deployer(compose_files=cluster_context.compose_files, compose_project_name=cluster_context.cluster)
+    # TODO: refactor to avoid duplicating this code above
+    if ctx.verbose:
+        print("Running compose ps")
+    container_list = deployer.ps()
+    if len(container_list) > 0:
+        if ctx.debug:
+            print(f"Container list from compose ps: {container_list}")
+        return True
+    else:
+        if ctx.debug:
+            print("No containers found from compose ps")
+        False
+
+
+def _make_runtime_env(ctx):
+    container_exec_env = {
+        "CERC_HOST_UID": f"{os.getuid()}",
+        "CERC_HOST_GID": f"{os.getgid()}"
+    }
+    container_exec_env.update({"CERC_SCRIPT_DEBUG": "true"} if ctx.debug else {})
+    return container_exec_env
+
+
+# stack has to be either PathLike pointing to a stack yml file, or a string with the name of a known stack
+def _make_cluster_context(ctx, stack, include, exclude, cluster, env_file):
+
+    dev_root_path = get_dev_root_path(ctx)
+
+    # TODO: huge hack, fix this
+    # If the caller passed a path for the stack file, then we know that we can get the compose files
+    # from the same directory
+    deployment = False
+    if isinstance(stack, os.PathLike):
+        compose_dir = stack.parent.joinpath("compose")
+        deployment = True
+    else:
+        # See: https://stackoverflow.com/questions/25389095/python-get-path-of-root-project-structure
+        compose_dir = Path(__file__).absolute().parent.parent.joinpath("data", "compose")
+
+    if cluster is None:
+        # Create default unique, stable cluster name from confile file path and stack name if provided
+        # TODO: change this to the config file path
+        path = os.path.realpath(sys.argv[0])
+        unique_cluster_descriptor = f"{path},{stack},{include},{exclude}"
+        if ctx.debug:
+            print(f"pre-hash descriptor: {unique_cluster_descriptor}")
+        hash = hashlib.md5(unique_cluster_descriptor.encode()).hexdigest()
+        cluster = f"laconic-{hash}"
+        if ctx.verbose:
+            print(f"Using cluster name: {cluster}")
+
+    # See: https://stackoverflow.com/a/20885799/1701505
+    from app import data
+    with resources.open_text(data, "pod-list.txt") as pod_list_file:
+        all_pods = pod_list_file.read().splitlines()
+
+    pods_in_scope = []
+    if stack:
+        stack_config = get_parsed_stack_config(stack)
+        # TODO: syntax check the input here
+        pods_in_scope = stack_config['pods']
+        cluster_config = stack_config['config'] if 'config' in stack_config else None
+    else:
+        pods_in_scope = all_pods
+        cluster_config = None
+
+    # Convert all pod definitions to v1.1 format
+    pods_in_scope = _convert_to_new_format(pods_in_scope)
+
+    if ctx.verbose:
+        print(f"Pods: {pods_in_scope}")
+
+    # Construct a docker compose command suitable for our purpose
+
+    compose_files = []
+    pre_start_commands = []
+    post_start_commands = []
+    for pod in pods_in_scope:
+        pod_name = pod["name"]
+        pod_repository = pod["repository"]
+        pod_path = pod["path"]
+        if include_exclude_check(pod_name, include, exclude):
+            if pod_repository is None or pod_repository == "internal":
+                compose_file_name = os.path.join(compose_dir, f"docker-compose-{pod_path}.yml")
+            else:
+                if deployment:
+                    compose_file_name = os.path.join(compose_dir, "docker-compose.yml")
+                    pod_pre_start_command = pod["pre_start_command"]
+                    pod_post_start_command = pod["post_start_command"]
+                    script_dir = compose_dir.parent.joinpath("pods", pod_name, "scripts")
+                    if pod_pre_start_command is not None:
+                        pre_start_commands.append(os.path.join(script_dir, pod_pre_start_command))
+                    if pod_post_start_command is not None:
+                        post_start_commands.append(os.path.join(script_dir, pod_post_start_command))
+                else:
+                    pod_root_dir = os.path.join(dev_root_path, pod_repository.split("/")[-1], pod["path"])
+                    compose_file_name = os.path.join(pod_root_dir, "docker-compose.yml")
+                    pod_pre_start_command = pod["pre_start_command"]
+                    pod_post_start_command = pod["post_start_command"]
+                    if pod_pre_start_command is not None:
+                        pre_start_commands.append(os.path.join(pod_root_dir, pod_pre_start_command))
+                    if pod_post_start_command is not None:
+                        post_start_commands.append(os.path.join(pod_root_dir, pod_post_start_command))
+            compose_files.append(compose_file_name)
+        else:
+            if ctx.verbose:
+                print(f"Excluding: {pod_name}")
+
+    if ctx.verbose:
+        print(f"files: {compose_files}")
+
+    return ClusterContext(ctx, cluster, compose_files, pre_start_commands, post_start_commands, cluster_config, env_file)
+
+
+def _convert_to_new_format(old_pod_array):
+    new_pod_array = []
+    for old_pod in old_pod_array:
+        if isinstance(old_pod, dict):
+            new_pod_array.append(old_pod)
+        else:
+            new_pod = {
+                "name": old_pod,
+                "repository": "internal",
+                "path": old_pod
+            }
+            new_pod_array.append(new_pod)
+    return new_pod_array
+
+
+def _run_command(ctx, cluster_name, command):
+    if ctx.verbose:
+        print(f"Running command: {command}")
+    command_dir = os.path.dirname(command)
+    command_file = os.path.join(".", os.path.basename(command))
+    command_env = os.environ.copy()
+    command_env["CERC_SO_COMPOSE_PROJECT"] = cluster_name
+    if ctx.debug:
+        command_env["CERC_SCRIPT_DEBUG"] = "true"
+    command_result = subprocess.run(command_file, shell=True, env=command_env, cwd=command_dir)
+    if command_result.returncode != 0:
+        print(f"FATAL Error running command: {command}")
+        sys.exit(1)
+
+
+def _orchestrate_cluster_config(ctx, cluster_config, deployer, container_exec_env):
+
+    @dataclass
+    class ConfigDirective:
+        source_container: str
+        source_variable: str
+        destination_container: str
+        destination_variable: str
+
+    if cluster_config is not None:
+        for container in cluster_config:
+            container_config = cluster_config[container]
+            if ctx.verbose:
+                print(f"{container} config: {container_config}")
+            for directive in container_config:
+                pd = ConfigDirective(
+                    container_config[directive].split(".")[0],
+                    container_config[directive].split(".")[1],
+                    container,
+                    directive
+                )
+                if ctx.verbose:
+                    print(f"Setting {pd.destination_container}.{pd.destination_variable}"
+                          f" = {pd.source_container}.{pd.source_variable}")
+                # TODO: add a timeout
+                waiting_for_data = True
+                destination_output = "*** no output received yet ***"
+                while waiting_for_data:
+                    # TODO: fix the script paths so they're consistent between containers
+                    source_value = None
+                    try:
+                        source_value = deployer.execute(pd.source_container,
+                                                        ["sh", "-c",
+                                                         "sh /docker-entrypoint-scripts.d/export-"
+                                                         f"{pd.source_variable}.sh"],
+                                                        tty=False,
+                                                        envs=container_exec_env)
+                    except DeployerException as error:
+                        if ctx.debug:
+                            print(f"Docker exception reading config source: {error}")
+                        # If the script executed failed for some reason, we get:
+                        # "It returned with code 1"
+                        if "It returned with code 1" in str(error):
+                            if ctx.verbose:
+                                print("Config export script returned an error, re-trying")
+                        # If the script failed to execute (e.g. the file is not there) then we get:
+                        # "It returned with code 2"
+                        if "It returned with code 2" in str(error):
+                            print(f"Fatal error reading config source: {error}")
+                    if source_value:
+                        if ctx.debug:
+                            print(f"fetched source value: {source_value}")
+                        destination_output = deployer.execute(pd.destination_container,
+                                                              ["sh", "-c",
+                                                               f"sh /scripts/import-{pd.destination_variable}.sh"
+                                                               f" {source_value}"],
+                                                              tty=False,
+                                                              envs=container_exec_env)
+                        waiting_for_data = False
+                    if ctx.debug:
+                        print(f"destination output: {destination_output}")
+
+
+command.add_command(deployment_init)
+command.add_command(deployment_create)
+command.add_command(deployment_setup)

app/deploy/deploy_types.py

@@ -0,0 +1,68 @@
+# Copyright © 2023 Vulcanize
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# 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/>.
+
+from typing import List
+from dataclasses import dataclass
+from pathlib import Path
+from app.command_types import CommandOptions
+from app.deploy.deployer import Deployer
+
+
+@dataclass
+class ClusterContext:
+    options: CommandOptions  # TODO: this should be in its own object not stuffed in here
+    cluster: str
+    compose_files: List[str]
+    pre_start_commands: List[str]
+    post_start_commands: List[str]
+    config: str
+    env_file: str
+
+
+@dataclass
+class DeployCommandContext:
+    stack: str
+    cluster_context: ClusterContext
+    deployer: Deployer
+
+
+@dataclass
+class DeploymentContext:
+    deployment_dir: Path
+    command_context: DeployCommandContext
+
+
+@dataclass
+class VolumeMapping:
+    host_path: str
+    container_path: str
+
+
+@dataclass
+class LaconicStackSetupCommand:
+    chain_id: str
+    node_moniker: str
+    key_name: str
+    initialize_network: bool
+    join_network: bool
+    create_network: bool
+    gentx_file_list: str
+    genesis_file: str
+    network_dir: str
+
+
+@dataclass
+class LaconicStackCreateCommand:
+    network_dir: str

app/deploy/deploy_util.py

@@ -0,0 +1,62 @@
+# Copyright © 2022, 2023 Vulcanize
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# 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
+from typing import List
+from app.deploy.deploy_types import DeployCommandContext, VolumeMapping
+from app.util import get_parsed_stack_config, get_yaml, get_compose_file_dir, get_pod_list
+
+
+def _container_image_from_service(stack: str, service: str):
+    # Parse the compose files looking for the image name of the specified service
+    image_name = None
+    parsed_stack = get_parsed_stack_config(stack)
+    pods = get_pod_list(parsed_stack)
+    yaml = get_yaml()
+    for pod in pods:
+        pod_file_path = os.path.join(get_compose_file_dir(), f"docker-compose-{pod}.yml")
+        parsed_pod_file = yaml.load(open(pod_file_path, "r"))
+        if "services" in parsed_pod_file:
+            services = parsed_pod_file["services"]
+            if service in services:
+                service_definition = services[service]
+                if "image" in service_definition:
+                    image_name = service_definition["image"]
+    return image_name
+
+
+def _volumes_to_docker(mounts: List[VolumeMapping]):
+    # Example from doc: [("/", "/host"), ("/etc/hosts", "/etc/hosts", "rw")]
+    result = []
+    for mount in mounts:
+        docker_volume = (mount.host_path, mount.container_path)
+        result.append(docker_volume)
+    return result
+
+
+def run_container_command(ctx: DeployCommandContext, service: str, command: str, mounts: List[VolumeMapping]):
+    deployer = ctx.deployer
+    container_image = _container_image_from_service(ctx.stack, service)
+    docker_volumes = _volumes_to_docker(mounts)
+    if ctx.cluster_context.options.debug:
+        print(f"Running this command in {service} container: {command}")
+    docker_output = deployer.run(
+        container_image,
+        ["-c", command], entrypoint="sh",
+        user=f"{os.getuid()}:{os.getgid()}",
+        volumes=docker_volumes
+        )
+    # There doesn't seem to be a way to get an exit code from docker.run()
+    return (docker_output, 0)

app/deploy/deployer.py

@@ -0,0 +1,52 @@
+# Copyright © 2023 Vulcanize
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# 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/>.
+
+from abc import ABC, abstractmethod
+
+
+class Deployer(ABC):
+
+    @abstractmethod
+    def up(self, detach, services):
+        pass
+
+    @abstractmethod
+    def down(self, timeout, volumes):
+        pass
+
+    @abstractmethod
+    def ps(self):
+        pass
+
+    @abstractmethod
+    def port(self, service, private_port):
+        pass
+
+    @abstractmethod
+    def execute(self, service_name, command, envs):
+        pass
+
+    @abstractmethod
+    def logs(self, services, tail, follow, stream):
+        pass
+
+    @abstractmethod
+    def run(self, image, command, user, volumes, entrypoint):
+        pass
+
+
+class DeployerException(Exception):
+    def __init__(self, *args: object) -> None:
+        super().__init__(*args)

app/deploy/deployer_factory.py

@@ -0,0 +1,26 @@
+# Copyright © 2023 Vulcanize
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# 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/>.
+
+from app.deploy.k8s.deploy_k8s import K8sDeployer
+from app.deploy.compose.deploy_docker import DockerDeployer
+
+
+def getDeployer(type, compose_files, compose_project_name, compose_env_file):
+    if type == "compose" or type is None:
+        return DockerDeployer(compose_files, compose_project_name, compose_env_file)
+    elif type == "k8s":
+        return K8sDeployer(compose_files, compose_project_name, compose_env_file)
+    else:
+        print(f"ERROR: deploy-to {type} is not valid")

app/deploy/deployment.py

@@ -0,0 +1,162 @@
+# Copyright © 2022, 2023 Vulcanize
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# 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 click
+from pathlib import Path
+import sys
+from app.deploy.deploy import up_operation, down_operation, ps_operation, port_operation
+from app.deploy.deploy import exec_operation, logs_operation, create_deploy_context
+from app.deploy.stack import Stack
+from app.deploy.spec import Spec
+
+
+class DeploymentContext:
+    dir: Path
+    spec: Spec
+    stack: Stack
+
+    def get_stack_file(self):
+        return self.dir.joinpath("stack.yml")
+
+    def get_spec_file(self):
+        return self.dir.joinpath("spec.yml")
+
+    def get_env_file(self):
+        return self.dir.joinpath("config.env")
+
+    # TODO: implement me
+    def get_cluster_name(self):
+        return None
+
+    def init(self, dir):
+        self.dir = dir
+        self.stack = Stack()
+        self.stack.init_from_file(self.get_stack_file())
+        self.spec = Spec()
+        self.spec.init_from_file(self.get_spec_file())
+
+
+@click.group()
+@click.option("--dir", required=True, help="path to deployment directory")
+@click.pass_context
+def command(ctx, dir):
+    '''manage a deployment'''
+
+    # Check that --stack wasn't supplied
+    if ctx.parent.obj.stack:
+        print("Error: --stack can't be supplied with the deployment command")
+        sys.exit(1)
+    # Check dir is valid
+    dir_path = Path(dir)
+    if not dir_path.exists():
+        print(f"Error: deployment directory {dir} does not exist")
+        sys.exit(1)
+    if not dir_path.is_dir():
+        print(f"Error: supplied deployment directory path {dir} exists but is a file not a directory")
+        sys.exit(1)
+    # Store the deployment context for subcommands
+    deployment_context = DeploymentContext()
+    deployment_context.init(dir_path)
+    ctx.obj = deployment_context
+
+
+def make_deploy_context(ctx):
+    context: DeploymentContext = ctx.obj
+    stack_file_path = context.get_stack_file()
+    env_file = context.get_env_file()
+    cluster_name = context.get_cluster_name()
+    return create_deploy_context(ctx.parent.parent.obj, stack_file_path, None, None, cluster_name, env_file,
+                                 context.spec.obj["deploy-to"])
+
+
+@command.command()
+@click.option("--stay-attached/--detatch-terminal", default=False, help="detatch or not to see container stdout")
+@click.argument('extra_args', nargs=-1)  # help: command: up <service1> <service2>
+@click.pass_context
+def up(ctx, stay_attached, extra_args):
+    ctx.obj = make_deploy_context(ctx)
+    services_list = list(extra_args) or None
+    up_operation(ctx, services_list, stay_attached)
+
+
+# start is the preferred alias for up
+@command.command()
+@click.option("--stay-attached/--detatch-terminal", default=False, help="detatch or not to see container stdout")
+@click.argument('extra_args', nargs=-1)  # help: command: up <service1> <service2>
+@click.pass_context
+def start(ctx, stay_attached, extra_args):
+    ctx.obj = make_deploy_context(ctx)
+    services_list = list(extra_args) or None
+    up_operation(ctx, services_list, stay_attached)
+
+
+@command.command()
+@click.option("--delete-volumes/--preserve-volumes", default=False, help="delete data volumes")
+@click.argument('extra_args', nargs=-1)  # help: command: down <service1> <service2>
+@click.pass_context
+def down(ctx, delete_volumes, extra_args):
+    # Get the stack config file name
+    # TODO: add cluster name and env file here
+    ctx.obj = make_deploy_context(ctx)
+    down_operation(ctx, delete_volumes, extra_args)
+
+
+# stop is the preferred alias for down
+@command.command()
+@click.option("--delete-volumes/--preserve-volumes", default=False, help="delete data volumes")
+@click.argument('extra_args', nargs=-1)  # help: command: down <service1> <service2>
+@click.pass_context
+def stop(ctx, delete_volumes, extra_args):
+    # TODO: add cluster name and env file here
+    ctx.obj = make_deploy_context(ctx)
+    down_operation(ctx, delete_volumes, extra_args)
+
+
+@command.command()
+@click.pass_context
+def ps(ctx):
+    ctx.obj = make_deploy_context(ctx)
+    ps_operation(ctx)
+
+
+@command.command()
+@click.argument('extra_args', nargs=-1)  # help: command: port <service1> <service2>
+@click.pass_context
+def port(ctx, extra_args):
+    port_operation(ctx, extra_args)
+
+
+@command.command()
+@click.argument('extra_args', nargs=-1)  # help: command: exec <service> <command>
+@click.pass_context
+def exec(ctx, extra_args):
+    ctx.obj = make_deploy_context(ctx)
+    exec_operation(ctx, extra_args)
+
+
+@command.command()
+@click.option("--tail", "-n", default=None, help="number of lines to display")
+@click.option("--follow", "-f", is_flag=True, default=False, help="follow log output")
+@click.argument('extra_args', nargs=-1)  # help: command: logs <service1> <service2>
+@click.pass_context
+def logs(ctx, tail, follow, extra_args):
+    ctx.obj = make_deploy_context(ctx)
+    logs_operation(ctx, tail, follow, extra_args)
+
+
+@command.command()
+@click.pass_context
+def status(ctx):
+    print(f"Context: {ctx.parent.obj}")

app/deploy/deployment_create.py

@@ -0,0 +1,385 @@
+# Copyright © 2022, 2023 Vulcanize
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# 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 click
+from importlib import util
+import os
+from pathlib import Path
+from typing import List
+import random
+from shutil import copy, copyfile, copytree
+import sys
+from app.util import (get_stack_file_path, get_parsed_deployment_spec, get_parsed_stack_config, global_options, get_yaml,
+                      get_pod_list, get_pod_file_path, pod_has_scripts, get_pod_script_paths, get_plugin_code_path)
+from app.deploy.deploy_types import DeploymentContext, DeployCommandContext, LaconicStackSetupCommand
+
+
+def _make_default_deployment_dir():
+    return "deployment-001"
+
+
+def _get_ports(stack):
+    ports = {}
+    parsed_stack = get_parsed_stack_config(stack)
+    pods = get_pod_list(parsed_stack)
+    yaml = get_yaml()
+    for pod in pods:
+        pod_file_path = get_pod_file_path(parsed_stack, pod)
+        parsed_pod_file = yaml.load(open(pod_file_path, "r"))
+        if "services" in parsed_pod_file:
+            for svc_name, svc in parsed_pod_file["services"].items():
+                if "ports" in svc:
+                    # Ports can appear as strings or numbers.  We normalize them as strings.
+                    ports[svc_name] = [str(x) for x in svc["ports"]]
+    return ports
+
+
+def _get_named_volumes(stack):
+    # Parse the compose files looking for named volumes
+    named_volumes = []
+    parsed_stack = get_parsed_stack_config(stack)
+    pods = get_pod_list(parsed_stack)
+    yaml = get_yaml()
+    for pod in pods:
+        pod_file_path = get_pod_file_path(parsed_stack, pod)
+        parsed_pod_file = yaml.load(open(pod_file_path, "r"))
+        if "volumes" in parsed_pod_file:
+            volumes = parsed_pod_file["volumes"]
+            for volume in volumes.keys():
+                # Volume definition looks like:
+                # 'laconicd-data': None
+                named_volumes.append(volume)
+    return named_volumes
+
+
+# If we're mounting a volume from a relatie path, then we
+# assume the directory doesn't exist yet and create it
+# so the deployment will start
+# Also warn if the path is absolute and doesn't exist
+def _create_bind_dir_if_relative(volume, path_string, compose_dir):
+    path = Path(path_string)
+    if not path.is_absolute():
+        absolute_path = Path(compose_dir).parent.joinpath(path)
+        absolute_path.mkdir(parents=True, exist_ok=True)
+    else:
+        if not path.exists():
+            print(f"WARNING: mount path for volume {volume} does not exist: {path_string}")
+
+
+# See: https://stackoverflow.com/questions/45699189/editing-docker-compose-yml-with-pyyaml
+def _fixup_pod_file(pod, spec, compose_dir):
+    # Fix up volumes
+    if "volumes" in spec:
+        spec_volumes = spec["volumes"]
+        if "volumes" in pod:
+            pod_volumes = pod["volumes"]
+            for volume in pod_volumes.keys():
+                if volume in spec_volumes:
+                    volume_spec = spec_volumes[volume]
+                    volume_spec_fixedup = volume_spec if Path(volume_spec).is_absolute() else f".{volume_spec}"
+                    _create_bind_dir_if_relative(volume, volume_spec, compose_dir)
+                    new_volume_spec = {"driver": "local",
+                                       "driver_opts": {
+                                          "type": "none",
+                                          "device": volume_spec_fixedup,
+                                          "o": "bind"
+                                       }
+                                       }
+                    pod["volumes"][volume] = new_volume_spec
+    # Fix up ports
+    if "ports" in spec:
+        spec_ports = spec["ports"]
+        for container_name, container_ports in spec_ports.items():
+            if container_name in pod["services"]:
+                pod["services"][container_name]["ports"] = container_ports
+
+
+def _commands_plugin_path(ctx: DeployCommandContext):
+    plugin_path = get_plugin_code_path(ctx.stack)
+    return plugin_path.joinpath("deploy", "commands.py")
+
+
+# See: https://stackoverflow.com/a/54625079/1701505
+def _has_method(o, name):
+    return callable(getattr(o, name, None))
+
+
+def call_stack_deploy_init(deploy_command_context):
+    # Link with the python file in the stack
+    # Call a function in it
+    # If no function found, return None
+    python_file_path = _commands_plugin_path(deploy_command_context)
+    if python_file_path.exists():
+        spec = util.spec_from_file_location("commands", python_file_path)
+        imported_stack = util.module_from_spec(spec)
+        spec.loader.exec_module(imported_stack)
+        if _has_method(imported_stack, "init"):
+            return imported_stack.init(deploy_command_context)
+    else:
+        return None
+
+
+# TODO: fold this with function above
+def call_stack_deploy_setup(deploy_command_context, parameters: LaconicStackSetupCommand, extra_args):
+    # Link with the python file in the stack
+    # Call a function in it
+    # If no function found, return None
+    python_file_path = _commands_plugin_path(deploy_command_context)
+    print(f"Path: {python_file_path}")
+    if python_file_path.exists():
+        spec = util.spec_from_file_location("commands", python_file_path)
+        imported_stack = util.module_from_spec(spec)
+        spec.loader.exec_module(imported_stack)
+        if _has_method(imported_stack, "setup"):
+            return imported_stack.setup(deploy_command_context, parameters, extra_args)
+    else:
+        return None
+
+
+# TODO: fold this with function above
+def call_stack_deploy_create(deployment_context, extra_args):
+    # Link with the python file in the stack
+    # Call a function in it
+    # If no function found, return None
+    python_file_path = _commands_plugin_path(deployment_context.command_context)
+    if python_file_path.exists():
+        spec = util.spec_from_file_location("commands", python_file_path)
+        imported_stack = util.module_from_spec(spec)
+        spec.loader.exec_module(imported_stack)
+        if _has_method(imported_stack, "create"):
+            return imported_stack.create(deployment_context, extra_args)
+    else:
+        return None
+
+
+# Inspect the pod yaml to find config files referenced in subdirectories
+# other than the one associated with the pod
+def _find_extra_config_dirs(parsed_pod_file, pod):
+    config_dirs = set()
+    services = parsed_pod_file["services"]
+    for service in services:
+        service_info = services[service]
+        if "volumes" in service_info:
+            for volume in service_info["volumes"]:
+                if ":" in volume:
+                    host_path = volume.split(":")[0]
+                    if host_path.startswith("../config"):
+                        config_dir = host_path.split("/")[2]
+                        if config_dir != pod:
+                            config_dirs.add(config_dir)
+    return config_dirs
+
+
+def _get_mapped_ports(stack: str, map_recipe: str):
+    port_map_recipes = ["any-variable-random", "localhost-same", "any-same", "localhost-fixed-random", "any-fixed-random"]
+    ports = _get_ports(stack)
+    if ports:
+        # Implement any requested mapping recipe
+        if map_recipe:
+            if map_recipe in port_map_recipes:
+                for service in ports.keys():
+                    ports_array = ports[service]
+                    for x in range(0, len(ports_array)):
+                        orig_port = ports_array[x]
+                        # Strip /udp suffix if present
+                        bare_orig_port = orig_port.replace("/udp", "")
+                        random_port = random.randint(20000, 50000)  # Beware: we're relying on luck to not collide
+                        if map_recipe == "any-variable-random":
+                            # This is the default so take no action
+                            pass
+                        elif map_recipe == "localhost-same":
+                            # Replace instances of "- XX" with "- 127.0.0.1:XX"
+                            ports_array[x] = f"127.0.0.1:{bare_orig_port}:{orig_port}"
+                        elif map_recipe == "any-same":
+                            # Replace instances of "- XX" with "- 0.0.0.0:XX"
+                            ports_array[x] = f"0.0.0.0:{bare_orig_port}:{orig_port}"
+                        elif map_recipe == "localhost-fixed-random":
+                            # Replace instances of "- XX" with "- 127.0.0.1:<rnd>:XX"
+                            ports_array[x] = f"127.0.0.1:{random_port}:{orig_port}"
+                        elif map_recipe == "any-fixed-random":
+                            # Replace instances of "- XX" with "- 0.0.0.0:<rnd>:XX"
+                            ports_array[x] = f"0.0.0.0:{random_port}:{orig_port}"
+                        else:
+                            print("Error: bad map_recipe")
+            else:
+                print(f"Error: --map-ports-to-host must specify one of: {port_map_recipes}")
+                sys.exit(1)
+    return ports
+
+
+def _parse_config_variables(variable_values: str):
+    result = None
+    if variable_values:
+        value_pairs = variable_values.split(",")
+        if len(value_pairs):
+            result_values = {}
+            for value_pair in value_pairs:
+                variable_value_pair = value_pair.split("=")
+                if len(variable_value_pair) != 2:
+                    print(f"ERROR: config argument is not valid: {variable_values}")
+                    sys.exit(1)
+                variable_name = variable_value_pair[0]
+                variable_value = variable_value_pair[1]
+                result_values[variable_name] = variable_value
+            result = {"config": result_values}
+    return result
+
+
+@click.command()
+@click.option("--config", help="Provide config variables for the deployment")
+@click.option("--output", required=True, help="Write yaml spec file here")
+@click.option("--map-ports-to-host", required=False,
+              help="Map ports to the host as one of: any-variable-random (default), "
+              "localhost-same, any-same, localhost-fixed-random, any-fixed-random")
+@click.pass_context
+def init(ctx, config, output, map_ports_to_host):
+    yaml = get_yaml()
+    stack = global_options(ctx).stack
+    debug = global_options(ctx).debug
+    default_spec_file_content = call_stack_deploy_init(ctx.obj)
+    spec_file_content = {"stack": stack, "deploy-to": ctx.obj.deployer.name}
+    if default_spec_file_content:
+        spec_file_content.update(default_spec_file_content)
+    config_variables = _parse_config_variables(config)
+    if config_variables:
+        # Implement merge, since update() overwrites
+        orig_config = spec_file_content["config"]
+        new_config = config_variables["config"]
+        merged_config = {**new_config, **orig_config}
+        spec_file_content.update({"config": merged_config})
+    if debug:
+        print(f"Creating spec file for stack: {stack} with content: {spec_file_content}")
+
+    ports = _get_mapped_ports(stack, map_ports_to_host)
+    spec_file_content["ports"] = ports
+
+    named_volumes = _get_named_volumes(stack)
+    if named_volumes:
+        volume_descriptors = {}
+        for named_volume in named_volumes:
+            volume_descriptors[named_volume] = f"./data/{named_volume}"
+        spec_file_content["volumes"] = volume_descriptors
+
+    with open(output, "w") as output_file:
+        yaml.dump(spec_file_content, output_file)
+
+
+def _write_config_file(spec_file: Path, config_env_file: Path):
+    spec_content = get_parsed_deployment_spec(spec_file)
+    # Note: we want to write an empty file even if we have no config variables
+    with open(config_env_file, "w") as output_file:
+        if "config" in spec_content and spec_content["config"]:
+            config_vars = spec_content["config"]
+            if config_vars:
+                for variable_name, variable_value in config_vars.items():
+                    output_file.write(f"{variable_name}={variable_value}\n")
+
+
+def _copy_files_to_directory(file_paths: List[Path], directory: Path):
+    for path in file_paths:
+        # Using copy to preserve the execute bit
+        copy(path, os.path.join(directory, os.path.basename(path)))
+
+
+@click.command()
+@click.option("--spec-file", required=True, help="Spec file to use to create this deployment")
+@click.option("--deployment-dir", help="Create deployment files in this directory")
+# TODO: Hack
+@click.option("--network-dir", help="Network configuration supplied in this directory")
+@click.option("--initial-peers", help="Initial set of persistent peers")
+@click.pass_context
+def create(ctx, spec_file, deployment_dir, network_dir, initial_peers):
+    # This function fails with a useful error message if the file doens't exist
+    parsed_spec = get_parsed_deployment_spec(spec_file)
+    stack_name = parsed_spec['stack']
+    stack_file = get_stack_file_path(stack_name)
+    parsed_stack = get_parsed_stack_config(stack_name)
+    if global_options(ctx).debug:
+        print(f"parsed spec: {parsed_spec}")
+    if deployment_dir is None:
+        deployment_dir = _make_default_deployment_dir()
+    if os.path.exists(deployment_dir):
+        print(f"Error: {deployment_dir} already exists")
+        sys.exit(1)
+    os.mkdir(deployment_dir)
+    # Copy spec file and the stack file into the deployment dir
+    copyfile(spec_file, os.path.join(deployment_dir, "spec.yml"))
+    copyfile(stack_file, os.path.join(deployment_dir, os.path.basename(stack_file)))
+    # Copy any config varibles from the spec file into an env file suitable for compose
+    _write_config_file(spec_file, os.path.join(deployment_dir, "config.env"))
+    # Copy the pod files into the deployment dir, fixing up content
+    pods = get_pod_list(parsed_stack)
+    destination_compose_dir = os.path.join(deployment_dir, "compose")
+    os.mkdir(destination_compose_dir)
+    destination_pods_dir = os.path.join(deployment_dir, "pods")
+    os.mkdir(destination_pods_dir)
+    data_dir = Path(__file__).absolute().parent.parent.joinpath("data")
+    yaml = get_yaml()
+    for pod in pods:
+        pod_file_path = get_pod_file_path(parsed_stack, pod)
+        parsed_pod_file = yaml.load(open(pod_file_path, "r"))
+        extra_config_dirs = _find_extra_config_dirs(parsed_pod_file, pod)
+        destination_pod_dir = os.path.join(destination_pods_dir, pod)
+        os.mkdir(destination_pod_dir)
+        if global_options(ctx).debug:
+            print(f"extra config dirs: {extra_config_dirs}")
+        _fixup_pod_file(parsed_pod_file, parsed_spec, destination_compose_dir)
+        with open(os.path.join(destination_compose_dir, os.path.basename(pod_file_path)), "w") as output_file:
+            yaml.dump(parsed_pod_file, output_file)
+        # Copy the config files for the pod, if any
+        config_dirs = {pod}
+        config_dirs = config_dirs.union(extra_config_dirs)
+        for config_dir in config_dirs:
+            source_config_dir = data_dir.joinpath("config", config_dir)
+            if os.path.exists(source_config_dir):
+                destination_config_dir = os.path.join(deployment_dir, "config", config_dir)
+                # If the same config dir appears in multiple pods, it may already have been copied
+                if not os.path.exists(destination_config_dir):
+                    copytree(source_config_dir, destination_config_dir)
+        # Copy the script files for the pod, if any
+        if pod_has_scripts(parsed_stack, pod):
+            destination_script_dir = os.path.join(destination_pod_dir, "scripts")
+            os.mkdir(destination_script_dir)
+            script_paths = get_pod_script_paths(parsed_stack, pod)
+            _copy_files_to_directory(script_paths, destination_script_dir)
+    # Delegate to the stack's Python code
+    # The deploy create command doesn't require a --stack argument so we need to insert the
+    # stack member here.
+    deployment_command_context = ctx.obj
+    deployment_command_context.stack = stack_name
+    deployment_context = DeploymentContext(Path(deployment_dir), deployment_command_context)
+    call_stack_deploy_create(deployment_context, [network_dir, initial_peers])
+
+
+# TODO: this code should be in the stack .py files but
+# we haven't yet figured out how to integrate click across
+# the plugin boundary
+@click.command()
+@click.option("--node-moniker", help="Moniker for this node")
+@click.option("--chain-id", help="The new chain id")
+@click.option("--key-name", help="Name for new node key")
+@click.option("--gentx-files", help="List of comma-delimited gentx filenames from other nodes")
+@click.option("--genesis-file", help="Genesis file for the network")
+@click.option("--initialize-network", is_flag=True, default=False, help="Initialize phase")
+@click.option("--join-network", is_flag=True, default=False, help="Join phase")
+@click.option("--create-network", is_flag=True, default=False, help="Create phase")
+@click.option("--network-dir", help="Directory for network files")
+@click.argument('extra_args', nargs=-1)
+@click.pass_context
+def setup(ctx, node_moniker, chain_id, key_name, gentx_files, genesis_file, initialize_network, join_network, create_network,
+          network_dir, extra_args):
+    parmeters = LaconicStackSetupCommand(chain_id, node_moniker, key_name, initialize_network, join_network, create_network,
+                                         gentx_files, genesis_file, network_dir)
+    call_stack_deploy_setup(ctx.obj, parmeters, extra_args)

app/deploy/k8s/deploy_k8s.py

@@ -0,0 +1,46 @@
+# Copyright © 2023 Vulcanize
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# 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/>.
+
+from kubernetes import client, config
+from app.deploy.deployer import Deployer
+
+
+class K8sDeployer(Deployer):
+    name: str = "k8s"
+
+    def __init__(self, compose_files, compose_project_name, compose_env_file) -> None:
+        config.load_kube_config()
+        self.client = client.CoreV1Api()
+
+    def up(self, detach, services):
+        pass
+
+    def down(self, timeout, volumes):
+        pass
+
+    def ps(self):
+        pass
+
+    def port(self, service, private_port):
+        pass
+
+    def execute(self, service_name, command, envs):
+        pass
+
+    def logs(self, services, tail, follow, stream):
+        pass
+
+    def run(self, image, command, user, volumes, entrypoint=None):
+        pass

app/deploy/spec.py

@@ -0,0 +1,30 @@
+# Copyright © 2022, 2023 Vulcanize
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# 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/>.
+
+from pathlib import Path
+import typing
+from app.util import get_yaml
+
+
+class Spec:
+
+    obj: typing.Any
+
+    def __init__(self) -> None:
+        pass
+
+    def init_from_file(self, file_path: Path):
+        with file_path:
+            self.obj = get_yaml().load(open(file_path, "r"))

app/deploy/stack.py

@@ -0,0 +1,30 @@
+# Copyright © 2023 Vulcanize
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# 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/>.
+
+from pathlib import Path
+import typing
+from app.util import get_yaml
+
+
+class Stack:
+
+    obj: typing.Any
+
+    def __init__(self) -> None:
+        pass
+
+    def init_from_file(self, file_path: Path):
+        with file_path:
+            self.obj = get_yaml().load(open(file_path, "r"))

app/deploy/stack_state.py

@@ -0,0 +1,23 @@
+# Copyright © 2023 Vulcanize
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# 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/>.
+
+from enum import Enum
+
+
+class State(Enum):
+    CREATED = 1
+    CONFIGURED = 2
+    STARTED = 3
+    STOPPED = 4