github can have multiple commits, so get diff with branch instead (#66)

* github can have multiple commit, so get diff with branch instead

* updates based on review comments

Author: dbasunag

apps/polarion/README.md

@@ -9,7 +9,7 @@ This script uses [pylero](https://github.com/RedHatQE/pylero) and expects .pyler
 ## Usage
 ```bash
 pyutils-polarion-verify-tc-requirements --help
-pyutils-polarion-verify-tc-requirements --project_id <project_id>
+pyutils-polarion-verify-tc-requirements --project_id <project_id> --branch <remote_branch_to_compare_to>
 ```
 
 ## Config file
@@ -20,13 +20,47 @@ To specify polation project id for polarion scripts, it can be added to the conf
 ### Example:
 
 ```yaml
-pyutils-polarion-verify-tc-requirements :
+pyutils-polarion-verify-tc-requirements:
   project_id: "<project_id>"
+  branch: "<remote_branch_to_compare_to>"
 ```
-This would run the polarion requirement check against Polarion project <project_id>
+This would run the polarion requirement check against Polarion project <project_id> and remote branch <remote_branch_to_compare_to>
 
-To run from CLI with `--project-id`
+To run from CLI with `--project-id` and `--branch`
 
 ```bash
-pyutils-polarion-verify-tc-requirements  --project-id 'my_project_id'
+pyutils-polarion-verify-tc-requirements  --project-id 'my_project_id' --branch "origin/main"
+```
+
+
+## pyutils-polarion-set-automated
+Utility to mark newly added test cases in a pytest repository as approved automatically.
+
+## Requirements
+This script uses [pylero](https://github.com/RedHatQE/pylero) and expects .pylero config file to be present in current directory or user's home directory.
+
+## Usage
+```bash
+pyutils-polarion-set-automated --help
+pyutils-polarion-set-automated --project_id <project_id> --branch <remote_branch_to_compare_to>
+```
+
+## Config file
+To specify polation project id for polarion scripts, it can be added to the config file:
+`~/.config/python-utility-scripts/config.yaml`
+
+
+### Example:
+
+```yaml
+pyutils-polarion-set-automated:
+  project_id: "<project_id>"
+  branch: "<remote_branch_to_compare_to>"
+```
+This would run the polarion requirement check against Polarion project <project_id> and remote branch <remote_branch_to_compare_to>
+
+To run from CLI with `--project-id` and `--branch`
+
+```bash
+pyutils-polarion-set-automated  --project-id 'my_project_id' --branch "origin/main"
 ```

apps/polarion/polarion_set_automated.py

@@ -20,12 +20,14 @@ def approve_tests(polarion_project_id: str, added_ids: List[str]) -> Dict[str, L
     )
 
 
-def remove_approved_tests(polarion_project_id: str, added_ids: Optional[List[str]] = None) -> Dict[str, List[str]]:
+def remove_approved_tests(
+    polarion_project_id: str, branch: str, added_ids: Optional[List[str]] = None
+) -> Dict[str, List[str]]:
     removed_polarions = {}
     added_ids = added_ids or []
-    if removed_ids := set(find_polarion_ids(polarion_project_id=polarion_project_id, string_to_match="removed")) - set(
-        added_ids
-    ):
+    if removed_ids := set(
+        find_polarion_ids(polarion_project_id=polarion_project_id, string_to_match="removed", branch=branch)
+    ) - set(added_ids):
         LOGGER.info(f"Following polarion ids were removed: {removed_ids}")
         removed_polarions = update_polarion_ids(
             polarion_ids=list(removed_ids), project_id=polarion_project_id, is_automated=False
@@ -42,8 +44,9 @@ def remove_approved_tests(polarion_project_id: str, added_ids: Optional[List[str
     default=os.path.expanduser("~/.config/python-utility-scripts/config.yaml"),
 )
 @click.option("--project-id", "-p", help="Provide the polarion project id")
+@click.option("--branch", "-b", help="Provide the github remote branch to run against", default="origin/main")
 @click.option("--verbose", default=False, is_flag=True)
-def polarion_approve_automate(config_file_path: str, project_id: str, verbose: bool) -> None:
+def polarion_approve_automate(config_file_path: str, project_id: str, branch: str, verbose: bool) -> None:
     if verbose:
         LOGGER.setLevel(logging.INFO)
     else:
@@ -52,11 +55,13 @@ def polarion_approve_automate(config_file_path: str, project_id: str, verbose: b
         config_file_path=config_file_path, util_name="pyutils-polarion-set-automated"
     )
     added_polarions = {}
-    if added_ids := find_polarion_ids(polarion_project_id=polarion_project_id, string_to_match="added"):
+    if added_ids := find_polarion_ids(polarion_project_id=polarion_project_id, string_to_match="added", branch=branch):
         added_polarions = approve_tests(polarion_project_id=polarion_project_id, added_ids=added_ids)
         LOGGER.info(f"Following polarion ids were marked automated and approved: {added_polarions.get('updated')}")
 
-    removed_polarions = remove_approved_tests(polarion_project_id=polarion_project_id, added_ids=added_ids)
+    removed_polarions = remove_approved_tests(
+        polarion_project_id=polarion_project_id, added_ids=added_ids, branch=branch
+    )
     if removed_polarions.get("failed") or added_polarions.get("failed"):
         error = "Following polarion ids updates failed."
         if removed_polarions.get("failed"):

apps/polarion/polarion_utils.py

@@ -15,14 +15,14 @@
 APPROVED = "approved"
 
 
-def git_diff() -> str:
-    data = subprocess.check_output(shlex.split("git diff HEAD^-1"))
+def git_diff(branch: str) -> str:
+    data = subprocess.check_output(shlex.split(f"git diff {branch} HEAD"))
     return data.decode()
 
 
-def git_diff_lines() -> Dict[str, List[str]]:
+def git_diff_lines(branch: str) -> Dict[str, List[str]]:
     diff: Dict[str, List[str]] = {}
-    for line in git_diff().splitlines():
+    for line in git_diff(branch=branch).splitlines():
         LOGGER.info(line)
         if line.startswith("+"):
             diff.setdefault("added", []).append(line)
@@ -58,10 +58,10 @@ def validate_polarion_requirements(
     return tests_with_missing_requirements
 
 
-def find_polarion_ids(polarion_project_id: str, string_to_match: str) -> List[str]:
+def find_polarion_ids(polarion_project_id: str, string_to_match: str, branch: str) -> List[str]:
     return re.findall(
         rf"pytest.mark.polarion.*({polarion_project_id}-[0-9]+)",
-        "\n".join(git_diff_lines().get(string_to_match, [])),
+        "\n".join(git_diff_lines(branch=branch).get(string_to_match, [])),
         re.MULTILINE | re.IGNORECASE,
     )
 

apps/polarion/polarion_verify_tc_requirements.py

@@ -17,16 +17,17 @@
     default=os.path.expanduser("~/.config/python-utility-scripts/config.yaml"),
 )
 @click.option("--project-id", "-p", help="Provide the polarion project id")
+@click.option("--branch", "-b", help="Provide the github remote branch to run against", default="origin/main")
 @click.option("--verbose", default=False, is_flag=True)
-def has_verify(config_file_path: str, project_id: str, verbose: bool) -> None:
+def has_verify(config_file_path: str, project_id: str, branch: str, verbose: bool) -> None:
     if verbose:
         LOGGER.setLevel(logging.INFO)
     else:
         logging.disable(logging.ERROR)
     polarion_project_id = project_id or get_polarion_project_id(
         config_file_path=config_file_path, util_name="pyutils-polarion-verify-tc-requirements"
     )
-    if added_ids := find_polarion_ids(polarion_project_id=polarion_project_id, string_to_match="added"):
+    if added_ids := find_polarion_ids(polarion_project_id=polarion_project_id, string_to_match="added", branch=branch):
         LOGGER.info(f"Checking following ids: {added_ids}")
         if tests_with_missing_requirements := validate_polarion_requirements(
             polarion_test_ids=added_ids,

config.example.yaml

@@ -5,5 +5,7 @@ pyutils-unusedcode:
   - "my_exclude_function_prefix"
 pyutils-polarion-verify-tc-requirements:
   project_id: "ABCDEF"
+  branch: "origin/main"
 pyutils-polarion-set-automated:
   project_id: "ABCDEF"
+  branch: "origin/main"