update based on github action

cmd/client/commandv2/config.go

@@ -27,6 +27,7 @@ import (
  "github.com/spf13/cobra"
 )
 
+// ConfigCmd defines config command.
 func ConfigCmd() *cobra.Command {
  cmd := &cobra.Command{
  Use: "config",

cmd/client/commandv2/describe.go

@@ -84,7 +84,7 @@ func describeCmdArgs(cmd *cobra.Command, args []string) (err error) {
  return fmt.Errorf("no resource specified")
  }
  if len(args) == 1 {
- if general.InApiResource(args[0], resources.CustomData()) {
+ if general.InAPIResource(args[0], resources.CustomData()) {
  return fmt.Errorf("no custom data kind specified")
  }
  return nil
@@ -95,7 +95,7 @@ func describeCmdArgs(cmd *cobra.Command, args []string) (err error) {
  if len(args) == 2 {
  return nil
  }
- if len(args) == 3 && general.InApiResource(args[0], resources.CustomData()) {
+ if len(args) == 3 && general.InAPIResource(args[0], resources.CustomData()) {
  return nil
  }
  return fmt.Errorf("invalid args")

cmd/client/commandv2/general.go

@@ -113,6 +113,7 @@ func APIsCmd() *cobra.Command {
  return cmd
 }
 
+// APIResourcesCmd returns api-resources command.
 func APIResourcesCmd() *cobra.Command {
  cd := resources.CustomData()
  cdk := resources.CustomDataKind()

cmd/client/commandv2/get.go

@@ -125,7 +125,7 @@ func getCmdArgs(cmd *cobra.Command, args []string) (err error) {
  return fmt.Errorf("no resource specified")
  }
  if len(args) == 1 {
- if general.InApiResource(args[0], resources.CustomData()) {
+ if general.InAPIResource(args[0], resources.CustomData()) {
  return fmt.Errorf("no custom data kind specified")
  }
  return nil
@@ -136,7 +136,7 @@ func getCmdArgs(cmd *cobra.Command, args []string) (err error) {
  if len(args) == 2 {
  return nil
  }
- if len(args) == 3 && general.InApiResource(args[0], resources.CustomData()) {
+ if len(args) == 3 && general.InAPIResource(args[0], resources.CustomData()) {
  return nil
  }
  return fmt.Errorf("invalid args")

cmd/client/general/config.go

@@ -256,15 +256,15 @@ func GetConfig() (*Config, error) {
 
 // GetRedactedConfig returns the config with sensitive data redacted.
 func GetRedactedConfig(c *Config) *Config {
- copy := *c
+ config := *c
  redacted, _ := base64.StdEncoding.DecodeString(string("REDACTED"))
- copy.Clusters = Map(copy.Clusters, func(c NamedCluster) NamedCluster {
+ config.Clusters = Map(config.Clusters, func(c NamedCluster) NamedCluster {
  if len(c.Cluster.CertificateAuthorityData) > 0 {
  c.Cluster.CertificateAuthorityData = redacted
  }
  return c
  })
- copy.AuthInfos = Map(copy.AuthInfos, func(u NamedAuthInfo) NamedAuthInfo {
+ config.AuthInfos = Map(config.AuthInfos, func(u NamedAuthInfo) NamedAuthInfo {
  if len(u.AuthInfo.ClientCertificateData) > 0 {
  u.AuthInfo.ClientCertificateData = redacted
  }
@@ -276,7 +276,7 @@ func GetRedactedConfig(c *Config) *Config {
  }
  return u
  })
- return &copy
+ return &config
 }
 
 var globalCurrentConfig *CurrentConfig

cmd/client/general/message.go

@@ -23,10 +23,12 @@ import (
  "strings"
 )
 
+// SuccessMsg returns the success message.
 func SuccessMsg(action CmdType, values ...string) string {
  return fmt.Sprintf("%s %s successfully", action, strings.Join(values, " "))
 }
 
+// ErrorMsg returns the error message.
 func ErrorMsg(action CmdType, err error, values ...string) error {
  return fmt.Errorf("%s %s failed, %v", action, strings.Join(values, " "), err)
 }

cmd/client/general/print.go

@@ -152,7 +152,7 @@ func PrintMapInterface(maps []map[string]interface{}, fronts []string, backs []s
  }
  }
 
- print := func(spec map[string]interface{}) {
+ printFn := func(spec map[string]interface{}) {
  spec = func(s map[string]interface{}) map[string]interface{} {
  res := map[string]interface{}{}
  for k, v := range s {
@@ -212,7 +212,7 @@ func PrintMapInterface(maps []map[string]interface{}, fronts []string, backs []s
  }
 
  for i, m := range maps {
- print(m)
+ printFn(m)
  if len(maps) > 1 && i != len(maps)-1 {
  fmt.Print("\n\n---\n\n")
  }

cmd/client/general/request.go

@@ -33,6 +33,7 @@ import (
  "github.com/megaease/easegress/pkg/util/stringtool"
 )
 
+// MakeURL is used to make URL for given path.
 func MakeURL(path string) (string, error) {
  // server priority: flag > config > default
  server := defaultServer
@@ -63,6 +64,7 @@ func MakePath(urlTemplate string, a ...interface{}) string {
  return fmt.Sprintf(urlTemplate, a...)
 }
 
+// GetHTTPClient is used to get HTTP client.
 func GetHTTPClient() (*http.Client, error) {
  config, err := GetCurrentConfig()
  if err != nil {
@@ -116,6 +118,7 @@ func GetHTTPClient() (*http.Client, error) {
  return client, nil
 }
 
+// SuccessfulStatusCode returns true if the status code is successful.
 func SuccessfulStatusCode(code int) bool {
  return code >= 200 && code < 300
 }
@@ -188,24 +191,29 @@ func doRequest(httpMethod string, url string, jsonBody []byte, client *http.Clie
  return resp, body, nil
 }
 
+// ArgInfo is used to store the information of arguments.
 type ArgInfo struct {
  Resource string
  Name string
  Other string
 }
 
+// ContainResource returns true if the arguments contain resource.
 func (a *ArgInfo) ContainResource() bool {
  return a.Resource != ""
 }
 
+// ContainName returns true if the arguments contain name.
 func (a *ArgInfo) ContainName() bool {
  return a.Name != ""
 }
 
+// ContainOther returns true if the arguments contain other.
 func (a *ArgInfo) ContainOther() bool {
  return a.Other != ""
 }
 
+// ParseArgs parses the arguments and returns the ArgInfo.
 func ParseArgs(args []string) *ArgInfo {
  if len(args) == 0 {
  return nil
@@ -221,6 +229,7 @@ func ParseArgs(args []string) *ArgInfo {
  return argInfo
 }
 
-func InApiResource(arg string, r *api.ApiResource) bool {
+// InAPIResource returns true if the arg is in the api resource.
+func InAPIResource(arg string, r *api.ApiResource) bool {
  return arg == r.Name || arg == r.Kind || stringtool.StrInSlice(arg, r.Aliases)
 }

cmd/client/general/type.go

@@ -22,17 +22,27 @@ package general
 type CmdType string
 
 const (
- GetCmd CmdType = "get"
- CreateCmd CmdType = "create"
- ApplyCmd CmdType = "apply"
- DeleteCmd CmdType = "delete"
+ // GetCmd is the get command.
+ GetCmd CmdType = "get"
+ // CreateCmd is the create command.
+ CreateCmd CmdType = "create"
+ // ApplyCmd is the apply command.
+ ApplyCmd CmdType = "apply"
+ // DeleteCmd is the delete command.
+ DeleteCmd CmdType = "delete"
+ // DescribeCmd is the describe command.
  DescribeCmd CmdType = "describe"
- StartCmd CmdType = "start"
- StopCmd CmdType = "stop"
+ // StartCmd is the start command.
+ StartCmd CmdType = "start"
+ // StopCmd is the stop command.
+ StopCmd CmdType = "stop"
 )
 
 const (
- JSONFormat string = "json"
- YamlFormat string = "yaml"
+ // JSONFormat is the json format.
+ JSONFormat string = "json"
+ // YamlFormat is the yaml format.
+ YamlFormat string = "yaml"
+ // DefaultFormat is the default format.
  DefaultFormat string = "default"
 )

cmd/client/general/visitor.go

@@ -66,6 +66,7 @@ func (v *yamlVisitor) Close() {
  }
 }
 
+// Spec is the spec of a resource
 type Spec struct {
  Kind string
  Name string
@@ -124,6 +125,7 @@ func (v *specVisitor) Close() {
  v.v.Close()
 }
 
+// BuildYAMLVisitor builds a YAMLVisitor
 func BuildYAMLVisitor(yamlFile string, cmd *cobra.Command) YAMLVisitor {
  var r io.ReadCloser
  if yamlFile == "" {
@@ -136,6 +138,7 @@ func BuildYAMLVisitor(yamlFile string, cmd *cobra.Command) YAMLVisitor {
  return &yamlVisitor{reader: r}
 }
 
+// BuildSpecVisitor builds a SpecVisitor
 func BuildSpecVisitor(yamlFile string, cmd *cobra.Command) SpecVisitor {
  v := BuildYAMLVisitor(yamlFile, cmd)
  return &specVisitor{v: v}

cmd/client/resources/resources.go

@@ -24,22 +24,22 @@
  "github.com/megaease/easegress/cmd/client/general"
 )
 
 func GetResourceKind(arg string) (string, error) {
- if general.InApiResource(arg, CustomData()) {
+ if general.InAPIResource(arg, CustomData()) {
  return CustomData().Kind, nil
  }
- if general.InApiResource(arg, CustomDataKind()) {
+ if general.InAPIResource(arg, CustomDataKind()) {
  return CustomDataKind().Kind, nil
  }
- if general.InApiResource(arg, Member()) {
+ if general.InAPIResource(arg, Member()) {
  return Member().Kind, nil
  }
  objects, err := ObjectApiResources()
  if err != nil {
  return "", err
  }
  for _, object := range objects {
- if general.InApiResource(arg, object) {
+ if general.InAPIResource(arg, object) {
  return object.Kind, nil
  }
  }

doc/egctl-cheat-sheet.md

@@ -62,26 +62,26 @@ kind: Config
 # current used context.
 current-context: context-default
 
-# `contexts` section contains `user` and `cluster` information, which informs egctl about which `user` should be used to access a specific `cluster`.
+# "contexts" section contains "user" and "cluster" information, which informs egctl about which "user" should be used to access a specific "cluster".
 contexts:
  - context:
  cluster: cluster-default
  user: user-default
  name: context-default
 
-# `clusters` section contains information about the `cluster`.
-# `server` specifies the host address that egctl should access.
-# `certificate-authority` or `certificate-authority-data` contain the root certificate authority that the client uses to verify server certificates.
+# "clusters" section contains information about the "cluster".
+# "server" specifies the host address that egctl should access.
+# "certificate-authority" or "certificate-authority-data" contain the root certificate authority that the client uses to verify server certificates.
 clusters:
  - cluster:
  server: localhost:2381
- certificate-authority: "/tmp/certs/ca.crt"
- certificate-authority-data: "xxxx" # base64
+ certificate-authority: "/tmp/certs/ca.crt" 
+ certificate-authority-data: "xxxx"
  name: cluster-default
 
-# `users` section contains `user` information.
-# `username` and `password` are used for basic authentication.
-# either the pair (`client-key`, `client-certificate`) or the pair (`client-key-data`, `client-certificate-data`) contains the client certificate
+# "users" section contains "user" information.
+# "username" and "password" are used for basic authentication.
+# either the pair ("client-key", "client-certificate") or the pair ("client-key-data", "client-certificate-data") contains the client certificate.
 users:
  - name: user-default
  user: