Skip to content

chore: modernize CI and lint config#496

Merged
nirtal85 merged 1 commit into
mainfrom
codex-modernize-ci-ruff
Jul 16, 2026
Merged

chore: modernize CI and lint config#496
nirtal85 merged 1 commit into
mainfrom
codex-modernize-ci-ruff

Conversation

@nirtal85

@nirtal85 nirtal85 commented Jul 16, 2026

Copy link
Copy Markdown
Owner

Summary

  • modernize uv usage in GitHub Actions and rename PR workflow
  • update Ruff config, add lint/format CI checks, and clean matching violations
  • refresh README commands and make Chrome browser version configurable

Verification

  • ruff check --config pyproject.toml .
  • ruff format --check --config pyproject.toml .
  • git diff --check

Summary by CodeRabbit

  • Documentation

    • Refreshed README branding, navigation links, setup instructions, test commands, and reporting guidance.
    • Added project metadata, including license, author, and README references.
  • Bug Fixes

    • Improved email inbox handling for addresses containing additional @ characters.
    • Made Chrome browser version configuration environment-driven.
  • Tests

    • Updated CI workflows to run dependency installation, linting, formatting checks, and tests more consistently.
    • Added and applied markers for sanity, development, flaky, and standard test runs.

@coderabbitai

coderabbitai Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@nirtal85, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 38 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5faff446-8cdc-4d8c-a9c2-78ee6c453424

📥 Commits

Reviewing files that changed from the base of the PR and between 95be7c7 and 026f2f9.

📒 Files selected for processing (14)
  • .github/workflows/monthly.yml
  • .github/workflows/pr.yml
  • README.md
  • pyproject.toml
  • src/pages/base_page.py
  • src/utilities/excel_parser.py
  • src/utilities/mailinator_helper.py
  • src/utilities/vrt_helper.py
  • tests/conftest.py
  • tests/dependency_class_test.py
  • tests/dependency_test.py
  • tests/email_test.py
  • tests/login_test.py
  • tests/workspaces_test.py
📝 Walkthrough

Walkthrough

The PR updates uv-based CI execution, project metadata and lint configuration, README setup instructions, helper implementations, browser test setup, and several test definitions and formatting details.

Changes

Tooling and test updates

Layer / File(s) Summary
Project metadata and quality configuration
pyproject.toml
Project metadata, pytest markers, and Ruff rule selection are updated.
uv-based CI execution
.github/workflows/monthly.yml, .github/workflows/pr.yml
Workflows install locked dependencies and run linting and pytest through uv.
Setup and execution documentation
README.md
Installation, test execution, reporting, badges, and section formatting are updated.
Helper implementation updates
src/pages/base_page.py, src/utilities/*
Element highlighting JavaScript and Mailinator email parsing are updated; comments and signatures are reformatted.
Test harness and test cleanup
tests/conftest.py, tests/*_test.py
Chrome version setup, pytest markers, assertions, failure messages, imports, and test documentation are adjusted.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Possibly related PRs

Suggested reviewers: elias-shoursoh

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 37.50% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main changes: CI workflow updates and lint/config modernization.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex-modernize-ci-ruff

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

github-actions Bot commented Jul 16, 2026

Copy link
Copy Markdown

Allure Report Summary

Name Duration Stats New Flaky Retry Report
Allure Report – Pull request #496 5ms Passed tests 1 1 0 0

@nirtal85
nirtal85 force-pushed the codex-modernize-ci-ruff branch from 95be7c7 to b8664f6 Compare July 16, 2026 20:36
@github-actions
github-actions Bot requested a review from elias-shoursoh July 16, 2026 20:38

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
src/utilities/vrt_helper.py (1)

89-98: 🎯 Functional Correctness | 🔴 Critical | ⚡ Quick win

Missing second argument in check.equal.

The check.equal assertion here is missing its second argument (TestRunStatus.OK.name), which will cause a TypeError when this method is executed. Compare this with the correct usage in the shoot_page method.

🐛 Proposed fix
             check.equal(
                 self.vrt_tracker.track(
                     TestRun(
                         name=baseline_name,
                         diffTollerancePercent=Constants.DIFF_TOLERANCE_PERCENT,
                         imageBase64=self.driver.get_screenshot_as_base64(),
                         ignoreAreas=ignore_areas,
                     )
                 ).testRunResponse.status.name,
+                TestRunStatus.OK.name,
             )
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/utilities/vrt_helper.py` around lines 89 - 98, Update the check.equal
call in the VRT tracking flow to pass TestRunStatus.OK.name as its
expected-value second argument, matching the established usage in shoot_page and
preserving the current tracked status as the actual value.
🧹 Nitpick comments (2)
src/utilities/vrt_helper.py (1)

60-62: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Correct typo in method name.

The method name contains a typo: ang instead of and.

♻️ Proposed refactor
-    def shoot_page_ang_ignore_elements(
+    def shoot_page_and_ignore_elements(
         self, baseline_name: str, elements: list[WebElement]
     ) -> None:
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/utilities/vrt_helper.py` around lines 60 - 62, Rename the VRT helper
method shoot_page_ang_ignore_elements to shoot_page_and_ignore_elements,
correcting ang to and, and update all call sites and references to use the new
name.
src/pages/base_page.py (1)

101-102: 🎯 Functional Correctness | 🔵 Trivial | ⚡ Quick win

Add missing semicolon and handle None for original_style.

When concatenating the original_style, there is no semicolon separating it from the new border style, which can result in invalid CSS (e.g., 1px solid greencolor: red;). Additionally, if the element has no style attribute, get_attribute("style") might return None, resulting in the string "None" being appended.

Consider handling None and ensuring proper CSS separation.

♻️ Proposed refactor
-        original_style = webelement.get_attribute("style")
-        new_style = f"background-color:yellow;border: 1px solid {color}{original_style}"
+        original_style = webelement.get_attribute("style") or ""
+        new_style = f"background-color:yellow;border: 1px solid {color}; {original_style}"
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/pages/base_page.py` around lines 101 - 102, Update the style construction
near original_style and new_style to treat a missing style attribute as an empty
string and insert a semicolon between the new border declaration and the
preserved original styles. Keep the existing background and border values
unchanged while ensuring the resulting CSS never appends the literal "None".
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/workflows/pr.yml:
- Around line 43-46: Update the pytest step in the workflow to pass BASE_URL
through the step’s env block, alongside EMAIL and PASSWORD, then reference the
environment variable in the run command instead of expanding vars.BASE_URL
directly. Preserve the existing pytest options and base URL behavior.

---

Outside diff comments:
In `@src/utilities/vrt_helper.py`:
- Around line 89-98: Update the check.equal call in the VRT tracking flow to
pass TestRunStatus.OK.name as its expected-value second argument, matching the
established usage in shoot_page and preserving the current tracked status as the
actual value.

---

Nitpick comments:
In `@src/pages/base_page.py`:
- Around line 101-102: Update the style construction near original_style and
new_style to treat a missing style attribute as an empty string and insert a
semicolon between the new border declaration and the preserved original styles.
Keep the existing background and border values unchanged while ensuring the
resulting CSS never appends the literal "None".

In `@src/utilities/vrt_helper.py`:
- Around line 60-62: Rename the VRT helper method shoot_page_ang_ignore_elements
to shoot_page_and_ignore_elements, correcting ang to and, and update all call
sites and references to use the new name.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: fff6c796-ce7b-4ef0-8223-45fa0ad0fdc5

📥 Commits

Reviewing files that changed from the base of the PR and between 2c78623 and 95be7c7.

📒 Files selected for processing (14)
  • .github/workflows/monthly.yml
  • .github/workflows/pr.yml
  • README.md
  • pyproject.toml
  • src/pages/base_page.py
  • src/utilities/excel_parser.py
  • src/utilities/mailinator_helper.py
  • src/utilities/vrt_helper.py
  • tests/conftest.py
  • tests/dependency_class_test.py
  • tests/dependency_test.py
  • tests/email_test.py
  • tests/login_test.py
  • tests/workspaces_test.py

Comment thread .github/workflows/pr.yml Outdated
@nirtal85
nirtal85 force-pushed the codex-modernize-ci-ruff branch from b8664f6 to 1083dcf Compare July 16, 2026 20:39
@nirtal85
nirtal85 force-pushed the codex-modernize-ci-ruff branch from 1083dcf to 3dca22a Compare July 16, 2026 20:42
@nirtal85
nirtal85 force-pushed the codex-modernize-ci-ruff branch from 3dca22a to dfc0f08 Compare July 16, 2026 20:45
@nirtal85
nirtal85 force-pushed the codex-modernize-ci-ruff branch from dfc0f08 to 02628be Compare July 16, 2026 20:48
@nirtal85
nirtal85 force-pushed the codex-modernize-ci-ruff branch from 02628be to 026f2f9 Compare July 16, 2026 20:53
@nirtal85
nirtal85 merged commit 1544566 into main Jul 16, 2026
6 checks passed
@nirtal85
nirtal85 deleted the codex-modernize-ci-ruff branch July 16, 2026 21:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant