fix: detach docker container class from the tests

manoelhc commented 4 months ago

Summary by CodeRabbit

New Features
- Updated Docker workflow to include building Docker images.
- Enhanced linting configurations to support exclusions and fixable linting options.
- Reordered and updated installation instructions in the CONTRIBUTING.md file.
Refactor
- Consolidated Docker container handling logic into a separate module for better code management.
Chores
- Updated various configuration files to improve analysis and workflow efficiency, including exclusion patterns and dependency management adjustments in workflow files.
Documentation
- Updated .gitignore patterns for better file management exclusions.

coderabbitai[bot] commented 4 months ago

Walkthrough

The recent updates focus on refining configuration and workflow across various tools and systems. Key changes include the exclusion of specific directories in analysis tools, streamlining code linting processes, and enhancing CI/CD workflows with Docker integration. Additionally, consolidation of Docker-related code into a separate module improves maintainability, while configuration files for different tools have been introduced or updated to optimize development practices.

Changes

File Pattern	Change Summary
`.deepsource.toml`, `.sourcery.yaml`, `sonar-project.properties`	Exclusion of the `packages` directory added to analysis configurations.
`.github/workflows/test.yaml`	Updated to remove dependency installation and add Docker image building step; adjusted workflow tasks.
`.gitignore`	Updated exclusion pattern from `.ruff` to `.ruff_`.
`.pre-commit-config.yaml`	Modified `ruff` hook arguments to exclude `packages` directory.
`CONTRIBUTING.md`	Reordered setup steps, added note for Linux users, and updated installation instructions.
`justfile`	Renamed `install-dev` to `install-deps`, adjusted dependencies installation, updated `test` and `test-ci` targets.
`src/test/.../test_docker_healthcheck.py`	Refactored imports, consolidated Docker logic into a separate module.

Recent Review Details

**Configuration used: .coderabbit.yaml**

Commits

Files that changed from the base of the PR and between 5450a4f4562ed7652facdf5f087b225236f29ec4 and 31f6745720bb4d456a2a6ac803253a281896abc6.

Files selected for processing (1)

* .deepsource.toml (1 hunks)

Files skipped from review as they are similar to previous changes (1)

* .deepsource.toml

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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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.` 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 a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

deepsource-io[bot] commented 4 months ago

Here's the code health analysis summary for commits 49c63af..31f6745. View details on DeepSource ↗.

Analysis Summary

Analyzer	Status	Summary	Link
Python	✅ Success		View Check ↗
Test coverage	✅ Success	🎯 11 occurences resolved	View Check ↗

Code Coverage Report

Metric	Aggregate	Python
Branch Coverage	87.9% (up 9.2% from `main`)	87.9% (up 9.2% from `main`)
Condition Coverage	87.9% (up 9.2% from `main`)	87.9% (up 9.2% from `main`)
Composite Coverage	96.2% (up 4.5% from `main`)	96.2% (up 4.5% from `main`)
Line Coverage	97.5% (up 2.9% from `main`)	97.5% (up 2.9% from `main`)
New Branch Coverage	100%	100%
New Condition Coverage	100%	100%
New Composite Coverage	100%	100%
New Line Coverage	100%	100%

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

codacy-production[bot] commented 4 months ago

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
:white_check_mark: +2.94% (target: -1.00%)	:white_check_mark: 100.00%

Coverage variation details

| | Coverable lines | Covered lines | Coverage | | ------------- | ------------- | ------------- | ------------- | | Common ancestor commit (49c63af4541c85195db462d3460ed344e28b81f0) | 555 | 525 | 94.59% | | | Head commit (31f6745720bb4d456a2a6ac803253a281896abc6) | 406 (-149) | 396 (-129) | 97.54% (**+2.94%**) | **Coverage variation** is the difference between the coverage for the head and common ancestor commits of the pull request branch: ` - `

Diff coverage details

| | Coverable lines | Covered lines | Diff coverage | | ------------- | ------------- | ------------- | ------------- | | Pull request (#19) | 1 | 1 | **100.00%** | **Diff coverage** is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: `/ * 100%`

See your quality gate settings Change summary preferences

_{You may notice some variations in coverage metrics with the latest Coverage engine update. For more details, visit the documentation}

codecov[bot] commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 96.05%. Comparing base (49c63af) to head (5450a4f). Report is 1 commits behind head on main.

:exclamation: Current head 5450a4f differs from pull request most recent head 31f6745. Consider uploading reports for the commit 31f6745 to get more accurate results

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #19 +/- ## ========================================== + Coverage 90.63% 96.05% +5.42% ========================================== Files 10 10 Lines 555 406 -149 Branches 61 33 -28 ========================================== - Hits 503 390 -113 + Misses 30 10 -20 + Partials 22 6 -16 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.