Split up testing/integration/internal

DirectXMan12 · DirectXMan12 · commit 862283579ce6 · 2021-05-25T13:27:00.000-07:00
This moves testing/integration/internal into several more specific
packages to prepare to refactor the rest and dedup with the main envtest
code.
diff --git a/pkg/internal/testing/addr/addr_suite_test.go b/pkg/internal/testing/addr/addr_suite_test.go
diff --git a/pkg/internal/testing/addr/manager.go b/pkg/internal/testing/addr/manager.go
@@ -7,6 +7,8 @@ import (
 	"time"
 )
 
+// TODO(directxman12): interface / release functionality for external port managers
+
 const (
 	portReserveTime   = 1 * time.Minute
 	portConflictRetry = 100
diff --git a/pkg/internal/testing/addr/manager_test.go b/pkg/internal/testing/addr/manager_test.go
@@ -1,13 +1,13 @@
 package addr_test
 
 import (
-	"sigs.k8s.io/controller-runtime/pkg/internal/testing/integration/addr"
-
 	"net"
 	"strconv"
 
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
+
+	"sigs.k8s.io/controller-runtime/pkg/internal/testing/addr"
 )
 
 var _ = Describe("SuggestAddress", func() {
diff --git a/pkg/internal/testing/certs/tinyca.go b/pkg/internal/testing/certs/tinyca.go
@@ -1,4 +1,4 @@
-package internal
+package certs
 
 // NB(directxman12): nothing has verified that this has good settings.  In fact,
 // the setting generated here are probably terrible, but they're fine for integration
diff --git a/pkg/internal/testing/integration/apiserver.go b/pkg/internal/testing/integration/apiserver.go
@@ -9,8 +9,10 @@ import (
 	"path/filepath"
 	"time"
 
-	"sigs.k8s.io/controller-runtime/pkg/internal/testing/integration/addr"
+	"sigs.k8s.io/controller-runtime/pkg/internal/testing/addr"
+	"sigs.k8s.io/controller-runtime/pkg/internal/testing/certs"
 	"sigs.k8s.io/controller-runtime/pkg/internal/testing/integration/internal"
+	"sigs.k8s.io/controller-runtime/pkg/internal/testing/process"
 )
 
 // APIServer knows how to run a kubernetes apiserver.
@@ -68,7 +70,7 @@ type APIServer struct {
 	Out io.Writer
 	Err io.Writer
 
-	processState *internal.ProcessState
+	processState *process.ProcessState
 }
 
 // Start starts the apiserver, waits for it to come up, and returns an error,
@@ -89,9 +91,9 @@ func (s *APIServer) setProcessState() error {
 
 	var err error
 
-	s.processState = &internal.ProcessState{}
+	s.processState = &process.ProcessState{}
 
-	s.processState.DefaultedProcessInput, err = internal.DoDefaulting(
+	s.processState.DefaultedProcessInput, err = process.DoDefaulting(
 		"kube-apiserver",
 		s.URL,
 		s.CertDir,
@@ -123,7 +125,7 @@ func (s *APIServer) setProcessState() error {
 		return err
 	}
 
-	s.processState.Args, err = internal.RenderTemplates(
+	s.processState.Args, err = process.RenderTemplates(
 		internal.DoAPIServerArgDefaulting(s.Args), s,
 	)
 	return err
@@ -135,7 +137,7 @@ func (s *APIServer) populateAPIServerCerts() error {
 		return statErr
 	}
 
-	ca, err := internal.NewTinyCA()
+	ca, err := certs.NewTinyCA()
 	if err != nil {
 		return err
 	}
diff --git a/pkg/internal/testing/integration/control_plane.go b/pkg/internal/testing/integration/control_plane.go
@@ -9,12 +9,12 @@ import (
 	"k8s.io/client-go/kubernetes/scheme"
 	"k8s.io/client-go/rest"
 
-	"sigs.k8s.io/controller-runtime/pkg/internal/testing/integration/internal"
+	"sigs.k8s.io/controller-runtime/pkg/internal/testing/certs"
 )
 
 // NewTinyCA creates a new a tiny CA utility for provisioning serving certs and client certs FOR TESTING ONLY.
 // Don't use this for anything else!
-var NewTinyCA = internal.NewTinyCA
+var NewTinyCA = certs.NewTinyCA
 
 // ControlPlane is a struct that knows how to start your test control plane.
 //
diff --git a/pkg/internal/testing/integration/etcd.go b/pkg/internal/testing/integration/etcd.go
@@ -7,6 +7,7 @@ import (
 	"net/url"
 
 	"sigs.k8s.io/controller-runtime/pkg/internal/testing/integration/internal"
+	"sigs.k8s.io/controller-runtime/pkg/internal/testing/process"
 )
 
 // Etcd knows how to run an etcd server.
@@ -55,7 +56,7 @@ type Etcd struct {
 	Out io.Writer
 	Err io.Writer
 
-	processState *internal.ProcessState
+	processState *process.ProcessState
 }
 
 // Start starts the etcd, waits for it to come up, and returns an error, if one
@@ -72,9 +73,9 @@ func (e *Etcd) Start() error {
 func (e *Etcd) setProcessState() error {
 	var err error
 
-	e.processState = &internal.ProcessState{}
+	e.processState = &process.ProcessState{}
 
-	e.processState.DefaultedProcessInput, err = internal.DoDefaulting(
+	e.processState.DefaultedProcessInput, err = process.DoDefaulting(
 		"etcd",
 		e.URL,
 		e.DataDir,
@@ -94,7 +95,7 @@ func (e *Etcd) setProcessState() error {
 	e.StartTimeout = e.processState.StartTimeout
 	e.StopTimeout = e.processState.StopTimeout
 
-	e.processState.Args, err = internal.RenderTemplates(
+	e.processState.Args, err = process.RenderTemplates(
 		internal.DoEtcdArgDefaulting(e.Args), e,
 	)
 	return err
diff --git a/pkg/internal/testing/integration/kubectl.go b/pkg/internal/testing/integration/kubectl.go
@@ -5,7 +5,7 @@ import (
 	"io"
 	"os/exec"
 
-	"sigs.k8s.io/controller-runtime/pkg/internal/testing/integration/internal"
+	"sigs.k8s.io/controller-runtime/pkg/internal/testing/process"
 )
 
 // KubeCtl is a wrapper around the kubectl binary.
@@ -30,7 +30,7 @@ type KubeCtl struct {
 // stderr.
 func (k *KubeCtl) Run(args ...string) (stdout, stderr io.Reader, err error) {
 	if k.Path == "" {
-		k.Path = internal.BinPathFinder("kubectl")
+		k.Path = process.BinPathFinder("kubectl")
 	}
 
 	stdoutBuffer := &bytes.Buffer{}
diff --git a/pkg/internal/testing/process/arguments.go b/pkg/internal/testing/process/arguments.go
@@ -1,4 +1,4 @@
-package internal
+package process
 
 import (
 	"bytes"
diff --git a/pkg/internal/testing/process/arguments_test.go b/pkg/internal/testing/process/arguments_test.go
@@ -1,4 +1,4 @@
-package internal_test
+package process_test
 
 import (
 	"net/url"
@@ -7,7 +7,7 @@ import (
 	. "github.com/onsi/gomega"
 
 	"sigs.k8s.io/controller-runtime/pkg/internal/testing/integration"
-	. "sigs.k8s.io/controller-runtime/pkg/internal/testing/integration/internal"
+	. "sigs.k8s.io/controller-runtime/pkg/internal/testing/process"
 )
 
 var _ = Describe("Arguments", func() {
diff --git a/pkg/internal/testing/process/bin_path_finder.go b/pkg/internal/testing/process/bin_path_finder.go
@@ -1,4 +1,4 @@
-package internal
+package process
 
 import (
 	"os"
@@ -18,6 +18,8 @@ func init() {
 	assetsPath = filepath.Join(filepath.Dir(thisFile), "..", "assets", "bin")
 }
 
+// TODO(directxman12): unify this with the logic from envtest
+
 // BinPathFinder checks the an environment variable, derived from the symbolic name,
 // and falls back to a default assets location when this variable is not set
 func BinPathFinder(symbolicName string) (binPath string) {
diff --git a/pkg/internal/testing/process/bin_path_finder_test.go b/pkg/internal/testing/process/bin_path_finder_test.go
@@ -1,4 +1,4 @@
-package internal
+package process
 
 import (
 	"os"
diff --git a/pkg/internal/testing/process/internal_suite_test.go b/pkg/internal/testing/process/internal_suite_test.go
@@ -0,0 +1,17 @@
+package process_test
+
+import (
+	"testing"
+
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+
+	"sigs.k8s.io/controller-runtime/pkg/envtest/printer"
+)
+
+func TestInternal(t *testing.T) {
+	t.Parallel()
+	RegisterFailHandler(Fail)
+	suiteName := "Envtest Process Launcher Suite"
+	RunSpecsWithDefaultAndCustomReporters(t, suiteName, []Reporter{printer.NewlineReporter{}, printer.NewProwReporter(suiteName)})
+}
diff --git a/pkg/internal/testing/process/process.go b/pkg/internal/testing/process/process.go
@@ -1,4 +1,4 @@
-package internal
+package process
 
 import (
 	"fmt"
@@ -16,7 +16,7 @@ import (
 	"github.com/onsi/gomega/gbytes"
 	"github.com/onsi/gomega/gexec"
 
-	"sigs.k8s.io/controller-runtime/pkg/internal/testing/integration/addr"
+	"sigs.k8s.io/controller-runtime/pkg/internal/testing/addr"
 )
 
 // ProcessState define the state of the process.
diff --git a/pkg/internal/testing/process/process_test.go b/pkg/internal/testing/process/process_test.go
@@ -1,4 +1,4 @@
-package internal_test
+package process_test
 
 import (
 	"bytes"
@@ -15,8 +15,8 @@ import (
 	. "github.com/onsi/gomega"
 	"github.com/onsi/gomega/gexec"
 	"github.com/onsi/gomega/ghttp"
-	"sigs.k8s.io/controller-runtime/pkg/internal/testing/integration/addr"
-	. "sigs.k8s.io/controller-runtime/pkg/internal/testing/integration/internal"
+	"sigs.k8s.io/controller-runtime/pkg/internal/testing/addr"
+	. "sigs.k8s.io/controller-runtime/pkg/internal/testing/process"
 )
 
 const (

Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,8 @@ import (`
`7`	`7`	`"time"`
`8`	`8`	`)`
`9`	`9`
	`10`	`+// TODO(directxman12): interface / release functionality for external port managers`
	`11`	`+`
`10`	`12`	`const (`
`11`	`13`	`portReserveTime = 1 * time.Minute`
`12`	`14`	`portConflictRetry = 100`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package internal`
	`1`	`+package certs`
`2`	`2`
`3`	`3`	`// NB(directxman12): nothing has verified that this has good settings. In fact,`
`4`	`4`	`// the setting generated here are probably terrible, but they're fine for integration`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ import (`
`5`	`5`	`"io"`
`6`	`6`	`"os/exec"`
`7`	`7`
`8`		`- "sigs.k8s.io/controller-runtime/pkg/internal/testing/integration/internal"`
	`8`	`+ "sigs.k8s.io/controller-runtime/pkg/internal/testing/process"`
`9`	`9`	`)`
`10`	`10`
`11`	`11`	`// KubeCtl is a wrapper around the kubectl binary.`
`@@ -30,7 +30,7 @@ type KubeCtl struct {`
`30`	`30`	`// stderr.`
`31`	`31`	`func (k *KubeCtl) Run(args ...string) (stdout, stderr io.Reader, err error) {`
`32`	`32`	`if k.Path == "" {`
`33`		`- k.Path = internal.BinPathFinder("kubectl")`
	`33`	`+ k.Path = process.BinPathFinder("kubectl")`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`stdoutBuffer := &bytes.Buffer{}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package internal`
	`1`	`+package process`
`2`	`2`
`3`	`3`	`import (`
`4`	`4`	`"bytes"`