Skip to content

Conversation

@oycyc
Copy link
Collaborator

@oycyc oycyc commented May 29, 2025

Describe your changes

  • Updated logging to include failure message even in the raw output
  • Updated linting / testing action

Reminder:

  • When the PR is ready, be sure to run npm run build to compile into the distribution /dist folder, which is the source code that the Action uses.

Summary by CodeRabbit

  • Chores

    • Added a CODEOWNERS file to define repository code ownership.
    • Updated workflow files for improved clarity, explicit permissions, and version pinning.
    • Adjusted workflow steps to ensure tests run regardless of previous step outcomes.
  • Documentation

    • Updated README with details about the new test_mode input parameter for configuring test execution.
  • Bug Fixes

    • Enhanced failure messages for OPA tests to include specific error details.

@coderabbitai
Copy link

coderabbitai bot commented May 29, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

A new CODEOWNERS file has been introduced, and the lint workflow has been refactored for clarity, explicit permissions, and version pinning. The test workflow was adjusted to ensure a step runs regardless of previous outcomes. The README now documents a new input parameter, and error messages in the action include more detailed output.

Changes

File(s) Change Summary
.github/CODEOWNERS Added CODEOWNERS file specifying repository code ownership rules.
.github/workflows/lint.yml Refactored workflow: renamed jobs, updated concurrency group, clarified permissions, pinned actions to SHAs.
.github/workflows/test.yml Modified a test step to run regardless of previous step outcomes using a conditional.
README.md Added documentation for new test_mode input parameter in usage example.
src/index.ts Enhanced failure message to include dynamic OPA error details in core.setFailed.

Sequence Diagram(s)

sequenceDiagram
    participant GitHub Actions
    participant Lint Workflow
    participant Test Workflow
    participant Action User
    participant OPA

    GitHub Actions->>Lint Workflow: Trigger on pull_request
    Lint Workflow->>Lint Workflow: Run lint job (with pinned versions)
    Lint Workflow->>Lint Workflow: Run conventional-title job

    GitHub Actions->>Test Workflow: Trigger test workflow
    Test Workflow->>Test Workflow: Run steps
    Test Workflow->>Test Workflow: Always run "Test Local Action" step

    Action User->>OPA: Run tests with test_mode (directory or file)
    OPA-->>Action User: Return test results or error
    Action User->>src/index.ts: Handle OPA error
    src/index.ts->>GitHub Actions: Report failure with detailed OPA error
Loading

Poem

In the warren, rules are clear,
CODEOWNERS now keep watch near.
Lint hops with names precise and new,
Tests run on, no matter the view.
README grows with modes to choose,
And errors now bring better news!
🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9eecaf7 and bb77a46.

⛔ Files ignored due to path filters (2)
  • dist/index.js is excluded by !**/dist/**
  • dist/index.js.map is excluded by !**/dist/**, !**/*.map
📒 Files selected for processing (5)
  • .github/CODEOWNERS (1 hunks)
  • .github/workflows/lint.yml (1 hunks)
  • .github/workflows/test.yml (1 hunks)
  • README.md (1 hunks)
  • src/index.ts (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

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
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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
Copy link
Contributor

github-actions bot commented May 29, 2025

Below is the Action testing on itself with this PR's source code against policies in /examples file by file. Confirm it is as expected.

File Status Passed Total Coverage Details
./examples/tests/track-using-labels_test.rego ✅ PASS 8 8 45.45%
Uncovered Lines3, 5, 12-13, 23-26, 35, 37-38, 41
Show Details✅ test_track_different_branches
✅ test_propose_non_empty_branch
✅ test_propose_empty_branch
✅ test_affected_directory
✅ test_affected_extension
✅ test_not_affected_directory
✅ test_not_affected_extension
✅ test_ignore_not_affected
./examples/tests/cancel-in-progress-runs_test.rego ✅ PASS 2 2 83.33%
Uncovered Lines16
Show Details✅ test_cancel_runs_allowed
✅ test_cancel_runs_denied
./examples/tests/enforce-module-use-policy_test.rego ✅ PASS 3 3 47.83%
Uncovered Lines37, 42, 46, 52, 54, 57, 60-61, 64, 68, 78, 80
Show Details✅ test_deny_creation_of_controlled_resource_type
✅ test_deny_update_of_controlled_resource_type
✅ test_allow_creation_of_uncontrolled_resource_type
./examples/tests/readers-writers-admins-teams_test.rego ✅ PASS 6 6 83.33%
Uncovered Lines16, 24, 28
Show Details✅ test_allow_writers
✅ test_allow_admins
✅ test_allow_readers
✅ test_space_admin_access
✅ test_space_write_access
✅ test_space_read_access
./examples/tests/do-not-delete-stateful-resources_test.rego ✅ PASS 5 5 85.71%
Uncovered Lines34
Show Details✅ test_deny_s3_bucket_deletion
✅ test_deny_db_instance_deletion
✅ test_deny_efs_file_system_deletion
✅ test_deny_dynamodb_table_deletion
✅ test_allow_instance_deletion
./examples/tests/enforce-password-length_test.rego ✅ PASS 3 3 90.91%
Uncovered Lines29
Show Details✅ test_deny_creation_of_password_with_less_than_16_characters
✅ test_warn_creation_of_password_between_16_and_20_characters
✅ test_allow_creation_of_password_longer_than_20_characters
./examples/tests/ignore-changes-outside-root_test.rego ✅ PASS 12 12 92.86%
Uncovered Lines42
Show Details✅ test_affected_no_files
✅ test_affected_tf_files
✅ test_affected_no_tf_files
✅ test_affected_outside_project_root
✅ test_ignore_affected
✅ test_ignore_not_affected
✅ test_ignore_tag
✅ test_propose_affected
✅ test_propose_not_affected
✅ test_track_affected
✅ test_track_not_affected
✅ test_track_not_stack_branch
./examples/tests/notification-stack-failure-origins_test.rego ✅ PASS 7 7 96.67%
Uncovered Lines80
Show Details✅ test_slack_notification_for_tracked_failed_run
✅ test_no_slack_notification_for_non_tracked_run
✅ test_no_slack_notification_for_successful_run
✅ test_slack_notification_with_unknown_github_user
✅ test_pr_comment_for_tracked_failed_run
✅ test_no_pr_comment_for_non_tracked_run
✅ test_no_pr_comment_for_successful_run
./examples/drift-detection.rego ⚠️ NO TESTS 0 0 N/A
Show DetailsNo test file found

Report generated by 🧪 GitHub Actions for OPA Rego Test

@github-actions
Copy link
Contributor

github-actions bot commented May 29, 2025

Below is the Action testing on itself with this PR's source code against /examples entire package directory. Confirm it is as expected.

File Status Passed Total Coverage Details
examples/tests/cancel-in-progress-runs_test.rego ✅ PASS 2 2 83.33%
Uncovered Lines16
Show Details✅ test_cancel_runs_allowed
✅ test_cancel_runs_denied
examples/tests/do-not-delete-stateful-resources_test.rego ✅ PASS 5 5 85.71%
Uncovered Lines34
Show Details✅ test_deny_s3_bucket_deletion
✅ test_deny_db_instance_deletion
✅ test_deny_efs_file_system_deletion
✅ test_deny_dynamodb_table_deletion
✅ test_allow_instance_deletion
examples/tests/enforce-module-use-policy_test.rego ✅ PASS 3 3 47.83%
Uncovered Lines37, 42, 46, 52, 54, 57, 60-61, 64, 68, 78, 80
Show Details✅ test_deny_creation_of_controlled_resource_type
✅ test_deny_update_of_controlled_resource_type
✅ test_allow_creation_of_uncontrolled_resource_type
examples/tests/enforce-password-length_test.rego ✅ PASS 3 3 90.91%
Uncovered Lines29
Show Details✅ test_deny_creation_of_password_with_less_than_16_characters
✅ test_warn_creation_of_password_between_16_and_20_characters
✅ test_allow_creation_of_password_longer_than_20_characters
examples/tests/ignore-changes-outside-root_test.rego ✅ PASS 12 12 92.86%
Uncovered Lines42
Show Details✅ test_affected_no_files
✅ test_affected_tf_files
✅ test_affected_no_tf_files
✅ test_affected_outside_project_root
✅ test_ignore_affected
✅ test_ignore_not_affected
✅ test_ignore_tag
✅ test_propose_affected
✅ test_propose_not_affected
✅ test_track_affected
✅ test_track_not_affected
✅ test_track_not_stack_branch
examples/tests/notification-stack-failure-origins_test.rego ✅ PASS 7 7 96.67%
Uncovered Lines80
Show Details✅ test_slack_notification_for_tracked_failed_run
✅ test_no_slack_notification_for_non_tracked_run
✅ test_no_slack_notification_for_successful_run
✅ test_slack_notification_with_unknown_github_user
✅ test_pr_comment_for_tracked_failed_run
✅ test_no_pr_comment_for_non_tracked_run
✅ test_no_pr_comment_for_successful_run
examples/tests/readers-writers-admins-teams_test.rego ✅ PASS 6 6 83.33%
Uncovered Lines16, 24, 28
Show Details✅ test_allow_writers
✅ test_allow_admins
✅ test_allow_readers
✅ test_space_admin_access
✅ test_space_write_access
✅ test_space_read_access
examples/tests/track-using-labels_test.rego ✅ PASS 8 8 86.36%
Uncovered Lines3, 12, 41
Show Details✅ test_track_different_branches
✅ test_propose_non_empty_branch
✅ test_propose_empty_branch
✅ test_affected_directory
✅ test_affected_extension
✅ test_not_affected_directory
✅ test_not_affected_extension
✅ test_ignore_not_affected#01
./examples/drift-detection.rego ⚠️ NO TESTS 0 0 N/A
Show DetailsNo test file found

Report generated by 🧪 GitHub Actions for OPA Rego Test

@github-actions
Copy link
Contributor

github-actions bot commented May 29, 2025

Coverage report

St.
Category Percentage Covered / Total
🟢 Statements 95.56% 86/90
🟢 Branches 92.59% 25/27
🟢 Functions 100% 8/8
🟢 Lines 96.63% 86/89

Test suite run success

15 tests passing in 1 suite.

Report generated by 🧪jest coverage report action from bb77a46

@oycyc oycyc changed the title chore: misc testing chore: up to date linting and codeowners and misc May 29, 2025
@oycyc oycyc marked this pull request as ready for review May 29, 2025 20:00
@oycyc oycyc merged commit 5484ca0 into main May 29, 2025
8 checks passed
@oycyc oycyc deleted the chore/housecleaning-misc branch May 29, 2025 20:00
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.

2 participants