Add code coverage disable check to GitHub workflows

.github/workflows/code_coverage_disable_check.py

@@ -0,0 +1,157 @@
+"""Code Coverage Disable Checker Script.
+
+Methodology:
+
+    Recursively analyzes TypeScript files in the specified directories to
+    ensure they do not contain code coverage disable statements.
+
+    This script enforces proper code coverage practices in the project.
+
+NOTE:
+    This script complies with our python3 coding and documentation standards.
+    It complies with:
+
+        1) Pylint
+        2) Pydocstyle
+        3) Pycodestyle
+        4) Flake8
+        5) Python Black
+
+"""
+
+import os
+import re
+import argparse
+import sys
+
+
+def has_code_coverage_disable(file_path):
+    """
+    Check if a TypeScript file contains code coverage disable statements.
+
+    Args:
+        file_path (str): Path to the TypeScript file.
+
+    Returns:
+        bool: True if code coverage disable statement is found, False
+        otherwise.
+    """
+    code_coverage_disable_pattern = re.compile(
+        r"""(?://\s*istanbul\s+ignore(?:-next-line|-line)?
+        |/\*\s*istanbul\s+ignore\s*(?:next|-line)\s*\*/)""",
+        re.IGNORECASE,
+    )
+
+    try:
+        with open(file_path, "r", encoding="utf-8") as file:
+            content = file.read()
+            return bool(code_coverage_disable_pattern.search(content))
+    except FileNotFoundError:
+        print(f"File not found: {file_path}")
+        return False
+    except PermissionError:
+        print(f"Permission denied: {file_path}")
+        return False
+    except (IOError, OSError) as e:
+        print(f"Error reading file {file_path}: {e}")
+        return False
+
+
+def check_code_coverage(directories):
+    """
+    Recursively check TypeScript files for code coverage disable statements.
+
+    Args:
+        directories (list) : List of directories.
+
+    Returns:
+        bool: True if code coverage disable statement is found, False
+        otherwise.
+    """
+    code_coverage_found = False
+
+    for directory in directories:
+        if not os.path.exists(directory):
+            print(
+                f"""Error: The specified directory '{directory}' does
+                not exist."""
+            )
+            sys.exit(1)
+        for root, _, files in os.walk(directory):
+            for file_name in files:
+                if (
+                    file_name.endswith(".tsx")
+                    and not file_name.endswith(".test.tsx")
+                   ):
+                    file_path = os.path.join(root, file_name)
+                    if has_code_coverage_disable(file_path):
+                        print(
+                            f"""File {file_path} contains code coverage disable
+                            statement."""
+                        )
+                        code_coverage_found = True
+
+        setup_path = os.path.join(directory, "setup.ts")
+        if (
+            os.path.exists(setup_path)
+            and has_code_coverage_disable(setup_path)
+           ):
+            print(
+                f"""Setup file {setup_path} contains code coverage disable
+                statement."""
+            )
+            code_coverage_found = True
+
+    return code_coverage_found
+
+
+def arg_parser_resolver():
+    """Resolve the CLI arguments provided by the user.
+
+    Returns:
+        result: Parsed argument object
+    """
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        "--directory",
+        type=str,
+        nargs="+",
+        default=[os.getcwd()],
+        help="""One or more directories to check for code coverage disable
+        statements (default: current directory).""",
+    )
+    return parser.parse_args()
+
+
+def main():
+    """
+    Execute the script's main functionality.
+
+    This function serves as the entry point for the script. It performs
+    the following tasks:
+    1. Validates and retrieves the directory to check from
+       command line arguments.
+    2. Recursively checks TypeScript files for code coverage disable
+    statements.
+    3. Provides informative messages based on the analysis.
+    4. Exits with an error if code coverage disable statements are found.
+
+    Raises:
+        SystemExit: If an error occurs during execution.
+    """
+    args = arg_parser_resolver()
+
+    print(args.directory)
+
+    # Check code coverage in the specified directory
+    code_coverage_found = check_code_coverage(args.directory)
+
+    if code_coverage_found:
+        print("Code coverage disable check failed. Exiting with error.")
+        sys.exit(1)
+
+    print("Code coverage disable check completed successfully.")
+
+
+if __name__ == "__main__":
+    main()

.github/workflows/eslint_disable_check.py

@@ -1,23 +1,23 @@
 #!/usr/bin/env python3
 # -*- coding: UTF-8 -*-
 """ESLint Checker Script.
 
 Methodology:
 
-    Recursively analyzes TypeScript files in the 'src' directory and its subdirectories
-    as well as 'setup.ts' files to ensure they do not contain eslint-disable statements.
+    Recursively analyzes TypeScript files in the specified directory
+    to ensure they do not contain eslint-disable statements.
 
     This script enforces code quality practices in the project.
 
 NOTE:
-
     This script complies with our python3 coding and documentation standards.
     It complies with:
 
         1) Pylint
         2) Pydocstyle
         3) Pycodestyle
         4) Flake8
+        5) Python Black
 
 """
 
@@ -26,6 +26,7 @@
 import argparse
 import sys
 
+
 def has_eslint_disable(file_path):
     """
     Check if a TypeScript file contains eslint-disable statements.
@@ -36,43 +37,73 @@
     Returns:
         bool: True if eslint-disable statement is found, False otherwise.
     """
-    eslint_disable_pattern = re.compile(r'//\s*eslint-disable(?:-next-line|-line)?', re.IGNORECASE)
-
+    eslint_disable_pattern = re.compile(
+        r"""\/\/\s*eslint-disable(?:-next-line
+        |-line)?[^\n]*|\/\*\s*eslint-disable[^\*]*\*\/""",
+        re.IGNORECASE,
+    )
+
     try:
-        with open(file_path, 'r', encoding='utf-8') as file:
+        with open(file_path, "r", encoding="utf-8") as file:
             content = file.read()
             return bool(eslint_disable_pattern.search(content))
-    except Exception as e:
+    except FileNotFoundError:
+        print(f"File not found: {file_path}")
+        return False
+    except PermissionError:
+        print(f"Permission denied: {file_path}")
+        return False
+    except (IOError, OSError) as e:
         print(f"Error reading file {file_path}: {e}")
         return False
 
-def check_eslint(directory):
+
+def check_eslint(directories):
     """
-    Recursively check TypeScript files for eslint-disable statements in the 'src' directory.
+    Recursively check TypeScript files for eslint-disable statements.
 
     Args:
-        directory (str): Path to the directory.
+        directories (list): List of directories.
 
     Returns:
         bool: True if eslint-disable statement is found, False otherwise.
     """
     eslint_found = False
 
-    for root, dirs, files in os.walk(os.path.join(directory, 'src')):
-        for file_name in files:
-            if file_name.endswith('.tsx') and not file_name.endswith('.test.tsx'):
-                file_path = os.path.join(root, file_name)
-                if has_eslint_disable(file_path):
-                    print(f'File {file_path} contains eslint-disable statement.')
-                    eslint_found = True
-
-    setup_path = os.path.join(directory, 'setup.ts')
-    if os.path.exists(setup_path) and has_eslint_disable(setup_path):
-        print(f'Setup file {setup_path} contains eslint-disable statement.')
-        eslint_found = True
+    for directory in directories:
+        if not os.path.exists(directory):
+            print(
+                f"""Error: The specified directory '{directory}' does not
+                exist."""
+            )
+            sys.exit(1)
+        for root, _, files in os.walk(directory):
+            if "node_modules" in root:
+                continue
+            for file_name in files:
+                if (
+                    file_name.endswith(".tsx")
+                    and not file_name.endswith(".test.tsx")
+                   ):
+                    file_path = os.path.join(root, file_name)
+                    if has_eslint_disable(file_path):
+                        print(
+                            f"""File {file_path} contains eslint-disable
+                              statement."""
+                        )
+                        eslint_found = True
+
+        setup_path = os.path.join(directory, "setup.ts")
+        if os.path.exists(setup_path) and has_eslint_disable(setup_path):
+            print(
+                f"""Setup file {setup_path} contains eslint-disable
+                statement."""
+            )
+            eslint_found = True
 
     return eslint_found
 
+
 def arg_parser_resolver():
     """Resolve the CLI arguments provided by the user.
 
@@ -83,11 +114,14 @@
     parser.add_argument(
         "--directory",
         type=str,
-        default=os.getcwd(),
-        help="Path to the directory to check (default: current directory)"
+        nargs="+",
+        default=[os.getcwd()],
+        help="""One or more directories to check for eslint disable
+        statements (default: current directory).""",
     )
     return parser.parse_args()
 
+
 def main():
     """
     Execute the script's main functionality.
@@ -104,11 +138,6 @@
         SystemExit: If an error occurs during execution.
     """
     args = arg_parser_resolver()
-
-    if not os.path.exists(args.directory):
-        print(f"Error: The specified directory '{args.directory}' does not exist.")
-        sys.exit(1)
-
     # Check eslint in the specified directory
     eslint_found = check_eslint(args.directory)
 
@@ -118,5 +147,6 @@
 
     print("ESLint-disable check completed successfully.")
 
+
 if __name__ == "__main__":
     main()

.github/workflows/pull-request.yml

@@ -1,4 +1,4 @@
 ##############################################################################
 ##############################################################################
 #
 # NOTE!
@@ -187,6 +187,55 @@
         run: |
           python .github/workflows/eslint_disable_check.py
 
+  Check-Code-Coverage-Disable:
+    name: Check for code coverage disable
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Get changed files
+        id: changed-files
+        uses: tj-actions/changed-files@v45
+
+      - name: Identify nearest changed directories
+        id: nearest_dirs
+        run: |
+          # Initialize an empty string to store the nearest directories
+          nearest_dirs=""
+
+          # Loop through each changed file to extract the nearest directory
+          for file in ${{ steps.changed-files.outputs.all_changed_files }}
+          do
+            # Get the full directory from the file path
+            folder=$(dirname "$file")
+            full_path="$repo_root/$folder"
+            # Add the folder to the nearest_dirs string if not already present
+            if [[ ! " $nearest_dirs " =~ " $full_path " ]]; then
+              if [ -z "$nearest_dirs" ]; then
+                nearest_dirs="$full_path"
+              else
+                nearest_dirs="$nearest_dirs,$full_path"
+              fi
+            fi
+          done
+
+          # Output the nearest changed directories
+          echo "Nearest changed directories: $nearest_dirs"
+
+          # Set the nearest directories as a GitHub environment variable
+          echo "NEAREST_DIRS=$nearest_dirs" >> $GITHUB_ENV
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.9
+
+      - name: Run Python script
+        run: |
+          # Access the nearest_dirs environment variable
+          python .github/workflows/code_coverage_disable_check.py --directory $NEAREST_DIRS
+
   Test-Application:
     name: Test Application
     runs-on: ubuntu-latest

src/App.tsx

@@ -70,7 +70,9 @@ const { setItem } = useLocalStorage();
  *
  * @returns  The rendered routes and components of the application.
  */
+// eslint-disable
 
+// istanbul ignore next
 function app(): JSX.Element {
   /*const { updatePluginLinks, updateInstalled } = bindActionCreators(
     actionCreators,