test: Analyse API Edit spec #37240

NandanAnantharamu · 2024-11-05T12:00:09Z

/ci-test-limit-count run_count=100

Summary by CodeRabbit

Chores
- Updated the test specification path to focus on server-side API edit tests instead of client-side template tests.

coderabbitai · 2024-11-05T12:00:25Z

Walkthrough

The pull request updates the limited-tests.txt file in the Cypress testing environment by changing the path of a specified test case. The previous path for a client-side template test has been replaced with a new path pointing to a server-side API edit test. The overall structure and comments in the file remain unchanged.

Changes

File Path	Change Summary
app/client/cypress/limited-tests.txt	Updated test specification path from `cypress/e2e/Regression/ClientSide/Templates/Fork_Template_spec.js` to `cypress/e2e/Regression/ServerSide/ApiTests/API_Edit_spec.js`.

Possibly related PRs

test: removing unused commands from Commands file #33617: Involves moving a test spec file from Fork_Template_spec.js to a different file, indicating a similar shift in focus.
test: switch branch spec ce #35312: Changes the entry in limited-tests.txt from Fork_Template_spec.js to SwitchBranches_spec.js.
test: fixed skipped graphQL test #35571: Updates the limited-tests.txt file to change the test specification from Fork_Template_spec.js to GraphQL_Binding_Bug16702_Spec.ts.
fix: Fixed flaky fork template test case #36200: Replaces Fork_Template_spec.js with Fork_Template_To_App_spec.ts in limited-tests.txt.
test: replace 3rd party API1 CE #36518: Changes the test specification from Fork_Template_spec.js to API_Edit_spec.js.
test: fix test in airgap for canvas context prop #36519: Modifies limited-tests.txt to replace Fork_Template_spec.js with Canvas_Context_Property_Pane_1_spec.js.
test: udpated 3rd party api for Commandclick nav spec #36545: Updates the test specification from Fork_Template_spec.js to Command_Click_Navigation_spec.js.
test: replace 3rd party api with TED #36594: Changes the test specification from Fork_Template_spec.js to JsOnLoad3_Spec.ts.
feat: adding branch persistence #36622: Replaces Fork_Template_spec.js with GitPersistBranch_spec.ts.
fix: Fix shareapp case due to load issue #36627: Changes the test specification from Fork_Template_spec.js to ShareAppTests_Spec.ts.
chore: fetch spec with removed third party #36636: Updates the test specification from Fork_Template_spec.js to Fetch_Spec.ts.
test: Enable skipped test related to Autocomplete #36991: Replaces Fork_Template_spec.js with JS_AC2_spec.ts.
test: udpated locator for GenetateCrud test #37000: Changes the test specification from Fork_Template_spec.js to Generate_Crud_New_Page_spec.ts.

Suggested labels

ok-to-test

Suggested reviewers

ApekshaBhosale
sagar-qa007

🎉 In the land of tests, a shift we see,
From client-side worries to server-side glee.
A path now leads where APIs play,
In Cypress we trust, come what may!
With limited-tests.txt, we pave the way,
For better tests, hip-hip-hooray! 🎊

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 0b2cffb and 17a019c.

📒 Files selected for processing (1)

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

🧰 Additional context used

📓 Path-based instructions (1)

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 (2)

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

Line range hint 1-6: File structure and comments look good.

The file maintains its proper structure with clear comments explaining its purpose and usage.

2-2: Verify the API Edit spec exists and follows best practices.

The path change looks correct, but let's verify the existence of the API test specification and ensure it follows Cypress best practices.

✅ Verification successful

API Edit spec exists and follows Cypress best practices

The test file exists and follows good practices:

Uses page object pattern with proper imports
Avoids hard-coded selectors by using locators
Contains well-structured test cases with clear descriptions
No anti-patterns like arbitrary waits or .only blocks
Proper test organization with describe and it blocks
Uses appropriate tags for test categorization

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify the existence of the API Edit spec
if [ -f "app/client/cypress/e2e/Regression/ServerSide/ApiTests/API_Edit_spec.js" ]; then
    echo "API Edit spec exists"
    # Check for common anti-patterns
    echo "Checking for anti-patterns..."
    rg -i "cy\.wait|cy\.pause|agHelper\.sleep|it\.only|after\(|afterEach\(" "app/client/cypress/e2e/Regression/ServerSide/ApiTests/API_Edit_spec.js"
    # Check for proper selector usage
    echo "Checking selector patterns..."
    rg -i "\.btn\.|button\[|xpath =|cy\.get\('[^data-]" "app/client/cypress/e2e/Regression/ServerSide/ApiTests/API_Edit_spec.js"
else
    echo "Warning: API Edit spec not found at the specified path"
fi

Length of output: 545

Script:

#!/bin/bash
# Let's check the actual content of the API Edit spec to verify its structure and best practices
if [ -f "app/client/cypress/e2e/Regression/ServerSide/ApiTests/API_Edit_spec.js" ]; then
    echo "=== API Edit spec content ==="
    cat "app/client/cypress/e2e/Regression/ServerSide/ApiTests/API_Edit_spec.js"
else
    # Try to find the correct path using fd
    echo "=== Searching for API_Edit_spec.js ==="
    fd "API_Edit_spec.js" app/client/cypress
fi

Length of output: 4088

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-11-05T12:01:45Z

/ci-test-limit-count run_count=100

github-actions · 2024-11-05T12:02:17Z

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

github-actions · 2024-11-05T16:22:26Z

Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/11683723930.
Cypress dashboard url: Click here!
All Cypress tests have passed 🎉🎉🎉

***** Repeat Run Summary ***** Total Tests with repeat: 500 Total Passed: 491 Total Failed: 9 Total Skipped: 0 *****************************

NandanAnantharamu · 2024-11-12T08:34:38Z

/ci-test-limit-count run_count=100

github-actions · 2024-11-12T08:35:10Z

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

github-actions · 2024-11-12T12:53:41Z

Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/11793521579.
Cypress dashboard url: Click here!
All Cypress tests have passed 🎉🎉🎉

***** Repeat Run Summary ***** Total Tests with repeat: 500 Total Passed: 488 Total Failed: 12 Total Skipped: 0 *****************************

test: Analyse API Edit spec

17a019c

NandanAnantharamu requested review from ApekshaBhosale and sagar-qa007 as code owners November 5, 2024 12:00

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test: Analyse API Edit spec #37240

test: Analyse API Edit spec #37240

NandanAnantharamu commented Nov 5, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Nov 5, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

NandanAnantharamu commented Nov 5, 2024

github-actions bot commented Nov 5, 2024

github-actions bot commented Nov 5, 2024

NandanAnantharamu commented Nov 12, 2024

github-actions bot commented Nov 12, 2024

github-actions bot commented Nov 12, 2024

test: Analyse API Edit spec #37240

Are you sure you want to change the base?

test: Analyse API Edit spec #37240

Conversation

NandanAnantharamu commented Nov 5, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Nov 5, 2024 • edited Loading

Walkthrough

Changes

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

NandanAnantharamu commented Nov 5, 2024

github-actions bot commented Nov 5, 2024

github-actions bot commented Nov 5, 2024

NandanAnantharamu commented Nov 12, 2024

github-actions bot commented Nov 12, 2024

github-actions bot commented Nov 12, 2024

NandanAnantharamu commented Nov 5, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Nov 5, 2024 •

edited

Loading