blob: 6092d8c1bca1a54b8c23b02fe5cd7731b845cbfd [file] [log] [blame]
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 commands
import (
"errors"
"fmt"
"github.com/apache/incubator-openwhisk-cli/wski18n"
"github.com/apache/incubator-openwhisk-client-go/whisk"
"github.com/fatih/color"
"github.com/spf13/cobra"
)
// ruleCmd represents the rule command
var ruleCmd = &cobra.Command{
Use: "rule",
Short: wski18n.T("work with rules"),
}
var ruleEnableCmd = &cobra.Command{
Use: "enable RULE_NAME",
Short: wski18n.T("enable rule"),
SilenceUsage: true,
SilenceErrors: true,
PreRunE: SetupClientConfig,
RunE: func(cmd *cobra.Command, args []string) error {
var err error
var qualifiedName = new(QualifiedName)
if whiskErr := CheckArgs(args, 1, 1, "Rule enable", wski18n.T("A rule name is required.")); whiskErr != nil {
return whiskErr
}
if qualifiedName, err = NewQualifiedName(args[0]); err != nil {
return NewQualifiedNameError(args[0], err)
}
Client.Namespace = qualifiedName.GetNamespace()
ruleName := qualifiedName.GetEntityName()
_, _, err = Client.Rules.SetState(ruleName, "active")
if err != nil {
whisk.Debug(whisk.DbgError, "Client.Rules.SetState(%s, active) failed: %s\n", ruleName, err)
errStr := wski18n.T("Unable to enable rule '{{.name}}': {{.err}}",
map[string]interface{}{"name": ruleName, "err": err})
werr := whisk.MakeWskErrorFromWskError(errors.New(errStr), err, whisk.EXIT_CODE_ERR_GENERAL, whisk.DISPLAY_MSG, whisk.NO_DISPLAY_USAGE)
return werr
}
fmt.Fprintf(color.Output,
wski18n.T("{{.ok}} enabled rule {{.name}}\n",
map[string]interface{}{"ok": color.GreenString("ok:"), "name": boldString(ruleName)}))
return nil
},
}
var ruleDisableCmd = &cobra.Command{
Use: "disable RULE_NAME",
Short: wski18n.T("disable rule"),
SilenceUsage: true,
SilenceErrors: true,
PreRunE: SetupClientConfig,
RunE: func(cmd *cobra.Command, args []string) error {
var err error
var qualifiedName = new(QualifiedName)
if whiskErr := CheckArgs(args, 1, 1, "Rule disable", wski18n.T("A rule name is required.")); whiskErr != nil {
return whiskErr
}
if qualifiedName, err = NewQualifiedName(args[0]); err != nil {
return NewQualifiedNameError(args[0], err)
}
Client.Namespace = qualifiedName.GetNamespace()
ruleName := qualifiedName.GetEntityName()
_, _, err = Client.Rules.SetState(ruleName, "inactive")
if err != nil {
whisk.Debug(whisk.DbgError, "Client.Rules.SetState(%s, inactive) failed: %s\n", ruleName, err)
errStr := wski18n.T("Unable to disable rule '{{.name}}': {{.err}}",
map[string]interface{}{"name": ruleName, "err": err})
werr := whisk.MakeWskErrorFromWskError(errors.New(errStr), err, whisk.EXIT_CODE_ERR_GENERAL, whisk.DISPLAY_MSG, whisk.NO_DISPLAY_USAGE)
return werr
}
fmt.Fprintf(color.Output,
wski18n.T("{{.ok}} disabled rule {{.name}}\n",
map[string]interface{}{"ok": color.GreenString("ok:"), "name": boldString(ruleName)}))
return nil
},
}
var ruleStatusCmd = &cobra.Command{
Use: "status RULE_NAME",
Short: wski18n.T("get rule status"),
SilenceUsage: true,
SilenceErrors: true,
PreRunE: SetupClientConfig,
RunE: func(cmd *cobra.Command, args []string) error {
var err error
var qualifiedName = new(QualifiedName)
if whiskErr := CheckArgs(args, 1, 1, "Rule status", wski18n.T("A rule name is required.")); whiskErr != nil {
return whiskErr
}
if qualifiedName, err = NewQualifiedName(args[0]); err != nil {
return NewQualifiedNameError(args[0], err)
}
Client.Namespace = qualifiedName.GetNamespace()
ruleName := qualifiedName.GetEntityName()
rule, _, err := Client.Rules.Get(ruleName)
if err != nil {
whisk.Debug(whisk.DbgError, "Client.Rules.Get(%s) failed: %s\n", ruleName, err)
errStr := wski18n.T("Unable to get status of rule '{{.name}}': {{.err}}",
map[string]interface{}{"name": ruleName, "err": err})
werr := whisk.MakeWskErrorFromWskError(errors.New(errStr), err, whisk.EXIT_CODE_ERR_GENERAL, whisk.DISPLAY_MSG, whisk.DISPLAY_USAGE)
return werr
}
fmt.Fprintf(color.Output,
wski18n.T("{{.ok}} rule {{.name}} is {{.status}}\n",
map[string]interface{}{"ok": color.GreenString("ok:"), "name": boldString(ruleName), "status": boldString(rule.Status)}))
return nil
},
}
var ruleCreateCmd = &cobra.Command{
Use: "create RULE_NAME TRIGGER_NAME ACTION_NAME",
Short: wski18n.T("create new rule"),
SilenceUsage: true,
SilenceErrors: true,
PreRunE: SetupClientConfig,
RunE: func(cmd *cobra.Command, args []string) error {
var err error
var qualifiedName = new(QualifiedName)
if whiskErr := CheckArgs(args, 3, 3, "Rule create",
wski18n.T("A rule, trigger and action name are required.")); whiskErr != nil {
return whiskErr
}
if qualifiedName, err = NewQualifiedName(args[0]); err != nil {
return NewQualifiedNameError(args[0], err)
}
Client.Namespace = qualifiedName.GetNamespace()
ruleName := qualifiedName.GetEntityName()
triggerName := getQualifiedName(args[1], Properties.Namespace)
actionName := getQualifiedName(args[2], Properties.Namespace)
rule := &whisk.Rule{
Name: ruleName,
Trigger: triggerName,
Action: actionName,
}
whisk.Debug(whisk.DbgInfo, "Inserting rule:\n%+v\n", rule)
var retRule *whisk.Rule
retRule, _, err = Client.Rules.Insert(rule, false)
if err != nil {
whisk.Debug(whisk.DbgError, "Client.Rules.Insert(%#v) failed: %s\n", rule, err)
errStr := wski18n.T("Unable to create rule '{{.name}}': {{.err}}",
map[string]interface{}{"name": ruleName, "err": err})
werr := whisk.MakeWskErrorFromWskError(errors.New(errStr), err, whisk.EXIT_CODE_ERR_GENERAL, whisk.DISPLAY_MSG, whisk.NO_DISPLAY_USAGE)
return werr
}
whisk.Debug(whisk.DbgInfo, "Inserted rule:\n%+v\n", retRule)
fmt.Fprintf(color.Output,
wski18n.T("{{.ok}} created rule {{.name}}\n",
map[string]interface{}{"ok": color.GreenString("ok:"), "name": boldString(ruleName)}))
return nil
},
}
var ruleUpdateCmd = &cobra.Command{
Use: "update RULE_NAME TRIGGER_NAME ACTION_NAME",
Short: wski18n.T("update an existing rule, or create a rule if it does not exist"),
SilenceUsage: true,
SilenceErrors: true,
PreRunE: SetupClientConfig,
RunE: func(cmd *cobra.Command, args []string) error {
var err error
var qualifiedName = new(QualifiedName)
if whiskErr := CheckArgs(args, 3, 3, "Rule update",
wski18n.T("A rule, trigger and action name are required.")); whiskErr != nil {
return whiskErr
}
if qualifiedName, err = NewQualifiedName(args[0]); err != nil {
return NewQualifiedNameError(args[0], err)
}
Client.Namespace = qualifiedName.GetNamespace()
ruleName := qualifiedName.GetEntityName()
triggerName := getQualifiedName(args[1], Properties.Namespace)
actionName := getQualifiedName(args[2], Properties.Namespace)
rule := &whisk.Rule{
Name: ruleName,
Trigger: triggerName,
Action: actionName,
}
_, _, err = Client.Rules.Insert(rule, true)
if err != nil {
whisk.Debug(whisk.DbgError, "Client.Rules.Insert(%#v) failed: %s\n", rule, err)
errStr := wski18n.T("Unable to update rule '{{.name}}': {{.err}}",
map[string]interface{}{"name": rule.Name, "err": err})
werr := whisk.MakeWskErrorFromWskError(errors.New(errStr), err, whisk.EXIT_CODE_ERR_GENERAL, whisk.DISPLAY_MSG, whisk.NO_DISPLAY_USAGE)
return werr
}
fmt.Fprintf(color.Output,
wski18n.T("{{.ok}} updated rule {{.name}}\n",
map[string]interface{}{"ok": color.GreenString("ok:"), "name": boldString(ruleName)}))
return nil
},
}
var ruleGetCmd = &cobra.Command{
Use: "get RULE_NAME",
Short: wski18n.T("get rule"),
SilenceUsage: true,
SilenceErrors: true,
PreRunE: SetupClientConfig,
RunE: func(cmd *cobra.Command, args []string) error {
var err error
var field string
var qualifiedName = new(QualifiedName)
if whiskErr := CheckArgs(args, 1, 2, "Rule get", wski18n.T("A rule name is required.")); whiskErr != nil {
return whiskErr
}
if len(args) > 1 {
field = args[1]
if !fieldExists(&whisk.Rule{}, field) {
errMsg := wski18n.T("Invalid field filter '{{.arg}}'.", map[string]interface{}{"arg": field})
whiskErr := whisk.MakeWskError(errors.New(errMsg), whisk.EXIT_CODE_ERR_GENERAL,
whisk.DISPLAY_MSG, whisk.NO_DISPLAY_USAGE)
return whiskErr
}
}
if qualifiedName, err = NewQualifiedName(args[0]); err != nil {
return NewQualifiedNameError(args[0], err)
}
Client.Namespace = qualifiedName.GetNamespace()
ruleName := qualifiedName.GetEntityName()
rule, _, err := Client.Rules.Get(ruleName)
if err != nil {
whisk.Debug(whisk.DbgError, "Client.Rules.Get(%s) failed: %s\n", ruleName, err)
errStr := wski18n.T("Unable to get rule '{{.name}}': {{.err}}",
map[string]interface{}{"name": ruleName, "err": err})
werr := whisk.MakeWskErrorFromWskError(errors.New(errStr), err, whisk.EXIT_CODE_ERR_GENERAL, whisk.DISPLAY_MSG, whisk.DISPLAY_USAGE)
return werr
}
if Flags.rule.summary {
printRuleSummary(rule)
} else {
if len(field) > 0 {
fmt.Fprintf(color.Output, wski18n.T("{{.ok}} got rule {{.name}}, displaying field {{.field}}\n",
map[string]interface{}{"ok": color.GreenString("ok:"), "name": boldString(ruleName),
"field": field}))
printField(rule, field)
} else {
fmt.Fprintf(color.Output, wski18n.T("{{.ok}} got rule {{.name}}\n",
map[string]interface{}{"ok": color.GreenString("ok:"), "name": boldString(ruleName)}))
printJSON(rule)
}
}
return nil
},
}
var ruleDeleteCmd = &cobra.Command{
Use: "delete RULE_NAME",
Short: wski18n.T("delete rule"),
SilenceUsage: true,
SilenceErrors: true,
PreRunE: SetupClientConfig,
RunE: func(cmd *cobra.Command, args []string) error {
var err error
var qualifiedName = new(QualifiedName)
if whiskErr := CheckArgs(args, 1, 1, "Rule delete", wski18n.T("A rule name is required.")); whiskErr != nil {
return whiskErr
}
if qualifiedName, err = NewQualifiedName(args[0]); err != nil {
return NewQualifiedNameError(args[0], err)
}
Client.Namespace = qualifiedName.GetNamespace()
ruleName := qualifiedName.GetEntityName()
if Flags.rule.disable {
_, _, err := Client.Rules.SetState(ruleName, "inactive")
if err != nil {
whisk.Debug(whisk.DbgError, "Client.Rules.SetState(%s, inactive) failed: %s\n", ruleName, err)
errStr := wski18n.T("Unable to disable rule '{{.name}}': {{.err}}",
map[string]interface{}{"name": ruleName, "err": err})
werr := whisk.MakeWskErrorFromWskError(errors.New(errStr), err, whisk.EXIT_CODE_ERR_GENERAL, whisk.DISPLAY_MSG, whisk.NO_DISPLAY_USAGE)
return werr
}
}
_, err = Client.Rules.Delete(ruleName)
if err != nil {
whisk.Debug(whisk.DbgError, "Client.Rules.Delete(%s) error: %s\n", ruleName, err)
errStr := wski18n.T("Unable to delete rule '{{.name}}': {{.err}}",
map[string]interface{}{"name": ruleName, "err": err})
werr := whisk.MakeWskErrorFromWskError(errors.New(errStr), err, whisk.EXIT_CODE_ERR_GENERAL, whisk.DISPLAY_MSG, whisk.NO_DISPLAY_USAGE)
return werr
}
fmt.Fprintf(color.Output,
wski18n.T("{{.ok}} deleted rule {{.name}}\n",
map[string]interface{}{"ok": color.GreenString("ok:"), "name": boldString(ruleName)}))
return nil
},
}
var ruleListCmd = &cobra.Command{
Use: "list [NAMESPACE]",
Short: wski18n.T("list all rules"),
SilenceUsage: true,
SilenceErrors: true,
PreRunE: SetupClientConfig,
RunE: func(cmd *cobra.Command, args []string) error {
var err error
var qualifiedName = new(QualifiedName)
if whiskErr := CheckArgs(args, 0, 1, "Rule list",
wski18n.T("An optional namespace is the only valid argument.")); whiskErr != nil {
return whiskErr
}
if len(args) == 1 {
if qualifiedName, err = NewQualifiedName(args[0]); err != nil {
return NewQualifiedNameError(args[0], err)
}
if len(qualifiedName.GetEntityName()) > 0 {
return entityNameError(qualifiedName.GetEntityName())
}
Client.Namespace = qualifiedName.GetNamespace()
}
ruleListOptions := &whisk.RuleListOptions{
Skip: Flags.common.skip,
Limit: Flags.common.limit,
}
rules, _, err := Client.Rules.List(ruleListOptions)
if err != nil {
whisk.Debug(whisk.DbgError, "Client.Rules.List(%#v) error: %s\n", ruleListOptions, err)
errStr := wski18n.T("Unable to obtain the list of rules for namespace '{{.name}}': {{.err}}",
map[string]interface{}{"name": getClientNamespace(), "err": err})
werr := whisk.MakeWskErrorFromWskError(errors.New(errStr), err, whisk.EXIT_CODE_ERR_GENERAL, whisk.DISPLAY_MSG, whisk.NO_DISPLAY_USAGE)
return werr
} else {
//No errors, lets attempt to retrieve the status of each rule #312
for index, rule := range rules {
ruleStatus, _, err := Client.Rules.Get(rule.Name)
if err != nil {
errStr := wski18n.T("Unable to get status of rule '{{.name}}': {{.err}}",
map[string]interface{}{"name": rule.Name, "err": err})
fmt.Println(errStr)
werr := whisk.MakeWskErrorFromWskError(errors.New(errStr), err, whisk.EXIT_CODE_ERR_GENERAL, whisk.DISPLAY_MSG, whisk.NO_DISPLAY_USAGE)
return werr
}
rules[index].Status = ruleStatus.Status
}
}
sortByName := Flags.common.nameSort
printList(rules, sortByName)
return nil
},
}
func init() {
ruleDeleteCmd.Flags().BoolVar(&Flags.rule.disable, "disable", false, wski18n.T("automatically disable rule before deleting it"))
ruleGetCmd.Flags().BoolVarP(&Flags.rule.summary, "summary", "s", false, wski18n.T("summarize rule details"))
ruleListCmd.Flags().IntVarP(&Flags.common.skip, "skip", "s", 0, wski18n.T("exclude the first `SKIP` number of rules from the result"))
ruleListCmd.Flags().IntVarP(&Flags.common.limit, "limit", "l", 30, wski18n.T("only return `LIMIT` number of rules from the collection"))
ruleListCmd.Flags().BoolVarP(&Flags.common.nameSort, "name-sort", "n", false, wski18n.T("sorts a list alphabetically by entity name; only applicable within the limit/skip returned entity block"))
ruleCmd.AddCommand(
ruleCreateCmd,
ruleEnableCmd,
ruleDisableCmd,
ruleStatusCmd,
ruleUpdateCmd,
ruleGetCmd,
ruleDeleteCmd,
ruleListCmd,
)
}