search

bitbomdev / minefield

Graphing SBOM's Fast.
https://bitbom.dev
Apache License 2.0
354 stars 10 forks source link

Added a flag to clear the cache #61

Closed neilnaveen closed 2 months ago

neilnaveen commented 2 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The changes involve updates across various files, adding new functionalities such as cache management, modifying existing methods, and enhancing command-line options. Notable additions include a .PHONY declaration in the Makefile, a new clear option in the cache command, and the implementation of RemoveAllCaches methods across multiple storage interfaces. Additionally, the return type of the SBOM function is altered to provide more informative feedback.

Changes

File Change Summary
Makefile Added .PHONY declaration for specified targets.
cmd/cache/cache.go Introduced clear field in options struct; modified AddFlags and Run methods.
pkg/tools/ingest/sbom.go Changed SBOM function return type to (int, error); added helper functions for progress.
pkg/graph/cache.go Added todoFuturePair struct and getTodoAndFutureNodesCached function for caching efficiency.
pkg/graph/mockGraph.go Added RemoveAllCaches method to MockStorage struct.
pkg/graph/storage.go Introduced RemoveAllCaches method in Storage interface.
pkg/storages/redis_storage.go Modified SaveNode key formatting; added RemoveAllCaches method to RedisStorage struct.
pkg/tools/ingest/sbom_test.go Updated TestIngestSBOM to capture return value from SBOM function.
pkg/tools/weightedNACD/riskCalculation.go Changed node type check from "PACKAGE" to "library" in WeightedNACD function.
pkg/tools/weightedNACD/riskCalculation_test.go Updated node types from "PACKAGE" to "library" in tests.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CacheCommand
    participant Storage

    User->>CacheCommand: Run with --clear
    CacheCommand->>Storage: RemoveAllCaches()
    Storage-->>CacheCommand: Success
    CacheCommand-->>User: Cache cleared successfully
sequenceDiagram
    participant User
    participant SBOMFunction
    participant ProgressHelper

    User->>SBOMFunction: Call with sbomPath
    SBOMFunction->>ProgressHelper: Format progress
    SBOMFunction-->>User: Return (count, error)

🐰 In a world of code so bright,
I hop with joy, what a delight!
Caches cleared and flags declared,
With every change, my heart is bared.
Let's celebrate with leaps and bounds,
For in this code, true magic sounds!
πŸ‡

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.` - `@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](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.
codecov[bot] commented 2 months ago

Codecov Report

Attention: Patch coverage is 40.98361% with 36 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
pkg/storages/redis_storage.go 0.00% 21 Missing and 1 partial :warning:
pkg/graph/mockGraph.go 0.00% 7 Missing :warning:
pkg/tools/ingest/sbom.go 76.19% 4 Missing and 1 partial :warning:
pkg/graph/cache.go 80.00% 1 Missing and 1 partial :warning:
Files with missing lines Coverage Ξ”
pkg/tools/weightedNACD/riskCalculation.go 62.79% <100.00%> (ΓΈ)
pkg/graph/cache.go 68.18% <80.00%> (ΓΈ)
pkg/tools/ingest/sbom.go 68.18% <76.19%> (ΓΈ)
pkg/graph/mockGraph.go 78.35% <0.00%> (ΓΈ)
pkg/storages/redis_storage.go 31.90% <0.00%> (ΓΈ)