Add polarion test requirement verification script (#6)

* Revert "initial PR"

This reverts commit de9e568.

* initial commit for unused_code

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* address code review comments on unused_code

* update config location

* add polarion test case requirement validation script

* fix imports

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update to polarion requirement check script

* Update pyproject.toml

* Update pyproject.toml

* Update apps/polarion/polarion_verify_tc_requirements.py

Co-authored-by: Ruth Netser <[email protected]>

* add more tests using unittest.mock and address review comments

* fix readme

* update rename of the script

* Update apps/polarion/polarion_utils.py

Co-authored-by: Ruth Netser <[email protected]>

* address review comments

* Update apps/utils.py

Co-authored-by: Meni Yakove <[email protected]>

* Update apps/utils.py

Co-authored-by: Meni Yakove <[email protected]>

* address review comments

* added missing config for pytest-cov

* update for coverage

* addressed comments

* address review comments

* Update tests/polarion/test_polarion.py

Co-authored-by: Ruth Netser <[email protected]>

* update based on review comments

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* address review comments

* address review comments

* update poetry

* remove polarion tests

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Ruth Netser <[email protected]>
Co-authored-by: Meni Yakove <[email protected]>

Author: 4 people

.gitignore

@@ -50,6 +50,7 @@ coverage.xml
 .hypothesis/
 .pytest_cache/
 cover/
+.tests_coverage/
 
 # Translations
 *.mo

README.md

@@ -1,6 +1,7 @@
 # python-utility-scripts
 Repository for various python utility scripts
-* [pyappsutils-unusedcode](https://github.com/RedHatQE/python-utility-scripts/blob/main/README.md)
+* [pyutils-unusedcode](https://github.com/RedHatQE/python-utility-scripts/blob/main/apps/unused_code/README.md)
+* [pyutils-polarion-verify-tc-requirements](https://github.com/RedHatQE/python-utility-scripts/blob/main/apps/polarion/README.md)
 
 ## Installation
 

apps/polarion/README.md

@@ -0,0 +1,32 @@
+# scripts to interact with Polarion instance
+
+## pyutils-polarion-verify-tc-requirements
+Utility to check if test cases in a pytest repository has associated Polarion requirements.
+
+## 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-verify-tc-requirements --help
+pyutils-polarion-verify-tc-requirements --project_id <project_id>
+```
+
+## 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-verify-tc-requirements :
+  project_id: "<project_id>"
+```
+This would run the polarion requirement check against Polarion project <project_id>
+
+To run from CLI with `--project-id`
+
+```bash
+pyutils-polarion-verify-tc-requirements  --project-id 'my_project_id'
+```

apps/polarion/__init__.py

@@ -0,0 +1,45 @@
+from simple_logger.logger import get_logger
+import shlex
+import subprocess
+from pylero.exceptions import PyleroLibException
+
+
+LOGGER = get_logger(name=__name__)
+
+
+def git_diff():
+    data = subprocess.check_output(shlex.split("git diff HEAD^-1"))
+    data = data.decode("utf-8")
+    return data
+
+
+def git_diff_lines():
+    diff = {}
+    for line in git_diff().splitlines():
+        LOGGER.debug(line)
+        if line.startswith("+"):
+            diff.setdefault("added", []).append(line)
+
+    return diff
+
+
+def validate_polarion_requirements(polarion_test_ids, polarion_project_id):
+    tests_with_missing_requirements = []
+    from pylero.work_item import Requirement, TestCase
+
+    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

apps/polarion/polarion_utils.py

@@ -0,0 +1,49 @@
+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
+
+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 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:
+        click.echo("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,
+    ):
+        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}")
+            raise click.Abort()
+
+
+if __name__ == "__main__":
+    has_verify()

apps/polarion/polarion_verify_tc_requirements.py

@@ -1,11 +1,11 @@
-# pyappsutils-unusedcode
+# pyutils-unusedcode
 Helper to identify unused code in a pytest repository. It should be run from inside the test repository using this tool.
 
 ## Usage
 
 ```bash
-pyappsutils-unusedcode
-pyappsutils-unusedcode --help
+pyutils-unusedcode
+pyutils-unusedcode --help
 ```
 
 ## Config file
@@ -15,7 +15,7 @@ To skip unused code check on specific files or functions of a repository, a conf
 ### Example:
 
 ```yaml
-pyappsutils-unusedcode:
+pyutils-unusedcode:
   exclude_files:
   - "my_exclude_file.py"
   exclude_function_prefix:
@@ -26,11 +26,11 @@ This would exclude any functions with prefix my_exclude_function_prefix and file
 To run from CLI with `--exclude-function-prefixes`
 
 ```bash
-pyappsutils-unusedcode --exclude-function-prefixes 'my_exclude_function1,my_exclude_function2'
+pyutils-unusedcode --exclude-function-prefixes 'my_exclude_function1,my_exclude_function2'
 ```
 
 To run from CLI with `--exclude-files`
 
 ```bash
-pyappsutils-unusedcode --exclude-files 'my_exclude_file1.py,my_exclude_file2.py'
+pyutils-unusedcode --exclude-files 'my_exclude_file1.py,my_exclude_file2.py'
 ```

apps/unused_code/README.md

@@ -1,11 +1,11 @@
 import ast
+import logging
 import os
 import subprocess
 import click
-import yaml
 from simple_logger.logger import get_logger
 
-from apps.utils import all_python_files, ListParamType
+from apps.utils import all_python_files, ListParamType, get_util_config
 
 LOGGER = get_logger(name=__name__)
 
@@ -42,19 +42,12 @@ def is_test(_elm):
             yield elm
 
 
-def read_config_file(config_file_path):
-    if os.path.exists(config_file_path):
-        with open(config_file_path) as _file:
-            return yaml.safe_load(_file)
-    return {}
-
-
 def is_ignore_function_list(ignore_prefix_list, function):
     ignore_function_lists = [
         function.name for ignore_prefix in ignore_prefix_list if function.name.startswith(ignore_prefix)
     ]
     if ignore_function_lists:
-        LOGGER.info(f"Following functions are getting skipped: {ignore_function_lists}")
+        LOGGER.debug(f"Following functions are getting skipped: {ignore_function_lists}")
         return True
 
 
@@ -75,10 +68,12 @@ def is_ignore_function_list(ignore_prefix_list, function):
     help="Provide a comma-separated string or list of function prefixes to exclude",
     type=ListParamType(),
 )
-def get_unused_functions(config_file_path, exclude_files, exclude_function_prefixes):
+@click.option("--verbosity", default=False, is_flag=True)
+def get_unused_functions(config_file_path, exclude_files, exclude_function_prefixes, verbosity):
+    if verbosity:
+        LOGGER.setLevel(logging.DEBUG)
     _unused_functions = []
-    config_yaml = read_config_file(config_file_path=config_file_path)
-    unused_code_config = config_yaml.get("pyappsutils-unusedcode", {})
+    unused_code_config = get_util_config(util_name="pyutils-unusedcode", config_file_path=config_file_path)
     func_ignore_prefix = exclude_function_prefixes or unused_code_config.get("exclude_function_prefix", [])
     file_ignore_list = exclude_files or unused_code_config.get("exclude_files", [])
     for py_file in all_python_files():

apps/unused_code/unused_code.py

@@ -1,11 +1,20 @@
 import os
+
+import yaml
 from simple_logger.logger import get_logger
 import json
 import click
 
 LOGGER = get_logger(name=__name__)
 
 
+def get_util_config(util_name, config_file_path):
+    if os.path.exists(config_file_path):
+        with open(config_file_path) as _file:
+            return yaml.safe_load(_file).get(util_name, {})
+    return {}
+
+
 # Reference: https://gist.github.com/welel/9cf860dd3f4d3e09f9b4305878b3a04e
 class ListParamType(click.ParamType):
     """Represents the list type of a CLI parameter.

apps/utils.py

@@ -0,0 +1,7 @@
+pyutils-unusedcode:
+  exclude_files:
+  - "my_exclude_file.py"
+  exclude_function_prefix:
+  - "my_exclude_function_prefix"
+pyutils-polarion-verify-tc-requirements:
+  project_id: "ABC"