Added gcip.addon.container.job.crane to allow copying container images between registries.

Author: bitfoo1

CHANGELOG.md

@@ -19,6 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Improved `conftest.check()` function. Now AssertionError is handled, the user will get receive how to update comparison files.
 * Added new class `PredefinedImages` in `gcip.addons.container`. Allows access to container images, that are widley used.
 * Added new `class` which handels docker client config and renders it to a json string.
+* Added `gcip.addon.container.job.crane` to allow copying container images between registries.
 
 ### Changed
 

gcip/addons/container/jobs/crane.py

@@ -0,0 +1,50 @@
+from typing import Union, Optional
+
+from gcip.core.job import Job
+from gcip.core.image import Image
+from gcip.addons.container.config import DockerClientConfig
+from gcip.addons.container.images import PredefinedImages
+
+
+def copy(
+    src: str,
+    dst: str,
+    *,
+    docker_client_config: Optional[DockerClientConfig] = None,
+    crane_image: Optional[Union[Image, str]] = None,
+) -> Job:
+    """
+    Creates a job to copy container images with `crane`.
+    See [`crane`](https://github.com/google/go-containerregistry/tree/main/cmd/crane)
+
+    Copying an image is usfull, if you want to have container images as close as possible
+    to your cluster or servers.
+
+    Args:
+        src (str): Registry URL to copy container image from.
+        dst (str): Registry URL to copy container image to.
+        docker_client_config (Optional[DockerClientConfig], optional): Creates the Docker configuration file base on objects settings,
+            used by crane to authenticate against given registries. Defaults to None.
+        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 copy a container image between images.
+    """
+    if not crane_image:
+        crane_image = PredefinedImages.CRANE
+
+    job = Job(
+        script=[
+            "date",
+            f"crane validate --remote {src}",
+            f"crane copy {src} {dst}",
+        ],
+        namespace="push_container_image",
+    )
+    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_advanced_crane_job.yml

@@ -0,0 +1,14 @@
+stages:
+- push_container_image
+push-container-image-with-authentication:
+  image:
+    name: gcr.io/go-containerregistry/crane:latest
+  stage: push_container_image
+  script:
+  - mkdir -p $HOME/.docker/
+  - 'echo "{\"auths\": {\"index.docker.io\": {\"username\": \"$REGISTRY_USERNAME\",
+    \"password\": \"$REGISTRY_PASSWORD\"}}, \"credHelpers\": {\"0132456789.dkr.eu-central-1.amazonaws.com\":
+    \"ecr-login\"}}" > $HOME/.docker/config.json'
+  - date
+  - crane validate --remote index.docker.io/alpine:3
+  - crane copy index.docker.io/alpine:3 0132456789.dkr.eu-central-1.amazonaws.com/namespace/alpine:3

tests/unit/comparison_files/test_addons_container_crane_test_default_crane_job.yml

@@ -0,0 +1,18 @@
+stages:
+- push_container_image
+push-container-image-default:
+  image:
+    name: gcr.io/go-containerregistry/crane:latest
+  stage: push_container_image
+  script:
+  - date
+  - crane validate --remote index.docker.io/alpine:3
+  - crane copy index.docker.io/alpine:3 index.docker.io/user/alpine:3
+push-container-image-custom-image:
+  image:
+    name: index.docker.io/user/crane:latest
+  stage: push_container_image
+  script:
+  - date
+  - crane validate --remote quay.io/wagoodman/dive:0.10.0
+  - crane copy quay.io/wagoodman/dive:0.10.0 index.docker.io/user/dive:latest

tests/unit/test_addons_container_crane.py

@@ -0,0 +1,40 @@
+from gcip import Pipeline
+from tests import conftest
+from gcip.core.image import Image
+from gcip.addons.container.jobs import crane
+from gcip.addons.container.config import DockerClientConfig
+
+
+def test_default_crane_job():
+    pipeline = Pipeline()
+
+    pipeline.add_children(
+        crane.copy("index.docker.io/alpine:3", "index.docker.io/user/alpine:3"),
+        name="default",
+    )
+    pipeline.add_children(
+        crane.copy(
+            "quay.io/wagoodman/dive:0.10.0",
+            "index.docker.io/user/dive:latest",
+            crane_image=Image("index.docker.io/user/crane:latest"),
+        ),
+        name="custom_image",
+    )
+    conftest.check(pipeline.render())
+
+
+def test_advanced_crane_job():
+    dcc = DockerClientConfig()
+    dcc.add_auth(registry="index.docker.io")
+    dcc.add_cred_helper("0132456789.dkr.eu-central-1.amazonaws.com", "ecr-login")
+
+    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,
+        ),
+        name="with_authentication",
+    )
+    conftest.check(pipeline.render())