forked from OpenAPITools/openapi-style-validator
-
Notifications
You must be signed in to change notification settings - Fork 0
/
MainTest.java
334 lines (297 loc) · 15.7 KB
/
MainTest.java
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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
package org.openapitools.openapistylevalidator.cli;
import static org.junit.jupiter.api.Assertions.assertEquals;
import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.DefaultParser;
import org.apache.commons.cli.Options;
import org.apache.commons.cli.ParseException;
import org.apache.commons.io.IOUtils;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import org.openapitools.openapistylevalidator.ValidatorParameters;
import org.openapitools.openapistylevalidator.ValidatorParameters.NamingConvention;
import org.openapitools.openapistylevalidator.styleerror.StyleError;
import org.opentest4j.MultipleFailuresError;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
import java.util.List;
public class MainTest {
private static final String PREFIX = " \"";
private static final String SEPARATOR = "\": ";
private static final String SEPARATOR_QUOTE = "\": \"";
private static final String NEXT_LINE = "," + System.lineSeparator();
private static final String NEXT_LINE_QUOTE = "\"," + System.lineSeparator();
private static final DefaultParser parser = new DefaultParser();
private final OutputUtils outputUtils = new OutputUtils();
@Test
void validateShouldReturnSixErrorsWithoutOptionFile() throws Exception {
OptionManager optionManager = new OptionManager(outputUtils);
Options options = optionManager.getOptions();
CommandLine commandLine = parser.parse(options, new String[]{"-s", "src/test/resources/ping.yaml"});
List<StyleError> errorList = Main.validate(optionManager, commandLine);
sixErrorsAssertions(errorList);
}
@Test
void validateShouldReturnSixErrorsWithEmptyOptionFile() throws Exception {
OptionManager optionManager = new OptionManager(outputUtils);
Options options = optionManager.getOptions();
CommandLine commandLine = parser.parse(options, new String[]{"-s", "src/test/resources/ping.yaml", "-o", "src/test/resources/empty.json"});
List<StyleError> errorList = Main.validate(optionManager, commandLine);
sixErrorsAssertions(errorList);
}
@Test
void validateShouldReturnSixErrorsWithDefaultOptionFile() throws Exception {
OptionManager optionManager = new OptionManager(outputUtils);
Options options = optionManager.getOptions();
CommandLine commandLine = parser.parse(options, new String[]{"-s", "src/test/resources/ping.yaml", "-o", "src/test/resources/default.json"});
List<StyleError> errorList = Main.validate(optionManager, commandLine);
sixErrorsAssertions(errorList);
}
private void sixErrorsAssertions(List<StyleError> errorList) throws MultipleFailuresError {
Assertions.assertAll(
() -> assertEquals(6, errorList.size()),
() -> assertEquals("*ERROR* Section: APIInfo: 'license' -> Should be present and not empty", errorList.get(0).toString()),
() -> assertEquals("*ERROR* Section: APIInfo: 'description' -> Should be present and not empty", errorList.get(1).toString()),
() -> assertEquals("*ERROR* Section: APIInfo: 'contact' -> Should be present and not empty", errorList.get(2).toString()),
() -> assertEquals("*ERROR* in Operation POST /ping 'description' -> This field should be present and not empty", errorList.get(3).toString()),
() -> assertEquals("*ERROR* in Operation POST /ping 'summary' -> This field should be present and not empty", errorList.get(4).toString()),
() -> assertEquals("*ERROR* in Operation POST /ping 'tags' -> The collection should be present and there should be at least one item in it", errorList.get(5).toString())
);
}
@Test
void validateShouldReturnNoErrorsWithCustomOptionFile() throws Exception {
OptionManager optionManager = new OptionManager(outputUtils);
Options options = optionManager.getOptions();
CommandLine commandLine = parser.parse(options, new String[]{"-s", "src/test/resources/ping.yaml", "-o", "src/test/resources/custom.json"});
List<StyleError> errorList = Main.validate(optionManager, commandLine);
assertEquals(0, errorList.size());
}
@Test
void validateWithoutOptionFileShouldReturnNamingErrors() throws Exception {
OptionManager optionManager = new OptionManager(outputUtils);
Options options = optionManager.getOptions();
CommandLine commandLine = parser.parse(options, new String[]{"-s", "src/test/resources/some.yaml"});
List<StyleError> errorList = Main.validate(optionManager, commandLine);
namingErrorsAssertions(errorList, "camelCase", "camelCase", "hyphen-case");
}
@Test
void validateWithAlternativeNamingOptionTestShouldReturnNamingErrors() throws Exception {
OptionManager optionManager = new OptionManager(outputUtils);
Options options = optionManager.getOptions();
CommandLine commandLine = parser.parse(options, new String[]{"-s", "src/test/resources/some.yaml", "-o", "src/test/resources/alternative.json"});
List<StyleError> errorList = Main.validate(optionManager, commandLine);
namingErrorsAssertions(errorList, "hyphen-case", "hyphen-case", "camelCase");
}
@Test
void validateWithUnderscoreNamingOptionTestShouldReturnNoError() throws Exception {
OptionManager optionManager = new OptionManager(outputUtils);
Options options = optionManager.getOptions();
CommandLine commandLine = parser.parse(options, new String[]{"-s", "src/test/resources/some.yaml", "-o", "src/test/resources/underscore.json"});
List<StyleError> errorList = Main.validate(optionManager, commandLine);
assertEquals(0, errorList.size());
}
@Test
void validateWithAlternativeLegacyNamingOptionTestShouldReturnNamingErrors() throws Exception {
OptionManager optionManager = new OptionManager(outputUtils);
Options options = optionManager.getOptions();
CommandLine commandLine = parser.parse(options, new String[]{"-s", "src/test/resources/some.yaml", "-o", "src/test/resources/alternativeLegacy.json"});
List<StyleError> errorList = Main.validate(optionManager, commandLine);
namingErrorsAssertions(errorList, "hyphen-case", "hyphen-case", "camelCase");
}
@Test
void validateWithAlternativeAndLegacyNamingOptionTestShouldReturnNamingErrors() throws Exception {
OptionManager optionManager = new OptionManager(outputUtils);
Options options = optionManager.getOptions();
CommandLine commandLine = parser.parse(options, new String[]{"-s", "src/test/resources/some.yaml", "-o", "src/test/resources/alternativeAndLegacy.json"});
List<StyleError> errorList = Main.validate(optionManager, commandLine);
namingErrorsAssertions(errorList, "hyphen-case", "hyphen-case", "camelCase");
}
@Test
void validateWithUnderscoreLegacyNamingOptionTestShouldReturnNoError() throws Exception {
OptionManager optionManager = new OptionManager(outputUtils);
Options options = optionManager.getOptions();
CommandLine commandLine = parser.parse(options, new String[]{"-s", "src/test/resources/some.yaml", "-o", "src/test/resources/underscoreLegacy.json"});
List<StyleError> errorList = Main.validate(optionManager, commandLine);
assertEquals(0, errorList.size());
}
private void namingErrorsAssertions(List<StyleError> errorList, String expectedPathParameterConvention, String expectedQueryParameterConvention, String expectedPathConvention) throws MultipleFailuresError {
Assertions.assertAll(
() -> assertEquals(3, errorList.size()),
() -> assertEquals("*ERROR* in path POST /some_path/{some_id} 'some_id' -> parameter should be in " + expectedPathParameterConvention, errorList.get(0).toString()),
() -> assertEquals("*ERROR* in path POST /some_path/{some_id} 'some_name' -> parameter should be in " + expectedQueryParameterConvention, errorList.get(1).toString()),
() -> assertEquals("*ERROR* in path /some_path/{some_id} 'some_path' -> path should be in " + expectedPathConvention, errorList.get(2).toString())
);
}
@Test
void defaultJsonFileContainsConstants() throws Exception {
InputStream stream = getClass().getResourceAsStream("/default.json");
String content = IOUtils.toString(stream, StandardCharsets.UTF_8);
StringBuilder sb = new StringBuilder();
sb.append("{");
sb.append(System.lineSeparator());
sb.append(PREFIX);
sb.append(ValidatorParameters.VALIDATE_INFO_LICENSE);
sb.append(SEPARATOR);
sb.append("true");
sb.append(NEXT_LINE);
sb.append(PREFIX);
sb.append(ValidatorParameters.VALIDATE_INFO_DESCRIPTION);
sb.append(SEPARATOR);
sb.append("true");
sb.append(NEXT_LINE);
sb.append(PREFIX);
sb.append(ValidatorParameters.VALIDATE_INFO_CONTACT);
sb.append(SEPARATOR);
sb.append("true");
sb.append(NEXT_LINE);
sb.append(PREFIX);
sb.append(ValidatorParameters.VALIDATE_OPERATION_OPERATION_ID);
sb.append(SEPARATOR);
sb.append("true");
sb.append(NEXT_LINE);
sb.append(PREFIX);
sb.append(ValidatorParameters.VALIDATE_OPERATION_DESCRIPTION);
sb.append(SEPARATOR);
sb.append("true");
sb.append(NEXT_LINE);
sb.append(PREFIX);
sb.append(ValidatorParameters.VALIDATE_OPERATION_TAG);
sb.append(SEPARATOR);
sb.append("true");
sb.append(NEXT_LINE);
sb.append(PREFIX);
sb.append(ValidatorParameters.VALIDATE_OPERATION_SUMMARY);
sb.append(SEPARATOR);
sb.append("true");
sb.append(NEXT_LINE);
sb.append(PREFIX);
sb.append(ValidatorParameters.VALIDATE_MODEL_PROPERTIES_EXAMPLE);
sb.append(SEPARATOR);
sb.append("true");
sb.append(NEXT_LINE);
sb.append(PREFIX);
sb.append(ValidatorParameters.VALIDATE_MODEL_PROPERTIES_DESCRIPTION);
sb.append(SEPARATOR);
sb.append("true");
sb.append(NEXT_LINE);
sb.append(PREFIX);
sb.append(ValidatorParameters.VALIDATE_MODEL_REQUIRED_PROPERTIES);
sb.append(SEPARATOR);
sb.append("true");
sb.append(NEXT_LINE);
sb.append(PREFIX);
sb.append(ValidatorParameters.VALIDATE_MODEL_NO_LOCAL_DEF);
sb.append(SEPARATOR);
sb.append("true");
sb.append(NEXT_LINE);
sb.append(PREFIX);
sb.append(ValidatorParameters.VALIDATE_NAMING);
sb.append(SEPARATOR);
sb.append("true");
sb.append(NEXT_LINE);
sb.append(PREFIX);
sb.append(ValidatorParameters.IGNORE_HEADER_X_NAMING);
sb.append(SEPARATOR);
sb.append("true");
sb.append(NEXT_LINE);
sb.append(PREFIX);
sb.append(ValidatorParameters.PATH_NAMING_CONVENTION);
sb.append(SEPARATOR_QUOTE);
sb.append(NamingConvention.HyphenCase);
sb.append(NEXT_LINE_QUOTE);
sb.append(PREFIX);
sb.append(ValidatorParameters.HEADER_NAMING_CONVENTION);
sb.append(SEPARATOR_QUOTE);
sb.append(NamingConvention.UnderscoreUpperCase);
sb.append(NEXT_LINE_QUOTE);
sb.append(PREFIX);
sb.append(ValidatorParameters.PARAMETER_NAMING_CONVENTION);
sb.append(SEPARATOR_QUOTE);
sb.append(NamingConvention.CamelCase);
sb.append(NEXT_LINE_QUOTE);
sb.append(PREFIX);
sb.append(ValidatorParameters.PROPERTY_NAMING_CONVENTION);
sb.append(SEPARATOR_QUOTE);
sb.append(NamingConvention.CamelCase);
sb.append("\"");
sb.append(System.lineSeparator());
sb.append("}");
assertEquals(sb.toString(), content);
}
@Test
void validateShouldThrowIllegalArgumentExceptionForInvalidPathNamingConvention() throws ParseException {
OptionManager optionManager = new OptionManager(outputUtils);
Options options = optionManager.getOptions();
CommandLine commandLine = parser.parse(options, new String[]{
"-s", "src/test/resources/some.yaml",
"-o", "src/test/resources/invalidPathNamingConvention.json"
});
IllegalArgumentException thrown = Assertions.assertThrows(IllegalArgumentException.class, () -> {
Main.validate(optionManager, commandLine);
});
Assertions.assertEquals("Invalid pathNamingConvention", thrown.getMessage());
}
@Test
void validateShouldThrowIllegalArgumentExceptionForInvalidParameterNamingConvention() throws ParseException {
OptionManager optionManager = new OptionManager(outputUtils);
Options options = optionManager.getOptions();
CommandLine commandLine = parser.parse(options, new String[]{
"-s", "src/test/resources/some.yaml",
"-o", "src/test/resources/invalidParameterNamingConvention.json"
});
IllegalArgumentException thrown = Assertions.assertThrows(IllegalArgumentException.class, () -> {
Main.validate(optionManager, commandLine);
});
Assertions.assertEquals("Invalid parameterNamingConvention", thrown.getMessage());
}
@Test
void validateShouldThrowIllegalArgumentExceptionForInvalidHeaderNamingConvention() throws ParseException {
OptionManager optionManager = new OptionManager(outputUtils);
Options options = optionManager.getOptions();
CommandLine commandLine = parser.parse(options, new String[]{
"-s", "src/test/resources/some.yaml",
"-o", "src/test/resources/invalidHeaderNamingConvention.json"
});
IllegalArgumentException thrown = Assertions.assertThrows(IllegalArgumentException.class, () -> {
Main.validate(optionManager, commandLine);
});
Assertions.assertEquals("Invalid headerNamingConvention", thrown.getMessage());
}
@Test
void validateShouldThrowIllegalArgumentExceptionForInvalidPropertyNamingConvention() throws ParseException {
OptionManager optionManager = new OptionManager(outputUtils);
Options options = optionManager.getOptions();
CommandLine commandLine = parser.parse(options, new String[]{
"-s", "src/test/resources/some.yaml",
"-o", "src/test/resources/invalidPropertyNamingConvention.json"
});
IllegalArgumentException thrown = Assertions.assertThrows(IllegalArgumentException.class, () -> {
Main.validate(optionManager, commandLine);
});
Assertions.assertEquals("Invalid propertyNamingConvention", thrown.getMessage());
}
/**
* See https://github.com/OpenAPITools/openapi-style-validator/issues/190
*/
@Test
void shouldNotFailWhenThereAreNoPaths() throws Throwable {
OptionManager optionManager = new OptionManager(outputUtils);
Options options = optionManager.getOptions();
CommandLine commandLine = parser.parse(options, new String[]{
"-s", "src/test/resources/openApiWithoutPaths.yaml",
"-o", "src/test/resources/default.json"
});
// Test will fail if any exception is thrown
Main.validate(optionManager, commandLine);
}
@Test
void shouldAcceptBinaryExamples() throws Throwable {
OptionManager optionManager = new OptionManager(outputUtils);
Options options = optionManager.getOptions();
CommandLine commandLine = parser.parse(options, new String[]{
"-s", "src/test/resources/broken-validation-base64-response.yaml",
"-o", "src/test/resources/default.json"
});
List<StyleError> errors = Main.validate(optionManager, commandLine);
assertEquals(0, errors.size(), errors.toString());
}
}