Skip to content

Commit ba13ab4

Browse files
silvanocerzasilvanocerza
authored
Fix core search command not searching through package terms (#1016)
1 parent 1d1da06 commit ba13ab4

File tree

5 files changed

+449
-1
lines changed

5 files changed

+449
-1
lines changed

‎commands/core/search.go‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,9 @@ func PlatformSearch(instanceID int32, searchArgs string, allVersions bool) (*rpc
5959
}
6060

6161
// platform has a valid release, check if it matches the search arguments
62-
if match(platform.Name, searchArgs) || match(platform.Architecture, searchArgs) || exactMatch(platform.String(), searchArgs) {
62+
if match(platform.Name, searchArgs) || match(platform.Architecture, searchArgs) ||
63+
exactMatch(platform.String(), searchArgs) || match(targetPackage.Name, searchArgs) ||
64+
match(targetPackage.Maintainer, searchArgs) || match(targetPackage.WebsiteURL, searchArgs) {
6365
if allVersions {
6466
res = append(res, platform.GetAllReleases()...)
6567
} else {

‎commands/core/search_test.go‎

Lines changed: 187 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,15 @@
1616
package core
1717

1818
import (
19+
"os"
1920
"testing"
2021

22+
"github.com/arduino/arduino-cli/cli/instance"
23+
"github.com/arduino/arduino-cli/configuration"
24+
"github.com/arduino/arduino-cli/rpc/commands"
25+
"github.com/arduino/go-paths-helper"
2126
"github.com/stretchr/testify/assert"
27+
"github.com/stretchr/testify/require"
2228
)
2329

2430
func TestMatch(t *testing.T) {
@@ -27,3 +33,184 @@ func TestMatch(t *testing.T) {
2733
assert.True(t, match("this is platform Foo", ""))
2834
assert.False(t, match("this is platform Foo", "Bar"))
2935
}
36+
37+
func TestPlatformSearch(t *testing.T) {
38+
39+
dataDir := paths.TempDir().Join("test", "data_dir")
40+
downloadDir := paths.TempDir().Join("test", "staging")
41+
os.Setenv("ARDUINO_DATA_DIR", dataDir.String())
42+
os.Setenv("ARDUINO_DOWNLOADS_DIR", downloadDir.String())
43+
dataDir.MkdirAll()
44+
downloadDir.MkdirAll()
45+
defer paths.TempDir().Join("test").RemoveAll()
46+
err := paths.New("testdata").Join("package_index.json").CopyTo(dataDir.Join("package_index.json"))
47+
require.Nil(t, err)
48+
49+
configuration.Init(paths.TempDir().Join("test", "arduino-cli.yaml").String())
50+
51+
inst, err := instance.CreateInstance()
52+
require.Nil(t, err)
53+
require.NotNil(t, inst)
54+
55+
res, err := PlatformSearch(inst.GetId(), "retrokit", true)
56+
require.Nil(t, err)
57+
require.NotNil(t, res)
58+
59+
require.Len(t, res.SearchOutput, 2)
60+
require.Contains(t, res.SearchOutput, &commands.Platform{
61+
ID: "Retrokits-RK002:arm",
62+
Installed: "",
63+
Latest: "1.0.5",
64+
Name: "RK002",
65+
Maintainer: "Retrokits (www.retrokits.com)",
66+
Website: "https://www.retrokits.com",
67+
Email: "info@retrokits.com",
68+
Boards: []*commands.Board{{Name: "RK002"}},
69+
})
70+
require.Contains(t, res.SearchOutput, &commands.Platform{
71+
ID: "Retrokits-RK002:arm",
72+
Installed: "",
73+
Latest: "1.0.6",
74+
Name: "RK002",
75+
Maintainer: "Retrokits (www.retrokits.com)",
76+
Website: "https://www.retrokits.com",
77+
Email: "info@retrokits.com",
78+
Boards: []*commands.Board{{Name: "RK002"}},
79+
})
80+
81+
res, err = PlatformSearch(inst.GetId(), "retrokit", false)
82+
require.Nil(t, err)
83+
require.NotNil(t, res)
84+
require.Len(t, res.SearchOutput, 1)
85+
require.Contains(t, res.SearchOutput, &commands.Platform{
86+
ID: "Retrokits-RK002:arm",
87+
Installed: "",
88+
Latest: "1.0.6",
89+
Name: "RK002",
90+
Maintainer: "Retrokits (www.retrokits.com)",
91+
Website: "https://www.retrokits.com",
92+
Email: "info@retrokits.com",
93+
Boards: []*commands.Board{{Name: "RK002"}},
94+
})
95+
96+
// Search the Package Maintainer
97+
res, err = PlatformSearch(inst.GetId(), "Retrokits (www.retrokits.com)", true)
98+
require.Nil(t, err)
99+
require.NotNil(t, res)
100+
require.Len(t, res.SearchOutput, 2)
101+
require.Contains(t, res.SearchOutput, &commands.Platform{
102+
ID: "Retrokits-RK002:arm",
103+
Installed: "",
104+
Latest: "1.0.5",
105+
Name: "RK002",
106+
Maintainer: "Retrokits (www.retrokits.com)",
107+
Website: "https://www.retrokits.com",
108+
Email: "info@retrokits.com",
109+
Boards: []*commands.Board{{Name: "RK002"}},
110+
})
111+
require.Contains(t, res.SearchOutput, &commands.Platform{
112+
ID: "Retrokits-RK002:arm",
113+
Installed: "",
114+
Latest: "1.0.6",
115+
Name: "RK002",
116+
Maintainer: "Retrokits (www.retrokits.com)",
117+
Website: "https://www.retrokits.com",
118+
Email: "info@retrokits.com",
119+
Boards: []*commands.Board{{Name: "RK002"}},
120+
})
121+
122+
// Search using the Package name
123+
res, err = PlatformSearch(inst.GetId(), "Retrokits-RK002", true)
124+
require.Nil(t, err)
125+
require.NotNil(t, res)
126+
require.Len(t, res.SearchOutput, 2)
127+
require.Contains(t, res.SearchOutput, &commands.Platform{
128+
ID: "Retrokits-RK002:arm",
129+
Installed: "",
130+
Latest: "1.0.5",
131+
Name: "RK002",
132+
Maintainer: "Retrokits (www.retrokits.com)",
133+
Website: "https://www.retrokits.com",
134+
Email: "info@retrokits.com",
135+
Boards: []*commands.Board{{Name: "RK002"}},
136+
})
137+
require.Contains(t, res.SearchOutput, &commands.Platform{
138+
ID: "Retrokits-RK002:arm",
139+
Installed: "",
140+
Latest: "1.0.6",
141+
Name: "RK002",
142+
Maintainer: "Retrokits (www.retrokits.com)",
143+
Website: "https://www.retrokits.com",
144+
Email: "info@retrokits.com",
145+
Boards: []*commands.Board{{Name: "RK002"}},
146+
})
147+
148+
// Search using the Platform name
149+
res, err = PlatformSearch(inst.GetId(), "rk002", true)
150+
require.Nil(t, err)
151+
require.NotNil(t, res)
152+
require.Len(t, res.SearchOutput, 2)
153+
require.Contains(t, res.SearchOutput, &commands.Platform{
154+
ID: "Retrokits-RK002:arm",
155+
Installed: "",
156+
Latest: "1.0.5",
157+
Name: "RK002",
158+
Maintainer: "Retrokits (www.retrokits.com)",
159+
Website: "https://www.retrokits.com",
160+
Email: "info@retrokits.com",
161+
Boards: []*commands.Board{{Name: "RK002"}},
162+
})
163+
require.Contains(t, res.SearchOutput, &commands.Platform{
164+
ID: "Retrokits-RK002:arm",
165+
Installed: "",
166+
Latest: "1.0.6",
167+
Name: "RK002",
168+
Maintainer: "Retrokits (www.retrokits.com)",
169+
Website: "https://www.retrokits.com",
170+
Email: "info@retrokits.com",
171+
Boards: []*commands.Board{{Name: "RK002"}},
172+
})
173+
174+
// Search using a board name
175+
res, err = PlatformSearch(inst.GetId(), "Yún", true)
176+
require.Nil(t, err)
177+
require.NotNil(t, res)
178+
require.Len(t, res.SearchOutput, 1)
179+
require.Contains(t, res.SearchOutput, &commands.Platform{
180+
ID: "arduino:avr",
181+
Installed: "",
182+
Latest: "1.8.3",
183+
Name: "Arduino AVR Boards",
184+
Maintainer: "Arduino",
185+
Website: "https://www.arduino.cc/",
186+
Email: "packages@arduino.cc",
187+
Boards: []*commands.Board{
188+
{Name: "Arduino Yún"},
189+
{Name: "Arduino Uno"},
190+
{Name: "Arduino Uno WiFi"},
191+
{Name: "Arduino Diecimila"},
192+
{Name: "Arduino Nano"},
193+
{Name: "Arduino Mega"},
194+
{Name: "Arduino MegaADK"},
195+
{Name: "Arduino Leonardo"},
196+
{Name: "Arduino Leonardo Ethernet"},
197+
{Name: "Arduino Micro"},
198+
{Name: "Arduino Esplora"},
199+
{Name: "Arduino Mini"},
200+
{Name: "Arduino Ethernet"},
201+
{Name: "Arduino Fio"},
202+
{Name: "Arduino BT"},
203+
{Name: "Arduino LilyPadUSB"},
204+
{Name: "Arduino Lilypad"},
205+
{Name: "Arduino Pro"},
206+
{Name: "Arduino ATMegaNG"},
207+
{Name: "Arduino Robot Control"},
208+
{Name: "Arduino Robot Motor"},
209+
{Name: "Arduino Gemma"},
210+
{Name: "Adafruit Circuit Playground"},
211+
{Name: "Arduino Yún Mini"},
212+
{Name: "Arduino Industrial 101"},
213+
{Name: "Linino One"},
214+
},
215+
})
216+
}

‎commands/core/testdata/package_index.json‎

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
{
2+
"packages": [
3+
{
4+
"name": "arduino",
5+
"maintainer": "Arduino",
6+
"websiteURL": "https://www.arduino.cc/",
7+
"email": "packages@arduino.cc",
8+
"help": {
9+
"online": "http://www.arduino.cc/en/Reference/HomePage"
10+
},
11+
"platforms": [
12+
{
13+
"name": "Arduino AVR Boards",
14+
"architecture": "avr",
15+
"version": "1.8.3",
16+
"category": "Arduino",
17+
"help": {
18+
"online": "http://www.arduino.cc/en/Reference/HomePage"
19+
},
20+
"url": "http://downloads.arduino.cc/cores/avr-1.8.3.tar.bz2",
21+
"archiveFileName": "avr-1.8.3.tar.bz2",
22+
"checksum": "SHA-256:de8a9b982477762d3d3e52fc2b682cdd8ff194dc3f1d46f4debdea6a01b33c14",
23+
"size": "4941548",
24+
"boards": [
25+
{ "name": "Arduino Yún" },
26+
{ "name": "Arduino Uno" },
27+
{ "name": "Arduino Uno WiFi" },
28+
{ "name": "Arduino Diecimila" },
29+
{ "name": "Arduino Nano" },
30+
{ "name": "Arduino Mega" },
31+
{ "name": "Arduino MegaADK" },
32+
{ "name": "Arduino Leonardo" },
33+
{ "name": "Arduino Leonardo Ethernet" },
34+
{ "name": "Arduino Micro" },
35+
{ "name": "Arduino Esplora" },
36+
{ "name": "Arduino Mini" },
37+
{ "name": "Arduino Ethernet" },
38+
{ "name": "Arduino Fio" },
39+
{ "name": "Arduino BT" },
40+
{ "name": "Arduino LilyPadUSB" },
41+
{ "name": "Arduino Lilypad" },
42+
{ "name": "Arduino Pro" },
43+
{ "name": "Arduino ATMegaNG" },
44+
{ "name": "Arduino Robot Control" },
45+
{ "name": "Arduino Robot Motor" },
46+
{ "name": "Arduino Gemma" },
47+
{ "name": "Adafruit Circuit Playground" },
48+
{ "name": "Arduino Yún Mini" },
49+
{ "name": "Arduino Industrial 101" },
50+
{ "name": "Linino One" }
51+
],
52+
"toolsDependencies": [
53+
{
54+
"packager": "arduino",
55+
"name": "avr-gcc",
56+
"version": "7.3.0-atmel3.6.1-arduino7"
57+
},
58+
{
59+
"packager": "arduino",
60+
"name": "avrdude",
61+
"version": "6.3.0-arduino17"
62+
},
63+
{
64+
"packager": "arduino",
65+
"name": "arduinoOTA",
66+
"version": "1.3.0"
67+
}
68+
]
69+
}
70+
]
71+
},
72+
{
73+
"name": "Retrokits-RK002",
74+
"maintainer": "Retrokits (www.retrokits.com)",
75+
"websiteURL": "https://www.retrokits.com",
76+
"email": "info@retrokits.com",
77+
"help": { "online": "https://www.retrokits.com/rk002/arduino" },
78+
"platforms": [
79+
{
80+
"name": "RK002",
81+
"architecture": "arm",
82+
"version": "1.0.5",
83+
"category": "Contributed",
84+
"help": {
85+
"online": "https://www.retrokits.com/rk002/arduino"
86+
},
87+
"url": "https://www.retrokits.com/rk002/arduino/retrokits-rk002-1.0.5.tar.bz2",
88+
"archiveFileName": "retrokits-rk002-1.0.5.tar.bz2",
89+
"checksum": "SHA-256:9a012867baf4bb26f656f84502e0acce6a653c3452cca4505ebac77256802fb6",
90+
"size": "290784",
91+
"boards": [{ "name": "RK002" }],
92+
"toolsDependencies": [
93+
{
94+
"packager": "arduino",
95+
"version": "4.8.3-2014q1",
96+
"name": "arm-none-eabi-gcc"
97+
}
98+
]
99+
}
100+
],
101+
"tools": []
102+
},
103+
{
104+
"name": "Retrokits-RK002",
105+
"maintainer": "Retrokits (www.retrokits.com)",
106+
"websiteURL": "https://www.retrokits.com",
107+
"email": "info@retrokits.com",
108+
"help": { "online": "https://www.retrokits.com/rk002/arduino" },
109+
"platforms": [
110+
{
111+
"name": "RK002",
112+
"architecture": "arm",
113+
"version": "1.0.6",
114+
"category": "Contributed",
115+
"help": {
116+
"online": "https://www.retrokits.com/rk002/arduino"
117+
},
118+
"url": "https://www.retrokits.com/rk002/arduino/retrokits-rk002-1.0.6.tar.bz2",
119+
"archiveFileName": "retrokits-rk002-1.0.6.tar.bz2",
120+
"checksum": "SHA-256:8a3b63efcf4dfaed047a37844861387e542d8519485b5305d5979630cb3feb20",
121+
"size": "291631",
122+
"boards": [{ "name": "RK002" }],
123+
"toolsDependencies": [
124+
{
125+
"packager": "arduino",
126+
"version": "4.8.3-2014q1",
127+
"name": "arm-none-eabi-gcc"
128+
}
129+
]
130+
}
131+
],
132+
"tools": []
133+
}
134+
]
135+
}

‎test/test_core.py‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,37 @@ def test_core_search(run_command, httpserver):
4545
data = json.loads(result.stdout)
4646
assert 2 == len(data)
4747

48+
# Search all Retrokit platforms
49+
result = run_command(f"core search retrokit --all --additional-urls={url}")
50+
assert result.ok
51+
assert 3 == len(result.stdout.strip().splitlines())
52+
lines = [l.split(maxsplit=2) for l in result.stdout.strip().splitlines()]
53+
assert ["Retrokits-RK002:arm", "1.0.5", "RK002"] in lines
54+
assert ["Retrokits-RK002:arm", "1.0.6", "RK002"] in lines
55+
56+
# Search using Retrokit Package Maintainer
57+
result = run_command(f"core search Retrokits-RK002 --all --additional-urls={url}")
58+
assert result.ok
59+
assert 3 == len(result.stdout.strip().splitlines())
60+
lines = [l.split(maxsplit=2) for l in result.stdout.strip().splitlines()]
61+
assert ["Retrokits-RK002:arm", "1.0.5", "RK002"] in lines
62+
assert ["Retrokits-RK002:arm", "1.0.6", "RK002"] in lines
63+
64+
# Search using the Retrokit Platform name
65+
result = run_command(f"core search rk002 --all --additional-urls={url}")
66+
assert result.ok
67+
assert 3 == len(result.stdout.strip().splitlines())
68+
lines = [l.split(maxsplit=2) for l in result.stdout.strip().splitlines()]
69+
assert ["Retrokits-RK002:arm", "1.0.5", "RK002"] in lines
70+
assert ["Retrokits-RK002:arm", "1.0.6", "RK002"] in lines
71+
72+
# Search using a board name
73+
result = run_command(f"core search myboard --all --additional-urls={url}")
74+
assert result.ok
75+
assert 2 == len(result.stdout.strip().splitlines())
76+
lines = [l.split(maxsplit=2) for l in result.stdout.strip().splitlines()]
77+
assert ["Package:x86", "1.2.3", "Platform"] in lines
78+
4879

4980
def test_core_search_no_args(run_command, httpserver):
5081
"""

0 commit comments

Comments
 (0)