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

Automate date fixes in test assets #8943

Merged
merged 3 commits into from
Jan 17, 2025

Conversation

zhiltsov-max
Copy link
Contributor

@zhiltsov-max zhiltsov-max commented Jan 14, 2025

Motivation and context

  • Automated millisecond truncation to 3 significant digits in test assets

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

  • Chores

    • Updated copyright year in a utility script
    • Minor modifications to test asset files:
      • Reordered task subsets in a project configuration
      • Added consistent configuration for empty annotations
      • Added a trailing newline in a users file
  • Tests

    • Enhanced JSON handling utility to clean JSON output with consistent formatting

Copy link
Contributor

coderabbitai bot commented Jan 14, 2025

Walkthrough

This pull request involves minor modifications across several test asset and utility files. The changes include reordering task subsets in a project JSON, adding a consistent configuration key in quality settings, appending a newline to a users JSON file, and introducing a new JSON cleaning utility function in a dump objects Python script. These modifications appear to be primarily related to test infrastructure and data consistency.

Changes

File Change Summary
tests/python/shared/assets/projects.json Reordered task_subsets array elements for project ID 14 from "Train" then "Validation" to "Validation" then "Train"
tests/python/shared/assets/quality_settings.json Added "empty_is_annotated": false to objects with IDs 1-24 in the results array
tests/python/shared/assets/users.json Added a trailing newline character
tests/python/shared/utils/dump_objects.py Added clean_json() function to truncate JSON milliseconds and remove trailing whitespace; updated copyright year to 2022-2025

Poem

🐰 A Rabbit's JSON Delight

Reordered tasks with gentle might,
Cleaned milliseconds, trailing white,
Quality settings now align just right,
A newline whispers at file's height,
Our code dances with pure delight! 🧹✨

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@zhiltsov-max zhiltsov-max requested a review from SpecLad January 14, 2025 18:21
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

🧹 Nitpick comments (1)
tests/python/shared/utils/dump_objects.py (1)

12-16: Consider enhancing the date format standardization.

The implementation correctly truncates milliseconds, but consider these improvements:

  1. The regex pattern assumes dates are in a specific format (ending with 'Z"'). This might miss dates in different formats.
  2. The function name could be more specific (e.g., standardize_json_dates).
-def clean_json(data: str) -> str:
+def standardize_json_dates(data: str) -> str:
     # truncate milliseconds to 3 digit precision to align with data.json
-    data = re.sub(r'(\.\d{3})\d{3}Z"', r'\g<1>000Z"', data)
+    # Handle both quoted and unquoted date formats
+    data = re.sub(r'(\.\d{3})\d{3}Z(["}])', r'\g<1>000Z\2', data)
     data = data.rstrip()
     return data
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e276295 and 014447d.

📒 Files selected for processing (4)
  • tests/python/shared/assets/projects.json (2 hunks)
  • tests/python/shared/assets/quality_settings.json (24 hunks)
  • tests/python/shared/assets/users.json (1 hunks)
  • tests/python/shared/utils/dump_objects.py (2 hunks)
✅ Files skipped from review due to trivial changes (2)
  • tests/python/shared/assets/quality_settings.json
  • tests/python/shared/assets/users.json
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: build
  • GitHub Check: generate_github_pages
  • GitHub Check: testing
  • GitHub Check: Analyze (python)
  • GitHub Check: Linter
  • GitHub Check: Analyze (javascript)
🔇 Additional comments (3)
tests/python/shared/utils/dump_objects.py (2)

1-1: LGTM! Copyright year updated.

The copyright year has been updated to reflect the current year range.


43-43: LGTM! Proper implementation of JSON cleaning.

The function is correctly applied to standardize the JSON output before writing to file.

tests/python/shared/assets/projects.json (1)

128-129: Verify if the task subsets order is significant for tests.

The order of task subsets has been changed from ["Train", "Validation"] to ["Validation", "Train"]. While this change aligns with the PR's objective of cleaning test assets, please verify that:

  1. The order of subsets doesn't affect any test assertions
  2. There are no test cases that depend on a specific order
✅ Verification successful

Task subsets order change is safe for tests

The order of task subsets in ["Validation", "Train"] vs ["Train", "Validation"] does not affect any test assertions or operations. The test fixtures use task_subsets only as an unordered collection, with no code depending on the specific order of these values.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for test files that might depend on the order of task subsets
rg -l "task_subsets.*\[.*Train.*Validation" tests/
rg -l "task_subsets.*\[.*Validation.*Train" tests/

Length of output: 105


Script:

#!/bin/bash
# Find references to the projects.json file
rg -l "projects\.json" tests/

# Look for task_subsets usage with broader patterns
rg "task_subsets" tests/ -C 2

# Search for array indexing patterns that might indicate order dependency
rg "\[0\]|\[1\].*task_subsets" tests/

Length of output: 55557


Script:

#!/bin/bash
# Check how task_subsets is used in the fixtures file
cat tests/python/shared/fixtures/data.py

Length of output: 14862

@codecov-commenter
Copy link

codecov-commenter commented Jan 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.84%. Comparing base (e276295) to head (b52463b).
Report is 7 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #8943      +/-   ##
===========================================
- Coverage    73.88%   73.84%   -0.05%     
===========================================
  Files          416      417       +1     
  Lines        44413    44583     +170     
  Branches      3993     4028      +35     
===========================================
+ Hits         32814    32921     +107     
- Misses       11599    11662      +63     
Components Coverage Δ
cvat-ui 78.28% <ø> (-0.13%) ⬇️
cvat-server 70.06% <ø> (ø)

@zhiltsov-max zhiltsov-max merged commit d7f49ef into develop Jan 17, 2025
34 checks passed
@zhiltsov-max zhiltsov-max deleted the zm/auto-date-fixes-in-test-assets branch January 17, 2025 15:59
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