ADD: outstanding issues report (#68)

* add coverity installation script

* add Outstanding issues report

* add Outstanding issues report

* run ruff formatter

* remove unnecessary files

* Update .github/coverity/api/api.py

Co-authored-by: Mateusz Grabuszyński <[email protected]>

* Update .github/coverity/api/api.py

Co-authored-by: Mateusz Grabuszyński <[email protected]>

* Update .github/coverity/api/api.py

Co-authored-by: Mateusz Grabuszyński <[email protected]>

* Update .github/workflows/coverity_reports.yml

Co-authored-by: Mateusz Grabuszyński <[email protected]>

---------

Co-authored-by: Mateusz Grabuszyński <[email protected]>

Author: zLukas

.github/coverity/api/api.py

@@ -32,16 +32,20 @@ def prepare_query() -> dict:
     TOKEN = os.getenv("COVERITY_TOKEN", default=None)
     PROJECT_NAME = os.getenv("COVERITY_PROJECT_NAME", default=None)
     USER = os.getenv("COVERITY_USER", default=None)
+    OUTSTANDING_VIEW_ID = os.getenv("COVERITY_OUTSTANDING_VIEW_ID", default=None)
+    PROJECT_ID = os.getenv("COVERITY_PROJECT_ID", default=None)
 
-    if None in [BASE_URL, TOKEN, PROJECT_NAME, USER]:
+    if None in [BASE_URL, TOKEN, PROJECT_NAME, USER, OUTSTANDING_VIEW_ID, PROJECT_ID]:
         log.error("Environment variables not set")
         log.error(
-            "Please set the following environment variables: COVERITY_BASE_URL, COVERITY_TOKEN, COVERITY_PROJECT_NAME, COVERITY_USER"
+            "Please set the following environment variables: COVERITY_BASE_URL, COVERITY_TOKEN, COVERITY_PROJECT_NAME, COVERITY_USER, OUTSTANDING_VIEW_ID, COVERITY_PROJECT_ID"
         )
         return {}
     return {
         "base_url": BASE_URL,
         "project_name": PROJECT_NAME,
+        "project_id": PROJECT_ID,
+        "outstanding_view_id": OUTSTANDING_VIEW_ID,
         "password": TOKEN,
         "user": USER,
         "stream": PROJECT_NAME,
@@ -59,6 +63,38 @@ def prepare_query() -> dict:
     }
 
 
+def fetch_outstanding_view_issues(config: dict) -> dict:
+    """
+    Fetch issues from a specific view based on the provided view ID.
+
+    Args:
+        config (dict): Configuration dictionary containing 'base_url', 'view_id, 'user', and 'password'.
+        view_id (int): The ID of the view to fetch issues from.
+
+    Returns:
+        dict: A dictionary containing the list of issues for the view.
+    """
+    endpoint = (
+        f"{config['base_url']}/api/v2/views/viewContents/{config['outstanding_view_id']}"
+    )
+    issues = {}
+    try:
+        response = requests.get(
+            endpoint,
+            params={"projectId": config["project_id"]},
+            auth=HTTPBasicAuth(config["user"], config["password"]),
+        )
+        response.raise_for_status()
+        issues = response.json()
+
+    except requests.exceptions.HTTPError as http_err:
+        logging.error(f"HTTP error occurred: {http_err}")
+    except Exception as err:
+        logging.error(f"An error occurred: {err}")
+    finally:
+        return issues
+
+
 def get_snapshot(config: dict, description: str, version: str) -> int:
     """
     Retrieve a snapshot ID based on the provided description and version.
@@ -75,7 +111,7 @@ def get_snapshot(config: dict, description: str, version: str) -> int:
     raw = get_snapshots_list(config)
     ids = list(map(lambda s: s["id"], raw["snapshotsForStream"]))
     snapshot_id = 0
-    #TODO: replace with threads
+    # TODO: replace with threads
     for id in ids:
         res = requests.get(
             f"{search_query_url}/{id}",

.github/coverity/api/parser.py

@@ -18,10 +18,12 @@ def issues_to_pandas(raw_response_data: dict) -> pd.DataFrame:
         converted_dict = {item["key"]: item["value"] for item in row}
         converted_response.append(converted_dict)
     df = pd.DataFrame(converted_response)
-
-    impact_order = ["High", "Medium", "Low"]
-    df["displayImpact"] = pd.Categorical(df["displayImpact"], categories=impact_order)
-    df = df.sort_values(by="displayImpact")
+    if "displayImpact" in df.columns:
+        impact_order = ["High", "Medium", "Low"]
+        df["displayImpact"] = pd.Categorical(
+            df["displayImpact"], categories=impact_order
+        )
+        df = df.sort_values(by="displayImpact")
     # remove abs path from displayFile
     df["displayFile"] = df["displayFile"].str.replace(r".*/_work/", "", regex=True)
     return df

.github/coverity/report.py

@@ -39,6 +39,11 @@ def main():
     df_launcher = api.filter_launcher_issues(df)
     df_grpc.to_csv("grpc_report.csv", index=False)
     df_launcher.to_csv("launcher_report.csv", index=False)
+
+    log.info("fetching outstanding view issues")
+    outstanding_issues = api.fetch_outstanding_view_issues(query)
+    df_outstanding = api.issues_to_pandas(outstanding_issues)
+    df_outstanding.to_csv("outstanding_issues.csv", index=False)
     log.info("Reports generated")
 
 

.github/workflows/coverity_reports.yml

@@ -31,6 +31,8 @@ jobs:
           COVERITY_TOKEN: ${{ secrets.COVERITY_REPORTS_TOKEN }}
           COVERITY_PROJECT_NAME: 'Intel-Tiber-Broadcast-Suite'
           COVERITY_USER: ${{ secrets.COVERITY_REPORTS_USER }}
+          COVERITY_OUTSTANDING_VIEW_ID: ${{ secrets.COVERITY_OUTSTANDING_VIEW_ID }}
+          COVERITY_PROJECT_ID: ${{ secrets.COVERITY_PROJECT_ID }}
 
       - name: prepare artifacts
         if: success()