chore: move packages to internal

.goreleaser.yml

@@ -13,7 +13,7 @@ builds:
     binary: kubectl-kuttl
     main: cmd/kubectl-kuttl/main.go
     ldflags:
-      - -s -w -X github.com/kudobuilder/kuttl/pkg/version.gitVersion={{ .Version }} -X github.com/kudobuilder/kuttl/pkg/version.gitCommit={{ .ShortCommit }} -X github.com/kudobuilder/kuttl/pkg/version.buildDate={{ .Date }}
+      - -s -w -X github.com/kudobuilder/kuttl/internal/version.gitVersion={{ .Version }} -X github.com/kudobuilder/kuttl/internal/version.gitCommit={{ .ShortCommit }} -X github.com/kudobuilder/kuttl/internal/version.buildDate={{ .Date }}
     goos:
       - linux
       - darwin

Makefile

@@ -1,12 +1,12 @@
 SHELL=/bin/bash -o pipefail
 
 CLI := kubectl-kuttl
-GIT_VERSION_PATH := github.com/kudobuilder/kuttl/pkg/version.gitVersion
+GIT_VERSION_PATH := github.com/kudobuilder/kuttl/internal/version.gitVersion
 GIT_VERSION := $(shell git describe --abbrev=0 --tags | cut -b 2-)
-GIT_COMMIT_PATH := github.com/kudobuilder/kuttl/pkg/version.gitCommit
+GIT_COMMIT_PATH := github.com/kudobuilder/kuttl/internal/version.gitCommit
 GIT_COMMIT := $(shell git rev-parse HEAD | cut -b -8)
 SOURCE_DATE_EPOCH := $(shell git show -s --format=format:%ct HEAD)
-BUILD_DATE_PATH := github.com/kudobuilder/kuttl/pkg/version.buildDate
+BUILD_DATE_PATH := github.com/kudobuilder/kuttl/internal/version.buildDate
 DATE_FMT := "%Y-%m-%dT%H:%M:%SZ"
 BUILD_DATE := $(shell date -u -d "@$SOURCE_DATE_EPOCH" "+${DATE_FMT}" 2>/dev/null || date -u -r "${SOURCE_DATE_EPOCH}" "+${DATE_FMT}" 2>/dev/null || date -u "+${DATE_FMT}")
 LDFLAGS := -X ${GIT_VERSION_PATH}=${GIT_VERSION} -X ${GIT_COMMIT_PATH}=${GIT_COMMIT} -X ${BUILD_DATE_PATH}=${BUILD_DATE}
@@ -131,9 +131,9 @@ all: lint test integration-test e2e-test  ## Runs lint, unit, integration and e2
 test: ## Runs unit tests
 ifdef _INTELLIJ_FORCE_SET_GOFLAGS
 # Run tests from a Goland terminal. Goland already set '-mod=readonly'
-	go test ./pkg/...  -v -coverprofile cover.out
+	go test ./pkg/... ./internal/...  -v -coverprofile cover.out
 else
-	go test ./pkg/...  -v -mod=readonly -coverprofile cover.out
+	go test ./pkg/... ./internal/... -v -mod=readonly -coverprofile cover.out
 endif
 
 .PHONY: integration-test

cmd/kubectl-kuttl/main.go

@@ -17,7 +17,7 @@ package main
 import (
 	"os"
 
-	"github.com/kudobuilder/kuttl/pkg/kuttlctl/cmd"
+	"github.com/kudobuilder/kuttl/internal/kuttlctl/cmd"
 )
 
 func main() {

docs/api-integration.md

@@ -16,13 +16,10 @@ The test harness type is defined in an `apis` package similar to a Kubernetes ty
 
 The `test` package contains the `test.Harness` implementation (given the configuration of the test harness configuration type previously mentioned).  The `test.Harness` provides the "run" of the test run and needs a Go `t *testing.T`.
 
-The `testutils` package contains utilities for docker, kubernetes, loggers and testing.
-
 ```go
 import (
   harness "github.com/kudobuilder/kuttl/pkg/apis/testharness/v1beta1"
   "github.com/kudobuilder/kuttl/pkg/test"
-  testutils "github.com/kudobuilder/kuttl/pkg/test/utils"
 )
 ```
 
@@ -37,16 +34,13 @@ options := harness.TestSuite{}
 The Go `t *testing.T` and `harness.TestSuite` are provided to `test.Harness` which provides the implementation for testing.
 
 ```go
-Run: func(cmd *cobra.Command, args []string) {
-  testutils.RunTests("kudo", testToRun, options.Parallel, func(t *testing.T) {
+func TestWithKuttl(t *testing.T) {
     harness := test.Harness{
       TestSuite: options,
       T:         t,
     }
-
     harness.Run()
-  })
-},
+}
 
 ```
 

docs/cli.md

@@ -137,19 +137,19 @@ parallel: 4
 The default can be run as follows:
 
 ```bash
-kubectl kuttl test  pkg/test/test_data/
+kubectl kuttl test  internal/harness/test_data/
 ```
 
 When running with no defined [test environment](testing/test-environments.md), the default is a preconfigured cluster defined in `$KUBECONFIG`.
 
 To run with the mocked control plane run:
 
 ```bash
-kubectl kuttl test --start-control-plane pkg/test/test_data/
+kubectl kuttl test --start-control-plane internal/harness/test_data/
 ```
 
 In order to run with the full kind cluster stack, run:
 
 ```bash
-kubectl kuttl test --start-kind pkg/test/test_data/
+kubectl kuttl test --start-kind internal/harness/test_data/
 ```

hack/run-integration-tests.sh

@@ -14,8 +14,8 @@ then
     go get github.com/jstemmer/go-junit-report
     go install github.com/jstemmer/go-junit-report
     go mod tidy
-    go test -tags integration ./pkg/... -v -mod=readonly -coverprofile cover-integration.out 2>&1 |tee /dev/fd/2 |go-junit-report -set-exit-code > reports/integration_report.xml
+    go test -tags integration ./pkg/... ./internal/... -v -mod=readonly -coverprofile cover-integration.out 2>&1 |tee /dev/fd/2 |go-junit-report -set-exit-code > reports/integration_report.xml
 else
     echo "Running integration tests without junit output"
-    go test -tags integration ./pkg/... -v -mod=readonly -coverprofile cover-integration.out
+    go test -tags integration ./pkg/... ./internal/... -v -mod=readonly -coverprofile cover-integration.out
 fi

pkg/test/assert/assert.go → internal/assert/assert.go

@@ -8,8 +8,8 @@ import (
 	"k8s.io/client-go/discovery"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
-	"github.com/kudobuilder/kuttl/pkg/kubernetes"
-	"github.com/kudobuilder/kuttl/pkg/test/step"
+	"github.com/kudobuilder/kuttl/internal/kubernetes"
+	"github.com/kudobuilder/kuttl/internal/step"
 )
 
 // Assert checks all provided assert files against a namespace.  Upon assert failure, it prints the failures and returns an error

pkg/file/files.go → internal/file/files.go

@@ -8,7 +8,7 @@ import (
 
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
-	"github.com/kudobuilder/kuttl/pkg/kubernetes"
+	"github.com/kudobuilder/kuttl/internal/kubernetes"
 )
 
 // from a list of paths, returns an array of runtime objects

pkg/test/harness/harness.go → internal/harness/harness.go

@@ -26,14 +26,14 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/envtest"
 	kindConfig "sigs.k8s.io/kind/pkg/apis/config/v1alpha4"
 
+	"github.com/kudobuilder/kuttl/internal/file"
+	"github.com/kudobuilder/kuttl/internal/http"
+	"github.com/kudobuilder/kuttl/internal/kind"
+	"github.com/kudobuilder/kuttl/internal/kubernetes"
+	"github.com/kudobuilder/kuttl/internal/report"
+	"github.com/kudobuilder/kuttl/internal/testcase"
+	testutils "github.com/kudobuilder/kuttl/internal/utils"
 	harness "github.com/kudobuilder/kuttl/pkg/apis/testharness/v1beta1"
-	"github.com/kudobuilder/kuttl/pkg/file"
-	"github.com/kudobuilder/kuttl/pkg/http"
-	"github.com/kudobuilder/kuttl/pkg/kubernetes"
-	"github.com/kudobuilder/kuttl/pkg/report"
-	"github.com/kudobuilder/kuttl/pkg/test/kind"
-	"github.com/kudobuilder/kuttl/pkg/test/testcase"
-	testutils "github.com/kudobuilder/kuttl/pkg/test/utils"
 )
 
 // Harness loads and runs tests based on the configuration provided.

pkg/test/harness/harness_integration_test.go → internal/harness/harness_integration_test.go

@@ -8,8 +8,8 @@ import (
 
 	"github.com/stretchr/testify/assert"
 
+	"github.com/kudobuilder/kuttl/internal/kubernetes"
 	harness "github.com/kudobuilder/kuttl/pkg/apis/testharness/v1beta1"
-	"github.com/kudobuilder/kuttl/pkg/kubernetes"
 )
 
 func TestHarnessRunIntegration(t *testing.T) {

pkg/http/client.go → internal/http/client.go

@@ -12,7 +12,7 @@ import (
 
 	"github.com/dustin/go-humanize"
 
-	"github.com/kudobuilder/kuttl/pkg/version"
+	"github.com/kudobuilder/kuttl/internal/version"
 )
 
 // Client is client used to simplified http requests for tarballs

pkg/http/http.go → internal/http/http.go

@@ -7,7 +7,7 @@ import (
 
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
-	"github.com/kudobuilder/kuttl/pkg/kubernetes"
+	"github.com/kudobuilder/kuttl/internal/kubernetes"
 )
 
 // IsURL returns true if string is an URL

pkg/test/kind/kind.go → internal/kind/kind.go

@@ -10,7 +10,7 @@ import (
 	"sigs.k8s.io/kind/pkg/cluster/nodes"
 	"sigs.k8s.io/kind/pkg/cluster/nodeutils"
 
-	testutils "github.com/kudobuilder/kuttl/pkg/test/utils"
+	testutils "github.com/kudobuilder/kuttl/internal/utils"
 )
 
 // Kind provides a thin abstraction layer for a KIND cluster.

pkg/test/kind/kind_integration_test.go → internal/kind/kind_integration_test.go

@@ -18,7 +18,7 @@ import (
 	"sigs.k8s.io/kind/pkg/apis/config/v1alpha4"
 	"sigs.k8s.io/kind/pkg/cluster/nodes"
 
-	testutils "github.com/kudobuilder/kuttl/pkg/test/utils"
+	testutils "github.com/kudobuilder/kuttl/internal/utils"
 )
 
 const (

pkg/test/kind/kind_logger.go → internal/kind/kind_logger.go

@@ -6,7 +6,7 @@ import (
 	"github.com/spf13/pflag"
 	"sigs.k8s.io/kind/pkg/log"
 
-	testutils "github.com/kudobuilder/kuttl/pkg/test/utils"
+	testutils "github.com/kudobuilder/kuttl/internal/utils"
 )
 
 type level int32

pkg/kubernetes/object_test.go → internal/kubernetes/object_test.go

@@ -9,7 +9,7 @@ import (
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apimachinery/pkg/runtime/schema"
 
-	"github.com/kudobuilder/kuttl/pkg/kubernetes/fake"
+	"github.com/kudobuilder/kuttl/internal/kubernetes/fake"
 )
 
 func TestGETAPIResource(t *testing.T) {

pkg/kuttlctl/cmd/assert.go → internal/kuttlctl/cmd/assert.go

@@ -5,7 +5,7 @@ import (
 
 	"github.com/spf13/cobra"
 
-	"github.com/kudobuilder/kuttl/pkg/test/assert"
+	"github.com/kudobuilder/kuttl/internal/assert"
 )
 
 var (

pkg/kuttlctl/cmd/errors.go → internal/kuttlctl/cmd/errors.go

@@ -5,7 +5,7 @@ import (
 
 	"github.com/spf13/cobra"
 
-	"github.com/kudobuilder/kuttl/pkg/test/assert"
+	"github.com/kudobuilder/kuttl/internal/assert"
 )
 
 var (

pkg/kuttlctl/cmd/root.go → internal/kuttlctl/cmd/root.go

@@ -3,8 +3,8 @@ package cmd
 import (
 	"github.com/spf13/cobra"
 
-	"github.com/kudobuilder/kuttl/pkg/kubernetes"
-	"github.com/kudobuilder/kuttl/pkg/version"
+	"github.com/kudobuilder/kuttl/internal/kubernetes"
+	"github.com/kudobuilder/kuttl/internal/version"
 )
 
 // NewKuttlCmd creates a new root command for kuttlctl

pkg/kuttlctl/cmd/test.go → internal/kuttlctl/cmd/test.go

@@ -12,12 +12,12 @@ import (
 	"github.com/spf13/pflag"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 
+	"github.com/kudobuilder/kuttl/internal/harness"
+	"github.com/kudobuilder/kuttl/internal/kind"
+	"github.com/kudobuilder/kuttl/internal/kubernetes"
+	"github.com/kudobuilder/kuttl/internal/report"
+	testutils "github.com/kudobuilder/kuttl/internal/utils"
 	harnessApi "github.com/kudobuilder/kuttl/pkg/apis/testharness/v1beta1"
-	"github.com/kudobuilder/kuttl/pkg/kubernetes"
-	"github.com/kudobuilder/kuttl/pkg/report"
-	"github.com/kudobuilder/kuttl/pkg/test/harness"
-	"github.com/kudobuilder/kuttl/pkg/test/kind"
-	testutils "github.com/kudobuilder/kuttl/pkg/test/utils"
 )
 
 var (
@@ -270,7 +270,7 @@ For more detailed documentation, visit: https://kuttl.dev`,
 	testCmd.Flags().StringVarP(&namespace, "namespace", "n", "", "Namespace to use for tests. Provided namespaces must exist prior to running tests.")
 	testCmd.Flags().StringSliceVar(&suppress, "suppress-log", []string{}, "Suppress logging for these kinds of logs (events).")
 	testCmd.Flags().Var(&runLabels, "test-run-labels", "Labels to use for this test run.")
-	// This cannot be a global flag because pkg/test/utils.RunTests calls flag.Parse which barfs on unknown top-level flags.
+	// This cannot be a global flag because internal/utils.RunTests calls flag.Parse which barfs on unknown top-level flags.
 	// Putting it here at least does not advertise it on a level where using it is impossible.
 	kind.SetFlags(testCmd.Flags())
 

pkg/kuttlctl/cmd/version.go → internal/kuttlctl/cmd/version.go

@@ -5,7 +5,7 @@ import (
 
 	"github.com/spf13/cobra"
 
-	"github.com/kudobuilder/kuttl/pkg/version"
+	"github.com/kudobuilder/kuttl/internal/version"
 )
 
 var (

pkg/test/step/expression_integration_test.go → internal/step/expression_integration_test.go

@@ -18,8 +18,8 @@ import (
 	"k8s.io/client-go/discovery"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
-	"github.com/kudobuilder/kuttl/pkg/kubernetes"
-	testutils "github.com/kudobuilder/kuttl/pkg/test/utils"
+	"github.com/kudobuilder/kuttl/internal/kubernetes"
+	testutils "github.com/kudobuilder/kuttl/internal/utils"
 )
 
 func buildTestStep(t *testing.T, testenv kubernetes.TestEnvironment) *Step {

pkg/test/step/step.go → internal/step/step.go

@@ -22,13 +22,13 @@ import (
 	"k8s.io/client-go/discovery"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
+	"github.com/kudobuilder/kuttl/internal/env"
+	"github.com/kudobuilder/kuttl/internal/expressions"
+	kfile "github.com/kudobuilder/kuttl/internal/file"
+	"github.com/kudobuilder/kuttl/internal/http"
+	"github.com/kudobuilder/kuttl/internal/kubernetes"
+	testutils "github.com/kudobuilder/kuttl/internal/utils"
 	harness "github.com/kudobuilder/kuttl/pkg/apis/testharness/v1beta1"
-	"github.com/kudobuilder/kuttl/pkg/env"
-	"github.com/kudobuilder/kuttl/pkg/expressions"
-	kfile "github.com/kudobuilder/kuttl/pkg/file"
-	"github.com/kudobuilder/kuttl/pkg/http"
-	"github.com/kudobuilder/kuttl/pkg/kubernetes"
-	testutils "github.com/kudobuilder/kuttl/pkg/test/utils"
 )
 
 // fileNameRegex contains two capturing groups to determine whether a file has special

pkg/test/step/step_integration_test.go → internal/step/step_integration_test.go

@@ -18,9 +18,9 @@ import (
 	"k8s.io/client-go/discovery"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
+	"github.com/kudobuilder/kuttl/internal/kubernetes"
+	testutils "github.com/kudobuilder/kuttl/internal/utils"
 	harness "github.com/kudobuilder/kuttl/pkg/apis/testharness/v1beta1"
-	"github.com/kudobuilder/kuttl/pkg/kubernetes"
-	testutils "github.com/kudobuilder/kuttl/pkg/test/utils"
 )
 
 var testenv kubernetes.TestEnvironment

pkg/test/step/step_test.go → internal/step/step_test.go

@@ -16,10 +16,10 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/client/fake"
 
+	"github.com/kudobuilder/kuttl/internal/kubernetes"
+	k8sfake "github.com/kudobuilder/kuttl/internal/kubernetes/fake"
+	testutils "github.com/kudobuilder/kuttl/internal/utils"
 	harness "github.com/kudobuilder/kuttl/pkg/apis/testharness/v1beta1"
-	"github.com/kudobuilder/kuttl/pkg/kubernetes"
-	k8sfake "github.com/kudobuilder/kuttl/pkg/kubernetes/fake"
-	testutils "github.com/kudobuilder/kuttl/pkg/test/utils"
 )
 
 const (

pkg/test/testcase/case.go → internal/testcase/case.go

@@ -18,13 +18,13 @@ import (
 	"k8s.io/client-go/discovery"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
+	"github.com/kudobuilder/kuttl/internal/kubernetes"
+	"github.com/kudobuilder/kuttl/internal/report"
+	"github.com/kudobuilder/kuttl/internal/step"
+	testutils "github.com/kudobuilder/kuttl/internal/utils"
+	eventutils "github.com/kudobuilder/kuttl/internal/utils/events"
+	"github.com/kudobuilder/kuttl/internal/utils/files"
 	"github.com/kudobuilder/kuttl/pkg/apis/testharness/v1beta1"
-	"github.com/kudobuilder/kuttl/pkg/kubernetes"
-	"github.com/kudobuilder/kuttl/pkg/report"
-	"github.com/kudobuilder/kuttl/pkg/test/step"
-	testutils "github.com/kudobuilder/kuttl/pkg/test/utils"
-	eventutils "github.com/kudobuilder/kuttl/pkg/test/utils/events"
-	"github.com/kudobuilder/kuttl/pkg/test/utils/files"
 )
 
 type getClientFuncType func(forceNew bool) (client.Client, error)

pkg/test/testcase/case_integration_test.go → internal/testcase/case_integration_test.go

@@ -9,10 +9,10 @@ import (
 	"k8s.io/client-go/discovery"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
-	"github.com/kudobuilder/kuttl/pkg/kubernetes"
-	"github.com/kudobuilder/kuttl/pkg/report"
-	"github.com/kudobuilder/kuttl/pkg/test/step"
-	testutils "github.com/kudobuilder/kuttl/pkg/test/utils"
+	"github.com/kudobuilder/kuttl/internal/kubernetes"
+	"github.com/kudobuilder/kuttl/internal/report"
+	"github.com/kudobuilder/kuttl/internal/step"
+	testutils "github.com/kudobuilder/kuttl/internal/utils"
 )
 
 // Create two test environments, ensure that the second environment is used when

pkg/test/testcase/case_test.go → internal/testcase/case_test.go

@@ -11,10 +11,10 @@ import (
 	"k8s.io/apimachinery/pkg/labels"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
+	"github.com/kudobuilder/kuttl/internal/kubernetes"
+	"github.com/kudobuilder/kuttl/internal/step"
+	testutils "github.com/kudobuilder/kuttl/internal/utils"
 	harness "github.com/kudobuilder/kuttl/pkg/apis/testharness/v1beta1"
-	"github.com/kudobuilder/kuttl/pkg/kubernetes"
-	"github.com/kudobuilder/kuttl/pkg/test/step"
-	testutils "github.com/kudobuilder/kuttl/pkg/test/utils"
 )
 
 // Verify the test state as loaded from disk.

pkg/test/utils/commands.go → internal/utils/commands.go

@@ -16,8 +16,8 @@ import (
 	"github.com/spf13/pflag"
 	_ "k8s.io/client-go/plugin/pkg/client/auth" // package needed for auth providers like GCP
 
+	"github.com/kudobuilder/kuttl/internal/env"
 	harness "github.com/kudobuilder/kuttl/pkg/apis/testharness/v1beta1"
-	"github.com/kudobuilder/kuttl/pkg/env"
 )
 
 // GetArgs parses a command line string into its arguments and appends a namespace if it is not already set.