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: Property control spec #38004

Merged
merged 7 commits into from
Dec 9, 2024
Merged

fix: Property control spec #38004

merged 7 commits into from
Dec 9, 2024

Conversation

sagar-qa007
Copy link
Contributor

@sagar-qa007 sagar-qa007 commented Dec 6, 2024

Description

Fix test case as DB data updated.

Fixes # https://app.zenhub.com/workspaces/stability-pod-6690c4814e31602e25cab7fd/issues/gh/appsmithorg/appsmith/38022

Automation

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

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/12236809570
Commit: 046fc7a
Cypress dashboard.
Tags: @tag.Widget
Spec:


Mon, 09 Dec 2024 14:51:56 UTC

Communication

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

  • Yes
  • No

Summary by CodeRabbit

Summary by CodeRabbit

  • Tests
    • Updated test specifications to focus on property control functionality instead of fork template functionality.
    • Modified searchable column parameters in tests to enhance data relevance for property control interactions.
    • Ensured continued validation of datasource dropdowns and search functionality within the tests.

@sagar-qa007
Copy link
Contributor Author

/ci-test-limit-count run_count=5

Copy link
Contributor

coderabbitai bot commented Dec 6, 2024

Walkthrough

The changes in this pull request involve updating the limited-tests.txt file used for Cypress testing. The entry for the test specification related to Fork_Template_spec.js has been replaced with PropertyControl_spec.ts, indicating a shift in testing focus to property control functionality within the OneClickBinding context. Other comments and instructions in the file remain unchanged.

Changes

File Path Change Summary
app/client/cypress/limited-tests.txt Updated test specification from Fork_Template_spec.js to PropertyControl_spec.ts.
app/client/cypress/e2e/Regression/ClientSide/OneClickBinding/PropertyControl_spec.ts Modified searchableColumn parameters in the ChooseAndAssertForm method calls. Updated values from "gender" to "email" and "status" to "imdb_id".

Possibly related PRs

Suggested labels

Task, Test

Suggested reviewers

  • ApekshaBhosale
  • NandanAnantharamu
  • yatinappsmith

🎉 In the land of tests, a change took flight,
From Fork_Template to Property Control, what a sight!
The focus now shifts, a new path to explore,
In Cypress we trust, for tests we adore.
So here's to the code, and the tweaks that we make,
For every small change, a new chance to awake! 🌟


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between f66f845 and 09cd0a4.

📒 Files selected for processing (1)
  • app/client/cypress/e2e/Regression/ClientSide/OneClickBinding/PropertyControl_spec.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • app/client/cypress/e2e/Regression/ClientSide/OneClickBinding/PropertyControl_spec.ts

🪧 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.

Copy link

github-actions bot commented 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: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between ba7c158 and a81de18.

📒 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 (1)
app/client/cypress/limited-tests.txt (1)

2-2: Verify test coverage migration from the old test file.

Need to ensure the test coverage from the removed Fork_Template_spec.js is maintained.

✅ Verification successful

Let me check the content of both files to compare the test coverage.


Let me try one more search to find any traces of the old test file or its content.


Let me try one more search to find any test coverage related to fork templates.


Test coverage for fork template functionality is maintained in ForkTemplateToGitConnectedApp.js

The test coverage has been migrated and enhanced in ForkTemplateToGitConnectedApp.js, which includes testing for:

  • Forking templates into git-connected apps
  • Forking templates to child branches
  • Cloning of JS Objects during template forking
  • Error handling and success states
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if fork template testing is covered elsewhere

# Search for other files that might contain fork template testing
rg -l "fork.*template" app/client/cypress/e2e

# Check if the old test file still exists (should be removed if replaced)
fd "Fork_Template_spec.js" app/client/cypress

Length of output: 181


Script:

#!/bin/bash
# Check content of both files to compare test coverage
echo "=== Content of ForkTemplateToGitConnectedApp.js ==="
cat app/client/cypress/e2e/Regression/ClientSide/Templates/ForkTemplateToGitConnectedApp.js

# Search for the old test file in the entire repository to ensure we get its content
echo -e "\n=== Searching for Fork_Template_spec.js content ==="
rg -l "Fork_Template_spec" app/client/cypress

Length of output: 4740


Script:

#!/bin/bash
# Search for any references to Fork_Template in the entire codebase
rg -i "fork.*template.*spec" app/client/cypress

# Search in limited-tests.txt for any history
cat app/client/cypress/limited-tests.txt

Length of output: 130759


Script:

#!/bin/bash
# Search for fork template testing in the entire codebase
rg -A 5 "fork.*template" app/client/cypress/e2e/Regression/ClientSide/Templates/ForkTemplateToGitConnectedApp.js

# Check if there are any other test files containing fork template tests
rg -l "fork.*template" app/client/cypress/e2e/Regression/ClientSide/Templates/

Length of output: 1264

@@ -1,5 +1,5 @@
# To run only limited tests - give the spec names in below format:
cypress/e2e/Regression/ClientSide/Templates/Fork_Template_spec.js
cypress/e2e/Regression/ClientSide/OneClickBinding/PropertyControl_spec.ts
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Test file exists but contains some test anti-patterns that need attention

  • Found usage of cy.wait(500) which is a flaky test practice. Consider using Cypress's built-in automatic retry and wait mechanisms
  • Test follows proper structure with describe/it blocks and meaningful test descriptions
  • No discouraged selectors found
  • The old Fork_Template_spec file is not present in the codebase
🔗 Analysis chain

Verify the new test specification exists and follows Cypress best practices.

Let's ensure the new test file exists and follows the required guidelines.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the existence and content of the new test file

# Check if the new test file exists
fd "PropertyControl_spec.ts" app/client/cypress

# Check for potential test anti-patterns
rg -A 3 "cy\.wait|cy\.pause|agHelper\.sleep|it\.only|after\(|afterEach\(" "app/client/cypress/e2e/Regression/ClientSide/OneClickBinding/PropertyControl_spec.ts" || echo "No anti-patterns found"

# Check selector usage
rg "\.btn\.submit|button\[type=submit\]|\$\('" "app/client/cypress/e2e/Regression/ClientSide/OneClickBinding/PropertyControl_spec.ts" || echo "No discouraged selectors found"

# Verify login/logout method usage
rg "LoginFromAPI|LogOutviaAPI|SignupFromAPI" "app/client/cypress/e2e/Regression/ClientSide/OneClickBinding/PropertyControl_spec.ts"

Length of output: 802


Script:

#!/bin/bash
# Let's check the content of the test file to verify best practices
cat "app/client/cypress/e2e/Regression/ClientSide/OneClickBinding/PropertyControl_spec.ts"

# Also check if the old test file exists somewhere else
fd "Fork_Template_spec" app/client/cypress

Length of output: 7983

Copy link

github-actions bot commented Dec 6, 2024

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

***** Repeat Run Summary ***** Total Tests with repeat: 15 Total Passed: 0 Total Failed: 15 Total Skipped: 0 *****************************

@sagar-qa007
Copy link
Contributor Author

/ci-test-limit-count run_count=10

Copy link

github-actions bot commented 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/e2e/Regression/ClientSide/OneClickBinding/PropertyControl_spec.ts (1)

Line range hint 41-41: Replace cy.wait with proper assertions

Using cy.wait is against our coding guidelines. Replace it with proper assertions or commands that wait for specific conditions.

- cy.wait(500);
+ cy.get('[data-testid="t--selected-widget-Table1"]').should('exist');
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between a81de18 and f66f845.

📒 Files selected for processing (1)
  • app/client/cypress/e2e/Regression/ClientSide/OneClickBinding/PropertyControl_spec.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
app/client/cypress/e2e/Regression/ClientSide/OneClickBinding/PropertyControl_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.
🔇 Additional comments (2)
app/client/cypress/e2e/Regression/ClientSide/OneClickBinding/PropertyControl_spec.ts (2)

Line range hint 15-252: Test structure and assertions look good

The test cases are well-structured with:

  • Clear test descriptions
  • Multiple assertions for validation
  • Proper use of Cypress commands
  • Good separation of concerns between test cases

100-100: Verify email column existence in datasource schemas

The searchableColumn has been changed to "email" for both Users and Movies tables. Please verify that:

  1. The "email" column exists in both datasource schemas
  2. The column is appropriate for search functionality

Also applies to: 108-108

@sagar-qa007 sagar-qa007 changed the title DNM : checking failure fix : Property control spec Dec 6, 2024
Copy link

github-actions bot commented Dec 6, 2024

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

***** Repeat Run Summary ***** Total Tests with repeat: 30 Total Passed: 21 Total Failed: 9 Total Skipped: 0 *****************************

@sagar-qa007 sagar-qa007 added the ok-to-test Required label for CI label Dec 9, 2024
@NandanAnantharamu NandanAnantharamu self-requested a review December 9, 2024 05:37
Copy link
Collaborator

@NandanAnantharamu NandanAnantharamu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@sagar-qa007 sagar-qa007 removed the ok-to-test Required label for CI label Dec 9, 2024
@sagar-qa007 sagar-qa007 added the ok-to-test Required label for CI label Dec 9, 2024
@sagar-qa007
Copy link
Contributor Author

/ci-test-limit-count run_count=10

Copy link

github-actions bot commented Dec 9, 2024

Copy link

github-actions bot commented Dec 9, 2024

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

@sagar-qa007
Copy link
Contributor Author

/ci-test-limit-count run_count=10 runId=12233135663

Copy link

github-actions bot commented Dec 9, 2024

@sagar-qa007 sagar-qa007 changed the title fix : Property control spec fix: Property control spec Dec 9, 2024
@github-actions github-actions bot added the Bug Something isn't working label Dec 9, 2024
Copy link

github-actions bot commented Dec 9, 2024

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

***** Repeat Run Summary ***** Total Tests with repeat: 30 Total Passed: 0 Total Failed: 30 Total Skipped: 0 *****************************

@sagar-qa007
Copy link
Contributor Author

/ci-test-limit-count run_count=20 runId=12233135663

Copy link

github-actions bot commented Dec 9, 2024

Copy link
Collaborator

@NandanAnantharamu NandanAnantharamu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm

Copy link

github-actions bot commented Dec 9, 2024

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

@sagar-qa007 sagar-qa007 merged commit 59833b0 into release Dec 9, 2024
42 checks passed
@sagar-qa007 sagar-qa007 deleted the fix/oneclickbindfuncase branch December 9, 2024 15:26
github-actions bot pushed a commit to Zeral-Zhang/appsmith that referenced this pull request Dec 12, 2024
## Description
Fix test case as DB data updated.


Fixes #
https://app.zenhub.com/workspaces/stability-pod-6690c4814e31602e25cab7fd/issues/gh/appsmithorg/appsmith/38022

## Automation

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

### 🔍 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/12236809570>
> Commit: 046fc7a
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=12236809570&attempt=1"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.Widget`
> Spec:
> <hr>Mon, 09 Dec 2024 14:51:56 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

## Summary by CodeRabbit

- **Tests**
- Updated test specifications to focus on property control functionality
instead of fork template functionality.
- Modified searchable column parameters in tests to enhance data
relevance for property control interactions.
- Ensured continued validation of datasource dropdowns and search
functionality within the 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
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.

2 participants