Add test for plugin scaffold command
#613
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,132 @@ | ||||||
| package cmd | ||||||
|
|
||||||
| import ( | ||||||
| "context" | ||||||
| "os" | ||||||
| "os/exec" | ||||||
| "path/filepath" | ||||||
| "sync" | ||||||
| "testing" | ||||||
| "time" | ||||||
|
|
||||||
| "github.com/codingsince1985/checksum" | ||||||
| "github.com/gatewayd-io/gatewayd/config" | ||||||
| "github.com/gatewayd-io/gatewayd/plugin" | ||||||
| "github.com/gatewayd-io/gatewayd/testhelpers" | ||||||
| "github.com/spf13/cast" | ||||||
| "github.com/stretchr/testify/assert" | ||||||
| "github.com/stretchr/testify/require" | ||||||
| yamlv3 "gopkg.in/yaml.v3" | ||||||
| ) | ||||||
|
|
||||||
| func Test_pluginScaffoldCmd(t *testing.T) { | ||||||
| // Start the test containers. | ||||||
| ctx := context.Background() | ||||||
| postgresHostIP1, postgresMappedPort1 := testhelpers.SetupPostgreSQLTestContainer(ctx, t) | ||||||
| postgresHostIP2, postgresMappedPort2 := testhelpers.SetupPostgreSQLTestContainer(ctx, t) | ||||||
| postgresAddress1 := postgresHostIP1 + ":" + postgresMappedPort1.Port() | ||||||
| t.Setenv("GATEWAYD_CLIENTS_DEFAULT_WRITES_ADDRESS", postgresAddress1) | ||||||
| postgresAddress2 := postgresHostIP2 + ":" + postgresMappedPort2.Port() | ||||||
| t.Setenv("GATEWAYD_CLIENTS_TEST_WRITE_ADDRESS", postgresAddress2) | ||||||
|
|
||||||
| globalTestConfigFile := filepath.Join("testdata", "gatewayd.yaml") | ||||||
| plugin.IsPluginTemplateEmbedded() | ||||||
| pluginTestScaffoldInputFile := "./testdata/scaffold_input.yaml" | ||||||
|
|
||||||
| output, err := executeCommandC( | ||||||
| rootCmd, "plugin", "scaffold", "-i", pluginTestScaffoldInputFile) | ||||||
| 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") | ||||||
| assert.Contains(t, output, "test-gatewayd-plugin/.github/pull_request_template.md") | ||||||
| assert.Contains(t, output, "test-gatewayd-plugin/.github/workflows/commits-signed.yaml") | ||||||
|
|
||||||
| pluginsConfig, err := os.ReadFile( | ||||||
| filepath.Join("plugins", "test-gatewayd-plugin", "gatewayd_plugin.yaml")) | ||||||
| require.NoError(t, err, "reading plugins config file should not return an error") | ||||||
|
|
||||||
| var localPluginsConfig map[string]interface{} | ||||||
| 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 |
||||||
| tidy.Dir = filepath.Join("plugins", "test-gatewayd-plugin") | ||||||
| err = tidy.Run() | ||||||
| assert.NoError(t, err) | ||||||
|
|
||||||
| build := exec.Command("make", "build-dev") | ||||||
| build.Dir = filepath.Join("plugins", "test-gatewayd-plugin") | ||||||
| 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
|
||||||
| require.NoError(t, err, "reading plugin binary file should not return an error") | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| 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
|
||||||
| plugin["localPath"] = filepath.Join("cmd", "plugins", "test-gatewayd-plugin", "test-gatewayd-plugin") | ||||||
| sum, err := checksum.SHA256sum(filepath.Join("plugins", "test-gatewayd-plugin", "test-gatewayd-plugin")) | ||||||
| require.NoError(t, err, "marshalling yaml file should not return error") | ||||||
| plugin["checksum"] = sum | ||||||
|
|
||||||
| pluginsList[0] = plugin | ||||||
| plugins := make(map[string]interface{}) | ||||||
| plugins["plugins"] = pluginsList | ||||||
|
|
||||||
| updatedPluginConfig, err := yamlv3.Marshal(plugins) | ||||||
| require.NoError(t, err, "marshalling yaml file should not return error") | ||||||
|
|
||||||
| err = os.WriteFile( | ||||||
| filepath.Join("plugins", "test-gatewayd-plugin", "gatewayd_plugins.yaml"), | ||||||
| updatedPluginConfig, FilePermissions) | ||||||
| require.NoError(t, err, "writingh to yaml file should not return error") | ||||||
|
|
||||||
| pluginTestConfigFile := filepath.Join( | ||||||
| "plugins", "test-gatewayd-plugin", "gatewayd_plugins.yaml") | ||||||
|
|
||||||
| stopChan = make(chan struct{}) | ||||||
|
|
||||||
| var waitGroup sync.WaitGroup | ||||||
|
|
||||||
| waitGroup.Add(1) | ||||||
| go func(waitGroup *sync.WaitGroup) { | ||||||
| // Test run command. | ||||||
| output, err := executeCommandC( | ||||||
| rootCmd, "run", "-c", globalTestConfigFile, "-p", pluginTestConfigFile) | ||||||
| require.NoError(t, err, "run command should not have returned an error") | ||||||
|
|
||||||
| // Print the output for debugging purposes. | ||||||
| runCmd.Print(output) | ||||||
| // Check if GatewayD started and stopped correctly. | ||||||
| assert.Contains(t, output, "GatewayD is running") | ||||||
| assert.Contains(t, output, "Stopped all servers") | ||||||
|
|
||||||
| waitGroup.Done() | ||||||
| }(&waitGroup) | ||||||
|
|
||||||
| waitGroup.Add(1) | ||||||
| go func(waitGroup *sync.WaitGroup) { | ||||||
| time.Sleep(waitBeforeStop) | ||||||
|
|
||||||
| StopGracefully( | ||||||
| context.Background(), | ||||||
| nil, | ||||||
| nil, | ||||||
| metricsServer, | ||||||
| nil, | ||||||
| loggers[config.Default], | ||||||
| servers, | ||||||
| stopChan, | ||||||
| nil, | ||||||
| nil, | ||||||
| ) | ||||||
|
|
||||||
| waitGroup.Done() | ||||||
| }(&waitGroup) | ||||||
|
|
||||||
| 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 |
||||||
| } | ||||||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| remote_url: https://github.com/gatewayd-io/test-gatewayd-plugin | ||
| version: 0.1 | ||
| description: This is test plugin | ||
| license: MIT | ||
| authors: | ||
| - GatewayD Team |
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we use
test-gateway-pluginmultiple times, we can have a valuable for it likepluginDir := filepath.Join(t.TempDir(), "test-gatewayd-plugin")There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we can use t.TempDir() to avoid polluting the working directory - https://pkg.go.dev/testing#B.TempDir
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Addressed in d7cf221.