Add test for plugin scaffold command
#613
Merged
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
Overview
Packages and Vulnerabilities (5 package changes and 0 vulnerability changes)
Changes for packages of type
|
| Package | Versionghcr.io/gatewayd-io/gatewayd:efc8668 |
Versiongatewaydio/gatewayd:latest |
|
|---|---|---|---|
| ➖ | ca-certificates | 20240705-r0 |
|
| ➖ | openssl | 3.3.2-r0 |
|
| ➖ | pax-utils | 1.3.7-r2 |
Changes for packages of type golang (2 changes)
| Package | Versionghcr.io/gatewayd-io/gatewayd:efc8668 |
Versiongatewaydio/gatewayd:latest |
|
|---|---|---|---|
| ♾️ | github.com/gatewayd-io/gatewayd | (devel) |
0.9.8 |
| ♾️ | stdlib | go1.23.2 |
1.23.1 |
4 tasks
mostafa
force-pushed
the
zeina1i/scaffold-tests
branch
from
6dd9adb to
07f1338
Compare
sinadarbouy
reviewed
Oct 3, 2024
| require.NoError(t, err, "plugin scaffold should not return an error") | ||
| assert.Contains(t, output, "scaffold done") | ||
| assert.Contains(t, output, "created files:") | ||
| assert.Contains(t, output, "test-gatewayd-plugin/.github/issue_template.md") |
There was a problem hiding this comment.
we use test-gateway-plugin multiple times, we can have a valuable for it like
pluginDir := filepath.Join(t.TempDir(), "test-gatewayd-plugin")
There was a problem hiding this comment.
we can use t.TempDir() to avoid polluting the working directory - https://pkg.go.dev/testing#B.TempDir
cmd/plugin_scaffold_test.go
Outdated
| err = yamlv3.Unmarshal(pluginsConfig, &localPluginsConfig) | ||
| require.NoError(t, err, "unmarshalling yaml file should not return error") | ||
|
|
||
| tidy := exec.Command("go", "mod", "tidy") |
There was a problem hiding this comment.
now, we use the same structure twice; we can create a separate function for it
func runCommand(command string, args ...string) error {
cmd := exec.Command(command, args...)
cmd.Dir = args[len(args)-1]
return cmd.Run()
}
cmd/plugin_scaffold_test.go
Outdated
| err = build.Run() | ||
| assert.NoError(t, err) | ||
|
|
||
| _, err = os.ReadFile(filepath.Join("plugins", "test-gatewayd-plugin", "test-gatewayd-plugin")) |
There was a problem hiding this comment.
if we want to verify that file exist we can use os.stat without reading the binary
Suggested change
| _, err = os.ReadFile(filepath.Join("plugins", "test-gatewayd-plugin", "test-gatewayd-plugin")) | |
| _, err = os.Stat(filepath.Join("plugins", "test-gatewayd-plugin", "test-gatewayd-plugin")) |
cmd/plugin_scaffold_test.go
Outdated
| assert.NoError(t, err) | ||
|
|
||
| _, err = os.ReadFile(filepath.Join("plugins", "test-gatewayd-plugin", "test-gatewayd-plugin")) | ||
| require.NoError(t, err, "reading plugin binary file should not return an error") |
There was a problem hiding this comment.
Suggested change
| require.NoError(t, err, "reading plugin binary file should not return an error") | |
| require.NoError(t, err, "plugin binary file should exist") |
cmd/plugin_scaffold_test.go
Outdated
|
|
||
| pluginsList := cast.ToSlice(localPluginsConfig["plugins"]) | ||
| plugin := cast.ToStringMap(pluginsList[0]) | ||
| pluginsList[0] = plugin |
There was a problem hiding this comment.
unnecessary, we do the same later
Suggested change
| pluginsList[0] = plugin |
cmd/plugin_scaffold_test.go
Outdated
|
|
||
| waitGroup.Wait() | ||
|
|
||
| assert.NoError(t, os.RemoveAll("plugins")) |
There was a problem hiding this comment.
if we use t.TempDir() we dont need this line
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.
Ticket(s)
Closes #475.
Description
Add test for
plugin scaffoldcommand. Thanks to @zeina1i for implementing the feature and writing the original test.Related PRs
N/A
Development Checklist
make gen-docscommand.Legal Checklist