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: To check flaky behaviour of General Admin settings #38710

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 in limited-tests configuration
    • Replaced one test file reference
    • Commented out Anvil widgets test path

Copy link
Contributor

coderabbitai bot commented Jan 16, 2025

Walkthrough

The pull request involves modifications to the limited-tests.txt file used for Cypress testing. A specific test file path has been updated, replacing JSEditorIndent_spec.js with General_settings_Spec.ts. Additionally, the line referencing all widgets under the Anvil directory has been commented out, effectively excluding those tests from the limited test suite.

Changes

File Change Summary
app/client/cypress/limited-tests.txt - Replaced test specification path from JSEditorIndent_spec.js to General_settings_Spec.ts
- Commented out Anvil widgets test specification

Possibly related PRs

Suggested Labels

skip-changelog, ok-to-test, Test

Suggested Reviewers

  • ApekshaBhosale
  • sagar-qa007

Poem

🧪 Cypress tests, a delicate dance
Paths shifting like a subtle glance
From JS to TS, we rearrange
Anvil's widgets take a brief estrange
In limited tests, our code's romance! 🔍


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

📒 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.
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: client-build / client-build
  • GitHub Check: client-prettier / prettier-check
🔇 Additional comments (2)
app/client/cypress/limited-tests.txt (2)

2-2: Verify test file existence and naming convention.

The new test file follows TypeScript naming conventions and aligns with the PR objective to test admin settings behavior.

✅ Verification successful

Test file verification successful

The test file exists and follows Cypress best practices with proper test organization, assertions, and feature flag handling.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify the test file exists and check its contents for Cypress best practices
fd "General_settings_Spec.ts" -t f | xargs cat | rg -i "cy\.(wait|pause)|agHelper\.sleep|it\.only|after(Each)?|\.btn\.submit"

Length of output: 125


Script:

#!/bin/bash
# Search for the test file with case-insensitive pattern
fd -i "general.*settings.*spec" 

# If file exists, examine its content for test structure
fd -i "general.*settings.*spec" -x cat {} \;

# Search for any settings-related spec files as fallback
fd -i "settings.*spec"

Length of output: 4437


5-5: Consider impact of excluding Anvil widget tests.

While focusing on admin settings tests, verify that commenting out Anvil widget tests doesn't impact the flaky behavior investigation.

✅ Verification successful

Excluding Anvil widget tests is safe for admin settings investigation

The Anvil tests are self-contained UI component tests with no dependencies on admin functionality. The only settings-related test is for app navigation, which is separate from admin settings.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if any Anvil widget tests are related to admin settings
fd -e ts -e js -t f . | xargs rg -l "admin.*settings.*anvil|anvil.*admin.*settings" 

Length of output: 85


Script:

#!/bin/bash
# First, find all Anvil widget test files
echo "=== Anvil Widget Test Files ==="
fd -e cy.ts -e cy.js "." cypress/e2e/Regression/ClientSide/Anvil/Widgets/

# Then check their content for admin-related terms with context
echo -e "\n=== Admin-related content in Anvil tests ==="
rg -l "admin" cypress/e2e/Regression/ClientSide/Anvil/Widgets/ || true

# Check for shared test utilities
echo -e "\n=== Shared utilities used by Anvil tests ==="
rg -l "import.*anvil" cypress/e2e/Regression/ClientSide/ || true

Length of output: 792


Script:

#!/bin/bash
# First, find the cypress directory structure
echo "=== Cypress Directory Structure ==="
fd -t d "cypress" app/client

# Then find all Anvil-related test files
echo -e "\n=== Anvil-related Test Files ==="
fd -t f ".*\.(cy|spec)\.(js|ts)$" app/client | rg -i "anvil"

# Look for admin-related content in any Anvil files
echo -e "\n=== Admin Content in Anvil Files ==="
rg -l "admin" app/client | rg -i "anvil"

Length of output: 399


Script:

#!/bin/bash
# Check for Anvil-related files in cypress directory
echo "=== Anvil Files in Cypress ==="
fd . app/client/cypress/e2e -t f | rg -i "anvil"

# Look for test dependencies between Anvil and admin
echo -e "\n=== Test Dependencies ==="
rg -C 2 "admin|settings" app/client/cypress/e2e 2>/dev/null | rg -i -C 2 "anvil"

# Check for shared test utilities or fixtures
echo -e "\n=== Shared Test Resources ==="
fd . app/client/cypress/support app/client/cypress/fixtures -t f | rg -i "anvil"

Length of output: 5611


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.

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

/ci-test-limit-count run_count=50

Copy link

Copy link

Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/12812357876.
Cypress dashboard: Click here!
The following are new failures, please fix them before merging the PR:
To know the list of identified flaky tests - Refer here

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

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 Test
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant