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

Added tests for Requests page #8287

Merged
merged 18 commits into from
Aug 20, 2024
Merged

Added tests for Requests page #8287

merged 18 commits into from
Aug 20, 2024

Conversation

klakhov
Copy link
Contributor

@klakhov klakhov commented Aug 9, 2024

Motivation and context

Tests for #8095
And for the problem with sumultaneous job exports crush

How has this been tested?

Checklist

  • I submit my changes into the develop branch
  • [ ] I have created a changelog fragment
  • [ ] I have updated the documentation accordingly
  • I have added tests to cover my changes
  • ~~[ ] I have linked related issues (see GitHub docs)~
  • [ ] I have increased versions of npm packages if it is necessary
    (cvat-canvas,
    cvat-core,
    cvat-data and
    cvat-ui)

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.

Summary by CodeRabbit

  • New Features

    • Introduced an extensive suite of automated end-to-end tests for the Requests page, enhancing verification of task creation, requests handling, and export processes.
    • Updated the downloadExport command to accept a configuration object, allowing users to control notification verification during tests.
  • Bug Fixes

    • Improved error handling for task creation with invalid configurations, ensuring proper feedback is provided to users.
  • Tests

    • Expanded testing coverage to ensure the robustness and reliability of the Requests page functionalities.

@klakhov klakhov added the tests label Aug 9, 2024
@klakhov klakhov requested a review from azhavoro as a code owner August 9, 2024 11:46
Copy link
Contributor

coderabbitai bot commented Aug 9, 2024

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The recent updates introduce a comprehensive suite of end-to-end tests for the Requests page of the CVAT application, utilizing Cypress for automated validation of key functionalities such as task creation, error handling, and export processes. Additionally, modifications to the downloadExport command enhance its flexibility, allowing conditional notification verification based on user preferences.

Changes

Files Change Summary
tests/cypress/e2e/features/requests_page.js Added a new test suite for the Requests page, covering task creation, error handling, and export functionality with detailed verifications.
tests/cypress/support/commands.js Modified downloadExport command to accept an optional configuration object for conditional notification verification.

Poem

🐰 In a land where code does play,
The Requests page shines today!
With tests to check each task we make,
And flexible exports for our sake.
Hooray for changes, hop and cheer,
Robust and ready, the future is near! 🎉


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

@klakhov klakhov mentioned this pull request Aug 9, 2024
7 tasks
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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 26f1f78 and 5a0a07b.

Files selected for processing (2)
  • tests/cypress/e2e/features/requests_page.js (1 hunks)
  • tests/cypress/support/commands.js (1 hunks)
Additional comments not posted (5)
tests/cypress/e2e/features/requests_page.js (4)

1-5: File header and context block look good.

The copyright and license information are correctly included, and the context block initializes necessary variables for the tests.


40-85: Setup in the before hook is well-structured.

The setup process efficiently prepares the environment for testing by logging in, creating a project and task, and generating necessary files.


87-89: Cleanup in the after hook is appropriate.

Deleting the project after tests ensures that resources are cleaned up, maintaining test isolation.


91-153: Test cases are comprehensive and well-structured.

The test cases effectively verify task creation, error handling, and export processes on the Requests page, covering critical functionalities.

tests/cypress/support/commands.js (1)

1296-1298: Modification to downloadExport command is well-implemented.

The addition of the expectNotification parameter enhances flexibility, allowing tests to conditionally verify notifications.

@klakhov klakhov requested a review from bsekachev as a code owner August 9, 2024 16:08
@klakhov
Copy link
Contributor Author

klakhov commented Aug 9, 2024

/check

Copy link
Contributor

github-actions bot commented Aug 9, 2024

❌ Some checks failed
📄 See logs here

@klakhov klakhov changed the title [WIP] Added tests for Requests page Added tests for Requests page Aug 12, 2024
@codecov-commenter
Copy link

codecov-commenter commented Aug 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.34%. Comparing base (afbb143) to head (1d10d3f).

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #8287      +/-   ##
===========================================
- Coverage    83.34%   83.34%   -0.01%     
===========================================
  Files          393      393              
  Lines        41579    41579              
  Branches      3843     3843              
===========================================
- Hits         34655    34654       -1     
- Misses        6924     6925       +1     
Components Coverage Δ
cvat-ui 79.57% <ø> (-0.01%) ⬇️
cvat-server 86.68% <ø> (ø)

tests/cypress/e2e/features/requests_page.js Outdated Show resolved Hide resolved
Comment on lines 101 to 145
cy.createProjects(
project.name,
project.label,
project.attrName,
project.attrVaue,
project.multiAttrParams,
project.advancedConfiguration,
);
cy.openProject(project.name);
cy.url().then((url) => {
data.projectID = Number(url.split('/').slice(-1)[0].split('?')[0]);

const task = {
name: taskName,
label: mainLabelName,
attrName,
textDefaultValue: 'Requests attr',
dataArchiveName: `${imageFileName}.zip`,
multiAttrParams: false,
forProject: true,
attachToProject: true,
projectName,
};
cy.goToTaskList();
cy.createAnnotationTask(
task.name,
task.label,
task.attrName,
task.textDefaultValue,
archiveName,
task.multiAttrParams,
null,
task.forProject,
task.attachToProject,
task.projectName,
);

cy.goToTaskList();
cy.openTask(taskName);
cy.url().then((taskUrl) => {
data.taskID = Number(taskUrl.split('/').slice(-1)[0].split('?')[0]);
cy.getJobIDFromIdx(0).then((jobID) => {
cy.headlessCreateObjects([rectanglePayload], jobID);
});
});
Copy link
Member

Choose a reason for hiding this comment

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

headlessCreateProject -> returns project ID
headlessCreateTask -> returns task ID and job ID

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There is a problem #8297, which doesnt allow to test backups with file share created tasks/projects. Thats why we create them from local files

tests/cypress/e2e/features/requests_page.js Outdated Show resolved Hide resolved
tests/cypress/e2e/features/requests_page.js Outdated Show resolved Hide resolved
tests/cypress/e2e/features/requests_page.js Outdated Show resolved Hide resolved
tests/cypress/e2e/features/requests_page.js Outdated Show resolved Hide resolved
Copy link

sonarcloud bot commented Aug 20, 2024

@klakhov
Copy link
Contributor Author

klakhov commented Aug 20, 2024

/check

Copy link
Contributor

github-actions bot commented Aug 20, 2024

❌ Some checks failed
📄 See logs here

@klakhov
Copy link
Contributor Author

klakhov commented Aug 20, 2024

/check

Copy link
Contributor

github-actions bot commented Aug 20, 2024

✔️ All checks completed successfully
📄 See logs here

@klakhov klakhov merged commit 884ffa9 into develop Aug 20, 2024
33 checks passed
@bsekachev bsekachev deleted the kl/test-requests-page branch August 29, 2024 08:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants