test: fix failing gitsync tests #34214

NandanAnantharamu · 2024-06-12T14:09:22Z

RCA:
Test was failing because of hard wait
Also the dropdown element which was being clicked was failing

Solution:
Removed hard waits and replaced with intercept
Updated locator and better method to fix tests

EE PR: https://github.com/appsmithorg/appsmith-ee/pull/4413

Summary by CodeRabbit

Refactor
- Updated the method for merging changes to the master branch in Git sync tests for improved reliability.
Tests
- Revised Cypress test configurations and spec names for better organization and clarity.
- Enhanced the CheckMergeConflicts method to improve test accuracy and reliability by including element visibility checks and network status assertions.

coderabbitai · 2024-06-12T14:09:30Z

Walkthrough

The recent changes focus on improving the Git synchronization process within the Cypress test suite. The primary enhancement involves replacing the old merge method with a new, streamlined function. Additionally, the spec configuration for limited tests has been updated, and the CheckMergeConflicts method now includes more robust handling of element visibility and network status assertions.

Changes

File Path	Change Summary
`.../GitSync/GitSyncedApps_spec.js`	Replaced `cy.merge(mainBranch)` with `gitSync.MergeToMaster()` for merging changes to the master branch.
`.../cypress/limited-tests.txt`	Updated the spec name for limited tests to reflect the new Git synchronization test file.
`.../support/Pages/GitSync.ts`	Enhanced `CheckMergeConflicts` method to handle element visibility and assert network status.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CypressTest
    participant GitSync

    User->>CypressTest: Run Git Sync Test
    CypressTest->>GitSync: MergeToMaster()
    GitSync->>GitSync: Handle merge to master
    GitSync-->>CypressTest: Return merge status
    CypressTest-->>User: Display results

Poem

In the land of code so bright,
Git syncs now take flight.
Merging branches with delight,
Tests run smooth, day and night.
Cypress dances, elements in sight,
Network checks, all just right.

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>.
- 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.

NandanAnantharamu · 2024-06-12T14:11:38Z

/ci-test-limit

github-actions · 2024-06-12T14:12:15Z

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

coderabbitai

Actionable comments posted: 0

Outside diff range and nitpick comments (2)

app/client/cypress/limited-tests.txt (1)
Line range hint 7-7: Consider revising the comment for clarity:
- #ci-test-limit uses this file to run minimum of specs. Do not run entire suite with this command.
+ #ci-test-limit uses this file to run a minimum set of specs. Do not run the entire suite with this command.
app/client/cypress/e2e/Regression/ClientSide/Git/GitSync/GitSyncedApps_spec.js (1)
Line range hint 44-448: Consider converting function expressions to arrow functions for consistency and to align with modern JavaScript practices:
- it("1. Generate postgreSQL crud page , connect to git, clone the page, rename page with special character in it", function () {
+ it("1. Generate postgreSQL crud page , connect to git, clone the page, rename page with special character in it", () => {
Repeat this change for all similar instances in this file.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b61577d and 746e4e3.

Files selected for processing (3)

app/client/cypress/e2e/Regression/ClientSide/Git/GitSync/GitSyncedApps_spec.js (1 hunks)
app/client/cypress/limited-tests.txt (1 hunks)
app/client/cypress/support/Pages/GitSync.ts (2 hunks)

Additional context used

LanguageTool

app/client/cypress/limited-tests.txt

[uncategorized] ~7-~7: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE)
Context: ...ile to run minimum of specs. Do not run entire suite with this command.

Biome

app/client/cypress/e2e/Regression/ClientSide/Git/GitSync/GitSyncedApps_spec.js

[error] 44-448: This function expression can be turned into an arrow function. (lint/complexity/useArrowFunction)

Function expressions that don't use this can be turned into arrow functions.
Safe fix: Use an arrow function instead.

Additional comments not posted (4)

app/client/cypress/limited-tests.txt (1)

2-2: Updated spec name correctly focuses on Git synchronization tests.

app/client/cypress/e2e/Regression/ClientSide/Git/GitSync/GitSyncedApps_spec.js (1)

403-403: The method gitSync.MergeToMaster() is used correctly to streamline the merging process.

app/client/cypress/support/Pages/GitSync.ts (2)

40-41: Updated _mergeBranchDropdownmenu selector correctly targets the new element for merge operations.

385-389: Enhancements to the CheckMergeConflicts method improve the robustness of merge conflict checking by waiting for elements to appear or disappear and asserting network status.

github-actions · 2024-06-12T14:39:49Z

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

ApekshaBhosale · 2024-06-12T14:53:59Z

app/client/cypress/limited-tests.txt

@@ -1,5 +1,5 @@
 # To run only limited tests - give the spec names in below format:
-cypress/e2e/Regression/ClientSide/Templates/Fork_Template_spec.js
+cypress/e2e/Regression/ClientSide/Git/GitSync/GitSyncedApps_spec.js
