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: Enable skipped test related to Autocomplete #36991

Merged
merged 2 commits into from
Oct 23, 2024

Conversation

NandanAnantharamu
Copy link
Collaborator

@NandanAnantharamu NandanAnantharamu commented Oct 21, 2024

EE PR: https://github.com/appsmithorg/appsmith-ee/pull/5409

/ok-to-test tags="@tag.Sanity"

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/11474508904
Commit: 79acd59
Cypress dashboard.
Tags: @tag.Sanity
Spec:


Wed, 23 Oct 2024 08:03:14 UTC

Copy link
Contributor

coderabbitai bot commented Oct 21, 2024

Walkthrough

The pull request introduces modifications to the Cypress test suite for JavaScript autocomplete functionality. It activates a previously skipped test case related to Bug #15429, ensuring that random keystrokes triggering autocomplete suggestions are now tested. Additionally, the path for the test specification in the limited-tests.txt file is updated to reflect a focus shift towards the JS_AC2_spec.ts file, which pertains to the Autocomplete feature.

Changes

File Path Change Summary
app/client/cypress/e2e/Regression/ClientSide/Autocomplete/JS_AC2_spec.ts Unskipped test case for Bug #15429, enabling its execution in the test suite.
app/client/cypress/limited-tests.txt Updated test specification path from Fork_Template_spec.js to JS_AC2_spec.ts, indicating a focus shift.

Possibly related PRs

Suggested labels

Bug, ok-to-test, Test, skip-changelog

Suggested reviewers

  • ApekshaBhosale
  • sagar-qa007
  • brayn003

🎉 In the land of code where tests do play,
A bug once skipped now joins the fray.
Autocomplete's magic, with keystrokes in sight,
Brings forth suggestions, oh what a delight!
From Forks to Autocomplete, the tests now align,
In the realm of Cypress, our code will shine! 🌟


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

/ci-test-limit-count run_count=25

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: 0

🧹 Outside diff range and nitpick comments (1)
app/client/cypress/e2e/Regression/ClientSide/Autocomplete/JS_AC2_spec.ts (1)

Line range hint 114-186: Improve test case implementation for Bug #15429

The test case for Bug #15429 has been unskipped, which is good for increasing test coverage. However, there are a few areas for improvement:

  1. Remove agHelper.Sleep() calls as they are against the coding guidelines. Use Cypress's built-in waiting mechanisms instead.
  2. Use data-* attributes for selectors instead of relying on class names or element types.
  3. Avoid using string literals for assertions. Consider using constants or enums for expected values.

Here's an example of how you could refactor a part of the test:

const NO_HINTS_MESSAGE = "No autocomplete hints should be present";

// Instead of:
agHelper.AssertElementAbsence(locators._hints);

// Use:
cy.get('[data-cy="autocomplete-hints"]').should('not.exist').then(() => {
  cy.log(NO_HINTS_MESSAGE);
});

This approach improves readability and maintainability of the test case.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 631abe8 and 66e0e61.

📒 Files selected for processing (2)
  • app/client/cypress/e2e/Regression/ClientSide/Autocomplete/JS_AC2_spec.ts (1 hunks)
  • app/client/cypress/limited-tests.txt (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
app/client/cypress/e2e/Regression/ClientSide/Autocomplete/JS_AC2_spec.ts (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 (1)
app/client/cypress/limited-tests.txt (1)

2-2: LGTM. Verify the new test specification.

The change aligns with the PR objectives. Ensure that the new test specification JS_AC2_spec.ts includes the activated test case for Bug #15429.

✅ Verification successful

File app/client/cypress/limited-tests.txt Verification Failed

The new test specification file cypress/e2e/Regression/ClientSide/Autocomplete/JS_AC2_spec.ts does not exist.

  • Action Required:
    • Verify the correct path of the new test specification.
    • Ensure that the file has been added to the repository.

Verify JS_AC2_spec.ts Includes Test for Bug #15429


Test Specification for Bug #15429 Verified

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify the content of the new test specification
rg -A 10 "Bug #15429" "cypress/e2e/Regression/ClientSide/Autocomplete/JS_AC2_spec.ts"

Length of output: 187


Script:

#!/bin/bash
# Search for the JS_AC2_spec.ts file in the repository
fd "JS_AC2_spec.ts"

Length of output: 92


Script:

#!/bin/bash
# Verify the presence of "Bug #15429" in the test specification
rg "Bug #15429" "app/client/cypress/e2e/Regression/ClientSide/Autocomplete/JS_AC2_spec.ts"

Length of output: 170

Copy link

Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/11437028886.
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: 75 Total Passed: 75 Total Failed: 0 Total Skipped: 0 *****************************

@NandanAnantharamu NandanAnantharamu changed the title check skipped test test: Enable skipped test related to Autocomplete Oct 22, 2024
@github-actions github-actions bot added skip-changelog Adding this label to a PR prevents it from being listed in the changelog Test labels Oct 22, 2024
@NandanAnantharamu NandanAnantharamu added the ok-to-test Required label for CI label Oct 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ok-to-test Required label for CI 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.

2 participants