base PR for set polarion as automated (#30)

* base PR for set polarion as automated

* updated based on reviews

* remove extra test

Author: dbasunag

apps/polarion/polarion_set_automated.py

@@ -0,0 +1,53 @@
+import logging
+import os
+from simple_logger.logger import get_logger
+
+import click
+
+from apps.polarion.polarion_utils import get_polarion_project_id, find_polarion_ids, update_polarion_ids
+
+LOGGER = get_logger(name=__name__)
+
+
+@click.command()
+@click.option(
+    "--config-file-path",
+    help="Provide absolute path to the config file. Any CLI option(s) would override YAML file",
+    type=click.Path(),
+    default=os.path.expanduser("~/.config/python-utility-scripts/config.yaml"),
+)
+@click.option("--project-id", "-p", help="Provide the polarion project id")
+@click.option("--verbosity", default=False, is_flag=True)
+def polarion_approve_automate(config_file_path, project_id, verbosity):
+    if verbosity:
+        LOGGER.setLevel(logging.DEBUG)
+    removed_polarions = {}
+    added_polarions = {}
+    polarion_project_id = get_polarion_project_id(
+        project_id=project_id, config_file_path=config_file_path, util_name="pyutils-polarion-set-automated"
+    )
+    added_ids = find_polarion_ids(polarion_project_id=polarion_project_id, string_to_match="added")
+    LOGGER.debug(f"Following polarion ids were added: {added_ids}")
+    if removed_ids := set(find_polarion_ids(polarion_project_id=polarion_project_id, string_to_match="removed")) - set(
+        added_ids
+    ):
+        LOGGER.debug(f"Following polarion ids were removed: {removed_ids}")
+        removed_polarions = update_polarion_ids(
+            polarion_ids=removed_ids, project_id=polarion_project_id, is_automated=False
+        )
+        LOGGER.error(f"Following polarion ids marked not automated: {removed_polarions.get('updated')}")
+
+    if added_polarions := update_polarion_ids(
+        polarion_ids=added_ids, project_id=polarion_project_id, is_automated=True, is_approved=True
+    ):
+        LOGGER.debug(f"Following polarion ids were marked automated and approved: {added_polarions.get('updated')}")
+    if removed_polarions.get("failed") or added_polarions.get("failed"):
+        LOGGER.error(
+            f"Following polarion ids updates failed. Removed ids: {removed_polarions.get('failed')}"
+            f"Added ids:: {added_polarions.get('failed')}"
+        )
+        raise click.Abort()
+
+
+if __name__ == "__main__":
+    polarion_approve_automate()

apps/polarion/polarion_utils.py

@@ -1,10 +1,16 @@
+import re
+
+import click
 from simple_logger.logger import get_logger
 import shlex
 import subprocess
-from pylero.exceptions import PyleroLibException
 
+from apps.utils import get_util_config
 
 LOGGER = get_logger(name=__name__)
+AUTOMATED = "automated"
+NOT_AUTOMATED = "notautomated"
+APPROVED = "approved"
 
 
 def git_diff():
@@ -19,31 +25,74 @@ def git_diff_lines():
         LOGGER.debug(line)
         if line.startswith("+"):
             diff.setdefault("added", []).append(line)
-
+        if line.startswith("-"):
+            diff.setdefault("removed", []).append(line)
     return diff
 
 
 def validate_polarion_requirements(
-    polarion_test_ids,
     polarion_project_id,
+    polarion_test_ids,
 ):
-    from pylero.work_item import TestCase, Requirement
-
     tests_with_missing_requirements = []
+    if polarion_test_ids:
+        from pylero.work_item import TestCase, Requirement
+        from pylero.exceptions import PyleroLibException
 
-    for _id in polarion_test_ids:
-        has_req = False
-        LOGGER.debug(f"Checking if {_id} verifies any requirement")
-        tc = TestCase(project_id=polarion_project_id, work_item_id=_id)
-        for link in tc.linked_work_items:
-            try:
-                Requirement(project_id=polarion_project_id, work_item_id=link.work_item_id)
-                has_req = True
-                break
-            except PyleroLibException:
-                continue
-
-        if not has_req:
-            LOGGER.error(f"{_id}: Is missing requirement")
-            tests_with_missing_requirements.append(_id)
+        for _id in polarion_test_ids:
+            has_req = False
+            LOGGER.debug(f"Checking if {_id} verifies any requirement")
+            tc = TestCase(project_id=polarion_project_id, work_item_id=_id)
+            for link in tc.linked_work_items:
+                try:
+                    Requirement(project_id=polarion_project_id, work_item_id=link.work_item_id)
+                    has_req = True
+                    break
+                except PyleroLibException:
+                    continue
+
+            if not has_req:
+                LOGGER.error(f"{_id}: Is missing requirement")
+                tests_with_missing_requirements.append(_id)
     return tests_with_missing_requirements
+
+
+def find_polarion_ids(polarion_project_id, string_to_match):
+    return re.findall(
+        rf"pytest.mark.polarion.*({polarion_project_id}-[0-9]+)",
+        "\n".join(git_diff_lines().get(string_to_match, [])),
+        re.MULTILINE | re.IGNORECASE,
+    )
+
+
+def get_polarion_project_id(project_id, config_file_path, util_name):
+    polarion_project_id = project_id or get_util_config(util_name=util_name, config_file_path=config_file_path).get(
+        "project_id"
+    )
+    if not polarion_project_id:
+        LOGGER.error("Polarion project id must be passed via config file or command line")
+        raise click.Abort()
+    return polarion_project_id
+
+
+def update_polarion_ids(project_id, is_automated, polarion_ids, is_approved=False):
+    updated_ids = {}
+    if polarion_ids:
+        automation_status = AUTOMATED if is_automated else NOT_AUTOMATED
+
+        from pylero.work_item import TestCase
+        from pylero.exceptions import PyleroLibException
+
+        for id in polarion_ids:
+            try:
+                tc = TestCase(project_id=project_id, work_item_id=id)
+                tc.caseautomation = automation_status
+                if is_approved:
+                    tc.status = APPROVED
+                tc.update()
+                LOGGER.debug(f"Polarion {id}: marked as: {automation_status}, approved status set: {is_approved}")
+                updated_ids.setdefault("updated", []).append(id)
+            except PyleroLibException as polarion_exception:
+                LOGGER.warning(f"{id}: {polarion_exception}")
+                updated_ids.setdefault("failed", []).append(id)
+    return updated_ids

apps/polarion/polarion_verify_tc_requirements.py

@@ -1,13 +1,8 @@
-import re
 import logging
 from simple_logger.logger import get_logger
 import os
 import click
-from apps.polarion.polarion_utils import (
-    git_diff_lines,
-    validate_polarion_requirements,
-)
-from apps.utils import get_util_config
+from apps.polarion.polarion_utils import validate_polarion_requirements, find_polarion_ids, get_polarion_project_id
 
 LOGGER = get_logger(name="polarion-verify-tc-requirements")
 
@@ -24,27 +19,16 @@
 def has_verify(config_file_path, project_id, verbosity):
     if verbosity:
         LOGGER.setLevel(logging.DEBUG)
-
-    polarion_project_id = project_id or get_util_config(
-        util_name="pyutils-polarion-verify-tc-requirements",
-        config_file_path=config_file_path,
-    ).get("project_id")
-
-    if not polarion_project_id:
-        LOGGER.error("Polarion project id must be passed via config file or command line")
-        raise click.Abort()
-
-    if added_ids := re.findall(
-        rf"pytest.mark.polarion.*({polarion_project_id}-[0-9]+)",
-        "\n".join(git_diff_lines().get("added", [])),
-        re.MULTILINE | re.IGNORECASE,
-    ):
+    polarion_project_id = get_polarion_project_id(
+        project_id=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"):
         LOGGER.debug(f"Checking following ids: {added_ids}")
         if tests_with_missing_requirements := validate_polarion_requirements(
             polarion_test_ids=added_ids,
             polarion_project_id=polarion_project_id,
         ):
-            click.echo(f"TestCases with missing requirement: {tests_with_missing_requirements}")
+            LOGGER.error(f"TestCases with missing requirement: {tests_with_missing_requirements}")
             raise click.Abort()
 
 

config.example.yaml

@@ -4,4 +4,6 @@ pyutils-unusedcode:
   exclude_function_prefix:
   - "my_exclude_function_prefix"
 pyutils-polarion-verify-tc-requirements:
-  project_id: "ABC"
+  project_id: "ABCDEF"
+pyutils-polarion-set-automated:
+  project_id: "ABCDEF"

poetry.lock

@@ -38,7 +38,7 @@ packages = [{ include = "apps" }]
 [tool.poetry.scripts]
 pyutils-unusedcode = "apps.unused_code.unused_code:get_unused_functions"
 pyutils-polarion-verify-tc-requirements = "apps.polarion.polarion_verify_tc_requirements:has_verify"
-
+pyutils-polarion-set-automated = "apps.polarion.polarion_set_automated:polarion_approve_automate"
 
 [tool.poetry.dependencies]
 python = "^3.8"
@@ -58,11 +58,6 @@ enable = true
 pattern = "((?P<epoch>\\d+)!)?(?P<base>\\d+(\\.\\d+)*)"
 
 
-
-
-
-
-
 [tool.poetry.group.test.dependencies]
 pytest = "^8.0.0"
 pytest-cov = "^4.1.0"

pyproject.toml

@@ -0,0 +1,17 @@
+import shlex
+import subprocess
+from pyhelper_utils.shell import run_command
+
+BASE_COMMAND = "poetry run python apps/polarion/polarion_set_automated.py"
+
+
+def test_missing_project_id_set_automated():
+    rc, _, err = run_command(
+        command=shlex.split(BASE_COMMAND),
+        verify_stderr=False,
+        check=False,
+        capture_output=False,
+        stderr=subprocess.PIPE,
+    )
+    assert "Polarion project id must be passed via config file or command line" in err
+    assert not rc