net/mlx5: use SPDX tags in 6WIND copyrighted files
[dpdk.git] / test / cmdline_test / cmdline_test_data.py
1 # SPDX-License-Identifier: BSD-3-Clause
2 # Copyright(c) 2010-2014 Intel Corporation
3
4 # collection of static data
5
6 # keycode constants
7 CTRL_A = chr(1)
8 CTRL_B = chr(2)
9 CTRL_C = chr(3)
10 CTRL_D = chr(4)
11 CTRL_E = chr(5)
12 CTRL_F = chr(6)
13 CTRL_K = chr(11)
14 CTRL_L = chr(12)
15 CTRL_N = chr(14)
16 CTRL_P = chr(16)
17 CTRL_W = chr(23)
18 CTRL_Y = chr(25)
19 ALT_B = chr(27) + chr(98)
20 ALT_D = chr(27) + chr(100)
21 ALT_F = chr(27) + chr(102)
22 ALT_BKSPACE = chr(27) + chr(127)
23 DEL = chr(27) + chr(91) + chr(51) + chr(126)
24 TAB = chr(9)
25 HELP = chr(63)
26 BKSPACE = chr(127)
27 RIGHT = chr(27) + chr(91) + chr(67)
28 DOWN = chr(27) + chr(91) + chr(66)
29 LEFT = chr(27) + chr(91) + chr(68)
30 UP = chr(27) + chr(91) + chr(65)
31 ENTER2 = '\r'
32 ENTER = '\n'
33
34 # expected result constants
35 NOT_FOUND = "Command not found"
36 BAD_ARG = "Bad arguments"
37 AMBIG = "Ambiguous command"
38 CMD1 = "Command 1 parsed!"
39 CMD2 = "Command 2 parsed!"
40 SINGLE = "Single word command parsed!"
41 SINGLE_LONG = "Single long word command parsed!"
42 AUTO1 = "Autocomplete command 1 parsed!"
43 AUTO2 = "Autocomplete command 2 parsed!"
44
45 # misc defines
46 CMD_QUIT = "quit"
47 CMD_GET_BUFSIZE = "get_history_bufsize"
48 BUFSIZE_TEMPLATE = "History buffer size: "
49 PROMPT = "CMDLINE_TEST>>"
50
51 # test defines
52 # each test tests progressively diverse set of keys. this way for example
53 # if we want to use some key sequence in the test, we first need to test
54 # that it itself does what it is expected to do. Most of the tests are
55 # designed that way.
56 #
57 # example: "arrows & delete test 1". we enter a partially valid command,
58 # then move 3 chars left and use delete three times. this way we get to
59 # know that "delete", "left" and "ctrl+B" all work (because if any of
60 # them fails, the whole test will fail and next tests won't be run).
61 #
62 # each test consists of name, character sequence to send to child,
63 # and expected output (if any).
64
65 tests = [
66     # test basic commands
67     {"Name": "command test 1",
68      "Sequence": "ambiguous first" + ENTER,
69      "Result": CMD1},
70     {"Name": "command test 2",
71      "Sequence": "ambiguous second" + ENTER,
72      "Result": CMD2},
73     {"Name": "command test 3",
74      "Sequence": "ambiguous ambiguous" + ENTER,
75      "Result": AMBIG},
76     {"Name": "command test 4",
77      "Sequence": "ambiguous ambiguous2" + ENTER,
78      "Result": AMBIG},
79
80     {"Name": "invalid command test 1",
81      "Sequence": "ambiguous invalid" + ENTER,
82      "Result": BAD_ARG},
83     # test invalid commands
84     {"Name": "invalid command test 2",
85      "Sequence": "invalid" + ENTER,
86      "Result": NOT_FOUND},
87     {"Name": "invalid command test 3",
88      "Sequence": "ambiguousinvalid" + ENTER2,
89      "Result": NOT_FOUND},
90
91     # test arrows and deletes
92     {"Name": "arrows & delete test 1",
93      "Sequence": "singlebad" + LEFT*2 + CTRL_B + DEL*3 + ENTER,
94      "Result": SINGLE},
95     {"Name": "arrows & delete test 2",
96      "Sequence": "singlebad" + LEFT*5 + RIGHT + CTRL_F + DEL*3 + ENTER,
97      "Result": SINGLE},
98
99     # test backspace
100     {"Name": "backspace test",
101      "Sequence": "singlebad" + BKSPACE*3 + ENTER,
102      "Result": SINGLE},
103
104     # test goto left and goto right
105     {"Name": "goto left test",
106      "Sequence": "biguous first" + CTRL_A + "am" + ENTER,
107      "Result": CMD1},
108     {"Name": "goto right test",
109      "Sequence": "biguous fir" + CTRL_A + "am" + CTRL_E + "st" + ENTER,
110      "Result": CMD1},
111
112     # test goto words
113     {"Name": "goto left word test",
114      "Sequence": "ambiguous st" + ALT_B + "fir" + ENTER,
115      "Result": CMD1},
116     {"Name": "goto right word test",
117      "Sequence": "ambig first" + CTRL_A + ALT_F + "uous" + ENTER,
118      "Result": CMD1},
119
120     # test removing words
121     {"Name": "remove left word 1",
122      "Sequence": "single invalid" + CTRL_W + ENTER,
123      "Result": SINGLE},
124     {"Name": "remove left word 2",
125      "Sequence": "single invalid" + ALT_BKSPACE + ENTER,
126      "Result": SINGLE},
127     {"Name": "remove right word",
128      "Sequence": "single invalid" + ALT_B + ALT_D + ENTER,
129      "Result": SINGLE},
130
131     # test kill buffer (copy and paste)
132     {"Name": "killbuffer test 1",
133      "Sequence": "ambiguous" + CTRL_A + CTRL_K + " first" + CTRL_A +
134                  CTRL_Y + ENTER,
135      "Result": CMD1},
136     {"Name": "killbuffer test 2",
137      "Sequence": "ambiguous" + CTRL_A + CTRL_K + CTRL_Y*26 + ENTER,
138      "Result": NOT_FOUND},
139
140     # test newline
141     {"Name": "newline test",
142      "Sequence": "invalid" + CTRL_C + "single" + ENTER,
143      "Result": SINGLE},
144
145     # test redisplay (nothing should really happen)
146     {"Name": "redisplay test",
147      "Sequence": "single" + CTRL_L + ENTER,
148      "Result": SINGLE},
149
150     # test autocomplete
151     {"Name": "autocomplete test 1",
152      "Sequence": "si" + TAB + ENTER,
153      "Result": SINGLE},
154     {"Name": "autocomplete test 2",
155      "Sequence": "si" + TAB + "_" + TAB + ENTER,
156      "Result": SINGLE_LONG},
157     {"Name": "autocomplete test 3",
158      "Sequence": "in" + TAB + ENTER,
159      "Result": NOT_FOUND},
160     {"Name": "autocomplete test 4",
161      "Sequence": "am" + TAB + ENTER,
162      "Result": BAD_ARG},
163     {"Name": "autocomplete test 5",
164      "Sequence": "am" + TAB + "fir" + TAB + ENTER,
165      "Result": CMD1},
166     {"Name": "autocomplete test 6",
167      "Sequence": "am" + TAB + "fir" + TAB + TAB + ENTER,
168      "Result": CMD1},
169     {"Name": "autocomplete test 7",
170      "Sequence": "am" + TAB + "fir" + TAB + " " + TAB + ENTER,
171      "Result": CMD1},
172     {"Name": "autocomplete test 8",
173      "Sequence": "am" + TAB + "     am" + TAB + "   " + ENTER,
174      "Result": AMBIG},
175     {"Name": "autocomplete test 9",
176      "Sequence": "am" + TAB + "inv" + TAB + ENTER,
177      "Result": BAD_ARG},
178     {"Name": "autocomplete test 10",
179      "Sequence": "au" + TAB + ENTER,
180      "Result": NOT_FOUND},
181     {"Name": "autocomplete test 11",
182      "Sequence": "au" + TAB + "1" + ENTER,
183      "Result": AUTO1},
184     {"Name": "autocomplete test 12",
185      "Sequence": "au" + TAB + "2" + ENTER,
186      "Result": AUTO2},
187     {"Name": "autocomplete test 13",
188      "Sequence": "au" + TAB + "2" + TAB + ENTER,
189      "Result": AUTO2},
190     {"Name": "autocomplete test 14",
191      "Sequence": "au" + TAB + "2   " + TAB + ENTER,
192      "Result": AUTO2},
193     {"Name": "autocomplete test 15",
194      "Sequence": "24" + TAB + ENTER,
195      "Result": "24"},
196
197     # test history
198     {"Name": "history test 1",
199      "Sequence": "invalid" + ENTER + "single" + ENTER + "invalid" +
200                  ENTER + UP + CTRL_P + ENTER,
201      "Result": SINGLE},
202     {"Name": "history test 2",
203      "Sequence": "invalid" + ENTER + "ambiguous first" + ENTER + "invalid" +
204                  ENTER + "single" + ENTER + UP * 3 + CTRL_N + DOWN + ENTER,
205      "Result": SINGLE},
206
207     #
208     # tests that improve coverage
209     #
210
211     # empty space tests
212     {"Name": "empty space test 1",
213      "Sequence": RIGHT + LEFT + CTRL_B + CTRL_F + ENTER,
214      "Result": PROMPT},
215     {"Name": "empty space test 2",
216      "Sequence": BKSPACE + ENTER,
217      "Result": PROMPT},
218     {"Name": "empty space test 3",
219      "Sequence": CTRL_E*2 + CTRL_A*2 + ENTER,
220      "Result": PROMPT},
221     {"Name": "empty space test 4",
222      "Sequence": ALT_F*2 + ALT_B*2 + ENTER,
223      "Result": PROMPT},
224     {"Name": "empty space test 5",
225      "Sequence": " " + CTRL_E*2 + CTRL_A*2 + ENTER,
226      "Result": PROMPT},
227     {"Name": "empty space test 6",
228      "Sequence": " " + CTRL_A + ALT_F*2 + ALT_B*2 + ENTER,
229      "Result": PROMPT},
230     {"Name": "empty space test 7",
231      "Sequence": "  " + CTRL_A + CTRL_D + CTRL_E + CTRL_D + ENTER,
232      "Result": PROMPT},
233     {"Name": "empty space test 8",
234      "Sequence": " space" + CTRL_W*2 + ENTER,
235      "Result": PROMPT},
236     {"Name": "empty space test 9",
237      "Sequence": " space" + ALT_BKSPACE*2 + ENTER,
238      "Result": PROMPT},
239     {"Name": "empty space test 10",
240      "Sequence": " space " + CTRL_A + ALT_D*3 + ENTER,
241      "Result": PROMPT},
242
243     # non-printable char tests
244     {"Name": "non-printable test 1",
245      "Sequence": chr(27) + chr(47) + ENTER,
246      "Result": PROMPT},
247     {"Name": "non-printable test 2",
248      "Sequence": chr(27) + chr(128) + ENTER*7,
249      "Result": PROMPT},
250     {"Name": "non-printable test 3",
251      "Sequence": chr(27) + chr(91) + chr(127) + ENTER*6,
252      "Result": PROMPT},
253
254     # miscellaneous tests
255     {"Name": "misc test 1",
256      "Sequence": ENTER,
257      "Result": PROMPT},
258     {"Name": "misc test 2",
259      "Sequence": "single #comment" + ENTER,
260      "Result": SINGLE},
261     {"Name": "misc test 3",
262      "Sequence": "#empty line" + ENTER,
263      "Result": PROMPT},
264     {"Name": "misc test 4",
265      "Sequence": "   single  " + ENTER,
266      "Result": SINGLE},
267     {"Name": "misc test 5",
268      "Sequence": "single#" + ENTER,
269      "Result": SINGLE},
270     {"Name": "misc test 6",
271      "Sequence": 'a' * 257 + ENTER,
272      "Result": NOT_FOUND},
273     {"Name": "misc test 7",
274      "Sequence": "clear_history" + UP*5 + DOWN*5 + ENTER,
275      "Result": PROMPT},
276     {"Name": "misc test 8",
277      "Sequence": "a" + HELP + CTRL_C,
278      "Result": PROMPT},
279     {"Name": "misc test 9",
280      "Sequence": CTRL_D*3,
281      "Result": None},
282 ]