Commit 1ceab8b

author

Massimiliano Pippi

authored

Avoid calling cloud API if vid or pid are invalid (#439)

* avoid calling cloud API if vid or pid are invalid * user regex

1 parent 6f1b5dd commit 1ceab8bCopy full SHA for 1ceab8b

File tree

2 files changed

+26

-10

lines changed

commands/board
- list.go
- list_test.go

2 files changed

+26

-10

lines changed

`‎commands/board/list.go‎`

Lines changed: 16 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@ import (`
`22`	`22`	`"fmt"`
`23`	`23`	`"io/ioutil"`
`24`	`24`	`"net/http"`
	`25`	`+ "regexp"`
`25`	`26`	`"sync"`
`26`	`27`
`27`	`28`	`"github.com/arduino/arduino-cli/cli/globals"`
`@@ -35,9 +36,20 @@ var (`
`35`	`36`	`// ErrNotFound is returned when the API returns 404`
`36`	`37`	`ErrNotFound = errors.New("board not found")`
`37`	`38`	`m sync.Mutex`
	`39`	`+ vidPidURL = "https://builder.arduino.cc/v3/boards/byVidPid"`
	`40`	+ validVidPid = regexp.MustCompile(`0[xX][a-fA-F\d]{4}`)
`38`	`41`	`)`
`39`	`42`
`40`		`-func apiByVidPid(url string) ([]*rpc.BoardListItem, error) {`
	`43`	`+func apiByVidPid(vid, pid string) ([]*rpc.BoardListItem, error) {`
	`44`	`+ // ensure vid and pid are valid before hitting the API`
	`45`	`+ if !validVidPid.MatchString(vid) {`
	`46`	`+ return nil, errors.Errorf("Invalid vid value: '%s'", vid)`
	`47`	`+ }`
	`48`	`+ if !validVidPid.MatchString(pid) {`
	`49`	`+ return nil, errors.Errorf("Invalid pid value: '%s'", pid)`
	`50`	`+ }`
	`51`	`+`
	`52`	`+ url := fmt.Sprintf("%s/%s/%s", vidPidURL, vid, pid)`
`41`	`53`	`retVal := []*rpc.BoardListItem{}`
`42`	`54`	`req, _ := http.NewRequest("GET", url, nil)`
`43`	`55`	`req.Header = globals.NewHTTPClientHeader()`
`@@ -110,10 +122,10 @@ func List(instanceID int32) ([]*rpc.DetectedPort, error) {`
`110`	`122`	`// the builder API`
`111`	`123`	`if len(b) == 0 {`
`112`	`124`	`logrus.Debug("Querying builder API for board identification...")`
`113`		`- url:= fmt.Sprintf("https://builder.arduino.cc/v3/boards/byVidPid/%s/%s",`
	`125`	`+ items, err:= apiByVidPid(`
`114`	`126`	`port.IdentificationPrefs.Get("vid"),`
`115`		`- port.IdentificationPrefs.Get("pid"))`
`116`		`- items, err:=apiByVidPid(url)`
	`127`	`+ port.IdentificationPrefs.Get("pid"),`
	`128`	`+ )`
`117`	`129`	`if err == ErrNotFound {`
`118`	`130`	`// the board couldn't be detected, print a warning`
`119`	`131`	`logrus.Debug("Board not recognized")`

`‎commands/board/list_test.go‎`

Lines changed: 10 additions & 6 deletions

Original file line number	Diff line number	Diff line change
`@@ -40,14 +40,15 @@ func TestGetByVidPid(t *testing.T) {`
`40`	`40`	`}))`
`41`	`41`	`defer ts.Close()`
`42`	`42`
`43`		`- res, err := apiByVidPid(ts.URL)`
	`43`	`+ vidPidURL = ts.URL`
	`44`	`+ res, err := apiByVidPid("0xf420", "0XF069")`
`44`	`45`	`require.Nil(t, err)`
`45`	`46`	`require.Len(t, res, 1)`
`46`	`47`	`require.Equal(t, "Arduino/Genuino MKR1000", res[0].Name)`
`47`	`48`	`require.Equal(t, "arduino:samd:mkr1000", res[0].FQBN)`
`48`	`49`
`49`		`- // wrong url`
`50`		`- res, err = apiByVidPid("http://0.0.0.0")`
	`50`	`+ // wrong vid (too long), wrong pid (not an hex value)`
	`51`	`+ res, err = apiByVidPid("0xfffff", "0xDEFG")`
`51`	`52`	`require.NotNil(t, err)`
`52`	`53`	`}`
`53`	`54`
`@@ -57,7 +58,8 @@ func TestGetByVidPidNotFound(t *testing.T) {`
`57`	`58`	`}))`
`58`	`59`	`defer ts.Close()`
`59`	`60`
`60`		`- res, err := apiByVidPid(ts.URL)`
	`61`	`+ vidPidURL = ts.URL`
	`62`	`+ res, err := apiByVidPid("0x0420", "0x0069")`
`61`	`63`	`require.NotNil(t, err)`
`62`	`64`	`require.Equal(t, "board not found", err.Error())`
`63`	`65`	`require.Len(t, res, 0)`
`@@ -70,7 +72,8 @@ func TestGetByVidPid5xx(t *testing.T) {`
`70`	`72`	`}))`
`71`	`73`	`defer ts.Close()`
`72`	`74`
`73`		`- res, err := apiByVidPid(ts.URL)`
	`75`	`+ vidPidURL = ts.URL`
	`76`	`+ res, err := apiByVidPid("0x0420", "0x0069")`
`74`	`77`	`require.NotNil(t, err)`
`75`	`78`	`require.Equal(t, "the server responded with status 500 Internal Server Error", err.Error())`
`76`	`79`	`require.Len(t, res, 0)`
`@@ -82,7 +85,8 @@ func TestGetByVidPidMalformedResponse(t *testing.T) {`
`82`	`85`	`}))`
`83`	`86`	`defer ts.Close()`
`84`	`87`
`85`		`- res, err := apiByVidPid(ts.URL)`
	`88`	`+ vidPidURL = ts.URL`
	`89`	`+ res, err := apiByVidPid("0x0420", "0x0069")`
`86`	`90`	`require.NotNil(t, err)`
`87`	`91`	`require.Equal(t, "wrong format in server response", err.Error())`
`88`	`92`	`require.Len(t, res, 0)`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commit 1ceab8b

File tree

2 files changed

2 files changed

`‎commands/board/list.go‎`

`‎commands/board/list_test.go‎`

0 commit comments