fix(int)!: fix int types and update to urfave v3 (#632)

* fix(int): fix int types

* chore(urfave cli): bump to v3

* converting some of the flags

* more v3

* more changes to v3

* chore(deps): update server to current main

* point to latest sdk-go

* make clean

---------

Co-authored-by: TimHuynh <[email protected]>
Co-authored-by: Kelly Merrick <[email protected]>

Author: 3 people

cmd/vela-worker/flags.go

@@ -3,9 +3,12 @@
 package main
 
 import (
+	"context"
+	"fmt"
+	"strings"
 	"time"
 
-	"github.com/urfave/cli/v2"
+	"github.com/urfave/cli/v3"
 
 	"github.com/go-vela/server/queue"
 	"github.com/go-vela/worker/executor"
@@ -19,43 +22,56 @@ func flags() []cli.Flag {
 	f := []cli.Flag{
 
 		&cli.StringFlag{
-			EnvVars: []string{"WORKER_ADDR", "VELA_WORKER_ADDR", "VELA_WORKER"},
 			Name:    "worker.addr",
 			Usage:   "Worker server address as a fully qualified url (<scheme>://<host>)",
+			Sources: cli.EnvVars("WORKER_ADDR", "VELA_WORKER_ADDR", "VELA_WORKER"),
+			Action: func(_ context.Context, _ *cli.Command, v string) error {
+				// check if the worker address has a scheme
+				if !strings.Contains(v, "://") {
+					return fmt.Errorf("worker address must be fully qualified (<scheme>://<host>)")
+				}
+
+				// check if the worker address has a trailing slash
+				if strings.HasSuffix(v, "/") {
+					return fmt.Errorf("worker address must not have trailing slash")
+				}
+
+				return nil
+			},
 		},
 
 		&cli.DurationFlag{
-			EnvVars: []string{"WORKER_CHECK_IN", "VELA_CHECK_IN", "CHECK_IN"},
 			Name:    "checkIn",
 			Usage:   "time to wait in between checking in with the server",
+			Sources: cli.EnvVars("WORKER_CHECK_IN", "VELA_CHECK_IN", "CHECK_IN"),
 			Value:   15 * time.Minute,
 		},
 
 		// Build Flags
 
 		&cli.IntFlag{
-			EnvVars: []string{"WORKER_BUILD_LIMIT", "VELA_BUILD_LIMIT", "BUILD_LIMIT"},
 			Name:    "build.limit",
 			Usage:   "maximum amount of builds that can run concurrently",
+			Sources: cli.EnvVars("WORKER_BUILD_LIMIT", "VELA_BUILD_LIMIT", "BUILD_LIMIT"),
 			Value:   1,
 		},
 		&cli.DurationFlag{
-			EnvVars: []string{"WORKER_BUILD_TIMEOUT", "VELA_BUILD_TIMEOUT", "BUILD_TIMEOUT"},
 			Name:    "build.timeout",
 			Usage:   "maximum amount of time a build can run for",
+			Sources: cli.EnvVars("WORKER_BUILD_TIMEOUT", "VELA_BUILD_TIMEOUT", "BUILD_TIMEOUT"),
 			Value:   30 * time.Minute,
 		},
 
 		// Logger Flags
 
 		&cli.StringFlag{
-			EnvVars: []string{"WORKER_LOG_FORMAT", "VELA_LOG_FORMAT", "LOG_FORMAT"},
 			Name:    "log.format",
 			Usage:   "set log format for the worker",
+			Sources: cli.EnvVars("WORKER_LOG_FORMAT", "VELA_LOG_FORMAT", "LOG_FORMAT"),
 			Value:   "json",
 		},
 		&cli.StringFlag{
-			EnvVars: []string{"WORKER_LOG_LEVEL", "VELA_LOG_LEVEL", "LOG_LEVEL"},
+			Sources: cli.EnvVars("WORKER_LOG_LEVEL", "VELA_LOG_LEVEL", "LOG_LEVEL"),
 			Name:    "log.level",
 			Usage:   "set log level for the worker",
 			Value:   "info",
@@ -64,30 +80,30 @@ func flags() []cli.Flag {
 		// Server Flags
 
 		&cli.StringFlag{
-			EnvVars: []string{"WORKER_SERVER_ADDR", "VELA_SERVER_ADDR", "VELA_SERVER", "SERVER_ADDR"},
 			Name:    "server.addr",
 			Usage:   "Vela server address as a fully qualified url (<scheme>://<host>)",
+			Sources: cli.EnvVars("WORKER_SERVER_ADDR", "VELA_SERVER_ADDR", "VELA_SERVER", "SERVER_ADDR"),
 		},
 		&cli.StringFlag{
-			EnvVars: []string{"WORKER_SERVER_SECRET", "VELA_SERVER_SECRET", "SERVER_SECRET"},
 			Name:    "server.secret",
 			Usage:   "secret used for server <-> worker communication",
+			Sources: cli.EnvVars("WORKER_SERVER_SECRET", "VELA_SERVER_SECRET", "SERVER_SECRET"),
 			Value:   "",
 		},
 		&cli.StringFlag{
-			EnvVars: []string{"WORKER_SERVER_CERT", "VELA_SERVER_CERT", "SERVER_CERT"},
 			Name:    "server.cert",
 			Usage:   "optional TLS certificate for https",
+			Sources: cli.EnvVars("WORKER_SERVER_CERT", "VELA_SERVER_CERT", "SERVER_CERT"),
 		},
 		&cli.StringFlag{
-			EnvVars: []string{"WORKER_SERVER_CERT_KEY", "VELA_SERVER_CERT_KEY", "SERVER_CERT_KEY"},
 			Name:    "server.cert-key",
 			Usage:   "optional TLS certificate key",
+			Sources: cli.EnvVars("WORKER_SERVER_CERT_KEY", "VELA_SERVER_CERT_KEY", "SERVER_CERT_KEY"),
 		},
 		&cli.StringFlag{
-			EnvVars: []string{"WORKER_SERVER_TLS_MIN_VERSION", "VELA_SERVER_TLS_MIN_VERSION", "SERVER_TLS_MIN_VERSION"},
 			Name:    "server.tls-min-version",
 			Usage:   "optional TLS minimum version requirement",
+			Sources: cli.EnvVars("WORKER_SERVER_TLS_MIN_VERSION", "VELA_SERVER_TLS_MIN_VERSION", "SERVER_TLS_MIN_VERSION"),
 			Value:   "1.2",
 		},
 	}

cmd/vela-worker/main.go

@@ -3,13 +3,13 @@
 package main
 
 import (
+	"context"
 	"encoding/json"
 	"fmt"
 	"os"
-	"time"
 
 	"github.com/sirupsen/logrus"
-	"github.com/urfave/cli/v2"
+	"github.com/urfave/cli/v3"
 
 	_ "github.com/joho/godotenv/autoload"
 
@@ -45,35 +45,20 @@ func main() {
 	// output the version information to stdout
 	fmt.Fprintf(os.Stdout, "%s\n", string(bytes))
 
-	app := cli.NewApp()
-
-	// Worker Information
-
-	app.Name = "vela-worker"
-	app.HelpName = "vela-worker"
-	app.Usage = "Vela build daemon designed for executing pipelines"
-	app.Copyright = "Copyright 2019 Target Brands, Inc. All rights reserved."
-	app.Authors = []*cli.Author{
-		{
-			Name:  "Vela Admins",
-			Email: "[email protected]",
-		},
+	cmd := cli.Command{
+		Name:    "vela-worker",
+		Version: v.Semantic(),
+		Action:  run,
+		Usage:   "Vela build daemon designed for executing pipelines",
 	}
 
-	// Worker Metadata
-
-	app.Action = run
-	app.Compiled = time.Now()
-	app.Version = v.Semantic()
-
 	// Worker Flags
 
-	app.Flags = flags()
+	cmd.Flags = flags()
 
 	// Worker Start
 
-	err = app.Run(os.Args)
-	if err != nil {
+	if err = cmd.Run(context.Background(), os.Args); err != nil {
 		logrus.Fatal(err)
 	}
 }

cmd/vela-worker/operate.go

@@ -31,7 +31,7 @@ func (w *Worker) operate(ctx context.Context) error {
 	registryWorker.SetHostname(w.Config.API.Address.Hostname())
 	registryWorker.SetAddress(w.Config.API.Address.String())
 	registryWorker.SetActive(true)
-	registryWorker.SetBuildLimit(int64(w.Config.Build.Limit))
+	registryWorker.SetBuildLimit(int32(w.Config.Build.Limit))
 
 	// set routes from config if set or defaulted to `vela`
 	if (len(w.Config.Queue.Routes) > 0) && (w.Config.Queue.Routes[0] != "NONE" && w.Config.Queue.Routes[0] != "") {

cmd/vela-worker/run.go

@@ -3,12 +3,13 @@
 package main
 
 import (
+	"context"
 	"fmt"
 	"net/url"
 
 	"github.com/gin-gonic/gin"
 	"github.com/sirupsen/logrus"
-	"github.com/urfave/cli/v2"
+	"github.com/urfave/cli/v3"
 
 	_ "github.com/joho/godotenv/autoload"
 
@@ -22,7 +23,7 @@ import (
 
 // run executes the worker based
 // off the configuration provided.
-func run(c *cli.Context) error {
+func run(ctx context.Context, c *cli.Command) error {
 	// set log format for the worker
 	switch c.String("log.format") {
 	case "t", "text", "Text", "TEXT":
@@ -95,15 +96,15 @@ func run(c *cli.Context) error {
 			},
 			// build configuration
 			Build: &Build{
-				Limit:   c.Int("build.limit"),
+				Limit:   int(c.Int("build.limit")),
 				Timeout: c.Duration("build.timeout"),
 			},
 			// build configuration
 			CheckIn: c.Duration("checkIn"),
 			// executor configuration
 			Executor: &executor.Setup{
 				Driver:              c.String("executor.driver"),
-				MaxLogSize:          c.Uint("executor.max_log_size"),
+				MaxLogSize:          uint(c.Uint("executor.max_log_size")),
 				LogStreamingTimeout: c.Duration("executor.log_streaming_timeout"),
 				EnforceTrustedRepos: c.Bool("executor.enforce-trusted-repos"),
 				OutputCtn:           outputsCtn,
@@ -119,7 +120,7 @@ func run(c *cli.Context) error {
 				ConfigFile:       c.String("runtime.config"),
 				Namespace:        c.String("runtime.namespace"),
 				PodsTemplateName: c.String("runtime.pods-template-name"),
-				PodsTemplateFile: c.Path("runtime.pods-template-file"),
+				PodsTemplateFile: c.String("runtime.pods-template-file"),
 				HostVolumes:      c.StringSlice("runtime.volumes"),
 				PrivilegedImages: c.StringSlice("runtime.privileged-images"),
 				DropCapabilities: c.StringSlice("runtime.drop-capabilities"),

executor/executor_test.go

@@ -260,7 +260,7 @@ var (
 		Link:        vela.String("https://github.com/github/octocat"),
 		Clone:       vela.String("https://github.com/github/octocat.git"),
 		Branch:      vela.String("main"),
-		Timeout:     vela.Int64(60),
+		Timeout:     vela.Int32(60),
 		Visibility:  vela.String("public"),
 		Private:     vela.Bool(false),
 		Trusted:     vela.Bool(false),
@@ -271,9 +271,9 @@ var (
 
 	_build = &api.Build{
 		ID:           vela.Int64(1),
-		Number:       vela.Int(1),
+		Number:       vela.Int64(1),
 		Repo:         _repo,
-		Parent:       vela.Int(1),
+		Parent:       vela.Int64(1),
 		Event:        vela.String("push"),
 		Status:       vela.String("success"),
 		Error:        vela.String(""),

executor/flags.go

@@ -5,7 +5,7 @@ package executor
 import (
 	"time"
 
-	"github.com/urfave/cli/v2"
+	"github.com/urfave/cli/v3"
 
 	"github.com/go-vela/server/constants"
 )
@@ -18,35 +18,47 @@ var Flags = []cli.Flag{
 	// Executor Flags
 
 	&cli.StringFlag{
-		EnvVars:  []string{"VELA_EXECUTOR_DRIVER", "EXECUTOR_DRIVER"},
-		FilePath: "/vela/executor/driver",
-		Name:     "executor.driver",
-		Usage:    "driver to be used for the executor",
-		Value:    constants.DriverLinux,
+		Name:  "executor.driver",
+		Usage: "driver to be used for the executor",
+		Sources: cli.NewValueSourceChain(
+			cli.EnvVar("VELA_EXECUTOR_DRIVER"),
+			cli.EnvVar("EXECUTOR_DRIVER"),
+			cli.File("/vela/executor/driver"),
+		),
+		Value: constants.DriverLinux,
 	},
 	&cli.UintFlag{
-		EnvVars:  []string{"VELA_EXECUTOR_MAX_LOG_SIZE", "EXECUTOR_MAX_LOG_SIZE"},
-		FilePath: "/vela/executor/max_log_size",
-		Name:     "executor.max_log_size",
-		Usage:    "maximum log size (in bytes)",
+		Name:  "executor.max_log_size",
+		Usage: "maximum log size (in bytes)",
+		Sources: cli.NewValueSourceChain(
+			cli.EnvVar("VELA_EXECUTOR_MAX_LOG_SIZE"),
+			cli.EnvVar("EXECUTOR_MAX_LOG_SIZE"),
+			cli.File("/vela/executor/max_log_size"),
+		),
 	},
 	&cli.DurationFlag{
-		EnvVars: []string{"WORKER_LOG_STREAMING_TIMEOUT", "VELA_LOG_STREAMING_TIMEOUT", "LOG_STREAMING_TIMEOUT"},
 		Name:    "executor.log_streaming_timeout",
 		Usage:   "maximum amount of time to wait for log streaming after build completes",
+		Sources: cli.EnvVars("WORKER_LOG_STREAMING_TIMEOUT", "VELA_LOG_STREAMING_TIMEOUT", "LOG_STREAMING_TIMEOUT"),
 		Value:   5 * time.Minute,
 	},
 	&cli.BoolFlag{
-		EnvVars:  []string{"VELA_EXECUTOR_ENFORCE_TRUSTED_REPOS", "EXECUTOR_ENFORCE_TRUSTED_REPOS"},
-		FilePath: "/vela/executor/enforce_trusted_repos",
-		Name:     "executor.enforce-trusted-repos",
-		Usage:    "enforce trusted repo restrictions for privileged images",
-		Value:    true,
+		Name:  "executor.enforce-trusted-repos",
+		Usage: "enforce trusted repo restrictions for privileged images",
+		Sources: cli.NewValueSourceChain(
+			cli.EnvVar("VELA_EXECUTOR_ENFORCE_TRUSTED_REPOS"),
+			cli.EnvVar("EXECUTOR_ENFORCE_TRUSTED_REPOS"),
+			cli.File("/vela/executor/enforce_trusted_repos"),
+		),
+		Value: true,
 	},
 	&cli.StringFlag{
-		EnvVars:  []string{"VELA_EXECUTOR_OUTPUTS_IMAGE", "EXECUTOR_OUTPUTS_IMAGE"},
-		FilePath: "/vela/executor/outputs_image",
-		Name:     "executor.outputs-image",
-		Usage:    "image used for the outputs container sidecar",
+		Name:  "executor.outputs-image",
+		Usage: "image used for the outputs container sidecar",
+		Sources: cli.NewValueSourceChain(
+			cli.EnvVar("VELA_EXECUTOR_OUTPUTS_IMAGE"),
+			cli.EnvVar("EXECUTOR_OUTPUTS_IMAGE"),
+			cli.File("/vela/executor/outputs_image"),
+		),
 	},
 }

executor/linux/build.go

@@ -396,7 +396,7 @@ func (c *client) AssembleBuild(ctx context.Context) error {
 	}
 
 	// create outputs container with a timeout equal to the repo timeout
-	c.err = c.outputs.create(ctx, c.OutputCtn, (int64(60) * c.build.GetRepo().GetTimeout()))
+	c.err = c.outputs.create(ctx, c.OutputCtn, int64(60*c.build.GetRepo().GetTimeout()))
 	if c.err != nil {
 		return fmt.Errorf("unable to create outputs container: %w", c.err)
 	}