appsmith icon indicating copy to clipboard operation
appsmith copied to clipboard
verified publisher icon appsmithorg

Do not merge : Fix/testprcomment

Open sagar-qa007 opened this issue 1 year ago • 9 comments

Description

Challenge: In our existing process, when users performed a limited run with a specified count, the results were recorded solely in the logs. This approach introduced an additional step, requiring users to manually navigate through each workflow to check the results, which was both time-consuming and prone to oversight.

Solution: To address this inefficiency, I took the initiative to develop a custom npm library specifically designed to enhance the user experience. This library automates the generation of a summary file that consolidates the run data into a single, easily accessible document. Furthermore, I integrated this solution into our existing workflow by updating the process to automatically post the contents of this summary file as a comment on the relevant PR upon completion of the run.

This improvement not only streamlines the workflow by eliminating the need for users to manually sift through logs, but it also ensures that critical information is immediately available at a glance. By centralizing the results in the PR comments, we’ve enhanced transparency and efficiency, allowing for quicker decision-making and more effective collaboration. This solution is a step forward in optimizing our processes and reducing the manual effort required to track and assess test outcomes.

Looks like this:

Screenshot 2024-08-28 at 11 06 37 AM

Fixes #35920

Automation

/ok-to-test tags=""

:mag: Cypress test results

[!WARNING] Tests have not run on the HEAD 16534b42f2011fb27a2f60767d737f3695d04bab yet

Wed, 28 Aug 2024 06:54:24 UTC

Communication

Should the DevRel and Marketing teams inform users about this change?

  • [ ] Yes
  • [x] No

Summary by CodeRabbit

  • Chores
    • Updated test specifications to focus on the "Dynamic Height" feature of the "Text Widget."
    • Maintained existing comment structure for clarity on running tests.
    • Upgraded the CI workflow to utilize an enhanced version of the Cypress repeat functionality for improved test execution.

sagar-qa007 avatar Aug 28 '24 06:08 sagar-qa007

Walkthrough

The changes involve updating the test specifications for Cypress limited tests, transitioning the focus from the "Fork Template" functionality to the "Dynamic Height" feature of the "Text Widget." This is evidenced by the renaming of the test specification file. Additionally, the CI workflow configuration has been modified to utilize a different command for running Cypress tests, indicating an upgrade in the testing tool.

Changes

File Change Summary
cypress/e2e/Regression/ClientSide/Templates/Fork_Template_spec.js → cypress/e2e/Regression/ClientSide/DynamicHeight/TextWidget_Spec.ts
.github/workflows/ci-test-limited-with-count.yml: Command changed from npx cypress-repeat run to npx cypress-repeat-pro run

Poem

In the land of code where tests reside,
A widget's height now takes the stride.
From forks to heights, the focus shifts,
In Cypress realms, we make our gifts.
So raise a cheer for changes bright,
As we test anew, with all our might! 🎉

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.

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.

coderabbitai[bot] avatar Aug 28 '24 06:08 coderabbitai[bot]

/ci-test-limit-count run_count=1

sagar-qa007 avatar Aug 28 '24 06:08 sagar-qa007

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/10591443733. Cypress dashboard PR: #35924.

github-actions[bot] avatar Aug 28 '24 06:08 github-actions[bot]

/ci-test-limit-count run_count=1

sagar-qa007 avatar Aug 28 '24 07:08 sagar-qa007

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/10592447710. Cypress dashboard PR: #35924.

github-actions[bot] avatar Aug 28 '24 07:08 github-actions[bot]

Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/10592447710. Cypress dashboard url: Click here! All cypress tests have passed 🎉🎉🎉

***** Repeat Run Summary ***** Total Tests with repeat: 1 Total Passed: 1 Total Failed: 0 Total Skipped: 0 *****************************

github-actions[bot] avatar Aug 28 '24 08:08 github-actions[bot]

/ci-test-limit-count run_count=4

sagar-qa007 avatar Aug 28 '24 08:08 sagar-qa007

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/10592892376. Cypress dashboard PR: #35924.

github-actions[bot] avatar Aug 28 '24 08:08 github-actions[bot]

Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/10592892376. Cypress dashboard url: Click here! All cypress tests have passed 🎉🎉🎉

***** Repeat Run Summary ***** Total Tests with repeat: 4 Total Passed: 4 Total Failed: 0 Total Skipped: 0 *****************************

github-actions[bot] avatar Aug 28 '24 08:08 github-actions[bot]

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

github-actions[bot] avatar Sep 04 '24 16:09 github-actions[bot]