feat(scenario): simplify generation of non complete setups

Allow for single SubGenerator generation for e.g. only create a Deployment
to simulate the Che Workspace Deployment.

Author: aslakknutsen

test/cmd/test-scenario/generator/generators.go

@@ -50,34 +50,49 @@ type Modifier func(service Entry, object runtime.Object)
 // Generate runs and prints the full test scenario generation to sysout.
 func Generate(out io.Writer, services []Entry, modifiers ...Modifier) {
 	sub := []SubGenerator{Deployment, DeploymentConfig, Service, DestinationRule, VirtualService}
-	modify := func(service Entry, object runtime.Object) {
-		for _, modifier := range modifiers {
-			modifier(service, object)
-		}
-	}
-	printObj := func(object runtime.Object) {
-		b, err := yaml.Marshal(object)
-		if err != nil {
-			_, _ = io.WriteString(out, "Marshal error"+err.Error()+"\n")
-		}
-		_, _ = out.Write(b)
-		_, _ = io.WriteString(out, "---\n")
-	}
 	for _, service := range services {
 		func(service Entry) {
 			for _, subGenerator := range sub {
-				object := subGenerator(service)
-				if object == nil {
-					continue
-				}
-				modify(service, object)
-				printObj(object)
+				Do(out, service, subGenerator, modifiers...)
 			}
 		}(service)
 	}
 	gw := Gateway()
-	modify(Entry{Name: "gateway"}, gw)
-	printObj(gw)
+	modify(Entry{Name: "gateway"}, gw, modifiers...)
+	printObj(out, gw)
+}
+
+// Do executes the SubGenerator and applies the Modifiers and prints the object to the io.Writer
+func Do(out io.Writer, service Entry, generator SubGenerator, modifiers ...Modifier) {
+	object := gen(service, generator)
+	if object == nil {
+		return
+	}
+	modify(service, object, modifiers...)
+	printObj(out, object)
+}
+
+func gen(service Entry, generator SubGenerator) runtime.Object {
+	object := generator(service)
+	if object == nil {
+		return nil
+	}
+	return object
+}
+
+func modify(service Entry, object runtime.Object, modifiers ...Modifier) {
+	for _, modifier := range modifiers {
+		modifier(service, object)
+	}
+}
+
+func printObj(out io.Writer, object runtime.Object) {
+	b, err := yaml.Marshal(object)
+	if err != nil {
+		_, _ = io.WriteString(out, "Marshal error"+err.Error()+"\n")
+	}
+	_, _ = out.Write(b)
+	_, _ = io.WriteString(out, "---\n")
 }
 
 // DeploymentConfig basic SubGenerator for the kind DeploymentConfig.

test/cmd/test-scenario/generator/modifiers.go

@@ -1,11 +1,14 @@
 package generator
 
 import (
+	"reflect"
+
 	osappsv1 "github.com/openshift/api/apps/v1"
 	istiov1alpha3 "istio.io/api/networking/v1alpha3"
 	istionetwork "istio.io/client-go/pkg/apis/networking/v1alpha3"
 	appsv1 "k8s.io/api/apps/v1"
 	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 )
 
@@ -150,3 +153,19 @@ func WithVersion(version string) Modifier {
 		}
 	}
 }
+
+func WithAnnotations(annotations map[string]string) Modifier {
+	return func(service Entry, object runtime.Object) {
+		k8sObjValue := reflect.ValueOf(object).Elem()
+		objectField := k8sObjValue.FieldByName("ObjectMeta")
+		if objMeta, ok := objectField.Interface().(metav1.ObjectMeta); ok {
+			if objMeta.Annotations == nil {
+				objMeta.Annotations = map[string]string{}
+			}
+			for k, v := range annotations {
+				objMeta.Annotations[k] = v
+			}
+			objectField.Set(reflect.ValueOf(objMeta))
+		}
+	}
+}

test/cmd/test-scenario/generator/scenarios.go

@@ -60,6 +60,29 @@ func TestScenario2ThreeServicesInSequenceDeploymentConfig(out io.Writer) {
 	)
 }
 
+// TestScenarioMutationHookChe is a basic test setup with a
+// few services calling each other in a chain. Similar to the original bookinfo example setup
+// and a single Deployment simulating a Che Deployment which should trigger the WebHook.
+// Using Deployment.
+func TestScenarioMutationHookChe(out io.Writer) {
+	productpage := Entry{"productpage", "Deployment", Namespace}
+	reviews := Entry{"reviews", "Deployment", Namespace}
+	ratings := Entry{"ratings", "Deployment", Namespace}
+	che := Entry{"che-workspace", "Deployment", Namespace}
+
+	Generate(
+		out,
+		[]Entry{productpage, reviews, ratings},
+		ForService(productpage, WithVersion("v1")),
+		ForService(reviews, WithVersion("v1")),
+		ForService(ratings, WithVersion("v1")),
+		ForService(productpage, Call(HTTP(), reviews), ConnectToGateway(GatewayHost)),
+		ForService(reviews, Call(HTTP(), ratings)),
+		GatewayOnHost(GatewayHost),
+	)
+	Do(out, che, Deployment, WithAnnotations(map[string]string{"ike.target": "reviews-v1"}))
+}
+
 // DemoScenario is a simple setup for demo purposes.
 func DemoScenario(out io.Writer) {
 	productpage := Entry{"productpage", "Deployment", Namespace}

test/cmd/test-scenario/main.go

@@ -28,6 +28,7 @@ func main() {
 		"scenario-1":   generator.TestScenario1HTTPThreeServicesInSequence,
 		"scenario-1.1": generator.TestScenario1GRPCThreeServicesInSequence,
 		"scenario-2":   generator.TestScenario2ThreeServicesInSequenceDeploymentConfig,
+		"scenario-che": generator.TestScenarioMutationHookChe,
 		"demo":         generator.DemoScenario,
 	}
 	scenario := os.Args[1]