Transformation wizard (#287)

* Transformation GUI mock

* Sample events

* Transformation operations

* Object creation

* Create transformation from wizard

* Editable operation path key

* Fix components and event types parsing, fallback to stdin

* Moved to the new registry

* Targets layout read/write fix

* Cleanup

* Disable config registry param

* Placeholder message

* Update triggermesh upstream dependency

* Change creation hotkey

* Edit mode added

* Escapable popups, more operations sanitizing

* Docs update

* Improved controls and layout behavior

* Target selection mandatory

Author: tzununbekov

LICENSES/vendor/github.com/jroimartin/gocui/LICENSE

@@ -18,15 +18,19 @@ package create
 
 import (
 	"bufio"
+	"bytes"
 	"context"
 	"fmt"
+	"io"
 	"os"
 	"strings"
 
+	"github.com/jroimartin/gocui"
 	"github.com/spf13/cobra"
 	"gopkg.in/yaml.v3"
 
 	"github.com/triggermesh/tmctl/pkg/completion"
+	transformationgui "github.com/triggermesh/tmctl/pkg/gui/transformation"
 	"github.com/triggermesh/tmctl/pkg/log"
 	"github.com/triggermesh/tmctl/pkg/output"
 	"github.com/triggermesh/tmctl/pkg/triggermesh"
@@ -65,8 +69,9 @@ https://github.com/triggermesh/triggermesh/tree/main/config/samples/bumblebee`
 func (o *CliOptions) newTransformationCmd() *cobra.Command {
 	var name, target, file string
 	var eventSourcesFilter, eventTypesFilter []string
+	var wizard bool
 	transformationCmd := &cobra.Command{
-		Use:   "transformation [--target <name>][--source <name>...][--eventTypes <type>...][--from <path>]",
+		Use:   "transformation [--target <name>][--source <name>...][--eventTypes <type>...][--from <path>][--wizard]",
 		Short: "Create TriggerMesh transformation. More information at https://docs.triggermesh.io/transformation/jsontransformation/",
 		Example: `tmctl create transformation <<EOF
   data:
@@ -75,9 +80,26 @@ func (o *CliOptions) newTransformationCmd() *cobra.Command {
     - key: new-field
       value: hello from Transformation!
 EOF`,
-		ValidArgs: []string{"--name", "--target", "--source", "--eventTypes", "--from"},
+		ValidArgs: []string{"--name", "--target", "--source", "--eventTypes", "--from", "--wizard"},
 		RunE: func(cmd *cobra.Command, args []string) error {
-			return o.transformation(name, target, file, eventSourcesFilter, eventTypesFilter)
+			if wizard {
+				name, sourceEventType, target, spec, err := transformationgui.Create(o.CRD, o.Manifest, o.Config)
+				if err == gocui.ErrQuit {
+					return nil
+				}
+				if err != nil {
+					return fmt.Errorf("transformation wizard error: %w", err)
+				}
+				return o.transformation(name, target, spec, []string{}, []string{sourceEventType})
+			}
+			if file != "" {
+				data, err := os.ReadFile(file)
+				if err != nil {
+					return fmt.Errorf("file %q read: %w", file, err)
+				}
+				return o.transformation(name, target, bytes.NewBuffer(data), eventSourcesFilter, eventTypesFilter)
+			}
+			return o.transformation(name, target, nil, eventSourcesFilter, eventTypesFilter)
 		},
 	}
 
@@ -91,6 +113,8 @@ EOF`,
 	transformationCmd.Flags().StringSliceVar(&eventSourcesFilter, "source", []string{}, "Sources component names")
 	transformationCmd.Flags().StringSliceVar(&eventTypesFilter, "eventTypes", []string{}, "Event types filter")
 
+	transformationCmd.Flags().BoolVar(&wizard, "wizard", false, "Experimental transformation wizard")
+
 	cobra.CheckErr(transformationCmd.RegisterFlagCompletionFunc("name", cobra.NoFileCompletions))
 	cobra.CheckErr(transformationCmd.RegisterFlagCompletionFunc("source", func(cmd *cobra.Command, args []string, _ string) ([]string, cobra.ShellCompDirective) {
 		return completion.ListSources(o.Manifest), cobra.ShellCompDirectiveNoFileComp
@@ -104,10 +128,13 @@ EOF`,
 	return transformationCmd
 }
 
-func (o *CliOptions) transformation(name, target, file string, eventSourcesFilter, eventTypesFilter []string) error {
+func (o *CliOptions) transformation(name, target string, specReader io.Reader, eventSourcesFilter, eventTypesFilter []string) error {
 	ctx := context.Background()
+	targetLabel := ""
+
 	var targetComponent triggermesh.Component
 	if target != "" {
+		targetLabel = target
 		t, err := o.lookupTarget(ctx, target)
 		if err != nil {
 			return err
@@ -127,14 +154,14 @@ func (o *CliOptions) transformation(name, target, file string, eventSourcesFilte
 	eventTypesFilter = append(eventTypesFilter, et...)
 
 	var data []byte
-	if file == "" {
+	if specReader == nil {
 		input, err := fromStdIn()
 		if err != nil {
 			return fmt.Errorf("stdin read: %w", err)
 		}
 		data = []byte(input)
 	} else {
-		specFile, err := os.ReadFile(file)
+		specFile, err := io.ReadAll(specReader)
 		if err != nil {
 			return fmt.Errorf("spec file read: %w", err)
 		}
@@ -153,13 +180,13 @@ func (o *CliOptions) transformation(name, target, file string, eventSourcesFilte
 		return fmt.Errorf("CRD for kind \"transformation\" not found")
 	}
 
-	t := transformation.New(name, "transformation", o.Config.Context, o.Config.Triggermesh.ComponentsVersion, crd, spec)
+	t := transformation.New(name, "transformation", o.Config.Context,
+		o.Config.Triggermesh.ComponentsVersion, crd, spec)
 
 	transformationEventType := fmt.Sprintf("%s.output", t.GetName())
 	if len(expectedEventTypes) > 0 {
 		transformationEventType = expectedEventTypes[0]
 	}
-
 	producedEventTypes, _ := t.(triggermesh.Producer).GetEventTypes()
 	if len(producedEventTypes) == 0 {
 		if err := t.(triggermesh.Producer).SetEventAttributes(map[string]string{
@@ -169,6 +196,7 @@ func (o *CliOptions) transformation(name, target, file string, eventSourcesFilte
 		}
 	} else {
 		transformationEventType = producedEventTypes[0]
+		targetLabel = producedEventTypes[0]
 	}
 
 	eventTypesMatch := false
@@ -187,6 +215,8 @@ func (o *CliOptions) transformation(name, target, file string, eventSourcesFilte
 			transformationEventType, targetComponent.GetName(), strings.Join(expectedEventTypes, ","))
 	}
 
+	t.(*transformation.Transformation).SetLabel(transformation.TransformationContextLabel, transformationContexts(targetLabel, eventTypesFilter))
+
 	log.Println("Updating manifest")
 	restart, err := o.Manifest.Add(t)
 	if err != nil {
@@ -291,3 +321,15 @@ func (o *CliOptions) lookupTarget(ctx context.Context, target string) (triggerme
 	}
 	return targetObject, nil
 }
+
+func transformationContexts(target string, sourceEventTypes []string) string {
+	contexts := []string{}
+	for _, et := range sourceEventTypes {
+		c := et
+		if target != "" {
+			c = fmt.Sprintf("%s-%s", et, target)
+		}
+		contexts = append(contexts, c)
+	}
+	return strings.Join(contexts, ",")
+}

LICENSES/vendor/github.com/mattn/go-runewidth/LICENSE

@@ -3,7 +3,7 @@
 Create TriggerMesh transformation. More information at https://docs.triggermesh.io/transformation/jsontransformation/
 
 ```
-tmctl create transformation [--target <name>][--source <name>...][--eventTypes <type>...][--from <path>] [flags]
+tmctl create transformation [--target <name>][--source <name>...][--eventTypes <type>...][--from <path>][--wizard] [flags]
 ```
 
 ### Examples
@@ -27,6 +27,7 @@ EOF
       --name string          Transformation name
       --source strings       Sources component names
       --target string        Target name
+      --wizard               Experimental transformation wizard
 ```
 
 ### Options inherited from parent commands

LICENSES/vendor/github.com/nsf/termbox-go/LICENSE

@@ -14,6 +14,7 @@ require (
 	github.com/cloudevents/sdk-go/v2 v2.13.0
 	github.com/docker/docker v23.0.6+incompatible
 	github.com/docker/go-connections v0.4.0
+	github.com/jroimartin/gocui v0.5.0
 	github.com/spf13/cobra v1.7.0
 	github.com/stretchr/testify v1.8.2
 	github.com/triggermesh/brokers v1.2.1
@@ -31,6 +32,8 @@ require (
 require (
 	github.com/google/go-querystring v1.1.0 // indirect
 	github.com/grpc-ecosystem/grpc-gateway/v2 v2.11.3 // indirect
+	github.com/mattn/go-runewidth v0.0.9 // indirect
+	github.com/nsf/termbox-go v1.1.1 // indirect
 )
 
 replace k8s.io/client-go => k8s.io/client-go v0.25.3
@@ -44,7 +47,7 @@ require (
 	contrib.go.opencensus.io/exporter/ocagent v0.7.1-0.20200907061046-05415f1de66d // indirect
 	contrib.go.opencensus.io/exporter/prometheus v0.4.0 // indirect
 	contrib.go.opencensus.io/exporter/zipkin v0.1.2 // indirect
-	github.com/Azure/azure-sdk-for-go/sdk/azcore v1.3.0 // indirect
+	github.com/Azure/azure-sdk-for-go/sdk/azcore v1.4.0 // indirect
 	github.com/Azure/go-autorest v14.2.0+incompatible // indirect
 	github.com/Azure/go-autorest/autorest/adal v0.9.22 // indirect
 	github.com/Azure/go-autorest/autorest/azure/cli v0.4.5 // indirect

cmd/create/transformation.go

@@ -82,8 +82,8 @@ github.com/Antonboom/errname v0.1.5/go.mod h1:DugbBstvPFQbv/5uLcRRzfrNqKE9tVdVCq
 github.com/Antonboom/nilnil v0.1.0/go.mod h1:PhHLvRPSghY5Y7mX4TW+BHZQYo1A8flE5H20D3IPZBo=
 github.com/Azure/azure-sdk-for-go v68.0.0+incompatible h1:fcYLmCpyNYRnvJbPerq7U0hS+6+I79yEDJBqVNcqUzU=
 github.com/Azure/azure-sdk-for-go v68.0.0+incompatible/go.mod h1:9XXNKU+eRnpl9moKnB4QOLf1HestfXbmab5FXxiDBjc=
-github.com/Azure/azure-sdk-for-go/sdk/azcore v1.3.0 h1:VuHAcMq8pU1IWNT/m5yRaGqbK0BiQKHT8X4DTp9CHdI=
-github.com/Azure/azure-sdk-for-go/sdk/azcore v1.3.0/go.mod h1:tZoQYdDZNOiIjdSn0dVWVfl0NEPGOJqVLzSrcFk4Is0=
+github.com/Azure/azure-sdk-for-go/sdk/azcore v1.4.0 h1:rTnT/Jrcm+figWlYz4Ixzt0SJVR2cMC8lvZcimipiEY=
+github.com/Azure/azure-sdk-for-go/sdk/azcore v1.4.0/go.mod h1:ON4tFdPTwRcgWEaVDrN3584Ef+b7GgSJaXxe5fW9t4M=
 github.com/Azure/go-ansiterm v0.0.0-20210608223527-2377c96fe795/go.mod h1:LmzpDX56iTiv29bbRTIsUNlaFfuhWRQBWjQdVyAevI8=
 github.com/Azure/go-ansiterm v0.0.0-20210617225240-d185dfc1b5a1 h1:UQHMgLO+TxOElx5B5HZ4hJQsoJ/PvUvKRhJHDQXO8P8=
 github.com/Azure/go-ansiterm v0.0.0-20210617225240-d185dfc1b5a1/go.mod h1:xomTg63KZ2rFqZQzSB4Vz2SUXa1BpHTVz9L5PTmPC4E=
@@ -636,6 +636,8 @@ github.com/josharian/intern v1.0.0 h1:vlS4z54oSdjm0bgjRigI+G1HpF+tI+9rE5LLzOg8Hm
 github.com/josharian/intern v1.0.0/go.mod h1:5DoeVV0s6jJacbCEi61lwdGj/aVlrQvzHFFd8Hwg//Y=
 github.com/josharian/txtarfs v0.0.0-20210218200122-0702f000015a/go.mod h1:izVPOvVRsHiKkeGCT6tYBNWyDVuzj9wAaBb5R9qamfw=
 github.com/jpillora/backoff v1.0.0/go.mod h1:J/6gKK9jxlEcS3zixgDgUAsiuZ7yrSoa/FX5e0EB2j4=
+github.com/jroimartin/gocui v0.5.0 h1:DCZc97zY9dMnHXJSJLLmx9VqiEnAj0yh0eTNpuEtG/4=
+github.com/jroimartin/gocui v0.5.0/go.mod h1:l7Hz8DoYoL6NoYnlnaX6XCNR62G7J5FfSW5jEogzaxE=
 github.com/json-iterator/go v1.1.6/go.mod h1:+SdeFBvtyEkXs7REEP0seUULqWtbJapLOCVDaaPEHmU=
 github.com/json-iterator/go v1.1.7/go.mod h1:KdQUCv79m/52Kvf8AW2vK1V8akMuk1QjK/uOdHXbAo4=
 github.com/json-iterator/go v1.1.10/go.mod h1:KdQUCv79m/52Kvf8AW2vK1V8akMuk1QjK/uOdHXbAo4=
@@ -719,6 +721,7 @@ github.com/mattn/go-isatty v0.0.16 h1:bq3VjFmv/sOjHtdEhmkEV4x1AJtvUvOJ2PFAZ5+peK
 github.com/mattn/go-runewidth v0.0.2/go.mod h1:LwmH8dsx7+W8Uxz3IHJYH5QSwggIsqBzpuz5H//U1FU=
 github.com/mattn/go-runewidth v0.0.4/go.mod h1:LwmH8dsx7+W8Uxz3IHJYH5QSwggIsqBzpuz5H//U1FU=
 github.com/mattn/go-runewidth v0.0.6/go.mod h1:H031xJmbD/WCDINGzjvQ9THkh0rPKHF+m2gUSrubnMI=
+github.com/mattn/go-runewidth v0.0.9 h1:Lm995f3rfxdpd6TSmuVCHVb/QhupuXlYr8sCI/QdE+0=
 github.com/mattn/go-runewidth v0.0.9/go.mod h1:H031xJmbD/WCDINGzjvQ9THkh0rPKHF+m2gUSrubnMI=
 github.com/mattn/go-sqlite3 v1.9.0/go.mod h1:FPy6KqzDD04eiIsT53CuJW3U88zkxoIYsOqkbpncsNc=
 github.com/mattn/goveralls v0.0.2/go.mod h1:8d1ZMHsd7fW6IRPKQh46F2WRpyib5/X4FOpevwGNQEw=
@@ -783,6 +786,8 @@ github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e/go.mod h1:zD1mROLA
 github.com/nishanths/exhaustive v0.2.3/go.mod h1:bhIX678Nx8inLM9PbpvK1yv6oGtoP8BfaIeMzgBNKvc=
 github.com/nishanths/predeclared v0.0.0-20190419143655-18a43bb90ffc/go.mod h1:62PewwiQTlm/7Rj+cxVYqZvDIUc+JjZq6GHAC1fsObQ=
 github.com/nishanths/predeclared v0.2.1/go.mod h1:HvkGJcA3naj4lOwnFXFDkFxVtSqQMB9sbB1usJ+xjQE=
+github.com/nsf/termbox-go v1.1.1 h1:nksUPLCb73Q++DwbYUBEglYBRPZyoXJdrj5L+TkjyZY=
+github.com/nsf/termbox-go v1.1.1/go.mod h1:T0cTdVuOwf7pHQNtfhnEbzHbcNyCEcVU4YPpouCbVxo=
 github.com/nxadm/tail v1.4.4/go.mod h1:kenIhsEOeOJmVchQTgglprH7qJGnHDVpk1VPCcaMI8A=
 github.com/nxadm/tail v1.4.8/go.mod h1:+ncqLTQzXmGhMZNUePPaPqPvBxHAIsmXswZKocGu+AU=
 github.com/oklog/ulid v1.3.1/go.mod h1:CirwcVhetQ6Lv90oh/F+FBtV6XMibvdAFo93nm5qn4U=

docs/tmctl_create_transformation.md

@@ -48,6 +48,8 @@ const (
 	// Broker config polling period. On Windows only.
 	defaultConfigPollingPeriod = "PT2S"
 
+	defaultSchemaRegistryURL = "https://registry.staging.triggermesh.io"
+
 	// TriggerMesh DockerHub Registry
 	DockerRegistry = "triggermesh"
 )
@@ -57,9 +59,10 @@ type Config struct {
 	ConfigHome string `yaml:"-"`
 
 	// Persisted attributes
-	Context     string   `yaml:"context"`
-	Triggermesh TmConfig `yaml:"triggermesh"`
-	Docker      Docker   `yaml:"docker"`
+	Context        string   `yaml:"context"`
+	SchemaRegistry string   `yaml:"schemaRegistry"`
+	Triggermesh    TmConfig `yaml:"triggermesh"`
+	Docker         Docker   `yaml:"docker"`
 }
 
 type Docker struct {

go.mod

@@ -23,6 +23,7 @@ type configOverride func(*Config) bool
 var overrides = []configOverride{
 	brokerImageReplacement(),
 	dockerTimeoutAppend(),
+	schemaRegistryAppend(),
 }
 
 func (c *Config) applyOverrides() error {
@@ -69,3 +70,13 @@ func dockerTimeoutAppend() configOverride {
 		return true
 	}
 }
+
+func schemaRegistryAppend() configOverride {
+	return func(c *Config) bool {
+		if c.SchemaRegistry != "" {
+			return false
+		}
+		c.SchemaRegistry = defaultSchemaRegistryURL
+		return true
+	}
+}