chore: move packages to internal (#632)

We should not be exposing all code as a public API.

Leave just the apis directory and the Harness type in pkg/ to avoid
the single active user that I could find.

When doing this, flatten the structure by moving packages under the
`pkg/test` package directly into `internal`.

Signed-off-by: Marcin Owsiany <[email protected]>

Author: porridge

.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

@@ -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

docs/cli.md

@@ -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