Added the cmake-config command (#6)

* Added the cmake-config command

+ also added a defaults.py file that holds default names and paths.
~ Moved the default tag prefix to the defaults file.

* Removed the moved universal tag function from _utils.py

* src prefix, CMAKE -> CMake,  docs changes

+ Added src_prefix function to defaults.
~ Changed references to CMAKE to instead say CMake
~ Some documentation improvement

* Small doc change

* Added unit tests for CMake config.

+ Added a cmake mark.
+ Added fixtures, functions, and tests for testing CMake config.
+ Added a CMake and Ninja lock file.

* BUGFIX: Unintended removal of init images by testing

Normal init images were removed by testing.
+ Added a function for making init image Dockerfiles.
~ Moved the above funtionality out of setup_init().
~ Changed the init_image fixture to add a unique directory to the init dockerfile so it will not delete images unintentionally.

* Removed src_prefix()

---------

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

Author: Tyler-g-hudson

docker_cli/_docker_cmake.py

@@ -0,0 +1,62 @@
+from textwrap import dedent
+
+from ._docker_mamba import micromamba_docker_lines
+from .defaults import build_prefix, install_prefix
+
+
+def cmake_config_dockerfile(base: str, build_type: str, with_cuda: bool = True) -> str:
+    """
+    Creates a Dockerfile for configuring CMake Build.
+
+    This function assumes that the working directory on the image is at the
+    source directory where the top-level CMakeLists.txt file is contained.
+
+    Parameters
+    ----------
+    base : str
+        The base image tag.
+    build_type : str
+        The CMake build type. See
+        `here <https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html>`_
+        for possible values.
+    with_cuda : bool, optional
+        Whether or not to use CUDA in the build. Defaults to True.
+
+    Returns
+    -------
+    dockerfile : str
+        The generated Dockerfile.
+    """
+    # Parsing the additional arguments and then joining them as a list because there may
+    # be additional cmake arguments to add in the future, and this simplifies the
+    # process of adding them.
+    additional_args = []
+    if with_cuda:
+        additional_args += ["-D WITH_CUDA=YES"]
+    else:
+        additional_args += ["-D WITH_CUDA=NO"]
+    cmake_extra_args = " ".join(additional_args)
+
+    # Begin constructing the dockerfile with the initial FROM line.
+    dockerfile: str = f"FROM {base}\n\n"
+
+    # Activate the micromamba user and environment.
+    dockerfile += micromamba_docker_lines() + "\n\n"
+    dockerfile += dedent(
+        f"""
+            ENV INSTALL_PREFIX {str(install_prefix())}
+            ENV BUILD_PREFIX {str(build_prefix())}
+
+            RUN cmake \\
+                -S . \\
+                -B $BUILD_PREFIX \\
+                -G Ninja \\
+                -D ISCE3_FETCH_DEPS=NO \\
+                -D CMAKE_BUILD_TYPE={build_type} \\
+                -D CMAKE_INSTALL_PREFIX=$INSTALL_PREFIX \\
+                -D CMAKE_PREFIX_PATH=$MAMBA_ROOT_PREFIX \\
+                {cmake_extra_args}
+        """
+    ).strip()
+
+    return dockerfile

docker_cli/_docker_init.py

@@ -0,0 +1,37 @@
+from textwrap import dedent
+
+
+def init_dockerfile(base: str, custom_lines: str) -> str:
+    """
+    Set up the initial configuration image.
+
+    Parameters
+    ----------
+    base : 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.
+
+    Returns
+    -------
+    str
+        The generated Dockerfile.
+    """
+    return (
+        f"FROM {base}\n\n"
+        + custom_lines
+        + "\n"
+        + dedent(
+            """
+        ENV DEFAULT_GROUP defaultgroup
+        ENV DEFAULT_USER defaultuser
+        ENV DEFAULT_GID 1000
+        ENV DEFAULT_UID 1000
+
+        RUN groupadd -g $DEFAULT_GID $DEFAULT_GROUP
+        RUN useradd -g $DEFAULT_GID -u $DEFAULT_UID -m $DEFAULT_USER
+
+        RUN chmod -R 777 /tmp
+        """
+        ).strip()
+    )

docker_cli/_utils.py

@@ -15,18 +15,7 @@
     get_supported_package_managers,
 )
 from ._url_reader import URLReader, get_supported_url_readers, get_url_reader
-
-
-def universal_tag_prefix() -> str:
-    """
-    Returns a prefix for tags generated by the system.
-
-    Returns
-    -------
-    str
-        The prefix.
-    """
-    return "dcli"
+from .defaults import universal_tag_prefix
 
 
 @contextmanager

docker_cli/cli/build_commands.py

@@ -2,7 +2,7 @@
 from pathlib import Path
 from typing import List
 
-from ..commands import copy_dir, get_archive
+from ..commands import configure_cmake, copy_dir, get_archive
 from ._utils import add_tag_argument, help_formatter
 
 
@@ -13,8 +13,8 @@ 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" and "copydir" commands, and more are
-    being added.
+    These commands consist of the "get-archive", "copydir", and "cmake-config" commands,
+    and more are being added.
 
     Parameters
     -----------
@@ -39,6 +39,24 @@ def init_build_parsers(subparsers: argparse._SubParsersAction) -> None:
         help="The path to place the contents of the Git archive at on the image.",
     )
 
+    build_type_choices = ["Release", "Debug", "RelWithDebInfo", "MinSizeRel"]
+    config_params = argparse.ArgumentParser(add_help=False)
+    config_params.add_argument(
+        "--build-type",
+        type=str,
+        default="Release",
+        metavar="CMAKE_BUILD_TYPE",
+        choices=build_type_choices,
+        help="The CMAKE_BUILD_TYPE argument for CMake. Valid options are: "
+        + f"{', '.join(build_type_choices)}. Defaults to \"Release\".",
+    )
+    config_params.add_argument(
+        "--no-cuda",
+        action="store_true",
+        default=False,
+        help="If used, the build configuration will not use CUDA.",
+    )
+
     setup_parse = argparse.ArgumentParser(add_help=False)
     setup_parse.add_argument(
         "--base",
@@ -89,14 +107,29 @@ def init_build_parsers(subparsers: argparse._SubParsersAction) -> None:
         help="Run Docker build with no cache if used.",
     )
 
+    config_parser = subparsers.add_parser(
+        "cmake-config",
+        parents=[setup_parse, config_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.",
+    )
+
 
 def build_command_names() -> List[str]:
     """Returns a list of all build command names."""
-    return ["get-archive", "copydir"]
+    return ["get-archive", "copydir", "cmake-config"]
 
 
 def run_build(args: argparse.Namespace, command: str) -> None:
     if command == "get-archive":
         get_archive(**vars(args))
     if command == "copydir":
         copy_dir(**vars(args))
+    if command == "cmake-config":
+        configure_cmake(**vars(args))

docker_cli/cli/cli.py

@@ -2,7 +2,7 @@
 import sys
 from typing import Sequence
 
-from .._utils import universal_tag_prefix
+from ..defaults import universal_tag_prefix
 from ._utils import help_formatter
 from .build_commands import build_command_names, init_build_parsers, run_build
 from .setup_commands import init_setup_parsers, run_setup

docker_cli/commands.py

@@ -5,17 +5,14 @@
 from subprocess import DEVNULL, PIPE, run
 from typing import Iterable, List
 
+from ._docker_cmake import 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,
-    universal_tag_prefix,
-)
+from ._utils import image_command_check, is_conda_pkg_name, temp_image
+from .defaults import universal_tag_prefix
 
 
 def get_archive(
@@ -149,6 +146,47 @@ def copy_dir(
     )
 
 
+def configure_cmake(
+    tag: str,
+    base: str,
+    build_type: str,
+    no_cuda: bool = False,
+    no_cache: bool = False,
+) -> Image:
+    """
+    Produces an image with CMake configured.
+
+    Parameters
+    ----------
+    tag : str
+        The image tag.
+    base : str
+        The base image tag.
+    build_type : str
+        The CMake build type. See
+        `here <https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html>`_
+        for possible values.
+    no_cuda : bool, optional
+        If True, build without CUDA. Defaults to False.
+    no_cache : bool, optional
+        Run Docker build with no cache if True. Defaults to False.
+
+    Returns
+    -------
+    Image
+        The generated image.
+    """
+    dockerfile: str = cmake_config_dockerfile(
+        base=base,
+        build_type=build_type,
+        with_cuda=not no_cuda,
+    )
+
+    prefix = universal_tag_prefix()
+    img_tag = tag if tag.startswith(prefix) else f"{prefix}-{tag}"
+    return Image.build(tag=img_tag, dockerfile_string=dockerfile, no_cache=no_cache)
+
+
 def dropin(tag: str) -> None:
     """
     Initiates a drop-in session on an image.

docker_cli/defaults.py

@@ -0,0 +1,16 @@
+from pathlib import Path
+
+
+def universal_tag_prefix() -> str:
+    """Returns a prefix for tags generated by the system."""
+    return "dcli"
+
+
+def install_prefix() -> Path:
+    """Returns the build system's default install prefix path."""
+    return Path("/app")
+
+
+def build_prefix() -> Path:
+    """Returns the build system's default build prefix path."""
+    return Path("/tmp/build")

docker_cli/setup_commands.py

@@ -1,20 +1,17 @@
 from __future__ import annotations
 
 from pathlib import Path
-from textwrap import dedent, indent
+from textwrap import indent
 from typing import Dict, Optional, Tuple
 
 from ._docker_cuda import CUDADockerfileGenerator, get_cuda_dockerfile_generator
+from ._docker_init import init_dockerfile
 from ._docker_mamba import mamba_add_reqs_dockerfile, mamba_install_dockerfile
 from ._image import Image
 from ._package_manager import PackageManager
 from ._url_reader import URLReader, get_url_reader
-from ._utils import (
-    image_command_check,
-    parse_cuda_info,
-    temp_image,
-    universal_tag_prefix,
-)
+from ._utils import image_command_check, parse_cuda_info, temp_image
+from .defaults import universal_tag_prefix
 
 
 def setup_init(
@@ -42,26 +39,9 @@ def setup_init(
         The URL Reader present on the image.
     """
     with temp_image(base) as temp_img:
-        package_mgr, url_reader, dockerfile = image_command_check(temp_img, True)
-
-    dockerfile = (
-        f"FROM {base}\n\n"
-        + dockerfile
-        + "\n"
-        + dedent(
-            """
-        ENV DEFAULT_GROUP defaultgroup
-        ENV DEFAULT_USER defaultuser
-        ENV DEFAULT_GID 1000
-        ENV DEFAULT_UID 1000
-
-        RUN groupadd -g $DEFAULT_GID $DEFAULT_GROUP
-        RUN useradd -g $DEFAULT_GID -u $DEFAULT_UID -m $DEFAULT_USER
-
-        RUN chmod -R 777 /tmp
-        """
-        ).strip()
-    )
+        package_mgr, url_reader, initial_lines = image_command_check(temp_img, True)
+
+    dockerfile = init_dockerfile(base=base, custom_lines=initial_lines)
 
     prefix = universal_tag_prefix()
     img_tag = tag if tag.startswith(prefix) else f"{prefix}-{tag}"

pytest.ini

@@ -3,6 +3,7 @@ log_cli = 0
 log_cli_level = WARNING
 markers =
     build: mark a test as a build command test.
+    cmake: mark a test as a CMake test.
     cuda: mark a test as a CUDA test.
     dockerfiles: mark a test as a dockerfile test.
     git: mark a test as a Git test.

test/fixtures.py

@@ -7,8 +7,8 @@
 from pytest import fixture
 
 from docker_cli import Image, PackageManager, URLReader
+from docker_cli._docker_init import init_dockerfile
 from docker_cli._utils import image_command_check, temp_image
-from docker_cli.setup_commands import setup_init
 
 from .utils import determine_scope, generate_tag, remove_docker_image
 
@@ -92,7 +92,20 @@ def init_image(base_tag: str, init_tag: str) -> Iterator[Image]:
     Iterator[Image]
         The initialization tag generator.
     """
-    img, _, _ = setup_init(base=base_tag, tag=init_tag, no_cache=False)
+    # Get some initial install lines to ensure that the appropriate software is
+    # installed on the init image.
+    with temp_image(base_tag) as temp_img:
+        _, _, initial_lines = image_command_check(temp_img, True)
+
+    # Get the init image dockerfile.
+    dockerfile = init_dockerfile(base=base_tag, custom_lines=initial_lines)
+
+    # Creates a unique directory in the image. This causes the image to be unique,
+    # preventing unintentional deletion of init images that are not for testing.
+    dockerfile += f"\n\nRUN mkdir {init_tag}"
+
+    # Build and yield the image.
+    img = Image.build(tag=init_tag, dockerfile_string=dockerfile)
     yield img
     remove_docker_image(init_tag)