test: Skipping test becasuea of an open Issue[RestAPIDatasrouce spec] #37354
Conversation
NandanAnantharamu
requested review from
ApekshaBhosale and
sagar-qa007
as code owners
WalkthroughThe pull request modifies the Cypress end-to-end test for creating a REST datasource. Key changes include marking the test suite as skipped due to an associated issue, enhancing the method for clicking the "store as datasource" button to ensure element visibility, and adding a check for a specific URL in the document body. Comments have been clarified, and the assertion for the datasource presence remains intact, while previous failure comments have been removed. Changes
Possibly related PRs
Suggested labels
Suggested reviewers
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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? 🪧 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
|
|
/ci-test-limit-count run_count=100 |
github-actions
bot
added
skip-changelog
|
Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/11809607457. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Outside diff range and nitpick comments (1)
app/client/cypress/e2e/Sanity/Datasources/RestApiDatasource_spec.js (1)
15-35: Consider restructuring the test for better reliability
- Combine related assertions for better test flow
- Consider breaking this into smaller, focused test cases
- Add error handling for API responses
Example structure:
it("should create REST datasource with valid URL", function () { apiPage.CreateAndFillApi(testdata.baseUrl + testdata.methods); // Save as datasource cy.get(apiPage._saveAsDS) .should('be.visible') .and('be.enabled') .click() .then(() => { // Verify no error toasts agHelper.AssertElementAbsence(locators._specificToast("Duplicate key error")); }); // Configure datasource cy.get(apiPage._urlInputField) .should('exist') .and('be.visible') .type(testdata.restApiUrl); // Save and verify cy.saveDatasource(); cy.get(apiPage._datasourceURLHighlight) .should('be.visible') .and('contain', testdata.restApiUrl); });
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
app/client/cypress/e2e/Sanity/Datasources/RestApiDatasource_spec.js(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
app/client/cypress/e2e/Sanity/Datasources/RestApiDatasource_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.
🔇 Additional comments (1)
app/client/cypress/e2e/Sanity/Datasources/RestApiDatasource_spec.js (1)
18-21: LGTM! Good error handling
The negative assertion for the error toast is well implemented.
| cy.get("body").then((body) => { | ||
| if ( | ||
| body.find('[value="http://host.docker.internal:5001"]').length < 1 | ||
| ) { | ||
| cy.get('[placeholder="https://example.com"]').type( | ||
| "http://host.docker.internal:5001", | ||
| ); | ||
| } | ||
| }); |
There was a problem hiding this comment.
Multiple violations of Cypress best practices
- Avoid using attribute selectors
- Move hardcoded URLs to test data
- Use data-cy attributes for element selection
-cy.get("body").then((body) => {
- if (body.find('[value="http://host.docker.internal:5001"]').length < 1) {
- cy.get('[placeholder="https://example.com"]').type(
- "http://host.docker.internal:5001",
- );
- }
-});
+const TEST_URL = testdata.restApiUrl;
+cy.get(apiPage._urlInputField)
+ .should('exist')
+ .then(($el) => {
+ if ($el.val() !== TEST_URL) {
+ cy.get(apiPage._urlInputField).type(TEST_URL);
+ }
+ });Also, update the testdata.json to include:
{
"restApiUrl": "http://host.docker.internal:5001"
}| cy.saveDatasource(); | ||
| cy.contains(".datasource-highlight", "http://host.docker.internal:5001"); //failing here since Save as Datasource is broken | ||
| cy.contains(".datasource-highlight", "http://host.docker.internal:5001"); |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Use data attributes and avoid hardcoded values
Replace class selector with data attribute and use the URL from test data.
-cy.contains(".datasource-highlight", "http://host.docker.internal:5001");
+cy.get(apiPage._datasourceURLHighlight)
+ .should('contain', testdata.restApiUrl);Committable suggestion skipped: line range outside the PR's diff.
| agHelper.WaitUntilEleAppear(apiPage._saveAsDS); | ||
| cy.get(apiPage._saveAsDS).click({ force: true }); |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Avoid using force: true in click operations
Replace the force click with proper element state verification:
agHelper.WaitUntilEleAppear(apiPage._saveAsDS);
-cy.get(apiPage._saveAsDS).click({ force: true });
+cy.get(apiPage._saveAsDS)
+ .should('be.visible')
+ .and('be.enabled')
+ .click();📝 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.
| agHelper.WaitUntilEleAppear(apiPage._saveAsDS); | |
| cy.get(apiPage._saveAsDS).click({ force: true }); | |
| agHelper.WaitUntilEleAppear(apiPage._saveAsDS); | |
| cy.get(apiPage._saveAsDS) | |
| .should('be.visible') | |
| .and('be.enabled') | |
| .click(); |
|
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/11809607457. |
NandanAnantharamu
changed the title
We observe an intermittent issue while create RestAPI DS. I have updated the test to handle this usecase.
raised below bug
(#37353)
Summary by CodeRabbit
Bug Fixes
Tests
Warning
Tests have not run on the HEAD a38a66c yet
Wed, 13 Nov 2024 10:39:02 UTC