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

fix nightly tests #8496

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

fix nightly tests #8496

wants to merge 2 commits into from

Conversation

azhavoro
Copy link
Contributor

@azhavoro azhavoro commented Oct 1, 2024

Motivation and context

How has this been tested?

https://github.com/cvat-ai/cvat/actions/runs/11124390649

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 CI-nightly workflow configuration for improved efficiency and organization.
    • Changed image tags for server and UI to reflect development versions.
    • Enhanced logging and error handling in testing processes.

Copy link
Contributor

coderabbitai bot commented Oct 1, 2024

Walkthrough

The changes involve updates to the CI-nightly workflow configuration in the .github/workflows/schedule.yml file, focusing on the unit_testing and e2e_testing jobs. Key modifications include changing image tags for the CVAT UI and server, consolidating steps for dependency installation and testing, and enhancing logging for server response checks.

Changes

Files Change Summary
.github/workflows/schedule.yml Updated image tags from latest to dev for both CVAT UI and server in unit_testing and e2e_testing jobs. Consolidated steps for installing dependencies and running tests. Enhanced logging for server response in e2e_testing.

Poem

In the garden where code does bloom,
A rabbit hops, dispelling gloom.
With tags now fresh, the tests align,
Through CI nights, our workflows shine.
Hooray for changes, swift and bright,
Let's celebrate with pure 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.

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 Oct 1, 2024

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

🧹 Outside diff range and nitpick comments (5)
.github/workflows/schedule.yml (5)

150-152: LGTM: Updated server image tagging, but note the TODO

The change to use the 'dev' tag for the server image is consistent with the UI image tagging and aligns with the PR objectives. The additional 'local' tag appears to be for compatibility purposes.

However, please note the TODO comment about fixing the tag in Dockerfile.ci. This should be addressed to ensure consistency across all configurations.

Consider creating a follow-up task to address the TODO comment and update Dockerfile.ci accordingly.


161-172: LGTM: Improved organization of SDK generation and dependency installation

The reorganization of the SDK generation and dependency installation steps is a good improvement. It enhances readability and potentially reduces the overall execution time of the workflow. This aligns well with the PR objective of improving the nightly tests.

Consider adding a comment explaining the purpose of the --extra-index-url flag in the pip install command. This would improve maintainability for future contributors.


Line range hint 174-184: LGTM: Added comprehensive REST API and SDK tests

The addition of multiple pytest commands with different configurations is an excellent improvement to the CI pipeline. This enhances test coverage and helps identify potential issues across various scenarios, directly contributing to the PR objective of fixing and improving nightly tests.

Consider extracting the pytest commands into a separate shell script to improve readability and maintainability of the workflow file. This would also make it easier to run these tests locally if needed.


Line range hint 254-258: LGTM: Improved image tagging and server waiting mechanism

The consistent use of 'dev' tags for both UI and server images is a good practice. The enhanced server waiting mechanism with additional logging is an excellent improvement for troubleshooting CI issues. These changes contribute to the overall reliability of the nightly tests.

Consider adding a timeout to the server waiting loop to prevent infinite waiting in case of unexpected issues. This could be implemented by checking if max_tries has reached zero and exiting with an error if so.

Also applies to: 270-288


Line range hint 1-324: Overall assessment: Improvements to CI-nightly workflow

The changes made to this workflow file are well-aligned with the PR objectives of fixing and improving nightly tests. Key improvements include:

  1. Consistent use of 'dev' tags for images
  2. Reorganization and enhancement of test steps
  3. Improved logging and error handling

These modifications contribute to a more reliable and maintainable CI pipeline. The changes are generally well-implemented, with only minor suggestions for further improvements.

Consider creating a separate configuration file for test-specific settings (e.g., image tags, test commands) to make the workflow more flexible and easier to maintain in the future.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 7551d6c and 837dc3e.

📒 Files selected for processing (1)
  • .github/workflows/schedule.yml (4 hunks)
🔇 Additional comments (1)
.github/workflows/schedule.yml (1)

130-130: LGTM: Updated UI image tag to 'dev'

Changing the tag from 'latest' to 'dev' is a good practice. It provides better control over the specific version used in the CI pipeline and aligns with the PR objective of fixing nightly tests.

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.34%. Comparing base (c9754a9) to head (837dc3e).
Report is 7 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #8496      +/-   ##
===========================================
- Coverage    74.34%   74.34%   -0.01%     
===========================================
  Files          394      394              
  Lines        42216    42211       -5     
  Branches      3896     3896              
===========================================
- Hits         31387    31383       -4     
+ Misses       10829    10828       -1     
Components Coverage Δ
cvat-ui 78.72% <ø> (-0.02%) ⬇️
cvat-server 70.48% <63.63%> (+0.01%) ⬆️

@@ -127,7 +127,7 @@ jobs:
context: .
file: ./Dockerfile.ui
cache-from: type=local,src=/tmp/cvat_cache_ui
tags: cvat/ui:latest
tags: cvat/ui:dev
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this image actually used for anything? It seems like the UI doesn't actually get started at any point in this job.

And if it is needed, wouldn't it make more sense to pull the image that's already been built, instead of building it anew?

@@ -147,9 +147,9 @@ jobs:
- name: Pull CVAT server image
run: |
docker pull ${{ steps.meta-server.outputs.tags }}
docker tag ${{ steps.meta-server.outputs.tags }} cvat/server:dev
#TODO fix tag in Dockerfile.ci
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 elaborate? What do you want to fix?

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