commands/.../test/local,pkg/test: add image flag to test local (#768)

* commands/.../test/local,pkg/test: add image flag to test local

Author: AlexNPavel

CHANGELOG.md

@@ -7,6 +7,7 @@
 ### Added
 
 - A new command [`operator-sdk print-deps`](https://github.com/operator-framework/operator-sdk/blob/master/doc/sdk-cli-reference.md#print-deps) which prints Golang packages and versions expected by the current Operator SDK version. Supplying `--as-file` prints packages and versions in Gopkg.toml format. ([#772](https://github.com/operator-framework/operator-sdk/pull/772))
+- Add [`image`](https://github.com/operator-framework/operator-sdk/blob/master/doc/sdk-cli-reference.md#flags-9) flag to `test local` subcommand ([#768](https://github.com/operator-framework/operator-sdk/pull/768))
 
 ### Bug fixes
 

Gopkg.lock

@@ -15,6 +15,7 @@
 package cmdtest
 
 import (
+	"bytes"
 	"fmt"
 	"io/ioutil"
 	"os"
@@ -27,8 +28,13 @@ import (
 	"github.com/operator-framework/operator-sdk/pkg/scaffold"
 	"github.com/operator-framework/operator-sdk/pkg/test"
 
+	"github.com/ghodss/yaml"
 	log "github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
+	appsv1 "k8s.io/api/apps/v1"
+	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/apimachinery/pkg/runtime/serializer"
+	cgoscheme "k8s.io/client-go/kubernetes/scheme"
 )
 
 var deployTestDir = filepath.Join(scaffold.DeployDir, "test")
@@ -39,6 +45,7 @@ type testLocalConfig struct {
 	namespacedManPath string
 	goTestFlags       string
 	namespace         string
+	image             string
 }
 
 var tlConfig testLocalConfig
@@ -54,6 +61,7 @@ func NewTestLocalCmd() *cobra.Command {
 	testCmd.Flags().StringVar(&tlConfig.namespacedManPath, "namespaced-manifest", "", "Path to manifest for per-test, namespaced resources (e.g. RBAC and Operator manifest)")
 	testCmd.Flags().StringVar(&tlConfig.goTestFlags, "go-test-flags", "", "Additional flags to pass to go test")
 	testCmd.Flags().StringVar(&tlConfig.namespace, "namespace", "", "If non-empty, single namespace to run tests in")
+	testCmd.Flags().StringVar(&tlConfig.image, "image", "", "Use a different operator image from the one specified in the namespaced manifest")
 
 	return testCmd
 }
@@ -141,6 +149,11 @@ func testLocalFunc(cmd *cobra.Command, args []string) {
 			}
 		}()
 	}
+	if tlConfig.image != "" {
+		if err := replaceImage(tlConfig.namespacedManPath, tlConfig.image); err != nil {
+			log.Fatalf("failed to overwrite operator image in the namespaced manifest: %v", err)
+		}
+	}
 	testArgs := []string{"test", args[0] + "/..."}
 	testArgs = append(testArgs, "-"+test.KubeConfigFlag, tlConfig.kubeconfig)
 	testArgs = append(testArgs, "-"+test.NamespacedManPathFlag, tlConfig.namespacedManPath)
@@ -176,3 +189,65 @@ func combineManifests(base, manifest []byte) []byte {
 	}
 	return base
 }
+
+// TODO: add support for multiple deployments and containers (user would have to
+// provide extra information in that case)
+
+// replaceImage searches for a deployment and replaces the image in the container
+// to the one specified in the function call. The function will fail if the
+// number of deployments is not equal to one or if the deployment has multiple
+// containers
+func replaceImage(manifestPath, image string) error {
+	yamlFile, err := ioutil.ReadFile(manifestPath)
+	if err != nil {
+		return err
+	}
+	foundDeployment := false
+	newManifest := []byte{}
+	yamlSplit := bytes.Split(yamlFile, []byte("\n---\n"))
+	for _, yamlSpec := range yamlSplit {
+		if string(yamlSpec) == "" {
+			continue
+		}
+		decoded := make(map[string]interface{})
+		err = yaml.Unmarshal(yamlSpec, &decoded)
+		if err != nil {
+			return err
+		}
+		kind, ok := decoded["kind"].(string)
+		if !ok || kind != "Deployment" {
+			newManifest = combineManifests(newManifest, yamlSpec)
+			continue
+		}
+		if foundDeployment {
+			return fmt.Errorf("cannot use `image` flag on namespaced manifest with more than 1 deployment")
+		}
+		foundDeployment = true
+		scheme := runtime.NewScheme()
+		// scheme for client go
+		cgoscheme.AddToScheme(scheme)
+		dynamicDecoder := serializer.NewCodecFactory(scheme).UniversalDeserializer()
+
+		obj, _, err := dynamicDecoder.Decode(yamlSpec, nil, nil)
+		if err != nil {
+			return err
+		}
+		dep := &appsv1.Deployment{}
+		switch o := obj.(type) {
+		case *appsv1.Deployment:
+			dep = o
+		default:
+			return fmt.Errorf("error in replaceImage switch case; could not convert runtime.Object to deployment")
+		}
+		if len(dep.Spec.Template.Spec.Containers) != 1 {
+			return fmt.Errorf("cannot use `image` flag on namespaced manifest containing more than 1 container in the operator deployment")
+		}
+		dep.Spec.Template.Spec.Containers[0].Image = image
+		updatedYamlSpec, err := yaml.Marshal(dep)
+		if err != nil {
+			return fmt.Errorf("failed to convert deployment object back to yaml: %v", err)
+		}
+		newManifest = combineManifests(newManifest, updatedYamlSpec)
+	}
+	return ioutil.WriteFile(manifestPath, newManifest, fileutil.DefaultFileMode)
+}

commands/operator-sdk/cmd/test/local.go

@@ -257,6 +257,7 @@ Runs the tests locally
 * `--namespaced-manifest` string - path to manifest for per-test, namespaced resources (default: combines deploy/service_account.yaml, deploy/rbac.yaml, and deploy/operator.yaml)
 *  `--namespace` string - if non-empty, single namespace to run tests in (e.g. "operator-test") (default: "")
 * `--go-test-flags` string - extra arguments to pass to `go test` (e.g. -f "-v -parallel=2")
+* `--image` string - use a different operator image from the one specified in the namespaced manifest
 * `-h, --help` - help for local
 
 ##### Use

doc/sdk-cli-reference.md

@@ -236,6 +236,13 @@ as an argument. You can use `--help` to view the other configuration options and
 $ operator-sdk test local ./test/e2e --go-test-flags "-v -parallel=2"
 ```
 
+If you wish to specify a different operator image than specified in your `operator.yaml` file (or a user-specified
+namespaced manifest file), you can use the `--image` flag:
+
+```shell
+$ operator-sdk test local ./test/e2e --image quay.io/example/my-operator:v0.0.2
+```
+
 If you wish to run all the tests in 1 namespace (which also forces `-parallel=1`), you can use the `--namespace` flag:
 
 ```shell

doc/test-framework/writing-e2e-tests.md

@@ -5,7 +5,7 @@ cd test/test-framework
 # test framework with defaults
 operator-sdk test local .
 # test operator-sdk test flags
-operator-sdk test local . --global-manifest deploy/crds/cache_v1alpha1_memcached_crd.yaml --namespaced-manifest deploy/namespace-init.yaml --go-test-flags "-parallel 1" --kubeconfig $HOME/.kube/config
+operator-sdk test local . --global-manifest deploy/crds/cache_v1alpha1_memcached_crd.yaml --namespaced-manifest deploy/namespace-init.yaml --go-test-flags "-parallel 1" --kubeconfig $HOME/.kube/config --image=quay.io/coreos/operator-sdk-dev:test-framework-operator-runtime
 # test operator-sdk test local single namespace mode
 kubectl create namespace test-memcached
 operator-sdk test local . --namespace=test-memcached

hack/tests/test-subcommand.sh

@@ -66,6 +66,10 @@ func (ctx *TestCtx) createFromYAML(yamlFile []byte, skipIfExists bool, cleanupOp
 	}
 	yamlSplit := bytes.Split(yamlFile, []byte("\n---\n"))
 	for _, yamlSpec := range yamlSplit {
+		// some autogenerated files may include an extra `---` at the end of the file
+		if string(yamlSpec) == "" {
+			continue
+		}
 		yamlSpec, err = setNamespaceYAML(yamlSpec, namespace)
 		if err != nil {
 			return err