Fix/cleanup

[dwertent]

User description

• Fix sbom cleanup
• Generate NP when status is ready
• Adding ingress and egress by default
• Set klog level to fatal

---

Type

Bug fix, Enhancement

---

Description

• Added a check to ensure networkNeighbors status annotation is ready before generating network policy.
• Added default Ingress and Egress to NetworkPolicySpec.
• Initialized mergedRules to avoid nil slice.
• Added a function IsAvailable to check if networkNeighbors is ready or completed.
• Removed omitempty tag from Ingress, Egress, and PolicyTypes in NetworkPolicySpec.
• Updated the cleanup handlers for various resources.
• Added a new function deleteDeprecated to delete deprecated resources.
• Added a logger with FatalLevel.
• Added a check to ensure networkNeighbors is available before generating network policy.
• Updated required fields in NetworkPolicySpec.
• Added and updated various dependencies.

---

Changes walkthrough

	Relevant files
Bug fix	networkpolicy.go Enhancements and bug fixes in network policy generation                    pkg/apis/softwarecomposition/networkpolicy/networkpolicy.go Added a check to ensure networkNeighbors status annotation is ready before generating network policy. Added default Ingress and Egress to NetworkPolicySpec. Initialized mergedRules to avoid nil slice. Added a function IsAvailable to check if networkNeighbors is ready or completed. +24/-10  generatednetworkpolicy.go Added check for networkNeighbors availability in generatednetworkpolicy.go pkg/registry/file/generatednetworkpolicy.go Added a check to ensure networkNeighbors is available before generating network policy. +3/-0
Enhancement	networkpolicy.go Updated NetworkPolicySpec structure                                                            pkg/apis/softwarecomposition/v1beta1/networkpolicy.go Removed omitempty tag from Ingress, Egress, and PolicyTypes in NetworkPolicySpec. +3/-3      cleanup.go Updated cleanup handlers and added function to delete deprecated resources pkg/cleanup/cleanup.go Updated the cleanup handlers for various resources. Added a new function deleteDeprecated to delete deprecated resources. +10/-4    main.go Added logger with FatalLevel in main.go                                                    main.go Added a logger with FatalLevel. +11/-0    zz_generated.openapi.go Updated required fields in NetworkPolicySpec in OpenAPI generation pkg/generated/openapi/zz_generated.openapi.go Updated required fields in NetworkPolicySpec. +1/-1
Dependencies	go.sum Updated dependencies in go.sum                                                                      go.sum Added and updated various dependencies. +6/-2      go.mod Updated dependencies in go.mod                                                                      go.mod Added and updated various dependencies. +4/-3

---

✨ Usage guide:

---

Overview:
The describe tool scans the PR code changes, and generates a description for the PR - title, type, summary, walkthrough and labels. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.

When commenting, to edit configurations related to the describe tool (pr_description section), use the following template:

/describe --pr_description.some_config1=... --pr_description.some_config2=...

With a configuration file, use the following template:

[pr_description]
some_config1=...
some_config2=...

Enabling\disabling automation When you first install the app, the default mode for the describe tool is: pr_commands = ["/describe --pr_description.add_original_user_description=true" "--pr_description.keep_original_user_title=true", ...] meaning the describe tool will run automatically on every PR, will keep the original title, and will add the original user description above the generated description. Markers are an alternative way to control the generated description, to give maximal control to the user. If you set: pr_commands = ["/describe --pr_description.use_description_markers=true", ...] the tool will replace every marker of the form pr_agent:marker_name in the PR description with the relevant content, where marker_name is one of the following: type: the PR type. summary: the PR summary. walkthrough: the PR walkthrough. Note that when markers are enabled, if the original PR description does not contain any markers, the tool will not alter the description at all.

Custom labels The default labels of the describe tool are quite generic: [Bug fix, Tests, Enhancement, Documentation, Other]. If you specify custom labels in the repo's labels page or via configuration file, you can get tailored labels for your use cases. Examples for custom labels: Main topic:performance - pr_agent:The main topic of this PR is performance New endpoint - pr_agent:A new endpoint was added in this PR SQL query - pr_agent:A new SQL query was added in this PR Dockerfile changes - pr_agent:The PR contains changes in the Dockerfile ... The list above is eclectic, and aims to give an idea of different possibilities. Define custom labels that are relevant for your repo and use cases. Note that Labels are not mutually exclusive, so you can add multiple label categories. Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it.

Inline File Walkthrough 💎 For enhanced user experience, the describe tool can add file summaries directly to the "Files changed" tab in the PR page. This will enable you to quickly understand the changes in each file, while reviewing the code changes (diffs). To enable inline file summary, set pr_description.inline_file_summary in the configuration file, possible values are: 'table': File changes walkthrough table will be displayed on the top of the "Files changed" tab, in addition to the "Conversation" tab. true: A collapsable file comment with changes title and a changes summary for each file in the PR. false (default): File changes walkthrough will be added only to the "Conversation" tab.

Utilizing extra instructions The describe tool can be configured with extra instructions, to guide the model to a feedback tailored to the needs of your project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Notice that the general structure of the description is fixed, and cannot be changed. Extra instructions can change the content or style of each sub-section of the PR description. Examples for extra instructions: [pr_description] extra_instructions=""" - The PR title should be in the format: '<PR type>: <title>' - The title should be short and concise (up to 10 words) - ... """ Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the describe usage page for a comprehensive guide on using this tool.

[codiumai-pr-agent-free]

PR Description updated to latest commit (c29946f)

[codiumai-pr-agent-free]

PR Analysis

• 🎯 Main theme: Enhancements and bug fixes in network policy generation and cleanup handlers
• 📝 PR summary: This PR introduces several enhancements and bug fixes in the network policy generation and cleanup handlers. It adds checks to ensure the readiness of networkNeighbors before generating network policies, initializes mergedRules to avoid nil slices, and updates the cleanup handlers for various resources. It also sets the klog level to fatal.
• 📌 Type of PR: Bug fix
• 🧪 Relevant tests added: No
• ⏱️ Estimated effort to review [1-5]: 4, because the PR involves changes in multiple files and introduces new logic in network policy generation and cleanup handlers. It requires a good understanding of the existing codebase to review these changes effectively.
• 🔒 Security concerns: No

PR Feedback

💡 General suggestions: The PR seems to be well-structured and the changes are logically grouped. However, it would be beneficial to add comments explaining the logic behind the new checks and initializations. This would make the code easier to understand for other developers. Also, it would be helpful to add tests to verify the new functionality and ensure that it works as expected.

---

✨ Usage guide:

---

Overview:
The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...

Utilizing extra instructions The review tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize. Examples for extra instructions: [pr_reviewer] # /review # extra_instructions=""" In the code feedback section, emphasize the following: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """ Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

How to enable\disable automation When you first install PR-Agent app, the default mode for the review tool is: pr_commands = ["/review", ...] meaning the review tool will run automatically on every PR, with the default configuration. Edit this field to enable/disable the tool, or to change the used configurations

About the 'Code feedback' section The review tool provides several type of feedbacks, one of them is code suggestions. If you are interested only in the code suggestions, it is recommended to use the improve feature instead, since it dedicated only to code suggestions, and usually gives better results. Use the review tool if you want to get a more comprehensive feedback, which includes code suggestions as well.

Auto-labels The review tool can auto-generate two specific types of labels for a PR: a possible security issue label, that detects possible security issues (enable_review_labels_security flag) a Review effort [1-5]: x label, where x is the estimated effort to review the PR (enable_review_labels_effort flag)

Extra sub-tools The review tool provides a collection of possible feedbacks about a PR. It is recommended to review the possible options, and choose the ones relevant for your use case. Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example: require_score_review, require_soc2_ticket, and more.

More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the review usage page for a comprehensive guide on using this tool.

[codiumai-pr-agent-free]

PR Code Suggestions

	Suggestions
maintainability	Move the availability check of networkNeighbors to a separate function. It seems you are checking the availability of networkNeighbors in the GenerateNetworkPolicy function. This check could be moved to a separate function to improve readability and maintainability. pkg/apis/softwarecomposition/networkpolicy/networkpolicy.go [27-30] func GenerateNetworkPolicy(networkNeighbors softwarecomposition.NetworkNeighbors, knownServers []softwarecomposition.KnownServer, timeProvider metav1.Time) (softwarecomposition.GeneratedNetworkPolicy, error) { - if !IsAvailable(networkNeighbors) { - return softwarecomposition.GeneratedNetworkPolicy{}, fmt.Errorf("networkNeighbors %s/%s status annotation is not ready", networkNeighbors.Namespace, networkNeighbors.Name) + if err := checkNetworkNeighborsAvailability(networkNeighbors); err != nil { + return softwarecomposition.GeneratedNetworkPolicy{}, err } ... } +func checkNetworkNeighborsAvailability(networkNeighbors softwarecomposition.NetworkNeighbors) error { + if !IsAvailable(networkNeighbors) { + return fmt.Errorf("networkNeighbors %s/%s status annotation is not ready", networkNeighbors.Namespace, networkNeighbors.Name) + } + return nil +} + Consider using or removing the zap.NewProduction() logger that is being created but not used. The zap.NewProduction() logger is being created but not used anywhere. If you want to use this logger, you should replace the existing logger with this one. Otherwise, consider removing this unused code to improve readability. main.go [43-46] +// If you want to use the zap logger if logger, err := zap.NewProduction(); err == nil { logger = logger.WithOptions(zap.IncreaseLevel(zap.FatalLevel)) - klog.SetLogger(zapr.NewLogger(logger)) + log.SetLogger(zapr.NewLogger(logger)) } +// If you want to remove the unused code +// (No changes) +
enhancement	Consider adding the omitempty JSON tag back to the Ingress, Egress, and PolicyTypes fields in the NetworkPolicySpec struct. The omitempty JSON tag was removed from the Ingress, Egress, and PolicyTypes fields in the NetworkPolicySpec struct. This means that these fields will always be included in the JSON output, even if they are empty. If this is not the intended behavior, consider adding the omitempty tag back. pkg/apis/softwarecomposition/v1beta1/networkpolicy.go [43-69] type NetworkPolicySpec struct { PodSelector metav1.LabelSelector `json:"podSelector" protobuf:"bytes,1,opt,name=podSelector"` - Ingress []NetworkPolicyIngressRule `json:"ingress" protobuf:"bytes,2,rep,name=ingress"` - Egress []NetworkPolicyEgressRule `json:"egress" protobuf:"bytes,3,rep,name=egress"` - PolicyTypes []PolicyType `json:"policyTypes" protobuf:"bytes,4,rep,name=policyTypes,casttype=PolicyType"` + Ingress []NetworkPolicyIngressRule `json:"ingress,omitempty" protobuf:"bytes,2,rep,name=ingress"` + Egress []NetworkPolicyEgressRule `json:"egress,omitempty" protobuf:"bytes,3,rep,name=egress"` + PolicyTypes []PolicyType `json:"policyTypes,omitempty" protobuf:"bytes,4,rep,name=policyTypes,casttype=PolicyType"` } Consider implementing the deletion logic in the deleteDeprecated function or removing it if it's not needed. The deleteDeprecated function currently returns true without performing any operations. If this function is intended to delete deprecated resources, you should implement the deletion logic. Otherwise, if this function is not needed, consider removing it to improve readability. pkg/cleanup/cleanup.go [184-186] +// If you want to implement the deletion logic // delete deprecated resources func deleteDeprecated(_, _ string, metadata *metav1.ObjectMeta, resourceMaps ResourceMaps) bool { + // Implement the deletion logic here + ... return true } +// If you want to remove the unused function +// (No changes) +

---

✨ Usage guide:

---

Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.
When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:

/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...

With a configuration file, use the following template:

[pr_code_suggestions]
some_config1=...
some_config2=...

Enabling\disabling automation When you first install the app, the default mode for the improve tool is: pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...] meaning the improve tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically.

Utilizing extra instructions Extra instructions are very important for the improve tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on. Examples for extra instructions: [pr_code_suggestions] # /improve # extra_instructions=""" Emphasize the following aspects: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """ Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

A note on code suggestions quality While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically. Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base. Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project. Best quality will be obtained by using 'improve --extended' mode.

More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the improve usage page for a more comprehensive guide on using this tool.

[github-actions]

Summary:

• License scan: failure
• Credentials scan: success
• Vulnerabilities scan: failure
• Unit test: success
• Go linting: success

[matthyx]

few nits

[matthyx]

I think this is useless

[matthyx]

why?