fix(appliance): bypass setupenv-test for local testing if not installed (#64305)

<!-- PR description tips:
https://www.notion.so/sourcegraph/Write-a-good-pull-request-description-610a7fd3e613496eb76f450db5a49b6e
-->

Bypass the requirement for
`sigs.k8s.io/controller-runtime/tools/setup-envtest` when running `go
test` in the `internal/appliance` package.

Previously running `go test` without
`sigs.k8s.io/controller-runtime/tools/setup-envtest` installed would
fail the tests that required it. This changes this behavior to instead
skip the tests requiring `setup-envtest` if the user doesn't have it
installed locally.

## Test plan

Tested locally without `setup-envtest` installed:
```shell
go test ./internal/appliance/reconciler... -v
=== RUN   TestApplianceTestSuite
    helpers_test.go:37: setup-envtest is not installed, skipping ApplianceTestSuite
--- SKIP: TestApplianceTestSuite (0.00s)
PASS
ok  	github.com/sourcegraph/sourcegraph/internal/appliance/reconciler	0.907s
```

Tested locally with `setup-envtest` installed:
```shell
go test ./internal/appliance/reconciler... -v
...
        --- PASS: TestApplianceTestSuite/TestDeployWorker/worker/with-blobstore (0.25s)
        --- PASS: TestApplianceTestSuite/TestDeployWorker/worker/with-replicas (0.24s)
    --- PASS: TestApplianceTestSuite/TestDoesNotDeleteUnownedResources (0.22s)
    --- PASS: TestApplianceTestSuite/TestFrontendDeploymentRollsWhenPGSecretsChange (1.36s)
        --- PASS: TestApplianceTestSuite/TestFrontendDeploymentRollsWhenPGSecretsChange/pgsql-auth (0.47s)
        --- PASS: TestApplianceTestSuite/TestFrontendDeploymentRollsWhenPGSecretsChange/codeinsights-db-auth (0.44s)
        --- PASS: TestApplianceTestSuite/TestFrontendDeploymentRollsWhenPGSecretsChange/codeintel-db-auth (0.45s)
    --- PASS: TestApplianceTestSuite/TestFrontendDeploymentRollsWhenRedisSecretsChange (0.93s)
        --- PASS: TestApplianceTestSuite/TestFrontendDeploymentRollsWhenRedisSecretsChange/redis-cache (0.45s)
        --- PASS: TestApplianceTestSuite/TestFrontendDeploymentRollsWhenRedisSecretsChange/redis-store (0.48s)
    --- PASS: TestApplianceTestSuite/TestMergeK8sObjects (0.00s)
        --- PASS: TestApplianceTestSuite/TestMergeK8sObjects/Successful_merge (0.00s)
        --- PASS: TestApplianceTestSuite/TestMergeK8sObjects/Merge_with_overlapping_keys (0.00s)
        --- PASS: TestApplianceTestSuite/TestMergeK8sObjects/Merge_with_empty_new_object (0.00s)
        --- PASS: TestApplianceTestSuite/TestMergeK8sObjects/merges_annotations (0.00s)
    --- PASS: TestApplianceTestSuite/TestNonNamespacedResourcesRemainWhenDisabled (0.45s)
    --- PASS: TestApplianceTestSuite/TestResourcesDeletedWhenDisabled (0.45s)
    --- PASS: TestApplianceTestSuite/TestStandardFeatures (2.43s)
        --- PASS: TestApplianceTestSuite/TestStandardFeatures/standard/blobstore-with-named-storage-class (0.24s)
        --- PASS: TestApplianceTestSuite/TestStandardFeatures/standard/frontend-with-no-cpu-memory-resources (0.25s)
        --- PASS: TestApplianceTestSuite/TestStandardFeatures/standard/precise-code-intel-with-env-vars (0.24s)
        --- PASS: TestApplianceTestSuite/TestStandardFeatures/standard/redis-with-multiple-custom-images (0.25s)
        --- PASS: TestApplianceTestSuite/TestStandardFeatures/standard/redis-with-storage (0.25s)
        --- PASS: TestApplianceTestSuite/TestStandardFeatures/standard/repo-updater-with-no-resources (0.26s)
        --- PASS: TestApplianceTestSuite/TestStandardFeatures/standard/repo-updater-with-pod-template-config (0.23s)
        --- PASS: TestApplianceTestSuite/TestStandardFeatures/standard/repo-updater-with-resources (0.25s)
        --- PASS: TestApplianceTestSuite/TestStandardFeatures/standard/repo-updater-with-sa-annotations (0.24s)
        --- PASS: TestApplianceTestSuite/TestStandardFeatures/standard/symbols-with-custom-image (0.23s)
PASS
ok  	github.com/sourcegraph/sourcegraph/internal/appliance/reconciler	20.576s
```

<!-- REQUIRED; info at
https://docs-legacy.sourcegraph.com/dev/background-information/testing_principles
-->

## Changelog
N/A as this is not a user facing change.
<!-- OPTIONAL; info at
https://www.notion.so/sourcegraph/Writing-a-changelog-entry-dd997f411d524caabf0d8d38a24a878c
-->

Author: jdpleiness

internal/appliance/healthchecker/health_checker_test.go

@@ -16,6 +16,7 @@ import (
 	"github.com/sourcegraph/log"
 	"github.com/sourcegraph/log/logr"
 	"github.com/sourcegraph/log/logtest"
+
 	"github.com/sourcegraph/sourcegraph/internal/appliance/k8senvtest"
 	"github.com/sourcegraph/sourcegraph/internal/k8s/resource/service"
 )
@@ -31,6 +32,11 @@ func TestMain(m *testing.M) {
 	ctx, cancel = context.WithCancel(context.Background())
 	defer cancel()
 
+	if !k8senvtest.ShouldRunSetupEnvTests() {
+		fmt.Println("setup-envtest is not installed or we are not in CI, skipping Appliance healthchecker tests")
+		os.Exit(0)
+	}
+
 	logger := log.Scoped("appliance-healthchecker-tests")
 	k8sConfig, cleanup, err := k8senvtest.SetupEnvtest(ctx, logr.New(logger), k8senvtest.NewNoopReconciler)
 	if err != nil {

internal/appliance/k8senvtest/envtest.go

@@ -121,9 +121,27 @@ func kubebuilderAssetPathLocalDev() (string, error) {
 }
 
 func NewNoopReconciler(mgr ctrl.Manager) KubernetesController {
-	return noopReconicler{}
+	return noopReconciler{}
 }
 
-type noopReconicler struct{}
+type noopReconciler struct{}
 
-func (noopReconicler) SetupWithManager(_ ctrl.Manager) error { return nil }
+func (noopReconciler) SetupWithManager(_ ctrl.Manager) error { return nil }
+
+func isSetupEnvTestInstalled() bool {
+	_, err := exec.LookPath("setup-envtest")
+	return err == nil
+}
+
+// ShouldRunSetupEnvTests determines if test requiring setup-envtest should be run or not.
+// Generally we want to require these tests to run in CI but not locally unless the developer
+// has "setup-envtest" present on their machine.
+func ShouldRunSetupEnvTests() bool {
+	// Assume we are in CI, require tests to run.
+	if os.Getenv("BAZEL_TEST") != "" {
+		return true
+	}
+
+	// fall back to whether or not requirments are installed
+	return isSetupEnvTestInstalled()
+}

internal/appliance/reconciler/frontend_test.go

@@ -99,7 +99,7 @@ func (suite *ApplianceTestSuite) TestFrontendDeploymentRollsWhenPGSecretsChange(
 		suite.Run(tc.secret, func() {
 			// Create the frontend before the PGSQL secret exists. In general, this
 			// might happen, depending on the order of the reconcile loop. If we
-			// introducce concurrency to this, we'll have little control over what
+			// introduce concurrency to this, we'll have little control over what
 			// happens first.
 			namespace := suite.createConfigMapAndAwaitReconciliation("frontend/default")
 
@@ -142,7 +142,7 @@ func (suite *ApplianceTestSuite) TestFrontendDeploymentRollsWhenRedisSecretsChan
 		suite.Run(tc.secret, func() {
 			// Create the frontend before the PGSQL secret exists. In general, this
 			// might happen, depending on the order of the reconcile loop. If we
-			// introducce concurrency to this, we'll have little control over what
+			// introduce concurrency to this, we'll have little control over what
 			// happens first.
 			namespace := suite.createConfigMapAndAwaitReconciliation("frontend/default")
 

internal/appliance/reconciler/helpers_test.go

@@ -17,6 +17,7 @@ import (
 
 	"github.com/sourcegraph/log/logr"
 	"github.com/sourcegraph/log/logtest"
+
 	"github.com/sourcegraph/sourcegraph/internal/appliance/config"
 	"github.com/sourcegraph/sourcegraph/internal/appliance/k8senvtest"
 )
@@ -32,6 +33,9 @@ type ApplianceTestSuite struct {
 }
 
 func TestApplianceTestSuite(t *testing.T) {
+	if !k8senvtest.ShouldRunSetupEnvTests() {
+		t.Skip("setup-envtest is not installed or we are not in CI, skipping ApplianceTestSuite")
+	}
 	suite.Run(t, new(ApplianceTestSuite))
 }
 

internal/appliance/selfupdate/integrationtest/integration_test.go

@@ -19,6 +19,7 @@ import (
 	"github.com/sourcegraph/log"
 	"github.com/sourcegraph/log/logr"
 	"github.com/sourcegraph/log/logtest"
+
 	"github.com/sourcegraph/sourcegraph/internal/appliance/config"
 	"github.com/sourcegraph/sourcegraph/internal/appliance/k8senvtest"
 	"github.com/sourcegraph/sourcegraph/internal/appliance/selfupdate"

internal/appliance/selfupdate/selfupdate.go

@@ -11,6 +11,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
 	"github.com/sourcegraph/log"
+
 	"github.com/sourcegraph/sourcegraph/internal/appliance"
 	"github.com/sourcegraph/sourcegraph/internal/releaseregistry"
 	"github.com/sourcegraph/sourcegraph/lib/errors"

internal/appliance/selfupdate/selfupdate_test.go

@@ -7,6 +7,7 @@ import (
 	"github.com/stretchr/testify/require"
 
 	"github.com/sourcegraph/log/logtest"
+
 	"github.com/sourcegraph/sourcegraph/internal/releaseregistry"
 	"github.com/sourcegraph/sourcegraph/internal/releaseregistry/mocks"
 )