Adding tests, updating logs

User description

Overview

This PR fixes #

Signed Commits

[ ] Yes, I signed my commits.

Type

Enhancement, Tests

Description

Enhanced error handling in HandleSingleRequest and HandleScopedRequest functions in mainhandler/handlerequests.go. These functions now handle errors more gracefully and provide more detailed logging information.
The HandleSingleRequest function has been updated to return an error.
The runCommand function has been updated to return an error.
The logging level in the sendWorkloadWithCredentials function in mainhandler/vulnscan.go has been changed from Info to Debug.
Added a new test case in watcher/podwatcher_test.go for handling pods with owner node.
Added a new test data file watcher/testdata/pod-kube-proxy.json for a pod with owner node.

Changes walkthrough

Relevant files

Error handling

handlerequests.go

Improved error handling and logging in request handling functions

mainhandler/handlerequests.go - Added error handling to `HandleSingleRequest` and
`HandleScopedRequest` functions. - Updated the `HandleSingleRequest` function to return an error. - Updated the `runCommand` function to return an error. - Enhanced logging information in `HandleImageScanningScopedRequest`.

+27/-15

Logging

vulnscan.go

Changed log level in sendWorkloadWithCredentials function

mainhandler/vulnscan.go - Changed the log level from Info to Debug in the
`sendWorkloadWithCredentials` function.

+1/-1

Tests

podwatcher_test.go `Added new test case in pod watcher tests` watcher/podwatcher_test.go - Added a new test case for handling pods with owner node.	+33/-1
pod-kube-proxy.json `Added new test data for pod with owner node` watcher/testdata/pod-kube-proxy.json - Added a new test data file for a pod with owner node.	+199/-0

✨ 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](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) every time a new PR is opened, or can be invoked manually by commenting on a PR. When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L46) 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](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-app), use the following template: ``` [pr_description] some_config1=... some_config2=... ```

Enabling\disabling automation

- When you first install the app, the [default mode](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) 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](https://github.com/Codium-ai/pr-agent/blob/main/docs/DESCRIBE.md#handle-custom-labels-from-the-repos-labels-page-gem) 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: ': ' - 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. </details></td></tr> <tr><td><details> <summary><strong> More PR-Agent commands</strong></summary><hr> > 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](https://github.com/Codium-ai/pr-agent/blob/main/docs/TOOLS_GUIDE.md) for more details. >To list the possible configuration parameters, add a **/config** comment. </details></td></tr> </table> See the [describe usage](https://github.com/Codium-ai/pr-agent/blob/main/docs/DESCRIBE.md) page for a comprehensive guide on using this tool. </details> </div> </div> <div class="comment"> <div class="user"> <a rel="noreferrer nofollow" target="_blank" href="https://github.com/codiumai-pr-agent-free[bot]"><img src="https://avatars.githubusercontent.com/in/354216?v=4" />codiumai-pr-agent-free[bot]</a> commented <strong> 9 months ago</strong> </div> <div class="markdown-body"> <p><strong><a href="https://github.com/kubescape/operator/pull/208">PR Description</a></strong> updated to latest commit (<a href="https://github.com/kubescape/operator/commit/1889117c1ef36d684b94bfce761bf95f73e2f791">https://github.com/kubescape/operator/commit/1889117c1ef36d684b94bfce761bf95f73e2f791</a>)</p> </div> </div> <div class="comment"> <div class="user"> <a rel="noreferrer nofollow" target="_blank" href="https://github.com/codiumai-pr-agent-free[bot]"><img src="https://avatars.githubusercontent.com/in/354216?v=4" />codiumai-pr-agent-free[bot]</a> commented <strong> 9 months ago</strong> </div> <div class="markdown-body"> <h2>PR Analysis</h2> <ul> <li>🎯 <strong>Main theme:</strong> Enhancing error handling and logging, and adding tests</li> <li>📝 <strong>PR summary:</strong> This PR enhances error handling in several functions, updates logging levels, and adds a new test case. The changes are mainly in the 'mainhandler/handlerequests.go', 'mainhandler/vulnscan.go', and 'watcher/podwatcher_test.go' files.</li> <li>📌 <strong>Type of PR:</strong> Enhancement, Tests</li> <li>🧪 <strong>Relevant tests added:</strong> Yes</li> <li>⏱️ <strong>Estimated effort to review [1-5]:</strong> 3, because the PR involves changes in error handling and logging which require careful review to ensure they are correctly implemented. Also, a new test case has been added which needs to be validated.</li> <li>🔒 <strong>Security concerns:</strong> No security concerns found <h2>PR Feedback</h2></li> </ul> <p><strong>💡 General suggestions:</strong> The changes in this PR seem to be well-implemented and follow good practices. The error handling has been improved and the logging levels have been adjusted appropriately. The addition of a new test case is also a good practice to ensure the robustness of the code. However, it would be beneficial to add more comments in the code to explain the logic, especially in complex or critical parts.</p> <hr> <details> <summary><strong>✨ Usage guide:</strong></summary><hr> **Overview:** The `review` tool scans the PR code changes, and generates a PR review. The tool can be triggered [automatically](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) every time a new PR is opened, or can be invoked manually by commenting on any PR. When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L19) 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](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-app), use the following template: ``` [pr_reviewer] some_config1=... some_config2=... ``` <table><tr><td><details> <summary><strong> Utilizing extra instructions</strong></summary><hr> 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 'general suggestions' 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. </details></td></tr> <tr><td><details> <summary><strong> How to enable\disable automation</strong></summary><hr> - When you first install PR-Agent app, the [default mode](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) 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 </details></td></tr> <tr><td><details> <summary><strong> Auto-labels</strong></summary><hr> The `review` tool can auto-generate two specific types of labels for a PR: - a `possible security issue` label, that detects possible [security issues](https://github.com/Codium-ai/pr-agent/blob/tr/user_description/pr_agent/settings/pr_reviewer_prompts.toml#L136) (`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) </details></td></tr> <tr><td><details> <summary><strong> Extra sub-tools</strong></summary><hr> The `review` tool provides a collection of possible feedbacks about a PR. It is recommended to review the [possible options](https://github.com/Codium-ai/pr-agent/blob/main/docs/REVIEW.md#enabledisable-features), 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. </details></td></tr> <tr><td><details> <summary><strong> More PR-Agent commands</strong></summary><hr> > 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](https://github.com/Codium-ai/pr-agent/blob/main/docs/TOOLS_GUIDE.md) for more details. >To list the possible configuration parameters, add a **/config** comment. </details></td></tr> </table> See the [review usage](https://github.com/Codium-ai/pr-agent/blob/main/docs/REVIEW.md) page for a comprehensive guide on using this tool. </details> </div> </div> <div class="comment"> <div class="user"> <a rel="noreferrer nofollow" target="_blank" href="https://github.com/codiumai-pr-agent-free[bot]"><img src="https://avatars.githubusercontent.com/in/354216?v=4" />codiumai-pr-agent-free[bot]</a> commented <strong> 9 months ago</strong> </div> <div class="markdown-body"> <h2>PR Code Suggestions</h2> <table><thead><tr><th></th><th>Suggestions </th></tr></thead><tbody><tr><td><strong>enhancement</strong></td><td><table><tr><td> <details><summary>Wrap errors with additional context before logging or sending them. </summary> ___ **Consider wrapping the error with additional context before logging it or sending it back. <br> This can help in understanding the error better during debugging and provides more <br> detailed logs.** [mainhandler/handlerequests.go [203]](https://github.com/kubescape/operator/pull/208/files#diff-cca06da32bce161709272821e2c91575bebc93d39802e599fbfbd6a742c40155R203-R203) ```diff -logger.L().Ctx(ctx).Error("failed to complete action", helpers.String("command", string(sessionObj.Command.CommandName)), helpers.String("wlid", sessionObj.Command.GetID()), helpers.Error(err)) +wrappedErr := fmt.Errorf("handling single request for command %s with wlid %s: %w", sessionObj.Command.CommandName, sessionObj.Command.GetID(), err) +logger.L().Ctx(ctx).Error("failed to complete action", helpers.String("command", string(sessionObj.Command.CommandName)), helpers.String("wlid", sessionObj.Command.GetID()), helpers.Error(wrappedErr)) ``` </details></td></tr></table></td></tr><tr><td><strong>performance</strong></td><td><table><tr><td> <details><summary>Check if debug logging is enabled before constructing log messages. </summary> ___ **It's a good practice to check if the logger is enabled for the specific log level before <br> constructing log messages, especially debug logs that might not always be enabled. This <br> can improve performance by avoiding unnecessary string operations.** [mainhandler/handlerequests.go [464]](https://github.com/kubescape/operator/pull/208/files#diff-cca06da32bce161709272821e2c91575bebc93d39802e599fbfbd6a742c40155R464-R464) ```diff -logger.L().Debug("scan request", helpers.String("url", scanUrl.String()), helpers.String("wlid", command.GetWlid()), helpers.String("instanceID", instanceID), helpers.String("imageTag", command.GetImageTag()), helpers.String("imageHash", command.GetImageHash()), helpers.Interface("credentials", hasCreds)) +if logger.L().IsDebugEnabled() { + logger.L().Debug("scan request", helpers.String("url", scanUrl.String()), helpers.String("wlid", command.GetWlid()), helpers.String("instanceID", instanceID), helpers.String("imageTag", command.GetImageTag()), helpers.String("imageHash", command.GetImageHash()), helpers.Interface("credentials", hasCreds)) +} ``` </details></td></tr></table></td></tr><tr><td><strong>best practice</strong></td><td><table><tr><td> <details><summary>Pass dependencies as interfaces to improve testability. </summary> ___ **To ensure that the `HandleSingleRequest` method can be easily tested, consider passing <br> dependencies such as `NewActionHandler` as interfaces to the method or struct. This allows <br> for better unit testing by enabling mocking of these dependencies.** [mainhandler/handlerequests.go [217]](https://github.com/kubescape/operator/pull/208/files#diff-cca06da32bce161709272821e2c91575bebc93d39802e599fbfbd6a742c40155R217-R217) ```diff -actionHandler := NewActionHandler(mainHandler.config, mainHandler.k8sAPI, sessionObj, mainHandler.commandResponseChannel) +// Assume ActionHandlerInterface is an interface that NewActionHandler implements. +func (mainHandler *MainHandler) HandleSingleRequest(ctx context.Context, sessionObj *utils.SessionObj, actionHandler ActionHandlerInterface) error { ``` </details></td></tr></table></td></tr><tr><td><strong>maintainability</strong></td><td><table><tr><td> <details><summary>Use constants for API version and kind to improve maintainability. </summary> ___ **Instead of hardcoding the API version and kind in the `HandleImageScanningScopedRequest` <br> method, consider using constants or retrieving these values from a configuration. This <br> makes the code more maintainable and flexible to changes.** [mainhandler/handlerequests.go [394-395]](https://github.com/kubescape/operator/pull/208/files#diff-cca06da32bce161709272821e2c91575bebc93d39802e599fbfbd6a742c40155R394-R395) ```diff -pod.APIVersion = "v1" -pod.Kind = "Pod" +pod.APIVersion = DefaultAPIVersion // Assume DefaultAPIVersion is a constant defined elsewhere. +pod.Kind = DefaultPodKind // Assume DefaultPodKind is a constant defined elsewhere. ``` </details></td></tr><tr><td> <details><summary>Create a helper function for generating expected commands in tests. </summary> ___ **To avoid duplication and improve maintainability, consider creating a helper function for <br> generating expected commands in tests. This function can take parameters for the varying <br> parts of the command and return a constructed command object.** [watcher/podwatcher_test.go [327-341]](https://github.com/kubescape/operator/pull/208/files#diff-012f1dfcc695a037393f2844031b3f03eb860836cfc2e9af8c3e3630751779e4R327-R341) ```diff expectedCommands: []apis.Command{ - { - CommandName: apis.TypeScanImages, - Wlid: "wlid://...", - Args: map[string]interface{}{ - ... - }, - }, + generateExpectedCommand(apis.TypeScanImages, "wlid://...", /* other varying parameters */), } +// generateExpectedCommand would be a helper function defined elsewhere in the test file. ``` </details></td></tr></table></td></tr></tr></tbody></table><hr> <details> <summary><strong>✨ Usage guide:</strong></summary><hr> **Overview:** The `improve` tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered [automatically](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) every time a new PR is opened, or can be invoked manually by commenting on a PR. When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L69) 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](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-app), use the following template: ``` [pr_code_suggestions] some_config1=... some_config2=... ``` <table><tr><td><details> <summary><strong> Enabling\disabling automation </strong></summary><hr> When you first install the app, the [default mode](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) 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. </details></td></tr> <tr><td><details> <summary><strong> Utilizing extra instructions</strong></summary><hr> 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. </details></td></tr> <tr><td><details> <summary><strong> A note on code suggestions quality</strong></summary><hr> - 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, or use the [custom suggestions :gem:](https://github.com/Codium-ai/pr-agent/blob/main/docs/CUSTOM_SUGGESTIONS.md) tool - With large PRs, best quality will be obtained by using 'improve --extended' mode. </details></td></tr> <tr><td><details> <summary><strong> More PR-Agent commands</strong></summary><hr> > 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](https://github.com/Codium-ai/pr-agent/blob/main/docs/TOOLS_GUIDE.md) for more details. >To list the possible configuration parameters, add a **/config** comment. </details></td></tr> </table> See the [improve usage](https://github.com/Codium-ai/pr-agent/blob/main/docs/IMPROVE.md) page for a more comprehensive guide on using this tool. </details> </div> </div> <div class="comment"> <div class="user"> <a rel="noreferrer nofollow" target="_blank" href="https://github.com/github-actions[bot]"><img src="https://avatars.githubusercontent.com/in/15368?v=4" />github-actions[bot]</a> commented <strong> 9 months ago</strong> </div> <div class="markdown-body"> <p>Summary:</p> <ul> <li>License scan: failure</li> <li>Credentials scan: failure</li> <li>Vulnerabilities scan: failure</li> <li>Unit test: success</li> <li>Go linting: success</li> </ul> </div> </div> <div class="page-bar-simple"> </div> <div class="footer"> <ul class="body"> <li>© <script> document.write(new Date().getFullYear()) </script> Githubissues.</li> <li>Githubissues is a development platform for aggregating issues.</li> </ul> </div> <script src="https://cdn.jsdelivr.net/npm/jquery@3.5.1/dist/jquery.min.js"></script> <script src="/githubissues/assets/js.js"></script> <script src="/githubissues/assets/markdown.js"></script> <script src="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.4.0/build/highlight.min.js"></script> <script src="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.4.0/build/languages/go.min.js"></script> <script> hljs.highlightAll(); </script> </body> </html>

kubescape / operator