diff --git a/stack_orchestrator/build/build_containers.py b/stack_orchestrator/build/build_containers.py
index bcc10bb0..44fc50d6 100644
--- a/stack_orchestrator/build/build_containers.py
+++ b/stack_orchestrator/build/build_containers.py
@@ -27,8 +27,11 @@ import subprocess
import click
import importlib.resources
from pathlib import Path
-from stack_orchestrator.util import include_exclude_check, get_parsed_stack_config, stack_is_external, warn_exit
+from stack_orchestrator.opts import opts
+from stack_orchestrator.util import include_exclude_check, get_parsed_stack_config, stack_is_external, error_exit, warn_exit
from stack_orchestrator.base import get_npm_registry_url
+from stack_orchestrator.build.build_types import BuildContext
+from stack_orchestrator.build.publish import publish_image
# 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)"
@@ -59,69 +62,58 @@ def make_container_build_env(dev_root_path: str,
return container_build_env
-def process_container(stack: str,
- container,
- container_build_dir: str,
- container_build_env: dict,
- dev_root_path: str,
- quiet: bool,
- verbose: bool,
- dry_run: bool,
- continue_on_error: bool,
- ):
- if not quiet:
- print(f"Building: {container}")
+def process_container(build_context: BuildContext) -> bool:
+ if not opts.o.quiet:
+ print(f"Building: {build_context.container}")
- default_container_tag = f"{container}:local"
- container_build_env.update({"CERC_DEFAULT_CONTAINER_IMAGE_TAG": default_container_tag})
+ default_container_tag = f"{build_context.container}:local"
+ build_context.container_build_env.update({"CERC_DEFAULT_CONTAINER_IMAGE_TAG": default_container_tag})
# Check if this is in an external stack
- if stack_is_external(stack):
- container_parent_dir = Path(stack).joinpath("container-build")
- temp_build_dir = container_parent_dir.joinpath(container.replace("/", "-"))
+ if stack_is_external(build_context.stack):
+ container_parent_dir = Path(build_context.stack).joinpath("container-build")
+ temp_build_dir = container_parent_dir.joinpath(build_context.container.replace("/", "-"))
temp_build_script_filename = temp_build_dir.joinpath("build.sh")
# Now check if the container exists in the external stack.
if not temp_build_script_filename.exists():
# If not, revert to building an internal container
- container_parent_dir = container_build_dir
+ container_parent_dir = build_context.container_build_dir
else:
- container_parent_dir = container_build_dir
+ container_parent_dir = build_context.container_build_dir
- build_dir = container_parent_dir.joinpath(container.replace("/", "-"))
+ build_dir = container_parent_dir.joinpath(build_context.container.replace("/", "-"))
build_script_filename = build_dir.joinpath("build.sh")
- if verbose:
+ if opts.o.verbose:
print(f"Build script filename: {build_script_filename}")
if os.path.exists(build_script_filename):
build_command = build_script_filename.as_posix()
else:
- if verbose:
+ if opts.o.verbose:
print(f"No script file found: {build_script_filename}, using default build script")
- repo_dir = container.split('/')[1]
+ repo_dir = build_context.container.split('/')[1]
# TODO: make this less of a hack -- should be specified in some metadata somewhere
# 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_full_path = os.path.join(build_context.dev_root_path, repo_dir)
repo_dir_or_build_dir = repo_full_path if os.path.exists(repo_full_path) else build_dir
- build_command = os.path.join(container_build_dir,
+ build_command = os.path.join(build_context.container_build_dir,
"default-build.sh") + f" {default_container_tag} {repo_dir_or_build_dir}"
- if not dry_run:
+ if not opts.o.dry_run:
# No PATH at all causes failures with podman.
- if "PATH" not in container_build_env:
- container_build_env["PATH"] = os.environ["PATH"]
- if verbose:
- print(f"Executing: {build_command} with environment: {container_build_env}")
- build_result = subprocess.run(build_command, shell=True, env=container_build_env)
- if verbose:
+ if "PATH" not in build_context.container_build_env:
+ build_context.container_build_env["PATH"] = os.environ["PATH"]
+ if opts.o.verbose:
+ print(f"Executing: {build_command} with environment: {build_context.container_build_env}")
+ build_result = subprocess.run(build_command, shell=True, env=build_context.container_build_env)
+ if opts.o.verbose:
print(f"Return code is: {build_result.returncode}")
if build_result.returncode != 0:
- print(f"Error running build for {container}")
- if not continue_on_error:
- print("FATAL Error: container build failed and --continue-on-error not set, exiting")
- sys.exit(1)
- else:
- print("****** Container Build Error, continuing because --continue-on-error is set")
+ return False
+ else:
+ return True
else:
print("Skipped")
+ return True
@click.command()
@@ -129,17 +121,14 @@ def process_container(stack: str,
@click.option('--exclude', help="don\'t build these containers")
@click.option("--force-rebuild", is_flag=True, default=False, help="Override dependency checking -- always rebuild")
@click.option("--extra-build-args", help="Supply extra arguments to build")
+@click.option("--publish-images", is_flag=True, default=False, help="Publish the built images in the specified image registry")
+@click.option("--image-registry", help="Specify the image registry for --publish-images")
@click.pass_context
-def command(ctx, include, exclude, force_rebuild, extra_build_args):
+def command(ctx, include, exclude, force_rebuild, extra_build_args, publish_images, image_registry):
'''build the set of containers required for a complete stack'''
- quiet = ctx.obj.quiet
- verbose = ctx.obj.verbose
- dry_run = ctx.obj.dry_run
- debug = ctx.obj.debug
local_stack = ctx.obj.local_stack
stack = ctx.obj.stack
- continue_on_error = ctx.obj.continue_on_error
# See: https://stackoverflow.com/questions/25389095/python-get-path-of-root-project-structure
container_build_dir = Path(__file__).absolute().parent.parent.joinpath("data", "container-build")
@@ -150,12 +139,16 @@ def command(ctx, include, exclude, force_rebuild, extra_build_args):
else:
dev_root_path = os.path.expanduser(config("CERC_REPO_BASE_DIR", default="~/cerc"))
- if not quiet:
+ if not opts.o.quiet:
print(f'Dev Root is: {dev_root_path}')
if not os.path.isdir(dev_root_path):
print('Dev root directory doesn\'t exist, creating')
+ if publish_images:
+ if not image_registry:
+ error_exit("--image-registry must be supplied with --publish-images")
+
# See: https://stackoverflow.com/a/20885799/1701505
from stack_orchestrator import data
with importlib.resources.open_text(data, "container-image-list.txt") as container_list_file:
@@ -170,21 +163,38 @@ def command(ctx, include, exclude, force_rebuild, extra_build_args):
else:
containers_in_scope = all_containers
- if verbose:
+ if opts.o.verbose:
print(f'Containers: {containers_in_scope}')
if stack:
print(f"Stack: {stack}")
container_build_env = make_container_build_env(dev_root_path,
container_build_dir,
- debug,
+ opts.o.debug,
force_rebuild,
extra_build_args)
for container in containers_in_scope:
if include_exclude_check(container, include, exclude):
- process_container(stack, container, container_build_dir, container_build_env,
- dev_root_path, quiet, verbose, dry_run, continue_on_error)
+
+ build_context = BuildContext(
+ stack,
+ container,
+ container_build_dir,
+ container_build_env,
+ dev_root_path
+ )
+ result = process_container(build_context)
+ if result:
+ if publish_images:
+ publish_image(container, image_registry)
+ else:
+ print(f"Error running build for {build_context.container}")
+ if not opts.o.continue_on_error:
+ error_exit("container build failed and --continue-on-error not set, exiting")
+ sys.exit(1)
+ else:
+ print("****** Container Build Error, continuing because --continue-on-error is set")
else:
- if verbose:
+ if opts.o.verbose:
print(f"Excluding: {container}")
diff --git a/stack_orchestrator/build/build_types.py b/stack_orchestrator/build/build_types.py
new file mode 100644
index 00000000..971188fe
--- /dev/null
+++ b/stack_orchestrator/build/build_types.py
@@ -0,0 +1,29 @@
+# Copyright © 2024 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 .
+
+
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Mapping
+
+
+@dataclass
+class BuildContext:
+ stack: str
+ container: str
+ container_build_dir: Path
+ container_build_env: Mapping[str,str]
+ dev_root_path: str
+
diff --git a/stack_orchestrator/build/build_webapp.py b/stack_orchestrator/build/build_webapp.py
index a9124590..fcdd8f66 100644
--- a/stack_orchestrator/build/build_webapp.py
+++ b/stack_orchestrator/build/build_webapp.py
@@ -26,6 +26,7 @@ import click
from pathlib import Path
from stack_orchestrator.build import build_containers
from stack_orchestrator.deploy.webapp.util import determine_base_container
+from stack_orchestrator.build.build_types import BuildContext
@click.command()
@@ -65,8 +66,14 @@ def command(ctx, base_container, source_repo, force_rebuild, extra_build_args, t
container_build_env = build_containers.make_container_build_env(dev_root_path, container_build_dir, debug,
force_rebuild, extra_build_args)
- build_containers.process_container(None, base_container, container_build_dir, container_build_env, dev_root_path, quiet,
- verbose, dry_run, continue_on_error)
+ build_context_1 = BuildContext(
+ stack,
+ base_container,
+ container_build_dir,
+ container_build_env,
+ dev_root_path,
+ )
+ build_containers.process_container(build_context_1)
# Now build the target webapp. We use the same build script, but with a different Dockerfile and work dir.
container_build_env["CERC_WEBAPP_BUILD_RUNNING"] = "true"
@@ -80,5 +87,11 @@ def command(ctx, base_container, source_repo, force_rebuild, extra_build_args, t
else:
container_build_env["CERC_CONTAINER_BUILD_TAG"] = tag
- build_containers.process_container(None, base_container, container_build_dir, container_build_env, dev_root_path, quiet,
- verbose, dry_run, continue_on_error)
+ build_context_2 = BuildContext(
+ stack,
+ base_container,
+ container_build_dir,
+ container_build_env,
+ dev_root_path,
+ )
+ build_containers.process_container(build_context_2)
diff --git a/stack_orchestrator/build/publish.py b/stack_orchestrator/build/publish.py
new file mode 100644
index 00000000..78059680
--- /dev/null
+++ b/stack_orchestrator/build/publish.py
@@ -0,0 +1,48 @@
+# Copyright © 2024 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 .
+
+from datetime import datetime
+from python_on_whales import DockerClient
+
+from stack_orchestrator.opts import opts
+from stack_orchestrator.util import error_exit
+
+
+def _publish_tag_for_image(local_image_tag: str, remote_repo: str, version: str):
+ # Turns image tags of the form: foo/bar:local into remote.repo/org/bar:deploy
+ (image_name, image_version) = local_image_tag.split(":")
+ if image_version == "local":
+ return f"{remote_repo}/{image_name}:{version}"
+ else:
+ error_exit("Asked to publish a non-locally built image")
+
+
+def publish_image(local_tag, registry):
+ if opts.o.verbose:
+ print(f"Publishing this image: {local_tag} to this registry: {registry}")
+ docker = DockerClient()
+ # Figure out the target image tag
+ # Eventually this version will be generated from the source repo state
+ # Using a timestemp is an intermediate step
+ version = datetime.now().strftime("%Y%m%d%H%M")
+ remote_tag = _publish_tag_for_image(local_tag, registry, version)
+ # Tag the image thus
+ if opts.o.debug:
+ print(f"Tagging {local_tag} to {remote_tag}")
+ docker.image.tag(local_tag, remote_tag)
+ # Push it to the desired registry
+ if opts.o.verbose:
+ print(f"Pushing image {remote_tag}")
+ docker.image.push(remote_tag)