search

kubescape / storage

Apache License 2.0
1 stars 6 forks source link

Add network policy test for generating network policy with big network #100

Closed kooomix closed 4 months ago

kooomix commented 4 months ago

Type

enhancement

Description

This PR adds a new test function TestGenerateNetworkPolicyBigNetwork to test the generation of network policy for a big network. It also adds a new embedded test data file testdata/BigNetworkNeighbors.json. Additionally, it updates the go.sum and go.mod files to include new dependencies and update existing ones. The changes include adding new packages, importing necessary packages, unmarshaling the test data file, generating network policy, and adding assertions to check for errors.

Changes walkthrough

Relevant files
Enhancement
networkpolicy_test.go
Add test for generating network policy with big network   
pkg/apis/softwarecomposition/v1beta1/networkpolicy/networkpolicy_test.go
  • Added test function TestGenerateNetworkPolicyBigNetwork to test the
    generation of network policy for a big network.
  • Added embedded test data file testdata/BigNetworkNeighbors.json.
  • Imported packages encoding/json, fmt, time,
    github.com/armosec/known-servers-generator/pkg/cache, and
    go.uber.org/zap.
  • Added code to unmarshal the test data file into
    softwarecomposition.NetworkNeighbors.
  • Added code to generate network policy using the test data and known
    servers cache.
  • Added assertions to check for errors during unmarshaling and network
    policy generation.
  • Added print statement to display the generated network policy.
    		• +29/-0   
    go.sum
    Update dependencies in go.sum                                                       
    go.sum
  • Added new dependencies:
    - github.com/armosec/known-servers-generator
    v0.0.9
    - dario.cat/mergo v1.0.0
    - github.com/cloudflare/circl
    v1.3.3
    - github.com/ProtonMail/go-crypto
    v0.0.0-20230828082145-3c4c8a2d2371
    -
    github.com/cyphar/filepath-securejoin v0.2.4
    -
    github.com/kevinburke/ssh_config v1.2.0
    - github.com/pjbgf/sha1cd
    v0.3.0
    - github.com/skeema/knownhosts v1.2.1
    -
    github.com/xanzy/ssh-agent v0.3.3
    - golang.org/x/crypto
    v0.0.0-20220622213112-05595931fe9d
    - golang.org/x/crypto
    v0.3.1-0.20221117191849-2c476679df9a
    - golang.org/x/crypto v0.7.0

    - golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2
    -
    gopkg.in/warnings.v0 v0.1.2
  • Updated existing dependencies.
    		• +47/-0   
    go.mod
    Update dependencies in go.mod                                                       
    go.mod
  • Added new indirect dependencies:
    - dario.cat/mergo v1.0.0
    -
    github.com/armosec/known-servers-generator v0.0.9
    -
    github.com/cloudflare/circl v1.3.3
    - github.com/ProtonMail/go-crypto
    v0.0.0-20230828082145-3c4c8a2d2371
    -
    github.com/cyphar/filepath-securejoin v0.2.4
    -
    github.com/kevinburke/ssh_config v1.2.0
    - github.com/pjbgf/sha1cd
    v0.3.0
    - github.com/skeema/knownhosts v1.2.1
    -
    github.com/xanzy/ssh-agent v0.3.3
    - golang.org/x/crypto
    v0.0.0-20220622213112-05595931fe9d
    - golang.org/x/crypto
    v0.3.1-0.20221117191849-2c476679df9a
    - golang.org/x/crypto v0.7.0

    - golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2
    -
    gopkg.in/warnings.v0 v0.1.2
  • Updated existing dependencies.
    		• +16/-0   

    ✨ PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    codiumai-pr-agent[bot] commented 4 months ago

    PR Description updated to latest commit (https://github.com/kubescape/storage/commit/09d17d181c4054e27d471573a45acd19727a0e9d)

    codiumai-pr-agent[bot] commented 4 months ago

    PR Review

    ⏱️ Estimated effort to review [1-5] 2, because the PR primarily focuses on adding a new test function along with its test data and updating dependencies. The logic within the new test function is straightforward and mainly involves generating a network policy from provided test data, making it relatively easy to review.
    🧪 Relevant tests Yes
    🔍 Possible issues The PR introduces new dependencies (`github.com/armosec/known-servers-generator v0.0.9` and others as indirect dependencies). It's important to ensure that these dependencies are well-maintained and secure.
    The use of `fmt.Println` within tests (`fmt.Println(generatedNP)`) is generally discouraged outside of debugging. Consider using a logger or removing it if it was added for debugging purposes.
    🔒 Security concerns No, the PR does not introduce any direct security concerns. However, it's important to review the newly introduced dependencies for any potential security issues.
    ✨ Review tool usage guide:
    **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=... ```
    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 'possible issues' 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](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
    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](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)
    Extra sub-tools
    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.
    Auto-approve PRs
    By invoking: ``` /review auto_approve ``` The tool will automatically approve the PR, and add a comment with the approval. To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following: ``` [pr_reviewer] enable_auto_approval = true ``` (this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository) You can also enable auto-approval only if the PR meets certain requirements, such as that the `estimated_review_effort` is equal or below a certain threshold, by adjusting the flag: ``` [pr_reviewer] maximal_review_effort = 5 ```
    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 \**: 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.
    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.
    codiumai-pr-agent[bot] commented 4 months ago

    PR Code Suggestions

    Suggestions                                                                                                                                                     
    best practice
    Handle errors from fmt.Println to catch print issues.                         ___ **Consider handling the error returned by fmt.Println(generatedNP) to ensure that any issues
    with printing the network policy are caught.** [pkg/apis/softwarecomposition/v1beta1/networkpolicy/networkpolicy_test.go [41]](https:/kubescape/storage/pull/100/files#diff-460886b2f266e9d0ca5a73910bd624cd670d91376ab9e50a349a41b04ea1522dR41-R41) ```diff -fmt.Println(generatedNP) +if _, err := fmt.Println(generatedNP); err != nil { + t.Errorf("failed to print generated network policy: %v", err) +} ```
    Use require.NoError for immediate test failure on error.                      ___ **Instead of using assert.NoError(t, err), consider using require.NoError(t, err) to
    immediately stop the test on a failure. This is especially useful for setup steps where
    continuing the test doesn't make sense on failure.** [pkg/apis/softwarecomposition/v1beta1/networkpolicy/networkpolicy_test.go [30-40]](https:/kubescape/storage/pull/100/files#diff-460886b2f266e9d0ca5a73910bd624cd670d91376ab9e50a349a41b04ea1522dR30-R40) ```diff -assert.NoError(t, err, "failed to create known servers cache") -assert.NoError(t, err, "failed to unmarshal network neighbors") -assert.NoError(t, err, "failed to generate network policy") +require.NoError(t, err, "failed to create known servers cache") +require.NoError(t, err, "failed to unmarshal network neighbors") +require.NoError(t, err, "failed to generate network policy") ```
    Add a cleanup step for resources created in tests.                            ___ **Consider adding a cleanup step for resources created during the test, such as the known
    servers cache, to prevent side effects on other tests.** [pkg/apis/softwarecomposition/v1beta1/networkpolicy/networkpolicy_test.go [28]](https:/kubescape/storage/pull/100/files#diff-460886b2f266e9d0ca5a73910bd624cd670d91376ab9e50a349a41b04ea1522dR28-R28) ```diff knownServersCache, err := cache.NewKnownServersCache(zap.NewNop(), 5*time.Minute, "") +t.Cleanup(func() { + knownServersCache.Close() // Assuming Close() is the method to release resources +}) ```
    Use a mock time provider for predictable test outcomes.                       ___ **To ensure the test is more resilient to changes, consider using a mock time provider
    instead of v1.Now() directly. This allows for more predictable and testable outcomes.** [pkg/apis/softwarecomposition/v1beta1/networkpolicy/networkpolicy_test.go [26]](https:/kubescape/storage/pull/100/files#diff-460886b2f266e9d0ca5a73910bd624cd670d91376ab9e50a349a41b04ea1522dR26-R26) ```diff -timeProvider := v1.Now() +mockTime := time.Date(2023, time.January, 1, 0, 0, 0, 0, time.UTC) +timeProvider := v1.NewTime(mockTime) ```
    maintainability
    Refactor setup code into a separate function for clarity.                     ___ **To improve test readability and maintainability, consider moving the setup code (like
    creating the known servers cache) into a separate function or using a test setup fixture.** [pkg/apis/softwarecomposition/v1beta1/networkpolicy/networkpolicy_test.go [28-32]](https:/kubescape/storage/pull/100/files#diff-460886b2f266e9d0ca5a73910bd624cd670d91376ab9e50a349a41b04ea1522dR28-R32) ```diff -knownServersCache, err := cache.NewKnownServersCache(zap.NewNop(), 5*time.Minute, "") -assert.NoError(t, err, "failed to create known servers cache") -knownServers := knownServersCache.GetKnownServers() +knownServers := setupKnownServersCache(t) ```
    ✨ Improve tool 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](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=... ```
    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 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, 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.
    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 \**: 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.
    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.