Add Scripts for Checking Eslint and Code Coverage Disable Statements #2811

im-vedant · 2024-12-30T23:11:13Z

Issue Number:

Summary by CodeRabbit

New Features
- Added GitHub Actions workflow checks for:
  - ESLint disable comment detection
  - Code coverage disable comment detection
Chores
- Introduced Python scripts to enhance code quality and compliance checks in the CI/CD pipeline

coderabbitai · 2024-12-30T23:11:20Z

Walkthrough

This pull request introduces two new GitHub Actions workflow jobs in .github/workflows/pull-request.yml: check_eslint_disable and check_code_coverage_disable. These jobs are designed to automatically detect and flag potentially problematic code comments that disable ESLint rules or code coverage checks. Each job follows a similar pattern of checking out code, retrieving changed files, setting up Python 3.9, and running a specific validation script to identify and report on these comments.

Changes

File	Change Summary
`.github/workflows/pull-request.yml`	Added two new jobs: `check_eslint_disable` and `check_code_coverage_disable`
`.github/workflows/scripts/code_coverage_disable_check.py`	New script to detect code coverage disable comments using regex
`.github/workflows/scripts/eslint_disable_check.py`	New script to detect ESLint disable comments using regex

Assessment against linked issues

Objective	Addressed	Explanation
Detect Code Coverage Bypass Comments [#2806]	✅
Detect ESLint Disable Comments [#2806]	✅
Fail Workflow if Bypass Comments Detected [#2806]	✅

Possibly related PRs

Enhance Linting and Code Coverage Checks with New Scripts and Job Separation #2810: Enhances linting and code coverage checks by introducing new validation scripts

Suggested reviewers

palisadoes

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

github-actions · 2024-12-30T23:11:36Z

Our Pull Request Approval Process

Thanks for contributing!

Testing Your Code

Remember, your PRs won't be reviewed until these criteria are met:

We don't merge PRs with poor code quality.
1. Follow coding best practices such that CodeRabbit.ai approves your PR.
We don't merge PRs with failed tests.
1. When tests fail, click on the Details link to learn more.
2. Write sufficient tests for your changes (CodeCov Patch Test). Your testing level must be better than the target threshold of the repository
3. Tests may fail if you edit sensitive files. Ask to add the ignore-sensitive-files-pr label if the edits are necessary.
We cannot merge PRs with conflicting files. These must be fixed.

Our policies make our code better.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

comments in this PR or
our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

arbitrators of future discussions with other contributors about the validity of your changes
point of contact for evaluating the validity of your work
person who verifies matching issues by others that should be closed.
person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

PRs with issues not assigned to you will be closed by the reviewer
Fix the first comment in the PR so that each issue listed automatically closes

Other

🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
Read the CONTRIBUTING.md file make

coderabbitai

Actionable comments posted: 17

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 11e1121 and 14c29f5.

📒 Files selected for processing (3)

.github/workflows/pull-request.yml (1 hunks)
.github/workflows/scripts/code_coverage_disable_check.py (1 hunks)
.github/workflows/scripts/eslint_disable_check.py (1 hunks)

🧰 Additional context used

🪛 Ruff (0.8.2)

.github/workflows/scripts/eslint_disable_check.py

1-1: Shebang is present but file is not executable

(EXE001)

30-30: Missing return type annotation for public function has_eslint_disable

(ANN201)

30-30: Missing type annotation for function argument file_path

(ANN001)

47-47: Unnecessary open mode parameters

Remove open mode parameters

(UP015)

56-56: Replace aliased errors with OSError

Replace with builtin OSError

(UP024)

61-61: check_eslint is too complex (11 > 10)

(C901)

61-61: Missing return type annotation for public function check_eslint

(ANN201)

61-61: Missing type annotation for function argument files_or_directories

(ANN001)

76-77: Use a single if statement instead of nested if statements

(SIM102)

92-92: Trailing comma missing

Add trailing comma

(COM812)

99-99: Missing return type annotation for public function arg_parser_resolver

(ANN201)

125-125: Missing return type annotation for public function main

Add return type annotation: None

(ANN201)

.github/workflows/scripts/code_coverage_disable_check.py

29-29: Missing return type annotation for public function has_code_coverage_disable

(ANN201)

29-29: Missing type annotation for function argument file_path

(ANN001)

46-46: Unnecessary open mode parameters

Remove open mode parameters

(UP015)

55-55: Replace aliased errors with OSError

Replace with builtin OSError

(UP024)

60-60: check_code_coverage is too complex (11 > 10)

(C901)

60-60: Missing return type annotation for public function check_code_coverage

(ANN201)

60-60: Missing type annotation for function argument files_or_dirs

(ANN001)

88-88: Trailing comma missing

Add trailing comma

(COM812)

91-98: Use a single if statement instead of nested if statements

(SIM102)

93-98: Use a single if statement instead of nested if statements

(SIM102)

100-100: Trailing comma missing

Add trailing comma

(COM812)

107-107: Missing return type annotation for public function arg_parser_resolver

(ANN201)

133-133: Missing return type annotation for public function main

Add return type annotation: None

(ANN201)

🪛 yamllint (1.35.1)

.github/workflows/pull-request.yml

[error] 73-73: trailing spaces

(trailing-spaces)

.github/workflows/scripts/eslint_disable_check.py

.github/workflows/scripts/code_coverage_disable_check.py

.github/workflows/pull-request.yml

Added disable check scripts

14c29f5

im-vedant requested a review from palisadoes as a code owner December 30, 2024 23:11

palisadoes approved these changes Dec 30, 2024

View reviewed changes

palisadoes merged commit 46b910e into PalisadoesFoundation:develop-postgres Dec 30, 2024
11 of 12 checks passed

im-vedant deleted the develop-postgres-workflow branch December 30, 2024 23:14

coderabbitai bot requested changes Dec 30, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Add Scripts for Checking Eslint and Code Coverage Disable Statements #2811

Add Scripts for Checking Eslint and Code Coverage Disable Statements #2811

Uh oh!

im-vedant commented Dec 30, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Dec 30, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

github-actions bot commented Dec 30, 2024

Uh oh!

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Add Scripts for Checking Eslint and Code Coverage Disable Statements #2811

Add Scripts for Checking Eslint and Code Coverage Disable Statements #2811

Uh oh!

Conversation

im-vedant commented Dec 30, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Dec 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Assessment against linked issues

Possibly related PRs

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

github-actions bot commented Dec 30, 2024

Our Pull Request Approval Process

Testing Your Code

Reviewers

Reviewing Your Code

CONTRIBUTING.md

Other

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

im-vedant commented Dec 30, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 30, 2024 •

edited

Loading