Rename app -> stack_orchestrator (#625)

.gitignore

@@ -6,5 +6,5 @@ laconic_stack_orchestrator.egg-info
 __pycache__
 *~
 package
-app/data/build_tag.txt
+stack_orchestrator/data/build_tag.txt
 /build

README.md

@@ -64,12 +64,12 @@ laconic-so update
 
 ## Usage
 
-The various [stacks](/app/data/stacks) each contain instructions for running different stacks based on your use case. For example:
+The various [stacks](/stack_orchestrator/data/stacks) each contain instructions for running different stacks based on your use case. For example:
 
-- [self-hosted Gitea](/app/data/stacks/build-support)
-- [an Optimism Fixturenet](/app/data/stacks/fixturenet-optimism)
-- [laconicd with console and CLI](app/data/stacks/fixturenet-laconic-loaded)
-- [kubo (IPFS)](app/data/stacks/kubo)
+- [self-hosted Gitea](/stack_orchestrator/data/stacks/build-support)
+- [an Optimism Fixturenet](/stack_orchestrator/data/stacks/fixturenet-optimism)
+- [laconicd with console and CLI](stack_orchestrator/data/stacks/fixturenet-laconic-loaded)
+- [kubo (IPFS)](stack_orchestrator/data/stacks/kubo)
 
 ## Contributing
 

app/deploy/k8s/helpers.py

@@ -1,57 +0,0 @@
-# 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
-import subprocess
-from typing import Set
-
-from app.opts import opts
-
-
-def _run_command(command: str):
-    if opts.o.debug:
-        print(f"Running: {command}")
-    result = subprocess.run(command, shell=True)
-    if opts.o.debug:
-        print(f"Result: {result}")
-
-
-def create_cluster(name: str):
-    _run_command(f"kind create cluster --name {name}")
-
-
-def destroy_cluster(name: str):
-    _run_command(f"kind delete cluster --name {name}")
-
-
-def load_images_into_kind(kind_cluster_name: str, image_set: Set[str]):
-    for image in image_set:
-        _run_command(f"kind load docker-image {image} --name {kind_cluster_name}")
-
-
-def pods_in_deployment(core_api: client.CoreV1Api, deployment_name: str):
-    pods = []
-    pod_response = core_api.list_namespaced_pod(namespace="default", label_selector="app=test-app")
-    if opts.o.debug:
-        print(f"pod_response: {pod_response}")
-    for pod_info in pod_response.items:
-        pod_name = pod_info.metadata.name
-        pods.append(pod_name)
-    return pods
-
-
-def log_stream_from_string(s: str):
-    # Note response has to be UTF-8 encoded because the caller expects to decode it
-    yield ("ignore", s.encode())

docs/adding-a-new-stack.md

@@ -8,7 +8,7 @@ Core to the feature completeness of stack orchestrator is to [decouple the tool
 
 ## Example
 
-- in `app/data/stacks/my-new-stack/stack.yml` add:
+- in `stack_orchestrator/data/stacks/my-new-stack/stack.yml` add:
 
 ```yaml
 version: "0.1"
@@ -21,7 +21,7 @@ pods:
   - my-new-stack
 ```
 
-- in `app/data/container-build/cerc-my-new-stack/build.sh` add:
+- in `stack_orchestrator/data/container-build/cerc-my-new-stack/build.sh` add:
 
 ```yaml
 #!/usr/bin/env bash
@@ -30,7 +30,7 @@ source ${CERC_CONTAINER_BASE_DIR}/build-base.sh
 docker build -t cerc/my-new-stack:local -f ${CERC_REPO_BASE_DIR}/my-new-stack/Dockerfile ${build_command_args} ${CERC_REPO_BASE_DIR}/my-new-stack
 ```
 
-- in `app/data/compose/docker-compose-my-new-stack.yml` add:
+- in `stack_orchestrator/data/compose/docker-compose-my-new-stack.yml` add:
 
 ```yaml
 version: "3.2"
@@ -43,20 +43,20 @@ services:
       - "0.0.0.0:3000:3000"
 ```
 
-- in `app/data/repository-list.txt` add:
+- in `stack_orchestrator/data/repository-list.txt` add:
 
 ```bash
 github.com/my-org/my-new-stack
 ```
 whereby that repository contains your source code and a `Dockerfile`, and matches the `repos:` field in the `stack.yml`.
 
-- in `app/data/container-image-list.txt` add:
+- in `stack_orchestrator/data/container-image-list.txt` add:
 
 ```bash
 cerc/my-new-stack
 ```
 
-- in `app/data/pod-list.txt` add:
+- in `stack_orchestrator/data/pod-list.txt` add:
 
 ```bash
 my-new-stack

scripts/create_build_tag_file.sh

@@ -1,6 +1,6 @@
-build_tag_file_name=./app/data/build_tag.txt
+build_tag_file_name=./stack_orchestrator/data/build_tag.txt
 echo "# This file should be re-generated running: scripts/create_build_tag_file.sh script" > $build_tag_file_name
-product_version_string=$( tail -1 ./app/data/version.txt )
+product_version_string=$( tail -1 ./stack_orchestrator/data/version.txt )
 commit_string=$( git rev-parse --short HEAD )
 timestamp_string=$(date +'%Y%m%d%H%M')
 build_tag_string=${product_version_string}-${commit_string}-${timestamp_string}

setup.py

@@ -14,7 +14,7 @@ setup(
     long_description=long_description,
     long_description_content_type="text/markdown",
     url='https://github.com/cerc-io/stack-orchestrator',
-    py_modules=['cli', 'app'],
+    py_modules=['stack_orchestrator'],
     packages=find_packages(),
     install_requires=[requirements],
     python_requires='>=3.7',
@@ -25,6 +25,6 @@ setup(
         "Operating System :: OS Independent",
     ],
     entry_points={
-        'console_scripts': ['laconic-so=cli:cli'],
+        'console_scripts': ['laconic-so=stack_orchestrator.main:cli'],
     }
 )

stack_orchestrator/base.py

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

stack_orchestrator/build/build_containers.py

@@ -27,8 +27,8 @@ import subprocess
 import click
 import importlib.resources
 from pathlib import Path
-from app.util import include_exclude_check, get_parsed_stack_config
-from app.base import get_npm_registry_url
+from stack_orchestrator.util import include_exclude_check, get_parsed_stack_config
+from stack_orchestrator.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 app import data
+    from stack_orchestrator import data
     with importlib.resources.open_text(data, "container-image-list.txt") as container_list_file:
         all_containers = container_list_file.read().splitlines()
 

stack_orchestrator/build/build_npms.py

@@ -25,8 +25,8 @@ from decouple import config
 import click
 import importlib.resources
 from python_on_whales import docker, DockerException
-from app.base import get_stack
-from app.util import include_exclude_check, get_parsed_stack_config
+from stack_orchestrator.base import get_stack
+from stack_orchestrator.util import include_exclude_check, get_parsed_stack_config
 
 builder_js_image_name = "cerc/builder-js:local"
 
@@ -83,7 +83,7 @@ def command(ctx, include, exclude, force_rebuild, extra_build_args):
         os.makedirs(build_root_path)
 
     # See: https://stackoverflow.com/a/20885799/1701505
-    from app import data
+    from stack_orchestrator import data
     with importlib.resources.open_text(data, "npm-package-list.txt") as package_list_file:
         all_packages = package_list_file.read().splitlines()