Skip to content

Commit

Permalink
Refactored board details to use pluggable discovery (#1332)
Browse files Browse the repository at this point in the history 
* Cache board identification properties

* Board details now shows pluggable discovery identification props

* Use new methods in go-properties-orderedmap to calculate subsets

* Updated i18n

* Added migration docs

* Improved tests

* Update arduino/cores/board.go

Co-authored-by: per1234 <[email protected]>

* Update docs/UPGRADING.md

Co-authored-by: per1234 <[email protected]>
  • Loading branch information
@cmaglie @per1234
cmaglie and per1234 authored Jul 22, 2021
1 parent f610ed7 commit fc367b7
Show file tree
Hide file tree
Showing 10 changed files with 498 additions and 480 deletions.
44 changes: 17 additions & 27 deletions arduino/cores/board.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,10 @@ import (

// Board represents a board loaded from an installed platform
type Board struct {
BoardID string
Properties *properties.Map `json:"-"`
PlatformRelease *PlatformRelease `json:"-"`
BoardID string
Properties *properties.Map `json:"-"`
PlatformRelease *PlatformRelease `json:"-"`
identificationProperties []*properties.Map
}

// HasUsbID returns true if the board match the usb vid and pid parameters
Expand Down Expand Up @@ -140,14 +141,19 @@ func (b *Board) GeneratePropertiesForConfiguration(config string) (*properties.M
return b.GetBuildProperties(fqbn.Configs)
}

// GetIdentificationProperties calculates and returns a list of properties sets
// containing the properties required to identify the board. The returned sets
// must not be changed by the caller.
func (b *Board) GetIdentificationProperties() []*properties.Map {
if b.identificationProperties == nil {
b.identificationProperties = b.Properties.ExtractSubIndexSets("upload_port")
}
return b.identificationProperties
}

// IsBoardMatchingIDProperties returns true if the board match the given
// identification properties
func (b *Board) IsBoardMatchingIDProperties(query *properties.Map) bool {
portIDPropsSet := b.Properties.SubTree("upload_port")
if portIDPropsSet.Size() == 0 {
return false
}

// check checks if the given set of properties p match the "query"
check := func(p *properties.Map) bool {
for k, v := range p.AsMap() {
Expand All @@ -159,26 +165,10 @@ func (b *Board) IsBoardMatchingIDProperties(query *properties.Map) bool {
}

// First check the identification properties with sub index "upload_port.N.xxx"
idx := 0
haveIndexedProperties := false
for {
idProps := portIDPropsSet.SubTree(fmt.Sprintf("%d", idx))
idx++
if idProps.Size() > 0 {
haveIndexedProperties = true
if check(idProps) {
return true
}
} else if idx > 1 {
// Always check sub-id 0 and 1 (https://github.com/arduino/arduino-cli/issues/456)
break
for _, idProps := range b.GetIdentificationProperties() {
if check(idProps) {
return true
}
}

// if there are no subindexed then check the whole "upload_port.xxx"
if !haveIndexedProperties {
return check(portIDPropsSet)
}

return false
}
24 changes: 12 additions & 12 deletions cli/board/details.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -130,13 +130,13 @@ func (dr detailsResult) String() string {
table.NewCell("✔", color.New(color.FgGreen)))
}

for i, idp := range details.IdentificationPrefs {
if i == 0 {
t.AddRow() // get some space from above
t.AddRow(tr("Identification properties:"), "VID:"+idp.UsbId.Vid+" PID:"+idp.UsbId.Pid)
continue
for _, idp := range details.GetIdentificationProperties() {
t.AddRow() // get some space from above
header := tr("Identification properties:")
for k, v := range idp.GetProperties() {
t.AddRow(header, k+"="+v)
header = ""
}
t.AddRow("", "VID:"+idp.UsbId.Vid+" PID:"+idp.UsbId.Pid)
}

t.AddRow() // get some space from above
Expand All @@ -159,14 +159,14 @@ func (dr detailsResult) String() string {

t.AddRow() // get some space from above
for _, tool := range details.ToolsDependencies {
t.AddRow(tr("Required tool:"), tool.Packager+":"+tool.Name, "", tool.Version)
t.AddRow(tr("Required tool:"), tool.Packager+":"+tool.Name, tool.Version)
if showFullDetails {
for _, sys := range tool.Systems {
t.AddRow("", tr("OS:"), "", sys.Host)
t.AddRow("", tr("File:"), "", sys.ArchiveFilename)
t.AddRow("", tr("Size (bytes):"), "", fmt.Sprint(sys.Size))
t.AddRow("", tr("Checksum:"), "", sys.Checksum)
t.AddRow("", "URL:", "", sys.Url)
t.AddRow("", tr("OS:"), sys.Host)
t.AddRow("", tr("File:"), sys.ArchiveFilename)
t.AddRow("", tr("Size (bytes):"), fmt.Sprint(sys.Size))
t.AddRow("", tr("Checksum:"), sys.Checksum)
t.AddRow("", "URL:", sys.Url)
t.AddRow() // get some space from above
}
}
Expand Down
16 changes: 6 additions & 10 deletions commands/board/details.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,12 @@ func Details(ctx context.Context, req *rpc.BoardDetailsRequest) (*rpc.BoardDetai
details.PropertiesId = board.BoardID
details.Official = fqbn.Package == "arduino"
details.Version = board.PlatformRelease.Version.String()
details.IdentificationProperties = []*rpc.BoardIdentificationProperties{}
for _, p := range board.GetIdentificationProperties() {
details.IdentificationProperties = append(details.IdentificationProperties, &rpc.BoardIdentificationProperties{
Properties: p.AsMap(),
})
}

details.DebuggingSupported = boardProperties.ContainsKey("debug.executable") ||
boardPlatform.Properties.ContainsKey("debug.executable") ||
Expand Down Expand Up @@ -80,16 +86,6 @@ func Details(ctx context.Context, req *rpc.BoardDetailsRequest) (*rpc.BoardDetai
details.Platform.Size = boardPlatform.Resource.Size
}

details.IdentificationPrefs = []*rpc.IdentificationPref{}
vids := board.Properties.SubTree("vid")
pids := board.Properties.SubTree("pid")
for id, vid := range vids.AsMap() {
if pid, ok := pids.GetOk(id); ok {
idPref := rpc.IdentificationPref{UsbId: &rpc.USBID{Vid: vid, Pid: pid}}
details.IdentificationPrefs = append(details.IdentificationPrefs, &idPref)
}
}

details.ConfigOptions = []*rpc.ConfigOption{}
options := board.GetConfigOptions()
for _, option := range options.Keys() {
Expand Down
106 changes: 106 additions & 0 deletions docs/UPGRADING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,112 @@ removed, in its place:

`Context.Sketch` types has been changed from `Sketch` to `sketch.Sketch`.

### Change in `board details` response (gRPC and JSON output)

The `board details` output WRT board identification properties has changed, before it was:

```
$ arduino-cli board details arduino:samd:mkr1000
Board name: Arduino MKR1000
FQBN: arduino:samd:mkr1000
Board version: 1.8.11
Debugging supported: ✔
Official Arduino board: ✔
Identification properties: VID:0x2341 PID:0x824e
VID:0x2341 PID:0x024e
VID:0x2341 PID:0x804e
VID:0x2341 PID:0x004e
[...]
$ arduino-cli board details arduino:samd:mkr1000 --format json
[...]
"identification_prefs": [
{
"usb_id": {
"vid": "0x2341",
"pid": "0x804e"
}
},
{
"usb_id": {
"vid": "0x2341",
"pid": "0x004e"
}
},
{
"usb_id": {
"vid": "0x2341",
"pid": "0x824e"
}
},
{
"usb_id": {
"vid": "0x2341",
"pid": "0x024e"
}
}
],
[...]
```

now the properties have been renamed from `identification_prefs` to `identification_properties` and they are no longer
specific to USB but they can theoretically be any set of key/values:

```
$ arduino-cli board details arduino:samd:mkr1000
Board name: Arduino MKR1000
FQBN: arduino:samd:mkr1000
Board version: 1.8.11
Debugging supported: ✔
Official Arduino board: ✔
Identification properties: vid=0x2341
pid=0x804e
Identification properties: vid=0x2341
pid=0x004e
Identification properties: vid=0x2341
pid=0x824e
Identification properties: vid=0x2341
pid=0x024e
[...]
$ arduino-cli board details arduino:samd:mkr1000 --format json
[...]
"identification_properties": [
{
"properties": {
"pid": "0x804e",
"vid": "0x2341"
}
},
{
"properties": {
"pid": "0x004e",
"vid": "0x2341"
}
},
{
"properties": {
"pid": "0x824e",
"vid": "0x2341"
}
},
{
"properties": {
"pid": "0x024e",
"vid": "0x2341"
}
}
]
}
```

### Change of behaviour of gRPC `Init` function

Previously the `Init` function was used to both create a new `CoreInstance` and initialize it, so that the internal
Expand Down
4 changes: 1 addition & 3 deletions go.mod
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ require (
github.com/fluxio/iohelpers v0.0.0-20160419043813-3a4dd67a94d2 // indirect
github.com/fluxio/multierror v0.0.0-20160419044231-9c68d39025e5 // indirect
github.com/gofrs/uuid v3.2.0+incompatible
github.com/golang/protobuf v1.5.2
github.com/h2non/filetype v1.0.8 // indirect
github.com/juju/loggo v0.0.0-20190526231331-6e530bcce5d8 // indirect
github.com/kr/text v0.2.0 // indirect
Expand All @@ -38,7 +37,6 @@ require (
github.com/spf13/jwalterweatherman v1.0.0
github.com/spf13/viper v1.6.2
github.com/stretchr/testify v1.6.1
github.com/xanzy/ssh-agent v0.2.1 // indirect
go.bug.st/cleanup v1.0.0
go.bug.st/downloader/v2 v2.1.1
go.bug.st/relaxed-semver v0.0.0-20190922224835-391e10178d18
Expand All @@ -48,7 +46,7 @@ require (
golang.org/x/net v0.0.0-20210505024714-0287a6fb4125
golang.org/x/sys v0.0.0-20210503173754-0981d6026fa6 // indirect
golang.org/x/text v0.3.6
google.golang.org/genproto v0.0.0-20210504143626-3b2ad6ccc450 // indirect
google.golang.org/genproto v0.0.0-20210504143626-3b2ad6ccc450
google.golang.org/grpc v1.37.0
google.golang.org/protobuf v1.26.0
gopkg.in/mgo.v2 v2.0.0-20180705113604-9856a29383ce // indirect
Expand Down
2 changes: 1 addition & 1 deletion i18n/data/en.po
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ msgstr "Global Flags:"
msgid "Id"
msgstr "Id"

#: cli/board/details.go:136
#: cli/board/details.go:135
msgid "Identification properties:"
msgstr "Identification properties:"

Expand Down
Loading

0 comments on commit fc367b7

Please sign in to comment.