Added crane.pull() function to gcip.addons.container.crane.

Author: bitfoo1

CHANGELOG.md

@@ -25,6 +25,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Added @properties to all public Job attributes.
 * New addons: *aws* to allow receiving AWS account id and region.
 * New `gcip.addons.container.registries.Registry.AWS()` allows getting an ECR URL to be used in pipeline.
+* Added `crane.pull()` function to `gcip.addons.container.crane`.
 
 ### Changed
 * Normalize config_file_path in `gcip.addons.container.config.DockerClientConfig`

gcip/addons/container/jobs/crane.py

@@ -118,3 +118,67 @@ def push(
         job.prepend_scripts(*docker_client_config.get_shell_command())
 
     return job
+
+
+def pull(
+    src_registry: Union[Registry, str],
+    *,
+    tar_path: Optional[str] = None,
+    image_name: Optional[str] = None,
+    image_tag: Optional[str] = None,
+    docker_client_config: Optional[DockerClientConfig] = None,
+    crane_image: Optional[Union[Image, str]] = None,
+) -> Job:
+    """
+    Creates a job to pull container image from remote container registry with `crane`.
+
+    Args:
+        src_registry (str): Registry URL to pull container image from.
+        image_name (str): Container image with namespace to pull from `src_registry`.
+            If `None` it defaults internally to `PredefinedVariables.CI_PROJECT_NAME`.
+        image_tag (str): Tag of the image which will be pulled.  If `None` it defaults internally to `PredefinedVariables.CI_COMMIT_TAG`
+            or `PredefinedVariables.CI_COMMIT_REF_SLUG` in order.
+        tar_path (Optional[str], optional): Path where to save the container image tarball.
+            If `None` it defaults internally to `PredefinedVariables.CI_PROJECT_DIR`. Defaults to None.
+        docker_client_config (Optional[DockerClientConfig], optional): Creates the Docker configuration file base on objects settings,
+            to authenticate against given registries. Defaults to a `DockerClientConfig` with login to the official Docker Hub
+            and expecting credentials given as environment variables `REGISTRY_USER` and `REGISTRY_LOGIN`.
+        crane_image (Optional[Union[Image, str]], optional): Container image which contains `crane` command.
+            Defaults to PredefindedImages.CRANE.
+
+    Returns:
+        Job: Returns a `gcip.Job`, with neccessary configuration to pull a container image from a remote registry and stores it in `tar_path`.
+            Job runs in ```stage=pull```
+    """
+    if not crane_image:
+        crane_image = PredefinedImages.CRANE
+
+    if not tar_path:
+        tar_path = PredefinedVariables.CI_PROJECT_DIR
+
+    if not image_name:
+        image_name = PredefinedVariables.CI_PROJECT_NAME
+    image_path = image_name.replace("/", "_")
+
+    if not docker_client_config:
+        docker_client_config = DockerClientConfig()
+        docker_client_config.add_auth(registry=Registry.DOCKER)
+
+    if not image_tag:
+        if PredefinedVariables.CI_COMMIT_TAG:
+            image_tag = PredefinedVariables.CI_COMMIT_TAG
+        else:
+            image_tag = PredefinedVariables.CI_COMMIT_REF_SLUG
+
+    job = Job(
+        script=[
+            f"crane pull {src_registry}/{image_name}:{image_tag} {tar_path}/{image_path}.tar",
+        ],
+        stage="pull",
+    )
+    job.set_image(crane_image)
+
+    if docker_client_config:
+        job.prepend_scripts(*docker_client_config.get_shell_command())
+
+    return job

tests/unit/comparison_files/test_addons_container_crane_test_crane_advanced_pull.yml

@@ -0,0 +1,14 @@
+stages:
+- pull
+pull:
+  image:
+    name: gcr.io/go-containerregistry/crane:debug
+    entrypoint:
+    - ''
+  stage: pull
+  script:
+  - mkdir -p $HOME/.docker
+  - 'echo "{\"auths\": {\"https://index.docker.io/v1/\": {\"username\": \"$REGISTRY_USERNAME\",
+    \"password\": \"$REGISTRY_PASSWORD\"}}, \"credHelpers\": {\"0132456789.dkr.eu-central-1.amazonaws.com\":
+    \"ecr-login\"}}" > $HOME/.docker/config.json'
+  - crane pull gcr.io/thomass/gcip:main test/foo/bar/thomass_gcip.tar

tests/unit/comparison_files/test_addons_container_crane_test_crane_simple_pull.yml

@@ -0,0 +1,13 @@
+stages:
+- pull
+pull:
+  image:
+    name: gcr.io/go-containerregistry/crane:debug
+    entrypoint:
+    - ''
+  stage: pull
+  script:
+  - mkdir -p $HOME/.docker
+  - 'echo "{\"auths\": {\"https://index.docker.io/v1/\": {\"username\": \"$REGISTRY_USERNAME\",
+    \"password\": \"$REGISTRY_PASSWORD\"}}}" > $HOME/.docker/config.json'
+  - crane pull gcr.io/gitlab-ci-project:11.22.33 /path/to/project/gitlab-ci-project.tar

tests/unit/comparison_files/test_addons_container_crane_test_crane_simple_pull_with_ref.yml

@@ -0,0 +1,13 @@
+stages:
+- pull
+pull:
+  image:
+    name: gcr.io/go-containerregistry/crane:debug
+    entrypoint:
+    - ''
+  stage: pull
+  script:
+  - mkdir -p $HOME/.docker
+  - 'echo "{\"auths\": {\"https://index.docker.io/v1/\": {\"username\": \"$REGISTRY_USERNAME\",
+    \"password\": \"$REGISTRY_PASSWORD\"}}}" > $HOME/.docker/config.json'
+  - crane pull gcr.io/gitlab-ci-project:my-awsome-feature-branch /path/to/project/gitlab-ci-project.tar

tests/unit/test_addons_container_crane.py

@@ -1,3 +1,5 @@
+import pytest
+
 from gcip import Pipeline
 from tests import conftest
 from gcip.core.image import Image
@@ -6,6 +8,14 @@
 from gcip.addons.container.registries import Registry
 
 
+@pytest.fixture()
+def docker_client_config() -> DockerClientConfig:
+    dcc = DockerClientConfig()
+    dcc.add_auth(registry="index.docker.io")
+    dcc.add_cred_helper("0132456789.dkr.eu-central-1.amazonaws.com", cred_helper="ecr-login")
+    return dcc
+
+
 def test_simple_crane_copy_job(gitlab_ci_environment_variables):
     pipeline = Pipeline()
 
@@ -24,17 +34,13 @@ def test_simple_crane_copy_job(gitlab_ci_environment_variables):
     conftest.check(pipeline.render())
 
 
-def test_advanced_crane_copy_job(gitlab_ci_environment_variables):
-    dcc = DockerClientConfig()
-    dcc.add_auth(registry="index.docker.io")
-    dcc.add_cred_helper("0132456789.dkr.eu-central-1.amazonaws.com", "ecr-login")
-
+def test_advanced_crane_copy_job(gitlab_ci_environment_variables, docker_client_config):
     pipeline = Pipeline()
     pipeline.add_children(
         crane.copy(
             "index.docker.io/alpine:3",
             "0132456789.dkr.eu-central-1.amazonaws.com/namespace/alpine:3",
-            docker_client_config=dcc,
+            docker_client_config=docker_client_config,
         ),
         name="with_authentication",
     )
@@ -47,35 +53,56 @@ def test_simple_crane_push_job(gitlab_ci_environment_variables):
     conftest.check(pipeline.render())
 
 
-def test_advanced_crane_push_job(gitlab_ci_environment_variables):
-    dcc = DockerClientConfig()
-    dcc.add_auth(registry="index.docker.io")
-    dcc.add_cred_helper("0132456789.dkr.eu-central-1.amazonaws.com", cred_helper="ecr-login")
+def test_advanced_crane_push_job(gitlab_ci_environment_variables, docker_client_config):
     pipeline = Pipeline()
     pipeline.add_children(
         crane.push(
             dst_registry="index.docker.io",
             image_name="crane",
-            docker_client_config=dcc,
+            docker_client_config=docker_client_config,
             crane_image="crane_image:v1.1.2",
         ),
         name="push_image",
     )
     conftest.check(pipeline.render())
 
 
-def test_addons_container_jobs_crane_push_registry(gitlab_ci_environment_variables):
-    dcc = DockerClientConfig()
-    dcc.add_auth(registry=Registry.DOCKER)
-    dcc.add_cred_helper("0132456789.dkr.eu-central-1.amazonaws.com", cred_helper="ecr-login")
+def test_addons_container_jobs_crane_push_registry(gitlab_ci_environment_variables, docker_client_config):
     pipeline = Pipeline()
     pipeline.add_children(
         crane.push(
             dst_registry=Registry.DOCKER,
             image_name="crane",
-            docker_client_config=dcc,
+            docker_client_config=docker_client_config,
             crane_image="crane_image:v1.1.2",
         ),
         name="push_image",
     )
     conftest.check(pipeline.render())
+
+
+def test_crane_simple_pull(gitlab_ci_environment_variables):
+    pipeline = Pipeline()
+    pipeline.add_children(crane.pull(Registry.GCR))
+    conftest.check(pipeline.render())
+
+
+def test_crane_simple_pull_with_ref(monkeypatch, gitlab_ci_environment_variables):
+    monkeypatch.delenv("CI_COMMIT_TAG")
+    pipeline = Pipeline()
+    pipeline.add_children(crane.pull(Registry.GCR))
+    conftest.check(pipeline.render())
+
+
+def test_crane_advanced_pull(gitlab_ci_environment_variables, docker_client_config):
+    pipeline = Pipeline()
+    pipeline.add_children(
+        crane.pull(
+            Registry.GCR,
+            docker_client_config=docker_client_config,
+            image_name="thomass/gcip",
+            image_tag="main",
+            tar_path="test/foo/bar",
+        )
+    )
+    conftest.check(pipeline.render())