ci: Fix Cypress test fail not reported for /test command

[sharat87]

Gets common validation code for tags, for both /ok-to-test and /test commands. Currently, for invalid tags in /test command, we aren't updating the PR description with details of the tag parsing failure. This PR fixes that, after finally bringing all the logic into Javascript needed to solve this.

/test sanity

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/9715326227
Commit: 260ec18
Cypress dashboard.
Tags: ``

Summary by CodeRabbit

• Chores
  • Updated GitHub Actions workflow to trigger on 'release' and 'pg' branches for 'ok-to-test' labeled PRs.
  • Simplified tag parsing and validation logic in automation scripts.

[coderabbitai]

Walkthrough

These changes enhance the GitHub Actions workflow for pull requests by allowing them to trigger on multiple branches and simplifying tag parsing logic. The updates include branch listening expansion, conditional job execution, tag retrieval adjustments, and improved error handling. This results in a more streamlined and robust workflow.

Changes

File	Change Summary
.github/workflows/pr-automation.yml	Updated branch listening, added job conditions, renamed steps, and streamlined tag handling processes.
.../workflows/scripts/test-tag-parser.js	Restructured parseTags function with stricter validation and enhanced error handling.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant GitHub_Actions
    participant Workflow
    participant Job_ParseTags
    participant FinalOutput

    Developer->>GitHub_Actions: Create/Update PR
    GitHub_Actions->>Workflow: Trigger on branch release/pg with label 'ok-to-test'
    Workflow->>Job_ParseTags: Execute parseTags job if label is 'ok-to-test'
    Job_ParseTags->>Workflow: Parse tags from PR description
    Workflow->>FinalOutput: Output tags in the final step

Loading

Poem

🐇

A pull request lands with gentle grace,
On branches 'release' and 'pg', its place.
'Ok-to-test', we heed the call,
Parsing tags, we handle all.
Simplified steps, in code we trust,
Robust workflows, fair and just.
🌟

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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]

This PR has not seen activitiy for a while. It will be closed in 7 days unless further activity is detected.

[coderabbitai]

Actionable comments posted: 0

Outside diff range and nitpick comments (1)

.github/workflows/scripts/test-tag-parser.js (1)

Line range hint 23-81: Review of parseTags Function

• Regex Usage: The use of regex for matching tags is effective. However, consider adding comments to explain complex regex patterns for maintainability.
• Error Handling: The function throws errors for unknown tags and when no tags are found, which is good for ensuring data integrity.
• Potential Improvement: The loops and conditions could be refactored into smaller, more testable functions to improve readability and maintainability.

+ // Refactor suggestion to improve readability
+ function validateTag(part, allTags) {
+   if (!allTags.includes(part)) {
+     throw new Error("Unknown tag: " + part);
+   }
+ }
+ // Use the new function in the loop
+ for (const part of parts) {
+   validateTag(part, allTags);
+ }

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b692083 and 260ec18.

Files selected for processing (2)

• .github/workflows/pr-automation.yml (3 hunks)
• .github/workflows/scripts/test-tag-parser.js (2 hunks)

Additional comments not posted (3)

.github/workflows/scripts/test-tag-parser.js (1)

1-20: Review of Main Module Export Function

• Error Handling: The use of try-catch blocks for error handling is appropriate here, ensuring that any parsing errors are caught and handled gracefully. However, the error message could be more descriptive about what went wrong.
• Output Settings: The function sets outputs for both success and failure cases, which is good for clarity in CI logs.
• Comment on Line 19: The comment about removing code in a separate PR is a good practice to keep changes focused and manageable.

.github/workflows/pr-automation.yml (2)

5-7: Review of Trigger Branches in on Section

• Branches List: The addition of the 'pg' branch alongside 'release' allows for broader trigger coverage, aligning with the PR's intent to enhance CI operations across more branches.

---

14-14: Review of Steps in parse-tags Job

• Conditional Execution: The condition to only run the job if the 'ok-to-test' label is present is a good security measure to prevent unauthorized CI runs.
• Step Renaming: Renaming the step to 'Read tags from PR description' improves clarity on what the step does.
• Matrix Configuration: The dynamic configuration of the matrix based on the presence of '@tag.All' is a smart use of CI resources, scaling the test environment based on needs.
• Final Output: The use of dynamic tags in the final output step ensures that the workflow is responsive to the actual tags parsed, enhancing the accuracy of the CI process.

Also applies to: 32-32, 46-46, 62-62