test: updated flow for GitSync #34239

NandanAnantharamu · 2024-06-14T05:12:28Z

RCA:
Click on the dropdown was not working intermittently

Solution:
updated the flow,

Wait for the destination dropdown
Click on the destination dropdown
Assert the branch name visible post dropdown has opened
Click on the destination branch

Summary by CodeRabbit

Bug Fixes
- Enhanced the mergeBranch process in GitSync to ensure better stability and accuracy by adding assertions for element appearances, disappearances, network status, and the presence of a destination branch.
Tests
- Switched limited test spec from Fork_Template_spec.js to GitSyncedApps_spec.js and added GitBugs_Spec.ts for improved test coverage and accuracy.
Refactor
- Changed className attribute to data-testid in the Select component within the GitSync merge tab for improved testing and readability.

coderabbitai · 2024-06-14T05:12:35Z

Walkthrough

The recent changes primarily focus on enhancing the functionality and reliability of the GitSync class within the Cypress support Pages. Key updates include improved assertions within the mergeBranch method to ensure elements appear/disappear correctly and the network status is verified. Additionally, testing files have been updated to expand coverage, including switching specific test specs and adding new ones. Visual components in the Editor module were fine-tuned for better testability by altering attribute selectors.

Changes

File Path	Description
app/client/cypress/support/Pages/GitSync.ts	Updated `mergeBranch` method to include additional assertions and element checks
app/client/cypress/limited-tests.txt	Switched test spec from `Fork_Template_spec.js` to `GitSyncedApps_spec.js`, added `GitBugs_Spec.ts`
app/client/src/pages/Editor/gitSync/Tabs/Merge.tsx	Changed `className` attribute to `data-testid` in the `Select` component

Sequence Diagram(s)

sequenceDiagram
    participant TestRunner as Cypress Test Runner
    participant GitSync as GitSync Class
    participant Network as Network Status

    TestRunner->>GitSync: Call mergeBranch()
    GitSync->>GitSync: Wait until _mergeBranchDropdownmenu appears
    GitSync->>Network: Assert network status
    GitSync->>GitSync: Verify _mergeBranchDropdownmenu disappearance
    GitSync->>GitSync: Verify destination branch presence
    GitSync-->>TestRunner: Return result

Poem

In the codebase where we sync,
Changes weave, our work in sync.
Assertions now stand tall and proud,
In Cypress tests, they're now avowed.
Branches merge with greater grace,
As elements fall in their place.
🎉 Our testing flows, no errors brace! 🐇

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-14T05:13:00Z

/ci-test-limit

github-actions · 2024-06-14T05:13:32Z

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

coderabbitai

Actionable comments posted: 0

Outside diff range and nitpick comments (5)

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

Line range hint 1-1: Consider removing the commented out GITEA_API_BASE if it is no longer needed. Keeping unused code can lead to confusion and clutter in the codebase.

Line range hint 175-183: This block of code is responsible for creating and connecting to a Git repository. It's important to handle potential errors in network requests and provide feedback to the user or system if something goes wrong.

Consider adding error handling for the network requests in the CreateNConnectToGit method to improve robustness and user experience.

Line range hint 200-220: The ImportAppFromGit method appears to be handling keys and making network requests without error handling. This could lead to unhandled exceptions if the network requests fail.

Add error handling for the network requests in the ImportAppFromGit method to ensure stability and provide clear feedback during failures.

Line range hint 344-367: The method SwitchGitBranch uses a hardcoded delay which can lead to brittle tests if the expected state is not reached within the timeout. Consider using dynamic waits or polling to check for the state.

Refactor the hardcoded delay in SwitchGitBranch to use dynamic waits or polling mechanisms to enhance test reliability.

Line range hint 370-370: The method CheckMergeConflicts uses a direct call to AssertElementAbsence which might not handle cases where the element takes longer than expected to disappear. Consider adding a timeout parameter to this assertion for better reliability.

Refactor AssertElementAbsence in CheckMergeConflicts to accept a timeout parameter, allowing for more flexible and reliable checks.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between dae657e and da556d7.

Files selected for processing (1)

app/client/cypress/support/Pages/GitSync.ts (1 hunks)

Additional comments not posted (1)

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

390-390: The change from _dropdownmenu to _mergeBranchDropdownmenu in the method GetNClickByContains appears to be aligned with the PR objectives. Ensure that this new locator is correctly functioning in all scenarios where it is used.

github-actions · 2024-06-14T05:32:05Z

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

NandanAnantharamu · 2024-06-14T05:34:34Z