test: replace embedded Git repository with dynamically created repository #6824
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: knqyf263 <knqyf263@gmail.com>
Signed-off-by: knqyf263 <knqyf263@gmail.com>
Signed-off-by: knqyf263 <knqyf263@gmail.com>
DmitriyLewen
reviewed
Jun 3, 2024
| } | ||
|
|
||
| func TestManager_Install(t *testing.T) { | ||
| gs := setupGitRepository(t, "test_plugin", "testdata/test_plugin") | ||
| t.Cleanup(gs.Close) | ||
|
|
||
| ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { |
There was a problem hiding this comment.
I detected one problem with this test server:
this zip file doesn't contain nested dir:
- test_plugin.zip/plugin.yaml
But GitHub archive contains repo name dir:
check https://github.com/aquasecurity/trivy-plugin-kubectl/archive/refs/heads/main.zip
- trivy-plugin-kubectl-main.zip/trivy-plugin-kubectl-main/plugin.yaml
I think we should handle this case, but perhaps in another PR.
There was a problem hiding this comment.
Good point. It's not introduced in this PR. I'll open another PR.
Signed-off-by: knqyf263 <knqyf263@gmail.com>
Signed-off-by: knqyf263 <knqyf263@gmail.com>
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Currently, Trivy includes a separate Git bare repository committed within its codebase for testing purposes. For example: https://github.com/aquasecurity/trivy/tree/29615be85e8bfeaf5a0cd51829b1898c55fa4274/pkg/plugin/testdata/test_plugin.git
While this approach allows us to focus on the logic of the code we want to test, it also has some drawbacks. In order to understand the state of this Git repository, we need to clone it and perform operations using
gitcommands. Additionally, if we want to make small modifications, we need to use git commands, and it's not possible to review the changes made on GitHub since those changes are binary.To address these issues, this PR proposes using go-git to dynamically create the test Git repository during the testing process. Although there is a potential downside that if the process of creating this test repository is incorrect, the tests will fail to run properly, the benefits outweigh this risk, IMO. Using Go to create the repository makes it clearer what branches are being created, what tags are being assigned, and so on. This approach also makes it easier to make changes and conduct reviews on GitHub.
Checklist