Remove cli module from pkg module (#212)

Author: kezhenxu94

.golangci.yml

@@ -46,6 +46,13 @@ linters-settings:
   whitespace:
     multi-if: false
     multi-func: false
+  depguard:
+    rules:
+      prevent_cli_in_pkg:
+        files: ["**/pkg/**/*.go"]
+        deny:
+          - pkg: "github.com/urfave/cli/v2"
+            desc: "github.com/urfave/cli/v2 is not allowed in pkg module"
 
 linters:
   enable:
@@ -74,8 +81,4 @@ linters:
     - unparam
     - unused
     - whitespace
-
-service:
-  golangci-lint-version: 1.20.x
-  prepare:
-    - echo "here I can run custom commands, but no preparation needed for this repo"
+    - depguard

Makefile

@@ -55,7 +55,7 @@ build: $(BUILDS)
 
 .PHONY: deps
 deps:
-	@$(GO_GET) -v -t -d ./...
+	@$(GO_GET) -v -t ./...
 
 $(GO_LINT):
 	@$(GO_LINT) version > /dev/null 2>&1 || go install github.com/golangci/golangci-lint/cmd/[email protected]

cmd/swctl/main.go

@@ -44,15 +44,18 @@ import (
 	"github.com/apache/skywalking-cli/internal/commands/service"
 	"github.com/apache/skywalking-cli/internal/commands/trace"
 	"github.com/apache/skywalking-cli/internal/logger"
+	intutil "github.com/apache/skywalking-cli/internal/util"
 	"github.com/apache/skywalking-cli/pkg/util"
 
 	"github.com/sirupsen/logrus"
 	"github.com/urfave/cli/v2"
 	"github.com/urfave/cli/v2/altsrc"
 )
 
-var log *logrus.Logger
-var version string // Will be initialized when building
+var (
+	log     *logrus.Logger
+	version string // Will be initialized when building
+)
 
 func init() {
 	log = logger.Log
@@ -119,7 +122,7 @@ services, service instances, etc.`
 	)
 
 	app.Flags = flags
-	app.CommandNotFound = util.CommandNotFound
+	app.CommandNotFound = intutil.CommandNotFound
 
 	// Enable auto-completion.
 	app.EnableBashCompletion = true

internal/commands/alarm/autopleteKeys.go

@@ -57,11 +57,12 @@ $ swctl alarm autocomplete-keys
 			Step:  step.(*model.StepEnumValue).Selected,
 		}
 
-		autocompleteKeys, err := alarm.TagAutocompleteKeys(ctx, duration)
+		autocompleteKeys, err := alarm.TagAutocompleteKeys(ctx.Context, duration)
 		if err != nil {
 			return err
 		}
 
-		return display.Display(ctx, &displayable.Displayable{Data: autocompleteKeys, Condition: duration})
+		ctx.Lineage()
+		return display.Display(ctx.Context, &displayable.Displayable{Data: autocompleteKeys, Condition: duration})
 	},
 }

internal/commands/alarm/autopleteValues.go

@@ -66,11 +66,11 @@ $ swctl alarm autocomplete-values --key=tagKey
 			Step:  step.(*model.StepEnumValue).Selected,
 		}
 
-		autocompleteValues, err := alarm.TagAutocompleteValues(ctx, duration, tagKey)
+		autocompleteValues, err := alarm.TagAutocompleteValues(ctx.Context, duration, tagKey)
 		if err != nil {
 			return err
 		}
 
-		return display.Display(ctx, &displayable.Displayable{Data: autocompleteValues, Condition: tagKey})
+		return display.Display(ctx.Context, &displayable.Displayable{Data: autocompleteValues, Condition: tagKey})
 	},
 }

internal/commands/alarm/list.go

@@ -89,8 +89,8 @@ $ swctl alarm list
 
 		var tags []*api.AlarmTag
 		if tagStr != "" {
-			tagArr := strings.Split(tagStr, ",")
-			for _, tag := range tagArr {
+			tagArr := strings.SplitSeq(tagStr, ",")
+			for tag := range tagArr {
 				kv := strings.SplitN(tag, "=", 2)
 				if len(kv) != 2 {
 					return fmt.Errorf("invalid tag, cannot be splitted into 2 parts. %s", tag)
@@ -112,11 +112,11 @@ $ swctl alarm list
 			Tags:     tags,
 			Paging:   &paging,
 		}
-		alarms, err := alarm.Alarms(ctx, condition)
+		alarms, err := alarm.Alarms(ctx.Context, condition)
 		if err != nil {
 			return err
 		}
 
-		return display.Display(ctx, &displayable.Displayable{Data: alarms, Condition: condition})
+		return display.Display(ctx.Context, &displayable.Displayable{Data: alarms, Condition: condition})
 	},
 }

internal/commands/browser/logs/list.go

@@ -80,11 +80,11 @@ $ swctl browser logs list`,
 			Paging:           &paging,
 		}
 
-		logs, err := log.BrowserLogs(ctx, condition)
+		logs, err := log.BrowserLogs(ctx.Context, condition)
 		if err != nil {
 			return err
 		}
 
-		return display.Display(ctx, &displayable.Displayable{Data: logs, Condition: condition})
+		return display.Display(ctx.Context, &displayable.Displayable{Data: logs, Condition: condition})
 	},
 }

internal/commands/browser/page/list.go

@@ -58,12 +58,11 @@ $ swctl browser page ls --service-id dGVzdC11aQ==.1`,
 		serviceID := ctx.String("service-id")
 		limit := ctx.Int("limit")
 
-		endpoints, err := metadata.SearchEndpoints(ctx, serviceID, "", limit, nil)
-
+		endpoints, err := metadata.SearchEndpoints(ctx.Context, serviceID, "", limit, nil)
 		if err != nil {
 			return err
 		}
 
-		return display.Display(ctx, &displayable.Displayable{Data: endpoints})
+		return display.Display(ctx.Context, &displayable.Displayable{Data: endpoints})
 	},
 }

internal/commands/browser/service/list.go

@@ -56,7 +56,7 @@ $ swctl browser svc ls test-ui`,
 		var err error
 
 		if args := ctx.Args(); args.Len() == 0 {
-			services, err = metadata.AllBrowserServices(ctx, api.Duration{
+			services, err = metadata.AllBrowserServices(ctx.Context, api.Duration{
 				Start: start,
 				End:   end,
 				Step:  step.(*model.StepEnumValue).Selected,
@@ -65,13 +65,13 @@ $ swctl browser svc ls test-ui`,
 				return err
 			}
 		} else {
-			service, err := metadata.SearchBrowserService(ctx, args.First())
+			service, err := metadata.SearchBrowserService(ctx.Context, args.First())
 			if err != nil {
 				return err
 			}
 			services = []api.Service{service}
 		}
 
-		return display.Display(ctx, &displayable.Displayable{Data: services})
+		return display.Display(ctx.Context, &displayable.Displayable{Data: services})
 	},
 }

internal/commands/browser/version/list.go

@@ -56,16 +56,15 @@ $ swctl browser version ls --service-id dGVzdC11aQ==.1`,
 		step := ctx.Generic("step")
 		serviceID := ctx.String("service-id")
 
-		instances, err := metadata.Instances(ctx, serviceID, api.Duration{
+		instances, err := metadata.Instances(ctx.Context, serviceID, api.Duration{
 			Start: start,
 			End:   end,
 			Step:  step.(*model.StepEnumValue).Selected,
 		})
-
 		if err != nil {
 			return err
 		}
 
-		return display.Display(ctx, &displayable.Displayable{Data: instances})
+		return display.Display(ctx.Context, &displayable.Displayable{Data: instances})
 	},
 }