Mock out HTTP calls in DevWorkspace controller tests

Introduce a fake http.Transport to allow simulating responses to HTTP
calls in DevWorkspace Operator tests. This is required for testing that
DevWorkspaces with mainUrls can enter the Running state.

Signed-off-by: Angel Misevski <[email protected]>

Author: amisevsk

controllers/workspace/http_test.go

@@ -0,0 +1,21 @@
+// Copyright (c) 2019-2022 Red Hat, Inc.
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package controllers
+
+import "net/http"
+
+func SetupHttpClientsForTesting(client *http.Client) {
+	httpClient = client
+	healthCheckHttpClient = client
+}

controllers/workspace/internal/testutil/http.go

@@ -0,0 +1,53 @@
+// Copyright (c) 2019-2022 Red Hat, Inc.
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package testutil
+
+import (
+	"bytes"
+	"fmt"
+	"io"
+	"net/http"
+)
+
+type TestRoundTripper struct {
+	Data map[string]TestResponse
+}
+
+type TestResponse struct {
+	StatusCode int
+	Bytes      []byte
+	Err        error
+}
+
+func (rt *TestRoundTripper) RoundTrip(req *http.Request) (*http.Response, error) {
+	if req.Method != http.MethodGet {
+		return nil, fmt.Errorf("test HTTP client only supports GET requests")
+	}
+	resp, ok := rt.Data[req.URL.String()]
+	if !ok {
+		return nil, fmt.Errorf("unexpected request URL in test HTTP client: %s", req.URL.String())
+	}
+
+	if resp.Err != nil {
+		return nil, resp.Err
+	}
+
+	return &http.Response{
+		StatusCode:    resp.StatusCode,
+		Body:          io.NopCloser(bytes.NewBuffer(resp.Bytes)),
+		ContentLength: int64(len(resp.Bytes)),
+	}, nil
+}
+
+var _ http.RoundTripper = (*TestRoundTripper)(nil)

controllers/workspace/suite_test.go

@@ -16,13 +16,15 @@ package controllers_test
 import (
 	"context"
 	"fmt"
+	"net/http"
 	"os"
 	"path/filepath"
 	"testing"
 
 	dwv1 "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha1"
 	dwv2 "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2"
 	controllerv1alpha1 "github.com/devfile/devworkspace-operator/apis/controller/v1alpha1"
+	"github.com/devfile/devworkspace-operator/controllers/workspace/internal/testutil"
 	appsv1 "k8s.io/api/apps/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"sigs.k8s.io/yaml"
@@ -134,6 +136,9 @@ var _ = BeforeSuite(func() {
 	}).SetupWithManager(mgr)
 	Expect(err).NotTo(HaveOccurred())
 
+	// Set HTTP client to fail all requests by default; tests that require HTTP must set this up directly
+	workspacecontroller.SetupHttpClientsForTesting(getBasicTestHttpClient())
+
 	// Skip trying to set up / test webhooks for now
 
 	By("Creating Namespace for the DevWorkspace")
@@ -187,3 +192,9 @@ func setupEnvVars() error {
 
 	return nil
 }
+
+func getBasicTestHttpClient() *http.Client {
+	return &http.Client{
+		Transport: &testutil.TestRoundTripper{},
+	}
+}