change makefile test target for no longer be required manual steps to run the commands (#3983)

**Description**
Customize the makefile target tests to download the binaries. 

Closes: #3692

Author: camilamacedo86

.gitignore

@@ -111,4 +111,9 @@ website/resources/
 website/node_modules/
 website/tech-doc-hugo
 
+# samples bin
+testdata/go/memcached-operator/bin/*
+
+
 *\.DS_Store
+

changelog/fragments/makefile_test.yaml

@@ -0,0 +1,17 @@
+# entries is a list of entries to include in
+# release notes and/or the migration guide
+entries:
+  - description: >
+      In Go projects, resolved an issue that caused failing tests by changing the Makefile's `test` target to
+      automatically download and configure the necessary `envtest` binaries.
+
+    # kind is one of:
+    # - addition
+    # - change
+    # - deprecation
+    # - removal
+    # - bugfix
+    kind: "bugfix"
+
+    # Is this a breaking change?
+    breaking: false

internal/plugins/envtest/init.go

@@ -0,0 +1,68 @@
+// Copyright 2020 The Operator-SDK Authors
+//
+// 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.
+
+// TODO: This implementation is already done for v3+. Also, it might be
+// addressed on v2 as well. More info: https://github.com/kubernetes-sigs/kubebuilder/pull/1711
+package envtest
+
+import (
+	"fmt"
+	"io/ioutil"
+	"os"
+	"strings"
+
+	"sigs.k8s.io/kubebuilder/pkg/model/config"
+)
+
+// controllerRuntimeVersion version to be used to download the envtest setup script
+const controllerRuntimeVersion = "v0.6.3"
+
+// RunInit modifies the project scaffolded by kubebuilder's Init plugin.
+func RunInit(cfg *config.Config) error {
+	// Only run these if project version is v3.
+	if !cfg.IsV3() {
+		return nil
+	}
+
+	// Update the scaffolded Makefile with operator-sdk recipes.
+	if err := initUpdateMakefile("Makefile"); err != nil {
+		return fmt.Errorf("error updating Makefile: %v", err)
+	}
+	return nil
+}
+
+// initUpdateMakefile updates a vanilla kubebuilder Makefile with operator-sdk recipes.
+func initUpdateMakefile(filePath string) error {
+	makefileBytes, err := ioutil.ReadFile(filePath)
+	if err != nil {
+		return err
+	}
+
+	makefileBytes = []byte(strings.Replace(string(makefileBytes),
+		"# Run tests\ntest: generate fmt vet manifests\n\tgo test ./... -coverprofile cover.out",
+		fmt.Sprintf(makefileTestTarget, controllerRuntimeVersion), 1))
+
+	var mode os.FileMode = 0644
+	if info, err := os.Stat(filePath); err != nil {
+		mode = info.Mode()
+	}
+	return ioutil.WriteFile(filePath, makefileBytes, mode)
+}
+
+const makefileTestTarget = `# Run tests
+ENVTEST_ASSETS_DIR = $(shell pwd)/testbin
+test: generate fmt vet manifests
+	mkdir -p $(ENVTEST_ASSETS_DIR)
+	test -f $(ENVTEST_ASSETS_DIR)/setup-envtest.sh || curl -sSLo $(ENVTEST_ASSETS_DIR)/setup-envtest.sh https://raw.githubusercontent.com/kubernetes-sigs/controller-runtime/%s/hack/setup-envtest.sh
+	source $(ENVTEST_ASSETS_DIR)/setup-envtest.sh; fetch_envtest_tools $(ENVTEST_ASSETS_DIR); setup_envtest_env $(ENVTEST_ASSETS_DIR); go test ./... -coverprofile cover.out`

internal/plugins/golang/v2/init.go

@@ -21,6 +21,7 @@ import (
 	"sigs.k8s.io/kubebuilder/pkg/model/config"
 	"sigs.k8s.io/kubebuilder/pkg/plugin"
 
+	"github.com/operator-framework/operator-sdk/internal/plugins/envtest"
 	"github.com/operator-framework/operator-sdk/internal/plugins/manifests"
 	"github.com/operator-framework/operator-sdk/internal/plugins/scorecard"
 )
@@ -64,6 +65,9 @@ func (p *initPlugin) Run() error {
 
 // SDK phase 2 plugins.
 func (p *initPlugin) runPhase2() error {
+	if err := envtest.RunInit(p.config); err != nil {
+		return err
+	}
 	if err := manifests.RunInit(p.config); err != nil {
 		return err
 	}

internal/plugins/manifests/init.go

@@ -18,6 +18,7 @@ package manifests
 import (
 	"fmt"
 	"io/ioutil"
+	"os"
 
 	"sigs.k8s.io/kubebuilder/pkg/model/config"
 
@@ -61,7 +62,11 @@ func initUpdateMakefile(cfg *config.Config, filePath string) error {
 
 	makefileBytes = append(makefileBytes, []byte(makefileBundleBuildFragment)...)
 
-	return ioutil.WriteFile(filePath, makefileBytes, 0644)
+	var mode os.FileMode = 0644
+	if info, err := os.Stat(filePath); err != nil {
+		mode = info.Mode()
+	}
+	return ioutil.WriteFile(filePath, makefileBytes, mode)
 }
 
 // Makefile fragments to add to the base Makefile.

testdata/go/memcached-operator/Makefile

@@ -26,8 +26,11 @@ endif
 all: manager
 
 # Run tests
+ENVTEST_ASSETS_DIR = $(shell pwd)/testbin
 test: generate fmt vet manifests
-	go test ./... -coverprofile cover.out
+	mkdir -p $(ENVTEST_ASSETS_DIR)
+	test -f $(ENVTEST_ASSETS_DIR)/setup-envtest.sh || curl -sSLo $(ENVTEST_ASSETS_DIR)/setup-envtest.sh https://raw.githubusercontent.com/kubernetes-sigs/controller-runtime/v0.6.3/hack/setup-envtest.sh
+	source $(ENVTEST_ASSETS_DIR)/setup-envtest.sh; fetch_envtest_tools $(ENVTEST_ASSETS_DIR); setup_envtest_env $(ENVTEST_ASSETS_DIR); go test ./... -coverprofile cover.out
 
 # Build manager binary
 manager: generate fmt vet

website/content/en/docs/building-operators/golang/migration.md

@@ -214,20 +214,6 @@ func main() {
 
 - Ensure that you copy all customizations made in `cmd/manager/main.go` to `main.go`. You’ll also need to ensure that all needed schemes have been registered, if you have been using third-party API's (i.e Route Api from OpenShift).
 
-### Configuring your test environment
-
-[Setup the `envtest` binaries and environment][envtest-setup] for your project.
-Update your `test` Makefile target to the following:
-
-```sh
-# Run tests
-ENVTEST_ASSETS_DIR=$(shell pwd)/testbin
-test: generate fmt vet manifests
-	mkdir -p ${ENVTEST_ASSETS_DIR}
-	test -f ${ENVTEST_ASSETS_DIR}/setup-envtest.sh || curl -sSLo ${ENVTEST_ASSETS_DIR}/setup-envtest.sh https://raw.githubusercontent.com/kubernetes-sigs/controller-runtime/master/hack/setup-envtest.sh
-	source ${ENVTEST_ASSETS_DIR}/setup-envtest.sh; fetch_envtest_tools $(ENVTEST_ASSETS_DIR); setup_envtest_env $(ENVTEST_ASSETS_DIR); go test ./... -coverprofile cover.out
-```
-
 ## Migrate your tests
 
 For the new layout, you will see that `controllers/suite_test.go` is created when a controller is scaffolded by the tool. This file contains boilerplate for executing integration tests using [envtest][envtest] with [ginkgo](https://onsi.github.io/ginkgo/) and [gomega][gomega].
@@ -355,7 +341,6 @@ E.g `kubectl logs deployment.apps/memcached-operator-controller-manager -n memca
 [metrics]: https://book.kubebuilder.io/reference/metrics.html?highlight=metr#metrics
 [memcached_controller]: https://github.com/operator-framework/operator-sdk/blob/master/testdata/go/memcached-operator/controllers/memcached_controller.go
 [rbac_markers]: https://book.kubebuilder.io/reference/markers/rbac.html
-[envtest-setup]: /docs/building-operators/golang/references/envtest-setup
 [kube-auth-proxy]: https://github.com/brancz/kube-rbac-proxy
 [markers]: https://book.kubebuilder.io/reference/markers.html?highlight=markers#marker-syntax
 [operator-scope]: /docs/building-operators/golang/operator-scope

website/content/en/docs/building-operators/golang/quickstart.md

@@ -34,20 +34,6 @@ Create a simple Memcached API:
 operator-sdk create api --group cache --version v1 --kind Memcached --resource=true --controller=true
 ```
 
-### Configuring your test environment
-
-[Setup the `envtest` binaries and environment][envtest-setup] for your project.
-Update your `test` Makefile target to the following:
-
-```sh
-# Run tests
-ENVTEST_ASSETS_DIR=$(shell pwd)/testbin
-test: generate fmt vet manifests
-	mkdir -p ${ENVTEST_ASSETS_DIR}
-	test -f ${ENVTEST_ASSETS_DIR}/setup-envtest.sh || curl -sSLo ${ENVTEST_ASSETS_DIR}/setup-envtest.sh https://raw.githubusercontent.com/kubernetes-sigs/controller-runtime/master/hack/setup-envtest.sh
-	source ${ENVTEST_ASSETS_DIR}/setup-envtest.sh; fetch_envtest_tools $(ENVTEST_ASSETS_DIR); setup_envtest_env $(ENVTEST_ASSETS_DIR); go test ./... -coverprofile cover.out
-```
-
 ### Build and push the operator image
 
 Use the built-in Makefile targets to build and push your operator. Make
@@ -102,6 +88,5 @@ Read the [tutorial][tutorial] for an in-depth walkthough of building a Go operat
 [docker_tool]:https://docs.docker.com/install/
 [kubectl_tool]:https://kubernetes.io/docs/tasks/tools/install-kubectl/
 [operator_install]: /docs/installation/install-operator-sdk
-[envtest-setup]: /docs/building-operators/golang/references/envtest-setup
 [tutorial]: /docs/building-operators/golang/tutorial/