forked from wp-cli/wp-cli
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest-doc-parser.php
More file actions
213 lines (174 loc) · 4.22 KB
/
test-doc-parser.php
File metadata and controls
213 lines (174 loc) · 4.22 KB
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
<?php
use WP_CLI\DocParser;
use WP_CLI\Tests\TestCase;
class DocParserTests extends TestCase {
public function test_empty() {
$doc = new DocParser( '' );
$this->assertEquals( '', $doc->get_shortdesc() );
$this->assertEquals( '', $doc->get_longdesc() );
$this->assertEquals( '', $doc->get_synopsis() );
$this->assertEquals( '', $doc->get_tag( 'alias' ) );
}
public function test_only_tags() {
$doc = new DocParser(
<<<EOB
/**
* @alias rock-on
* @subcommand revoke-md5-passwords
*/
EOB
);
$this->assertEquals( '', $doc->get_shortdesc() );
$this->assertEquals( '', $doc->get_longdesc() );
$this->assertEquals( '', $doc->get_synopsis() );
$this->assertEquals( '', $doc->get_tag( 'foo' ) );
$this->assertEquals( 'rock-on', $doc->get_tag( 'alias' ) );
$this->assertEquals( 'revoke-md5-passwords', $doc->get_tag( 'subcommand' ) );
}
public function test_no_longdesc() {
$doc = new DocParser(
<<<EOB
/**
* Rock and roll!
* @alias rock-on
*/
EOB
);
$this->assertEquals( 'Rock and roll!', $doc->get_shortdesc() );
$this->assertEquals( '', $doc->get_longdesc() );
$this->assertEquals( '', $doc->get_synopsis() );
$this->assertEquals( 'rock-on', $doc->get_tag( 'alias' ) );
}
public function test_complete() {
$doc = new DocParser(
<<<EOB
/**
* Rock and roll!
*
* ## OPTIONS
*
* <genre>...
* : Start with one or more genres.
*
* --volume=<number>
* : Sets the volume.
*
* --artist=<artist-name>
* : Limit to a specific artist.
*
* ## EXAMPLES
*
* wp rock-on --volume=11
*
* @synopsis [--volume=<number>]
* @alias rock-on
*/
EOB
);
$this->assertEquals( 'Rock and roll!', $doc->get_shortdesc() );
$this->assertEquals( '[--volume=<number>]', $doc->get_synopsis() );
$this->assertEquals( 'Start with one or more genres.', $doc->get_arg_desc( 'genre' ) );
$this->assertEquals( 'Sets the volume.', $doc->get_param_desc( 'volume' ) );
$this->assertEquals( 'rock-on', $doc->get_tag( 'alias' ) );
$longdesc = <<<EOB
## OPTIONS
<genre>...
: Start with one or more genres.
--volume=<number>
: Sets the volume.
--artist=<artist-name>
: Limit to a specific artist.
## EXAMPLES
wp rock-on --volume=11
EOB;
$this->assertEquals( $longdesc, $doc->get_longdesc() );
}
public function test_desc_parses_yaml() {
$longdesc = <<<EOB
Play some music loudly
```
# Here's an example of how you might run the command
wp rock-on electronic --volume=11
```
## OPTIONS
<genre>...
: Start with one or more genres.
---
options:
- rock
- electronic
default: rock
---
--volume=<number>
: Sets the volume.
---
default: 10
---
--artist=<artist-name>
: Limit to a specific artist.
## EXAMPLES
wp rock-on electronic --volume=11
EOB;
$doc = new DocParser( $longdesc );
$this->assertEquals( 'Start with one or more genres.', $doc->get_arg_desc( 'genre' ) );
$this->assertEquals( 'Sets the volume.', $doc->get_param_desc( 'volume' ) );
$expected = [
'options' => [ 'rock', 'electronic' ],
'default' => 'rock',
];
$this->assertEquals( $expected, $doc->get_arg_args( 'genre' ) );
$expected = [
'default' => 10,
];
$this->assertEquals( $expected, $doc->get_param_args( 'volume' ) );
$this->assertNull( $doc->get_param_args( 'artist' ) );
}
public function test_desc_doesnt_parse_far_params_yaml() {
$longdesc = <<<EOB
## OPTIONS
<hook>
: The name of the action or filter.
[--format=<format>]
: List callbacks as a table, JSON, CSV, or YAML.
---
default: table
options:
- table
- json
- csv
- yaml
---
EOB;
$doc = new DocParser( $longdesc );
$expected = [
'default' => 'table',
'options' => [ 'table', 'json', 'csv', 'yaml' ],
];
$this->assertEquals( $expected, $doc->get_param_args( 'format' ) );
$this->assertNull( $doc->get_arg_args( 'hook' ) );
}
public function test_desc_doesnt_parse_far_args_yaml() {
$longdesc = <<<EOB
## OPTIONS
<hook>
: The name of the action or filter.
<format>
: List callbacks as a table, JSON, CSV, or YAML.
---
default: table
options:
- table
- json
- csv
- yaml
---
EOB;
$doc = new DocParser( $longdesc );
$expected = [
'default' => 'table',
'options' => [ 'table', 'json', 'csv', 'yaml' ],
];
$this->assertEquals( $expected, $doc->get_arg_args( 'format' ) );
$this->assertNull( $doc->get_arg_args( 'hook' ) );
}
}