Refactor HTTP trigger command (#1367)

pkg/fission-cli/cmd/httptrigger/create.go

@@ -0,0 +1,220 @@
+/*
+Copyright 2019 The Fission 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.
+*/
+
+package httptrigger
+
+import (
+	"fmt"
+	"github.com/pkg/errors"
+	"net/http"
+	"strings"
+
+	"github.com/satori/go.uuid"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
+	fv1 "github.com/fission/fission/pkg/apis/fission.io/v1"
+	"github.com/fission/fission/pkg/controller/client"
+	ferror "github.com/fission/fission/pkg/error"
+	"github.com/fission/fission/pkg/fission-cli/cliwrapper/cli"
+	"github.com/fission/fission/pkg/fission-cli/cmd"
+	"github.com/fission/fission/pkg/fission-cli/cmd/spec"
+	"github.com/fission/fission/pkg/fission-cli/log"
+	"github.com/fission/fission/pkg/fission-cli/util"
+)
+
+type CreateSubCommand struct {
+	client  *client.Client
+	trigger *fv1.HTTPTrigger
+}
+
+func Create(flags cli.Input) error {
+	opts := CreateSubCommand{
+		client: cmd.GetServer(flags),
+	}
+	return opts.do(flags)
+}
+
+func (opts *CreateSubCommand) do(flags cli.Input) error {
+	err := opts.complete(flags)
+	if err != nil {
+		return err
+	}
+	return opts.run(flags)
+}
+
+// complete creates a environment objects and populates it with default value and CLI inputs.
+func (opts *CreateSubCommand) complete(flags cli.Input) error {
+	functionList := flags.StringSlice("function")
+	functionWeightsList := flags.IntSlice("weight")
+
+	if len(functionList) == 0 {
+		return errors.New("need a function name to create a trigger, use --function")
+	}
+
+	functionRef, err := setHtFunctionRef(functionList, functionWeightsList)
+	if err != nil {
+		return err
+	}
+
+	triggerName := flags.String("name")
+	fnNamespace := flags.String("fnNamespace")
+
+	m := &metav1.ObjectMeta{
+		Name:      triggerName,
+		Namespace: fnNamespace,
+	}
+
+	htTrigger, err := opts.client.HTTPTriggerGet(m)
+	if err != nil && !ferror.IsNotFound(err) {
+		return err
+	}
+	if htTrigger != nil {
+		return errors.New("duplicate trigger exists, choose a different name or leave it empty for fission to auto-generate it")
+	}
+
+	triggerUrl := flags.String("url")
+	if len(triggerUrl) == 0 {
+		return errors.New("need a trigger URL, use --url")
+	}
+	if !strings.HasPrefix(triggerUrl, "/") {
+		triggerUrl = fmt.Sprintf("/%s", triggerUrl)
+	}
+
+	method, err := GetMethod(flags.String("method"))
+	if err != nil {
+		return err
+	}
+
+	// For Specs, the spec validate checks for function reference
+	if !flags.Bool("spec") {
+		err = util.CheckFunctionExistence(opts.client, functionList, fnNamespace)
+		if err != nil {
+			log.Warn(err.Error())
+		}
+	}
+
+	createIngress := flags.Bool("createingress")
+	ingressConfig, err := GetIngressConfig(
+		flags.StringSlice("ingressannotation"), flags.String("ingressrule"),
+		flags.String("ingresstls"), triggerUrl, nil)
+	if err != nil {
+		return errors.Wrap(err, "error parsing ingress configuration")
+	}
+
+	host := flags.String("host")
+	if flags.IsSet("host") {
+		log.Warn(fmt.Sprintf("--host is now marked as deprecated, see 'help' for details"))
+	}
+
+	// just name triggers by uuid.
+	if triggerName == "" {
+		triggerName = uuid.NewV4().String()
+	}
+
+	opts.trigger = &fv1.HTTPTrigger{
+		Metadata: metav1.ObjectMeta{
+			Name:      triggerName,
+			Namespace: fnNamespace,
+		},
+		Spec: fv1.HTTPTriggerSpec{
+			Host:              host,
+			RelativeURL:       triggerUrl,
+			Method:            method,
+			FunctionReference: *functionRef,
+			CreateIngress:     createIngress,
+			IngressConfig:     *ingressConfig,
+		},
+	}
+
+	return nil
+}
+
+func (opts *CreateSubCommand) run(flags cli.Input) error {
+	// if we're writing a spec, don't call the API
+	if flags.Bool("spec") {
+		specFile := fmt.Sprintf("route-%v.yaml", opts.trigger.Metadata.Name)
+		err := spec.SpecSave(*opts.trigger, specFile)
+		if err != nil {
+			return errors.Wrap(err, "error creating HTTP trigger spec")
+		}
+		return nil
+	}
+
+	_, err := opts.client.HTTPTriggerCreate(opts.trigger)
+	if err != nil {
+		return errors.Wrap(err, "create HTTP trigger")
+	}
+
+	fmt.Printf("trigger '%v' created\n", opts.trigger.Metadata.Name)
+
+	return nil
+}
+
+// GetMethod returns one of HTTP method
+func GetMethod(method string) (string, error) {
+	switch strings.ToUpper(method) {
+	case "GET":
+		return http.MethodGet, nil
+	case "HEAD":
+		return http.MethodHead, nil
+	case "POST":
+		return http.MethodPost, nil
+	case "PUT":
+		return http.MethodPut, nil
+	case "PATCH":
+		return http.MethodPatch, nil
+	case "DELETE":
+		return http.MethodDelete, nil
+	case "CONNECT":
+		return http.MethodConnect, nil
+	case "OPTIONS":
+		return http.MethodOptions, nil
+	case "TRACE":
+		return http.MethodTrace, nil
+	default:
+		return "", fmt.Errorf("invalid or unsupported HTTP Method %v", method)
+	}
+}
+
+func setHtFunctionRef(functionList []string, functionWeightsList []int) (*fv1.FunctionReference, error) {
+	if len(functionList) == 1 {
+		return &fv1.FunctionReference{
+			Type: fv1.FunctionReferenceTypeFunctionName,
+			Name: functionList[0],
+		}, nil
+	} else if len(functionList) == 2 {
+		if len(functionWeightsList) != 2 {
+			return nil, fmt.Errorf("weights of the function need to be specified when 2 functions are supplied")
+		}
+
+		totalWeight := functionWeightsList[0] + functionWeightsList[1]
+		if totalWeight != 100 {
+			return nil, errors.New("the function weights should add up to 100")
+		}
+
+		functionWeights := make(map[string]int)
+		for index := range functionList {
+			functionWeights[functionList[index]] = functionWeightsList[index]
+		}
+
+		return &fv1.FunctionReference{
+			Type:            fv1.FunctionReferenceTypeFunctionWeights,
+			FunctionWeights: functionWeights,
+		}, nil
+	}
+
+	return nil, fmt.Errorf("the number of functions in a trigger can be 1 or 2(for canary feature along with their weights)")
+}

pkg/fission-cli/cmd/httptrigger/delete.go

@@ -0,0 +1,104 @@
+/*
+Copyright 2019 The Fission 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.
+*/
+
+package httptrigger
+
+import (
+	"fmt"
+
+	"github.com/hashicorp/go-multierror"
+	"github.com/pkg/errors"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
+	"github.com/fission/fission/pkg/controller/client"
+	"github.com/fission/fission/pkg/fission-cli/cliwrapper/cli"
+	"github.com/fission/fission/pkg/fission-cli/cmd"
+)
+
+type DeleteSubCommand struct {
+	client       *client.Client
+	triggerName  string
+	functionName string
+	namespace    string
+}
+
+func Delete(flags cli.Input) error {
+	opts := DeleteSubCommand{
+		client: cmd.GetServer(flags),
+	}
+	return opts.do(flags)
+}
+
+func (opts *DeleteSubCommand) do(flags cli.Input) error {
+	err := opts.complete(flags)
+	if err != nil {
+		return err
+	}
+	return opts.run(flags)
+}
+
+// complete creates a environment objects and populates it with default value and CLI inputs.
+func (opts *DeleteSubCommand) complete(flags cli.Input) error {
+	opts.triggerName = flags.String("name")
+	opts.functionName = flags.String("function")
+	if len(opts.triggerName) == 0 && len(opts.functionName) == 0 {
+		return errors.New("need --name or --function")
+	} else if len(opts.triggerName) > 0 && len(opts.functionName) > 0 {
+		return errors.New("need either of --name or --function and not both arguments")
+	}
+	opts.namespace = flags.String("triggerNamespace")
+	return nil
+}
+
+func (opts *DeleteSubCommand) run(flags cli.Input) error {
+	triggers, err := opts.client.HTTPTriggerList(opts.namespace)
+	if err != nil {
+		return errors.Wrap(err, "error getting HTTP trigger list")
+	}
+
+	var triggersToDelete []string
+
+	if len(opts.functionName) > 0 {
+		for _, trigger := range triggers {
+			// TODO: delete canary http triggers as well.
+			if trigger.Spec.FunctionReference.Name == opts.functionName {
+				triggersToDelete = append(triggersToDelete, trigger.Metadata.Name)
+			}
+		}
+	} else {
+		triggersToDelete = []string{opts.triggerName}
+	}
+
+	errs := &multierror.Error{}
+
+	for _, name := range triggersToDelete {
+		err := opts.client.HTTPTriggerDelete(&metav1.ObjectMeta{
+			Name:      name,
+			Namespace: opts.namespace,
+		})
+		if err != nil {
+			errs = multierror.Append(errs, err)
+		} else {
+			fmt.Printf("trigger '%v' deleted\n", name)
+		}
+	}
+
+	if errs.ErrorOrNil() != nil {
+		return errors.Wrap(errs.ErrorOrNil(), "error deleting trigger(s)")
+	}
+
+	return nil
+}

pkg/fission-cli/cmd/httptrigger/get.go

@@ -0,0 +1,113 @@
+/*
+Copyright 2019 The Fission 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.
+*/
+
+package httptrigger
+
+import (
+	"fmt"
+	"os"
+	"strings"
+	"text/tabwriter"
+
+	"github.com/pkg/errors"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
+	fv1 "github.com/fission/fission/pkg/apis/fission.io/v1"
+	"github.com/fission/fission/pkg/controller/client"
+	"github.com/fission/fission/pkg/fission-cli/cliwrapper/cli"
+	"github.com/fission/fission/pkg/fission-cli/cmd"
+)
+
+type GetSubCommand struct {
+	client    *client.Client
+	trigger   string
+	namespace string
+}
+
+func Get(flags cli.Input) error {
+	opts := GetSubCommand{
+		client: cmd.GetServer(flags),
+	}
+	return opts.do(flags)
+}
+
+func (opts *GetSubCommand) do(flags cli.Input) error {
+	err := opts.complete(flags)
+	if err != nil {
+		return err
+	}
+	return opts.run(flags)
+}
+
+// complete creates a environment objects and populates it with default value and CLI inputs.
+func (opts *GetSubCommand) complete(flags cli.Input) error {
+	opts.trigger = flags.String("name")
+	opts.namespace = flags.String("fnNamespace")
+
+	if len(opts.trigger) <= 0 {
+		return errors.New("need a trigger name, use --name")
+	}
+	return nil
+}
+
+func (opts *GetSubCommand) run(flags cli.Input) error {
+	m := &metav1.ObjectMeta{
+		Name:      opts.trigger,
+		Namespace: opts.namespace,
+	}
+	ht, err := opts.client.HTTPTriggerGet(m)
+	if err != nil {
+		return errors.Wrap(err, "error getting http trigger")
+	}
+
+	printHtSummary([]fv1.HTTPTrigger{*ht})
+
+	return nil
+}
+
+func printHtSummary(triggers []fv1.HTTPTrigger) {
+	w := tabwriter.NewWriter(os.Stdout, 0, 0, 1, ' ', 0)
+	fmt.Fprintf(w, "%v\t%v\t%v\t%v\t%v\t%v\t%v\t%v\t%v\n", "NAME", "METHOD", "URL", "FUNCTION(s)", "INGRESS", "HOST", "PATH", "TLS", "ANNOTATIONS")
+	for _, trigger := range triggers {
+		function := ""
+		if trigger.Spec.FunctionReference.Type == fv1.FunctionReferenceTypeFunctionName {
+			function = trigger.Spec.FunctionReference.Name
+		} else {
+			for k, v := range trigger.Spec.FunctionReference.FunctionWeights {
+				function += fmt.Sprintf("%s:%v ", k, v)
+			}
+		}
+
+		host := trigger.Spec.Host
+		if len(trigger.Spec.IngressConfig.Host) > 0 {
+			host = trigger.Spec.IngressConfig.Host
+		}
+		path := trigger.Spec.RelativeURL
+		if len(trigger.Spec.IngressConfig.Path) > 0 {
+			path = trigger.Spec.IngressConfig.Path
+		}
+
+		var msg []string
+		for k, v := range trigger.Spec.IngressConfig.Annotations {
+			msg = append(msg, fmt.Sprintf("%v: %v", k, v))
+		}
+		ann := strings.Join(msg, ", ")
+
+		fmt.Fprintf(w, "%v\t%v\t%v\t%v\t%v\t%v\t%v\t%v\t%v\n",
+			trigger.Metadata.Name, trigger.Spec.Method, trigger.Spec.RelativeURL, function, trigger.Spec.CreateIngress, host, path, trigger.Spec.IngressConfig.TLS, ann)
+	}
+	w.Flush()
+}

pkg/fission-cli/cmd/httptrigger/list.go

@@ -0,0 +1,74 @@
+/*
+Copyright 2019 The Fission 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.
+*/
+
+package httptrigger
+
+import (
+	"github.com/pkg/errors"
+
+	fv1 "github.com/fission/fission/pkg/apis/fission.io/v1"
+	"github.com/fission/fission/pkg/controller/client"
+	"github.com/fission/fission/pkg/fission-cli/cliwrapper/cli"
+	"github.com/fission/fission/pkg/fission-cli/cmd"
+)
+
+type ListSubCommand struct {
+	client             *client.Client
+	triggerNamespace   string
+	filterFunctionName string
+}
+
+func List(flags cli.Input) error {
+	opts := ListSubCommand{
+		client: cmd.GetServer(flags),
+	}
+	return opts.do(flags)
+}
+
+func (opts *ListSubCommand) do(flags cli.Input) error {
+	err := opts.complete(flags)
+	if err != nil {
+		return err
+	}
+	return opts.run(flags)
+}
+
+// complete creates a environment objects and populates it with default value and CLI inputs.
+func (opts *ListSubCommand) complete(flags cli.Input) error {
+	opts.triggerNamespace = flags.String("triggerNamespace")
+	opts.filterFunctionName = flags.String("function")
+	return nil
+}
+
+func (opts *ListSubCommand) run(flags cli.Input) error {
+	hts, err := opts.client.HTTPTriggerList(opts.triggerNamespace)
+	if err != nil {
+		return errors.Wrap(err, "error listing HTTP triggers")
+	}
+
+	var triggers []fv1.HTTPTrigger
+	for _, ht := range hts {
+		// TODO: list canary http triggers as well.
+		if len(opts.filterFunctionName) == 0 ||
+			(len(opts.filterFunctionName) > 0 && opts.filterFunctionName == ht.Spec.FunctionReference.Name) {
+
+			triggers = append(triggers, ht)
+		}
+	}
+
+	printHtSummary(triggers)
+	return nil
+}

pkg/fission-cli/cmd/httptrigger/update.go

@@ -0,0 +1,122 @@
+/*
+Copyright 2019 The Fission 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.
+*/
+
+package httptrigger
+
+import (
+	"fmt"
+
+	"github.com/pkg/errors"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
+	fv1 "github.com/fission/fission/pkg/apis/fission.io/v1"
+	"github.com/fission/fission/pkg/controller/client"
+	"github.com/fission/fission/pkg/fission-cli/cliwrapper/cli"
+	"github.com/fission/fission/pkg/fission-cli/cmd"
+	"github.com/fission/fission/pkg/fission-cli/log"
+	"github.com/fission/fission/pkg/fission-cli/util"
+)
+
+type UpdateSubCommand struct {
+	client  *client.Client
+	trigger *fv1.HTTPTrigger
+}
+
+func Update(flags cli.Input) error {
+	opts := UpdateSubCommand{
+		client: cmd.GetServer(flags),
+	}
+	return opts.do(flags)
+}
+
+func (opts *UpdateSubCommand) do(flags cli.Input) error {
+	err := opts.complete(flags)
+	if err != nil {
+		return err
+	}
+	return opts.run(flags)
+}
+
+// complete creates a environment objects and populates it with default value and CLI inputs.
+func (opts *UpdateSubCommand) complete(flags cli.Input) error {
+	htName := flags.String("name")
+	if len(htName) == 0 {
+		return errors.New("need name of trigger, use --name")
+	}
+	triggerNamespace := flags.String("triggerNamespace")
+
+	ht, err := opts.client.HTTPTriggerGet(&metav1.ObjectMeta{
+		Name:      htName,
+		Namespace: triggerNamespace,
+	})
+	if err != nil {
+		return errors.Wrap(err, "error getting HTTP trigger")
+	}
+
+	if flags.IsSet("function") {
+		// get the functions and their weights if specified
+		functionList := flags.StringSlice("function")
+		err := util.CheckFunctionExistence(opts.client, functionList, triggerNamespace)
+		if err != nil {
+			log.Warn(err.Error())
+		}
+
+		var functionWeightsList []int
+		if flags.IsSet("weight") {
+			functionWeightsList = flags.IntSlice("weight")
+		}
+
+		// set function reference
+		functionRef, err := setHtFunctionRef(functionList, functionWeightsList)
+		if err != nil {
+			return errors.Wrap(err, "error setting function weight")
+		}
+
+		ht.Spec.FunctionReference = *functionRef
+	}
+
+	if flags.IsSet("createingress") {
+		ht.Spec.CreateIngress = flags.Bool("createingress")
+	}
+
+	if flags.IsSet("host") {
+		ht.Spec.Host = flags.String("host")
+		log.Warn(fmt.Sprintf("--host is now marked as deprecated, see 'help' for details"))
+	}
+
+	if flags.IsSet("ingressrule") || flags.IsSet("ingressannotation") || flags.IsSet("ingresstls") {
+		ingress, err := GetIngressConfig(
+			flags.StringSlice("ingressannotation"), flags.String("ingressrule"),
+			flags.String("ingresstls"), ht.Spec.RelativeURL, &ht.Spec.IngressConfig)
+		if err != nil {
+			return errors.Wrap(err, "parse ingress configuration")
+		}
+		ht.Spec.IngressConfig = *ingress
+	}
+
+	opts.trigger = ht
+
+	return nil
+}
+
+func (opts *UpdateSubCommand) run(flags cli.Input) error {
+	_, err := opts.client.HTTPTriggerUpdate(opts.trigger)
+	if err != nil {
+		return errors.Wrap(err, "error updating the HTTP trigger")
+	}
+	fmt.Printf("trigger '%v' updated\n", opts.trigger.Metadata.Name)
+	return nil
+}