Added cmake-compile command, changed prefixing (#7)

* Added cmake-compile command, changed prefixing

+ Added the cmake-compile command and all associated functionality
~ Changed tag prefixing to use a function in most cases
+ Added tag prefixing for base tags as well as image tags to make the interface more consistent.

* Tiny documentation change.

* setup_conda_dev bugfix

~ Removed a bug that causes errors when building the conda dev image.

* Lock file update

~ Updated the lock files.

* Bugfixes

~ Updated the GCC version in the lockfiles
~ Added a Test option for docker init images to avoid unintended removals

* Added ISCE3 test fixtures and CMake build test.

* Documentation updates

* ISCE3 fixtures: No-Cache -> False

---------

Co-authored-by: tyler-g-hudson <[email protected]>

Author: Tyler-g-hudson

docker_cli/_docker_cmake.py

@@ -60,3 +60,29 @@ def cmake_config_dockerfile(base: str, build_type: str, with_cuda: bool = True)
     ).strip()
 
     return dockerfile
+
+
+def cmake_build_dockerfile(base: str) -> str:
+    """
+    Creates a dockerfile for compiling with CMake.
+
+    Parameters
+    ----------
+    base : str
+        The base image tag.
+
+    Returns
+    -------
+    dockerfile: str
+        The generated Dockerfile.
+    """
+    # Begin constructing the dockerfile with the initial FROM line.
+    dockerfile = f"FROM {base}\n\n"
+
+    # Run as the $MAMBA_USER and activate the micromamba environment.
+    dockerfile += f"{micromamba_docker_lines()}\n\n"
+
+    # Build the project.
+    dockerfile += "RUN cmake --build $BUILD_PREFIX --parallel"
+
+    return dockerfile

docker_cli/_docker_init.py

@@ -1,7 +1,7 @@
 from textwrap import dedent
 
 
-def init_dockerfile(base: str, custom_lines: str) -> str:
+def init_dockerfile(base: str, custom_lines: str, test: bool = False) -> str:
     """
     Set up the initial configuration image.
 
@@ -11,13 +11,16 @@ def init_dockerfile(base: str, custom_lines: str) -> str:
         The name of the image upon this one will be based.
     custom_lines : str
         Custom installation and configuration lines to be added to the Dockerfile.
+    test : bool, optional
+        Add a "test" directory mkdir command to the Dockerfile if True. Used for test
+        images. Defaults to False.
 
     Returns
     -------
     str
         The generated Dockerfile.
     """
-    return (
+    dockerfile = (
         f"FROM {base}\n\n"
         + custom_lines
         + "\n"
@@ -35,3 +38,8 @@ def init_dockerfile(base: str, custom_lines: str) -> str:
         """
         ).strip()
     )
+
+    if test:
+        dockerfile += "\n\nRUN mkdir /test_directory"
+
+    return dockerfile

docker_cli/_utils.py

@@ -18,6 +18,13 @@
 from .defaults import universal_tag_prefix
 
 
+def prefix_image_tag(tag: str):
+    """Prepends the image tag prefix to the tag if it is not already there."""
+    prefix = universal_tag_prefix()
+    prefixed_tag = tag if tag.startswith(prefix) else f"{prefix}-{tag}"
+    return prefixed_tag
+
+
 @contextmanager
 def temp_image(
     base: str,
@@ -53,7 +60,7 @@ def temp_image(
     # inherently pulls from the internet if the base image isn't already present on
     # the local environment. This ensures that, if the image exists anywhere accessible,
     # it will be found automatically without the need for additional logic.
-    tag = f"{universal_tag_prefix()}-temp-{generate_random_string(k=10)}"
+    tag = prefix_image_tag(f"temp-{generate_random_string(k=10)}")
     try:
         temp: Image = Image.build(  # type: ignore
             tag=tag,

docker_cli/cli/build_commands.py

@@ -2,7 +2,7 @@
 from pathlib import Path
 from typing import List
 
-from ..commands import configure_cmake, copy_dir, get_archive
+from ..commands import compile_cmake, configure_cmake, copy_dir, get_archive
 from ._utils import add_tag_argument, help_formatter
 
 
@@ -13,7 +13,11 @@ def init_build_parsers(subparsers: argparse._SubParsersAction) -> None:
     The build commands are the group of commands to be completed after the CUDA and
     conda environments have been installed to the image, with the purpose of acquiring
     and building the ISCE3 repository and any further repositories.
-    These commands consist of the "get-archive", "copydir", and "cmake-config" commands,
+    These commands consist of the following commands:
+        get-archive,
+        copydir,
+        cmake-config,
+        cmake-compile,
     and more are being added.
 
     Parameters
@@ -57,31 +61,33 @@ def init_build_parsers(subparsers: argparse._SubParsersAction) -> None:
         help="If used, the build configuration will not use CUDA.",
     )
 
-    setup_parse = argparse.ArgumentParser(add_help=False)
-    setup_parse.add_argument(
+    setup_params = argparse.ArgumentParser(add_help=False)
+    setup_params.add_argument(
         "--base",
         "-b",
         type=str,
         required=True,
         help="The name of the base Docker image.",
     )
 
+    no_cache_params = argparse.ArgumentParser(add_help=False)
+    no_cache_params.add_argument(
+        "--no-cache",
+        action="store_true",
+        help="Run Docker build with no cache if used.",
+    )
+
     archive_parser = subparsers.add_parser(
         "get-archive",
-        parents=[setup_parse, archive_params],
+        parents=[setup_params, archive_params, no_cache_params],
         help="Set up the GitHub repository image, in [USER]/[REPO_NAME] format.",
         formatter_class=help_formatter,
     )
     add_tag_argument(parser=archive_parser, default="repo")
-    archive_parser.add_argument(
-        "--no-cache",
-        action="store_true",
-        help="Run Docker build with no cache if used.",
-    )
 
     copy_dir_parser = subparsers.add_parser(
         "copydir",
-        parents=[setup_parse],
+        parents=[setup_params, no_cache_params],
         help="Insert the contents of a directory at the given path.",
         formatter_class=help_formatter,
     )
@@ -101,24 +107,22 @@ def init_build_parsers(subparsers: argparse._SubParsersAction) -> None:
         help="The path on the image to copy the source directory to. If not given, "
         "the base name of the path given by the directory argument will be used.",
     )
-    copy_dir_parser.add_argument(
-        "--no-cache",
-        action="store_true",
-        help="Run Docker build with no cache if used.",
-    )
 
     config_parser = subparsers.add_parser(
         "cmake-config",
-        parents=[setup_parse, config_params],
+        parents=[setup_params, config_params, no_cache_params],
         help="Creates an image with a configured compiler.",
         formatter_class=help_formatter,
     )
     add_tag_argument(parser=config_parser, default="configured")
-    config_parser.add_argument(
-        "--no-cache",
-        action="store_true",
-        help="Run Docker build with no cache if used.",
+
+    compile_parser = subparsers.add_parser(
+        "cmake-compile",
+        parents=[setup_params, no_cache_params],
+        help="Creates an image with the project built.",
+        formatter_class=help_formatter,
     )
+    add_tag_argument(parser=compile_parser, default="compiled")
 
 
 def build_command_names() -> List[str]:
@@ -133,3 +137,5 @@ def run_build(args: argparse.Namespace, command: str) -> None:
         copy_dir(**vars(args))
     if command == "cmake-config":
         configure_cmake(**vars(args))
+    if command == "cmake-compile":
+        compile_cmake(**vars(args))

docker_cli/commands.py

@@ -5,14 +5,13 @@
 from subprocess import DEVNULL, PIPE, run
 from typing import Iterable, List
 
-from ._docker_cmake import cmake_config_dockerfile
+from ._docker_cmake import cmake_build_dockerfile, cmake_config_dockerfile
 from ._docker_git import git_extract_dockerfile
 from ._docker_insert import insert_dir_dockerfile
 from ._docker_mamba import mamba_lockfile_command
 from ._image import Image
 from ._url_reader import URLReader
-from ._utils import image_command_check, is_conda_pkg_name, temp_image
-from .defaults import universal_tag_prefix
+from ._utils import image_command_check, is_conda_pkg_name, prefix_image_tag, temp_image
 
 
 def get_archive(
@@ -54,11 +53,11 @@ def get_archive(
         with temp_image(base) as temp_img:
             _, url_reader, _ = image_command_check(temp_img)
 
-    prefix = universal_tag_prefix()
-    img_tag = tag if tag.startswith(prefix) else f"{prefix}-{tag}"
+    img_tag = prefix_image_tag(tag)
+    base_tag = prefix_image_tag(base)
 
     dockerfile = git_extract_dockerfile(
-        base=base,
+        base=base_tag,
         directory=directory,
         archive_url=archive_url,
         url_reader=url_reader,
@@ -106,8 +105,7 @@ def copy_dir(
         The generated image.
     """
 
-    prefix = universal_tag_prefix()
-    img_tag = tag if tag.startswith(prefix) else f"{prefix}-{tag}"
+    img_tag = prefix_image_tag(tag)
 
     dir_str = os.fspath(directory)
 
@@ -128,8 +126,9 @@ def copy_dir(
 
     # Generate the dockerfile. The source directory will be "." since the build context
     # will be at the source path when the image is built.
+    base_tag = prefix_image_tag(base)
     dockerfile: str = insert_dir_dockerfile(
-        base=base,
+        base=base_tag,
         target_dir=target_dir,
         source_dir=".",
     )
@@ -176,17 +175,49 @@ def configure_cmake(
     Image
         The generated image.
     """
+    base_tag = prefix_image_tag(base)
+
     dockerfile: str = cmake_config_dockerfile(
-        base=base,
+        base=base_tag,
         build_type=build_type,
         with_cuda=not no_cuda,
     )
 
-    prefix = universal_tag_prefix()
-    img_tag = tag if tag.startswith(prefix) else f"{prefix}-{tag}"
+    img_tag = prefix_image_tag(tag)
     return Image.build(tag=img_tag, dockerfile_string=dockerfile, no_cache=no_cache)
 
 
+def compile_cmake(tag: str, base: str, no_cache: bool = False) -> Image:
+    """
+    Produces an image with the working directory compiled.
+
+    Parameters
+    ----------
+    tag : str
+        The image tag.
+    base : str
+        The base image tag.
+    no_cache : bool, optional
+        Run Docker build with no cache if True. Defaults to False.
+
+    Returns
+    -------
+    Image
+        The generated image.
+    """
+
+    prefixed_tag: str = prefix_image_tag(tag)
+    prefixed_base_tag: str = prefix_image_tag(base)
+
+    dockerfile: str = cmake_build_dockerfile(base=prefixed_base_tag)
+
+    return Image.build(
+        tag=prefixed_tag,
+        dockerfile_string=dockerfile,
+        no_cache=no_cache,
+    )
+
+
 def dropin(tag: str) -> None:
     """
     Initiates a drop-in session on an image.
@@ -196,6 +227,7 @@ def dropin(tag: str) -> None:
     tag : str
         The tag or ID of the image.
     """
+    tag = prefix_image_tag(tag)
     image: Image = Image(tag)
 
     image.drop_in()
@@ -234,18 +266,18 @@ def remove(
 
     # Search for and delete all images matching each tag or wildcard.
     for tag in tags:
-        prefix = universal_tag_prefix()
-        search = tag if (tag.startswith(prefix) or ignore_prefix) else f"{prefix}-{tag}"
+        if not ignore_prefix:
+            tag = prefix_image_tag(tag)
         if verbose:
-            print(f"Attempting removal for tag: {search}")
+            print(f"Attempting removal for tag: {tag}")
 
         # Search for all images whose name matches this tag, acquire a list
-        search_command = split(f'docker images --filter=reference="{search}" -q')
+        search_command = split(f'docker images --filter=reference="{tag}" -q')
         search_result = run(search_command, text=True, stdout=PIPE, stderr=output)
         # An empty return indicates that no such images were found. Skip to the next.
         if search_result.stdout == "":
             if verbose:
-                print(f"No images found matching pattern {search}. Proceeding.")
+                print(f"No images found matching pattern {tag}. Proceeding.")
             continue
         # The names come in a list delimited by newlines. Reform this to be delimited
         # by spaces to use with `Docker rmi`.
@@ -277,6 +309,7 @@ def make_lockfile(
         The name of the environment. Defaults to "base".
     """
     cmd: str = mamba_lockfile_command(env_name=env_name)
+    tag = prefix_image_tag(tag)
     image: Image = Image(tag)
     lockfile: str = image.run(command=cmd, stdout=PIPE)
     assert isinstance(lockfile, str)