Test fixes

Author: MaciejKaras

scripts/release/build/build_info.py

@@ -2,7 +2,7 @@
 from typing import Dict
 
 from scripts.release.build.build_scenario import BuildScenario
-from scripts.release.constants import DEFAULT_REPOSITORY_PATH
+from scripts.release.constants import DEFAULT_REPOSITORY_PATH, DEFAULT_CHANGELOG_PATH, RELEASE_INITIAL_VERSION_ENV_VAR
 
 
 class ImageInfo(dict):
@@ -61,8 +61,23 @@ def to_json(self):
         }
 
 
-def load_build_info(scenario: BuildScenario, repository_path: str = DEFAULT_REPOSITORY_PATH) -> BuildInfo:
-    version = scenario.get_version(repository_path)
+def load_build_info(scenario: BuildScenario,
+                    repository_path: str = DEFAULT_REPOSITORY_PATH,
+                    changelog_sub_path: str = DEFAULT_CHANGELOG_PATH,
+                    initial_commit_sha: str = None,
+                    initial_version: str = None) -> BuildInfo:
+    f"""
+    Load build information based on the specified scenario.
+
+    :param scenario: BuildScenario enum value indicating the build scenario (e.g., PATCH, STAGING, RELEASE).
+    :param repository_path: Path to the Git repository. Default is the current directory `{DEFAULT_REPOSITORY_PATH}`.
+    :param changelog_sub_path: Path to the changelog directory relative to the repository root. Default is '{DEFAULT_CHANGELOG_PATH}'.
+    :param initial_commit_sha: SHA of the initial commit to start from if no previous version tag is found. If not provided, it will be determined based on `{RELEASE_INITIAL_VERSION_ENV_VAR} environment variable.
+    :param initial_version: Initial version to use if no previous version tag is found. If not provided, it will be determined based on `{RELEASE_INITIAL_VERSION_ENV_VAR}` environment variable.
+    :return: BuildInfo object containing images, binaries, and helm charts information for specified scenario.
+    """
+
+    version = scenario.get_version(repository_path, changelog_sub_path, initial_commit_sha, initial_version)
 
     with open("build_info.json", "r") as f:
         build_info = json.load(f)

scripts/release/build/build_scenario.py

@@ -1,9 +1,8 @@
 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
@@ -14,20 +13,19 @@ class BuildScenario(StrEnum):
     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:
+    def get_version(self, repository_path: str, changelog_sub_path: str, initial_commit_sha: str = None,
+                    initial_version: str = None) -> str:
+        repo = Repo(repository_path)
+
         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)
+                return calculate_next_version(repo, changelog_sub_path, initial_commit_sha, initial_version)
 
         raise ValueError(f"Unknown build scenario: {self}")

scripts/release/build/build_scenario_test.py

@@ -3,6 +3,7 @@
 from git import Repo
 
 from scripts.release.build.build_scenario import BuildScenario
+from scripts.release.constants import DEFAULT_CHANGELOG_PATH
 
 
 class TestGetVersionForBuildScenario:
@@ -11,7 +12,8 @@ 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)
+        version = BuildScenario.PATCH.get_version(repository_path=git_repo.working_dir,
+                                                  changelog_sub_path=DEFAULT_CHANGELOG_PATH)
 
         assert version == expected_version
 
@@ -20,13 +22,15 @@ def test_staging_build_scenario(self, git_repo: Repo):
         git_repo.git.checkout(initial_commit)
         expected_version = initial_commit.hexsha[:8]
 
-        version = BuildScenario.STAGING.get_version(repository_path=git_repo.working_dir)
+        version = BuildScenario.STAGING.get_version(repository_path=git_repo.working_dir,
+                                                    changelog_sub_path=DEFAULT_CHANGELOG_PATH)
 
         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)
+        version = BuildScenario.RELEASE.get_version(repository_path=git_repo.working_dir,
+                                                    changelog_sub_path=DEFAULT_CHANGELOG_PATH)
 
         assert version == "1.2.0"

scripts/release/release_info.py

@@ -4,11 +4,23 @@
 
 from scripts.release.build.build_info import load_build_info
 from scripts.release.build.build_scenario import BuildScenario
-from scripts.release.constants import DEFAULT_REPOSITORY_PATH
+from scripts.release.constants import (
+    DEFAULT_CHANGELOG_PATH,
+    DEFAULT_RELEASE_INITIAL_VERSION,
+    DEFAULT_REPOSITORY_PATH,
+)
 
 
-def create_release_info_json(repository_path: str) -> str:
-    build_info = load_build_info(BuildScenario.RELEASE, repository_path)
+def create_release_info_json(
+    repository_path: str, changelog_sub_path: str, initial_commit_sha: str = None, initial_version: str = None
+) -> str:
+    build_info = load_build_info(
+        scenario=BuildScenario.RELEASE,
+        repository_path=repository_path,
+        changelog_sub_path=changelog_sub_path,
+        initial_commit_sha=initial_commit_sha,
+        initial_version=initial_version,
+    )
 
     return json.dumps(build_info.to_json(), indent=2)
 
@@ -27,6 +39,32 @@ def create_release_info_json(repository_path: str) -> str:
         type=pathlib.Path,
         help="Path to the Git repository. Default is the current directory '.'",
     )
+    parser.add_argument(
+        "-c",
+        "--changelog-path",
+        default=DEFAULT_CHANGELOG_PATH,
+        metavar="",
+        action="store",
+        type=str,
+        help=f"Path to the changelog directory relative to a current working directory. Default is '{DEFAULT_CHANGELOG_PATH}'",
+    )
+    parser.add_argument(
+        "-s",
+        "--initial-commit-sha",
+        metavar="",
+        action="store",
+        type=str,
+        help="SHA of the initial commit to start from if no previous version tag is found.",
+    )
+    parser.add_argument(
+        "-v",
+        "--initial-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_RELEASE_INITIAL_VERSION}'",
+    )
     parser.add_argument(
         "--output",
         "-o",
@@ -36,7 +74,9 @@ def create_release_info_json(repository_path: str) -> str:
     )
     args = parser.parse_args()
 
-    release_info = create_release_info_json(args.path)
+    release_info = create_release_info_json(
+        args.path, args.changelog_path, args.initial_commit_sha, args.initial_version
+    )
 
     if args.output is not None:
         with open(args.output, "w") as file:

scripts/release/release_info_test.py

@@ -2,6 +2,7 @@
 
 from git import Repo
 
+from scripts.release.constants import DEFAULT_CHANGELOG_PATH
 from scripts.release.release_info import create_release_info_json
 
 
@@ -57,6 +58,8 @@ def test_create_release_info_json(
         "helm-charts": {"mongodb-kubernetes": {"repository": "quay.io/mongodb/helm-charts", "version": "1.0.0"}},
     }
     expected_release_info_json = json.dumps(expected_json, indent=2)
-    release_info_json = create_release_info_json(git_repo.working_dir)
+    release_info_json = create_release_info_json(
+        repository_path=git_repo.working_dir, changelog_sub_path=DEFAULT_CHANGELOG_PATH
+    )
 
     assert release_info_json == expected_release_info_json