Move integration tests from cmd to cmd/tests

See #2459
grafana · Jan 17, 2023 · 2378549 · 2378549
1 parent 0f93267
commit 2378549
Show file tree

Hide file tree

Showing 13 changed files with 262 additions and 244 deletions.
diff --git a/cmd/archive_test.go b/cmd/archive_test.go
@@ -13,7 +13,7 @@ import (
 
 	"github.com/spf13/afero"
 	"github.com/stretchr/testify/require"
-	"go.k6.io/k6/cmd/state"
+	"go.k6.io/k6/cmd/tests"
 	"go.k6.io/k6/errext/exitcodes"
 )
 
@@ -79,7 +79,7 @@ func TestArchiveThresholds(t *testing.T) {
 			testScript, err := ioutil.ReadFile(testCase.testFilename)
 			require.NoError(t, err)
 
-			ts := state.NewGlobalTestState(t)
+			ts := tests.NewGlobalTestState(t)
 			require.NoError(t, afero.WriteFile(ts.FS, filepath.Join(ts.Cwd, testCase.testFilename), testScript, 0o644))
 			ts.CmdArgs = []string{"k6", "archive", testCase.testFilename}
 			if testCase.noThresholds {
@@ -100,7 +100,7 @@ func TestArchiveContainsEnv(t *testing.T) {
 	// given some script that will be archived
 	fileName := "script.js"
 	testScript := []byte(`export default function () {}`)
-	ts := state.NewGlobalTestState(t)
+	ts := tests.NewGlobalTestState(t)
 	require.NoError(t, afero.WriteFile(ts.FS, filepath.Join(ts.Cwd, fileName), testScript, 0o644))
 
 	// when we do archiving and passing the `--env` flags
@@ -133,7 +133,7 @@ func TestArchiveNotContainsEnv(t *testing.T) {
 	// given some script that will be archived
 	fileName := "script.js"
 	testScript := []byte(`export default function () {}`)
-	ts := state.NewGlobalTestState(t)
+	ts := tests.NewGlobalTestState(t)
 	require.NoError(t, afero.WriteFile(ts.FS, filepath.Join(ts.Cwd, fileName), testScript, 0o644))
 
 	// when we do archiving and passing the `--env` flags altogether with `--exclude-env-vars` flag

diff --git a/cmd/config_consolidation_test.go b/cmd/config_consolidation_test.go
@@ -11,6 +11,7 @@ import (
 	"gopkg.in/guregu/null.v3"
 
 	"go.k6.io/k6/cmd/state"
+	"go.k6.io/k6/cmd/tests"
 	"go.k6.io/k6/lib"
 	"go.k6.io/k6/lib/executor"
 	"go.k6.io/k6/lib/types"
@@ -486,7 +487,7 @@ func getConfigConsolidationTestCases() []configConsolidationTestCase {
 func runTestCase(t *testing.T, testCase configConsolidationTestCase, subCmd string) {
 	t.Logf("Test for `k6 %s` with opts=%#v and exp=%#v\n", subCmd, testCase.options, testCase.expected)
 
-	ts := state.NewGlobalTestState(t)
+	ts := tests.NewGlobalTestState(t)
 	ts.CmdArgs = append([]string{"k6", subCmd}, testCase.options.cli...)
 	ts.Env = state.BuildEnvMap(testCase.options.env)
 	if testCase.options.fs != nil {

diff --git a/cmd/convert_test.go b/cmd/convert_test.go
@@ -9,7 +9,7 @@ import (
 	"github.com/spf13/afero"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
-	"go.k6.io/k6/cmd/state"
+	"go.k6.io/k6/cmd/tests"
 )
 
 const testHAR = `
@@ -108,7 +108,7 @@ func TestConvertCmdCorrelate(t *testing.T) {
 	expectedTestPlan, err := ioutil.ReadFile("testdata/example.js")
 	require.NoError(t, err)
 
-	ts := state.NewGlobalTestState(t)
+	ts := tests.NewGlobalTestState(t)
 	require.NoError(t, afero.WriteFile(ts.FS, "correlate.har", har, 0o644))
 	ts.CmdArgs = []string{
 		"k6", "convert", "--output=result.js", "--correlate=true", "--no-batch=true",
@@ -143,7 +143,7 @@ func TestConvertCmdCorrelate(t *testing.T) {
 
 func TestConvertCmdStdout(t *testing.T) {
 	t.Parallel()
-	ts := state.NewGlobalTestState(t)
+	ts := tests.NewGlobalTestState(t)
 	require.NoError(t, afero.WriteFile(ts.FS, "stdout.har", []byte(testHAR), 0o644))
 	ts.CmdArgs = []string{"k6", "convert", "stdout.har"}
 
@@ -154,7 +154,7 @@ func TestConvertCmdStdout(t *testing.T) {
 func TestConvertCmdOutputFile(t *testing.T) {
 	t.Parallel()
 
-	ts := state.NewGlobalTestState(t)
+	ts := tests.NewGlobalTestState(t)
 	require.NoError(t, afero.WriteFile(ts.FS, "output.har", []byte(testHAR), 0o644))
 	ts.CmdArgs = []string{"k6", "convert", "--output", "result.js", "output.har"}
 

diff --git a/cmd/panic_integration_test.go b/cmd/panic_integration_test.go
@@ -10,7 +10,7 @@ import (
 	"github.com/spf13/afero"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
-	"go.k6.io/k6/cmd/state"
+	"go.k6.io/k6/cmd/tests"
 	"go.k6.io/k6/errext/exitcodes"
 	"go.k6.io/k6/js/modules"
 	"go.k6.io/k6/lib/testutils"
@@ -85,7 +85,7 @@ func TestRunScriptPanicsErrorsAndAbort(t *testing.T) {
 			t.Parallel()
 
 			testFilename := "script.js"
-			ts := state.NewGlobalTestState(t)
+			ts := tests.NewGlobalTestState(t)
 			require.NoError(t, afero.WriteFile(ts.FS, filepath.Join(ts.Cwd, testFilename), []byte(tc.testScript), 0o644))
 			ts.CmdArgs = []string{"k6", "run", testFilename}
 

diff --git a/cmd/root.go b/cmd/root.go
@@ -131,6 +131,13 @@ func Execute() {
 	newRootCommand(gs).execute()
 }
 
+// ExecuteWithGlobalState runs the root command with an existing GlobalState.
+// This is needed by integration tests, and we don't want to modify the
+// Execute() signature to avoid breaking k6 extensions.
+func ExecuteWithGlobalState(gs *state.GlobalState) {
+	newRootCommand(gs).execute()
+}
+
 func (c *rootCommand) waitRemoteLogger() {
 	if c.loggerIsRemote {
 		select {

diff --git a/cmd/root_test.go b/cmd/root_test.go
@@ -2,74 +2,22 @@ package cmd
 
 import (
 	"bytes"
-	"fmt"
-	"net/http"
-	"os"
-	"sync/atomic"
 	"testing"
 
 	"github.com/sirupsen/logrus"
 	"github.com/stretchr/testify/assert"
-	"go.k6.io/k6/cmd/state"
+	"go.k6.io/k6/cmd/tests"
 	"go.k6.io/k6/lib/testutils"
-	"go.uber.org/goleak"
 )
 
-type blockingTransport struct {
-	fallback       http.RoundTripper
-	forbiddenHosts map[string]bool
-	counter        uint32
-}
-
-func (bt *blockingTransport) RoundTrip(req *http.Request) (*http.Response, error) {
-	host := req.URL.Hostname()
-	if bt.forbiddenHosts[host] {
-		atomic.AddUint32(&bt.counter, 1)
-		panic(fmt.Errorf("trying to make forbidden request to %s during test", host))
-	}
-	return bt.fallback.RoundTrip(req)
-}
-
 func TestMain(m *testing.M) {
-	exitCode := 1 // error out by default
-	defer func() {
-		os.Exit(exitCode)
-	}()
-
-	bt := &blockingTransport{
-		fallback: http.DefaultTransport,
-		forbiddenHosts: map[string]bool{
-			"ingest.k6.io":    true,
-			"cloudlogs.k6.io": true,
-			"app.k6.io":       true,
-			"reports.k6.io":   true,
-		},
-	}
-	http.DefaultTransport = bt
-	defer func() {
-		if bt.counter > 0 {
-			fmt.Printf("Expected blocking transport count to be 0 but was %d\n", bt.counter) //nolint:forbidigo
-			exitCode = 2
-		}
-	}()
-
-	defer func() {
-		// TODO: figure out why logrus' `Entry.WriterLevel` goroutine sticks
-		// around and remove this exception.
-		opt := goleak.IgnoreTopFunction("io.(*pipe).read")
-		if err := goleak.Find(opt); err != nil {
-			fmt.Println(err) //nolint:forbidigo
-			exitCode = 3
-		}
-	}()
-
-	exitCode = m.Run()
+	tests.Main(m)
 }
 
 func TestDeprecatedOptionWarning(t *testing.T) {
 	t.Parallel()
 
-	ts := state.NewGlobalTestState(t)
+	ts := tests.NewGlobalTestState(t)
 	ts.CmdArgs = []string{"k6", "--logformat", "json", "run", "-"}
 	ts.Stdin = bytes.NewBuffer([]byte(`
 		console.log('foo');

diff --git a/cmd/run_test.go b/cmd/run_test.go
@@ -18,7 +18,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	"go.k6.io/k6/cmd/state"
+	"go.k6.io/k6/cmd/tests"
 	"go.k6.io/k6/errext"
 	"go.k6.io/k6/errext/exitcodes"
 	"go.k6.io/k6/lib/fsext"
@@ -201,7 +201,7 @@ func TestRunScriptErrorsAndAbort(t *testing.T) {
 			testScript, err := ioutil.ReadFile(path.Join("testdata", tc.testFilename))
 			require.NoError(t, err)
 
-			ts := state.NewGlobalTestState(t)
+			ts := tests.NewGlobalTestState(t)
 			require.NoError(t, afero.WriteFile(ts.FS, filepath.Join(ts.Cwd, tc.testFilename), testScript, 0o644))
 			ts.CmdArgs = append([]string{"k6", "run", tc.testFilename}, tc.extraArgs...)
 
@@ -256,7 +256,7 @@ func TestInvalidOptionsThresholdErrExitCode(t *testing.T) {
 			testScript, err := ioutil.ReadFile(path.Join("testdata", tc.testFilename))
 			require.NoError(t, err)
 
-			ts := state.NewGlobalTestState(t)
+			ts := tests.NewGlobalTestState(t)
 			require.NoError(t, afero.WriteFile(ts.FS, filepath.Join(ts.Cwd, tc.testFilename), testScript, 0o644))
 			ts.CmdArgs = append([]string{"k6", "run", tc.testFilename}, tc.extraArgs...)
 
@@ -306,7 +306,7 @@ func TestThresholdsRuntimeBehavior(t *testing.T) {
 			testScript, err := ioutil.ReadFile(path.Join("testdata", tc.testFilename))
 			require.NoError(t, err)
 
-			ts := state.NewGlobalTestState(t)
+			ts := tests.NewGlobalTestState(t)
 			require.NoError(t, afero.WriteFile(ts.FS, filepath.Join(ts.Cwd, tc.testFilename), testScript, 0o644))
 
 			ts.CmdArgs = []string{"k6", "run", tc.testFilename}

diff --git a/cmd/runtime_options_test.go b/cmd/runtime_options_test.go
@@ -11,7 +11,7 @@ import (
 	"github.com/stretchr/testify/require"
 	"gopkg.in/guregu/null.v3"
 
-	"go.k6.io/k6/cmd/state"
+	"go.k6.io/k6/cmd/tests"
 	"go.k6.io/k6/lib"
 	"go.k6.io/k6/loader"
 	"go.k6.io/k6/metrics"
@@ -59,7 +59,7 @@ func testRuntimeOptionsCase(t *testing.T, tc runtimeOptionsTestCase) {
 	fs := afero.NewMemMapFs()
 	require.NoError(t, afero.WriteFile(fs, "/script.js", jsCode.Bytes(), 0o644))
 
-	ts := state.NewGlobalTestState(t) // TODO: move upwards, make this into an almost full integration test
+	ts := tests.NewGlobalTestState(t) // TODO: move upwards, make this into an almost full integration test
 	registry := metrics.NewRegistry()
 	test := &loadedTest{
 		sourceRootPath: "script.js",