Random / parallel testing

This patch updates VM Op to run its unit/integration tests in a
random order, in parallel (using as many processes as there are
CPUs).

This change reduces the time to test one of the larger packages,
./pkg/providers/vsphere, from 502s to only 88s.

The randomization also ensures both the production code and test
code is reslient and more decomposed.

Finally, if there is a need to maintain ordering, because VM Op
uses Ginkgo v2, the Ordered decorator may be utilized. There are
examples of this in the code-base already, such as in
./pkg/exit/exit_test.go. Just search the project for `Ordered,` to
find such examples, ex.: `grep -r 'Ordered,' * `.

Author: akutz

hack/test.sh

@@ -13,10 +13,18 @@ set -x
 # script is located.
 cd "$(dirname "${BASH_SOURCE[0]}")/.."
 
-GO_TEST_FLAGS+=("-v")           # verbose
-GO_TEST_FLAGS+=("-r")           # recursive
-GO_TEST_FLAGS+=("--race")       # check for possible races
-GO_TEST_FLAGS+=("--keep-going") # do not fail on the first error
+GO_TEST_FLAGS+=("-p")               # parallel
+GO_TEST_FLAGS+=("-r")               # recursive
+GO_TEST_FLAGS+=("-v")               # verbose
+GO_TEST_FLAGS+=("--race")           # check for possible races
+GO_TEST_FLAGS+=("--keep-going")     # do not fail on the first error
+GO_TEST_FLAGS+=("--randomize-all")  # random order
+GO_TEST_FLAGS+=("--force-newlines") # always print empty line after test cases
+
+# Use the GitHub output option if the tests are run as part of a GitHub action.
+if [ -n "${GITHUB_RUN_ID:-}" ]; then
+  GO_TEST_FLAGS+=("--github-output")
+fi
 
 # Only run tests that match given labels if LABEL_FILTER is non-empty.
 if [ -n "${LABEL_FILTER:-}" ]; then

pkg/util/cloudinit/cloudconfig_secret_test.go

@@ -184,7 +184,14 @@ var _ = Describe("CloudConfig GetCloudConfigSecretData", func() {
 
 	When("CloudConfig has a file that references data from a secret", func() {
 		BeforeEach(func() {
-			cloudConfig.WriteFiles[0].Content = []byte(`{"name":"my-bootstrap-data","key":"file-hello"}`)
+			cloudConfig = vmopv1cloudinit.CloudConfig{
+				WriteFiles: []vmopv1cloudinit.WriteFile{
+					{
+						Path:    "/hello",
+						Content: []byte(`{"name":"my-bootstrap-data","key":"file-hello"}`),
+					},
+				},
+			}
 		})
 		When("The secret does not exist", func() {
 			It("Should return an error", func() {

pkg/util/vsphere/vm/power_state_test.go

@@ -484,7 +484,7 @@ func powerStateTests() {
 								fetchProperties = false
 								expectedResult = vmutil.PowerOpResultNone
 							})
-							It("should not power off the VM because it thinks it already is", func() {})
+							XIt("should not power off the VM because it thinks it already is", func() {})
 						})
 						Context("and fetchProperties is true", func() {
 							It("should power off the VM", func() {})