test: Api curl remaining cases #38753
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WalkthroughThis pull request introduces a new Cypress end-to-end test file Changes
Sequence DiagramsequenceDiagram
participant User
participant APIPanel
participant RunButton
User->>APIPanel: Enter API details
alt Empty Fields
APIPanel-->>RunButton: Disable Run Button
end
User->>APIPanel: Enter Invalid URL
User->>APIPanel: Click Import
APIPanel-->>User: Display Error Message
User->>APIPanel: Focus on Data Source
User->>APIPanel: Cmd + Enter
APIPanel->>RunButton: Trigger Run
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (7)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
github-actions
bot
added
skip-changelog
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
app/client/cypress/e2e/Regression/ServerSide/ApiTests/API_RunValidations_spec.ts (2)
9-12: Consider using a more descriptive test suite name.The current description "API Panel request body" could be more specific about what aspects are being tested, e.g., "API Panel Run Button and URL Validation Tests".
13-16: Add more assertions for comprehensive validation.While the test checks for button disability, consider adding assertions for:
- Button state before API creation
- Visual indicators of the disabled state
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
app/client/cypress/e2e/Regression/ServerSide/ApiTests/API_RunValidations_spec.ts(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
app/client/cypress/e2e/Regression/ServerSide/ApiTests/API_RunValidations_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.
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: perform-test / rts-build / build
- GitHub Check: perform-test / server-build / server-unit-tests
- GitHub Check: client-unit-tests / client-unit-tests
- GitHub Check: client-prettier / prettier-check
🔇 Additional comments (1)
app/client/cypress/e2e/Regression/ServerSide/ApiTests/API_RunValidations_spec.ts (1)
1-8: LGTM! Clean imports following best practices.
Comment on lines
+18
to
+26
| it('2. Validate we get an appropriate error message when an invalid URL is entered. Error should show up when nothing is entered & we click on "Import".', function () { | ||
| apiPage.CreateAndFillApi( | ||
| "htt://failedurlfortest", | ||
| "WhatTrumpThinks", | ||
| "SecondAPI", | ||
| ); | ||
| agHelper.GetNClick(apiPage._apiRunBtn, 0, true, 10000); | ||
| apiPage.ResponseStatusCheck("PE-RST-5000"); | ||
| }); |
There was a problem hiding this comment.
Replace GetNClick wait time with proper assertions.
The use of hardcoded wait time (10000) in GetNClick violates the Cypress best practices.
Replace with:
- agHelper.GetNClick(apiPage._apiRunBtn, 0, true, 10000);
+ agHelper.GetNAssertElementPresence(apiPage._apiRunBtn)
+ agHelper.GetNClick(apiPage._apiRunBtn);📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| it('2. Validate we get an appropriate error message when an invalid URL is entered. Error should show up when nothing is entered & we click on "Import".', function () { | |
| apiPage.CreateAndFillApi( | |
| "htt://failedurlfortest", | |
| "WhatTrumpThinks", | |
| "SecondAPI", | |
| ); | |
| agHelper.GetNClick(apiPage._apiRunBtn, 0, true, 10000); | |
| apiPage.ResponseStatusCheck("PE-RST-5000"); | |
| }); | |
| it('2. Validate we get an appropriate error message when an invalid URL is entered. Error should show up when nothing is entered & we click on "Import".', function () { | |
| apiPage.CreateAndFillApi( | |
| "htt://failedurlfortest", | |
| "WhatTrumpThinks", | |
| "SecondAPI", | |
| ); | |
| agHelper.GetNAssertElementPresence(apiPage._apiRunBtn) | |
| agHelper.GetNClick(apiPage._apiRunBtn); | |
| apiPage.ResponseStatusCheck("PE-RST-5000"); | |
| }); |
Comment on lines
28
to
39
| it("3. Validate keyboard navigation e.g. Cmd + Enter should trigger the Run button", function () { | ||
| apiPage.CreateAndFillApi( | ||
| dataManager.dsValues[dataManager.defaultEnviorment].randomTrumpApi, | ||
| "WhatTrumpThinks", | ||
| "ThirdAPI", | ||
| ); | ||
| agHelper.GetNClick(ApiEditor.dataSourceField, 0, true); | ||
| cy.get(ApiEditor.dataSourceField).type("{cmd}{enter}", { | ||
| release: false, | ||
| }); | ||
| assertHelper.AssertNetworkStatus("@postExecute"); | ||
| }); |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Improve cross-platform compatibility for keyboard shortcuts.
The current implementation might not work correctly across different operating systems.
Consider:
- Using a platform-agnostic approach
- Adding assertions for both Windows (Ctrl+Enter) and Mac (Cmd+Enter)
- cy.get(ApiEditor.dataSourceField).type("{cmd}{enter}", {
+ cy.get(ApiEditor.dataSourceField).type(Cypress.platform === 'darwin' ? '{cmd}{enter}' : '{ctrl}{enter}', {
release: false,
});📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| it("3. Validate keyboard navigation e.g. Cmd + Enter should trigger the Run button", function () { | |
| apiPage.CreateAndFillApi( | |
| dataManager.dsValues[dataManager.defaultEnviorment].randomTrumpApi, | |
| "WhatTrumpThinks", | |
| "ThirdAPI", | |
| ); | |
| agHelper.GetNClick(ApiEditor.dataSourceField, 0, true); | |
| cy.get(ApiEditor.dataSourceField).type("{cmd}{enter}", { | |
| release: false, | |
| }); | |
| assertHelper.AssertNetworkStatus("@postExecute"); | |
| }); | |
| it("3. Validate keyboard navigation e.g. Cmd + Enter should trigger the Run button", function () { | |
| apiPage.CreateAndFillApi( | |
| dataManager.dsValues[dataManager.defaultEnviorment].randomTrumpApi, | |
| "WhatTrumpThinks", | |
| "ThirdAPI", | |
| ); | |
| agHelper.GetNClick(ApiEditor.dataSourceField, 0, true); | |
| cy.get(ApiEditor.dataSourceField).type(Cypress.platform === 'darwin' ? '{cmd}{enter}' : '{ctrl}{enter}', { | |
| release: false, | |
| }); | |
| assertHelper.AssertNetworkStatus("@postExecute"); | |
| }); |
This was referenced Jan 28, 2025
2 tasks
github-actions bot
pushed a commit
to Zeral-Zhang/appsmith
that referenced
this pull request
Feb 7, 2025
## Description New test cases Fixes # https://app.zenhub.com/workspaces/qa-63316faf86bb2e170ed2e46b/issues/gh/appsmithorg/appsmith/38478 ## Automation /ok-to-test tags="@tag.Datasource" ### 🔍 Cypress test results <!-- This is an auto-generated comment: Cypress test results --> > [!TIP] > 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉 > Workflow run: <https://github.com/appsmithorg/appsmith/actions/runs/12850322339> > Commit: 308c60e > <a href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=12850322339&attempt=2" target="_blank">Cypress dashboard</a>. > Tags: `@tag.Datasource` > Spec: > <hr>Sun, 19 Jan 2025 09:01:49 UTC <!-- end of auto-generated comment: Cypress test results --> ## Communication Should the DevRel and Marketing teams inform users about this change? - [ ] Yes - [x] No <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Tests** - Added comprehensive Cypress end-to-end tests for API panel functionality - Validated run button state with empty fields - Verified error handling for invalid URL inputs - Confirmed keyboard navigation for running API tests <!-- end of auto-generated comment: release notes by coderabbit.ai -->
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
New test cases
Fixes # https://app.zenhub.com/workspaces/qa-63316faf86bb2e170ed2e46b/issues/gh/appsmithorg/appsmith/38478
Automation
/ok-to-test tags="@tag.Datasource"
🔍 Cypress test results
Tip
🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/12850322339
Commit: 308c60e
Cypress dashboard.
Tags:
@tag.DatasourceSpec:
Sun, 19 Jan 2025 09:01:49 UTC
Communication
Should the DevRel and Marketing teams inform users about this change?
Summary by CodeRabbit