Added crane push job.

Author: bitfoo1

CHANGELOG.md

@@ -22,6 +22,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * 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.
+* Added `push` Job function to `gcip.addon.container.job.crane` to allow pushing local tarballs to remote registries.
 
 ### Changed
 

gcip/addons/container/jobs/crane.py

@@ -2,6 +2,7 @@
 
 from gcip.core.job import Job
 from gcip.core.image import Image
+from gcip.core.variables import PredefinedVariables
 from gcip.addons.container.config import DockerClientConfig
 from gcip.addons.container.images import PredefinedImages
 
@@ -47,3 +48,53 @@ def copy(
         job.prepend_scripts(*docker_client_config.get_shell_command())
 
     return job
+
+
+def push(
+    dst: str,
+    image_path: Optional[str] = None,
+    image_name: Optional[str] = None,
+    *,
+    docker_client_config: Optional[DockerClientConfig] = None,
+    crane_image: Optional[Union[Image, str]] = None,
+) -> Job:
+    """
+    Creates a job to push container image to remote container registry with `crane`.
+
+    The image to copy must be in a `tarball` format. It gets validated with crane
+    and is pushed to `dst` destination registry.
+
+    Args:
+        dst (str): Registry URL to copy container image to.
+        image_path (Optional[str], optional): Path where to find the container image.
+            If `None` it defaults internally to `PredefinedVariables.CI_PROJECT_DIR`. Defaults to None.
+        image_name (Optional[str], optional): Container image name, searched for in `image_path` and gets `.tar` appended.
+            If `None` it defaults internally to `PredefinedVariables.CI_PROJECT_NAME`. Defaults to None.
+        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 push a container image stored as a `tarball` to a remote registry.
+    """
+    if not crane_image:
+        crane_image = PredefinedImages.CRANE
+
+    if not image_path:
+        image_path = PredefinedVariables.CI_PROJECT_DIR
+    if not image_name:
+        image_name = PredefinedVariables.CI_PROJECT_NAME
+    job = Job(
+        script=[
+            f"crane validate --tarball {image_path}/{image_name}.tar",
+            f"crane push {image_path}/{image_name}.tar {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_push_job.yml

@@ -0,0 +1,13 @@
+stages:
+- push_container_image
+push-container-image-push-image:
+  image:
+    name: crane_image:v1.1.2
+  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'
+  - crane validate --tarball /path/to/project/crane.tar
+  - crane push /path/to/project/crane.tar index.docker.io

tests/unit/comparison_files/test_addons_container_crane_test_simple_crane_push_job.yml

@@ -0,0 +1,9 @@
+stages:
+- push_container_image
+push-container-image-push-image:
+  image:
+    name: gcr.io/go-containerregistry/crane:latest
+  stage: push_container_image
+  script:
+  - crane validate --tarball /path/to/project/gitlab-ci-project.tar
+  - crane push /path/to/project/gitlab-ci-project.tar index.docker.io

tests/unit/test_addons_container_crane.py

@@ -5,7 +5,7 @@
 from gcip.addons.container.config import DockerClientConfig
 
 
-def test_simple_crane_copy_job():
+def test_simple_crane_copy_job(gitlab_ci_environment_variables):
     pipeline = Pipeline()
 
     pipeline.add_children(
@@ -23,7 +23,7 @@ def test_simple_crane_copy_job():
     conftest.check(pipeline.render())
 
 
-def test_advanced_crane_copy_job():
+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")
@@ -38,3 +38,26 @@ def test_advanced_crane_copy_job():
         name="with_authentication",
     )
     conftest.check(pipeline.render())
+
+
+def test_simple_crane_push_job(gitlab_ci_environment_variables):
+    pipeline = Pipeline()
+    pipeline.add_children(crane.push(dst="index.docker.io"), name="push_image")
+    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")
+    pipeline = Pipeline()
+    pipeline.add_children(
+        crane.push(
+            dst="index.docker.io",
+            image_name="crane",
+            docker_client_config=dcc,
+            crane_image="crane_image:v1.1.2",
+        ),
+        name="push_image"
+    )
+    conftest.check(pipeline.render())