Added new staticmethod to Registry.

Author: bitfoo1

CHANGELOG.md

@@ -24,6 +24,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Added documentation to the `gcip.core.variables` module.
 * 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.
 
 ### Changed
 * Normalize config_file_path in `gcip.addons.container.config.DockerClientConfig`

gcip/addons/aws/helper.py

@@ -2,8 +2,7 @@
 
 import boto3
 
-session = boto3.Session()
-sts = session.client("sts")
+sts = boto3.Session().client("sts")
 
 
 def aws_account_id() -> str:
@@ -20,8 +19,7 @@ def aws_account_id() -> str:
     if os.environ.get("AWS_ACCOUNT_ID"):
         return os.environ["AWS_ACCOUNT_ID"]
 
-    sts_response = sts.get_caller_identity()
-    return sts_response["Account"]
+    return sts.get_caller_identity()["Account"]
 
 
 def aws_region() -> str:

gcip/addons/container/registries.py

@@ -6,6 +6,13 @@
 __maintainer__ = "Daniel von Eßen"
 __email__ = "daniel.von-essen@deutschebahn.com"
 
+from typing import Optional
+
+from gcip.addons.aws.helper import (
+    aws_region,
+    aws_account_id,
+)
+
 
 class Registry:
     """
@@ -15,3 +22,29 @@ class Registry:
     DOCKER: str = "index.docker.io"
     QUAY: str = "quay.io"
     GCR: str = "gcr.io"
+
+    @staticmethod
+    def AWS(*, account_id: Optional[str] = None, region: Optional[str] = None) -> str:
+        """Amazon Elastic Container Registry (ECR).
+
+        If neither `account_id` nor `region` is given, method tries to evaluate `account_id` and `region`
+        with helper functions from `gcip.addons.aws.helper`. If one of the helper functions, do not
+        resolve to an appropriate value they will throw a `ValueError` or `KeyError` exception.
+
+        Args:
+            account_id (Optional[str]): AWS account id. Defaults internally to `gcip.addons.aws.helper.aws_account_id()`.
+            region (Optional[str]): AWS region where the ECR repository lives in. Defaults internally to `gcip.addons.aws.helper.aws_region`.
+
+        Raises:
+            ValueError: If no region was found in `gcip.addons.aws.helper.aws_region()`.
+            ValueError: If aws account id to resolvable from `gcip.addons.aws.helper.aws_account_id()`.
+
+        Returns:
+            str: Elastic Container Registry URL in format of **aws_account_id.dkr.ecr.region.amazonaws.com**
+        """
+        if not account_id:
+            account_id = aws_account_id()
+        if not region:
+            region = aws_region()
+
+        return f"{account_id}.dkr.ecr.{region}.amazonaws.com"

gcip/core/artifact.py

@@ -0,0 +1,105 @@
+# __author__ = "Thomas Steinbach"
+# __copyright__ = "Copyright 2020 DB Systel GmbH"
+# __credits__ = ["Daniel von Eßen"]
+# # SPDX-License-Identifier: Apache-2.0
+# __license__ = "Apache-2.0"
+# __maintainer__ = "Daniel von Eßen"
+# __email__ = "daniel.von-essen@deutschebahn.com"
+
+# from typing import Any, Dict, List, Optional
+
+# from gcip.core.rule import WhenStatement
+# from gcip.core.variables import PredefinedVariables
+
+
+# class Artifacts:
+#     def __init__(
+#         self,
+#         paths: List[str],
+#         *,
+#         excludes: List[str] = [],
+#         expire_in: Optional[str] = None,
+#         expose_as: Optional[str] = None,
+#         name: Optional[str] = None,
+#         public: Optional[bool] = None,
+#         untracked: Optional[bool] = None,
+#         when: Optional[WhenStatement] = None,
+#     ) -> None:
+#         self._expire_in = expire_in
+#         self._expose_as = expose_as
+#         self._name = name if name else f"{PredefinedVariables.CI_JOB_NAME}-{PredefinedVariables.CI_COMMIT_REF_SLUG}"
+#         self._public = public
+#         self._untracked = untracked
+#         self._when = when
+
+#         # Remove project path prefix from paths given.
+#         # Prepend ./ to path to clearify that cache paths
+#         # are relative to CI_PROJECT_DIR
+#         self._paths = [path if not path.startswith(PredefinedVariables.CI_PROJECT_DIR) else path[len(PredefinedVariables.CI_PROJECT_DIR) :] for path in paths]
+#         if len(excludes) > 0:
+#             self._excludes = [
+#                 exclude if not exclude.startswith(PredefinedVariables.CI_PROJECT_DIR) else exclude[len(PredefinedVariables.CI_PROJECT_DIR) :]
+#                 for exclude in excludes
+#             ]
+
+#     @property
+#     def paths(self):
+#         return self._paths
+
+#     @property
+#     def excludes(self):
+#         return self._excludes
+
+#     @property
+#     def expire_in(self):
+#         return self._expire_in
+
+#     @property
+#     def expose_as(self):
+#         return self._expose_as
+
+#     @property
+#     def name(self):
+#         return self._name
+
+#     @property
+#     def public(self):
+#         return self._public
+
+#     @property
+#     def untracked(self):
+#         return self._untracked
+
+#     @property
+#     def when(self):
+#         return self._when
+
+#     def render(self) -> Dict[str, Any]:
+#         """Return a representation of this Cache object as dictionary with static values.
+
+#         The rendered representation is used by the gcip to dump it
+#         in YAML format as part of the .gitlab-ci.yml pipeline.
+
+#         Returns:
+#             Dict[str, Any]: A dictionary prepresenting the cache object in Gitlab CI.
+#         """
+#         rendered: Dict[str, Union[str, bool, List[str], Union[str, Dict[str, Union[List[str], str]]]]]
+#         rendered = {
+#             "paths": self.paths,
+#             "name": self.name,
+#         }
+#         if self.excludes:
+#             rendered["excludes"] = self.excludes
+#         if self.expire_in:
+#             rendered["expire_in"] = self.expire_in
+#         if self.expose_as:
+#             rendered["expose_as"] = self.expose_as
+#         if self.expose_as:
+#             rendered["expose_as"] = self._policy.value
+#         if self.expose_as:
+#             rendered["expose_as"] = self._policy.value
+#         if self.expose_as:
+#             rendered["expose_as"] = self._policy.value
+#         rendered["key"] = self._cache_key.render()
+
+#         return rendered

tests/unit/test_addons_container_registries.py

@@ -9,7 +9,16 @@
         ("DOCKER", "https://index.docker.io/v1/"),
         ("GCR", "gcr.io"),
         ("QUAY", "quay.io"),
-    ]
+    ],
 )
 def test_registries(registry, expected_url):
     getattr(Registry, registry) == expected_url
+
+
+def test_aws_registry(mocker, monkeypatch):
+    monkeypatch.setenv("AWS_ACCOUNT_ID", "123456789012")
+    monkeypatch.setenv("AWS_DEFAULT_REGION", "eu-central-1")
+    mocker.patch("gcip.addons.aws.helper.aws_region", return_value="eu-central-1")
+    mocker.patch("gcip.addons.aws.helper.aws_account_id", return_value="123456789012")
+    aws_registry = Registry.AWS()
+    assert "123456789012.dkr.ecr.eu-central-1.amazonaws.com" == aws_registry