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

Tests for basic Management tab on Quality control page #8447

Merged
merged 3 commits into from
Sep 19, 2024

Conversation

klakhov
Copy link
Contributor

@klakhov klakhov commented Sep 17, 2024

Motivation and context

This PR adds tests for management tab that was introduced in #8329

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

    • Enhanced styling for the Allocation Table and Summary components with new CSS class names for better visual representation.
    • Introduced a new Cypress command for creating jobs, improving the testing process.
    • Added a new testing suite for ground truth management, validating key functionalities in the management page.
  • Bug Fixes

    • Updated test data for regression tests to ensure accuracy in testing scenarios.

@klakhov klakhov added the tests label Sep 17, 2024
@klakhov klakhov requested a review from bsekachev September 17, 2024 09:50
@klakhov klakhov requested a review from azhavoro as a code owner September 17, 2024 09:50
Copy link
Contributor

coderabbitai bot commented Sep 17, 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 changes involve enhancements to the styling of the AllocationTable and SummaryComponent by adding CSS class names for better visual representation. Additionally, a new Cypress testing suite for ground truth management is introduced, along with a new command for job creation. The tests validate various functionalities related to frame allocation and management, while existing commands are modified to include default parameter values.

Changes

Files Change Summary
cvat-ui/src/components/quality-control/task-quality/allocation-table.tsx
cvat-ui/src/components/quality-control/task-quality/summary.tsx
Added CSS class names to enhance styling in AllocationTable and SummaryComponent. No alterations to exported entities.
tests/cypress/e2e/features/ground_truth_jobs.js Introduced a new testing suite for ground truth management, added openManagementTab function, and updated image file name.
tests/cypress/support/commands.js Added headlessCreateJob command for job creation and modified existing command parameters to include default values.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Cypress
    participant ManagementTab

    User->>Cypress: Trigger test suite
    Cypress->>ManagementTab: Open management tab
    ManagementTab->>Cypress: Validate contents and links
    Cypress->>ManagementTab: Check frame allocation
    ManagementTab->>Cypress: Return frame status
    Cypress->>User: Display test results
Loading

Poem

🐇 In the garden of code, we hop and play,
With styles anew, brightening the day.
A table of frames, all dressed up fine,
In tests we explore, where the ground truths shine.
So let’s cheer for changes, both big and small,
For in this code burrow, we’re having a ball! 🌼


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.

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.

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

Outside diff range and nitpick comments (2)
tests/cypress/e2e/features/ground_truth_jobs.js (1)

Line range hint 338-340: Incorrect use of afterEach leading to premature task deletion

Using afterEach to delete the task after each test could cause subsequent tests to fail because the task would no longer exist. If the intention is to delete the task after all tests have completed, use after instead of afterEach.

Apply this diff to correct the hook:

-afterEach(() => {
+after(() => {
     cy.headlessDeleteTask(taskID);
 });
tests/cypress/support/commands.js (1)

174-175: Consider using empty objects {} as default parameters instead of null

Using empty objects {} as default values for multiAttrParams and advancedConfigurationParams can prevent potential null reference errors if these parameters are used without null checks within the function.

Apply this diff to improve default parameter handling:

 multiAttrParams = {},
 advancedConfigurationParams = {},
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e929a3d and 772d0d7.

Files selected for processing (4)
  • cvat-ui/src/components/quality-control/task-quality/allocation-table.tsx (4 hunks)
  • cvat-ui/src/components/quality-control/task-quality/summary.tsx (2 hunks)
  • tests/cypress/e2e/features/ground_truth_jobs.js (3 hunks)
  • tests/cypress/support/commands.js (2 hunks)
Files skipped from review due to trivial changes (2)
  • cvat-ui/src/components/quality-control/task-quality/allocation-table.tsx
  • cvat-ui/src/components/quality-control/task-quality/summary.tsx
Additional comments not posted (1)
tests/cypress/e2e/features/ground_truth_jobs.js (1)

91-97: Good use of helper function for opening the Management tab

The openManagementTab function promotes code reuse and improves readability by encapsulating the steps to navigate to the Management tab.

tests/cypress/e2e/features/ground_truth_jobs.js Outdated Show resolved Hide resolved
tests/cypress/support/commands.js Show resolved Hide resolved
tests/cypress/support/commands.js Show resolved Hide resolved
@codecov-commenter
Copy link

codecov-commenter commented Sep 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.22%. Comparing base (e929a3d) to head (69b8319).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #8447      +/-   ##
===========================================
+ Coverage    83.10%   83.22%   +0.12%     
===========================================
  Files          397      397              
  Lines        41907    41907              
  Branches      3882     3882              
===========================================
+ Hits         34825    34876      +51     
+ Misses        7082     7031      -51     
Components Coverage Δ
cvat-ui 78.71% <ø> (+0.25%) ⬆️
cvat-server 87.22% <ø> (ø)

Copy link
Member

@bsekachev bsekachev left a comment

Choose a reason for hiding this comment

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

awesome

Copy link

@klakhov klakhov merged commit 6d38124 into develop Sep 19, 2024
34 checks passed
@klakhov klakhov deleted the kl/add-quality-management-test branch September 23, 2024 08:16
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