189 lines
8.1 KiB
Python
189 lines
8.1 KiB
Python
# 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/>.
|
|
|
|
# Builds or pulls containers for the system components
|
|
|
|
# env vars:
|
|
# CERC_REPO_BASE_DIR defaults to ~/cerc
|
|
|
|
# TODO: display the available list of containers; allow re-build of either all or specific containers
|
|
|
|
import os
|
|
import sys
|
|
from decouple import config
|
|
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
|
|
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)"
|
|
|
|
|
|
def make_container_build_env(dev_root_path: str,
|
|
container_build_dir: str,
|
|
debug: bool,
|
|
force_rebuild: bool,
|
|
extra_build_args: str):
|
|
container_build_env = {
|
|
"CERC_NPM_REGISTRY_URL": get_npm_registry_url(),
|
|
"CERC_GO_AUTH_TOKEN": config("CERC_GO_AUTH_TOKEN", default=""),
|
|
"CERC_NPM_AUTH_TOKEN": config("CERC_NPM_AUTH_TOKEN", default=""),
|
|
"CERC_REPO_BASE_DIR": dev_root_path,
|
|
"CERC_CONTAINER_BASE_DIR": container_build_dir,
|
|
"CERC_HOST_UID": f"{os.getuid()}",
|
|
"CERC_HOST_GID": f"{os.getgid()}",
|
|
"DOCKER_BUILDKIT": config("DOCKER_BUILDKIT", default="0")
|
|
}
|
|
container_build_env.update({"CERC_SCRIPT_DEBUG": "true"} if debug else {})
|
|
container_build_env.update({"CERC_FORCE_REBUILD": "true"} if force_rebuild else {})
|
|
container_build_env.update({"CERC_CONTAINER_EXTRA_BUILD_ARGS": extra_build_args} if extra_build_args else {})
|
|
docker_host_env = os.getenv("DOCKER_HOST")
|
|
if docker_host_env:
|
|
container_build_env.update({"DOCKER_HOST": docker_host_env})
|
|
|
|
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}")
|
|
|
|
default_container_tag = f"{container}:local"
|
|
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("/", "-"))
|
|
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
|
|
else:
|
|
container_parent_dir = container_build_dir
|
|
|
|
build_dir = container_parent_dir.joinpath(container.replace("/", "-"))
|
|
build_script_filename = build_dir.joinpath("build.sh")
|
|
|
|
if 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:
|
|
print(f"No script file found: {build_script_filename}, using default build script")
|
|
repo_dir = 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_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,
|
|
"default-build.sh") + f" {default_container_tag} {repo_dir_or_build_dir}"
|
|
if not 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:
|
|
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")
|
|
else:
|
|
print("Skipped")
|
|
|
|
|
|
@click.command()
|
|
@click.option('--include', help="only build these containers")
|
|
@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.pass_context
|
|
def command(ctx, include, exclude, force_rebuild, extra_build_args):
|
|
'''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")
|
|
|
|
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:
|
|
print(f'Dev Root is: {dev_root_path}')
|
|
|
|
if not os.path.isdir(dev_root_path):
|
|
print('Dev root directory doesn\'t exist, creating')
|
|
|
|
# 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:
|
|
all_containers = container_list_file.read().splitlines()
|
|
|
|
containers_in_scope = []
|
|
if stack:
|
|
stack_config = get_parsed_stack_config(stack)
|
|
containers_in_scope = stack_config['containers']
|
|
else:
|
|
containers_in_scope = all_containers
|
|
|
|
if 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,
|
|
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)
|
|
else:
|
|
if verbose:
|
|
print(f"Excluding: {container}")
|