Added the CMake Install Command (#8)

* docker_cli -> WIGWAM

* Added `cmake-install` command

* tiny fix

* PR fixes

+ Added documentation for why to use USER root in cmake install
+ Added a check for the case where an image uses 'lib' and not 'lib64'
+ Added PYTHONPATH env variable change in cmake install
~ Changed some documentation in cmake install
- Remove workdir change in cmake install

* Added unit test, fixed libdir bug

---------

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

Author: Tyler-g-hudson

test/conftest.py

@@ -2,7 +2,7 @@
 import sys
 from pathlib import Path
 
-from docker_cli.commands import remove
+from wigwam.commands import remove
 
 # This import is necessary for the fixtures to be visible to the test files.
 # Importing fixtures directly into a file can cause some non-trivial problems with
@@ -20,7 +20,7 @@ def pytest_sessionstart(session):
     os.chdir(Path(__file__).parent)
 
     # Set the system to look for files in the repository root path so it can see the
-    # docker_cli module without having to install it.
+    # wigwam module without having to install it.
     sys.path.insert(0, str(Path(__file__).parents[1]))
 
 

test/fixtures.py

@@ -6,9 +6,9 @@
 
 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 wigwam import Image, PackageManager, URLReader
+from wigwam._docker_init import init_dockerfile
+from wigwam._utils import image_command_check, temp_image
 
 from .utils import determine_scope, generate_tag, remove_docker_image
 

test/fixtures_isce3.py

@@ -7,10 +7,14 @@
 
 from pytest import fixture
 
-from docker_cli import Image, URLReader
-from docker_cli._docker_cmake import cmake_build_dockerfile, cmake_config_dockerfile
-from docker_cli._docker_git import git_extract_dockerfile
-from docker_cli.setup_commands import setup_all
+from wigwam import Image, URLReader
+from wigwam._docker_cmake import (
+    cmake_build_dockerfile,
+    cmake_config_dockerfile,
+    cmake_install_dockerfile,
+)
+from wigwam._docker_git import git_extract_dockerfile
+from wigwam.setup_commands import setup_all
 
 from .utils import determine_scope, generate_tag, remove_docker_image
 
@@ -110,7 +114,7 @@ def isce3_git_repo_image(
         tag=isce3_git_repo_tag, dockerfile_string=dockerfile, no_cache=False
     )
 
-    remove_docker_image(isce3_git_repo_image)
+    remove_docker_image(isce3_git_repo_tag)
 
 
 @fixture(scope=determine_scope)
@@ -162,4 +166,28 @@ def isce3_cmake_build_image(
         tag=isce3_cmake_build_tag, dockerfile_string=dockerfile, no_cache=False
     )
 
-    remove_docker_image(isce3_cmake_config_tag)
+    remove_docker_image(isce3_cmake_build_tag)
+
+
+@fixture(scope=determine_scope)
+def isce3_cmake_install_tag() -> str:
+    """Return a tag for the ISCE3 CMake install image."""
+    return generate_tag("isce3-cmake-install")
+
+
+@fixture(scope=determine_scope)
+def isce3_cmake_install_image(
+    isce3_cmake_install_tag: str,
+    isce3_cmake_build_tag: str,
+    isce3_cmake_build_image: Image,  # type: ignore
+) -> Iterator[Image]:
+    """Return the ISCE3 CMake install image."""
+    dockerfile = cmake_install_dockerfile(base=isce3_cmake_build_tag)
+
+    yield Image.build(
+        tag=isce3_cmake_install_tag,
+        dockerfile_string=dockerfile,
+        no_cache=False,
+    )
+
+    remove_docker_image(isce3_cmake_install_tag)

test/test_bind_mount.py

@@ -1,6 +1,6 @@
 from pytest import raises
 
-from docker_cli._bind_mount import BindMount
+from wigwam._bind_mount import BindMount
 
 
 def test_mount_init():

test/test_docker_cmake.py

@@ -5,8 +5,12 @@
 
 from pytest import fixture, mark
 
-from docker_cli import Image, mamba_install_dockerfile
-from docker_cli._docker_cmake import cmake_build_dockerfile, cmake_config_dockerfile
+from wigwam import Image, mamba_install_dockerfile
+from wigwam._docker_cmake import (
+    cmake_build_dockerfile,
+    cmake_config_dockerfile,
+    cmake_install_dockerfile,
+)
 
 from .utils import (
     determine_scope,
@@ -216,13 +220,17 @@ def test_cmake_config_dockerfile(
         rough_dockerfile_validity_check(example_cmake_config_dockerfile)
 
     @mark.dockerfiles
-    def test_cmake_build_dockerfile(
-        self,
-    ):
+    def test_cmake_build_dockerfile(self):
         """Tests the CMake build dockerfiles generated by the system."""
         dockerfile = cmake_build_dockerfile(base="abc")
         rough_dockerfile_validity_check(dockerfile=dockerfile)
 
+    @mark.dockerfiles
+    def test_cmake_install_dockerfile(self):
+        """Tests the CMake build dockerfiles generated by the system."""
+        dockerfile = cmake_install_dockerfile(base="abc")
+        rough_dockerfile_validity_check(dockerfile=dockerfile)
+
     @mark.images
     class TestCMakeImages:
         def test_cmake_config_build(
@@ -266,3 +274,18 @@ def test_cmake_build_image(
             ISCE3 base images.
             """
             isce3_cmake_build_image.run(command="test cxx/isce3/libisce3.so")
+
+        @mark.isce3
+        @mark.slow
+        def test_cmake_install_image(
+            self,
+            isce3_cmake_install_image: Image,
+        ):
+            """
+            Test the CMake install image.
+
+            NOTE: This test runs very slowly because it requires the building of all
+            ISCE3 base images.
+            """
+            isce3_cmake_install_image.run(command='python -c "import isce3"')
+            isce3_cmake_install_image.run(command='python -c "import nisar"')

test/test_docker_cuda.py

@@ -2,15 +2,15 @@
 
 from pytest import fixture, mark
 
-from docker_cli import Image
-from docker_cli._docker_cuda import (
+from wigwam import Image
+from wigwam._docker_cuda import (
     AptGetCUDADockerfileGen,
     CUDADockerfileGenerator,
     YumCUDADockerfileGen,
     get_cuda_dockerfile_generator,
 )
-from docker_cli._package_manager import AptGet, PackageManager, Yum
-from docker_cli._url_reader import Curl, URLReader, Wget
+from wigwam._package_manager import AptGet, PackageManager, Yum
+from wigwam._url_reader import Curl, URLReader, Wget
 
 from .utils import (
     determine_scope,

test/test_docker_git.py

@@ -3,9 +3,9 @@
 
 from pytest import mark
 
-from docker_cli._docker_git import git_extract_dockerfile
-from docker_cli._image import Image
-from docker_cli._url_reader import URLReader, get_supported_url_readers, get_url_reader
+from wigwam._docker_git import git_extract_dockerfile
+from wigwam._image import Image
+from wigwam._url_reader import URLReader, get_supported_url_readers, get_url_reader
 
 from .utils import generate_tag, rough_dockerfile_validity_check
 

test/test_docker_insert.py

@@ -1,7 +1,7 @@
 from pytest import mark
 
-from docker_cli._docker_insert import insert_dir_dockerfile
-from docker_cli._image import Image
+from wigwam._docker_insert import insert_dir_dockerfile
+from wigwam._image import Image
 
 from .utils import generate_tag, rough_dockerfile_validity_check
 

test/test_docker_mamba.py

@@ -3,8 +3,8 @@
 
 from pytest import fixture, mark
 
-from docker_cli import Image
-from docker_cli._docker_mamba import mamba_add_reqs_dockerfile, mamba_install_dockerfile
+from wigwam import Image
+from wigwam._docker_mamba import mamba_add_reqs_dockerfile, mamba_install_dockerfile
 
 from .utils import (
     determine_scope,

test/test_image.py

@@ -5,9 +5,9 @@
 
 from pytest import mark, raises
 
-from docker_cli import CommandNotFoundError, DockerBuildError, Image
-from docker_cli._exceptions import ImageNotFoundError
-from docker_cli._image import get_image_id
+from wigwam import CommandNotFoundError, DockerBuildError, Image
+from wigwam._exceptions import ImageNotFoundError
+from wigwam._image import get_image_id
 
 from .utils import remove_docker_image