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

Test/custom lib tests #37900

Closed
wants to merge 8 commits into from
Closed

Test/custom lib tests #37900

wants to merge 8 commits into from

Conversation

NandanAnantharamu
Copy link
Collaborator

@NandanAnantharamu NandanAnantharamu commented Dec 2, 2024

Adding tests for custom library

Summary by CodeRabbit

  • New Features

    • Introduced comprehensive end-to-end tests for JavaScript library management, including integration and functionality checks for libraries like moment.js, Swiper, and jspdf.
    • Added tests for partial import and export functionality within the application, ensuring smooth transitions and validations across different scenarios.
  • Bug Fixes

    • Updated JSON structure for partial query exports to enhance compatibility with Google Sheets.
  • Chores

    • Updated test file paths in the Cypress testing environment to reflect new test locations.

Copy link
Contributor

coderabbitai bot commented Dec 2, 2024

Walkthrough

The pull request introduces two new test files: Custom_library_spec.ts and PartialImportExportWithinNewPageAndApp.ts, which contain end-to-end tests for JavaScript libraries and partial import/export functionalities, respectively. Additionally, it updates a JSON fixture file to modify the structure of an action related to Google Sheets and changes a test file path in limited-tests.txt to point to the newly created JavaScript library test.

Changes

File Path Change Summary
app/client/cypress/e2e/Regression/ClientSide/JSLibrary/Custom_library_spec.ts Introduced end-to-end tests for JavaScript libraries, covering functionalities of moment.js, Swiper, and jspdf libraries.
app/client/cypress/e2e/Regression/ClientSide/PartialImportExport/PartialImportExportWithinNewPageAndApp.ts Added tests for partial import/export functionality, validating export/import of widgets and queries across applications.
app/client/cypress/fixtures/PartialImportExport/PartialQueryExport.json Modified JSON structure for Home_Api1, changing plugin details and action configuration to support Google Sheets.
app/client/cypress/limited-tests.txt Updated test file path from Fork_Template_spec.js to Custom_library_spec.ts for limited tests.

Possibly related PRs

Suggested labels

Enhancement, Test, ok-to-test, Query & JS Pod

Suggested reviewers

  • ApekshaBhosale
  • sagar-qa007

🎉 In the realm of code, where tests take flight,
New libraries dance, in the day and the night.
With imports and exports, all neatly aligned,
Our application's strength is beautifully defined.
So here's to the changes, both bold and bright,
In the world of testing, we shine with delight! 🌟


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.

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: 2

🧹 Outside diff range and nitpick comments (1)
app/client/cypress/e2e/Regression/ClientSide/JSLibrary/Custom_library_spec.ts (1)

53-58: Remove commented-out code

Consider removing the commented-out deployment code to keep the test file clean and maintainable.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between b5d52e7 and a2a2ed2.

📒 Files selected for processing (4)
  • app/client/cypress/e2e/Regression/ClientSide/JSLibrary/Custom_library_spec.ts (1 hunks)
  • app/client/cypress/e2e/Regression/ClientSide/PartialImportExport/PartialImportExportWithinNewPageAndApp.ts (1 hunks)
  • app/client/cypress/fixtures/PartialImportExport/PartialQueryExport.json (1 hunks)
  • app/client/cypress/limited-tests.txt (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • app/client/cypress/limited-tests.txt
🧰 Additional context used
📓 Path-based instructions (3)
app/client/cypress/e2e/Regression/ClientSide/PartialImportExport/PartialImportExportWithinNewPageAndApp.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.
app/client/cypress/e2e/Regression/ClientSide/JSLibrary/Custom_library_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.
app/client/cypress/fixtures/PartialImportExport/PartialQueryExport.json (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.
🪛 Biome (1.9.4)
app/client/cypress/fixtures/PartialImportExport/PartialQueryExport.json

[error] 1-1: unexpected character <

(parse)


[error] 1-1: unexpected character <

(parse)


[error] 1-1: unexpected character <

(parse)


[error] 1-1: unexpected character <

(parse)


[error] 1-1: unexpected character <

(parse)


[error] 1-1: unexpected character <

(parse)


[error] 1-1: unexpected character <

(parse)


[error] 1-1: String values must be double quoted.

(parse)


[error] 1-2: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 2-3: unexpected character =

(parse)


[error] 3-3: unexpected character =

(parse)


[error] 3-3: unexpected character =

(parse)


[error] 3-3: unexpected character =

(parse)


[error] 3-3: unexpected character =

(parse)


[error] 3-3: unexpected character =

(parse)


[error] 3-3: unexpected character =

(parse)


[error] 3-4: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 4-5: unexpected character >

(parse)


[error] 5-5: unexpected character >

(parse)


[error] 5-5: unexpected character >

(parse)


[error] 5-5: unexpected character >

(parse)


[error] 5-5: unexpected character >

(parse)


[error] 5-5: unexpected character >

(parse)


[error] 5-5: unexpected character >

(parse)


[error] 5-5: String values must be double quoted.

(parse)


[error] 5-5: unexpected character /

(parse)


[error] 5-5: String values must be double quoted.

(parse)


[error] 5-5: unexpected character /

(parse)


[error] 5-5: String values must be double quoted.

(parse)


[error] 5-5: unexpected character /

(parse)


[error] 5-5: String values must be double quoted.

(parse)

Comment on lines +1 to +5
{"artifactJsonType":"APPLICATION","clientSchemaVersion":1,"serverSchemaVersion":11,"actionList":[{"id":"Home_Api1","pluginType":"SAAS","pluginId":"google-sheets-plugin","unpublishedAction":{"name":"Api1","fullyQualifiedName":"Api1","datasource":{"userPermissions":[],"name":"Untitled datasource 2","pluginId":"google-sheets-plugin","messages":[],"isValid":true},"pageId":"Home","actionConfiguration":{"timeoutInMillisecond":10000,"paginationType":"NONE","encodeParamsToggle":true,"formData":{"command":{"data":"FETCH_MANY"},"entityType":{"data":"ROWS"},"tableHeaderIndex":{"data":"1"},"projection":{"data":["Currency"]},"queryFormat":{"data":"ROWS"},"range":{"data":""},"where":{"data":{"condition":"AND","children":[{"condition":"LT"}]}},"pagination":{"data":{"limit":"20","offset":"0"}},"smartSubstitution":{"data":true},"sheetUrl":{"data":"https://docs.google.com/spreadsheets/d/1DLNNumIhXhbajHGAEhWfzlgixcAu259gzAOVvLtWVpA/edit"},"sheetName":{"data":"Sheet1"},"sortBy":{"data":[{"column":"","order":"Ascending"}]}}},"executeOnLoad":true,"dynamicBindingPathList":[],"isValid":true,"invalids":[],"messages":[],"jsonPathKeys":[],"confirmBeforeExecute":false,"userPermissions":[]},"publishedAction":{"name":"Api1","fullyQualifiedName":"Api1","datasource":{"userPermissions":[],"name":"Untitled datasource 2","pluginId":"google-sheets-plugin","messages":[],"isValid":true},"pageId":"Home","actionConfiguration":{"timeoutInMillisecond":10000,"paginationType":"NONE","encodeParamsToggle":true,"formData":{"command":{"data":"FETCH_MANY"},"entityType":{"data":"ROWS"},"tableHeaderIndex":{"data":"1"},"projection":{"data":["Currency"]},"queryFormat":{"data":"ROWS"},"range":{"data":""},"where":{"data":{"condition":"AND","children":[{"condition":"LT"}]}},"pagination":{"data":{"limit":"20","offset":"0"}},"smartSubstitution":{"data":true},"sheetUrl":{"data":"https://docs.google.com/spreadsheets/d/1DLNNumIhXhbajHGAEhWfzlgixcAu259gzAOVvLtWVpA/edit"},"sheetName":{"data":"Sheet1"},"sortBy":{"data":[{"column":"","order":"Ascending"}]}}},"executeOnLoad":true,"dynamicBindingPathList":[],"isValid":true,"invalids":[],"messages":[],"jsonPathKeys":[],"confirmBeforeExecute":false,"userPermissions":[]}}],"widgets":""}
=======
{"artifactJsonType":"APPLICATION","clientSchemaVersion":1,"serverSchemaVersion":11,"actionList":[{"id":"Home_Api1","pluginType":"API","pluginId":"restapi-plugin","unpublishedAction":{"name":"Api1","fullyQualifiedName":"Api1","datasource":{"userPermissions":[],"name":"DEFAULT_REST_DATASOURCE","pluginId":"restapi-plugin","datasourceConfiguration":{"url":"http://host.docker.internal:5001"},"invalids":[],"messages":[],"isValid":true},"pageId":"Home","actionConfiguration":{"timeoutInMillisecond":10000,"paginationType":"NONE","path":"/v1/mock-api","headers":[],"autoGeneratedHeaders":[],"encodeParamsToggle":true,"queryParameters":[{"key":"records","value":"10"}],"body":"","bodyFormData":[],"httpMethod":"GET","httpVersion":"HTTP11","pluginSpecifiedTemplates":[{"value":true}],"formData":{"apiContentType":"none"}},"executeOnLoad":true,"dynamicBindingPathList":[],"isValid":true,"invalids":[],"messages":[],"jsonPathKeys":[],"confirmBeforeExecute":false,"userPermissions":[]},"publishedAction":{"name":"Api1","fullyQualifiedName":"Api1","datasource":{"userPermissions":[],"messages":[],"isValid":true},"pageId":"Home","messages":[],"confirmBeforeExecute":false,"userPermissions":[]}}],"widgets":""}
>>>>>>> refs/remotes/origin/release
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Resolve merge conflicts in the JSON file

There are unresolved merge conflict markers in this file. Please resolve them to ensure the JSON is valid.

🧰 Tools
🪛 Biome (1.9.4)

[error] 1-1: unexpected character <

(parse)


[error] 1-1: unexpected character <

(parse)


[error] 1-1: unexpected character <

(parse)


[error] 1-1: unexpected character <

(parse)


[error] 1-1: unexpected character <

(parse)


[error] 1-1: unexpected character <

(parse)


[error] 1-1: unexpected character <

(parse)


[error] 1-1: String values must be double quoted.

(parse)


[error] 1-2: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 2-3: unexpected character =

(parse)


[error] 3-3: unexpected character =

(parse)


[error] 3-3: unexpected character =

(parse)


[error] 3-3: unexpected character =

(parse)


[error] 3-3: unexpected character =

(parse)


[error] 3-3: unexpected character =

(parse)


[error] 3-3: unexpected character =

(parse)


[error] 3-4: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 4-5: unexpected character >

(parse)


[error] 5-5: unexpected character >

(parse)


[error] 5-5: unexpected character >

(parse)


[error] 5-5: unexpected character >

(parse)


[error] 5-5: unexpected character >

(parse)


[error] 5-5: unexpected character >

(parse)


[error] 5-5: unexpected character >

(parse)


[error] 5-5: String values must be double quoted.

(parse)


[error] 5-5: unexpected character /

(parse)


[error] 5-5: String values must be double quoted.

(parse)


[error] 5-5: unexpected character /

(parse)


[error] 5-5: String values must be double quoted.

(parse)


[error] 5-5: unexpected character /

(parse)


[error] 5-5: String values must be double quoted.

(parse)

fixtureName,
);

cy.wait(5000);
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Avoid using cy.wait

Please avoid using cy.wait(5000);. Replace it with proper wait mechanisms like agHelper.WaitUntilAllToastsDisappear(); or assertions to ensure synchronization.

Apply this diff:

- cy.wait(5000);
+ // Wait for necessary elements or conditions instead of using fixed wait
+ agHelper.WaitUntilElementsAppear(locators._desiredElement);

Committable suggestion skipped: line range outside the PR's diff.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant