Add deployment scripting (#444)

* Back to Github-based actions.

* Use fork.

* Use new release plugin tag.

.gitea/workflows/fixturenet-eth-test.yml

@@ -12,7 +12,7 @@ jobs:
       - name: "Clone project repository"
         uses: actions/checkout@v3
       - name: "Install Python"
-        uses: cerc-io/setup-python@v4
+        uses: actions/setup-python@v4
         with:
           python-version: '3.8'
       - name: "Print Python version"

.gitea/workflows/publish.yml

@@ -19,7 +19,7 @@ jobs:
           build_tag=$(./scripts/create_build_tag_file.sh)
           echo "build-tag=v${build_tag}" >> $GITHUB_OUTPUT
       - name: "Install Python"
-        uses: cerc-io/setup-python@v4
+        uses: actions/setup-python@v4
         with:
           python-version: '3.8'
       - name: "Print Python version"
@@ -37,7 +37,7 @@ jobs:
         run: |
           cp ${{ steps.build.outputs.package-file }} ./laconic-so
       - name: "Create release"
-        uses: cerc-io/action-gh-release@gitea-v1
+        uses: https://gitea.com/cerc-io/action-gh-release@gitea-v2
         with:
           tag_name: ${{ steps.build-info.outputs.build-tag }}
           # On the publish test branch, mark our release as a draft

.gitea/workflows/test-deploy.yml

@@ -20,7 +20,7 @@ jobs:
       - name: "Clone project repository"
         uses: actions/checkout@v3
       - name: "Install Python"
-        uses: cerc-io/setup-python@v4
+        uses: actions/setup-python@v4
         with:
           python-version: '3.8'
       - name: "Print Python version"

.gitea/workflows/test.yml

@@ -20,7 +20,7 @@ jobs:
       - name: "Clone project repository"
         uses: actions/checkout@v3
       - name: "Install Python"
-        uses: cerc-io/setup-python@v4
+        uses: actions/setup-python@v4
         with:
           python-version: '3.8'
       - name: "Print Python version"

app/base.py

@@ -15,7 +15,7 @@
 
 import os
 from abc import ABC, abstractmethod
-from .deploy import get_stack_status
+from app.deploy import get_stack_status
 from decouple import config
 
 

app/build_containers.py

@@ -27,8 +27,8 @@ import subprocess
 import click
 import importlib.resources
 from pathlib import Path
-from .util import include_exclude_check, get_parsed_stack_config
-from .base import get_npm_registry_url
+from app.util import include_exclude_check, get_parsed_stack_config
+from app.base import get_npm_registry_url
 
 # TODO: find a place for this
 #    epilog="Config provided either in .env or settings.ini or env vars: CERC_REPO_BASE_DIR (defaults to ~/cerc)"
@@ -67,7 +67,7 @@ def command(ctx, include, exclude, force_rebuild, extra_build_args):
         print('Dev root directory doesn\'t exist, creating')
 
     # See: https://stackoverflow.com/a/20885799/1701505
-    from . import data
+    from app import data
     with importlib.resources.open_text(data, "container-image-list.txt") as container_list_file:
         all_containers = container_list_file.read().splitlines()
 

app/build_npms.py

@@ -25,8 +25,8 @@ 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
+from app.base import get_stack
+from app.util import include_exclude_check, get_parsed_stack_config
 
 builder_js_image_name = "cerc/builder-js:local"
 
@@ -81,7 +81,7 @@ def command(ctx, include, exclude, force_rebuild, extra_build_args):
         os.makedirs(build_root_path)
 
     # See: https://stackoverflow.com/a/20885799/1701505
-    from . import data
+    from app import data
     with importlib.resources.open_text(data, "npm-package-list.txt") as package_list_file:
         all_packages = package_list_file.read().splitlines()
 

app/data/compose/docker-compose-fixturenet-optimism.yml

@@ -23,10 +23,10 @@ services:
     command: |
       "./wait-for-it.sh -h ${CERC_L1_HOST:-$${DEFAULT_CERC_L1_HOST}} -p ${CERC_L1_PORT:-$${DEFAULT_CERC_L1_PORT}} -s -t 60 -- ./run.sh"
     volumes:
-      - ../config/wait-for-it.sh:/app/packages/contracts-bedrock/wait-for-it.sh
-      - ../container-build/cerc-optimism-contracts/hardhat-tasks/verify-contract-deployment.ts:/app/packages/contracts-bedrock/tasks/verify-contract-deployment.ts
-      - ../container-build/cerc-optimism-contracts/hardhat-tasks/rekey-json.ts:/app/packages/contracts-bedrock/tasks/rekey-json.ts
-      - ../container-build/cerc-optimism-contracts/hardhat-tasks/send-balance.ts:/app/packages/contracts-bedrock/tasks/send-balance.ts
+      - ../config/network/wait-for-it.sh:/app/packages/contracts-bedrock/wait-for-it.sh
+      - ../config/optimism-contracts/hardhat-tasks/verify-contract-deployment.ts:/app/packages/contracts-bedrock/tasks/verify-contract-deployment.ts
+      - ../config/optimism-contracts/hardhat-tasks/rekey-json.ts:/app/packages/contracts-bedrock/tasks/rekey-json.ts
+      - ../config/optimism-contracts/hardhat-tasks/send-balance.ts:/app/packages/contracts-bedrock/tasks/send-balance.ts
       - ../config/fixturenet-optimism/optimism-contracts/update-config.js:/app/packages/contracts-bedrock/update-config.js
       - ../config/fixturenet-optimism/optimism-contracts/run.sh:/app/packages/contracts-bedrock/run.sh
       - l2_accounts:/l2-accounts
@@ -120,7 +120,7 @@ services:
       CERC_SCRIPT_DEBUG: ${CERC_SCRIPT_DEBUG}
       CERC_L1_RPC: ${CERC_L1_RPC}
     volumes:
-      - ../config/wait-for-it.sh:/wait-for-it.sh
+      - ../config/network/wait-for-it.sh:/wait-for-it.sh
       - ../config/fixturenet-optimism/run-op-batcher.sh:/run-op-batcher.sh
       - l2_accounts:/l2-accounts:ro
     entrypoint: ["sh", "-c"]
@@ -145,7 +145,7 @@ services:
       CERC_SCRIPT_DEBUG: ${CERC_SCRIPT_DEBUG}
       CERC_L1_RPC: ${CERC_L1_RPC}
     volumes:
-      - ../config/wait-for-it.sh:/wait-for-it.sh
+      - ../config/network/wait-for-it.sh:/wait-for-it.sh
       - ../config/fixturenet-optimism/run-op-proposer.sh:/run-op-proposer.sh
       - l1_deployment:/contracts-bedrock:ro
       - l2_accounts:/l2-accounts:ro

app/data/compose/docker-compose-fixturenet-plugeth.yml

@@ -29,7 +29,6 @@ services:
     image: cerc/fixturenet-plugeth-plugeth:local
     volumes:
       - fixturenet_plugeth_geth_1_data:/root/ethdata
-      - ../config/fixturenet-plugeth/plugins:/root/ethdata/plugins
     healthcheck:
       test: ["CMD", "wget", "--tries=1", "--connect-timeout=1", "--quiet", "-O", "-", "http://localhost:8545/"]
       interval: 30s
@@ -61,7 +60,6 @@ services:
       - fixturenet-eth-bootnode-geth
     volumes:
       - fixturenet_plugeth_geth_2_data:/root/ethdata
-      - ../config/fixturenet-plugeth/plugins:/root/ethdata/plugins
 
   fixturenet-eth-bootnode-lighthouse:
     restart: always

app/data/compose/docker-compose-mainnet-laconicd.yml

@@ -2,7 +2,7 @@ services:
   laconicd:
     restart: no
     image: cerc/laconicd:local
-    command: ["sh", "/docker-entrypoint-scripts.d/create-fixturenet.sh"]
+    command: ["/bin/sh", "-c", "while :; do sleep 600; done"]
     volumes:
       # The cosmos-sdk node's database directory:
       - laconicd-data:/root/.laconicd/data

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

@@ -18,7 +18,7 @@ services:
     working_dir: /scripts
     command: ["sh", "mobymask-app-start.sh"]
     volumes:
-      - ../config/wait-for-it.sh:/scripts/wait-for-it.sh
+      - ../config/network/wait-for-it.sh:/scripts/wait-for-it.sh
       - ../config/watcher-mobymask-v2/mobymask-app-start.sh:/scripts/mobymask-app-start.sh
       - peers_ids:/peers
       - mobymask_deployment:/server
@@ -50,7 +50,7 @@ services:
     working_dir: /scripts
     command: ["sh", "mobymask-app-start.sh"]
     volumes:
-      - ../config/wait-for-it.sh:/scripts/wait-for-it.sh
+      - ../config/network/wait-for-it.sh:/scripts/wait-for-it.sh
       - ../config/watcher-mobymask-v2/mobymask-app-start.sh:/scripts/mobymask-app-start.sh
       - peers_ids:/peers
       - mobymask_deployment:/server

app/data/compose/docker-compose-peer-test-app.yml

@@ -14,7 +14,7 @@ services:
       CERC_DENY_MULTIADDRS: ${CERC_DENY_MULTIADDRS}
     command: ["sh", "test-app-start.sh"]
     volumes:
-      - ../config/wait-for-it.sh:/scripts/wait-for-it.sh
+      - ../config/network/wait-for-it.sh:/scripts/wait-for-it.sh
       - ../config/watcher-mobymask-v2/test-app-start.sh:/scripts/test-app-start.sh
       - peers_ids:/peers
     ports:

app/data/compose/docker-compose-watcher-mobymask-v2.yml

@@ -44,7 +44,7 @@ services:
       CERC_L2_NODE_PORT: ${CERC_L2_NODE_PORT}
     command: ["sh", "deploy-and-generate-invite.sh"]
     volumes:
-      - ../config/wait-for-it.sh:/app/packages/server/wait-for-it.sh
+      - ../config/network/wait-for-it.sh:/app/packages/server/wait-for-it.sh
       - ../config/watcher-mobymask-v2/secrets-template.json:/app/packages/server/secrets-template.json
       - ../config/watcher-mobymask-v2/deploy-and-generate-invite.sh:/app/packages/server/deploy-and-generate-invite.sh
       - mobymask_deployment:/app/packages/server

app/data/container-build/cerc-fixturenet-eth-geth/run-el.sh

@@ -7,11 +7,12 @@ fi
 ETHERBASE=`cat /opt/testnet/build/el/accounts.csv | head -1 | cut -d',' -f2`
 NETWORK_ID=`cat /opt/testnet/el/el-config.yaml | grep 'chain_id' | awk '{ print $2 }'`
 NETRESTRICT=`ip addr | grep inet | grep -v '127.0' | awk '{print $2}'`
+CERC_ETH_DATADIR="${CERC_ETH_DATADIR:-$HOME/ethdata}"
+CERC_PLUGINS_DIR="${CERC_PLUGINS_DIR:-/usr/local/lib/plugeth}"
 
-HOME_DIR=`pwd`
 cd /opt/testnet/build/el
 python3 -m http.server 9898 &
-cd $HOME_DIR
+cd $HOME
 
 START_CMD="geth"
 if [ "true" == "$CERC_REMOTE_DEBUG" ] && [ -x "/usr/local/bin/dlv" ]; then
@@ -34,7 +35,7 @@ trap 'cleanup' SIGINT SIGTERM
 
 if [ "true" == "$RUN_BOOTNODE" ]; then
     $START_CMD \
-       --datadir=~/ethdata \
+      --datadir="${CERC_ETH_DATADIR}" \
       --nodekeyhex="${BOOTNODE_KEY}" \
       --nodiscover \
       --ipcdisable \
@@ -82,7 +83,7 @@ else
           fi
         fi
       done
-      STATEDIFF_OPTS="--statediff=true \
+      STATEDIFF_OPTS="--statediff \
       --statediff.db.host=$CERC_STATEDIFF_DB_HOST \
       --statediff.db.name=$CERC_STATEDIFF_DB_NAME \
       --statediff.db.nodeid=$CERC_STATEDIFF_DB_NODE_ID \
@@ -94,10 +95,15 @@ else
       --statediff.waitforsync=true \
       --statediff.workers=${CERC_STATEDIFF_WORKERS:-1} \
       --statediff.writing=true"
+
+      if [ -d "${CERC_PLUGINS_DIR}" ]; then
+        # With plugeth, we separate the statediff options by prefixing with ' -- '
+        STATEDIFF_OPTS="--pluginsdir "${CERC_PLUGINS_DIR}" -- ${STATEDIFF_OPTS}"
+      fi
     fi
 
     $START_CMD \
-      --datadir=~/ethdata \
+      --datadir="${CERC_ETH_DATADIR}" \
       --bootnodes="${ENODE}" \
       --allow-insecure-unlock \
       --http \
@@ -124,8 +130,9 @@ else
       --metrics \
       --metrics.addr="0.0.0.0" \
       --verbosity=${CERC_GETH_VERBOSITY:-3} \
-      --vmodule="${CERC_GETH_VMODULE:-statediff/*=5}" \
-      --miner.etherbase="${ETHERBASE}" ${STATEDIFF_OPTS} \
+      --log.vmodule="${CERC_GETH_VMODULE:-statediff/*=5}" \
+      --miner.etherbase="${ETHERBASE}" \
+      ${STATEDIFF_OPTS} \
       &
 
     geth_pid=$!

app/data/container-build/cerc-fixturenet-eth-plugeth/Dockerfile

@@ -1,27 +0,0 @@
-FROM skylenet/ethereum-genesis-generator@sha256:210353ce7c898686bc5092f16c61220a76d357f51eff9c451e9ad1b9ad03d4d3 AS ethgen
-
-FROM golang:1.19.4-bullseye AS delve
-RUN go install github.com/go-delve/delve/cmd/dlv@latest
-
-FROM ubuntu:22.04
-RUN apt-get update && \
-      apt-get install -y --no-install-recommends \
-        python3 python3-dev python3-pip curl wget jq gettext gettext-base openssl bash dnsutils postgresql-client make iproute2 netcat && \
-      rm -rf /var/lib/apt/lists/*
-
-COPY --from=delve  /go/bin/dlv /usr/local/bin/
-COPY --from=ethgen /usr/local/bin/eth2-testnet-genesis /usr/local/bin/
-COPY --from=ethgen /usr/local/bin/eth2-val-tools /usr/local/bin/
-COPY --from=ethgen /apps /apps
-
-RUN wget -O /usr/local/bin/geth https://github.com/openrelayxyz/plugeth/releases/download/v1.11.6.1.0/geth-linux-amd64-v1.1.0-v1.11.6.1.0 && chmod a+x /usr/local/bin/geth
-RUN cd /apps/el-gen && pip3 install -r requirements.txt
-
-COPY genesis /opt/testnet
-COPY run-el.sh /opt/testnet/run.sh
-
-RUN cd /opt/testnet && make genesis-el
-
-RUN geth --datadir ~/ethdata init /opt/testnet/build/el/geth.json && rm -f ~/ethdata/geth/nodekey
-
-ENTRYPOINT ["/opt/testnet/run.sh"]

app/data/container-build/cerc-fixturenet-eth-plugeth/build.sh

@@ -1,17 +0,0 @@
-#!/usr/bin/env bash
-# Build cerc/fixturenet-eth-plugeth
-set -x
-
-source ${CERC_CONTAINER_BASE_DIR}/build-base.sh
-
-SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
-
-if [ ! -d "${SCRIPT_DIR}/genesis" ]; then
-  cp -frp ${SCRIPT_DIR}/../cerc-fixturenet-eth-geth/genesis ${SCRIPT_DIR}/genesis
-fi
-
-if [ ! -d "${SCRIPT_DIR}/run-el.sh" ]; then
-  cp -fp ${SCRIPT_DIR}/../cerc-fixturenet-eth-geth/run-el.sh ${SCRIPT_DIR}/
-fi
-
-docker build -t cerc/fixturenet-eth-plugeth:local -f ${SCRIPT_DIR}/Dockerfile ${build_command_args} $SCRIPT_DIR

app/data/container-build/cerc-fixturenet-plugeth-plugeth/Dockerfile

@@ -1,20 +1,19 @@
 FROM skylenet/ethereum-genesis-generator@sha256:210353ce7c898686bc5092f16c61220a76d357f51eff9c451e9ad1b9ad03d4d3 AS ethgen
 
-FROM golang:1.19.4-bullseye AS delve
+FROM golang:1.19-alpine as delve
 RUN go install github.com/go-delve/delve/cmd/dlv@latest
 
-FROM ubuntu:22.04
-RUN apt-get update && \
-      apt-get install -y --no-install-recommends \
-        python3 python3-dev python3-pip curl wget jq gettext gettext-base openssl bash dnsutils postgresql-client make iproute2 netcat psmisc && \
-      rm -rf /var/lib/apt/lists/*
+FROM cerc/plugeth:local as geth
+FROM cerc/plugeth-statediff:local as statediff
+
+FROM alpine:3.17
+RUN apk add --no-cache python3 python3-dev py3-pip curl wget jq build-base gettext libintl openssl bash bind-tools postgresql-client
 
 COPY --from=delve  /go/bin/dlv /usr/local/bin/
 COPY --from=ethgen /usr/local/bin/eth2-testnet-genesis /usr/local/bin/
 COPY --from=ethgen /usr/local/bin/eth2-val-tools /usr/local/bin/
 COPY --from=ethgen /apps /apps
 
-RUN wget -O /usr/local/bin/geth https://github.com/openrelayxyz/plugeth/releases/download/v1.11.6.1.0/geth-linux-amd64-v1.1.0-v1.11.6.1.0 && chmod a+x /usr/local/bin/geth
 RUN cd /apps/el-gen && pip3 install -r requirements.txt
 
 COPY genesis /opt/testnet
@@ -22,7 +21,10 @@ COPY run-el.sh /opt/testnet/run.sh
 
 RUN cd /opt/testnet && make genesis-el
 
-RUN geth --datadir ~/ethdata init /opt/testnet/build/el/geth.json && rm -f ~/ethdata/geth/nodekey
+COPY --from=geth  /usr/local/bin/geth /usr/local/bin/
+
+RUN mkdir -p /usr/local/lib/plugeth/
+COPY --from=statediff  /usr/local/lib/statediff.so /usr/local/lib/plugeth/
 
 # Snag the genesis block info.
 RUN geth --datadir ~/ethdata init /opt/testnet/build/el/geth.json && rm -f ~/ethdata/geth/nodekey

app/data/container-build/cerc-go-opera/build.sh

@@ -2,10 +2,6 @@
 # Build cerc/go-opera
 source ${CERC_CONTAINER_BASE_DIR}/build-base.sh
 
-# Checkout appropriate release; refer to https://docs.fantom.foundation/
-OPERA_TAG=${OPERA_TAG:-release/1.1.2-rc.5}
-git -C ${CERC_REPO_BASE_DIR}/go-opera checkout ${OPERA_TAG}
-
 # Repo's dockerfile gives build error because it's hardcoded for go 1.17; go 1.19 is required
 sed -i 's/FROM golang:1\.[0-9]*-alpine as builder/FROM golang:1.19-alpine as builder/' ${CERC_REPO_BASE_DIR}/go-opera/docker/Dockerfile.opera
 

app/data/stacks/fixturenet-plugeth-tx/stack.yml

@@ -5,14 +5,24 @@ repos:
   - github.com/cerc-io/tx-spammer
   - github.com/dboreham/foundry
   - github.com/cerc-io/lighthouse
+  - github.com/cerc-io/ipld-eth-db@v5
+  - github.com/cerc-io/ipld-eth-server@v5
+  - git.vdb.to/cerc-io/plugeth@statediff-wip
+  - git.vdb.to/cerc-io/plugeth-statediff@dev-local-build
 containers:
   - cerc/lighthouse
   - cerc/lighthouse-cli
+  - cerc/plugeth-statediff
+  - cerc/plugeth
   - cerc/fixturenet-plugeth-plugeth
   - cerc/fixturenet-plugeth-lighthouse
   - cerc/tx-spammer
   - cerc/foundry
+  - cerc/ipld-eth-db
+  - cerc/ipld-eth-server
 pods:
+  - ipld-eth-db
+  - ipld-eth-server
   - fixturenet-plugeth
   - foundry
   - tx-spammer

app/data/stacks/mainnet-go-opera/stack.yml

@@ -2,7 +2,7 @@ version: "1.1"
 name: mainnet-opera
 decription: "Fantom mainnet node"
 repos:
-  - github.com/Fantom-foundation/go-opera
+  - github.com/Fantom-foundation/go-opera@release/1.1.2-rc.5
 containers:
   - cerc/go-opera
 pods:

app/data/stacks/mainnet-laconic/deploy/commands.py

@@ -13,45 +13,50 @@
 # 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
-import os
-from shutil import copyfile
-import sys
-from .util import get_stack_config_filename, get_parsed_deployment_spec
+from dataclasses import dataclass
+from app.util import get_yaml
+from app.stack_state import State
 
-default_spec_file_content = """stack: mainnet-laconic
-data_dir: /my/path
-node_name: my-node-name
+default_spec_file_content = """config:
+    node_moniker: my-node-name
+    chain_id: my-chain-id
 """
 
+init_help_text = """Add helpful text here on setting config variables.
+"""
 
-def make_default_deployment_dir():
-    return "deployment-001"
-
-@click.command()
-@click.option("--output", required=True, help="Write yaml spec file here")
-@click.pass_context
-def init(ctx, output):
-    with open(output, "w") as output_file:
-        output_file.write(default_spec_file_content)
+@dataclass
+class VolumeMapping:
+    host_path: str
+    container_path: str
 
 
-@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")
-@click.pass_context
-def create(ctx, spec_file, deployment_dir):
-    # This function fails with a useful error message if the file doens't exist
-    parsed_spec = get_parsed_deployment_spec(spec_file)
-    if 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, os.path.basename(spec_file)))
-    stack_file = get_stack_config_filename(parsed_spec.stack)
-    copyfile(stack_file, os.path.join(deployment_dir, os.path.basename(stack_file)))
+# In order to make this, we need the ability to run the stack
+# In theory we can make this same way as we would run deploy up
+def run_container_command(ctx, ontainer, command, mounts):
+    deploy_context = ctx.obj
+    pass
+
+
+def setup(ctx):
+    node_moniker = "dbdb-node"
+    chain_id = "laconic_81337-1"
+    mounts = [
+        VolumeMapping("./path", "~/.laconicd")
+    ]
+    output, status = run_container_command(ctx, "laconicd", f"laconicd init {node_moniker} --chain-id {chain_id}", mounts)
+
+
+def init(command_context):
+    print(init_help_text)
+    yaml = get_yaml()
+    return yaml.load(default_spec_file_content)
+
+
+def get_state(command_context):
+    print("Here we get state")
+    return State.CONFIGURED
+
+
+def change_state(command_context):
+    pass

app/data/stacks/mainnet-laconic/stack.yml

@@ -25,7 +25,4 @@ containers:
 pods:
   - mainnet-laconicd
   - fixturenet-laconic-console
-config:
-  cli:
-    key: laconicd.mykey
-    address: laconicd.myaddress
+

app/deploy.py

@@ -26,9 +26,10 @@ import subprocess
 from python_on_whales import DockerClient, DockerException
 import click
 from pathlib import Path
-from .util import include_exclude_check, get_parsed_stack_config, global_options2
-from .deployment_create import create as deployment_create
-from .deployment_create import init as deployment_init
+from app.util import include_exclude_check, get_parsed_stack_config, global_options2
+from app.deployment_create import create as deployment_create
+from app.deployment_create import init as deployment_init
+from app.deployment_create import setup as deployment_setup
 
 
 class DeployCommandContext(object):
@@ -263,7 +264,7 @@ def _make_cluster_context(ctx, stack, include, exclude, cluster, env_file):
             print(f"Using cluster name: {cluster}")
 
     # See: https://stackoverflow.com/a/20885799/1701505
-    from . import data
+    from app import data
     with resources.open_text(data, "pod-list.txt") as pod_list_file:
         all_pods = pod_list_file.read().splitlines()
 
@@ -420,3 +421,4 @@ def _orchestrate_cluster_config(ctx, cluster_config, docker, container_exec_env)
 
 command.add_command(deployment_init)
 command.add_command(deployment_create)
+command.add_command(deployment_setup)

app/deployment.py

@@ -17,8 +17,8 @@ import click
 from dataclasses import dataclass
 from pathlib import Path
 import sys
-from .deploy import up_operation, down_operation, ps_operation, port_operation, exec_operation, logs_operation, create_deploy_context
-from .util import global_options
+from app.deploy import up_operation, down_operation, ps_operation, port_operation, exec_operation, logs_operation, create_deploy_context
+from app.util import global_options
 
 
 @dataclass
@@ -73,23 +73,25 @@ def start(ctx, extra_args):
 
 
 @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, extra_args):
+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, extra_args, None)
+    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, extra_args):
+def stop(ctx, delete_volumes, extra_args):
     # TODO: add cluster name and env file here
     ctx.obj = make_deploy_context(ctx)
-    down_operation(ctx, extra_args, None)
+    down_operation(ctx, delete_volumes, extra_args, None)
 
 
 @command.command()
@@ -126,15 +128,3 @@ def logs(ctx, extra_args):
 @click.pass_context
 def status(ctx):
     print(f"Context: {ctx.parent.obj}")
-
-
-
-#from importlib import resources, util
-# TODO: figure out how to do this dynamically
-#stack = "mainnet-laconic"
-#module_name = "commands"
-#spec = util.spec_from_file_location(module_name, "./app/data/stacks/" + stack + "/deploy/commands.py")
-#imported_stack = util.module_from_spec(spec)
-#spec.loader.exec_module(imported_stack)
-#command.add_command(imported_stack.init)
-#command.add_command(imported_stack.create)

app/deployment_create.py

@@ -14,20 +14,12 @@
 # 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 shutil import copyfile, copytree
 import sys
-import ruamel.yaml
-from .util import get_stack_file_path, get_parsed_deployment_spec, get_parsed_stack_config, global_options
-
-
-def _get_yaml():
-    # See: https://stackoverflow.com/a/45701840/1701505
-    yaml = ruamel.yaml.YAML()
-    yaml.preserve_quotes = True
-    yaml.indent(sequence=3, offset=1)
-    return yaml
+from app.util import get_stack_file_path, get_parsed_deployment_spec, get_parsed_stack_config, global_options, get_yaml
 
 
 def _make_default_deployment_dir():
@@ -47,7 +39,7 @@ def _get_named_volumes(stack):
     named_volumes = []
     parsed_stack = get_parsed_stack_config(stack)
     pods = parsed_stack["pods"]
-    yaml = _get_yaml()
+    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"))
@@ -96,21 +88,64 @@ def _fixup_pod_file(pod, spec, compose_dir):
                     pod["volumes"][volume] = new_volume_spec
 
 
+def call_stack_deploy_init(stack):
+    # Link with the python file in the stack
+    # Call a function in it
+    # If no function found, return None
+    python_file_path = get_stack_file_path(stack).parent.joinpath("deploy", "commands.py")
+    spec = util.spec_from_file_location("commands", python_file_path)
+    imported_stack = util.module_from_spec(spec)
+    spec.loader.exec_module(imported_stack)
+    return imported_stack.init(None)
+
+
+# TODO: fold this with function above
+def call_stack_deploy_setup(stack):
+    # Link with the python file in the stack
+    # Call a function in it
+    # If no function found, return None
+    python_file_path = get_stack_file_path(stack).parent.joinpath("deploy", "commands.py")
+    spec = util.spec_from_file_location("commands", python_file_path)
+    imported_stack = util.module_from_spec(spec)
+    spec.loader.exec_module(imported_stack)
+    return imported_stack.setup(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
+
+
 @click.command()
 @click.option("--output", required=True, help="Write yaml spec file here")
 @click.pass_context
 def init(ctx, output):
-    yaml = _get_yaml()
+    yaml = get_yaml()
     stack = global_options(ctx).stack
     verbose = global_options(ctx).verbose
+    default_spec_file_content = call_stack_deploy_init(stack)
     spec_file_content = {"stack": stack}
+    spec_file_content.update(default_spec_file_content)
     if verbose:
         print(f"Creating spec file for stack: {stack}")
     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}"
+            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)
@@ -142,14 +177,36 @@ def create(ctx, spec_file, deployment_dir):
     destination_compose_dir = os.path.join(deployment_dir, "compose")
     os.mkdir(destination_compose_dir)
     data_dir = Path(__file__).absolute().parent.joinpath("data")
-    yaml = _get_yaml()
+    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"))
+        extra_config_dirs = _find_extra_config_dirs(parsed_pod_file, pod)
+        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
-        source_config_dir = data_dir.joinpath("config", pod)
-        if os.path.exists(source_config_dir):
-            copytree(source_config_dir, os.path.join(deployment_dir, "config", pod))
+        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)
+
+
+@click.command()
+@click.option("--node-moniker", help="Help goes here")
+@click.option("--key-name", help="Help goes here")
+@click.option("--initialize-network", is_flag=True, default=False, help="Help goes here")
+@click.option("--join-network", is_flag=True, default=False, help="Help goes here")
+@click.option("--create-network", is_flag=True, default=False, help="Help goes here")
+@click.pass_context
+def setup(ctx, node_moniker, key_name, initialize_network, join_network, create_network):
+    stack = global_options(ctx).stack
+    call_stack_deploy_setup(stack)
+

app/setup_repositories.py

@@ -25,7 +25,7 @@ import click
 import importlib.resources
 from pathlib import Path
 import yaml
-from .util import include_exclude_check
+from app.util import include_exclude_check
 
 
 class GitProgress(git.RemoteProgress):
@@ -227,7 +227,7 @@ def command(ctx, include, exclude, git_ssh, check_only, pull, branches, branches
         os.makedirs(dev_root_path)
 
     # See: https://stackoverflow.com/a/20885799/1701505
-    from . import data
+    from app import data
     with importlib.resources.open_text(data, "repository-list.txt") as repository_list_file:
         all_repos = repository_list_file.read().splitlines()
 

app/stack_state.py

@@ -0,0 +1,22 @@
+# Copyright © 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/>.
+
+from enum import Enum
+
+class State(Enum):
+    CREATED = 1
+    CONFIGURED = 2
+    STARTED = 3
+    STOPPED = 4

app/util.py

@@ -15,7 +15,7 @@
 
 import os.path
 import sys
-import yaml
+import ruamel.yaml
 from pathlib import Path
 
 
@@ -42,7 +42,7 @@ def get_parsed_stack_config(stack):
     stack_file_path = stack if isinstance(stack, os.PathLike) else get_stack_file_path(stack)
     try:
         with stack_file_path:
-            stack_config = yaml.safe_load(open(stack_file_path, "r"))
+            stack_config = get_yaml().load(open(stack_file_path, "r"))
             return stack_config
     except FileNotFoundError as error:
         # We try here to generate a useful diagnostic error
@@ -60,7 +60,7 @@ def get_parsed_deployment_spec(spec_file):
     spec_file_path = Path(spec_file)
     try:
         with spec_file_path:
-            deploy_spec = yaml.safe_load(open(spec_file_path, "r"))
+            deploy_spec = get_yaml().load(open(spec_file_path, "r"))
             return deploy_spec
     except FileNotFoundError as error:
         # We try here to generate a useful diagnostic error
@@ -69,6 +69,14 @@ def get_parsed_deployment_spec(spec_file):
         sys.exit(1)
 
 
+def get_yaml():
+    # See: https://stackoverflow.com/a/45701840/1701505
+    yaml = ruamel.yaml.YAML()
+    yaml.preserve_quotes = True
+    yaml.indent(sequence=3, offset=1)
+    return yaml
+
+
 # TODO: this is fragile wrt to the subcommand depth
 # See also: https://github.com/pallets/click/issues/108
 def global_options(ctx):

app/version.py

@@ -22,7 +22,7 @@ def command(ctx):
     '''print tool version'''
 
     # See: https://stackoverflow.com/a/20885799/1701505
-    from . import data
+    from app import data
     with importlib.resources.open_text(data, "build_tag.txt") as version_file:
         # TODO: code better version that skips comment lines
         version_string = version_file.read().splitlines()[1]