Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test:check flaky behaviour of Deletebranch spec #38711

Open
wants to merge 1 commit into
base: release
Choose a base branch
from

Conversation

NandanAnantharamu
Copy link
Collaborator

@NandanAnantharamu NandanAnantharamu commented Jan 16, 2025

Summary by CodeRabbit

  • Tests
    • Updated Cypress test specifications
    • Replaced JSEditor indentation test with Git branch deletion test
    • Commented out Anvil Widgets tests from limited test run

Copy link
Contributor

coderabbitai bot commented Jan 16, 2025

Walkthrough

The pull request modifies the limited-tests.txt file in the Cypress testing configuration. The changes involve replacing a JSEditor indentation test with a new Git branch deletion test and commenting out the Anvil Widgets test specifications. This adjustment appears to be a strategic modification of the test suite's focus, prioritizing Git synchronization testing while temporarily excluding Anvil Widgets tests.

Changes

File Change Summary
app/client/cypress/limited-tests.txt - Replaced JSEditor indentation test with Git branch deletion test
- Commented out Anvil Widgets test path

Possibly related PRs

Suggested Labels

Bug, ok-to-test, Test

Suggested Reviewers

  • ApekshaBhosale
  • brayn003

Poem

🌿 In the realm of tests, a branch must go
Git's delete dance, a careful flow
Cypress clicks, specs rearrange
Testing paths that softly change
Code's ballet, a gentle show! 🧪


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 56f968f and 0b3e1b3.

📒 Files selected for processing (1)
  • app/client/cypress/limited-tests.txt (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
app/client/cypress/limited-tests.txt (1)

Pattern app/client/cypress/**/**.*: Review the following e2e test code written using the Cypress test library. Ensure that:

  • Follow best practices for Cypress code and e2e automation.
  • Avoid using cy.wait in code.
  • Avoid using cy.pause in code.
  • Avoid using agHelper.sleep().
  • Use locator variables for locators and do not use plain strings.
  • Use data-* attributes for selectors.
  • Avoid Xpaths, Attributes and CSS path.
  • Avoid selectors like .btn.submit or button[type=submit].
  • Perform logins via API with LoginFromAPI.
  • Perform logout via API with LogOutviaAPI.
  • Perform signup via API with SignupFromAPI.
  • Avoid using it.only.
  • Avoid using after and aftereach in test cases.
  • Use multiple assertions for expect statements.
  • Avoid using strings for assertions.
  • Do not use duplicate filenames even with different paths.
  • Avoid using agHelper.Sleep, this.Sleep in any file in code.
📓 Learnings (1)
app/client/cypress/limited-tests.txt (1)
Learnt from: brayn003
PR: appsmithorg/appsmith#36622
File: app/client/cypress/e2e/Regression/ClientSide/Git/GitPersistBranch_spec.ts:41-45
Timestamp: 2024-11-12T08:11:36.416Z
Learning: In `app/client/cypress/**/**.*` Cypress test files, the cleanup guideline is to use `after` hooks for cleanup tasks.
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: client-unit-tests / client-unit-tests
  • GitHub Check: client-lint / client-lint
  • GitHub Check: client-prettier / prettier-check
  • GitHub Check: client-build / client-build
🔇 Additional comments (2)
app/client/cypress/limited-tests.txt (2)

5-5: Confirm the intention to exclude Anvil Widget tests.

Please verify if commenting out the Anvil Widget tests is intentional as part of reducing the test scope for investigating the DeleteBranch spec's flaky behavior.


2-2: 💡 Codebase verification

Test implementation needs stability improvements

Several potential sources of flakiness identified in the DeleteBranch spec:

  • Replace arbitrary cy.wait() calls with proper assertions or cy.intercept()
  • Avoid using { force: true } with clicks
  • Remove timing-dependent mouse interactions in DeleteBranchFromUI()
🔗 Analysis chain

Verify the stability of DeleteBranch spec.

Given that the PR title mentions "flaky behaviour", let's verify the implementation of this test spec for potential sources of flakiness.

Let's analyze the test implementation:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for common causes of flakiness in the DeleteBranch spec
rg -A 5 "cy\.wait|\.sleep|\.pause" "cypress/e2e/Regression/ClientSide/Git/GitSync/DeleteBranch_spec.js"

# Check for proper selector usage
rg "\.btn\.|button\[|xpath=|\.contains\(" "cypress/e2e/Regression/ClientSide/Git/GitSync/DeleteBranch_spec.js"

# Check for proper cleanup
ast-grep --pattern 'after($$$)' "cypress/e2e/Regression/ClientSide/Git/GitSync/DeleteBranch_spec.js"

Length of output: 643


Script:

#!/bin/bash
# Search for files with similar names
fd -t f "DeleteBranch.*\.js" app/client/cypress

# Search for references to this file
rg -l "DeleteBranch_spec" app/client/cypress

# List all Git-related test files
fd -t f "Git.*\.js$" app/client/cypress/e2e

Length of output: 842


Script:

#!/bin/bash
# Check for wait mechanisms and timing-related code
rg -A 5 "cy\.wait|\.sleep|\.pause" "app/client/cypress/e2e/Regression/ClientSide/Git/GitSync/DeleteBranch_spec.js"

# Check for selector usage
rg "\.btn\.|button\[|xpath=|\.contains\(" "app/client/cypress/e2e/Regression/ClientSide/Git/GitSync/DeleteBranch_spec.js"

# Check for cleanup hooks
ast-grep --pattern 'after($$$)' "app/client/cypress/e2e/Regression/ClientSide/Git/GitSync/DeleteBranch_spec.js"

# Get the full test content for context
cat "app/client/cypress/e2e/Regression/ClientSide/Git/GitSync/DeleteBranch_spec.js"

Length of output: 7201

⛔ Skipped due to learnings
Learnt from: brayn003
PR: appsmithorg/appsmith#38635
File: app/client/cypress/e2e/Regression/ClientSide/Git/GitSync/MergeViaRemote_spec.ts:102-102
Timestamp: 2025-01-13T15:14:12.806Z
Learning: In Cypress Git sync tests, explicit assertions after _.gitSync.SwitchGitBranch() are not required as the helper method likely handles the verification internally.
Learnt from: brayn003
PR: appsmithorg/appsmith#38635
File: app/client/cypress/e2e/Regression/ClientSide/Git/GitSync/MergeViaRemote_spec.ts:81-82
Timestamp: 2025-01-13T15:14:42.085Z
Learning: In Cypress test files, unsafe optional chaining is acceptable when the intention is for the test to fail if the expected data structure is not present, as it helps validate the API response structure.
Learnt from: brayn003
PR: appsmithorg/appsmith#36622
File: app/client/cypress/e2e/Regression/ClientSide/Git/GitPersistBranch_spec.ts:41-45
Timestamp: 2024-11-12T08:11:36.416Z
Learning: In `app/client/cypress/**/**.*` Cypress test files, the cleanup guideline is to use `after` hooks for cleanup tasks.
Learnt from: brayn003
PR: appsmithorg/appsmith#38635
File: app/client/cypress/e2e/Regression/ClientSide/Git/GitSync/MergeViaRemote_spec.ts:52-58
Timestamp: 2025-01-13T15:15:05.763Z
Learning: The Git sync helper functions (_.gitSync.CommitAndPush, _.gitSync.MergeToMaster) in Cypress tests already include built-in assertions, so additional explicit assertions after these calls are not needed.

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>, please review it.
    • 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 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 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 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. (Beta)
  • @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.

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
Copy link
Collaborator Author

/ci-test-limit-count run_count=50

@github-actions github-actions bot added skip-changelog Adding this label to a PR prevents it from being listed in the changelog Test labels Jan 16, 2025
Copy link

Copy link

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

***** Repeat Run Summary ***** Total Tests with repeat: 200 Total Passed: 114 Total Failed: 36 Total Skipped: 0 *****************************

Copy link

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

@github-actions github-actions bot added the Stale label Jan 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog Adding this label to a PR prevents it from being listed in the changelog Stale Test
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant