Move --stack

Author: telackey

src/stack/build/build_webapp.py

@@ -25,7 +25,6 @@
 import os
 import sys
 
-from decouple import config
 from pathlib import Path
 
 from stack.build import prepare_containers
@@ -50,7 +49,6 @@ def command(ctx, base_container, source_repo, force_rebuild, extra_build_args, t
     quiet = ctx.obj.quiet
     debug = ctx.obj.debug
     verbose = ctx.obj.verbose
-    stack = ctx.obj.stack
 
     # 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")
@@ -71,7 +69,7 @@ def command(ctx, base_container, source_repo, force_rebuild, extra_build_args, t
         logger.log(f"Building base container: {base_container}")
 
     build_context_1 = BuildContext(
-        stack,
+        None,
         ContainerSpec(base_container),
         container_build_dir,
         container_build_env,
@@ -101,7 +99,7 @@ def command(ctx, base_container, source_repo, force_rebuild, extra_build_args, t
         logger.log(f"Building app container: {tag}")
 
     build_context_2 = BuildContext(
-        stack,
+        None,
         ContainerSpec(base_container),
         container_build_dir,
         container_build_env,

src/stack/build/prepare_containers.py

@@ -36,8 +36,7 @@
 from stack.constants import container_file_name, container_lock_file_name
 from stack.opts import opts
 from stack.repos.setup_repositories import fs_path_for_repo, process_repo
-from stack.util import get_dev_root_path, include_exclude_check, stack_is_external, error_exit, get_yaml
-
+from stack.util import get_dev_root_path, include_exclude_check, stack_is_external, error_exit, get_yaml, check_if_stack_exists
 
 docker = DockerClient()
 
@@ -143,27 +142,8 @@ def process_container(build_context: BuildContext) -> bool:
         return True
 
 
-@click.command(hidden=True)
-@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.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 legacy_command(ctx, include, exclude, force_rebuild, extra_build_args, publish_images, image_registry):
-    """build the set of containers required for a complete stack"""
-
-    # Legacy support for build-containers command.
-
-    build_policy = "build"
-    if force_rebuild:
-        build_policy = "build-force"
-
-    _prepare_containers(ctx, include, exclude, False, build_policy, extra_build_args, True, publish_images, image_registry, None)
-
-
 @click.command()
+@click.option("--stack", help="path to the stack", required=True)
 @click.option("--include", help="only build these containers")
 @click.option("--exclude", help="don't build these containers")
 @click.option("--git-ssh", is_flag=True, default=False)
@@ -174,14 +154,9 @@ def legacy_command(ctx, include, exclude, force_rebuild, extra_build_args, publi
 @click.option("--image-registry", help="Specify the remote image registry (default: auto-detect per-container)")
 @click.option("--target-arch", help="Specify a target architecture (only for use with --no-pull)")
 @click.pass_context
-def command(ctx, include, exclude, git_ssh, build_policy, extra_build_args, no_pull, publish_images, image_registry, target_arch):
+def command(ctx, stack, include, exclude, git_ssh, build_policy, extra_build_args, no_pull, publish_images, image_registry, target_arch):
     """build (or fetch pre-built) stack containers"""
-
-    _prepare_containers(ctx, include, exclude, git_ssh, build_policy, extra_build_args, no_pull, publish_images, image_registry, target_arch)
-
-
-def _prepare_containers(ctx, include, exclude, git_ssh, build_policy, extra_build_args, no_pull, publish_images, image_registry, target_arch):
-    stack = ctx.obj.stack
+    check_if_stack_exists(stack)
 
     if build_policy not in BUILD_POLICIES:
         error_exit(f"{build_policy} is not one of {BUILD_POLICIES}")

src/stack/command_types.py

@@ -18,7 +18,6 @@
 
 @dataclass
 class CommandOptions:
-    stack: str
     quiet: bool = False
     verbose: bool = False
     dry_run: bool = False

src/stack/deploy/deploy.py

@@ -456,5 +456,5 @@ class ConfigDirective:
                         print(f"destination output: {destination_output}")
 
 
-command.add_command(deployment_init, "config")
+command.add_command(deployment_init, "init")
 command.add_command(deployment_create, "create")

src/stack/deploy/deployment.py

@@ -42,10 +42,6 @@
 def command(ctx, dir):
     """manage an existing stack deployment"""
 
-    # Check that --stack wasn't supplied
-    if ctx.parent.obj.stack:
-        print("Error: --stack can't be supplied with the deployment command")
-        sys.exit(1)
     # Check dir is valid
     dir_path = Path(dir)
     if not dir_path.exists():

src/stack/deploy/deployment_create.py

@@ -27,7 +27,6 @@
 from stack import constants
 from stack.opts import opts
 from stack.util import (
-    global_options,
     get_stack_path,
     get_yaml,
     pod_has_scripts,
@@ -41,6 +40,7 @@
 from stack.deploy.stack import Stack
 from stack.deploy.deployer_factory import getDeployerConfigGenerator
 from stack.deploy.deployment_context import DeploymentContext
+from stack.util import check_if_stack_exists
 
 
 def _make_default_deployment_dir():
@@ -266,6 +266,7 @@ def _parse_config_variables(variable_values: str):
 
 
 @click.command()
+@click.option("--stack", help="path to the stack", required=True)
 @click.option("--config", help="Provide config variables for the deployment")
 @click.option("--config-file", help="Provide config variables in a file for the deployment")
 @click.option("--kube-config", help="Provide a config file for a k8s deployment")
@@ -289,6 +290,7 @@ def _parse_config_variables(variable_values: str):
 @click.pass_context
 def init(
     ctx,
+    stack,
     config,
     config_file,
     kube_config,
@@ -298,9 +300,8 @@ def init(
     map_ports_to_host,
 ):
     """output a stack specification file"""
-    stack = global_options(ctx).stack
-    if not stack:
-        error_exit("Error: --stack option is required")
+    check_if_stack_exists(stack)
+
     deployer_type = ctx.obj.deployer.type
     deploy_command_context = ctx.obj
     return init_operation(

src/stack/deploy/webapp/deploy_webapp.py

@@ -102,9 +102,7 @@ def create_deployment(ctx, deployment_dir, image, url, kube_config, image_regist
 def command(ctx):
     """manage a webapp setupment"""
 
-    # Check that --stack wasn't supplied
-    if ctx.parent.obj.stack:
-        error_exit("--stack can't be supplied with the webapp setup command")
+    pass
 
 
 @command.command()

src/stack/main.py

@@ -15,59 +15,46 @@
 # along with this program.  If not, see <http:#www.gnu.org/licenses/>.
 
 import click
-import os
 import sys
 
 from stack.cli_util import StackCLI, load_subcommands_from_stack
 from stack.command_types import CommandOptions
 from stack.repos import fetch
-from stack.repos import setup_repositories
 from stack.build import build
-from stack.build import prepare_containers
 from stack.deploy import deploy
 from stack import version
 from stack.deploy import deployment
 from stack import opts
 from stack import update
 from stack.webapp import webapp
-from stack.util import stack_is_external, error_exit
+from stack.util import STACK_USE_BUILTIN_STACK
 
 CONTEXT_SETTINGS = dict(help_option_names=["-h", "--help"])
 
-STACK_USE_BUILTIN_STACK = "true" == os.environ.get("STACK_USE_BUILTIN_STACK", "false")
-
 
 @click.group(context_settings=CONTEXT_SETTINGS, cls=StackCLI)
-@click.option("--stack", help="path to the stack to build/deploy")
 @click.option("--verbose", help="more detailed output", is_flag=True, default=False)
 @click.option("--debug", help="enable debug logging", is_flag=True, default=False)
 # TEL: Hide these for now, until we make sure they are consistently implemented.
 @click.option("--quiet", is_flag=True, default=False, hidden=True)
 @click.option("--dry-run", is_flag=True, default=False, hidden=True)
 @click.option("--continue-on-error", is_flag=True, default=False, hidden=True)
 @click.pass_context
-def cli(ctx, stack, quiet, verbose, dry_run, debug, continue_on_error):
+def cli(ctx, quiet, verbose, dry_run, debug, continue_on_error):
     """BPI stack"""
-    if stack and not stack_is_external(stack) and not STACK_USE_BUILTIN_STACK:
-        error_exit(f"Stack {stack} does not exist")
-
-    command_options = CommandOptions(stack, quiet, verbose, dry_run, debug, continue_on_error)
+    command_options = CommandOptions(quiet, verbose, dry_run, debug, continue_on_error)
     opts.opts.o = command_options
     ctx.obj = command_options
 
 
 cli.add_command(build.command, "build")
+cli.add_command(deploy.command, "deploy")
 cli.add_command(deployment.command, "deployment")
 cli.add_command(fetch.command, "fetch")
-cli.add_command(deploy.command, "init")
 cli.add_command(update.command, "update")
 cli.add_command(version.command, "version")
 cli.add_command(webapp.command, "webapp")
 
-# Hidden commands
-cli.add_command(prepare_containers.legacy_command, "build-containers")
-cli.add_command(setup_repositories.legacy_command, "fetch repositories")
-
 # We only try to load external commands from an external stack.
 if not STACK_USE_BUILTIN_STACK:
     stack_path = None

src/stack/repos/setup_repositories.py

@@ -33,7 +33,7 @@
     warn_exit,
 )
 
-from stack.util import get_dev_root_path
+from stack.util import get_dev_root_path, check_if_stack_exists
 
 from stack.build.build_util import get_containers_in_scope, host_and_path_for_repo, branch_strip
 
@@ -182,39 +182,21 @@ def parse_branches(branches_string):
         return None
 
 
-@click.command(hidden=True)
-@click.option("--include", help="only clone these repositories")
-@click.option("--exclude", help="don't clone these repositories")
-@click.option("--git-ssh", is_flag=True, default=False)
-@click.option("--check-only", is_flag=True, default=False)
-@click.option("--pull", is_flag=True, default=False)
-@click.option("--branches", help="override branches for repositories")
-@click.pass_context
-def legacy_command(ctx, include, exclude, git_ssh, check_only, pull, branches):
-    """clone the repositories needed by the stack"""
-
-    return _command(ctx, include, exclude, git_ssh, check_only, pull, branches)
-
-
 @click.command()
+@click.option("--stack", help="path to the stack", required=True)
 @click.option("--include", help="only clone these repositories")
 @click.option("--exclude", help="don't clone these repositories")
 @click.option("--git-ssh", is_flag=True, default=False)
 @click.option("--check-only", is_flag=True, default=False)
 @click.option("--pull", is_flag=True, default=False)
 @click.option("--branches", help="override branches for repositories")
 @click.pass_context
-def command(ctx, include, exclude, git_ssh, check_only, pull, branches):
+def command(ctx, stack, include, exclude, git_ssh, check_only, pull, branches):
     """clone the repositories needed by the stack"""
+    check_if_stack_exists(stack)
 
-    return _command(ctx, include, exclude, git_ssh, check_only, pull, branches)
-
-
-def _command(ctx, include, exclude, git_ssh, check_only, pull, branches):
-    """clone the repositories needed by the stack"""
     quiet = opts.o.quiet
     verbose = opts.o.verbose
-    stack = opts.o.stack
 
     branches_array = []
 

src/stack/util.py

@@ -23,6 +23,8 @@
 from typing import Mapping, Set, List
 from stack.constants import stack_file_name, deployment_file_name
 
+STACK_USE_BUILTIN_STACK = "true" == os.environ.get("STACK_USE_BUILTIN_STACK", "false")
+
 
 def include_exclude_check(s, include, exclude):
     if include is None and exclude is None:
@@ -239,3 +241,8 @@ def warn_exit(s):
 
 def env_var_map_from_file(file: Path, expand=True) -> Mapping[str, str]:
     return dotenv_values(file, interpolate=expand)
+
+
+def check_if_stack_exists(stack):
+    if stack and not stack_is_external(stack) and not STACK_USE_BUILTIN_STACK:
+        error_exit(f"Stack {stack} does not exist")