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

fix: Renaming tests with error expectations #38021

Merged
merged 3 commits into from
Dec 7, 2024
Merged

Conversation

hetunandu
Copy link
Member

@hetunandu hetunandu commented Dec 6, 2024

Description

Update renaming tests for tabs when error expectations need to be asserted

Automation

/ok-to-test tags="@tag.IDE, @tag.Datasource"

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/12199824922
Commit: 47dddde
Cypress dashboard.
Tags: @tag.IDE, @tag.Datasource
Spec:


Fri, 06 Dec 2024 14:30:54 UTC

Communication

Should the DevRel and Marketing teams inform users about this change?

  • Yes
  • No

Summary by CodeRabbit

  • Bug Fixes

    • Streamlined the API renaming and validation process for improved accuracy and efficiency.
  • New Features

    • Enhanced error handling capabilities in the API renaming process, allowing for more graceful management of error scenarios.
    • Introduced new interfaces for better handling of widget interactions and validations.
  • Refactor

    • Consolidated multiple steps in API name validation into single method calls for improved clarity and efficiency.
  • Style

    • Minor formatting changes for improved readability.

Copy link
Contributor

coderabbitai bot commented Dec 6, 2024

Walkthrough

The changes in this pull request involve modifications to the Cypress test cases and support files related to API name validation and renaming functionality. The test for renaming an API has been streamlined by consolidating multiple calls into a single method. Additionally, the support files have been updated to enhance error handling and modularity, including the introduction of new interfaces and adjustments to existing method signatures. These updates improve the clarity and efficiency of the code without introducing new functionalities.

Changes

File Path Change Summary
app/client/cypress/e2e/Regression/ClientSide/ExplorerTests/Entity_Naming_conflict_spec.js Updated the test case for renaming an API to replace cy.RenameEntity(apiName) and cy.validateMessage(apiName) with cy.CreationOfUniqueAPIcheck(apiName), consolidating functionality for entity renaming and validation.
app/client/cypress/support/ApiCommands.js Modified CreationOfUniqueAPIcheck and CreateApiAndValidateUniqueEntityName to consolidate RenameQuery calls, now passing both API name and error message as parameters. Added two JSON locator imports for modularity.
app/client/cypress/support/Pages/AggregateHelper.ts Added SubActionParams and SelectAndValidateParams interfaces. Updated RenameQuery and rename method signatures to include an optional willFailError parameter for improved error handling and control flow adjustments.

Suggested labels

skip-changelog, Test, IDE Product, IDE Pod

Suggested reviewers

  • ApekshaBhosale
  • sagar-qa007

🎉 In the realm of code, where functions dance,
A rename was streamlined, given a chance.
With parameters added, and logic refined,
The tests now flow smoothly, perfectly aligned.
So here's to the changes, both clever and bright,
In the world of development, all feels just right! 🎈


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 280be35 and 47dddde.

📒 Files selected for processing (1)
  • app/client/cypress/support/ApiCommands.js (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • app/client/cypress/support/ApiCommands.js

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.

@github-actions github-actions bot added the Bug Something isn't working label Dec 6, 2024
@hetunandu hetunandu added the ok-to-test Required label for CI label Dec 6, 2024
sagar-qa007
sagar-qa007 previously approved these changes Dec 6, 2024
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/support/Pages/AggregateHelper.ts (1)

Line range hint 235-258: Consider enhancing error handling structure

While the error handling addition is good, consider refactoring to improve readability and maintainability.

-    if (args.willFailError) {
-      this.AssertContains(args.willFailError, "exist", ".ads-v2-tooltip");
-      cy.get(textInputLocator).blur();
-    } else {
-      cy.get(textInputLocator).blur();
-      this.PressEnter();
-    }
+    cy.get(textInputLocator).blur();
+    
+    if (args.willFailError) {
+      this.AssertContains(args.willFailError, "exist", ".ads-v2-tooltip");
+      return;
+    }
+    
+    this.PressEnter();
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 5707f67 and 280be35.

📒 Files selected for processing (1)
  • app/client/cypress/support/Pages/AggregateHelper.ts (7 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
app/client/cypress/support/Pages/AggregateHelper.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.
🔇 Additional comments (3)
app/client/cypress/support/Pages/AggregateHelper.ts (3)

19-26: Well-structured interfaces for test automation!

The new interfaces SubActionParams and SelectAndValidateParams are well-defined with proper TypeScript types and optional properties.


271-277: LGTM: Consistent method signature update

The RenameQuery method has been properly updated to handle error cases, maintaining consistency with the rename method changes.


952-952: Skip: Formatting change

@hetunandu hetunandu merged commit ef0ef1b into release Dec 7, 2024
42 checks passed
@hetunandu hetunandu deleted the fix/rename-test-fix branch December 7, 2024 11:58
github-actions bot pushed a commit to Zeral-Zhang/appsmith that referenced this pull request Dec 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working ok-to-test Required label for CI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants