Use version_id instead of datetime

Author: SimonBaeumer

.evergreen-functions.yml

@@ -9,6 +9,7 @@ variables:
       - PKCS11_URI
       - branch_name
       - build_id
+      - build_tag_type
       - build_variant
       - distro
       - e2e_cloud_qa_apikey_owner_ubi_cloudqa
@@ -29,7 +30,6 @@ variables:
       - otel_collector_endpoint
       - otel_parent_id
       - otel_trace_id
-      - build_tag_type
       - registry
       - requester
       - skip_tags

.evergreen-periodic-builds.yaml

@@ -3,13 +3,6 @@ include:
   - filename: .evergreen-tasks.yml
 
 parameters:
-  # Deprecated: do not use pin_tag_at parameter, this was used to pin the image tag to a specific time,
-  # but resulted in overwritten image tags which causes quay to garbage collect
-  # untagged images. This caused a release image to be missing.
-  - key: pin_tag_at
-    value: 00:00
-    description: Pin tags at this time of the day. Midnight by default.
-
   - key: build_tag_type
     value: periodic
     description: The build type, this is added to the image tag. Used for periodic and release builds.

.evergreen.yml

@@ -180,13 +180,6 @@ parameters:
     value: "true"
     description: set this to false to suppress retries on failure
 
-  # Deprecated: do not use pin_tag_at parameter, this was used to pin the image tag to a specific time,
-  # but resulted in overwritten image tags which causes quay to garbage collect
-  # untagged images. This caused a release image to be missing.
-  - key: pin_tag_at
-    value: 10:00
-    description: Pin tags at this time of the day. Midnight by default for periodic and 10 for releases.
-
   - key: build_tag_type
     value: release
     description: The build type, this is added to the image tag. Used for periodic and release builds.

pipeline.py

@@ -199,72 +199,32 @@ def is_running_in_evg_pipeline():
 class MissingEnvironmentVariable(Exception):
     pass
 
-
-# Deprecated: do not use pin_tag_at parameter, this was used to pin the image tag to a specific time,
-# but resulted in overwritten image tags which causes quay to garbage collect
-# untagged images. This caused a release image to be missing.
-def should_pin_at() -> Optional[Tuple[str, str]]:
-    """Gets the value of the pin_tag_at to tag the images with.
-
-    Returns its value split on :.
-    """
-    # We need to return something so `partition` does not raise
-    # AttributeError
-    is_patch = is_running_in_patch()
-
-    try:
-        pinned = os.environ["pin_tag_at"]
-    except KeyError:
-        raise MissingEnvironmentVariable(f"pin_tag_at environment variable does not exist, but is required")
-    if is_patch:
-        if pinned == "00:00":
-            raise Exception("Pinning to midnight during a patch is not supported. Please pin to another date!")
-
-    hour, _, minute = pinned.partition(":")
-    return hour, minute
-
-
 def is_running_in_patch():
     is_patch = os.environ.get("is_patch")
     return is_patch is not None and is_patch.lower() == "true"
 
 
 def build_id() -> str:
-    """Returns the current UTC time in ISO8601 date format.
-
-    If running in Evergreen and `created_at` expansion is defined, use the
-    datetime defined in that variable instead.
-
-    It is possible to pin this time at midnight (00:00) for periodic builds. If
-    running a manual build, then the Evergreen `pin_tag_at` variable needs to be
-    set to the empty string, in which case, the image tag suffix will correspond
-    to the current timestamp.
-
+    """Returns the build id used for the image tag.
+       The build id is configurable `build_tag_type` and `version_id` in evergreen.
     """
 
+    build_tag_type = ""
     try:
         build_tag_type = os.environ["build_tag_type"]
     except KeyError:
         pass
 
-    date = datetime.now(timezone.utc)
+    version_id = ""
     try:
-        created_at = os.environ["created_at"]
-        date = datetime.strptime(created_at, "%y_%m_%d_%H_%M_%S")
+        version_id = os.environ["version_id"]
     except KeyError:
-        pass
+        raise MissingEnvironmentVariable("Missing environment variable `version_id`")
 
-    # Deprecated: do not use should_pin_at(). Use the suffix instead.
-    hour, minute = should_pin_at()
-    if hour and minute:
-        logger.info(f"we are pinning to, hour: {hour}, minute: {minute}")
-        date = date.replace(hour=int(hour), minute=int(minute), second=0)
+    if build_tag_type == "":
+        return version_id
     else:
-        logger.warning(f"hour and minute cannot be extracted from provided pin_tag_at env, pinning to now")
-
-    string_time = date.strftime("%Y%m%dT%H%M%SZ")
-
-    return f"{string_time}-{build_tag_type}"
+        return f"{version_id}-{build_tag_type}"
 
 
 def get_release() -> Dict:

pipeline_test.py

@@ -324,3 +324,18 @@ def test_create_and_push_manifest_push_error(mock_run):
 
     assert "Error pushing manifest" in str(exc_info.value)
     assert mock_run.call_count == 2  # Both create and push calls
+
+def test_build_id():
+    from pipeline import build_id
+
+    os.environ["version_id"] = "abcdefg"
+    os.environ["build_tag_type"] = "release"
+    id = build_id()
+
+    assert id == "abcdefg-release"
+
+    os.environ["version_id"] = "abcdefg"
+    os.environ["build_tag_type"] = ""
+    id = build_id()
+
+    assert id == "abcdefg"