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: updated limited run file for Tab spec #38426

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

Conversation

NandanAnantharamu
Copy link
Collaborator

@NandanAnantharamu NandanAnantharamu commented Dec 31, 2024

Summary by CodeRabbit

  • Tests
    • Updated the limited test specification to focus on a new tab widget scenario test instead of the previous JavaScript editor visual test.

Copy link
Contributor

coderabbitai bot commented Dec 31, 2024

Walkthrough

The pull request modifies the limited-tests.txt file in the Cypress testing environment, specifically changing the test specification path. The update replaces a visual JavaScript editor test with a new tab widget scenario test, indicating a shift in the testing focus for limited test runs.

Changes

File Change Summary
app/client/cypress/limited-tests.txt Replaced test specification path from JSEditorIndent_spec.js to Tab_new_scenario_spec.js

Possibly related PRs

Suggested labels

skip-changelog, ok-to-test, Test

Suggested reviewers

  • ApekshaBhosale
  • sagar-qa007

Poem

🧪 In the realm of tests, a path anew,
From editor's indent to tab's debut,
Cypress clicks, a scenario unfurls,
Limited tests dance, as code twirls!
A small change, yet a testing art 🔍


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 Dec 31, 2024
Copy link

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

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

Line range hint 1-6: Configuration change looks good.

The update to run Tab widget tests instead of JS Editor tests is straightforward and maintains the correct format.

Consider adding a comment explaining why this specific test was chosen for the limited run to help other developers understand the testing strategy.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between de2d5a4 and 7e715ec.

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

@@ -1,5 +1,5 @@
# To run only limited tests - give the spec names in below format:
cypress/e2e/Regression/ClientSide/VisualTests/JSEditorIndent_spec.js
cypress/e2e/Regression/ClientSide/Widgets/Tab/Tab_new_scenario_spec.js
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Test file needs the following improvements

  • Replace cy.wait(3000) with proper assertions or intercepts for tab content loading
  • Remove empty afterEach block if no cleanup is needed
  • Avoid using force: true in click events - fix element visibility instead
  • Consider adding error handling for modal interactions

The test follows most Cypress practices with proper visibility assertions, but these changes will make it more robust and maintainable.

🔗 Analysis chain

Verify the new test specification exists and follows guidelines.

Let's verify the existence and content of the new test file:


Test file needs improvements to follow Cypress best practices

The test file contains practices that should be avoided:

  • Usage of cy.wait(3000) which introduces flaky tests. Replace with cy.intercept() or appropriate assertions
  • Contains afterEach block which may need review for cleanup approach
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if the new test file exists and analyze its content
if [ -f "app/client/cypress/e2e/Regression/ClientSide/Widgets/Tab/Tab_new_scenario_spec.js" ]; then
    echo "File exists. Analyzing content..."
    
    # Check for prohibited practices
    echo "Checking for prohibited practices..."
    rg -i "cy\.wait|cy\.pause|agHelper\.sleep|it\.only|after\(|afterEach\(" "app/client/cypress/e2e/Regression/ClientSide/Widgets/Tab/Tab_new_scenario_spec.js"
    
    # Check for selector patterns
    echo "Checking selector patterns..."
    rg -i "\.btn\.submit|button\[type=submit\]|\$\('" "app/client/cypress/e2e/Regression/ClientSide/Widgets/Tab/Tab_new_scenario_spec.js"
    
    # Check for xpath usage
    echo "Checking for XPath usage..."
    rg -i "xpath|cy\.xpath" "app/client/cypress/e2e/Regression/ClientSide/Widgets/Tab/Tab_new_scenario_spec.js"
else
    echo "ERROR: Test file not found!"
fi

Length of output: 827


Script:

#!/bin/bash
# Let's check the full content of the test file to provide specific guidance
echo "Test file content:"
cat "app/client/cypress/e2e/Regression/ClientSide/Widgets/Tab/Tab_new_scenario_spec.js"

# Check for better practices like intercept usage
echo -e "\nChecking for recommended practices:"
rg -i "cy\.intercept|\.should\(|\.contains\(" "app/client/cypress/e2e/Regression/ClientSide/Widgets/Tab/Tab_new_scenario_spec.js"

Length of output: 2236

Copy link

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

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

@NandanAnantharamu
Copy link
Collaborator Author

/ci-test-limit-count run_count=50

Copy link

github-actions bot commented Jan 2, 2025

Copy link

github-actions bot commented Jan 2, 2025

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

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

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