refactor of the code

Author: MaciejKaras

scripts/release/build/build_info.py

@@ -2,6 +2,7 @@
 from typing import Dict
 
 from scripts.release.build.build_scenario import BuildScenario
+from scripts.release.constants import DEFAULT_REPOSITORY_PATH
 
 
 class ImageInfo(dict):
@@ -60,7 +61,9 @@ def to_json(self):
         }
 
 
-def load_build_info(scenario: BuildScenario, version: str) -> BuildInfo:
+def load_build_info(scenario: BuildScenario, repository_path: str = DEFAULT_REPOSITORY_PATH) -> BuildInfo:
+    version = scenario.get_version(repository_path)
+
     with open("build_info.json", "r") as f:
         build_info = json.load(f)
 

scripts/release/build/build_info_test.py

@@ -1,15 +1,19 @@
+import os
+
 from scripts.release.build.build_info import (
     BinaryInfo,
     BuildInfo,
     HelmChartInfo,
     ImageInfo,
     load_build_info,
 )
-from scripts.release.version import BuildScenario
+from git import Repo
+from scripts.release.build.build_scenario import BuildScenario
 
 
-def test_load_build_info_patch():
+def test_load_build_info_patch(git_repo: Repo):
     build_id = "688364423f9b6c00072b3556"
+    os.environ["BUILD_ID"] = build_id
 
     expected_build_info = BuildInfo(
         images={
@@ -64,74 +68,78 @@ def test_load_build_info_patch():
         },
     )
 
-    build_info = load_build_info(BuildScenario.PATCH, build_id)
+    build_info = load_build_info(BuildScenario.PATCH, git_repo.working_dir)
 
     assert build_info.__dict__() == expected_build_info.__dict__()
 
 
-def test_load_build_info_staging():
-    commit_sha = "05029e97"
+def test_load_build_info_staging(git_repo: Repo):
+    initial_commit = list(git_repo.iter_commits(reverse=True))[4]
+    git_repo.git.checkout(initial_commit)
+    expecter_commit_sha = initial_commit.hexsha[:8]
 
     expected_build_info = BuildInfo(
         images={
             "mongodbOperator": ImageInfo(
                 repository="quay.io/mongodb/mongodb-kubernetes-stg",
                 platforms=["linux/arm64", "linux/amd64"],
-                version=commit_sha,
+                version=expecter_commit_sha,
             ),
             "initDatabase": ImageInfo(
                 repository="quay.io/mongodb/mongodb-kubernetes-init-database-stg",
                 platforms=["linux/arm64", "linux/amd64"],
-                version=commit_sha,
+                version=expecter_commit_sha,
             ),
             "initAppDb": ImageInfo(
                 repository="quay.io/mongodb/mongodb-kubernetes-init-appdb-stg",
                 platforms=["linux/arm64", "linux/amd64"],
-                version=commit_sha,
+                version=expecter_commit_sha,
             ),
             "initOpsManager": ImageInfo(
                 repository="quay.io/mongodb/mongodb-kubernetes-init-ops-manager-stg",
                 platforms=["linux/arm64", "linux/amd64"],
-                version=commit_sha,
+                version=expecter_commit_sha,
             ),
             "database": ImageInfo(
                 repository="quay.io/mongodb/mongodb-kubernetes-database-stg",
                 platforms=["linux/arm64", "linux/amd64"],
-                version=commit_sha,
+                version=expecter_commit_sha,
             ),
             "readinessprobe": ImageInfo(
                 repository="quay.io/mongodb/mongodb-kubernetes-readinessprobe-stg",
                 platforms=["linux/arm64", "linux/amd64"],
-                version=commit_sha,
+                version=expecter_commit_sha,
             ),
             "operator-version-upgrade-post-start-hook": ImageInfo(
                 repository="quay.io/mongodb/mongodb-kubernetes-operator-version-upgrade-post-start-hook-stg",
                 platforms=["linux/arm64", "linux/amd64"],
-                version=commit_sha,
+                version=expecter_commit_sha,
             ),
         },
         binaries={
             "kubectl-mongodb": BinaryInfo(
                 s3_store="s3://kubectl-mongodb/staging",
                 platforms=["darwin/amd64", "darwin/arm64", "linux/amd64", "linux/arm64"],
-                version=commit_sha,
+                version=expecter_commit_sha,
             )
         },
         helm_charts={
             "mongodb-kubernetes": HelmChartInfo(
                 repository="quay.io/mongodb/helm-charts-stg",
-                version=commit_sha,
+                version=expecter_commit_sha,
             )
         },
     )
 
-    build_info = load_build_info(BuildScenario.STAGING, commit_sha)
+    build_info = load_build_info(BuildScenario.STAGING, git_repo.working_dir)
 
     assert build_info.__dict__() == expected_build_info.__dict__()
 
 
-def test_load_build_info_release(readinessprobe_version, operator_version_upgrade_post_start_hook_version):
-    version = "1.2.3"
+def test_load_build_info_release(git_repo: Repo, readinessprobe_version: str,
+                                 operator_version_upgrade_post_start_hook_version: str):
+    version = "1.2.0"
+    git_repo.git.checkout(version)
 
     expected_build_info = BuildInfo(
         images={
@@ -175,7 +183,7 @@ def test_load_build_info_release(readinessprobe_version, operator_version_upgrad
             "kubectl-mongodb": BinaryInfo(
                 s3_store="s3://kubectl-mongodb/prod",
                 platforms=["darwin/amd64", "darwin/arm64", "linux/amd64", "linux/arm64"],
-                version="1.2.3",
+                version=version,
             )
         },
         helm_charts={
@@ -186,6 +194,6 @@ def test_load_build_info_release(readinessprobe_version, operator_version_upgrad
         },
     )
 
-    build_info = load_build_info(BuildScenario.RELEASE, version)
+    build_info = load_build_info(BuildScenario.RELEASE, git_repo.working_dir)
 
     assert build_info.__dict__() == expected_build_info.__dict__()

scripts/release/build/build_scenario.py

@@ -1,7 +1,33 @@
+import os
 from enum import StrEnum
+from git import Repo
+
+from scripts.release.constants import get_initial_commit_sha, get_initial_version, DEFAULT_CHANGELOG_PATH, \
+    DEFAULT_REPOSITORY_PATH
+from scripts.release.version import calculate_next_version
+
+COMMIT_SHA_LENGTH = 8
 
 
 class BuildScenario(StrEnum):
     RELEASE = "release"  # Official release triggered by a git tag
     PATCH = "patch"  # CI build for a patch/pull request
     STAGING = "staging"  # CI build from a merge to the master
+
+    def get_version(self, repository_path: str) -> str:
+        match self:
+            case BuildScenario.PATCH:
+                build_id = os.environ["BUILD_ID"]
+                if not build_id:
+                    raise ValueError(f"BUILD_ID environment variable is not set for `{self}` build scenario")
+                return build_id
+            case BuildScenario.STAGING:
+                repo = Repo(repository_path)
+                return repo.head.object.hexsha[:COMMIT_SHA_LENGTH]
+            case BuildScenario.RELEASE:
+                repo = Repo(repository_path)
+                initial_commit_sha = get_initial_commit_sha()
+                initial_version = get_initial_version()
+                return calculate_next_version(repo, DEFAULT_CHANGELOG_PATH, initial_commit_sha, initial_version)
+
+        raise ValueError(f"Unknown build scenario: {self}")

scripts/release/build/build_scenario_test.py

@@ -0,0 +1,32 @@
+import os
+
+from git import Repo
+
+from scripts.release.build.build_scenario import BuildScenario
+
+
+class TestGetVersionForBuildScenario:
+
+    def test_patch_build_scenario(self, git_repo: Repo):
+        os.environ["BUILD_ID"] = "688364423f9b6c00072b3556"
+        expected_version = os.environ["BUILD_ID"]
+
+        version = BuildScenario.PATCH.get_version(repository_path=git_repo.working_dir)
+
+        assert version == expected_version
+
+    def test_staging_build_scenario(self, git_repo: Repo):
+        initial_commit = list(git_repo.iter_commits(reverse=True))[4]
+        git_repo.git.checkout(initial_commit)
+        expected_version = initial_commit.hexsha[:8]
+
+        version = BuildScenario.STAGING.get_version(repository_path=git_repo.working_dir)
+
+        assert version == expected_version
+
+    def test_release_build_scenario(self, git_repo: Repo):
+        git_repo.git.checkout("1.2.0")
+
+        version = BuildScenario.RELEASE.get_version(repository_path=git_repo.working_dir)
+
+        assert version == "1.2.0"

scripts/release/build/conftest.py

@@ -9,9 +9,9 @@ def get_manually_upgradable_versions() -> Dict[str, str]:
         build_info = json.load(f)
 
     return {
-        "readinessprobe": build_info["images"]["readinessprobe"]["prod"]["version"],
+        "readinessprobe": build_info["images"]["readinessprobe"]["release"]["version"],
         "operator_version_upgrade_post_start_hook": build_info["images"]["operator-version-upgrade-post-start-hook"][
-            "prod"
+            "release"
         ]["version"],
     }
 

scripts/release/calculate_next_version.py

@@ -3,9 +3,10 @@
 
 from git import Repo
 
-from scripts.release.changelog import (
+from scripts.release.constants import (
     DEFAULT_CHANGELOG_PATH,
-    DEFAULT_INITIAL_GIT_TAG_VERSION,
+    DEFAULT_RELEASE_INITIAL_VERSION,
+    DEFAULT_REPOSITORY_PATH,
 )
 from scripts.release.version import calculate_next_version
 
@@ -17,7 +18,7 @@
     parser.add_argument(
         "-p",
         "--path",
-        default=".",
+        default=DEFAULT_REPOSITORY_PATH,
         metavar="",
         action="store",
         type=pathlib.Path,
@@ -43,11 +44,11 @@
     parser.add_argument(
         "-v",
         "--initial-version",
-        default=DEFAULT_INITIAL_GIT_TAG_VERSION,
+        default=DEFAULT_RELEASE_INITIAL_VERSION,
         metavar="",
         action="store",
         type=str,
-        help=f"Version to use if no previous version tag is found. Default is '{DEFAULT_INITIAL_GIT_TAG_VERSION}'",
+        help=f"Version to use if no previous version tag is found. Default is '{DEFAULT_RELEASE_INITIAL_VERSION}'",
     )
     args = parser.parse_args()
 

scripts/release/changelog.py

@@ -6,8 +6,6 @@
 import frontmatter
 from git import Commit, Repo
 
-DEFAULT_CHANGELOG_PATH = "changelog/"
-DEFAULT_INITIAL_GIT_TAG_VERSION = "1.0.0"
 FILENAME_DATE_FORMAT = "%Y%m%d"
 FRONTMATTER_DATE_FORMAT = "%Y-%m-%d"
 MAX_TITLE_LENGTH = 50

scripts/release/check_changelog.py

@@ -3,7 +3,8 @@
 
 from git import Repo
 
-from scripts.release.changelog import DEFAULT_CHANGELOG_PATH, get_changelog_entries
+from scripts.release.changelog import get_changelog_entries
+from scripts.release.constants import DEFAULT_CHANGELOG_PATH, DEFAULT_REPOSITORY_PATH
 
 
 def str2bool(v):
@@ -25,7 +26,7 @@ def str2bool(v):
     parser.add_argument(
         "-p",
         "--path",
-        default=".",
+        default=DEFAULT_REPOSITORY_PATH,
         metavar="",
         action="store",
         type=pathlib.Path,

scripts/release/conftest.py

@@ -5,7 +5,7 @@
 from _pytest.fixtures import fixture
 from git import Repo
 
-from scripts.release.changelog import DEFAULT_CHANGELOG_PATH
+from scripts.release.constants import DEFAULT_CHANGELOG_PATH
 
 
 @fixture(scope="session")

scripts/release/constants.py

@@ -0,0 +1,17 @@
+import os
+
+RELEASE_INITIAL_VERSION_ENV_VAR = "RELEASE_INITIAL_VERSION"
+RELEASE_INITIAL_COMMIT_SHA_ENV_VAR = "RELEASE_INITIAL_COMMIT_SHA"
+
+DEFAULT_RELEASE_INITIAL_VERSION = "1.0.0"
+DEFAULT_RELEASE_INITIAL_COMMIT_SHA = "9ed5f98fc70c5b3442f633d2393265fb8a2aba0c"
+DEFAULT_CHANGELOG_PATH = "changelog/"
+DEFAULT_REPOSITORY_PATH = "."
+
+
+def get_initial_version() -> str:
+    return os.getenv(RELEASE_INITIAL_VERSION_ENV_VAR, DEFAULT_RELEASE_INITIAL_VERSION)
+
+
+def get_initial_commit_sha() -> str:
+    return os.getenv(RELEASE_INITIAL_COMMIT_SHA_ENV_VAR, DEFAULT_RELEASE_INITIAL_COMMIT_SHA)