-
-
Notifications
You must be signed in to change notification settings - Fork 976
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
256 changed files
with
17,554 additions
and
1,355 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| ############################################################################## | ||
| ############################################################################## | ||
| # | ||
| # NOTE! | ||
| # | ||
| # Please read the README.md file in this directory that defines what should | ||
| # be placed in this file | ||
| # | ||
| ############################################################################## | ||
| ############################################################################## | ||
|
|
||
| name: PUSH Workflow - Website Deployment | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - "develop-postgres" | ||
|
|
||
| env: | ||
| CODECOV_UNIQUE_NAME: CODECOV_UNIQUE_NAME-${{ github.run_id }}-${{ github.run_number }} | ||
|
|
||
| jobs: | ||
| Deploy-Docusaurus: | ||
| name: Deploy https://docs-api.talawa.io website | ||
| runs-on: ubuntu-latest | ||
| # Run only if the develop-postgres branch and not dependabot | ||
| if: ${{ github.actor != 'dependabot[bot]' }} | ||
| environment: | ||
| # This "name" has to be the repos' branch that contains | ||
| # the current active website. There must be an entry for | ||
| # the same branch in the PalisadoesFoundation's | ||
| # "Code and automation > Environments > github-pages" | ||
| # menu. The branch "name" must match the branch in the | ||
| # "on.push.branches" section at the top of this file | ||
| name: develop-postgres | ||
| url: https://docs-api.talawa.io | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: pnpm/action-setup@v4 | ||
| - uses: actions/cache@v3 | ||
| with: | ||
| path: docs/.docusaurus | ||
| key: docusaurus-${{ hashFiles('docs/**') }} | ||
| restore-keys: | | ||
| docusaurus- | ||
| - uses: webfactory/[email protected] | ||
| with: | ||
| ssh-private-key: ${{ secrets.DEPLOY_GITHUB_PAGES }} | ||
| - name: Deploy to GitHub Pages | ||
| env: | ||
| USE_SSH: true | ||
| GIT_USER: git | ||
| working-directory: ./docs | ||
| run: | | ||
| git config --global user.email "[email protected]" | ||
| git config --global user.name "gh-actions" | ||
| if ! pnpm install --frozen-lockfile; then | ||
| echo "Failed to install dependencies" | ||
| exit 1 | ||
| fi | ||
| if ! pnpm run deploy; then | ||
| echo "Deployment failed" | ||
| exit 1 | ||
| fi |
161 changes: 161 additions & 0 deletions
161
.github/workflows/scripts/code_coverage_disable_check.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,161 @@ | ||
| """Code Coverage Disable Checker Script. | ||
| Methodology: | ||
| Recursively analyzes TypeScript files in the specified directories or | ||
| checks specific files | ||
| 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(?:\s+(?:next|-line))?[^\n]*| | ||
| /\*\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(files_or_dirs): | ||
| """ | ||
| Check TypeScript files for code coverage disable statements. | ||
| Args: | ||
| files_or_dirs (list): List of files or directories to check. | ||
| Returns: | ||
| bool: True if code coverage disable statement is found, False | ||
| otherwise. | ||
| """ | ||
| code_coverage_found = False | ||
|
|
||
| for item in files_or_dirs: | ||
| if os.path.isdir(item): | ||
| # If it's a directory, recursively walk through the files in it | ||
| for root, _, files in os.walk(item): | ||
| if "node_modules" in root: | ||
| continue | ||
| for file_name in files: | ||
| if ( | ||
| file_name.endswith(".ts") | ||
| and not file_name.endswith(".test.ts") | ||
| and not file_name.endswith(".spec.ts") | ||
| ): | ||
| 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 | ||
| elif os.path.isfile(item): | ||
| # If it's a file, check it directly | ||
| if ( | ||
| item.endswith(".ts") | ||
| and not item.endswith(".test.ts") | ||
| and not item.endswith(".spec.ts") | ||
| ): | ||
| if has_code_coverage_disable(item): | ||
| print( | ||
| f"""File {item} contains code coverage disable statement. Please remove it and add the appropriate tests.""" | ||
| ) | ||
| 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).""", | ||
| ) | ||
| parser.add_argument( | ||
| "--files", | ||
| type=str, | ||
| nargs="+", | ||
| default=[], | ||
| help="""One or more files to check directly for code coverage disable | ||
| statements (default: check directories).""", | ||
| ) | ||
| 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 files or directories to check from | ||
| command line arguments. | ||
| 2. Checks files or directories 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() | ||
| files_or_dirs = args.files if args.files else args.directory | ||
| # Check code coverage in the specified files or directories | ||
| code_coverage_found = check_code_coverage(files_or_dirs) | ||
|
|
||
| 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() |
Oops, something went wrong.