1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
|
// This file is part of arduino-cli.
//
// Copyright 2022 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 license@arduino.cc.
package completion_test
import (
"testing"
"github.com/arduino/arduino-cli/internal/integrationtest"
"github.com/arduino/go-paths-helper"
"github.com/stretchr/testify/require"
)
// test if the completion command behaves correctly
func TestCompletionNoArgs(t *testing.T) {
env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
defer env.CleanUp()
stdout, stderr, err := cli.Run("completion")
require.Error(t, err)
require.Contains(t, string(stderr), "Error: accepts 1 arg(s), received 0")
require.Empty(t, stdout)
}
func TestCompletionBash(t *testing.T) {
env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
defer env.CleanUp()
stdout, stderr, err := cli.Run("completion", "bash")
require.NoError(t, err)
require.Empty(t, stderr)
require.Contains(t, string(stdout), "# bash completion V2 for arduino-cli")
require.Contains(t, string(stdout), "__start_arduino-cli()")
}
func TestCompletionZsh(t *testing.T) {
env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
defer env.CleanUp()
stdout, stderr, err := cli.Run("completion", "zsh")
require.NoError(t, err)
require.Empty(t, stderr)
require.Contains(t, string(stdout), "#compdef arduino-cli")
require.Contains(t, string(stdout), "_arduino-cli()")
}
func TestCompletionFish(t *testing.T) {
env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
defer env.CleanUp()
stdout, stderr, err := cli.Run("completion", "fish")
require.NoError(t, err)
require.Empty(t, stderr)
require.Contains(t, string(stdout), "# fish completion for arduino-cli")
require.Contains(t, string(stdout), "function __arduino_cli_perform_completion")
}
func TestCompletionPowershell(t *testing.T) {
env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
defer env.CleanUp()
stdout, stderr, err := cli.Run("completion", "powershell")
require.NoError(t, err)
require.Empty(t, stderr)
require.Contains(t, string(stdout), "# powershell completion for arduino-cli")
require.Contains(t, string(stdout), "Register-ArgumentCompleter -CommandName 'arduino-cli' -ScriptBlock")
}
func TestCompletionBashNoDesc(t *testing.T) {
env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
defer env.CleanUp()
stdout, stderr, err := cli.Run("completion", "bash", "--no-descriptions")
require.NoError(t, err)
require.Empty(t, stderr)
require.Contains(t, string(stdout), "# bash completion V2 for arduino-cli")
require.Contains(t, string(stdout), "__start_arduino-cli()")
require.Contains(t, string(stdout), "__completeNoDesc")
}
func TestCompletionZshNoDesc(t *testing.T) {
env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
defer env.CleanUp()
stdout, stderr, err := cli.Run("completion", "zsh", "--no-descriptions")
require.NoError(t, err)
require.Empty(t, stderr)
require.Contains(t, string(stdout), "#compdef arduino-cli")
require.Contains(t, string(stdout), "_arduino-cli()")
require.Contains(t, string(stdout), "__completeNoDesc")
}
func TestCompletionFishNoDesc(t *testing.T) {
env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
defer env.CleanUp()
stdout, stderr, err := cli.Run("completion", "fish", "--no-descriptions")
require.NoError(t, err)
require.Empty(t, stderr)
require.Contains(t, string(stdout), "# fish completion for arduino-cli")
require.Contains(t, string(stdout), "function __arduino_cli_perform_completion")
require.Contains(t, string(stdout), "__completeNoDesc")
}
func TestCompletionPowershellNoDesc(t *testing.T) {
env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
defer env.CleanUp()
stdout, stderr, err := cli.Run("completion", "powershell", "--no-descriptions")
require.Error(t, err)
require.Empty(t, stdout)
require.Contains(t, string(stderr), "Error: command description is not supported by powershell")
}
// test if the completion suggestions returned are meaningful
// we use the __complete hidden command
// https://github.com/spf13/cobra/blob/master/shell_completions.md#debugging
// test static completions
func TestStaticCompletions(t *testing.T) {
env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
defer env.CleanUp()
stdout, _, _ := cli.Run("__complete", "--format", "")
require.Contains(t, string(stdout), "json")
stdout, _, _ = cli.Run("__complete", "--log-format", "")
require.Contains(t, string(stdout), "json")
stdout, _, _ = cli.Run("__complete", "--log-level", "")
require.Contains(t, string(stdout), "trace")
}
// here we test if the completions coming from the core are working
func TestConfigCompletion(t *testing.T) {
env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
defer env.CleanUp()
stdout, _, _ := cli.Run("__complete", "config", "add", "")
require.Contains(t, string(stdout), "board_manager.additional_urls")
stdout, _, _ = cli.Run("__complete", "config", "remove", "")
require.Contains(t, string(stdout), "board_manager.additional_urls")
stdout, _, _ = cli.Run("__complete", "config", "delete", "")
require.Contains(t, string(stdout), "board_manager.additional_urls")
stdout, _, _ = cli.Run("__complete", "config", "set", "")
require.Contains(t, string(stdout), "board_manager.additional_urls")
}
// here we test if the completions coming from the libs are working
func TestLibCompletion(t *testing.T) {
env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
defer env.CleanUp()
_, _, err := cli.Run("lib", "update-index")
require.NoError(t, err)
stdout, _, _ := cli.Run("__complete", "lib", "install", "")
require.Contains(t, string(stdout), "WiFi101")
stdout, _, _ = cli.Run("__complete", "lib", "download", "")
require.Contains(t, string(stdout), "WiFi101")
stdout, _, _ = cli.Run("__complete", "lib", "uninstall", "")
require.NotContains(t, string(stdout), "WiFi101") // not yet installed
_, _, err = cli.Run("lib", "install", "Wifi101")
require.NoError(t, err)
stdout, _, _ = cli.Run("__complete", "lib", "uninstall", "")
require.Contains(t, string(stdout), "WiFi101")
stdout, _, _ = cli.Run("__complete", "lib", "examples", "")
require.Contains(t, string(stdout), "WiFi101")
stdout, _, _ = cli.Run("__complete", "lib", "deps", "")
require.Contains(t, string(stdout), "WiFi101")
}
// here we test if the completions coming from the core are working
func TestCoreCompletion(t *testing.T) {
env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
defer env.CleanUp()
_, _, err := cli.Run("core", "update-index")
require.NoError(t, err)
stdout, _, _ := cli.Run("__complete", "core", "install", "")
require.Contains(t, string(stdout), "arduino:avr")
stdout, _, _ = cli.Run("__complete", "core", "download", "")
require.Contains(t, string(stdout), "arduino:avr")
stdout, _, _ = cli.Run("__complete", "core", "uninstall", "")
require.NotContains(t, string(stdout), "arduino:avr")
// we install a core because the provided completions comes from it
_, _, err = cli.Run("core", "install", "arduino:avr@1.8.3")
require.NoError(t, err)
stdout, _, _ = cli.Run("__complete", "core", "uninstall", "")
require.Contains(t, string(stdout), "arduino:avr")
stdout, _, _ = cli.Run("__complete", "board", "details", "-b", "")
require.Contains(t, string(stdout), "arduino:avr:uno")
stdout, _, _ = cli.Run("__complete", "burn-bootloader", "-b", "")
require.Contains(t, string(stdout), "arduino:avr:uno")
stdout, _, _ = cli.Run("__complete", "compile", "-b", "")
require.Contains(t, string(stdout), "arduino:avr:uno")
stdout, _, _ = cli.Run("__complete", "debug", "-b", "")
require.Contains(t, string(stdout), "arduino:avr:uno")
stdout, _, _ = cli.Run("__complete", "lib", "examples", "-b", "")
require.Contains(t, string(stdout), "arduino:avr:uno")
stdout, _, _ = cli.Run("__complete", "upload", "-b", "")
require.Contains(t, string(stdout), "arduino:avr:uno")
stdout, _, _ = cli.Run("__complete", "monitor", "-b", "")
require.Contains(t, string(stdout), "arduino:avr:uno")
// -l/--protocol and -p/--port cannot be tested because there are
// no board connected.
stdout, _, _ = cli.Run("__complete", "burn-bootloader", "-P", "")
require.Contains(t, string(stdout), "atmel_ice")
stdout, _, _ = cli.Run("__complete", "compile", "-P", "")
require.Contains(t, string(stdout), "atmel_ice")
stdout, _, _ = cli.Run("__complete", "debug", "-P", "")
require.Contains(t, string(stdout), "atmel_ice")
stdout, _, _ = cli.Run("__complete", "upload", "-P", "")
require.Contains(t, string(stdout), "atmel_ice")
}
func TestProfileCompletion(t *testing.T) {
env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
defer env.CleanUp()
// Create test sketches
sketchWithProfilesPath, err := paths.New("testdata", "SketchWithProfiles").Abs()
require.NoError(t, err)
require.True(t, sketchWithProfilesPath.IsDir())
stdout, _, _ := cli.Run("__complete", "compile", sketchWithProfilesPath.String(), "--profile", "")
require.Contains(t, string(stdout), "profile1")
stdout, _, _ = cli.Run("__complete", "monitor", sketchWithProfilesPath.String(), "--profile", "")
require.Contains(t, string(stdout), "profile1")
stdout, _, _ = cli.Run("__complete", "upload", sketchWithProfilesPath.String(), "--profile", "")
require.Contains(t, string(stdout), "profile1")
// The cli is running in the sketch folder, so need the explicitly specify the path in the cli
cli.SetWorkingDir(sketchWithProfilesPath)
stdout, _, _ = cli.Run("__complete", "compile", "--profile", "")
require.Contains(t, string(stdout), "profile1")
stdout, _, _ = cli.Run("__complete", "monitor", "--profile", "")
require.Contains(t, string(stdout), "profile1")
stdout, _, _ = cli.Run("__complete", "upload", "--profile", "")
require.Contains(t, string(stdout), "profile1")
}
|
