Fix/bump k8s interface

[dwertent]

User description

Overview

This PR fixes #

Signed Commits

• Yes, I signed my commits.

---

Type

Bug fix, Enhancement

---

Description

• This PR primarily focuses on improving the logging and error handling in watcher.go, and extending the test coverage in watcher_test.go.
• It also includes a configuration change in the GitHub Actions workflow to reset the run number for PR merges.
• The version of github.com/kubescape/k8s-interface has been updated in go.mod and go.sum.

---

Changes walkthrough

	Relevant files
Error handling	watcher.go Refactor logging and error handling in watcher.go                                watcher/watcher.go Removed a log warning for unrecognized instance IDs. Added a newline after an error check. +1/-1
Tests	watcher_test.go Extend test coverage in watcher_test.go                                                    watcher/watcher_test.go Added new test cases for the function annotationsToInstanceID. +41/-0
Configuration changes	pr-merged.yaml Update GitHub Actions workflow for PR merges                                          .github/workflows/pr-merged.yaml Added a new job to reset the GitHub run number. Updated the image tag to use the reset run number. +15/-4
Dependencies	go.mod Update k8s-interface dependency in go.mod                                                go.mod Updated the version of github.com/kubescape/k8s-interface. +1/-1      go.sum Update k8s-interface checksums in go.sum                                                  go.sum Updated the checksums for github.com/kubescape/k8s-interface. +2/-2

---

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

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 (76d24a5)

[codiumai-pr-agent-free]

PR Analysis

• 🎯 Main theme: This PR primarily focuses on improving the logging and error handling in the watcher.go file, extending the test coverage in watcher_test.go, and updating the version of github.com/kubescape/k8s-interface in go.mod and go.sum. It also includes a configuration change in the GitHub Actions workflow to reset the run number for PR merges.
• 📝 PR summary: The PR introduces improvements to the logging and error handling in watcher.go and extends the test coverage in watcher_test.go. It also updates the version of github.com/kubescape/k8s-interface and modifies the GitHub Actions workflow to reset the run number for PR merges.
• 📌 Type of PR: Bug fix
• 🧪 Relevant tests added: Yes
• ⏱️ Estimated effort to review [1-5]: 2, because the changes are relatively straightforward and involve improvements to logging, error handling, and test coverage. The PR also includes a version bump for a dependency and a minor configuration change in the GitHub Actions workflow.
• 🔒 Security concerns: No security concerns found

PR Feedback

💡 General suggestions: The changes in the PR are generally good, with improvements to logging and error handling, and increased test coverage. However, it would be beneficial to include more context or comments in the code to explain the logic behind certain decisions, especially in the watcher.go file. This would make it easier for other developers to understand the code.

---

✨ 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_review, enable_review_labels_effort, 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
best practice	Handle errors returned by Delete method.                         Consider handling the error returned by Delete method. Ignoring errors can lead to unexpected behavior. watcher/watcher.go [291-292] -wh.storageClient.SpdxV1beta1().SBOMSyftFiltereds(obj.ObjectMeta.Namespace).Delete(context.TODO(), obj.ObjectMeta.Name, v1.DeleteOptions{}) -wh.storageClient.SpdxV1beta1().SBOMSPDXv2p3Filtereds(obj.ObjectMeta.Namespace).Delete(context.TODO(), obj.ObjectMeta.Name, v1.DeleteOptions{}) +if err := wh.storageClient.SpdxV1beta1().SBOMSyftFiltereds(obj.ObjectMeta.Namespace).Delete(context.TODO(), obj.ObjectMeta.Name, v1.DeleteOptions{}); err != nil { + // handle error +} +if err := wh.storageClient.SpdxV1beta1().SBOMSPDXv2p3Filtereds(obj.ObjectMeta.Namespace).Delete(context.TODO(), obj.ObjectMeta.Name, v1.DeleteOptions{}); err != nil { + // handle error +} Use table-driven tests to reduce code duplication.                            Consider using table-driven tests for similar test cases to reduce code duplication. watcher/watcher_test.go [1385-1407] -t.Run("Valid instance ID annotation", func(t *testing.T) { - // test code -}) -t.Run("Valid instance ID annotation", func(t *testing.T) { - // test code -}) +tests := []struct { + name string + annotations map[string]string + expectedSlug string + // other fields +}{ + {"Valid instance ID annotation", /*annotations*/, /*expectedSlug*/, /*other fields*/}, + {"Valid instance ID annotation", /*annotations*/, /*expectedSlug*/, /*other fields*/}, + // other test cases +} +for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + // test code using tt.fields + }) +} Use a stable release version of the k8s-interface package.       Consider using a stable release version of the k8s-interface package instead of a specific commit. This can help ensure that your project is using a version of the package that has been thoroughly tested. go.mod [21] -github.com/kubescape/k8s-interface v0.0.158-0.20240123155300-c2a152fdc0d8 +github.com/kubescape/k8s-interface v0.0.158
maintainability	Use a more descriptive name for the job.                                      Consider using a more descriptive name for the job reset-run-number. The name should <br> reflect <br> the <br> job's <br> purpose. .github/workflows/pr-merged.yaml [13-15] -reset-run-number: +reset-build-number: runs-on: ubuntu-latest - name: reset github.run_number + name: Reset build number

---

✨ 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