Merge pull request openSUSE#1974 from dmach/git-scm-store-check-parent-project-branch

Check that the git package has the same branch as the parent project

Author: dmach

osc/git_scm/store.py

@@ -2,9 +2,10 @@
 import fnmatch
 import json
 import os
-from pathlib import Path
+import sys
 import typing
 import urllib.parse
+from pathlib import Path
 from typing import Dict
 from typing import List
 from typing import Optional
@@ -88,6 +89,8 @@ class LocalGitStore:
     It is not supposed to be used directly, it's a base class for GitStore that adds logic for resolving the values from multiple places.
     """
 
+    _BRANCH_MISMATCH_WARNING_PRINTED = set()
+
     @classmethod
     def is_project_dir(cls, path):
         try:
@@ -289,6 +292,23 @@ def assert_is_package(self):
             msg = f"Directory '{self.abspath}' is not a Git SCM working copy of a package"
             raise oscerr.NoWorkingCopy(msg)
 
+        if self.project_store and hasattr(self.project_store, "_git") and self.project_store._git.current_branch != self._git.current_branch:
+            key = (self.project_store._git.current_branch, self._git.current_branch)
+            if key not in self.__class__._BRANCH_MISMATCH_WARNING_PRINTED:
+                from osc.output import tty
+
+                # print the warning only once and store the information in the class
+                self.__class__._BRANCH_MISMATCH_WARNING_PRINTED.add(key)
+                msg = (
+                    f"{tty.colorize('WARNING', 'yellow,bold')}: "
+                    "Git SCM package working copy is switched to a different branch than it's corresponding parent project\n"
+                    f" - Package branch: {self._git.current_branch}\n"
+                    f" - Project branch: {self.project_store._git.current_branch}\n"
+                    f" - Package path: {self.topdir}\n"
+                    f" - Project path: {self.project_store.topdir}"
+                )
+                print(msg, file=sys.stderr)
+
         missing = []
         for name in ["apiurl", "project", "package"]:
             if not getattr(self, name):

tests/test_git_scm_store.py

@@ -97,7 +97,7 @@ def tearDown(self):
         except OSError:
             pass
 
-    def _git_init(self, path, *, separate_git_dir=None):
+    def _git_init(self, path, *, branch="factory", separate_git_dir=None):
         os.makedirs(path, exist_ok=True)
         git_init_cmd = ["git", "init", "-q"]
         if separate_git_dir:
@@ -106,7 +106,7 @@ def _git_init(self, path, *, separate_git_dir=None):
         subprocess.check_output(["git", "config", "user.email", "[email protected]"], cwd=path)
         subprocess.check_output(["git", "config", "user.name", "User Name"], cwd=path)
         subprocess.check_output(["git", "commit", "-m", "empty", "--allow-empty"], cwd=path)
-        subprocess.check_output(["git", "checkout", "-b", "factory", "-q"], cwd=path)
+        subprocess.check_output(["git", "checkout", "-b", branch, "-q"], cwd=path)
         subprocess.check_output(["git", "remote", "add", "origin", "https://example.com/packages/my-package.git"], cwd=path)
 
     def _setup_project(self, path, *, apiurl="https://api.example.com", project=None):
@@ -350,6 +350,24 @@ def test_pkg_git_in_submodule(self):
         self.assertEqual(store.project, "PROJ")
         self.assertEqual(store.package, "pkg")
 
+    def test_project_with_different_branch(self):
+        prj_path = os.path.join(self.tmpdir, "project")
+        self._git_init(prj_path, branch="project-foo")
+        manifest_data = {
+            "obs_apiurl": "https://api.example.com",
+            "obs_project": "PROJ",
+        }
+
+        self._write(os.path.join(prj_path, "_manifest"), osc_yaml.yaml_dumps(manifest_data))
+
+        pkg_path = os.path.join(prj_path, "package")
+        self._git_init(pkg_path, branch="project-bar")
+
+        stderr = io.StringIO()
+        with contextlib.redirect_stderr(stderr):
+            GitStore(pkg_path)
+        self.assertIn("WARNING", stderr.getvalue())
+
 
 if __name__ == "__main__":
     unittest.main()