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

stop using datumaro.util.test_utils #8259

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from

Conversation

Eldies
Copy link
Contributor

@Eldies Eldies commented Aug 5, 2024

Motivation and context

we want to move datumaro.util.test_utils to datumaro.tests.utils.test_utils, but to do it we need to stop using functions from there in cvat

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 utility functions for dataset comparison and management of temporary directories in the testing framework.
  • Bug Fixes
    • Improved clarity and maintainability of test methods by updating the invocation of the compare_datasets function.
  • Chores
    • Updated import statements in several test files for better organization and modularity.

Copy link
Contributor

coderabbitai bot commented Aug 5, 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 changes streamline the testing framework within the CVAT dataset manager by refactoring utility functions and enhancing organization. Key updates include the removal of the self parameter from the compare_datasets function calls in various test methods, promoting clarity and maintainability. Additionally, utility classes for file management and dataset comparison have been introduced, while import paths for test utilities have been updated, reflecting a more modular code structure.

Changes

Files Change Summary
cvat/apps/dataset_manager/tests/test_rest_api_formats.py Removed the self argument from compare_datasets function calls in multiple test methods, enhancing clarity and maintainability.
cvat/apps/dataset_manager/tests/utils.py Introduced FileRemover and TestDir classes for safe file management and context-specific temporary directory handling; added a new compare_datasets function for dataset comparison.
cvat/apps/engine/tests/test_rest_api.py, cvat/apps/engine/tests/test_rest_api_3D.py Updated import statements for TestDir and current_function_name to new paths in the cvat.apps.dataset_manager module, reflecting a restructuring aimed at improved organization without changing core test logic.

Poem

🐇 In the garden of code, where changes bloom,
Refactoring whispers, dispelling the gloom.
With compare_datasets now sleek and bright,
Our tests leap gracefully, taking flight!
New paths we tread, with tools at our side,
Let’s hop into the future, with joy as our guide! 🌼


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

sonarcloud bot commented Aug 5, 2024

@Eldies Eldies marked this pull request as ready for review August 5, 2024 11:15
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 f3dcc3e and 196acce.

Files selected for processing (4)
  • cvat/apps/dataset_manager/tests/test_rest_api_formats.py (6 hunks)
  • cvat/apps/dataset_manager/tests/utils.py (1 hunks)
  • cvat/apps/engine/tests/test_rest_api.py (1 hunks)
  • cvat/apps/engine/tests/test_rest_api_3D.py (1 hunks)
Files skipped from review due to trivial changes (2)
  • cvat/apps/engine/tests/test_rest_api.py
  • cvat/apps/engine/tests/test_rest_api_3D.py
Additional comments not posted (9)
cvat/apps/dataset_manager/tests/utils.py (3)

17-35: Verify the necessity of handling unittest.SkipTest.

The exception handling for unittest.SkipTest is unusual in this context. Ensure that it is necessary and correctly implemented.


37-74: LGTM!

The TestDir class correctly extends FileRemover to create a temporary directory for tests.


77-85: LGTM!

The compare_datasets function correctly compares two datasets using ExactComparator.

cvat/apps/dataset_manager/tests/test_rest_api_formats.py (6)

1037-1037: LGTM!

The function test_api_v2_tasks_annotations_dump_and_upload_many_jobs_with_datumaro correctly calls compare_datasets without the self parameter.


1113-1113: LGTM!

The function test_api_v2_tasks_annotations_dump_and_upload_with_datumaro correctly calls compare_datasets without the self parameter.


1179-1179: LGTM!

The function test_api_v2_check_duplicated_polygon_points correctly calls compare_datasets without the self parameter.


1252-1252: LGTM!

The function test_api_v2_check_widerface_with_all_attributes correctly calls compare_datasets without the self parameter.


1215-1215: LGTM!

The function test_api_v2_check_mot_with_shapes_only correctly calls compare_datasets without the self parameter.


1252-1252: LGTM!

The function test_api_v2_check_attribute_import_in_tracks correctly calls compare_datasets without the self parameter.

@codecov-commenter
Copy link

codecov-commenter commented Aug 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.36%. Comparing base (c9754a9) to head (9360841).
Report is 4 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #8259      +/-   ##
===========================================
+ Coverage    74.34%   74.36%   +0.01%     
===========================================
  Files          394      394              
  Lines        42216    42212       -4     
  Branches      3896     3896              
===========================================
+ Hits         31387    31389       +2     
+ Misses       10829    10823       -6     
Components Coverage Δ
cvat-ui 78.75% <ø> (+0.01%) ⬆️
cvat-server 70.48% <63.63%> (+0.01%) ⬆️

@Eldies Eldies mentioned this pull request Aug 5, 2024
7 tasks


class FileRemover:
def __init__(self, path, is_dir=False):
Copy link
Contributor

Choose a reason for hiding this comment

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

Could you add type annotations in the updated code and enable code formatting for the new files?

Copy link
Contributor Author

@Eldies Eldies Sep 26, 2024

Choose a reason for hiding this comment

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

Added annotations and enabled black and isort for the new file

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Correction: I can not enable black and isort on CI for the new file alone, because the linters are run on folders, not individual files. Disabled them back

Copy link
Contributor

Choose a reason for hiding this comment

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

It still makes sense to add this file into dev/format_python_code.sh

Copy link
Contributor

@zhiltsov-max zhiltsov-max left a comment

Choose a reason for hiding this comment

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

^

Copy link

sonarcloud bot commented Sep 26, 2024

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.

3 participants