Re-factored e2e helper packages per commenter recommendation.

Author: jweite-amazon

test/e2e/deploy_app_toxi.go

@@ -26,7 +26,7 @@ import (
 	"os"
 	"path/filepath"
 	"runtime"
-	"sigs.k8s.io/cluster-api-provider-cloudstack-staging/test/e2e/helpers"
+	"sigs.k8s.io/cluster-api-provider-cloudstack-staging/test/e2e/toxiproxy"
 	"sigs.k8s.io/cluster-api/test/framework/clusterctl"
 	"sigs.k8s.io/cluster-api/util"
 )
@@ -41,8 +41,8 @@ func DeployAppToxiSpec(ctx context.Context, inputGetter func() CommonSpecInput)
 		clusterResources                 *clusterctl.ApplyClusterTemplateAndWaitResult
 		bootstrapClusterToxicName        string
 		cloudStackToxicName              string
-		bootstrapClusterToxiProxyContext *helpers.ToxiProxyContext
-		cloudStackToxiProxyContext       *helpers.ToxiProxyContext
+		bootstrapClusterToxiProxyContext *toxiproxy.Context
+		cloudStackToxiProxyContext       *toxiproxy.Context
 		appName                          = "httpd"
 		appManifestPath                  = "data/fixture/sample-application.yaml"
 		expectedHtmlPath                 = "data/fixture/expected-webpage.html"
@@ -66,14 +66,14 @@ func DeployAppToxiSpec(ctx context.Context, inputGetter func() CommonSpecInput)
 		Expect(input.E2EConfig.Variables).To(HaveKey(KubernetesVersion))
 
 		// Set up a toxiProxy for bootstrap server.
-		bootstrapClusterToxiProxyContext = helpers.SetupForToxiProxyTestingBootstrapCluster(input.BootstrapClusterProxy, clusterName)
+		bootstrapClusterToxiProxyContext = toxiproxy.SetupForToxiProxyTestingBootstrapCluster(input.BootstrapClusterProxy, clusterName)
 		const ToxicLatencyMs = 100
 		const ToxicJitterMs = 100
 		const ToxicToxicity = 1
 		bootstrapClusterToxicName = bootstrapClusterToxiProxyContext.AddLatencyToxic(ToxicLatencyMs, ToxicJitterMs, ToxicToxicity, false)
 
 		// Set up a toxiProxy for CloudStack
-		cloudStackToxiProxyContext = helpers.SetupForToxiProxyTestingACS(
+		cloudStackToxiProxyContext = toxiproxy.SetupForToxiProxyTestingACS(
 			ctx,
 			clusterName,
 			input.BootstrapClusterProxy,
@@ -154,9 +154,9 @@ func DeployAppToxiSpec(ctx context.Context, inputGetter func() CommonSpecInput)
 
 		// Tear down the ToxiProxies
 		cloudStackToxiProxyContext.RemoveToxic(cloudStackToxicName)
-		helpers.TearDownToxiProxyACS(ctx, input.BootstrapClusterProxy, cloudStackToxiProxyContext)
+		toxiproxy.TearDownToxiProxyACS(ctx, input.BootstrapClusterProxy, cloudStackToxiProxyContext)
 
 		bootstrapClusterToxiProxyContext.RemoveToxic(bootstrapClusterToxicName)
-		helpers.TearDownToxiProxyBootstrap(bootstrapClusterToxiProxyContext)
+		toxiproxy.TearDownToxiProxyBootstrap(bootstrapClusterToxiProxyContext)
 	})
 }

test/e2e/e2e_suite_test.go

@@ -25,7 +25,7 @@ import (
 	"os"
 	"path/filepath"
 	go_runtime "runtime"
-	"sigs.k8s.io/cluster-api-provider-cloudstack-staging/test/e2e/helpers"
+	"sigs.k8s.io/cluster-api-provider-cloudstack-staging/test/e2e/toxiproxy"
 	"strings"
 	"testing"
 	"time"
@@ -122,7 +122,7 @@ var _ = SynchronizedBeforeSuite(func() []byte {
 	// Toxiproxy running in a docker container requires docker host networking, only available in linux.
 	if go_runtime.GOOS == "linux" {
 		By("Launching Toxiproxy Server")
-		Expect(helpers.ToxiProxyServerExec(ctx)).To(Succeed())
+		Expect(toxiproxy.ServerExec(ctx)).To(Succeed())
 	}
 
 	if clusterctlConfig == "" {
@@ -180,7 +180,7 @@ var _ = SynchronizedAfterSuite(func() {
 
 	if go_runtime.GOOS == "linux" {
 		By("Killing Toxiproxy Server")
-		Expect(helpers.ToxiProxyServerKill(ctx)).To(Succeed())
+		Expect(toxiproxy.ServerKill(ctx)).To(Succeed())
 	}
 })
 

test/e2e/helpers/data/README renamed to test/e2e/kubeconfig_helper/data/README

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package helpers
+package kubeconfig_helper
 
 import (
 	"errors"

test/e2e/helpers/data/kubeconfig renamed to test/e2e/kubeconfig_helper/data/kubeconfig

@@ -14,18 +14,18 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package helpers_test
+package kubeconfig_helper_test
 
 import (
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
 	"io/ioutil"
-	"sigs.k8s.io/cluster-api-provider-cloudstack-staging/test/e2e/helpers"
+	"sigs.k8s.io/cluster-api-provider-cloudstack-staging/test/e2e/kubeconfig_helper"
 )
 
 var _ = Describe("Test kubeconfig helper methods", func() {
 	It("should work", func() {
-		kubeconfig := helpers.NewKubeconfig()
+		kubeconfig := kubeconfig_helper.NewKubeconfig()
 
 		var kubeconfigPath string = "./data/kubeconfig"
 		var unmodifiedKubeconfigPath string = "/tmp/unmodifiedKubeconfig"

test/e2e/helpers/kubeconfig.go renamed to test/e2e/kubeconfig_helper/kubeconfig.go

@@ -1,4 +1,4 @@
-package helpers_test
+package kubeconfig_helper_test
 
 import (
 	"testing"
@@ -9,5 +9,5 @@ import (
 
 func TestHelpers(t *testing.T) {
 	RegisterFailHandler(Fail)
-	RunSpecs(t, "Helpers Suite")
+	RunSpecs(t, "Kubeconfig Helpers Suite")
 }

test/e2e/helpers/kubeconfig_test.go renamed to test/e2e/kubeconfig_helper/kubeconfig_test.go

@@ -29,6 +29,7 @@ import (
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/utils/pointer"
 	"sigs.k8s.io/cluster-api-provider-cloudstack-staging/test/e2e/helpers"
+	"sigs.k8s.io/cluster-api-provider-cloudstack-staging/test/e2e/toxiproxy"
 	"sigs.k8s.io/cluster-api/test/framework/clusterctl"
 	"sigs.k8s.io/cluster-api/util"
 )
@@ -41,7 +42,7 @@ func NetworkInterruptionToxiSpec(ctx context.Context, inputGetter func() CommonS
 		namespace                         *corev1.Namespace
 		cancelWatches                     context.CancelFunc
 		clusterResources                  *clusterctl.ApplyClusterTemplateAndWaitResult
-		cloudStackToxiProxyContext        *helpers.ToxiProxyContext
+		cloudStackToxiProxyContext        *toxiproxy.Context
 		clusterName                       = fmt.Sprintf("%s-%s", specName, util.RandomString(6))
 		networkInterruptorShutdownChannel = make(chan bool, 2)
 	)
@@ -59,7 +60,7 @@ func NetworkInterruptionToxiSpec(ctx context.Context, inputGetter func() CommonS
 		Expect(input.E2EConfig.Variables).To(HaveKey(KubernetesVersion))
 
 		// Set up a toxiProxy for CloudStack
-		cloudStackToxiProxyContext = helpers.SetupForToxiProxyTestingACS(
+		cloudStackToxiProxyContext = toxiproxy.SetupForToxiProxyTestingACS(
 			ctx,
 			clusterName,
 			input.BootstrapClusterProxy,
@@ -121,11 +122,11 @@ func NetworkInterruptionToxiSpec(ctx context.Context, inputGetter func() CommonS
 		dumpSpecResourcesAndCleanup(ctx, specName, input.BootstrapClusterProxy, input.ArtifactFolder, namespace, cancelWatches, clusterResources.Cluster, input.E2EConfig.GetIntervals, input.SkipCleanup)
 
 		// Tear down the ToxiProxies
-		helpers.TearDownToxiProxyACS(ctx, input.BootstrapClusterProxy, cloudStackToxiProxyContext)
+		toxiproxy.TearDownToxiProxyACS(ctx, input.BootstrapClusterProxy, cloudStackToxiProxyContext)
 	})
 }
 
-func networkInterruptor(toxiProxyContext *helpers.ToxiProxyContext, shutdownChannel chan bool) {
+func networkInterruptor(toxiProxyContext *toxiproxy.Context, shutdownChannel chan bool) {
 	// Wait for ApplyClusterTemplateAndWait() to make some progress
 	helpers.InterruptibleSleep(15*time.Second, time.Second, shutdownChannel)
 

test/e2e/helpers/suite_test.go renamed to test/e2e/kubeconfig_helper/suite_test.go

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package helpers
+package toxiproxy
 
 import (
 	"context"
@@ -29,13 +29,14 @@ import (
 	toxiproxyapi "github.com/Shopify/toxiproxy/v2/client"
 	. "github.com/onsi/gomega"
 	corev1 "k8s.io/api/core/v1"
+	"sigs.k8s.io/cluster-api-provider-cloudstack-staging/test/e2e/kubeconfig_helper"
 	"sigs.k8s.io/cluster-api/test/framework"
 	"sigs.k8s.io/cluster-api/test/framework/clusterctl"
 	"sigs.k8s.io/cluster-api/test/framework/exec"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 )
 
-func ToxiProxyServerExec(ctx context.Context) error {
+func ServerExec(ctx context.Context) error {
 	execArgs := []string{"run", "-d", "--name=capc-e2e-toxiproxy", "--net=host", "--rm", "ghcr.io/shopify/toxiproxy"}
 	runCmd := exec.NewCommand(
 		exec.WithCommand("docker"),
@@ -48,7 +49,7 @@ func ToxiProxyServerExec(ctx context.Context) error {
 	return err
 }
 
-func ToxiProxyServerKill(ctx context.Context) error {
+func ServerKill(ctx context.Context) error {
 	execArgs := []string{"stop", "capc-e2e-toxiproxy"}
 	runCmd := exec.NewCommand(
 		exec.WithCommand("docker"),
@@ -58,17 +59,17 @@ func ToxiProxyServerKill(ctx context.Context) error {
 	return err
 }
 
-type ToxiProxyContext struct {
+type Context struct {
 	KubeconfigPath string
 	Secret         corev1.Secret
 	ClusterProxy   framework.ClusterProxy
 	ToxiProxy      *toxiproxyapi.Proxy
 	ConfigPath     string
 }
 
-func SetupForToxiProxyTestingBootstrapCluster(bootstrapClusterProxy framework.ClusterProxy, clusterName string) *ToxiProxyContext {
+func SetupForToxiProxyTestingBootstrapCluster(bootstrapClusterProxy framework.ClusterProxy, clusterName string) *Context {
 	// Read/parse the actual kubeconfig for the cluster
-	kubeConfig := NewKubeconfig()
+	kubeConfig := kubeconfig_helper.NewKubeconfig()
 	unproxiedKubeconfigPath := bootstrapClusterProxy.GetKubeconfigPath()
 	err := kubeConfig.Load(unproxiedKubeconfigPath)
 	Expect(err).To(BeNil())
@@ -112,14 +113,14 @@ func SetupForToxiProxyTestingBootstrapCluster(bootstrapClusterProxy framework.Cl
 		framework.WithMachineLogCollector(framework.DockerLogCollector{}),
 	)
 
-	return &ToxiProxyContext{
+	return &Context{
 		KubeconfigPath: toxiProxyKubeconfigPath,
 		ClusterProxy:   toxiproxyBootstrapClusterProxy,
 		ToxiProxy:      proxy,
 	}
 }
 
-func TearDownToxiProxyBootstrap(toxiProxyContext *ToxiProxyContext) {
+func TearDownToxiProxyBootstrap(toxiProxyContext *Context) {
 	// Tear down the proxy
 	err := toxiProxyContext.ToxiProxy.Delete()
 	Expect(err).To(BeNil())
@@ -129,12 +130,12 @@ func TearDownToxiProxyBootstrap(toxiProxyContext *ToxiProxyContext) {
 	Expect(err).To(BeNil())
 }
 
-func (tp *ToxiProxyContext) RemoveToxic(toxicName string) {
+func (tp *Context) RemoveToxic(toxicName string) {
 	err := tp.ToxiProxy.RemoveToxic(toxicName)
 	Expect(err).To(BeNil())
 }
 
-func (tp *ToxiProxyContext) AddLatencyToxic(latencyMs int, jitterMs int, toxicity float32, upstream bool) string {
+func (tp *Context) AddLatencyToxic(latencyMs int, jitterMs int, toxicity float32, upstream bool) string {
 	stream := "downstream"
 	if upstream == true {
 		stream = "upstream"
@@ -150,15 +151,15 @@ func (tp *ToxiProxyContext) AddLatencyToxic(latencyMs int, jitterMs int, toxicit
 	return toxicName
 }
 
-func (tp *ToxiProxyContext) Disable() {
+func (tp *Context) Disable() {
 	tp.ToxiProxy.Disable()
 }
 
-func (tp *ToxiProxyContext) Enable() {
+func (tp *Context) Enable() {
 	tp.ToxiProxy.Enable()
 }
 
-func SetupForToxiProxyTestingACS(ctx context.Context, clusterName string, clusterProxy framework.ClusterProxy, e2eConfig *clusterctl.E2EConfig, configPath string) *ToxiProxyContext {
+func SetupForToxiProxyTestingACS(ctx context.Context, clusterName string, clusterProxy framework.ClusterProxy, e2eConfig *clusterctl.E2EConfig, configPath string) *Context {
 	// Get the cloud-config secret that CAPC will use to access CloudStack
 	fdEndpointSecretObjectKey := client.ObjectKey{
 		Namespace: e2eConfig.GetVariable("CLOUDSTACK_FD1_SECRET_NAMESPACE"),
@@ -209,14 +210,14 @@ func SetupForToxiProxyTestingACS(ctx context.Context, clusterName string, cluste
 	editConfigFile(newConfigFilePath, configPath, "CLOUDSTACK_FD1_SECRET_NAME", toxiProxyFdEndpointSecret.Name)
 
 	// Return a context
-	return &ToxiProxyContext{
+	return &Context{
 		Secret:     toxiProxyFdEndpointSecret,
 		ToxiProxy:  proxy,
 		ConfigPath: newConfigFilePath,
 	}
 }
 
-func TearDownToxiProxyACS(ctx context.Context, clusterProxy framework.ClusterProxy, toxiProxyContext *ToxiProxyContext) {
+func TearDownToxiProxyACS(ctx context.Context, clusterProxy framework.ClusterProxy, toxiProxyContext *Context) {
 	// Tear down the proxy
 	err := toxiProxyContext.ToxiProxy.Delete()
 	Expect(err).To(BeNil())