Adds support for linking a Devfile component with an Operator backed service (redhat-developer#3557)

* Add dependency on service binding operator

* Add extra dependencies for service binding operator

* Adds support for odo link between component and operator hub service

* Add owner reference for the link

* Deals with inability to install SBO the OLM way on k8s

redhat-developer/service-binding-operator#536

* Adds and removes 'odo link' entry to/from env.yaml

* Makes odo push set appropriate "envFrom" for a podTemplateSpec

* Changes to unit test & those based on PR feedback

* Rebase and "glide update -v"

* Make the linter happy. Remove unused variables

* Fix unit test of envinfo to include 'link' paramter

* Move 'odo link' tests under operator hub tests

* Install SBO on the cluster

* Changes as per PR feedback

* Check for Operator before trying to create a link

* Change error message expected in tests

* Make example less confusing by using less 'example'

Author: dharmit

glide.lock

@@ -88,15 +88,20 @@ import:
   version: v1.3.3
   subpackages:
   - errdefs
-- package: github.com/google/go-github/github
+- package: github.com/google/go-github
   version: v30.1.0
+  subpackages:
+  - github
 - package: github.com/golang/mock
   version: v1.4.3
-# help glide with go mod submodule tag
 - package: github.com/Azure/go-autorest
   version: autorest/v0.9.0
-  # use older version due to https://github.com/hashicorp/go-multierror/issues/36
 - package: github.com/hashicorp/go-multierror
   version: v1.0.0
 - package: github.com/zalando/go-keyring
-  version: master
+  version: master
+- package: github.com/redhat-developer/service-binding-operator
+  version: v0.1.1
+- package: github.com/openshift/custom-resource-status
+- package: sigs.k8s.io/controller-runtime/
+  version: v0.6.0

glide.yaml

@@ -7,6 +7,7 @@ import (
 	"strings"
 
 	componentlabels "github.com/openshift/odo/pkg/component/labels"
+	"github.com/openshift/odo/pkg/envinfo"
 	"github.com/openshift/odo/pkg/exec"
 
 	corev1 "k8s.io/api/core/v1"
@@ -107,7 +108,7 @@ func (a Adapter) Push(parameters common.PushParameters) (err error) {
 		parameters.ForceBuild = true
 	}
 
-	err = a.createOrUpdateComponent(componentExists)
+	err = a.createOrUpdateComponent(componentExists, parameters.EnvSpecificInfo)
 	if err != nil {
 		return errors.Wrap(err, "unable to create or update component")
 	}
@@ -211,7 +212,7 @@ func (a Adapter) DoesComponentExist(cmpName string) (bool, error) {
 	return utils.ComponentExists(a.Client, cmpName)
 }
 
-func (a Adapter) createOrUpdateComponent(componentExists bool) (err error) {
+func (a Adapter) createOrUpdateComponent(componentExists bool, ei envinfo.EnvSpecificInfo) (err error) {
 	componentName := a.ComponentName
 
 	componentType := strings.TrimSuffix(a.AdapterContext.Devfile.Data.GetMetadata().Name, "-")
@@ -234,6 +235,12 @@ func (a Adapter) createOrUpdateComponent(componentExists bool) (err error) {
 		return err
 	}
 
+	// set EnvFrom to the container that's supposed to have link to the Operator backed service
+	containers, err = utils.UpdateContainerWithEnvFrom(containers, a.Devfile, a.devfileRunCmd, ei)
+	if err != nil {
+		return err
+	}
+
 	objectMeta := kclient.CreateObjectMeta(componentName, a.Client.Namespace, labels, nil)
 	podTemplateSpec := kclient.GeneratePodTemplateSpec(objectMeta, containers)
 

pkg/devfile/adapters/kubernetes/component/adapter.go

@@ -3,6 +3,7 @@ package component
 import (
 	"testing"
 
+	"github.com/openshift/odo/pkg/envinfo"
 	"github.com/openshift/odo/pkg/util"
 	"github.com/pkg/errors"
 
@@ -39,30 +40,35 @@ func TestCreateOrUpdateComponent(t *testing.T) {
 	tests := []struct {
 		name          string
 		componentType versionsCommon.DevfileComponentType
+		envInfo       envinfo.EnvSpecificInfo
 		running       bool
 		wantErr       bool
 	}{
 		{
 			name:          "Case 1: Invalid devfile",
 			componentType: "",
+			envInfo:       envinfo.EnvSpecificInfo{},
 			running:       false,
 			wantErr:       true,
 		},
 		{
 			name:          "Case 2: Valid devfile",
 			componentType: versionsCommon.ContainerComponentType,
+			envInfo:       envinfo.EnvSpecificInfo{},
 			running:       false,
 			wantErr:       false,
 		},
 		{
 			name:          "Case 3: Invalid devfile, already running component",
 			componentType: "",
+			envInfo:       envinfo.EnvSpecificInfo{},
 			running:       true,
 			wantErr:       true,
 		},
 		{
 			name:          "Case 4: Valid devfile, already running component",
 			componentType: versionsCommon.ContainerComponentType,
+			envInfo:       envinfo.EnvSpecificInfo{},
 			running:       true,
 			wantErr:       false,
 		},
@@ -98,7 +104,7 @@ func TestCreateOrUpdateComponent(t *testing.T) {
 			}
 
 			componentAdapter := New(adapterCtx, *fkclient)
-			err := componentAdapter.createOrUpdateComponent(tt.running)
+			err := componentAdapter.createOrUpdateComponent(tt.running, tt.envInfo)
 
 			// Checks for unexpected error cases
 			if !tt.wantErr == (err != nil) {
@@ -269,27 +275,31 @@ func TestDoesComponentExist(t *testing.T) {
 		componentType    versionsCommon.DevfileComponentType
 		componentName    string
 		getComponentName string
+		envInfo          envinfo.EnvSpecificInfo
 		want             bool
 		wantErr          bool
 	}{
 		{
 			name:             "Case 1: Valid component name",
 			componentName:    "test-name",
 			getComponentName: "test-name",
+			envInfo:          envinfo.EnvSpecificInfo{},
 			want:             true,
 			wantErr:          false,
 		},
 		{
 			name:             "Case 2: Non-existent component name",
 			componentName:    "test-name",
 			getComponentName: "fake-component",
+			envInfo:          envinfo.EnvSpecificInfo{},
 			want:             false,
 			wantErr:          false,
 		},
 		{
 			name:             "Case 3: Error condition",
 			componentName:    "test-name",
 			getComponentName: "test-name",
+			envInfo:          envinfo.EnvSpecificInfo{},
 			want:             false,
 			wantErr:          true,
 		},
@@ -317,7 +327,7 @@ func TestDoesComponentExist(t *testing.T) {
 
 			// DoesComponentExist requires an already started component, so start it.
 			componentAdapter := New(adapterCtx, *fkclient)
-			err := componentAdapter.createOrUpdateComponent(false)
+			err := componentAdapter.createOrUpdateComponent(false, tt.envInfo)
 
 			// Checks for unexpected error cases
 			if err != nil {

pkg/devfile/adapters/kubernetes/component/adapter_test.go

@@ -8,6 +8,7 @@ import (
 	adaptersCommon "github.com/openshift/odo/pkg/devfile/adapters/common"
 	devfileParser "github.com/openshift/odo/pkg/devfile/parser"
 	"github.com/openshift/odo/pkg/devfile/parser/data/common"
+	"github.com/openshift/odo/pkg/envinfo"
 	"github.com/openshift/odo/pkg/kclient"
 	"github.com/openshift/odo/pkg/util"
 
@@ -270,3 +271,39 @@ func overrideContainerArgs(container *corev1.Container) {
 	container.Command = append(container.Command, adaptersCommon.SupervisordBinaryPath)
 	container.Args = append(container.Args, "-c", adaptersCommon.SupervisordConfFile)
 }
+
+// UpdateContainerWithEnvFrom populates the runtime container with relevant
+// values for "EnvFrom" so that component can be linked with Operator backed
+// service
+func UpdateContainerWithEnvFrom(containers []corev1.Container, devfile devfileParser.DevfileObj, devfileRunCmd string, ei envinfo.EnvSpecificInfo) ([]corev1.Container, error) {
+	runCommand, err := adaptersCommon.GetRunCommand(devfile.Data, devfileRunCmd)
+	if err != nil {
+		return nil, err
+	}
+
+	for i := range containers {
+		c := &containers[i]
+		if c.Name == runCommand.Exec.Component {
+			c.EnvFrom = generateEnvFromSource(ei)
+		}
+	}
+
+	return containers, nil
+}
+
+func generateEnvFromSource(ei envinfo.EnvSpecificInfo) []corev1.EnvFromSource {
+
+	envFrom := []corev1.EnvFromSource{}
+
+	for _, link := range ei.GetLink() {
+		envFrom = append(envFrom, corev1.EnvFromSource{
+			SecretRef: &corev1.SecretEnvSource{
+				LocalObjectReference: corev1.LocalObjectReference{
+					Name: link.Name,
+				},
+			},
+		})
+	}
+
+	return envFrom
+}