Merge pull request #193 from cerc-io/dboreham/disable-docker-buildkit

Revert move to BuildKit in new Docker releases

Former-commit-id: 4fdb442263

app/base.py

@@ -0,0 +1,71 @@
+# Copyright © 2022, 2023 Cerc
+
+# 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 abc import ABC, abstractmethod
+from .deploy_system import get_stack_status
+
+
+def get_stack(config, stack):
+    if stack == "package-registry":
+        return package_registry_stack(config, stack)
+    else:
+        return base_stack(config, stack)
+
+
+class base_stack(ABC):
+
+    def __init__(self, config, stack):
+        self.config = config
+        self.stack = stack
+
+    @abstractmethod
+    def ensure_available(self):
+        pass
+
+    @abstractmethod
+    def get_url(self):
+        pass
+
+
+class package_registry_stack(base_stack):
+
+    def ensure_available(self):
+        self.url = "<no registry url set>"
+        # Check if we were given an external registry URL
+        url_from_environment = os.environ.get("CERC_NPM_REGISTRY_URL")
+        if url_from_environment:
+            if self.config.verbose:
+                print(f"Using package registry url from CERC_NPM_REGISTRY_URL: {url_from_environment}")
+            self.url = url_from_environment
+        else:
+            # Otherwise we expect to use the local package-registry stack
+            # First check if the stack is up
+            registry_running = get_stack_status(self.config, "package-registry")
+            if registry_running:
+                # If it is available, get its mapped port and construct its URL
+                if self.config.debug:
+                    print("Found local package registry stack is up")
+                # TODO: get url from deploy-stack
+                self.url = "http://gitea.local:3000/api/packages/cerc-io/npm/"
+            else:
+                # If not, print a message about how to start it and return fail to the caller
+                print("ERROR: The package-registry stack is not running, and no external registry specified with CERC_NPM_REGISTRY_URL")
+                print("ERROR: Start the local package registry with: laconic-so --stack package-registry deploy-system up")
+                return False
+        return True
+
+    def get_url(self):
+        return self.url

app/build_containers.py

@@ -83,7 +83,10 @@ def command(ctx, include, exclude):
     container_build_env = {
         "CERC_NPM_URL": "http://gitea.local:3000/api/packages/cerc-io/npm/",
         "CERC_NPM_AUTH_TOKEN": config("CERC_NPM_AUTH_TOKEN", default="<token-not-supplied>"),
-        "CERC_REPO_BASE_DIR": dev_root_path
+        "CERC_REPO_BASE_DIR": dev_root_path,
+        "CERC_HOST_UID": f"{os.getuid()}",
+        "CERC_HOST_GID": f"{os.getgid()}",
+        "DOCKER_BUILDKIT": "0"
     }
 
     def process_container(container):
@@ -103,10 +106,10 @@ def command(ctx, include, exclude):
             # Check if we have a repo for this container. If not, set the context dir to the container-build subdir
             repo_full_path = os.path.join(dev_root_path, repo_dir)
             repo_dir_or_build_dir = repo_dir if os.path.exists(repo_full_path) else build_dir
-            build_command = os.path.join(container_build_dir, "default-build.sh") + f" {container} {repo_dir_or_build_dir}"
+            build_command = os.path.join(container_build_dir, "default-build.sh") + f" {container}:local {repo_dir_or_build_dir}"
         if not dry_run:
             if verbose:
-                print(f"Executing: {build_command}")
+                print(f"Executing: {build_command} with environment: {container_build_env}")
             build_result = subprocess.run(build_command, shell=True, env=container_build_env)
             if verbose:
                 print(f"Return code is: {build_result.returncode}")

app/build_npms.py

@@ -20,12 +20,16 @@
 
 import os
 import sys
+from shutil import rmtree, copytree
 from decouple import config
 import click
 import importlib.resources
 from python_on_whales import docker, DockerException
+from .base import get_stack
 from .util import include_exclude_check, get_parsed_stack_config
 
+builder_js_image_name = "cerc/builder-js:local"
+
 @click.command()
 @click.option('--include', help="only build these packages")
 @click.option('--exclude', help="don\'t build these packages")
@@ -41,17 +45,38 @@ def command(ctx, include, exclude):
     stack = ctx.obj.stack
     continue_on_error = ctx.obj.continue_on_error
 
+    _ensure_prerequisites()
+
+    # build-npms depends on having access to a writable package registry
+    # so we check here that it is available
+    package_registry_stack = get_stack(ctx.obj, "package-registry")
+    registry_available = package_registry_stack.ensure_available()
+    if not registry_available:
+        print("FATAL: no npm registry available for build-npms command")
+        sys.exit(1)
+    npm_registry_url = package_registry_stack.get_url()
+    npm_registry_url_token = config("CERC_NPM_AUTH_TOKEN", default=None)
+    if not npm_registry_url_token:
+        print("FATAL: CERC_NPM_AUTH_TOKEN is not defined")
+        sys.exit(1)
+
     if local_stack:
         dev_root_path = os.getcwd()[0:os.getcwd().rindex("stack-orchestrator")]
         print(f'Local stack dev_root_path (CERC_REPO_BASE_DIR) overridden to: {dev_root_path}')
     else:
         dev_root_path = os.path.expanduser(config("CERC_REPO_BASE_DIR", default="~/cerc"))
 
-    if not quiet:
+    build_root_path = os.path.join(dev_root_path, "build-trees")
+
+    if verbose:
         print(f'Dev Root is: {dev_root_path}')
 
     if not os.path.isdir(dev_root_path):
         print('Dev root directory doesn\'t exist, creating')
+        os.makedirs(dev_root_path)
+    if not os.path.isdir(dev_root_path):
+        print('Build root directory doesn\'t exist, creating')
+        os.makedirs(build_root_path)
 
     # See: https://stackoverflow.com/a/20885799/1701505
     from . import data
@@ -74,21 +99,38 @@ def command(ctx, include, exclude):
             print(f"Building npm package: {package}")
         repo_dir = package
         repo_full_path = os.path.join(dev_root_path, repo_dir)
-        # TODO: make the npm registry url configurable.
-        build_command = ["sh", "-c", "cd /workspace && build-npm-package-local-dependencies.sh http://gitea.local:3000/api/packages/cerc-io/npm/"]
+        # Copy the repo and build that to avoid propagating JS tooling file changes back into the cloned repo
+        repo_copy_path = os.path.join(build_root_path, repo_dir)
+        # First delete any old build tree
+        if os.path.isdir(repo_copy_path):
+            if verbose:
+                print(f"Deleting old build tree: {repo_copy_path}")
+            if not dry_run:
+                rmtree(repo_copy_path)
+        # Now copy the repo into the build tree location
+        if verbose:
+            print(f"Copying build tree from: {repo_full_path} to: {repo_copy_path}")
+        if not dry_run:
+            copytree(repo_full_path, repo_copy_path)
+        build_command = ["sh", "-c", f"cd /workspace && build-npm-package-local-dependencies.sh {npm_registry_url}"]
         if not dry_run:
             if verbose:
                 print(f"Executing: {build_command}")
-            envs = {"CERC_NPM_AUTH_TOKEN": os.environ["CERC_NPM_AUTH_TOKEN"]} | ({"CERC_SCRIPT_DEBUG": "true"} if debug else {})
+            # Originally we used the PEP 584 merge operator:
+            # envs = {"CERC_NPM_AUTH_TOKEN": npm_registry_url_token} | ({"CERC_SCRIPT_DEBUG": "true"} if debug else {})
+            # but that isn't available in Python 3.8 (default in Ubuntu 20) so for now we use dict.update:
+            envs = {"CERC_NPM_AUTH_TOKEN": npm_registry_url_token}
+            envs.update({"CERC_SCRIPT_DEBUG": "true"} if debug else {})
             try:
-                docker.run("cerc/builder-js",
+                docker.run(builder_js_image_name,
                            remove=True,
                            interactive=True,
                            tty=True,
                            user=f"{os.getuid()}:{os.getgid()}",
                            envs=envs,
+                           # TODO: detect this host name in npm_registry_url rather than hard-wiring it
                            add_hosts=[("gitea.local", "host-gateway")],
-                           volumes=[(repo_full_path, "/workspace")],
+                           volumes=[(repo_copy_path, "/workspace")],
                            command=build_command
                            )
                 # Note that although the docs say that build_result should contain
@@ -111,3 +153,13 @@ def command(ctx, include, exclude):
         else:
             if verbose:
                 print(f"Excluding: {package}")
+
+
+def _ensure_prerequisites():
+    # Check that the builder-js container is available and
+    # Tell the user how to build it if not
+    images = docker.image.list(builder_js_image_name)
+    if len(images) == 0:
+        print(f"FATAL: builder image: {builder_js_image_name} is required but was not found")
+        print("Please run this command to create it: laconic-so --stack build-support build-containers")
+        sys.exit(1)

app/data/compose/docker-compose-fixturenet-eth-metrics.yml

@@ -13,6 +13,8 @@ services:
   grafana:
     restart: always
     image: grafana/grafana
+    environment:
+      - GF_SECURITY_ADMIN_PASSWORD=changeme6325
     volumes:
       - ../config/fixturenet-eth-metrics/grafana/etc/provisioning/dashboards:/etc/grafana/provisioning/dashboards
       - ../config/fixturenet-eth-metrics/grafana/etc/provisioning/datasources:/etc/grafana/provisioning/datasources

app/data/compose/docker-compose-kubo.yml

@@ -0,0 +1,13 @@
+version: "3.2"
+# See: https://docs.ipfs.tech/install/run-ipfs-inside-docker/#set-up
+services:
+  ipfs:
+    image: ipfs/kubo:master-2023-02-20-714a968
+    restart: always
+    volumes:
+      - ./ipfs/import:/import
+      - ./ipfs/data:/data/ipfs
+    ports:
+      - "8080"
+      - "4001"
+      - "5001"

app/data/container-build/cerc-builder-gerbil/Dockerfile

@@ -16,6 +16,12 @@ RUN apt-get update && export DEBIAN_FRONTEND=noninteractive && export DEBCONF_NO
 RUN mkdir /scripts
 COPY install-dependencies.sh /scripts
 
+# Override the definition of GERBIL_PATH in the base image, but
+# is safe because (at present) no gerbil packages are installed in the base image
+# We do this in order to allow a set of pre-installed packages from the container
+# to be used with an arbitrary, potentially different set of projects bind mounted
+# at /src
+ENV GERBIL_PATH=/.gerbil
 RUN bash /scripts/install-dependencies.sh
 
 # Needed to prevent git from raging about /src

app/data/container-build/cerc-builder-gerbil/install-dependencies.sh

@@ -10,6 +10,7 @@ DEPS=(github.com/fare/gerbil-utils
       github.com/vyzo/gerbil-libp2p
       ) ;
 for i in ${DEPS[@]} ; do
+  echo "Installing gerbil package: $i"
   gxpkg install $i &&
   gxpkg build $i
 done

app/data/container-build/cerc-builder-js/Dockerfile

@@ -1,14 +1,30 @@
 # Originally from: https://github.com/devcontainers/images/blob/main/src/javascript-node/.devcontainer/Dockerfile
+# Which depends on: https://github.com/nodejs/docker-node/blob/main/Dockerfile-debian.template
 # [Choice] Node.js version (use -bullseye variants on local arm64/Apple Silicon): 18, 16, 14, 18-bullseye, 16-bullseye, 14-bullseye, 18-buster, 16-buster, 14-buster
 ARG VARIANT=16-bullseye
 FROM node:${VARIANT}
 
+# Set these args to change the uid/gid for the base container's "node" user to match that of the host user (so bind mounts work as expected).
+ARG CERC_HOST_UID=1000
+ARG CERC_HOST_GID=1000
+# Make these values available at runtime to allow a consistency check.
+ENV HOST_UID=${CERC_HOST_UID}
+ENV HOST_GID=${CERC_HOST_GID}
+
 ARG USERNAME=node
 ARG NPM_GLOBAL=/usr/local/share/npm-global
 
 # Add NPM global to PATH.
 ENV PATH=${NPM_GLOBAL}/bin:${PATH}
 
+RUN \
+    if [ ${CERC_HOST_GID} -ne 1000 ] ; then \
+        groupmod -g ${CERC_HOST_GID} ${USERNAME} ; \
+    fi \
+    && if [ ${CERC_HOST_UID} -ne 1000 ] ; then \
+        usermod -u ${CERC_HOST_UID} -g ${CERC_HOST_GID} ${USERNAME} && chown ${CERC_HOST_UID}:${CERC_HOST_GID} /home/${USERNAME} ; \
+    fi
+
 RUN \
     # Configure global npm install location, use group to adapt to UID/GID changes
     if ! cat /etc/group | grep -e "^npm:" > /dev/null 2>&1; then groupadd -r npm; fi \
@@ -39,6 +55,7 @@ RUN mkdir /scripts
 COPY build-npm-package.sh /scripts
 COPY yarn-local-registry-fixup.sh /scripts
 COPY build-npm-package-local-dependencies.sh /scripts
+COPY check-uid.sh /scripts
 ENV PATH="${PATH}:/scripts"
 
 COPY entrypoint.sh .

app/data/container-build/cerc-builder-js/check-uid.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+# Make the container usable for uid/gid != 1000
+if [[ -n "$CERC_SCRIPT_DEBUG" ]]; then
+    set -x
+fi
+current_uid=$(id -u)
+current_gid=$(id -g)
+# Don't check if running as root
+if [[ ${current_uid} == 0 ]]; then
+    exit 0
+fi
+# Check the current uid/gid vs the uid/gid used to build the container.
+# We do this because both bind mounts and npm tooling require the uid/gid to match.
+if [[ ${current_gid} != ${HOST_GID} ]]; then
+    echo "Warning: running with gid: ${current_gid} which is not the gid for which this container was built (${HOST_GID})"
+    exit 0
+fi
+if [[ ${current_uid} != ${HOST_UID} ]]; then
+    echo "Warning: running with gid: ${current_uid} which is not the uid for which this container was built (${HOST_UID})"
+    exit 0
+fi

app/data/container-build/cerc-builder-js/entrypoint.sh

@@ -1,2 +1,3 @@
 #!/bin/sh
+/scripts/check-uid.sh
 exec "$@"

app/data/container-build/cerc-go-ethereum-foundry/Dockerfile

@@ -1,6 +1,4 @@
-# Use locally build foundry base image to work around there being
-# no aarm64 image published.
-FROM foundry-rs/foundry:local
+FROM ghcr.io/foundry-rs/foundry
 
 RUN apk update ; apk add --no-cache --allow-untrusted ca-certificates curl bash git jq
 RUN apk add --no-cache --upgrade grep

app/data/container-build/cerc-keycloak/Dockerfile

@@ -1,4 +1,4 @@
 FROM quay.io/keycloak/keycloak:20.0
 WORKDIR /opt/keycloak/providers
 RUN curl -L https://github.com/aerogear/keycloak-metrics-spi/releases/download/2.5.3/keycloak-metrics-spi-2.5.3.jar --output keycloak-metrics-spi.jar
-RUN curl -L https://github.com/cerc-io/keycloak-api-key-demo/releases/download/v0.2/api-key-module-0.2.jar --output api-key-module.jar
+RUN curl -L https://github.com/cerc-io/keycloak-api-key-demo/releases/download/v0.3/api-key-module-0.3.jar --output api-key-module.jar

app/data/container-build/default-build.sh

@@ -1,6 +1,9 @@
 #!/usr/bin/env bash
 # Usage: default-build.sh <image-tag> [<repo-relative-path>]
 # if <repo-relative-path> is not supplied, the context is the directory where the Dockerfile lives
+if [[ -n "$CERC_SCRIPT_DEBUG" ]]; then
+    set -x
+fi
 if [[ $# -ne 2 ]]; then
     echo "Illegal number of parameters" >&2
     exit 1
@@ -8,4 +11,4 @@ fi
 image_tag=$1
 build_dir=$2
 echo "Building ${image_tag} in ${build_dir}"
-docker build -t ${image_tag} ${build_dir}
+docker build -t ${image_tag} --build-arg CERC_HOST_UID=${CERC_HOST_UID} --build-arg CERC_HOST_GID=${CERC_HOST_GID} ${build_dir}

app/data/pod-list.txt

@@ -18,3 +18,4 @@ test
 eth-probe
 keycloak
 tx-spammer
+kubo

app/data/stacks/build-support/README.md

@@ -0,0 +1,30 @@
+# Build Support Stack
+
+## Instructions
+
+JS/TS/NPM builds need an npm registry to store intermediate package artifacts.
+This can be supplied by the user (e.g. using a hosted registry or even npmjs.com), or a local registry using gitea can be deployed by stack orchestrator.
+To use a user-supplied registry set these environment variables:
+
+`CERC_NPM_REGISTRY_URL` and 
+`CERC_NPM_AUTH_TOKEN`
+
+Leave `CERC_NPM_REGISTRY_URL` un-set to use the local gitea registry.
+
+### Build support containers
+```
+$ laconic-so --stack build-support build-containers
+```
+### Deploy Gitea Package Registry
+
+```
+$ laconic-so --stack package-registry setup-repositories
+$ laconic-so --stack package-registry deploy-system up
+This is your gitea access token: 84fe66a73698bf11edbdccd0a338236b7d1d5c45. Keep it safe and secure, it can not be fetched again from gitea.
+$ export CERC_NPM_AUTH_TOKEN=84fe66a73698bf11edbdccd0a338236b7d1d5c45
+```
+Now npm packages can be built:
+### Build npm Packages
+```
+$ laconic-so build-npms --include laconic-sdk
+```

app/data/stacks/build-support/stack.yml

@@ -0,0 +1,6 @@
+version: "1.1"
+name: build-support
+decription: "Build Support Components"
+containers:
+  - cerc/builder-js
+  - cerc/builder-gerbil

app/data/stacks/erc20/README.md

@@ -7,13 +7,13 @@ Instructions to deploy a local ERC20 watcher stack (core + watcher) for demonstr
 Clone required repositories:
 
 ```bash
-laconic-so setup-repositories --include cerc-io/go-ethereum,cerc-io/ipld-eth-db,cerc-io/ipld-eth-server,cerc-io/watcher-ts 
+laconic-so --stack erc20 setup-repositories
 ```
 
 Build the core and watcher container images:
 
 ```bash
-laconic-so build-containers --include cerc/go-ethereum,cerc/go-ethereum-foundry,cerc/ipld-eth-db,cerc/ipld-eth-server,cerc/watcher-erc20
+laconic-so --stack erc20 build-containers
 ```
 
 This should create the required docker images in the local image registry.
@@ -21,7 +21,7 @@ This should create the required docker images in the local image registry.
 Deploy the stack:
 
 ```bash
-laconic-so deploy-system --include ipld-eth-db,go-ethereum-foundry,ipld-eth-server,watcher-erc20 up
+laconic-so --stack erc20 deploy-system up
 ```
 
 ## Demo
@@ -153,5 +153,5 @@ Transfer funds between different accounts using MetaMask and use the playground
 To stop all the services running in background run:
 
 ```bash
-laconic-so deploy-system --include ipld-eth-db,go-ethereum-foundry,ipld-eth-server,watcher-erc20 down
+laconic-so --stack erc20 deploy-system down
 ```

app/data/stacks/erc721/README.md

@@ -6,23 +6,23 @@ Instructions to deploy a local ERC721 watcher stack (core + watcher) for demonst
 
 * Clone / pull required repositories:
 
-  ```bash
-  $ laconic-so setup-repositories --include cerc-io/go-ethereum,cerc-io/ipld-eth-db,cerc-io/ipld-eth-server,cerc-io/watcher-ts --pull
-  ```
+```bash
+laconic-so --stack erc721 setup-repositories
+```
 
 * Build the core and watcher container images:
 
-  ```bash
-  $ laconic-so build-containers --include cerc/go-ethereum,cerc/go-ethereum-foundry,cerc/ipld-eth-db,cerc/ipld-eth-server,cerc/watcher-erc721
-  ```
+```bash
+laconic-so --stack erc721 build-containers
+```
 
   This should create the required docker images in the local image registry.
 
 * Deploy the stack:
 
-  ```bash
-  $ laconic-so deploy-system --include db,go-ethereum-foundry,ipld-eth-server,watcher-erc721 up
-  ```
+```bash
+laconic-so --stack erc721 deploy-system up
+```
 
 ## Demo
 
@@ -209,6 +209,6 @@ Instructions to deploy a local ERC721 watcher stack (core + watcher) for demonst
 
 * To stop all the services running in background:
 
-  ```bash
-  $ laconic-so deploy-system --include db,go-ethereum-foundry,ipld-eth-server,watcher-erc721 down
-  ```
+```bash
+laconic-so --stack erc721 deploy-system down
+```

app/data/stacks/fixturenet-eth-loaded/README.md

@@ -0,0 +1,6 @@
+# fixturenet-eth
+
+A "loaded" version of fixturenet-eth, with all the bells and whistles enabled.
+
+TODO: write me
+

app/data/stacks/fixturenet-eth-loaded/stack.yml

@@ -0,0 +1,24 @@
+version: "1.0"
+name: fixturenet-eth-loaded
+decription: "Loaded Ethereum Fixturenet"
+repos:
+  - cerc-io/go-ethereum
+  - cerc-io/tx-spammer
+  - cerc-io/ipld-eth-server
+  - cerc-io/ipld-eth-db
+  - cerc/go-ethereum
+containers:
+  - cerc/lighthouse
+  - cerc/fixturenet-eth-geth
+  - cerc/fixturenet-eth-lighthouse
+  - cerc/ipld-eth-server
+  - cerc/ipld-eth-db
+  - cerc/keycloak
+  - cerc/tx-spammer
+pods:
+  - fixturenet-eth
+  - tx-spammer
+  - fixturenet-eth-metrics
+  - keycloak
+  - ipld-eth-server
+  - ipld-eth-db

app/data/stacks/package-registry/stack.yml

@@ -0,0 +1,11 @@
+version: "1.1"
+name: package-registry
+decription: "Local Package Registry"
+repos:
+  - cerc-io/hosting
+pods:
+  - name: gitea
+    repository: cerc-io/hosting
+    path: gitea
+    pre_start_command: "run-this-first.sh"
+    post_start_command: "initialize-gitea.sh"

app/data/version.txt

@@ -1,2 +1,2 @@
 # This file should be re-generated running: scripts/update-version-file.sh script
-v1.0.16-ecf943b
+v1.0.21-c52f9e6

app/deploy_system.py

@@ -16,8 +16,11 @@
 # Deploys the system components using docker-compose
 
 import hashlib
+import copy
 import os
 import sys
+from decouple import config
+import subprocess
 from python_on_whales import DockerClient
 import click
 import importlib.resources
@@ -40,53 +43,14 @@ def command(ctx, include, exclude, cluster, command, extra_args):
     debug = ctx.obj.debug
     quiet = ctx.obj.quiet
     verbose = ctx.obj.verbose
+    local_stack = ctx.obj.local_stack
     dry_run = ctx.obj.dry_run
     stack = ctx.obj.stack
 
-    # See: https://stackoverflow.com/questions/25389095/python-get-path-of-root-project-structure
-    compose_dir = Path(__file__).absolute().parent.joinpath("data", "compose")
-
-    if cluster is None:
-        # Create default unique, stable cluster name from confile file path
-        # TODO: change this to the config file path
-        path = os.path.realpath(sys.argv[0])
-        hash = hashlib.md5(path.encode()).hexdigest()
-        cluster = f"laconic-{hash}"
-        if verbose:
-            print(f"Using cluster name: {cluster}")
-
-    # See: https://stackoverflow.com/a/20885799/1701505
-    from . import data
-    with importlib.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']
-    else:
-        pods_in_scope = all_pods
-
-    if verbose:
-        print(f"Pods: {pods_in_scope}")
-
-    # Construct a docker compose command suitable for our purpose
-
-    compose_files = []
-    for pod in pods_in_scope:
-        if include_exclude_check(pod, include, exclude):
-            compose_file_name = os.path.join(compose_dir, f"docker-compose-{pod}.yml")
-            compose_files.append(compose_file_name)
-        else:
-            if verbose:
-                print(f"Excluding: {pod}")
-
-    if verbose:
-        print(f"files: {compose_files}")
+    cluster_context = _make_cluster_context(ctx.obj, include, exclude, cluster)
 
     # See: https://gabrieldemarmiesse.github.io/python-on-whales/sub-commands/compose/
-    docker = DockerClient(compose_files=compose_files, compose_project_name=cluster)
+    docker = DockerClient(compose_files=cluster_context.compose_files, compose_project_name=cluster_context.cluster)
 
     extra_args_list = list(extra_args) or None
 
@@ -96,7 +60,11 @@ def command(ctx, include, exclude, cluster, command, extra_args):
                 os.environ["CERC_SCRIPT_DEBUG"] = "true"
             if verbose:
                 print(f"Running compose up for extra_args: {extra_args_list}")
+            for pre_start_command in cluster_context.pre_start_commands:
+                _run_command(ctx.obj, cluster_context.cluster, pre_start_command)
             docker.compose.up(detach=True, services=extra_args_list)
+            for post_start_command in cluster_context.post_start_commands:
+                _run_command(ctx.obj, cluster_context.cluster, post_start_command)
         elif command == "down":
             if verbose:
                 print("Running compose down")
@@ -148,3 +116,133 @@ def command(ctx, include, exclude, cluster, command, extra_args):
             if verbose:
                 print("Running compose logs")
             docker.compose.logs()
+
+
+def get_stack_status(ctx, stack):
+
+    ctx_copy = copy.copy(ctx)
+    ctx_copy.stack = stack
+
+    cluster_context = _make_cluster_context(ctx_copy, None, None, None)
+    docker = DockerClient(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 = docker.compose.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_cluster_context(ctx, include, exclude, cluster):
+
+    if ctx.local_stack:
+        dev_root_path = os.getcwd()[0:os.getcwd().rindex("stack-orchestrator")]
+        print(f'Local stack dev_root_path (CERC_REPO_BASE_DIR) overridden to: {dev_root_path}')
+    else:
+        dev_root_path = os.path.expanduser(config("CERC_REPO_BASE_DIR", default="~/cerc"))
+
+    # See: https://stackoverflow.com/questions/25389095/python-get-path-of-root-project-structure
+    compose_dir = Path(__file__).absolute().parent.joinpath("data", "compose")
+
+    if cluster is None:
+        # Create default unique, stable cluster name from confile file path
+        # TODO: change this to the config file path
+        path = os.path.realpath(sys.argv[0])
+        hash = hashlib.md5(path.encode()).hexdigest()
+        cluster = f"laconic-{hash}"
+        if ctx.verbose:
+            print(f"Using cluster name: {cluster}")
+
+    # See: https://stackoverflow.com/a/20885799/1701505
+    from . import data
+    with importlib.resources.open_text(data, "pod-list.txt") as pod_list_file:
+        all_pods = pod_list_file.read().splitlines()
+
+    pods_in_scope = []
+    if ctx.stack:
+        stack_config = get_parsed_stack_config(ctx.stack)
+        # TODO: syntax check the input here
+        pods_in_scope = stack_config['pods']
+    else:
+        pods_in_scope = all_pods
+
+    # 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:
+                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 cluster_context(cluster, compose_files, pre_start_commands, post_start_commands)
+
+
+class cluster_context:
+    def __init__(self, cluster, compose_files, pre_start_commands, post_start_commands) -> None:
+        self.cluster = cluster
+        self.compose_files = compose_files
+        self.pre_start_commands = pre_start_commands
+        self.post_start_commands = post_start_commands
+
+
+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)

docs/release-process.md

@@ -0,0 +1,29 @@
+# Release Process
+
+## Manually publish to github releases
+
+In order to build, the shiv and wheel packages must be installed:
+```
+$ pip install shiv
+$ pip install wheel
+```
+
+Then:
+
+1. Define `CERC_GH_RELEASE_SCRIPTS_DIR`
+1. Define `CERC_PACKAGE_RELEASE_GITHUB_TOKEN`
+1. Run `./scripts/tag_new_release.sh <major> <minor> <patch>`
+1. Run `./scripts/build_shiv_package.sh`
+1. Run `./scripts/publish_shiv_package_github.sh <major> <minor> <patch>`
+1. Commit the new version file.
+
+e.g.
+
+```
+$ export CERC_GH_RELEASE_SCRIPTS_DIR=~/projects/cerc/github-release-api/
+$ export CERC_PACKAGE_RELEASE_GITHUB_TOKEN=github_pat_xxxxxx
+$ ./scripts/tag_new_release.sh 1 0 17
+$ ./scripts/build_shiv_package.sh
+$ ./scripts/publish_shiv_package_github.sh 1 0 17
+```
+

requirements.txt

@@ -1,6 +1,6 @@
 python-decouple>=3.6
 GitPython>=3.1.27
 tqdm>=4.64.0
-python-on-whales>=0.52.0
+python-on-whales>=0.58.0
 click>=8.1.3
 pyyaml>=6.0