Refactor Kubernetes E2E test definition for ease of use

[jbohanon]

Description

Introduces abstractions over the test cases for Ordered and Unordered sets of tests within a suite. This allows us to define the run behavior of the tests separate from the suite that runs them.

Also refactors the tests out into an importable tests package (*_test packages cannot be imported). This will allow us to run the tests in the same way in EE, and also make sure the test suites in OSS and EE stay in lockstep.

Any tests which did not have a comment about needing to be ordered were assumed to be unordered. There is a non-zero risk that this introduces some flakes if the test order was in fact important.

Context

Tests added to these suites in OSS had to be added in the same manner in EE. By exporting the entire pack of tests to run, the EE suites can import them to run on their bespoke e2e.TestInstallation.

Code changes

• New types and interface to abstract the concept of Ordered and Unordered groups of tests
• Tests actually run in the suite were separated from the suite. This adds a little unnecessary code distance, but in order to import them they could not be in a *_test package and it seemed cleaner to me (and possibly necessary for testify but not sure) to leave the suites in *_test package.

Testing steps

I manually verified behavior by opening https://github.com/solo-io/solo-projects/pull/6314 and running nightlies off of that branch to see that the expected suite ran (at that time just the k8s_gw_tests had been migrated).

Interesting decisions

In order to reduce verbosity of defining a new test, we strip back some of the injection to the actual Run function. This means that we cannot need to reference the three things we need injected (ctx, t, testInstallation) when we are registering tests. To reconcile with this, what is registered is actually the feature suite construction function. We have enforced this by defining a new typedef for that signature and making a compiler assertion at the top of each feature suite for its construction function.

A side-effect of this is that nested test structures such as used for Glooctl in k8s_gw_test.go no longer work since we don't have access to the injected values at registration time. To resolve this, nested test structures must be defined as suites. An example of this can be found in the same Glooctl test, now located in k8s_gw_tests.go.

Checklist:

• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• I have added tests that prove my fix is effective or that my feature works

[github-actions]

Visit the preview URL for this PR (updated for commit 3d86031):

https://gloo-edge--pr9581-jbohanon-e2e-tests-c-f5lfdmel.web.app

_{(expires Thu, 20 Jun 2024 14:45:20 GMT)}

_{🔥 via Firebase Hosting GitHub Action 🌎}

_{Sign: 77c2b86e287749579b7ff9cadb81e099042ef677}

[solo-changelog-bot]

Issues linked to changelog:
#9353

[jbohanon]

/skip-ci Kube tests only

[jbohanon]

/skip-ci Kube tests only

[jbohanon]

Had to kick cluster one due to this error which looks like the validation flakiness being worked on elsewhere in this repo now

Error from server: error when creating "/home/runner/work/gloo/gloo/test/kubernetes/e2e/features/glooctl/testdata/edge-gateway-gateways.yaml": admission webhook "gloo.k8s-gw-test.svc" denied the request: resource incompatible with current Gloo snapshot: [Validating *v1.Gateway failed: 1 error occurred:
	* Validating *v1.Gateway failed: validating *v1.Gateway name:"gateway1"  namespace:"k8s-gw-test": 1 error occurred:
	* could not render proxy: 2 errors occurred:
	* invalid resource k8s-gw-test.gateway1
	* invalid virtual service ref name:"vs1"  namespace:"default"

[jbohanon]

/skip-ci Kube tests only

[sam-heilbron]

nice work!

[jbohanon]

/skip-ci Kube tests only

[sam-heilbron]

great work!

[jbohanon]

/skip-ci Kube tests only

[jbohanon]

Dozer?