fix: zap api scan report

manoelhc commented 4 months ago

Summary by CodeRabbit

New Features
- Added a new directory copy command in the Docker setup to enhance package management.
- Introduced a new build target for Manocorp utils package in the build configuration.
Refactor
- Updated branch triggers in vulnerability and scanner workflows for better targeting in CI/CD pipelines.
- Modified API router setup in the user management module to improve header management and routing efficiency.
Tests
- Updated test configurations to align with the new package structure.
Chores
- Updated Python version target and lint settings in the project configuration for improved code quality compliance.

codacy-production[bot] commented 4 months ago

Coverage summary from Codacy

See diff coverage on Codacy

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

Coverage variation details

| | Coverable lines | Covered lines | Coverage | | ------------- | ------------- | ------------- | ------------- | | Common ancestor commit (959e905cbfb7bde540fa3ae9c5a81ac2c846c3a5) | 406 | 396 | 97.54% | | | Head commit (488d6a465f480fd03096e9c537c1382ef93e1796) | 407 (+1) | 397 (+1) | 97.54% (**+0.01%**) | **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 (#21) | 3 | 3 | **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}

coderabbitai[bot] commented 4 months ago

Walkthrough

The changes primarily focus on refining the development and testing environments by adjusting branch triggers for vulnerability scans, updating configurations for Python linting, enhancing Docker setups, and modifying source code imports and classes for better integration and compliance. These modifications aim to streamline processes and improve the specificity and efficiency of development operations.

Changes

File Path	Change Summary
`.github/workflows/...`	Modified branch triggers from `main` to `fix/12-zap-api-scan-report` in both vulnerability scan and ZAP scanner workflows. Updated ZAP target URL in `zap-scanner.yaml` for a more specific scan.
`.ruff.toml`	Updated `target-version` to `"py312"` and adjusted `fixable` lint settings to include all fixable issues.
`Dockerfile`	Added a `COPY` command to move the `manocorp` directory and updated `pip install` to include the package from this new directory.
`justfile`	Added `build-packages` target, updated package installation path to use `packages/manocorp`, and modified `run-ci` target with additional Docker environment variables.
`src/routers/user.py`	Imported `SecFetchJsonRoute` from `manocorp.fastapi.routing` and updated `APIRouter` instantiation to include `route_class=SecFetchJsonRoute` and default headers.
`src/test/...test_docker_healthcheck.py`	Updated import from `localtest_docker` to `manocorp.testing` for `DockerContainerDaemon`.

Recent Review Details

**Configuration used: .coderabbit.yaml**

Commits

Files that changed from the base of the PR and between 4aa2d3aa93bca5b29f530f8c3999de3bf293a974 and 488d6a465f480fd03096e9c537c1382ef93e1796.

Files ignored due to path filters (1)

* `packages/manocorp/build/lib/manocorp/testing/docker.py` is excluded by `!packages/**`

Files selected for processing (2)

* Dockerfile (1 hunks) * justfile (5 hunks)

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

* justfile

Additional Context Used

GitHub Check Runs (1)

Codacy Static Code Analysis action_required (1)
Dockerfile: [warning] 19-19: Dockerfile#L19 Pin versions in pip. Instead of `pip install ` use `pip install ==`

Additional comments not posted (1)

Dockerfile (1)
`14-14`: COPY command correctly copies `manocorp` directory to `/manocorp` in the Docker image.

--- 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 959e905..488d6a4. View details on DeepSource ↗.

Analysis Summary

Analyzer	Status	Summary	Link
Python	✅ Success		View Check ↗
Test coverage	✅ Success		View Check ↗

Code Coverage Report

Metric	Aggregate	Python
Branch Coverage	87.9%	87.9%
Condition Coverage	87.9%	87.9%
Composite Coverage	96.2%	96.2%
Line Coverage	97.5%	97.5%
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.

codecov[bot] commented 4 months ago

Codecov Report

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

Project coverage is 96.06%. Comparing base (959e905) to head (488d6a4).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #21 +/- ## ======================================= Coverage 96.05% 96.06% ======================================= Files 10 10 Lines 406 407 +1 Branches 33 33 ======================================= + Hits 390 391 +1 Misses 10 10 Partials 6 6 ```

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