Skip to content

Commit a465ec2

Browse files
cmagliecmaglie
committed
Moved a batch of function from commands/* subpackage to commands (part 2)
1 parent 874e94b commit a465ec2

13 files changed

+41
-2582
lines changed

‎commands/board/board.go

Lines changed: 0 additions & 20 deletions
This file was deleted.

‎commands/board/testdata/package_index.json

Lines changed: 0 additions & 2523 deletions
This file was deleted.

‎commands/service.go

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,7 @@ import (
2222
"io"
2323
"sync/atomic"
2424

25-
"github.com/arduino/arduino-cli/commands/board"
2625
"github.com/arduino/arduino-cli/commands/cmderrors"
27-
"github.com/arduino/arduino-cli/commands/compile"
2826
"github.com/arduino/arduino-cli/commands/monitor"
2927
"github.com/arduino/arduino-cli/commands/sketch"
3028
"github.com/arduino/arduino-cli/commands/upload"
@@ -53,13 +51,13 @@ func convertErrorToRPCStatus(err error) error {
5351

5452
// BoardDetails FIXMEDOC
5553
func (s *ArduinoCoreServerImpl) BoardDetails(ctx context.Context, req *rpc.BoardDetailsRequest) (*rpc.BoardDetailsResponse, error) {
56-
resp, err := board.Details(ctx, req)
54+
resp, err := BoardDetails(ctx, req)
5755
return resp, convertErrorToRPCStatus(err)
5856
}
5957

6058
// BoardList FIXMEDOC
6159
func (s *ArduinoCoreServerImpl) BoardList(ctx context.Context, req *rpc.BoardListRequest) (*rpc.BoardListResponse, error) {
62-
ports, _, err := board.List(req)
60+
ports, _, err := BoardList(req)
6361
if err != nil {
6462
return nil, convertErrorToRPCStatus(err)
6563
}
@@ -92,7 +90,7 @@ func (s *ArduinoCoreServerImpl) BoardListWatch(req *rpc.BoardListWatchRequest, s
9290
return err
9391
}
9492

95-
eventsChan, err := board.Watch(stream.Context(), req)
93+
eventsChan, err := BoardListWatch(stream.Context(), req)
9694
if err != nil {
9795
return convertErrorToRPCStatus(err)
9896
}
@@ -191,7 +189,7 @@ func (s *ArduinoCoreServerImpl) Compile(req *rpc.CompileRequest, stream rpc.Ardu
191189
Message: &rpc.CompileResponse_Progress{Progress: p},
192190
})
193191
}
194-
compileRes, compileErr := compile.Compile(stream.Context(), req, outStream, errStream, progressStream)
192+
compileRes, compileErr := Compile(stream.Context(), req, outStream, errStream, progressStream)
195193
outStream.Close()
196194
errStream.Close()
197195
var compileRespSendErr error

‎commands/board/details.go renamed to ‎commands/service_board_details.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
// Arduino software without disclosing the source code of your own applications.
1414
// To purchase a commercial license, send an email to license@arduino.cc.
1515

16-
package board
16+
package commands
1717

1818
import (
1919
"context"
@@ -25,9 +25,9 @@ import (
2525
rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
2626
)
2727

28-
// Details returns all details for a board including tools and HW identifiers.
28+
// BoardDetails returns all details for a board including tools and HW identifiers.
2929
// This command basically gather al the information and translates it into the required grpc struct properties
30-
func Details(ctx context.Context, req *rpc.BoardDetailsRequest) (*rpc.BoardDetailsResponse, error) {
30+
func BoardDetails(ctx context.Context, req *rpc.BoardDetailsRequest) (*rpc.BoardDetailsResponse, error) {
3131
pme, release, err := instances.GetPackageManagerExplorer(req.GetInstance())
3232
if err != nil {
3333
return nil, err

‎commands/board/list.go renamed to ‎commands/service_board_list.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
// Arduino software without disclosing the source code of your own applications.
1414
// To purchase a commercial license, send an email to license@arduino.cc.
1515

16-
package board
16+
package commands
1717

1818
import (
1919
"context"
@@ -201,10 +201,10 @@ func identify(pme *packagemanager.Explorer, port *discovery.Port) ([]*rpc.BoardL
201201
return boards, nil
202202
}
203203

204-
// List returns a list of boards found by the loaded discoveries.
204+
// BoardList returns a list of boards found by the loaded discoveries.
205205
// In case of errors partial results from discoveries that didn't fail
206206
// are returned.
207-
func List(req *rpc.BoardListRequest) (r []*rpc.DetectedPort, discoveryStartErrors []error, e error) {
207+
func BoardList(req *rpc.BoardListRequest) (r []*rpc.DetectedPort, discoveryStartErrors []error, e error) {
208208
pme, release, err := instances.GetPackageManagerExplorer(req.GetInstance())
209209
if err != nil {
210210
return nil, nil, err
@@ -258,8 +258,8 @@ func hasMatchingBoard(b *rpc.DetectedPort, fqbnFilter *cores.FQBN) bool {
258258
return false
259259
}
260260

261-
// Watch returns a channel that receives boards connection and disconnection events.
262-
func Watch(ctx context.Context, req *rpc.BoardListWatchRequest) (<-chan *rpc.BoardListWatchResponse, error) {
261+
// BoardListWatch returns a channel that receives boards connection and disconnection events.
262+
func BoardListWatch(ctx context.Context, req *rpc.BoardListWatchRequest) (<-chan *rpc.BoardListWatchResponse, error) {
263263
pme, release, err := instances.GetPackageManagerExplorer(req.GetInstance())
264264
if err != nil {
265265
return nil, err

‎commands/board/list_test.go renamed to ‎commands/service_board_list_test.go

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
// Arduino software without disclosing the source code of your own applications.
1414
// To purchase a commercial license, send an email to license@arduino.cc.
1515

16-
package board
16+
package commands
1717

1818
import (
1919
"fmt"
@@ -30,11 +30,9 @@ import (
3030
semver "go.bug.st/relaxed-semver"
3131
)
3232

33-
func init() {
34-
configuration.Settings = configuration.Init("")
35-
}
36-
3733
func TestGetByVidPid(t *testing.T) {
34+
configuration.Settings = configuration.Init("")
35+
configuration.Settings.Set("locale", "en")
3836
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
3937
fmt.Fprintln(w, `
4038
{
@@ -63,6 +61,8 @@ func TestGetByVidPid(t *testing.T) {
6361
}
6462

6563
func TestGetByVidPidNotFound(t *testing.T) {
64+
configuration.Settings = configuration.Init("")
65+
configuration.Settings.Set("locale", "en")
6666
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
6767
w.WriteHeader(http.StatusNotFound)
6868
}))
@@ -75,6 +75,8 @@ func TestGetByVidPidNotFound(t *testing.T) {
7575
}
7676

7777
func TestGetByVidPid5xx(t *testing.T) {
78+
configuration.Settings = configuration.Init("")
79+
configuration.Settings.Set("locale", "en")
7880
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
7981
w.WriteHeader(http.StatusInternalServerError)
8082
w.Write([]byte("500 - Ooooops!"))
@@ -89,6 +91,8 @@ func TestGetByVidPid5xx(t *testing.T) {
8991
}
9092

9193
func TestGetByVidPidMalformedResponse(t *testing.T) {
94+
configuration.Settings = configuration.Init("")
95+
configuration.Settings.Set("locale", "en")
9296
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
9397
fmt.Fprintln(w, "{}")
9498
}))
@@ -102,12 +106,17 @@ func TestGetByVidPidMalformedResponse(t *testing.T) {
102106
}
103107

104108
func TestBoardDetectionViaAPIWithNonUSBPort(t *testing.T) {
109+
configuration.Settings = configuration.Init("")
110+
configuration.Settings.Set("locale", "en")
105111
items, err := identifyViaCloudAPI(properties.NewMap())
106112
require.NoError(t, err)
107113
require.Empty(t, items)
108114
}
109115

110116
func TestBoardIdentifySorting(t *testing.T) {
117+
configuration.Settings = configuration.Init("")
118+
configuration.Settings.Set("locale", "en")
119+
111120
dataDir := paths.TempDir().Join("test", "data_dir")
112121
t.Setenv("ARDUINO_DATA_DIR", dataDir.String())
113122
dataDir.MkdirAll()

‎commands/compile/compile.go renamed to ‎commands/service_compile.go

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
// Arduino software without disclosing the source code of your own applications.
1414
// To purchase a commercial license, send an email to license@arduino.cc.
1515

16-
package compile
16+
package commands
1717

1818
import (
1919
"context"
@@ -32,15 +32,12 @@ import (
3232
"github.com/arduino/arduino-cli/internal/arduino/utils"
3333
"github.com/arduino/arduino-cli/internal/buildcache"
3434
"github.com/arduino/arduino-cli/internal/cli/configuration"
35-
"github.com/arduino/arduino-cli/internal/i18n"
3635
"github.com/arduino/arduino-cli/internal/inventory"
3736
rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
3837
paths "github.com/arduino/go-paths-helper"
3938
"github.com/sirupsen/logrus"
4039
)
4140

42-
var tr = i18n.Tr
43-
4441
// Compile FIXMEDOC
4542
func Compile(ctx context.Context, req *rpc.CompileRequest, outStream, errStream io.Writer, progressCB rpc.TaskProgressCB) (r *rpc.BuilderResult, e error) {
4643

‎internal/cli/arguments/completion.go

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ import (
1919
"context"
2020

2121
"github.com/arduino/arduino-cli/commands"
22-
"github.com/arduino/arduino-cli/commands/board"
2322
"github.com/arduino/arduino-cli/commands/upload"
2423
"github.com/arduino/arduino-cli/internal/cli/instance"
2524
rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
@@ -169,7 +168,7 @@ func GetInstallableLibs() []string {
169168
func GetAvailablePorts() []*rpc.Port {
170169
inst := instance.CreateAndInit()
171170

172-
list, _, _ := board.List(&rpc.BoardListRequest{
171+
list, _, _ := commands.BoardList(&rpc.BoardListRequest{
173172
Instance: inst,
174173
})
175174
var res []*rpc.Port

‎internal/cli/arguments/port.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import (
2020
"fmt"
2121
"time"
2222

23-
"github.com/arduino/arduino-cli/commands/board"
23+
"github.com/arduino/arduino-cli/commands"
2424
"github.com/arduino/arduino-cli/commands/cmderrors"
2525
f "github.com/arduino/arduino-cli/internal/algorithms"
2626
"github.com/arduino/arduino-cli/internal/cli/feedback"
@@ -91,7 +91,7 @@ func (p *Port) GetPort(instance *rpc.Instance, defaultAddress, defaultProtocol s
9191

9292
ctx, cancel := context.WithCancel(context.Background())
9393
defer cancel()
94-
watcher, err := board.Watch(ctx, &rpc.BoardListWatchRequest{Instance: instance})
94+
watcher, err := commands.BoardListWatch(ctx, &rpc.BoardListWatchRequest{Instance: instance})
9595
if err != nil {
9696
return nil, err
9797
}
@@ -130,7 +130,7 @@ func (p *Port) GetSearchTimeout() time.Duration {
130130
// discovered Port object together with the FQBN. If the port does not match
131131
// exactly 1 board,
132132
func (p *Port) DetectFQBN(inst *rpc.Instance) (string, *rpc.Port) {
133-
detectedPorts, _, err := board.List(&rpc.BoardListRequest{
133+
detectedPorts, _, err := commands.BoardList(&rpc.BoardListRequest{
134134
Instance: inst,
135135
Timeout: p.timeout.Get().Milliseconds(),
136136
})

‎internal/cli/arguments/programmer.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ package arguments
1818
import (
1919
"context"
2020

21-
"github.com/arduino/arduino-cli/commands/board"
22-
"github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
21+
"github.com/arduino/arduino-cli/commands"
22+
rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
2323
"github.com/spf13/cobra"
2424
)
2525

@@ -40,14 +40,14 @@ func (p *Programmer) AddToCommand(cmd *cobra.Command) {
4040

4141
// String returns the programmer specified by the user, or the default programmer
4242
// for the given board if defined.
43-
func (p *Programmer) String(inst *commands.Instance, fqbn string) string {
43+
func (p *Programmer) String(inst *rpc.Instance, fqbn string) string {
4444
if p.programmer != "" {
4545
return p.programmer
4646
}
4747
if inst == nil || fqbn == "" {
4848
return ""
4949
}
50-
details, err := board.Details(context.Background(), &commands.BoardDetailsRequest{
50+
details, err := commands.BoardDetails(context.Background(), &rpc.BoardDetailsRequest{
5151
Instance: inst,
5252
Fqbn: fqbn,
5353
})

‎internal/cli/board/details.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import (
2020
"fmt"
2121
"os"
2222

23-
"github.com/arduino/arduino-cli/commands/board"
23+
"github.com/arduino/arduino-cli/commands"
2424
"github.com/arduino/arduino-cli/internal/cli/arguments"
2525
"github.com/arduino/arduino-cli/internal/cli/feedback"
2626
"github.com/arduino/arduino-cli/internal/cli/feedback/result"
@@ -65,7 +65,7 @@ func runDetailsCommand(fqbn string, showFullDetails, listProgrammers bool, showP
6565
if err != nil {
6666
feedback.Fatal(err.Error(), feedback.ErrBadArgument)
6767
}
68-
res, err := board.Details(context.Background(), &rpc.BoardDetailsRequest{
68+
res, err := commands.BoardDetails(context.Background(), &rpc.BoardDetailsRequest{
6969
Instance: inst,
7070
Fqbn: fqbn,
7171
DoNotExpandBuildProperties: showPropertiesMode == arguments.ShowPropertiesUnexpanded,

‎internal/cli/board/list.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import (
2222
"os"
2323
"sort"
2424

25-
"github.com/arduino/arduino-cli/commands/board"
25+
"github.com/arduino/arduino-cli/commands"
2626
"github.com/arduino/arduino-cli/commands/cmderrors"
2727
"github.com/arduino/arduino-cli/internal/arduino/cores"
2828
"github.com/arduino/arduino-cli/internal/cli/arguments"
@@ -67,7 +67,7 @@ func runListCommand(watch bool, timeout int64, fqbn string) {
6767
return
6868
}
6969

70-
ports, discoveryErrors, err := board.List(&rpc.BoardListRequest{
70+
ports, discoveryErrors, err := commands.BoardList(&rpc.BoardListRequest{
7171
Instance: inst,
7272
Timeout: timeout,
7373
Fqbn: fqbn,
@@ -87,7 +87,7 @@ func runListCommand(watch bool, timeout int64, fqbn string) {
8787
}
8888

8989
func watchList(inst *rpc.Instance) {
90-
eventsChan, err := board.Watch(context.Background(), &rpc.BoardListWatchRequest{Instance: inst})
90+
eventsChan, err := commands.BoardListWatch(context.Background(), &rpc.BoardListWatchRequest{Instance: inst})
9191
if err != nil {
9292
feedback.Fatal(tr("Error detecting boards: %v", err), feedback.ErrNetwork)
9393
}

‎internal/cli/compile/compile.go

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ import (
2626

2727
"github.com/arduino/arduino-cli/commands"
2828
"github.com/arduino/arduino-cli/commands/cmderrors"
29-
"github.com/arduino/arduino-cli/commands/compile"
3029
"github.com/arduino/arduino-cli/commands/sketch"
3130
"github.com/arduino/arduino-cli/commands/upload"
3231
"github.com/arduino/arduino-cli/internal/cli/arguments"
@@ -248,7 +247,7 @@ func runCompileCommand(cmd *cobra.Command, args []string) {
248247
DoNotExpandBuildProperties: showProperties == arguments.ShowPropertiesUnexpanded,
249248
Jobs: jobs,
250249
}
251-
builderRes, compileError := compile.Compile(context.Background(), compileRequest, stdOut, stdErr, nil)
250+
builderRes, compileError := commands.Compile(context.Background(), compileRequest, stdOut, stdErr, nil)
252251

253252
var uploadRes *rpc.UploadResult
254253
if compileError == nil && uploadAfterCompile {

0 commit comments

Comments
 (0)