add patching for applicationprofiles

[matthyx]

Type

Enhancement

---

Description

This PR introduces patching for application profiles. The main changes include:

• Added new fields savedCapabilities and savedSyscalls to the ApplicationProfileManager struct in pkg/applicationprofilemanager/v1/applicationprofile_manager.go.
• Implemented saving new activities, updating profiles, and handling errors during these operations in pkg/applicationprofilemanager/v1/applicationprofile_manager.go.
• Added the PatchApplicationProfile method to the StorageClient interface in pkg/storage/storage_interface.go.
• Implemented the PatchApplicationProfile method in the StorageNoCache struct in pkg/storage/v1/storage_nocache.go.
• Added a mock for the PatchApplicationProfile method and updated the CreateApplicationProfile method to simulate a failure on the first call in pkg/storage/storage_mock.go.
• Added new test cases for the PatchNetworkNeighbors and PatchApplicationProfile methods in pkg/storage/v1/storage_test.go.
• Updated the TestApplicationProfileManager test case to accommodate the changes made in the applicationprofile_manager.go file in pkg/applicationprofilemanager/v1/applicationprofile_manager_test.go.
• Updated the version of the github.com/kubescape/storage package in go.sum and go.mod.

---

Changes walkthrough

	Relevant files
Enhancement	applicationprofile_manager.go                                                              pkg/applicationprofilemanager/v1/applicationprofile_manager.go Added patching for application profiles. This includes saving new activities, updating profiles, and handling errors during these operations. Also, added new fields savedCapabilities and savedSyscalls to the ApplicationProfileManager struct. +65/-46 storage_nocache.go                                                                                    pkg/storage/v1/storage_nocache.go Implemented the PatchApplicationProfile method in the StorageNoCache struct. +12/-0 storage_interface.go                                                                                pkg/storage/storage_interface.go Added the PatchApplicationProfile method to the StorageClient interface. +1/-0
Tests	storage_test.go                                                                                          pkg/storage/v1/storage_test.go Added new test cases for the PatchNetworkNeighbors and PatchApplicationProfile methods. +135/-0 applicationprofile_manager_test.go                                                    pkg/applicationprofilemanager/v1/applicationprofile_manager_test.go Updated the TestApplicationProfileManager test case to accommodate the changes made in the applicationprofile_manager.go file. +15/-5 storage_mock.go                                                                                          pkg/storage/storage_mock.go Added a mock for the PatchApplicationProfile method and updated the CreateApplicationProfile method to simulate a failure on the first call. +14/-0
Dependencies	go.sum                                                                                                            go.sum Updated the version of the github.com/kubescape/storage package. +2/-2 go.mod                                                                                                            go.mod Updated the version of the github.com/kubescape/storage package. +1/-1

---

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

[github-actions]

Summary:

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

[codiumai-pr-agent-free]

PR Description updated to latest commit (084591b)

[codiumai-pr-agent-free]

PR Analysis

• 🎯 Main theme: Implementing patching for application profiles
• 📝 PR summary: This PR introduces patching for application profiles. It adds new fields to the ApplicationProfileManager struct, implements saving new activities, updating profiles, and handling errors during these operations. It also adds the PatchApplicationProfile method to the StorageClient interface and implements it in the StorageNoCache struct. New test cases have been added for the new methods.
• 📌 Type of PR: Enhancement
• 🧪 Relevant tests added: Yes
• ⏱️ Estimated effort to review [1-5]: 4, because the PR involves changes in multiple files and introduces new logic for patching application profiles. The changes are not trivial and require a good understanding of the existing codebase to review effectively.
• 🔒 Security concerns: No

PR Feedback

💡 General suggestions: The code changes are generally well-structured and follow good practices. However, there are a few areas where the code could be improved:

• The logic in the saveProfile function in applicationprofile_manager.go is quite complex. It might be beneficial to break this function down into smaller, more manageable functions.
• The use of magic numbers in the test cases (e.g., time.Sleep(12 * time.Second)) could potentially lead to flaky tests. It would be better to use synchronization primitives or channels to control the flow of the tests.
• The error handling could be improved. For example, in the saveProfile function, if syscallPeekFunc fails, the function continues to execute. It might be better to return early in this case.

---

✨ 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
error handling	Improve error handling in the saveProfile function.              The error handling in the saveProfile function could be improved. Currently, the function continues executing even if an error occurs when getting syscalls from IG. Instead, the function should return immediately after logging the error. pkg/applicationprofilemanager/v1/applicationprofile_manager.go [160-163] observedSyscalls, err := am.syscallPeekFunc(watchedContainer.NsMntId) if err != nil { logger.L().Ctx(ctx).Error("ApplicationProfileManager - failed to get syscalls", helpers.Error(err)) + return } Improve error messages in the PatchApplicationProfile function.  The error messages in the PatchApplicationProfile function could be more specific. Currently, the error messages do not provide enough context to understand what went wrong. Consider including the name and namespace of the profile in the error messages. pkg/storage/v1/storage_nocache.go [118-121] _, err = sc.StorageClient.ApplicationProfiles(namespace).Patch(context.Background(), name, types.StrategicMergePatchType, bytes, metav1.PatchOptions{}) if err != nil { - return fmt.Errorf("patch neighbors: %w", err) + return fmt.Errorf("failed to patch application profile '%s' in namespace '%s': %w", name, namespace, err) }
maintainability	Refactor the saveProfile function to improve readability and maintainability. The saveProfile function could be refactored to improve readability and maintainability. Currently, the function is quite long and does a lot of different things. Consider breaking it up into smaller, more manageable functions. pkg/applicationprofilemanager/v1/applicationprofile_manager.go [153-308] func (am *ApplicationProfileManager) saveProfile(ctx context.Context, watchedContainer *containercollection.Container) { + ... + am.saveApplicationActivity(ctx, watchedContainer) + am.saveApplicationProfile(ctx, watchedContainer) ... } +func (am *ApplicationProfileManager) saveApplicationActivity(ctx context.Context, watchedContainer *containercollection.Container) { + ... +} + +func (am *ApplicationProfileManager) saveApplicationProfile(ctx context.Context, watchedContainer *containercollection.Container) { + ... +} +
test improvement	Refactor the TestApplicationProfileManager test to use subtests. The TestApplicationProfileManager test could be improved by using subtests. Currently, the test is doing multiple things and it would be easier to understand and maintain if it was split into subtests. pkg/applicationprofilemanager/v1/applicationprofile_manager_test.go [19-89] func TestApplicationProfileManager(t *testing.T) { + t.Run("test application profile manager initialization", func(t *testing.T) { + ... + }) + t.Run("test application profile manager with container callback", func(t *testing.T) { + ... + }) ... }

---

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

Caveat: if we have several replica saving on the same profile, they will override syscalls

[github-actions]

Summary:

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

[github-actions]

Summary:

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