Follow convetion where context must be the first argument

internal/cli/arguments/completion.go

@@ -27,8 +27,8 @@ import (
 // GetInstalledBoards is an helper function useful to autocomplete.
 // It returns a list of fqbn
 // it's taken from cli/board/listall.go
-func GetInstalledBoards(srv rpc.ArduinoCoreServiceServer, ctx context.Context) []string {
-	inst := instance.CreateAndInit(srv, ctx)
+func GetInstalledBoards(ctx context.Context, srv rpc.ArduinoCoreServiceServer) []string {
+	inst := instance.CreateAndInit(ctx, srv)
 
 	list, _ := srv.BoardListAll(context.Background(), &rpc.BoardListAllRequest{
 		Instance:            inst,
@@ -45,8 +45,8 @@ func GetInstalledBoards(srv rpc.ArduinoCoreServiceServer, ctx context.Context) [
 
 // GetInstalledProgrammers is an helper function useful to autocomplete.
 // It returns a list of programmers available based on the installed boards
-func GetInstalledProgrammers(srv rpc.ArduinoCoreServiceServer, ctx context.Context) []string {
-	inst := instance.CreateAndInit(srv, ctx)
+func GetInstalledProgrammers(ctx context.Context, srv rpc.ArduinoCoreServiceServer) []string {
+	inst := instance.CreateAndInit(ctx, srv)
 
 	// we need the list of the available fqbn in order to get the list of the programmers
 	listAllReq := &rpc.BoardListAllRequest{
@@ -78,8 +78,8 @@ func GetInstalledProgrammers(srv rpc.ArduinoCoreServiceServer, ctx context.Conte
 
 // GetUninstallableCores is an helper function useful to autocomplete.
 // It returns a list of cores which can be uninstalled
-func GetUninstallableCores(srv rpc.ArduinoCoreServiceServer, ctx context.Context) []string {
-	inst := instance.CreateAndInit(srv, ctx)
+func GetUninstallableCores(ctx context.Context, srv rpc.ArduinoCoreServiceServer) []string {
+	inst := instance.CreateAndInit(ctx, srv)
 
 	platforms, _ := commands.PlatformSearch(&rpc.PlatformSearchRequest{
 		Instance:          inst,
@@ -99,8 +99,8 @@ func GetUninstallableCores(srv rpc.ArduinoCoreServiceServer, ctx context.Context
 
 // GetInstallableCores is an helper function useful to autocomplete.
 // It returns a list of cores which can be installed/downloaded
-func GetInstallableCores(srv rpc.ArduinoCoreServiceServer, ctx context.Context) []string {
-	inst := instance.CreateAndInit(srv, ctx)
+func GetInstallableCores(ctx context.Context, srv rpc.ArduinoCoreServiceServer) []string {
+	inst := instance.CreateAndInit(ctx, srv)
 
 	platforms, _ := commands.PlatformSearch(&rpc.PlatformSearchRequest{
 		Instance:   inst,
@@ -118,18 +118,18 @@ func GetInstallableCores(srv rpc.ArduinoCoreServiceServer, ctx context.Context)
 
 // GetInstalledLibraries is an helper function useful to autocomplete.
 // It returns a list of libs which are currently installed, including the builtin ones
-func GetInstalledLibraries(srv rpc.ArduinoCoreServiceServer, ctx context.Context) []string {
-	return getLibraries(srv, ctx, true)
+func GetInstalledLibraries(ctx context.Context, srv rpc.ArduinoCoreServiceServer) []string {
+	return getLibraries(ctx, srv, true)
 }
 
 // GetUninstallableLibraries is an helper function useful to autocomplete.
 // It returns a list of libs which can be uninstalled
-func GetUninstallableLibraries(srv rpc.ArduinoCoreServiceServer, ctx context.Context) []string {
-	return getLibraries(srv, ctx, false)
+func GetUninstallableLibraries(ctx context.Context, srv rpc.ArduinoCoreServiceServer) []string {
+	return getLibraries(ctx, srv, false)
 }
 
-func getLibraries(srv rpc.ArduinoCoreServiceServer, ctx context.Context, all bool) []string {
-	inst := instance.CreateAndInit(srv, ctx)
+func getLibraries(ctx context.Context, srv rpc.ArduinoCoreServiceServer, all bool) []string {
+	inst := instance.CreateAndInit(ctx, srv)
 	libs, _ := commands.LibraryList(context.Background(), &rpc.LibraryListRequest{
 		Instance:  inst,
 		All:       all,
@@ -147,8 +147,8 @@ func getLibraries(srv rpc.ArduinoCoreServiceServer, ctx context.Context, all boo
 
 // GetInstallableLibs is an helper function useful to autocomplete.
 // It returns a list of libs which can be installed/downloaded
-func GetInstallableLibs(srv rpc.ArduinoCoreServiceServer, ctx context.Context) []string {
-	inst := instance.CreateAndInit(srv, ctx)
+func GetInstallableLibs(ctx context.Context, srv rpc.ArduinoCoreServiceServer) []string {
+	inst := instance.CreateAndInit(ctx, srv)
 
 	libs, _ := commands.LibrarySearch(context.Background(), &rpc.LibrarySearchRequest{
 		Instance:   inst,
@@ -165,9 +165,9 @@ func GetInstallableLibs(srv rpc.ArduinoCoreServiceServer, ctx context.Context) [
 // GetAvailablePorts is an helper function useful to autocomplete.
 // It returns a list of upload port of the boards which are currently connected.
 // It will not suggests network ports because the timeout is not set.
-func GetAvailablePorts(srv rpc.ArduinoCoreServiceServer, ctx context.Context) []*rpc.Port {
+func GetAvailablePorts(ctx context.Context, srv rpc.ArduinoCoreServiceServer) []*rpc.Port {
 	// Get the port list
-	inst := instance.CreateAndInit(srv, ctx)
+	inst := instance.CreateAndInit(ctx, srv)
 	list, _ := srv.BoardList(ctx, &rpc.BoardListRequest{Instance: inst})
 
 	// Transform the data structure for the completion (DetectedPort -> Port)

internal/cli/arguments/fqbn.go

@@ -37,7 +37,7 @@ type Fqbn struct {
 func (f *Fqbn) AddToCommand(cmd *cobra.Command, srv rpc.ArduinoCoreServiceServer) {
 	cmd.Flags().StringVarP(&f.fqbn, "fqbn", "b", "", tr("Fully Qualified Board Name, e.g.: arduino:avr:uno"))
 	cmd.RegisterFlagCompletionFunc("fqbn", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
-		return GetInstalledBoards(srv, context.Background()), cobra.ShellCompDirectiveDefault
+		return GetInstalledBoards(context.Background(), srv), cobra.ShellCompDirectiveDefault
 	})
 	cmd.Flags().StringSliceVar(&f.boardOptions, "board-options", []string{},
 		tr("List of board options separated by commas. Or can be used multiple times for multiple options."))

internal/cli/arguments/port.go

@@ -42,11 +42,11 @@ type Port struct {
 func (p *Port) AddToCommand(cmd *cobra.Command, srv rpc.ArduinoCoreServiceServer) {
 	cmd.Flags().StringVarP(&p.address, "port", "p", "", tr("Upload port address, e.g.: COM3 or /dev/ttyACM2"))
 	cmd.RegisterFlagCompletionFunc("port", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
-		return f.Map(GetAvailablePorts(srv, context.Background()), (*rpc.Port).GetAddress), cobra.ShellCompDirectiveDefault
+		return f.Map(GetAvailablePorts(context.Background(), srv), (*rpc.Port).GetAddress), cobra.ShellCompDirectiveDefault
 	})
 	cmd.Flags().StringVarP(&p.protocol, "protocol", "l", "", tr("Upload port protocol, e.g: serial"))
 	cmd.RegisterFlagCompletionFunc("protocol", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
-		return f.Map(GetAvailablePorts(srv, context.Background()), (*rpc.Port).GetProtocol), cobra.ShellCompDirectiveDefault
+		return f.Map(GetAvailablePorts(context.Background(), srv), (*rpc.Port).GetProtocol), cobra.ShellCompDirectiveDefault
 	})
 	p.timeout.AddToCommand(cmd)
 }

internal/cli/arguments/programmer.go

@@ -33,7 +33,7 @@ type Programmer struct {
 func (p *Programmer) AddToCommand(cmd *cobra.Command, srv rpc.ArduinoCoreServiceServer) {
 	cmd.Flags().StringVarP(&p.programmer, "programmer", "P", "", tr("Programmer to use, e.g: atmel_ice"))
 	cmd.RegisterFlagCompletionFunc("programmer", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
-		return GetInstalledProgrammers(srv, context.Background()), cobra.ShellCompDirectiveDefault
+		return GetInstalledProgrammers(context.Background(), srv), cobra.ShellCompDirectiveDefault
 	})
 }
 

internal/cli/arguments/reference.go

@@ -44,11 +44,11 @@ func (r *Reference) String() string {
 
 // ParseReferences is a convenient wrapper that operates on a slice of strings and
 // calls ParseReference for each of them. It returns at the first invalid argument.
-func ParseReferences(srv rpc.ArduinoCoreServiceServer, ctx context.Context, args []string) ([]*Reference, error) {
+func ParseReferences(ctx context.Context, srv rpc.ArduinoCoreServiceServer, args []string) ([]*Reference, error) {
 	ret := []*Reference{}
 	for _, arg := range args {
 		// TODO: This is quite resource consuming (since it creates a new instance for each call)
-		reference, err := ParseReference(srv, ctx, arg)
+		reference, err := ParseReference(ctx, srv, arg)
 		if err != nil {
 			return nil, err
 		}
@@ -62,7 +62,7 @@ func ParseReferences(srv rpc.ArduinoCoreServiceServer, ctx context.Context, args
 // To achieve that, it tries to use github.com/arduino/arduino-cli/commands/core.GetPlatform
 // Note that the Reference is returned rightaway if the arg inserted by the user matches perfectly one in the response of core.GetPlatform
 // A MultiplePlatformsError is returned if the platform searched by the user matches multiple platforms
-func ParseReference(srv rpc.ArduinoCoreServiceServer, ctx context.Context, arg string) (*Reference, error) {
+func ParseReference(ctx context.Context, srv rpc.ArduinoCoreServiceServer, arg string) (*Reference, error) {
 	logrus.Infof("Parsing reference %s", arg)
 	ret := &Reference{}
 	if arg == "" {
@@ -98,7 +98,7 @@ func ParseReference(srv rpc.ArduinoCoreServiceServer, ctx context.Context, arg s
 	// try to use core.PlatformList to optimize what the user typed
 	// (by replacing the PackageName and Architecture in ret with the content of core.GetPlatform())
 	platforms, _ := commands.PlatformSearch(&rpc.PlatformSearchRequest{
-		Instance: instance.CreateAndInit(srv, ctx),
+		Instance: instance.CreateAndInit(ctx, srv),
 	})
 	foundPlatforms := []string{}
 	for _, platform := range platforms.GetSearchOutput() {

internal/cli/arguments/reference_test.go

@@ -62,13 +62,13 @@ func TestParseReferenceCores(t *testing.T) {
 	srv := commands.NewArduinoCoreServer("")
 	ctx := context.Background()
 	for _, tt := range goodCores {
-		actual, err := arguments.ParseReference(srv, ctx, tt.in)
+		actual, err := arguments.ParseReference(ctx, srv, tt.in)
 		assert.Nil(t, err)
 		assert.Equal(t, tt.expected, actual)
 	}
 
 	for _, tt := range badCores {
-		actual, err := arguments.ParseReference(srv, ctx, tt.in)
+		actual, err := arguments.ParseReference(ctx, srv, tt.in)
 		require.NotNil(t, err, "Testing bad core '%s'", tt.in)
 		require.Equal(t, tt.expected, actual, "Testing bad core '%s'", tt.in)
 	}
@@ -81,7 +81,7 @@ func TestParseArgs(t *testing.T) {
 	}
 
 	srv := commands.NewArduinoCoreServer("")
-	refs, err := arguments.ParseReferences(srv, context.Background(), input)
+	refs, err := arguments.ParseReferences(context.Background(), srv, input)
 	assert.Nil(t, err)
 	assert.Equal(t, len(goodCores), len(refs))
 

internal/cli/board/details.go

@@ -57,7 +57,7 @@ func initDetailsCommand(srv rpc.ArduinoCoreServiceServer) *cobra.Command {
 
 func runDetailsCommand(srv rpc.ArduinoCoreServiceServer, fqbn string, showFullDetails, listProgrammers bool, showProperties arguments.ShowProperties) {
 	ctx := context.Background()
-	inst := instance.CreateAndInit(srv, ctx)
+	inst := instance.CreateAndInit(ctx, srv)
 
 	logrus.Info("Executing `arduino-cli board details`")
 

internal/cli/board/list.go

@@ -59,7 +59,7 @@ func initListCommand(srv rpc.ArduinoCoreServiceServer) *cobra.Command {
 // runListCommand detects and lists the connected arduino boards
 func runListCommand(srv rpc.ArduinoCoreServiceServer, watch bool, timeout int64, fqbn string) {
 	ctx := context.Background()
-	inst := instance.CreateAndInit(srv, ctx)
+	inst := instance.CreateAndInit(ctx, srv)
 
 	logrus.Info("Executing `arduino-cli board list`")
 

internal/cli/board/listall.go

@@ -53,7 +53,7 @@ for a specific board if you specify the board name`),
 // runListAllCommand list all installed boards
 func runListAllCommand(args []string, srv rpc.ArduinoCoreServiceServer) {
 	ctx := context.Background()
-	inst := instance.CreateAndInit(srv, ctx)
+	inst := instance.CreateAndInit(ctx, srv)
 
 	logrus.Info("Executing `arduino-cli board listall`")
 

internal/cli/board/search.go

@@ -50,7 +50,7 @@ func initSearchCommand(srv rpc.ArduinoCoreServiceServer) *cobra.Command {
 
 func runSearchCommand(srv rpc.ArduinoCoreServiceServer, args []string) {
 	ctx := context.Background()
-	inst := instance.CreateAndInit(srv, ctx)
+	inst := instance.CreateAndInit(ctx, srv)
 
 	logrus.Info("Executing `arduino-cli board search`")
 

internal/cli/burnbootloader/burnbootloader.go

@@ -67,7 +67,7 @@ func NewCommand(srv rpc.ArduinoCoreServiceServer) *cobra.Command {
 
 func runBootloaderCommand(srv rpc.ArduinoCoreServiceServer) {
 	ctx := context.Background()
-	instance := instance.CreateAndInit(srv, ctx)
+	instance := instance.CreateAndInit(ctx, srv)
 
 	logrus.Info("Executing `arduino-cli burn-bootloader`")
 

internal/cli/compile/compile.go

@@ -169,9 +169,9 @@ func runCompileCommand(cmd *cobra.Command, args []string, srv rpc.ArduinoCoreSer
 	var profile *rpc.SketchProfile
 
 	if profileArg.Get() == "" {
-		inst, profile = instance.CreateAndInitWithProfile(srv, ctx, sk.GetDefaultProfile().GetName(), sketchPath)
+		inst, profile = instance.CreateAndInitWithProfile(ctx, srv, sk.GetDefaultProfile().GetName(), sketchPath)
 	} else {
-		inst, profile = instance.CreateAndInitWithProfile(srv, ctx, profileArg.Get(), sketchPath)
+		inst, profile = instance.CreateAndInitWithProfile(ctx, srv, profileArg.Get(), sketchPath)
 	}
 
 	if fqbnArg.String() == "" {

internal/cli/core/download.go

@@ -42,19 +42,19 @@ func initDownloadCommand(srv rpc.ArduinoCoreServiceServer) *cobra.Command {
 			runDownloadCommand(srv, args)
 		},
 		ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
-			return arguments.GetInstallableCores(srv, context.Background()), cobra.ShellCompDirectiveDefault
+			return arguments.GetInstallableCores(context.Background(), srv), cobra.ShellCompDirectiveDefault
 		},
 	}
 	return downloadCommand
 }
 
 func runDownloadCommand(srv rpc.ArduinoCoreServiceServer, args []string) {
 	ctx := context.Background()
-	inst := instance.CreateAndInit(srv, ctx)
+	inst := instance.CreateAndInit(ctx, srv)
 
 	logrus.Info("Executing `arduino-cli core download`")
 
-	platformsRefs, err := arguments.ParseReferences(srv, ctx, args)
+	platformsRefs, err := arguments.ParseReferences(ctx, srv, args)
 	if err != nil {
 		feedback.Fatal(tr("Invalid argument passed: %v", err), feedback.ErrBadArgument)
 	}

internal/cli/core/install.go

@@ -48,7 +48,7 @@ func initInstallCommand(srv rpc.ArduinoCoreServiceServer) *cobra.Command {
 			runInstallCommand(srv, args, scriptFlags, noOverwrite)
 		},
 		ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
-			return arguments.GetInstallableCores(srv, context.Background()), cobra.ShellCompDirectiveDefault
+			return arguments.GetInstallableCores(context.Background(), srv), cobra.ShellCompDirectiveDefault
 		},
 	}
 	scriptFlags.AddToCommand(installCommand)
@@ -59,9 +59,9 @@ func initInstallCommand(srv rpc.ArduinoCoreServiceServer) *cobra.Command {
 func runInstallCommand(srv rpc.ArduinoCoreServiceServer, args []string, scriptFlags arguments.PrePostScriptsFlags, noOverwrite bool) {
 	logrus.Info("Executing `arduino-cli core install`")
 	ctx := context.Background()
-	inst := instance.CreateAndInit(srv, ctx)
+	inst := instance.CreateAndInit(ctx, srv)
 
-	platformsRefs, err := arguments.ParseReferences(srv, ctx, args)
+	platformsRefs, err := arguments.ParseReferences(ctx, srv, args)
 	if err != nil {
 		feedback.Fatal(tr("Invalid argument passed: %v", err), feedback.ErrBadArgument)
 	}

internal/cli/core/list.go

@@ -49,7 +49,7 @@ func initListCommand(srv rpc.ArduinoCoreServiceServer) *cobra.Command {
 
 func runListCommand(srv rpc.ArduinoCoreServiceServer, all bool, updatableOnly bool) {
 	ctx := context.Background()
-	inst := instance.CreateAndInit(srv, ctx)
+	inst := instance.CreateAndInit(ctx, srv)
 	logrus.Info("Executing `arduino-cli core list`")
 	List(inst, all, updatableOnly)
 }

internal/cli/core/search.go

@@ -54,7 +54,7 @@ const indexUpdateInterval = 24 * time.Hour
 
 func runSearchCommand(srv rpc.ArduinoCoreServiceServer, args []string, allVersions bool) {
 	ctx := context.Background()
-	inst := instance.CreateAndInit(srv, ctx)
+	inst := instance.CreateAndInit(ctx, srv)
 
 	res, err := commands.UpdateIndex(
 		context.Background(),

internal/cli/core/uninstall.go

@@ -41,7 +41,7 @@ func initUninstallCommand(srv rpc.ArduinoCoreServiceServer) *cobra.Command {
 			runUninstallCommand(srv, args, preUninstallFlags)
 		},
 		ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
-			return arguments.GetUninstallableCores(srv, context.Background()), cobra.ShellCompDirectiveDefault
+			return arguments.GetUninstallableCores(context.Background(), srv), cobra.ShellCompDirectiveDefault
 		},
 	}
 	preUninstallFlags.AddToCommand(uninstallCommand)
@@ -51,9 +51,9 @@ func initUninstallCommand(srv rpc.ArduinoCoreServiceServer) *cobra.Command {
 func runUninstallCommand(srv rpc.ArduinoCoreServiceServer, args []string, preUninstallFlags arguments.PrePostScriptsFlags) {
 	logrus.Info("Executing `arduino-cli core uninstall`")
 	ctx := context.Background()
-	inst := instance.CreateAndInit(srv, ctx)
+	inst := instance.CreateAndInit(ctx, srv)
 
-	platformsRefs, err := arguments.ParseReferences(srv, ctx, args)
+	platformsRefs, err := arguments.ParseReferences(ctx, srv, args)
 	if err != nil {
 		feedback.Fatal(tr("Invalid argument passed: %v", err), feedback.ErrBadArgument)
 	}

internal/cli/core/update_index.go

@@ -45,7 +45,7 @@ func initUpdateIndexCommand(srv rpc.ArduinoCoreServiceServer) *cobra.Command {
 func runUpdateIndexCommand(srv rpc.ArduinoCoreServiceServer) {
 	logrus.Info("Executing `arduino-cli core update-index`")
 	ctx := context.Background()
-	inst := instance.CreateAndInit(srv, ctx)
+	inst := instance.CreateAndInit(ctx, srv)
 	resp := UpdateIndex(inst)
 
 	feedback.PrintResult(&updateIndexResult{result.NewUpdateIndexResponse_ResultResult(resp)})

internal/cli/core/upgrade.go

@@ -53,12 +53,12 @@ func initUpgradeCommand(srv rpc.ArduinoCoreServiceServer) *cobra.Command {
 func runUpgradeCommand(srv rpc.ArduinoCoreServiceServer, args []string, skipPostInstall bool, skipPreUninstall bool) {
 	logrus.Info("Executing `arduino-cli core upgrade`")
 	ctx := context.Background()
-	inst := instance.CreateAndInit(srv, ctx)
-	Upgrade(srv, ctx, inst, args, skipPostInstall, skipPreUninstall)
+	inst := instance.CreateAndInit(ctx, srv)
+	Upgrade(ctx, srv, inst, args, skipPostInstall, skipPreUninstall)
 }
 
 // Upgrade upgrades one or all installed platforms to the latest version.
-func Upgrade(srv rpc.ArduinoCoreServiceServer, ctx context.Context, inst *rpc.Instance, args []string, skipPostInstall bool, skipPreUninstall bool) {
+func Upgrade(ctx context.Context, srv rpc.ArduinoCoreServiceServer, inst *rpc.Instance, args []string, skipPostInstall bool, skipPreUninstall bool) {
 	// if no platform was passed, upgrade allthethings
 	if len(args) == 0 {
 		platforms, err := commands.PlatformSearch(&rpc.PlatformSearchRequest{
@@ -103,7 +103,7 @@ func Upgrade(srv rpc.ArduinoCoreServiceServer, ctx context.Context, inst *rpc.In
 	}
 
 	// proceed upgrading, if anything is upgradable
-	platformsRefs, err := arguments.ParseReferences(srv, ctx, args)
+	platformsRefs, err := arguments.ParseReferences(ctx, srv, args)
 	if err != nil {
 		feedback.Fatal(tr("Invalid argument passed: %v", err), feedback.ErrBadArgument)
 	}

internal/cli/debug/debug.go

@@ -93,9 +93,9 @@ func runDebugCommand(srv rpc.ArduinoCoreServiceServer, args []string, portArgs *
 	var profile *rpc.SketchProfile
 
 	if profileArg.Get() == "" {
-		inst, profile = instance.CreateAndInitWithProfile(srv, ctx, sk.GetDefaultProfile().GetName(), sketchPath)
+		inst, profile = instance.CreateAndInitWithProfile(ctx, srv, sk.GetDefaultProfile().GetName(), sketchPath)
 	} else {
-		inst, profile = instance.CreateAndInitWithProfile(srv, ctx, profileArg.Get(), sketchPath)
+		inst, profile = instance.CreateAndInitWithProfile(ctx, srv, profileArg.Get(), sketchPath)
 	}
 
 	if fqbnArg.String() == "" {

internal/cli/debug/debug_check.go

@@ -53,7 +53,7 @@ func newDebugCheckCommand(srv rpc.ArduinoCoreServiceServer) *cobra.Command {
 
 func runDebugCheckCommand(srv rpc.ArduinoCoreServiceServer, portArgs *arguments.Port, fqbnArg *arguments.Fqbn, interpreter string, programmerArg *arguments.Programmer) {
 	ctx := context.Background()
-	instance := instance.CreateAndInit(srv, ctx)
+	instance := instance.CreateAndInit(ctx, srv)
 	logrus.Info("Executing `arduino-cli debug`")
 
 	port, err := portArgs.GetPort(instance, srv, "", "")