Start replacing curl pods and using common validation

changelog/v1.18.0-beta26/TestConfigureNotAttachedHttpListenerOptions-fix.yaml

@@ -0,0 +1,7 @@
+changelog:
+  - type: FIX
+    issueLink: https://github.com/solo-io/gloo/issues/9736
+    resolvesIssue: false
+    description: >-
+      Check curl pod is running before starting tests
+

test/kubernetes/e2e/defaults/defaults.go

@@ -1,15 +1,53 @@
 package defaults
 
 import (
+	"context"
 	"path/filepath"
 
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/suite"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 
 	"github.com/solo-io/gloo/pkg/utils/kubeutils/kubectl"
+	"github.com/solo-io/gloo/test/kubernetes/e2e"
 	"github.com/solo-io/skv2/codegen/util"
 )
 
+type CommonTestSuite interface {
+	Ctx() context.Context
+	TestInstallation() *e2e.TestInstallation // DO_NOT_SUBMIT: what to do about solo-projects? uses a struct that embeds this struct
+	Assert() *assert.Assertions
+	Resources() []Resource
+}
+
+type CommonTestSuiteImpl struct {
+	suite.Suite
+	ctx       context.Context
+	ti        *e2e.TestInstallation
+	resources []Resource
+}
+
+func (s *CommonTestSuiteImpl) Ctx() context.Context {
+	return s.ctx
+}
+
+func (s *CommonTestSuiteImpl) TestInstallation() *e2e.TestInstallation {
+	return s.ti
+}
+
+func (s *CommonTestSuiteImpl) Resources() []Resource {
+	return s.resources
+}
+
+func NewCommonTestSuiteImpl(ctx context.Context, testInst *e2e.TestInstallation, resources []Resource) *CommonTestSuiteImpl {
+	return &CommonTestSuiteImpl{
+		ctx:       ctx,
+		ti:        testInst,
+		resources: resources,
+	}
+}
+
 var (
 	CurlPodExecOpt = kubectl.PodExecOptions{
 		Name:      "curl",
@@ -84,3 +122,83 @@
 </body>
 </html>`
 )
+
+// Resource interface
+type Resource interface {
+	Install(s CommonTestSuite)
+	Delete(s CommonTestSuite)
+}
+
+// InstallResources installs multiple resources for the test suite
+func InstallResources(s CommonTestSuite) {
+	for _, r := range s.Resources() {
+		r.Install(s)
+	}
+}
+
+// DeleteResources deletes multiple resources for the test suite
+func DeleteResources(s CommonTestSuite) {
+	for _, r := range s.Resources() {
+		r.Delete(s)
+	}
+}
+
+// CurlPodResource
+type CurlPodResource struct{}
+
+func (c *CurlPodResource) eventuallyRunning(s CommonTestSuite) {
+	s.TestInstallation().Assertions.EventuallyPodsRunning(s.Ctx(), CurlPod.ObjectMeta.GetNamespace(), metav1.ListOptions{
+		LabelSelector: "app.kubernetes.io/name=curl",
+	})
+}
+
+func (c *CurlPodResource) Install(s CommonTestSuite) {
+	err := s.TestInstallation().Actions.Kubectl().ApplyFile(s.Ctx(), CurlPodManifest)
+	s.Assert().NoError(err)
+	c.eventuallyRunning(s)
+}
+
+func (c *CurlPodResource) Delete(s CommonTestSuite) {
+	output, err := s.TestInstallation().Actions.Kubectl().DeleteFileWithOutput(s.Ctx(), CurlPodManifest)
+	s.Assert().NoError(err, "can delete curl pod")
+	s.TestInstallation().Assertions.ExpectObjectDeleted(CurlPodManifest, err, output)
+}
+
+// func CurlPodEventuallyRunning(s CommonTestSuite) {
+// 	// Check that test resources are running
+// 	s.TestInstallation().Assertions.EventuallyPodsRunning(s.Ctx(), CurlPod.ObjectMeta.GetNamespace(), metav1.ListOptions{
+// 		LabelSelector: "app.kubernetes.io/name=curl",
+// 	})
+// }
+
+// func InstallCurlPod(s CommonTestSuite) {
+// 	err := s.TestInstallation().Actions.Kubectl().ApplyFile(s.Ctx(), CurlPodManifest)
+// 	s.Assert().NoError(err)
+// 	CurlPodEventuallyRunning(s)
+// }
+
+// func DeleteCurlPod(s CommonTestSuite) {
+// 	output, err := s.TestInstallation().Actions.Kubectl().DeleteFileWithOutput(s.Ctx(), CurlPodManifest)
+// 	s.Assert().NoError(err, "can delete curl pod")
+// 	s.TestInstallation().Assertions.ExpectObjectDeleted(CurlPodManifest, err, output)
+// }
+
+// // Or like this?
+// func CurlPodEventuallyRunning(ctx context.Context, ti *e2e.TestInstallation) {
+// 	// Check that test resources are running
+// 	ti.Assertions.EventuallyPodsRunning(ctx, CurlPod.ObjectMeta.GetNamespace(), metav1.ListOptions{
+// 		LabelSelector: "app.kubernetes.io/name=curl",
+// 	})
+// }
+
+// func InstallCurlPod(ctx context.Context, ti *e2e.TestInstallation, s *suite.Suite) {
+// 	err := ti.Actions.Kubectl().ApplyFile(ctx, CurlPodManifest)
+// 	s.Assert().NoError(err)
+// 	CurlPodEventuallyRunning(ctx, ti)
+// }
+
+// func DeleteCurlPod(ctx context.Context, ti *e2e.TestInstallation, s *suite.Suite) {
+// 	output, err := ti.Actions.Kubectl().DeleteFileWithOutput(ctx, CurlPodManifest)
+// 	s.Assert().NoError(err, "can delete curl pod")
+// 	ti.Assertions.ExpectObjectDeleted(CurlPodManifest, err, output)
+// }

test/kubernetes/e2e/features/headless_svc/gloo_gateway_suite.go

@@ -9,6 +9,7 @@ import (
 	"github.com/solo-io/gloo/projects/gateway/pkg/defaults"
 	gloo_defaults "github.com/solo-io/gloo/projects/gloo/pkg/defaults"
 	"github.com/solo-io/gloo/test/kubernetes/e2e"
+	testdefaults "github.com/solo-io/gloo/test/kubernetes/e2e/defaults"
 	testutilsresources "github.com/solo-io/gloo/test/kubernetes/testutils/resources"
 	"github.com/solo-io/solo-kit/pkg/api/v1/resources"
 
@@ -33,6 +34,21 @@ type edgeGatewaySuite struct {
 	routingManifestFile string
 }
 
+// DO_NOT_SUBMIT: better like this or embeddeded like in test/kubernetes/e2e/features/http_listener_options/http_lis_opt_suite.go
+func (s *edgeGatewaySuite) Ctx() context.Context {
+	return s.ctx
+}
+
+func (s *edgeGatewaySuite) TestInstallation() *e2e.TestInstallation {
+	return s.testInstallation
+}
+
+func (s *edgeGatewaySuite) Resources() []testdefaults.Resource {
+	return []testdefaults.Resource{
+		&testdefaults.CurlPodResource{},
+	}
+}
+
 func NewEdgeGatewayHeadlessSvcSuite(ctx context.Context, testInst *e2e.TestInstallation) suite.TestingSuite {
 	manifestFile := filepath.Join(testInst.GeneratedFiles.TempDir, EdgeGatewayApiRoutingGeneratedFileName)
 	return &edgeGatewaySuite{
@@ -55,6 +71,8 @@ func (s *edgeGatewaySuite) TestEdgeGatewayRoutingHeadlessSvc() {
 		s.NoError(err, "can delete setup manifest")
 		s.testInstallation.Assertions.EventuallyObjectsNotExist(s.ctx, headlessService)
 
+		testdefaults.DeleteResources(s)
+
 		err = s.testInstallation.Actions.Kubectl().DeleteFile(s.ctx, s.routingManifestFile)
 		s.NoError(err, "can delete setup Edge Gateway API routing manifest")
 	})
@@ -66,6 +84,8 @@ func (s *edgeGatewaySuite) TestEdgeGatewayRoutingHeadlessSvc() {
 		LabelSelector: "app.kubernetes.io/name=nginx",
 	})
 
+	testdefaults.InstallResources(s)
+
 	err = s.testInstallation.Actions.Kubectl().ApplyFile(s.ctx, s.routingManifestFile)
 	s.NoError(err, "can setup Edge Gateway API routing manifest")
 	// check status of the VirtualService and Upstream to ensure they are accepted

test/kubernetes/e2e/features/headless_svc/k8s_gw_suite.go

@@ -11,6 +11,7 @@ import (
 	"github.com/solo-io/gloo/pkg/utils/kubeutils"
 	"github.com/solo-io/gloo/pkg/utils/requestutils/curl"
 	"github.com/solo-io/gloo/test/kubernetes/e2e"
+	testdefaults "github.com/solo-io/gloo/test/kubernetes/e2e/defaults"
 	"github.com/solo-io/gloo/test/kubernetes/testutils/resources"
 )
 
@@ -29,6 +30,20 @@ type k8sGatewaySuite struct {
 	routingManifestFile string
 }
 
+func (s *k8sGatewaySuite) Ctx() context.Context {
+	return s.ctx
+}
+
+func (s *k8sGatewaySuite) TestInstallation() *e2e.TestInstallation {
+	return s.testInstallation
+}
+
+func (s *k8sGatewaySuite) Resources() []testdefaults.Resource {
+	return []testdefaults.Resource{
+		&testdefaults.CurlPodResource{},
+	}
+}
+
 func NewK8sGatewayHeadlessSvcSuite(ctx context.Context, testInst *e2e.TestInstallation) suite.TestingSuite {
 	routingManifestFile := filepath.Join(testInst.GeneratedFiles.TempDir, K8sApiRoutingGeneratedFileName)
 	return &k8sGatewaySuite{
@@ -53,6 +68,8 @@ func (s *k8sGatewaySuite) TestConfigureRoutingHeadlessSvc() {
 		s.NoError(err, "can delete setup manifest")
 		s.testInstallation.Assertions.EventuallyObjectsNotExist(s.ctx, headlessService)
 
+		testdefaults.DeleteResources(s)
+
 		err = s.testInstallation.Actions.Kubectl().DeleteFile(s.ctx, s.routingManifestFile)
 		s.NoError(err, "can delete setup k8s routing manifest")
 		s.testInstallation.Assertions.EventuallyObjectsNotExist(s.ctx, k8sApiProxyDeployment, k8sApiProxyService)
@@ -65,6 +82,8 @@ func (s *k8sGatewaySuite) TestConfigureRoutingHeadlessSvc() {
 		LabelSelector: "app.kubernetes.io/name=nginx",
 	})
 
+	testdefaults.InstallResources(s)
+
 	err = s.testInstallation.Actions.Kubectl().ApplyFile(s.ctx, s.routingManifestFile)
 	s.NoError(err, "can setup k8s routing manifest")
 

test/kubernetes/e2e/features/headless_svc/testdata/setup.yaml

@@ -24,31 +24,3 @@ spec:
       ports:
         - containerPort: 80
           name: http-web-svc
----
-apiVersion: v1
-kind: Namespace
-metadata:
-  name: curl
----
-apiVersion: v1
-kind: Pod
-metadata:
-  name: curl
-  namespace: curl
-  labels:
-    app: curl
-    version: v1
-spec:
-  containers:
-    - name: curl
-      image: curlimages/curl:7.83.1
-      imagePullPolicy: IfNotPresent
-      command:
-        - "tail"
-        - "-f"
-        - "/dev/null"
-      resources:
-        requests:
-          cpu: "100m"
-        limits:
-          cpu: "200m"

test/kubernetes/e2e/features/http_listener_options/http_lis_opt_suite.go

@@ -19,33 +19,42 @@ var _ e2e.NewSuiteFunc = NewTestingSuite
 
 // testingSuite is the entire Suite of tests for the "HttpListenerOptions" feature
 type testingSuite struct {
-	suite.Suite
-	ctx              context.Context
-	testInstallation *e2e.TestInstallation
-	// maps test name to a list of manifests to apply before the test
+	//suite.Suite
+	testdefaults.CommonTestSuiteImpl
+	// ctx              context.Context
+	// testInstallation *e2e.TestInstallation
+	// // maps test name to a list of manifests to apply before the test
 	manifests map[string][]string
 }
 
+// DO_NOT_SUBMIT: Better with embedding or writing the methods directly like intest/kubernetes/e2e/features/headless_svc/gloo_gateway_suite.go?
 func NewTestingSuite(
 	ctx context.Context,
 	testInst *e2e.TestInstallation,
 ) suite.TestingSuite {
 	return &testingSuite{
-		ctx:              ctx,
-		testInstallation: testInst,
+		CommonTestSuiteImpl: *testdefaults.NewCommonTestSuiteImpl(
+			ctx,
+			testInst,
+			[]testdefaults.Resource{
+				&testdefaults.CurlPodResource{},
+			},
+		),
 	}
 }
 
 func (s *testingSuite) SetupSuite() {
 	// Check that the common setup manifest is applied
-	err := s.testInstallation.Actions.Kubectl().ApplyFile(s.ctx, setupManifest)
+	err := s.TestInstallation().Actions.Kubectl().ApplyFile(s.Ctx(), setupManifest)
 	s.NoError(err, "can apply "+setupManifest)
-	s.testInstallation.Assertions.EventuallyObjectsExist(s.ctx, exampleSvc, nginxPod)
+	s.TestInstallation().Assertions.EventuallyObjectsExist(s.Ctx(), exampleSvc, nginxPod)
 	// Check that test app is running
-	s.testInstallation.Assertions.EventuallyPodsRunning(s.ctx, nginxPod.ObjectMeta.GetNamespace(), metav1.ListOptions{
+	s.TestInstallation().Assertions.EventuallyPodsRunning(s.Ctx(), nginxPod.ObjectMeta.GetNamespace(), metav1.ListOptions{
 		LabelSelector: "app.kubernetes.io/name=nginx",
 	})
 
+	testdefaults.InstallResources(s)
+
 	// include gateway manifests for the tests, so we recreate it for each test run
 	s.manifests = map[string][]string{
 		"TestConfigureHttpListenerOptions":            {gatewayManifest, basicLisOptManifest},
@@ -55,8 +64,10 @@ func (s *testingSuite) SetupSuite() {
 
 func (s *testingSuite) TearDownSuite() {
 	// Check that the common setup manifest is deleted
-	output, err := s.testInstallation.Actions.Kubectl().DeleteFileWithOutput(s.ctx, setupManifest)
-	s.testInstallation.Assertions.ExpectObjectDeleted(setupManifest, err, output)
+	output, err := s.TestInstallation().Actions.Kubectl().DeleteFileWithOutput(s.Ctx(), setupManifest)
+	s.TestInstallation().Assertions.ExpectObjectDeleted(setupManifest, err, output)
+
+	testdefaults.DeleteResources(s)
 }
 
 func (s *testingSuite) BeforeTest(suiteName, testName string) {
@@ -66,14 +77,14 @@ func (s *testingSuite) BeforeTest(suiteName, testName string) {
 	}
 
 	for _, manifest := range manifests {
-		err := s.testInstallation.Actions.Kubectl().ApplyFile(s.ctx, manifest)
+		err := s.TestInstallation().Actions.Kubectl().ApplyFile(s.Ctx(), manifest)
 		s.Assert().NoError(err, "can apply manifest "+manifest)
 	}
 
 	// we recreate the `Gateway` resource (and thus dynamically provision the proxy pod) for each test run
 	// so let's assert the proxy svc and pod is ready before moving on
-	s.testInstallation.Assertions.EventuallyObjectsExist(s.ctx, proxyService, proxyDeployment)
-	s.testInstallation.Assertions.EventuallyPodsRunning(s.ctx, proxyDeployment.ObjectMeta.GetNamespace(), metav1.ListOptions{
+	s.TestInstallation().Assertions.EventuallyObjectsExist(s.Ctx(), proxyService, proxyDeployment)
+	s.TestInstallation().Assertions.EventuallyPodsRunning(s.Ctx(), proxyDeployment.ObjectMeta.GetNamespace(), metav1.ListOptions{
 		LabelSelector: "app.kubernetes.io/name=gloo-proxy-gw",
 	})
 }
@@ -85,15 +96,15 @@ func (s *testingSuite) AfterTest(suiteName, testName string) {
 	}
 
 	for _, manifest := range manifests {
-		output, err := s.testInstallation.Actions.Kubectl().DeleteFileWithOutput(s.ctx, manifest)
-		s.testInstallation.Assertions.ExpectObjectDeleted(manifest, err, output)
+		output, err := s.TestInstallation().Actions.Kubectl().DeleteFileWithOutput(s.Ctx(), manifest)
+		s.TestInstallation().Assertions.ExpectObjectDeleted(manifest, err, output)
 	}
 }
 
 func (s *testingSuite) TestConfigureHttpListenerOptions() {
 	// Check healthy response and response headers contain server name override from HttpListenerOption
-	s.testInstallation.Assertions.AssertEventualCurlResponse(
-		s.ctx,
+	s.TestInstallation().Assertions.AssertEventualCurlResponse(
+		s.Ctx(),
 		testdefaults.CurlPodExecOpt,
 		[]curl.Option{
 			curl.WithHost(kubeutils.ServiceFQDN(proxyService.ObjectMeta)),
@@ -110,8 +121,8 @@ func (s *testingSuite) TestConfigureHttpListenerOptions() {
 
 func (s *testingSuite) TestConfigureNotAttachedHttpListenerOptions() {
 	// Check healthy response and response headers contain default server name as HttpLisOpt isn't attached
-	s.testInstallation.Assertions.AssertEventualCurlResponse(
-		s.ctx,
+	s.TestInstallation().Assertions.AssertEventualCurlResponse(
+		s.Ctx(),
 		testdefaults.CurlPodExecOpt,
 		[]curl.Option{
 			curl.WithHost(kubeutils.ServiceFQDN(proxyService.ObjectMeta)),