Skip to content

Core search/list now return boards in a platform #268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 9, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cli/core/list.go
Original file line number Diff line number Diff line change
@@ -69,7 +69,7 @@ func runListCommand(cmd *cobra.Command, args []string) {
}
}

func outputInstalledCores(cores []*rpc.InstalledPlatform) {
func outputInstalledCores(cores []*rpc.Platform) {
table := output.NewTable()
table.AddRow("ID", "Installed", "Latest", "Name")
sort.Slice(cores, func(i, j int) bool {
4 changes: 2 additions & 2 deletions cli/core/search.go
Original file line number Diff line number Diff line change
@@ -71,14 +71,14 @@ func runSearchCommand(cmd *cobra.Command, args []string) {
}
}

func outputSearchCores(cores []*rpc.SearchOutput) {
func outputSearchCores(cores []*rpc.Platform) {
table := output.NewTable()
table.AddRow("ID", "Version", "Name")
sort.Slice(cores, func(i, j int) bool {
return cores[i].ID < cores[j].ID
})
for _, item := range cores {
table.AddRow(item.GetID(), item.GetVersion(), item.GetName())
table.AddRow(item.GetID(), item.GetLatest(), item.GetName())
}
fmt.Print(table.Render())
}
54 changes: 54 additions & 0 deletions commands/core/core.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
/*
* This file is part of arduino-cli.
*
* Copyright 2019 ARDUINO SA (http://www.arduino.cc/)
*
* This software is released under the GNU General Public License version 3,
* which covers the main part of arduino-cli.
* The terms of this license can be found at:
* https://www.gnu.org/licenses/gpl-3.0.en.html
*
* You can be released from the requirements of the above licenses by purchasing
* a commercial license. Buying such a license is mandatory if you want to modify or
* otherwise use the software for commercial activities involving the Arduino
* software without disclosing the source code of your own applications. To purchase
* a commercial license, send an email to [email protected].
*/

package core
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add license and copyright header?


import (
"github.com/arduino/arduino-cli/arduino/cores"
rpc "github.com/arduino/arduino-cli/rpc/commands"
)

// platformReleaseToRPC converts our internal structure to the RPC structure.
// Note: this function does not touch the "Installed" field of rpc.Platform as it's not always clear that the
// platformRelease we're currently converting is actually installed.
func platformReleaseToRPC(platformRelease *cores.PlatformRelease) *rpc.Platform {
boards := make([]*rpc.Board, len(platformRelease.Boards))
i := 0
for _, b := range platformRelease.Boards {
Copy link
Contributor

@masci masci Jul 9, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's do for i, b := range platformRelease.Boards and let range deal with the index increments comment not relevant since it's a map

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That would be my preferred way, too. Boards is a map[string].. though, thus i would not be numeric index here unfortunately.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oops my bad, didn't check what's been iterated here, scratch my comment!

boards[i] = &rpc.Board{
Name: b.Name(),
Fqbn: b.FQBN(),
}
i++
}

result := &rpc.Platform{
ID: platformRelease.Platform.String(),
Name: platformRelease.Platform.Name,
Maintainer: platformRelease.Platform.Package.Maintainer,
Website: platformRelease.Platform.Package.WebsiteURL,
Email: platformRelease.Platform.Package.Email,
Boards: boards,
}

latest := platformRelease.Platform.GetLatestRelease()
if latest != nil {
result.Latest = latest.Version.String()
}

return result
}
13 changes: 4 additions & 9 deletions commands/core/list.go
Original file line number Diff line number Diff line change
@@ -32,7 +32,7 @@ func PlatformList(ctx context.Context, req *rpc.PlatformListReq) (*rpc.PlatformL
return nil, errors.New("invalid instance")
}

installed := []*rpc.InstalledPlatform{}
installed := []*rpc.Platform{}
for _, targetPackage := range pm.GetPackages().Packages {
for _, platform := range targetPackage.Platforms {
if platformRelease := pm.GetInstalledPlatformRelease(platform); platformRelease != nil {
@@ -41,14 +41,9 @@ func PlatformList(ctx context.Context, req *rpc.PlatformListReq) (*rpc.PlatformL
continue
}
}
p := &rpc.InstalledPlatform{
ID: platformRelease.String(),
Installed: platformRelease.Version.String(),
Name: platformRelease.Platform.Name,
}
if latest := platformRelease.Platform.GetLatestRelease(); latest != nil {
p.Latest = latest.Version.String()
}

p := platformReleaseToRPC(platformRelease)
p.Installed = platformRelease.Version.String()
installed = append(installed, p)
}
}
10 changes: 3 additions & 7 deletions commands/core/search.go
Original file line number Diff line number Diff line change
@@ -65,13 +65,9 @@ func PlatformSearch(ctx context.Context, req *rpc.PlatformSearchReq) (*rpc.Platf
}
}

out := []*rpc.SearchOutput{}
for _, platformRelease := range res {
out = append(out, &rpc.SearchOutput{
ID: platformRelease.Platform.String(),
Name: platformRelease.Platform.Name,
Version: platformRelease.Version.String(),
})
out := make([]*rpc.Platform, len(res))
for i, platformRelease := range res {
out[i] = platformReleaseToRPC(platformRelease)
}
return &rpc.PlatformSearchResp{SearchOutput: out}, nil
}
279 changes: 153 additions & 126 deletions rpc/commands/core.pb.go

Large diffs are not rendered by default.

21 changes: 12 additions & 9 deletions rpc/commands/core.proto
Original file line number Diff line number Diff line change
@@ -73,13 +73,7 @@ message PlatformSearchReq {
}

message PlatformSearchResp {
repeated SearchOutput search_output = 1;
}

message SearchOutput {
string ID = 1;
string Version = 2;
string Name = 3;
repeated Platform search_output = 1;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🍰

}

message PlatformListReq {
@@ -88,12 +82,21 @@ message PlatformListReq {
}

message PlatformListResp {
repeated InstalledPlatform installed_platform = 1;
repeated Platform installed_platform = 1;
}

message InstalledPlatform {
message Platform {
string ID = 1;
string Installed = 2;
string Latest = 3;
string Name = 4;
string Maintainer = 5;
string Website = 6;
string Email = 7;
repeated Board Boards = 8;
}

message Board {
string name = 1;
string fqbn = 2;
}