test: fix MaintainContext spec #36409

NandanAnantharamu · 2024-09-19T06:56:30Z

Summary by CodeRabbit

Bug Fixes
- Improved the reliability of context and focus tests within the IDE by ensuring the correct element is targeted during interactions.
Chores
- Updated the configuration for limited tests to prioritize testing for maintaining context and focus in the IDE.

coderabbitai · 2024-09-19T06:56:39Z

Walkthrough

This pull request introduces modifications to Cypress tests, specifically focusing on the selection mechanism for elements within the IDE. The test for maintaining context and focus has been refined to ensure that the first matching element is clicked, thereby enhancing test reliability. Additionally, the configuration for limited tests has been updated to prioritize this specific test, reflecting a shift in testing focus.

Changes

File	Change Summary
`app/client/cypress/e2e/Regression/ClientSide/IDE/MaintainContext&Focus_spec.js`	Updated element selection from `click()` to `first().click()` to target the first matching element.
`app/client/cypress/limited-tests.txt`	Changed the specified test file for limited tests from `Fork_Template_spec.js` to `MaintainContext&Focus_spec.js`.

Possibly related issues

[Bug]: flaky spec MaintainContext&Focus #36362: The changes in this PR address the flaky test issue reported, as the updated element selection should improve test stability.

Possibly related PRs

fix: Fixed flaky fork template test case #36200: This PR enhances reliability in Cypress tests through dynamic locators, similar to the changes made in this PR.
test: fix canvas context property pane #36356: This PR includes modifications related to the IDE, aligning with the focus of maintaining context within the IDE.

Suggested labels

skip-changelog, Test

Suggested reviewers

ApekshaBhosale
sagar-qa007

Poem

In the realm of tests, a change so bright,
Clicking the first, we set it right.
Context maintained, focus in sight,
Cypress now dances, with all its might!
Limited tests shift, priorities align,
In the world of code, everything's fine! 🎉

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 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 · 2024-09-19T06:57:10Z

/ci-test-limit

github-actions · 2024-09-19T06:57:41Z

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

coderabbitai

Actionable comments posted: 1

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 006dbfd and b0dea13.

Files selected for processing (2)

app/client/cypress/e2e/Regression/ClientSide/IDE/MaintainContext&Focus_spec.js (1 hunks)
app/client/cypress/limited-tests.txt (1 hunks)

Additional context used

Path-based instructions (2)

app/client/cypress/e2e/Regression/ClientSide/IDE/MaintainContext&Focus_spec.js (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.

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.

Additional comments not posted (1)

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

2-2: Excellent work on updating the limited test suite! 👏

The change in focus from the Fork_Template_spec.js to the MaintainContext&Focus_spec.js is a wise decision. It's crucial to prioritize testing the core functionality of maintaining context and focus within the IDE. This ensures a smooth and uninterrupted user experience.

Keep up the great work in refining our testing strategy! 🌟

coderabbitai · 2024-09-19T07:00:02Z

app/client/cypress/e2e/Regression/ClientSide/IDE/MaintainContext&Focus_spec.js

@@ -56,7 +56,7 @@ describe("MaintainContext&Focus", { tags: ["@tag.IDE"] }, function () {
    EditorNavigation.SelectEntityByName("Rest_Api_2", EntityType.Api);

    cy.wait(1000);
-    cy.xpath("//span[contains(text(), 'Headers')]").click();
+    cy.xpath("//span[contains(text(), 'Headers')]").first().click();


Avoid using XPaths for selectors, class. Use data- attributes instead.*

XPaths are brittle and can break easily if the structure of the DOM changes. It's best to use data-* attributes for more reliable and maintainable selectors.

NandanAnantharamu · 2024-09-19T10:57:47Z

/ci-test-limit-count run_count=25

github-actions · 2024-09-19T10:58:17Z

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

NandanAnantharamu · 2024-09-19T17:28:41Z

/ci-test-limit

github-actions · 2024-09-19T17:29:15Z

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

test: fix MaintainContext spec

b0dea13

NandanAnantharamu requested review from ApekshaBhosale and sagar-qa007 as code owners September 19, 2024 06:56

github-actions bot added skip-changelog Adding this label to a PR prevents it from being listed in the changelog Test labels Sep 19, 2024

coderabbitai bot reviewed Sep 19, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test: fix MaintainContext spec #36409

test: fix MaintainContext spec #36409

NandanAnantharamu commented Sep 19, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Sep 19, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

NandanAnantharamu commented Sep 19, 2024

github-actions bot commented Sep 19, 2024

coderabbitai bot left a comment

coderabbitai bot Sep 19, 2024

NandanAnantharamu commented Sep 19, 2024

github-actions bot commented Sep 19, 2024

NandanAnantharamu commented Sep 19, 2024

github-actions bot commented Sep 19, 2024

test: fix MaintainContext spec #36409

Are you sure you want to change the base?

test: fix MaintainContext spec #36409

Conversation

NandanAnantharamu commented Sep 19, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Sep 19, 2024 • edited Loading

Walkthrough

Changes

Possibly related issues

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

NandanAnantharamu commented Sep 19, 2024

github-actions bot commented Sep 19, 2024

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot Sep 19, 2024

Choose a reason for hiding this comment

NandanAnantharamu commented Sep 19, 2024

github-actions bot commented Sep 19, 2024

NandanAnantharamu commented Sep 19, 2024

github-actions bot commented Sep 19, 2024

NandanAnantharamu commented Sep 19, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Sep 19, 2024 •

edited

Loading