cli code refactoring: argument parsing/handling should not access the arduino package directly

[cmaglie]

Describe the problem

This is an architectural issue in the golang implementation of the CLI.
The cli package should not use directly the arduino package but it should use only the functions available through gRPC, implemented in the commands package to avoid code duplication and re-implementation of the same functionality over and over.

To reproduce

The current instances of the above issue are here:

internal/cli/arguments/completion.go access the package arduino/cores:

• import:

  arduino-cli/internal/cli/arguments/completion.go

  Line 21 in 82e6f5d

  "github.com/arduino/arduino-cli/arduino/cores"

• usage:

  arduino-cli/internal/cli/arguments/completion.go

  Line 106 in 82e6f5d

  fqbn, _ := cores.ParseFQBN(board.Fqbn)

internal/cli/arguments/fqbn.go access the packages arduino/cores and arduino/sketch

• import:

  arduino-cli/internal/cli/arguments/fqbn.go

  Lines 21 to 22 in 82e6f5d

  	"github.com/arduino/arduino-cli/arduino"
  	"github.com/arduino/arduino-cli/arduino/sketch"

• use of sketch:

  arduino-cli/internal/cli/arguments/fqbn.go

  Line 73 in 82e6f5d

  func CalculateFQBNAndPort(portArgs *Port, fqbnArg *Fqbn, instance *rpc.Instance, sk *sketch.Sketch) (string, *rpc.Port) {

• use of arduino:

  arduino-cli/internal/cli/arguments/fqbn.go

  Line 82 in 82e6f5d

  feedback.FatalError(&arduino.MissingFQBNError{}, feedback.ErrGeneric)

• use of arduino:

  arduino-cli/internal/cli/arguments/fqbn.go

  Line 86 in 82e6f5d

  feedback.FatalError(&arduino.MissingFQBNError{}, feedback.ErrGeneric)

internal/cli/arguments/port.go access arduino/discovery and arduino/sketch

• imports:

  arduino-cli/internal/cli/arguments/port.go

  Lines 22 to 24 in 82e6f5d

  	"github.com/arduino/arduino-cli/arduino"
  	"github.com/arduino/arduino-cli/arduino/discovery"
  	"github.com/arduino/arduino-cli/arduino/sketch"

• use of sketch:

  arduino-cli/internal/cli/arguments/port.go

  Line 60 in 82e6f5d

  func (p *Port) GetPortAddressAndProtocol(instance *rpc.Instance, sk *sketch.Sketch) (string, string, error) {

• use of sketch:

  arduino-cli/internal/cli/arguments/port.go

  Line 73 in 82e6f5d

  func (p *Port) GetPort(instance *rpc.Instance, sk *sketch.Sketch) (*discovery.Port, error) {

• it completely duplicates a discovery-manager run loop to discover the ports:

  arduino-cli/internal/cli/arguments/port.go

  Lines 95 to 132 in 82e6f5d

  	// FIXME: We must not access PackageManager directly here but use one of the commands.* functions
  	pme, release := commands.GetPackageManagerExplorer(&rpc.BoardListAllRequest{Instance: instance})
  	if pme == nil {
  	return nil, &arduino.InvalidInstanceError{}
  	}
  	defer release()
  	dm := pme.DiscoveryManager()
  	watcher, err := dm.Watch()
  	if err != nil {
  	return nil, err
  	}
  	defer watcher.Close()
  	deadline := time.After(p.timeout.Get())
  	for {
  	select {
  	case portEvent := <-watcher.Feed():
  	if portEvent.Type != "add" {
  	continue
  	}
  	port := portEvent.Port
  	if (protocol == "" || protocol == port.Protocol) && address == port.Address {
  	return port, nil
  	}
  	case <-deadline:
  	// No matching port found
  	if protocol == "" {
  	return &discovery.Port{
  	Address: address,
  	Protocol: "serial",
  	}, nil
  	}
  	return nil, fmt.Errorf(tr("port not found: %[1]s %[2]s"), address, protocol)
  	}
  	}
  	}

cli/arguments/reference.go uses arduino to get an error object:

• use of arduino:

  arduino-cli/internal/cli/arguments/reference.go

  Line 123 in 82e6f5d

  return nil, &arduino.MultiplePlatformsError{Platforms: foundPlatforms, UserPlatform: arg}

cli/arguments/sketch.go uses arduino/sketch:

• use of sketch:

  arduino-cli/internal/cli/arguments/sketch.go

  Lines 46 to 47 in 82e6f5d

  	func NewSketch(sketchPath *paths.Path) *sketch.Sketch {
  	sketch, err := sketch.New(sketchPath)

• use of sketch:

  arduino-cli/internal/cli/arguments/sketch.go

  Line 57 in 82e6f5d

  if files := sketch.CheckForPdeFiles(sketchPath); len(files) > 0 {

Expected behavior

Remove all direct access to the arduino package using the gRPC commads implementation in commands.

Arduino CLI version

nightly build

Operating system

N/A

Operating system version

Additional context

No response

Issue checklist

• I searched for previous reports in the issue tracker
• I verified the problem still occurs when using the nightly build
• My report contains all necessary details

[cmaglie]

Partially solved by #2217

[cmaglie]

We forgot to remove the discovery loop in

arduino-cli/internal/cli/arguments/port.go

Lines 95 to 132 in 82e6f5d

	// FIXME: We must not access PackageManager directly here but use one of the commands.* functions
	pme, release := commands.GetPackageManagerExplorer(&rpc.BoardListAllRequest{Instance: instance})
	if pme == nil {
	return nil, &arduino.InvalidInstanceError{}
	}
	defer release()
	dm := pme.DiscoveryManager()
	watcher, err := dm.Watch()
	if err != nil {
	return nil, err
	}
	defer watcher.Close()
	deadline := time.After(p.timeout.Get())
	for {
	select {
	case portEvent := <-watcher.Feed():
	if portEvent.Type != "add" {
	continue
	}
	port := portEvent.Port
	if (protocol == "" || protocol == port.Protocol) && address == port.Address {
	return port, nil
	}
	case <-deadline:
	// No matching port found
	if protocol == "" {
	return &discovery.Port{
	Address: address,
	Protocol: "serial",
	}, nil
	}
	return nil, fmt.Errorf(tr("port not found: %[1]s %[2]s"), address, protocol)
	}
	}
	}