2 * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.mdsal.binding.java.api.generator;
10 import static org.hamcrest.CoreMatchers.startsWith;
11 import static org.hamcrest.MatcherAssert.assertThat;
12 import static org.junit.Assert.assertEquals;
13 import static org.junit.Assert.assertFalse;
14 import static org.junit.Assert.assertThrows;
15 import static org.junit.Assert.assertTrue;
17 import com.google.common.collect.Collections2;
18 import com.google.common.collect.ImmutableList;
19 import com.google.common.collect.ImmutableSet;
20 import com.google.common.collect.Range;
22 import java.io.IOException;
23 import java.lang.annotation.Annotation;
24 import java.lang.reflect.Field;
25 import java.lang.reflect.Method;
26 import java.lang.reflect.Modifier;
27 import java.lang.reflect.ParameterizedType;
28 import java.lang.reflect.Type;
29 import java.lang.reflect.WildcardType;
30 import java.net.URISyntaxException;
32 import java.net.URLClassLoader;
33 import java.util.ArrayList;
34 import java.util.Arrays;
35 import java.util.Collection;
36 import java.util.HexFormat;
37 import java.util.List;
38 import java.util.stream.Collectors;
39 import org.junit.Test;
40 import org.opendaylight.mdsal.binding.model.ri.TypeConstants;
41 import org.opendaylight.yangtools.yang.binding.ChildOf;
42 import org.opendaylight.yangtools.yang.binding.annotations.RoutingContext;
43 import org.opendaylight.yangtools.yang.common.Decimal64;
44 import org.opendaylight.yangtools.yang.common.Empty;
45 import org.opendaylight.yangtools.yang.common.Uint16;
46 import org.opendaylight.yangtools.yang.common.Uint32;
47 import org.opendaylight.yangtools.yang.common.Uint64;
48 import org.opendaylight.yangtools.yang.common.Uint8;
51 * Test correct code generation.
54 public class CompilationTest extends BaseCompilationTest {
57 * Java 8 allows JaCoCo to hook onto interfaces, as well as
58 * generating a default implementation. We only want to check
61 private static Collection<Method> abstractMethods(final Class<?> clazz) {
63 return Collections2.filter(Arrays.asList(clazz.getDeclaredMethods()),
64 input -> Modifier.isAbstract(input.getModifiers()));
68 public void testListGeneration() throws Exception {
69 final File sourcesOutputDir = CompilationTestUtils.generatorOutput("list-gen");
70 final File compiledOutputDir = CompilationTestUtils.compilerOutput("list-gen");
71 generateTestSources("/compilation/list-gen", sourcesOutputDir);
73 // Test if all sources are generated
74 File parent = new File(sourcesOutputDir, CompilationTestUtils.NS_TEST);
75 final File keyArgs = new File(parent, "KeyArgs.java");
76 final File links = new File(parent, "Links.java");
77 final File linksBuilder = new File(parent, "LinksBuilder.java");
78 final File linksKey = new File(parent, "LinksKey.java");
79 final File testData = new File(parent, "TestData.java");
80 assertTrue(keyArgs.exists());
81 assertTrue(links.exists());
82 assertTrue(linksBuilder.exists());
83 assertTrue(linksKey.exists());
84 assertTrue(testData.exists());
85 CompilationTestUtils.assertFilesCount(parent, 7);
87 parent = new File(sourcesOutputDir, CompilationTestUtils.NS_TEST + CompilationTestUtils.FS + "links");
88 final File level = new File(parent, "Level.java");
89 final File linkGroup = new File(parent, "LinkGroup.java");
90 final File node = new File(parent, "Node.java");
91 final File nodeBuilder = new File(parent, "NodeBuilder.java");
92 final File nodeList = new File(parent, "NodeList.java");
93 final File nodeListBuilder = new File(parent, "NodeListBuilder.java");
94 final File nodesType = new File(parent, "NodesType.java");
95 assertTrue(level.exists());
96 assertTrue(linkGroup.exists());
97 assertTrue(node.exists());
98 assertTrue(nodeBuilder.exists());
99 assertTrue(nodeList.exists());
100 assertTrue(nodeListBuilder.exists());
101 assertTrue(nodesType.exists());
102 CompilationTestUtils.assertFilesCount(parent, 8);
104 // Test if sources are compilable
105 CompilationTestUtils.testCompilation(sourcesOutputDir, compiledOutputDir);
107 final ClassLoader loader = new URLClassLoader(new URL[] { compiledOutputDir.toURI().toURL() });
108 final Class<?> keyArgsClass = Class.forName(CompilationTestUtils.BASE_PKG
109 + ".urn.opendaylight.test.rev131008.KeyArgs", true, loader);
110 final Class<?> linksClass = Class.forName(CompilationTestUtils.BASE_PKG
111 + ".urn.opendaylight.test.rev131008.Links", true, loader);
112 final Class<?> linksKeyClass = Class.forName(CompilationTestUtils.BASE_PKG
113 + ".urn.opendaylight.test.rev131008.LinksKey", true, loader);
115 // Test generated 'grouping key-args'
116 assertTrue(keyArgsClass.isInterface());
117 CompilationTestUtils.assertContainsMethod(keyArgsClass, String.class, "getName");
118 CompilationTestUtils.assertContainsMethod(keyArgsClass, Integer.class, "getSize");
119 assertEquals(3, abstractMethods(keyArgsClass).size());
121 // Test generated 'list links'
122 assertTrue(linksClass.isInterface());
123 CompilationTestUtils.assertImplementsIfc(linksClass, keyArgsClass);
124 assertEquals(8, abstractMethods(linksClass).size());
125 CompilationTestUtils.assertContainsMethod(linksClass,
126 "org.opendaylight.yang.gen.v1.urn.opendaylight.test.rev131008.links.Text", "getText", loader);
127 CompilationTestUtils.assertContainsMethod(linksClass,
128 "org.opendaylight.yang.gen.v1.urn.opendaylight.test.rev131008.links.Text", "requireText", loader);
130 // Test list key constructor arguments ordering
131 CompilationTestUtils.assertContainsConstructor(linksKeyClass, Byte.class, String.class, Integer.class);
132 // Test serialVersionUID generation
133 final Field suid = CompilationTestUtils.assertContainsField(linksKeyClass, "serialVersionUID", Long.TYPE);
134 suid.setAccessible(true);
135 assertEquals(-8829501012356283881L, suid.getLong(null));
137 CompilationTestUtils.cleanUp(sourcesOutputDir, compiledOutputDir);
141 * Test that nonnull getter method is generated for non-presence containers only.
143 * @throws Exception when any exception occurs during the test
146 public void testContainerGettersGeneration() throws Exception {
147 final File sourcesOutputDir = CompilationTestUtils.generatorOutput("containers-gen");
148 final File compiledOutputDir = CompilationTestUtils.compilerOutput("containers-gen");
149 generateTestSources("/compilation/containers-gen", sourcesOutputDir);
151 // Test if all sources were generated from 'module containers'
152 File parent = new File(sourcesOutputDir, CompilationTestUtils.NS_TEST);
153 assertTrue(new File(parent, "RootContainer.java").exists());
154 assertTrue(new File(parent, "rootcontainer/PresenceContainer.java").exists());
155 assertTrue(new File(parent, "rootcontainer/NonPresenceContainer.java").exists());
156 CompilationTestUtils.assertFilesCount(parent, 5);
158 // Test if sources are compilable
159 CompilationTestUtils.testCompilation(sourcesOutputDir, compiledOutputDir);
161 final ClassLoader loader = new URLClassLoader(new URL[] { compiledOutputDir.toURI().toURL() });
162 final Class<?> rootClass = Class.forName(CompilationTestUtils.BASE_PKG
163 + ".urn.opendaylight.test.rev131008.RootContainer", true, loader);
165 // Test generated 'container root'
166 assertTrue(rootClass.isInterface());
167 assertEquals(3, abstractMethods(rootClass).size());
169 // Test generated getter and not-generated nonnull method for presence container
170 CompilationTestUtils.assertContainsMethod(rootClass,
171 "org.opendaylight.yang.gen.v1.urn.opendaylight.test.rev131008.rootcontainer.PresenceContainer",
172 "getPresenceContainer", loader);
173 final var error = assertThrows(AssertionError.class, () ->
174 CompilationTestUtils.assertContainsMethod(rootClass,
175 "org.opendaylight.yang.gen.v1.urn.opendaylight.test.rev131008.rootcontainer.PresenceContainer",
176 "nonnullPresenceContainer", loader));
177 assertTrue(error.getCause() instanceof NoSuchMethodException);
179 // Test generated getter and nonnull methods for non-presence container
180 CompilationTestUtils.assertContainsMethod(rootClass,
181 "org.opendaylight.yang.gen.v1.urn.opendaylight.test.rev131008.rootcontainer.NonPresenceContainer",
182 "getNonPresenceContainer", loader);
183 CompilationTestUtils.assertContainsMethod(rootClass,
184 "org.opendaylight.yang.gen.v1.urn.opendaylight.test.rev131008.rootcontainer.NonPresenceContainer",
185 "nonnullNonPresenceContainer", loader);
187 CompilationTestUtils.cleanUp(sourcesOutputDir, compiledOutputDir);
191 public void testAugmentUnderUsesGeneration() throws Exception {
192 final File sourcesOutputDir = CompilationTestUtils.generatorOutput("augment-under-uses");
193 final File compiledOutputDir = CompilationTestUtils.compilerOutput("augment-under-uses");
194 generateTestSources("/compilation/augment-under-uses", sourcesOutputDir);
196 // Test if all sources were generated from 'module foo'
197 File parent = new File(sourcesOutputDir, CompilationTestUtils.NS_FOO);
198 assertTrue(new File(parent, "Object.java").exists());
199 assertTrue(new File(parent, "ClosedObject.java").exists());
200 assertTrue(new File(parent, "OpenObject.java").exists());
201 assertTrue(new File(parent, "ExplicitRouteObject.java").exists());
202 assertTrue(new File(parent, "PathKeySubobject.java").exists());
203 assertTrue(new File(parent, "FooData.java").exists());
204 CompilationTestUtils.assertFilesCount(parent, 11);
206 parent = new File(parent, "object");
207 assertTrue(new File(parent, "Nodes.java").exists());
208 assertTrue(new File(parent, "NodesBuilder.java").exists());
209 CompilationTestUtils.assertFilesCount(parent, 2);
211 parent = new File(sourcesOutputDir, CompilationTestUtils.NS_FOO + CompilationTestUtils.FS + "closed");
212 CompilationTestUtils.assertFilesCount(parent, 1);
214 parent = new File(parent, "object");
215 assertTrue(new File(parent, "Link1.java").exists());
216 assertTrue(new File(parent, "Link1Builder.java").exists());
217 CompilationTestUtils.assertFilesCount(parent, 2);
219 parent = new File(sourcesOutputDir, CompilationTestUtils.NS_FOO + CompilationTestUtils.FS + "open");
220 CompilationTestUtils.assertFilesCount(parent, 1);
222 parent = new File(parent, "object");
223 assertTrue(new File(parent, "Nodes1.java").exists());
224 assertTrue(new File(parent, "Nodes1Builder.java").exists());
225 CompilationTestUtils.assertFilesCount(parent, 3);
227 parent = new File(parent, "nodes");
228 assertTrue(new File(parent, "Links.java").exists());
229 assertTrue(new File(parent, "LinksBuilder.java").exists());
230 CompilationTestUtils.assertFilesCount(parent, 2);
232 parent = new File(sourcesOutputDir, CompilationTestUtils.NS_FOO + CompilationTestUtils.FS + "explicit");
233 CompilationTestUtils.assertFilesCount(parent, 1);
234 parent = new File(parent, "route");
235 CompilationTestUtils.assertFilesCount(parent, 1);
236 parent = new File(parent, "object");
237 assertTrue(new File(parent, "Subobjects.java").exists());
238 assertTrue(new File(parent, "SubobjectsBuilder.java").exists());
239 CompilationTestUtils.assertFilesCount(parent, 3);
241 parent = new File(parent, "subobjects");
242 CompilationTestUtils.assertFilesCount(parent, 1);
243 parent = new File(parent, "subobject");
244 CompilationTestUtils.assertFilesCount(parent, 1);
245 parent = new File(parent, "type");
246 assertTrue(new File(parent, "PathKey.java").exists());
247 assertTrue(new File(parent, "PathKeyBuilder.java").exists());
248 CompilationTestUtils.assertFilesCount(parent, 3);
250 parent = new File(parent, "path");
251 CompilationTestUtils.assertFilesCount(parent, 1);
252 parent = new File(parent, "key");
253 assertTrue(new File(parent, "PathKey.java").exists());
254 assertTrue(new File(parent, "PathKeyBuilder.java").exists());
255 CompilationTestUtils.assertFilesCount(parent, 2);
257 // Test if all sources were generated from 'module bar'
258 parent = new File(sourcesOutputDir, CompilationTestUtils.NS_BAR);
259 assertTrue(new File(parent, "BarData.java").exists());
260 assertTrue(new File(parent, "BasicExplicitRouteSubobjects.java").exists());
261 assertTrue(new File(parent, "ExplicitRouteSubobjects.java").exists());
262 assertTrue(new File(parent, "RouteSubobjects.java").exists());
263 CompilationTestUtils.assertFilesCount(parent, 7);
265 parent = new File(parent, "route");
266 CompilationTestUtils.assertFilesCount(parent, 1);
267 parent = new File(new File(sourcesOutputDir, CompilationTestUtils.NS_BAR), "basic");
268 CompilationTestUtils.assertFilesCount(parent, 1);
269 parent = new File(parent, "explicit");
270 CompilationTestUtils.assertFilesCount(parent, 1);
271 parent = new File(parent, "route");
272 CompilationTestUtils.assertFilesCount(parent, 1);
274 parent = new File(parent, "subobjects");
275 CompilationTestUtils.assertFilesCount(parent, 2);
276 assertTrue(new File(parent, "SubobjectType.java").exists());
278 parent = new File(parent, "subobject");
279 CompilationTestUtils.assertFilesCount(parent, 1);
281 parent = new File(parent, "type");
282 assertTrue(new File(parent, "IpPrefix.java").exists());
283 assertTrue(new File(parent, "IpPrefixBuilder.java").exists());
284 assertTrue(new File(parent, "Label.java").exists());
285 assertTrue(new File(parent, "LabelBuilder.java").exists());
286 CompilationTestUtils.assertFilesCount(parent, 4);
288 // Test if sources are compilable
289 CompilationTestUtils.testCompilation(sourcesOutputDir, compiledOutputDir);
291 CompilationTestUtils.cleanUp(sourcesOutputDir, compiledOutputDir);
295 public void testAugmentOfAugmentGeneration() throws Exception {
296 final File sourcesOutputDir = CompilationTestUtils.generatorOutput("aug-of-aug");
297 final File compiledOutputDir = CompilationTestUtils.compilerOutput("aug-of-aug");
298 generateTestSources("/compilation/augment-of-augment", sourcesOutputDir);
300 // Test if all sources were generated from 'module foo'
301 File parent = new File(sourcesOutputDir, CompilationTestUtils.NS_FOO);
302 assertTrue(new File(parent, "FooData.java").exists());
303 assertTrue(new File(parent, "FooListener.java").exists());
304 assertTrue(new File(parent, "PathAttributes.java").exists());
305 assertTrue(new File(parent, "Update.java").exists());
306 assertTrue(new File(parent, "UpdateBuilder.java").exists());
307 CompilationTestUtils.assertFilesCount(parent, 8);
309 parent = new File(sourcesOutputDir, CompilationTestUtils.NS_FOO + CompilationTestUtils.FS + "path");
310 CompilationTestUtils.assertFilesCount(parent, 1);
311 parent = new File(parent, "attributes");
312 CompilationTestUtils.assertFilesCount(parent, 2);
313 final File origin = new File(parent, "Origin.java");
314 final File originBuilder = new File(parent, "OriginBuilder.java");
315 assertTrue(origin.exists());
316 assertTrue(originBuilder.exists());
318 parent = new File(sourcesOutputDir, CompilationTestUtils.NS_FOO + CompilationTestUtils.FS + "update");
319 CompilationTestUtils.assertFilesCount(parent, 2);
320 assertTrue(new File(parent, "PathAttributes.java").exists());
321 assertTrue(new File(parent, "PathAttributesBuilder.java").exists());
323 // Test if all sources were generated from 'module bar'
324 parent = new File(sourcesOutputDir, CompilationTestUtils.NS_BAR);
325 assertTrue(new File(parent, "BarData.java").exists());
326 assertTrue(new File(parent, "Destination.java").exists());
327 assertTrue(new File(parent, "PathAttributes1.java").exists());
328 assertTrue(new File(parent, "PathAttributes1Builder.java").exists());
329 CompilationTestUtils.assertFilesCount(parent, 7);
331 parent = new File(sourcesOutputDir, CompilationTestUtils.NS_BAR + CompilationTestUtils.FS + "destination");
332 CompilationTestUtils.assertFilesCount(parent, 2);
333 final File destinationType = new File(parent, "DestinationType.java");
334 assertTrue(destinationType.exists());
336 parent = new File(parent, "destination");
337 CompilationTestUtils.assertFilesCount(parent, 1);
338 parent = new File(parent, "type");
339 CompilationTestUtils.assertFilesCount(parent, 2);
340 final File destinationIpv4 = new File(parent, "DestinationIp.java");
341 final File destinationIpv4Builder = new File(parent, "DestinationIpBuilder.java");
342 assertTrue(destinationIpv4.exists());
343 assertTrue(destinationIpv4Builder.exists());
345 parent = new File(sourcesOutputDir, CompilationTestUtils.NS_BAR + CompilationTestUtils.FS + "update");
346 CompilationTestUtils.assertFilesCount(parent, 1);
347 parent = new File(parent, "path");
348 CompilationTestUtils.assertFilesCount(parent, 1);
349 parent = new File(parent, "attributes");
350 final File mpUnreachNlri = new File(parent, "MpUnreachNlri.java");
351 final File mpUnreachNlriBuilder = new File(parent, "MpUnreachNlriBuilder.java");
352 assertTrue(mpUnreachNlri.exists());
353 assertTrue(mpUnreachNlriBuilder.exists());
354 CompilationTestUtils.assertFilesCount(parent, 3);
356 parent = new File(parent, "mp");
357 CompilationTestUtils.assertFilesCount(parent, 1);
358 parent = new File(parent, "unreach");
359 CompilationTestUtils.assertFilesCount(parent, 1);
360 parent = new File(parent, "nlri");
361 assertTrue(new File(parent, "WithdrawnRoutes.java").exists());
362 assertTrue(new File(parent, "WithdrawnRoutesBuilder.java").exists());
363 CompilationTestUtils.assertFilesCount(parent, 2);
365 // Test if all sources were generated from 'module baz'
366 parent = new File(sourcesOutputDir, CompilationTestUtils.NS_BAZ);
367 assertTrue(new File(parent, "BazData.java").exists());
368 assertTrue(new File(parent, "LinkstateDestination.java").exists());
369 CompilationTestUtils.assertFilesCount(parent, 4);
371 parent = new File(sourcesOutputDir, CompilationTestUtils.NS_BAZ + CompilationTestUtils.FS + "update");
372 CompilationTestUtils.assertFilesCount(parent, 1);
373 parent = new File(parent, "path");
374 CompilationTestUtils.assertFilesCount(parent, 1);
375 parent = new File(parent, "attributes");
376 CompilationTestUtils.assertFilesCount(parent, 1);
377 parent = new File(parent, "mp");
378 CompilationTestUtils.assertFilesCount(parent, 1);
379 parent = new File(parent, "unreach");
380 CompilationTestUtils.assertFilesCount(parent, 1);
381 parent = new File(parent, "nlri");
382 CompilationTestUtils.assertFilesCount(parent, 1);
383 parent = new File(parent, "withdrawn");
384 CompilationTestUtils.assertFilesCount(parent, 1);
385 parent = new File(parent, "routes");
386 CompilationTestUtils.assertFilesCount(parent, 1);
387 parent = new File(parent, "destination");
388 CompilationTestUtils.assertFilesCount(parent, 1);
389 parent = new File(parent, "type");
390 final File destinationLinkstate = new File(parent, "DestinationLinkstate.java");
391 final File destinationLinkstateBuilder = new File(parent, "DestinationLinkstateBuilder.java");
392 assertTrue(destinationLinkstate.exists());
393 assertTrue(destinationLinkstateBuilder.exists());
394 CompilationTestUtils.assertFilesCount(parent, 3);
395 parent = new File(parent, "destination");
396 CompilationTestUtils.assertFilesCount(parent, 1);
397 parent = new File(parent, "linkstate");
398 final File links = new File(parent, "Links.java");
399 final File linksBuilder = new File(parent, "LinksBuilder.java");
400 assertTrue(links.exists());
401 assertTrue(linksBuilder.exists());
402 CompilationTestUtils.assertFilesCount(parent, 3);
403 parent = new File(parent, "links");
404 final File source = new File(parent, "Source.java");
405 final File sourceBuilder = new File(parent, "SourceBuilder.java");
406 assertTrue(source.exists());
407 assertTrue(sourceBuilder.exists());
408 CompilationTestUtils.assertFilesCount(parent, 3);
409 parent = new File(parent, "source");
410 final File address = new File(parent, "Address.java");
411 final File addressBuilder = new File(parent, "AddressBuilder.java");
412 assertTrue(address.exists());
413 assertTrue(addressBuilder.exists());
414 CompilationTestUtils.assertFilesCount(parent, 2);
416 // Test if sources are compilable
417 CompilationTestUtils.testCompilation(sourcesOutputDir, compiledOutputDir);
419 CompilationTestUtils.cleanUp(sourcesOutputDir, compiledOutputDir);
423 public void testLeafReturnTypes() throws Exception {
424 final File sourcesOutputDir = CompilationTestUtils.generatorOutput("leaf-return-types");
425 final File compiledOutputDir = CompilationTestUtils.compilerOutput("leaf-return-types");
426 generateTestSources("/compilation/leaf-return-types", sourcesOutputDir);
428 final File parent = new File(sourcesOutputDir, CompilationTestUtils.NS_TEST);
429 assertTrue(new File(parent, "TestData.java").exists());
430 assertTrue(new File(parent, "Nodes.java").exists());
431 assertTrue(new File(parent, "NodesBuilder.java").exists());
432 assertTrue(new File(parent, "Alg.java").exists());
433 CompilationTestUtils.assertFilesCount(parent, 5);
435 // Test if sources are compilable
436 CompilationTestUtils.testCompilation(sourcesOutputDir, compiledOutputDir);
438 final String pkg = CompilationTestUtils.BASE_PKG + ".urn.opendaylight.test.rev131008";
439 final ClassLoader loader = new URLClassLoader(new URL[] { compiledOutputDir.toURI().toURL() });
440 final Class<?> nodesClass = Class.forName(pkg + ".Nodes", true, loader);
441 final Class<?> builderClass = Class.forName(pkg + ".NodesBuilder", true, loader);
443 // Test methods return type
444 final byte[] b = new byte[] {};
445 CompilationTestUtils.assertContainsMethod(nodesClass, b.getClass(), "getIdBinary");
446 CompilationTestUtils.assertContainsMethod(nodesClass, pkg + ".Nodes$IdBits", "getIdBits", loader);
447 CompilationTestUtils.assertContainsMethod(nodesClass, Boolean.class, "getIdBoolean");
448 CompilationTestUtils.assertContainsMethod(nodesClass, Decimal64.class, "getIdDecimal64");
449 CompilationTestUtils.assertContainsMethod(nodesClass, Empty.class, "getIdEmpty");
450 CompilationTestUtils.assertContainsMethod(nodesClass, pkg + ".Nodes$IdEnumeration", "getIdEnumeration", loader);
451 testReturnTypeIdentityref(nodesClass, "getIdIdentityref", pkg + ".Alg");
452 testReturnTypeInstanceIdentitifer(loader, nodesClass, "getIdInstanceIdentifier");
453 CompilationTestUtils.assertContainsMethod(nodesClass, Byte.class, "getId8");
454 CompilationTestUtils.assertContainsMethod(nodesClass, Short.class, "getId16");
455 CompilationTestUtils.assertContainsMethod(nodesClass, Integer.class, "getId32");
456 CompilationTestUtils.assertContainsMethod(nodesClass, Long.class, "getId64");
457 CompilationTestUtils.assertContainsMethod(nodesClass, Long.class, "getIdLeafref");
458 CompilationTestUtils.assertContainsMethod(nodesClass, String.class, "getIdString");
459 CompilationTestUtils.assertContainsMethod(nodesClass, Uint8.class, "getIdU8");
460 CompilationTestUtils.assertContainsMethod(nodesClass, Uint16.class, "getIdU16");
461 CompilationTestUtils.assertContainsMethod(nodesClass, Uint32.class, "getIdU32");
462 CompilationTestUtils.assertContainsMethod(nodesClass, Uint64.class, "getIdU64");
463 CompilationTestUtils.assertContainsMethod(nodesClass, pkg + ".Nodes$IdUnion", "getIdUnion", loader);
465 final Object builderObj = builderClass.getDeclaredConstructor().newInstance();
467 Method method = CompilationTestUtils.assertContainsMethod(builderClass, builderClass, "setIdBinary",
469 final List<Range<Integer>> lengthConstraints = new ArrayList<>();
470 lengthConstraints.add(Range.closed(1, 10));
471 byte[] arg = new byte[] {};
472 String expectedMsg = String.format("Invalid length: %s, expected: %s.", HexFormat.of().formatHex(arg),
474 CompilationTestUtils.assertContainsRestrictionCheck(builderObj, method, expectedMsg, arg);
476 method = CompilationTestUtils.assertContainsMethod(builderClass, builderClass, "setIdDecimal64",
478 final List<Range<Decimal64>> rangeConstraints = new ArrayList<>();
479 rangeConstraints.add(Range.closed(Decimal64.valueOf("1.5"), Decimal64.valueOf("5.5")));
480 Object arg1 = Decimal64.valueOf("1.4");
481 expectedMsg = String.format("Invalid range: %s, expected: %s.", arg1, rangeConstraints);
482 CompilationTestUtils.assertContainsRestrictionCheck(builderObj, method, expectedMsg, arg1);
484 CompilationTestUtils.cleanUp(sourcesOutputDir, compiledOutputDir);
488 public void testGenerationContextReferenceExtension() throws IOException, URISyntaxException,
489 ClassNotFoundException {
490 final File sourcesOutputDir = CompilationTestUtils.generatorOutput("context-reference");
491 final File compiledOutputDir = CompilationTestUtils.compilerOutput("context-reference");
492 generateTestSources("/compilation/context-reference", sourcesOutputDir);
494 // Test if all sources are generated
495 final File fooParent = new File(sourcesOutputDir, CompilationTestUtils.NS_FOO);
496 CompilationTestUtils.assertFilesCount(fooParent, 4);
497 assertTrue(new File(fooParent, "FooData.java").exists());
498 assertTrue(new File(fooParent, "Nodes.java").exists());
499 assertTrue(new File(fooParent, "NodesBuilder.java").exists());
501 final File barParent = new File(sourcesOutputDir, CompilationTestUtils.NS_BAR);
502 CompilationTestUtils.assertFilesCount(barParent, 3);
503 assertTrue(new File(barParent, "BarData.java").exists());
504 assertTrue(new File(barParent, "IdentityClass.java").exists());
506 // Test if sources are compilable
507 CompilationTestUtils.testCompilation(sourcesOutputDir, compiledOutputDir);
509 final ClassLoader loader = new URLClassLoader(new URL[] { compiledOutputDir.toURI().toURL() });
510 final Class<?> nodesClass = Class.forName(CompilationTestUtils.BASE_PKG
511 + ".urn.opendaylight.foo.rev131008.Nodes", true, loader);
512 final Class<?> identityClass = Class
513 .forName(CompilationTestUtils.BASE_PKG + ".urn.opendaylight.bar.rev131008.IdentityClass", true, loader);
516 final Class<?> baseIdentity = Class.forName("org.opendaylight.yangtools.yang.binding.BaseIdentity", true,
518 assertEquals(ImmutableList.of(baseIdentity), Arrays.asList(identityClass.getInterfaces()));
523 getId = nodesClass.getMethod("getId");
524 } catch (final NoSuchMethodException e) {
525 throw new AssertionError("Method getId() not found", e);
528 assertEquals(ImmutableSet.of(RoutingContext.class), Arrays.stream(getId.getAnnotations())
529 .map(Annotation::annotationType).collect(Collectors.toSet()));
530 CompilationTestUtils.cleanUp(sourcesOutputDir, compiledOutputDir);
534 public void compilationTest() throws Exception {
535 final File sourcesOutputDir = CompilationTestUtils.generatorOutput("yang");
536 final File compiledOutputDir = CompilationTestUtils.compilerOutput("yang");
537 generateTestSources("/yang", sourcesOutputDir);
539 // Test if sources are compilable
540 CompilationTestUtils.testCompilation(sourcesOutputDir, compiledOutputDir);
542 CompilationTestUtils.cleanUp(sourcesOutputDir, compiledOutputDir);
546 public void testBug586() throws Exception {
547 final File sourcesOutputDir = CompilationTestUtils.generatorOutput("bug586");
548 final File compiledOutputDir = CompilationTestUtils.compilerOutput("bug586");
549 generateTestSources("/compilation/bug586", sourcesOutputDir);
551 // Test if sources are compilable
552 CompilationTestUtils.testCompilation(sourcesOutputDir, compiledOutputDir);
554 CompilationTestUtils.cleanUp(sourcesOutputDir, compiledOutputDir);
558 public void testBug4760() throws Exception {
559 final File sourcesOutputDir = CompilationTestUtils.generatorOutput("bug4760");
560 final File compiledOutputDir = CompilationTestUtils.compilerOutput("bug4760");
561 generateTestSources("/compilation/bug4760", sourcesOutputDir);
563 // Test if sources are compilable
564 CompilationTestUtils.testCompilation(sourcesOutputDir, compiledOutputDir);
566 CompilationTestUtils.cleanUp(sourcesOutputDir, compiledOutputDir);
570 * Test handling nested uses-augmentations.
573 public void testBug1172() throws Exception {
574 final File sourcesOutputDir = CompilationTestUtils.generatorOutput("bug1172");
575 final File compiledOutputDir = CompilationTestUtils.compilerOutput("bug1172");
576 generateTestSources("/compilation/bug1172", sourcesOutputDir);
578 // Test if sources are compilable
579 CompilationTestUtils.testCompilation(sourcesOutputDir, compiledOutputDir);
581 CompilationTestUtils.cleanUp(sourcesOutputDir, compiledOutputDir);
585 public void testBug5461() throws Exception {
586 final File sourcesOutputDir = CompilationTestUtils.generatorOutput("bug5461");
587 final File compiledOutputDir = CompilationTestUtils.compilerOutput("bug5461");
588 generateTestSources("/compilation/bug5461", sourcesOutputDir);
590 // Test if sources are compilable
591 CompilationTestUtils.testCompilation(sourcesOutputDir, compiledOutputDir);
593 CompilationTestUtils.cleanUp(sourcesOutputDir, compiledOutputDir);
597 public void testBug5882() throws Exception {
598 final File sourcesOutputDir = CompilationTestUtils.generatorOutput("bug5882");
599 final File compiledOutputDir = CompilationTestUtils.compilerOutput("bug5882");
600 generateTestSources("/compilation/bug5882", sourcesOutputDir);
602 // Test if sources are compilable
603 CompilationTestUtils.testCompilation(sourcesOutputDir, compiledOutputDir);
605 final File parent = new File(sourcesOutputDir, CompilationTestUtils.NS_BUG5882);
606 assertTrue(new File(parent, "FooData.java").exists());
607 assertTrue(new File(parent, "TypedefCurrent.java").exists());
608 assertTrue(new File(parent, "TypedefDeprecated.java").exists());
610 try (URLClassLoader loader = new URLClassLoader(new URL[] { compiledOutputDir.toURI().toURL() })) {
611 final String pkg = CompilationTestUtils.BASE_PKG + ".urn.yang.foo.rev160102";
612 final Class<?> cls = loader.loadClass(pkg + ".FooData");
613 final Class<?> clsContainer = loader.loadClass(pkg + ".ContainerMain");
614 final Class<?> clsTypedefDepr = loader.loadClass(pkg + ".TypedefDeprecated");
615 final Class<?> clsTypedefCur = loader.loadClass(pkg + ".TypedefCurrent");
616 final Class<?> clsGroupingDepr = loader.loadClass(pkg + ".GroupingDeprecated");
617 final Class<?> clsGroupingCur = loader.loadClass(pkg + ".GroupingCurrent");
618 final Class<?> clsTypeDef1 = loader.loadClass(pkg + ".Typedef1");
619 final Class<?> clsTypeDef2 = loader.loadClass(pkg + ".Typedef2");
620 final Class<?> clsTypeDef3 = loader.loadClass(pkg + ".Typedef3");
621 assertEquals(1, clsTypedefDepr.getAnnotations().length);
622 assertThat(clsTypedefDepr.getAnnotations()[0].toString(), startsWith("@java.lang.Deprecated"));
623 assertEquals(0, clsTypedefCur.getAnnotations().length);
624 assertEquals(1, clsGroupingDepr.getAnnotations().length);
625 assertThat(clsGroupingDepr.getAnnotations()[0].toString(), startsWith("@java.lang.Deprecated"));
626 assertEquals(0, clsGroupingCur.getAnnotations().length);
627 assertEquals(0, clsTypeDef1.getAnnotations().length);
628 assertEquals(1, clsTypeDef2.getAnnotations().length);
629 assertThat(clsTypeDef2.getAnnotations()[0].toString(), startsWith("@java.lang.Deprecated"));
630 assertEquals(0, clsTypeDef3.getAnnotations().length);
632 /*methods inside container*/
633 assertTrue(clsContainer.getMethod("getContainerMainLeafDepr").isAnnotationPresent(Deprecated.class));
634 assertTrue(clsContainer.getMethod("getContainerMainListDepr").isAnnotationPresent(Deprecated.class));
635 assertTrue(clsContainer.getMethod("getContainerMainChoiceDepr").isAnnotationPresent(Deprecated.class));
636 assertFalse(clsContainer.getMethod("getContainerMainLeafCurrent").isAnnotationPresent(Deprecated.class));
637 assertFalse(clsContainer.getMethod("getContainerMainListCurrent").isAnnotationPresent(Deprecated.class));
638 assertFalse(clsContainer.getMethod("getContainerMainChoiceCur").isAnnotationPresent(Deprecated.class));
640 /*methods inside module*/
641 assertTrue(cls.getMethod("getContainerMainLeafDepr").isAnnotationPresent(Deprecated.class));
642 assertTrue(cls.getMethod("getContainerMainListDepr").isAnnotationPresent(Deprecated.class));
643 assertTrue(cls.getMethod("getContainerMainChoiceDepr").isAnnotationPresent(Deprecated.class));
644 assertFalse(cls.getMethod("getContainerMainLeafCurrent").isAnnotationPresent(Deprecated.class));
645 assertFalse(cls.getMethod("getContainerMainListCurrent").isAnnotationPresent(Deprecated.class));
646 assertFalse(cls.getMethod("getContainerMainChoiceCur").isAnnotationPresent(Deprecated.class));
647 assertTrue(cls.getMethod("getLeafDeprecated").isAnnotationPresent(Deprecated.class));
650 CompilationTestUtils.cleanUp(sourcesOutputDir, compiledOutputDir);
654 * Test if class generated for node from grouping implements ChildOf.
657 public void testBug1377() throws Exception {
658 final File sourcesOutputDir = CompilationTestUtils.generatorOutput("bug1377");
659 final File compiledOutputDir = CompilationTestUtils.compilerOutput("bug1377");
661 generateTestSources("/compilation/bug1377", sourcesOutputDir);
663 // Test if sources are compilable
664 CompilationTestUtils.testCompilation(sourcesOutputDir, compiledOutputDir);
666 final ClassLoader loader = new URLClassLoader(new URL[] { compiledOutputDir.toURI().toURL() });
667 final Class<?> outputActionClass = Class.forName(CompilationTestUtils.BASE_PKG
668 + ".urn.test.foo.rev140717.action.action.output.action._case.OutputAction", true, loader);
669 final Class<?> actionClass = Class.forName(CompilationTestUtils.BASE_PKG + ".urn.test.foo.rev140717.Action",
672 // Test generated 'container output-action'
673 assertTrue(outputActionClass.isInterface());
674 CompilationTestUtils.assertImplementsParameterizedIfc(outputActionClass, ChildOf.class.toString(),
675 actionClass.getCanonicalName());
677 CompilationTestUtils.cleanUp(sourcesOutputDir, compiledOutputDir);
681 public void testMdsal327() throws Exception {
682 final File sourcesOutputDir = CompilationTestUtils.generatorOutput("mdsal327");
683 final File compiledOutputDir = CompilationTestUtils.compilerOutput("mdsal327");
684 generateTestSources("/compilation/mdsal327", sourcesOutputDir);
685 CompilationTestUtils.testCompilation(sourcesOutputDir, compiledOutputDir);
686 CompilationTestUtils.cleanUp(sourcesOutputDir, compiledOutputDir);
690 public void testMdsal365() throws Exception {
691 final File sourcesOutputDir = CompilationTestUtils.generatorOutput("mdsal365");
692 final File compiledOutputDir = CompilationTestUtils.compilerOutput("mdsal365");
693 generateTestSources("/compilation/mdsal365", sourcesOutputDir);
694 CompilationTestUtils.testCompilation(sourcesOutputDir, compiledOutputDir);
695 CompilationTestUtils.cleanUp(sourcesOutputDir, compiledOutputDir);
699 public void testMdsal395() throws Exception {
700 final File sourcesOutputDir = CompilationTestUtils.generatorOutput("mdsal395");
701 final File compiledOutputDir = CompilationTestUtils.compilerOutput("mdsal395");
702 generateTestSources("/compilation/mdsal395", sourcesOutputDir);
703 CompilationTestUtils.testCompilation(sourcesOutputDir, compiledOutputDir);
704 CompilationTestUtils.cleanUp(sourcesOutputDir, compiledOutputDir);
708 public void classNamesColisionTest() throws Exception {
709 final File sourcesOutputDir = CompilationTestUtils.generatorOutput("class-name-collision");
710 final File compiledOutputDir = CompilationTestUtils.compilerOutput("class-name-collision");
711 generateTestSources("/compilation/class-name-collision", sourcesOutputDir);
712 CompilationTestUtils.testCompilation(sourcesOutputDir, compiledOutputDir);
713 CompilationTestUtils.cleanUp(sourcesOutputDir, compiledOutputDir);
717 public void innerEnumerationNameCollisionTest() throws Exception {
718 final File sourcesOutputDir = CompilationTestUtils.generatorOutput("mdsal321");
719 final File compiledOutputDir = CompilationTestUtils.compilerOutput("mdsal321");
720 generateTestSources("/compilation/mdsal321", sourcesOutputDir);
721 CompilationTestUtils.testCompilation(sourcesOutputDir, compiledOutputDir);
722 CompilationTestUtils.cleanUp(sourcesOutputDir, compiledOutputDir);
726 public void twoNestedUnionsTest() throws Exception {
727 final File sourcesOutputDir = CompilationTestUtils.generatorOutput("mdsal320");
728 final File compiledOutputDir = CompilationTestUtils.compilerOutput("mdsal320");
729 generateTestSources("/compilation/mdsal320", sourcesOutputDir);
730 CompilationTestUtils.testCompilation(sourcesOutputDir, compiledOutputDir);
731 CompilationTestUtils.cleanUp(sourcesOutputDir, compiledOutputDir);
735 public void testMdsal425() throws Exception {
736 final File sourcesOutputDir = CompilationTestUtils.generatorOutput("mdsal425");
737 final File compiledOutputDir = CompilationTestUtils.compilerOutput("mdsal425");
738 generateTestSources("/compilation/mdsal425", sourcesOutputDir);
739 CompilationTestUtils.testCompilation(sourcesOutputDir, compiledOutputDir);
740 CompilationTestUtils.cleanUp(sourcesOutputDir, compiledOutputDir);
744 public void testMdsal426() throws Exception {
745 final File sourcesOutputDir = CompilationTestUtils.generatorOutput("mdsal426");
746 final File compiledOutputDir = CompilationTestUtils.compilerOutput("mdsal426");
747 generateTestSources("/compilation/mdsal426", sourcesOutputDir);
748 CompilationTestUtils.testCompilation(sourcesOutputDir, compiledOutputDir);
749 CompilationTestUtils.cleanUp(sourcesOutputDir, compiledOutputDir);
753 public void testMdsal529() throws Exception {
754 final File sourcesOutputDir = CompilationTestUtils.generatorOutput("mdsal529");
755 final File compiledOutputDir = CompilationTestUtils.compilerOutput("mdsal529");
756 generateTestSources("/compilation/mdsal529", sourcesOutputDir);
757 CompilationTestUtils.testCompilation(sourcesOutputDir, compiledOutputDir);
758 CompilationTestUtils.cleanUp(sourcesOutputDir, compiledOutputDir);
762 public void testMdsal589() throws Exception {
763 final File sourcesOutputDir = CompilationTestUtils.generatorOutput("mdsal589");
764 final File compiledOutputDir = CompilationTestUtils.compilerOutput("mdsal589");
765 generateTestSources("/compilation/mdsal589", sourcesOutputDir);
766 CompilationTestUtils.testCompilation(sourcesOutputDir, compiledOutputDir);
767 CompilationTestUtils.cleanUp(sourcesOutputDir, compiledOutputDir);
771 public void testMdsal533() throws Exception {
772 final File sourcesOutputDir = CompilationTestUtils.generatorOutput("mdsal533");
773 final File compiledOutputDir = CompilationTestUtils.compilerOutput("mdsal533");
774 generateTestSources("/compilation/mdsal533", sourcesOutputDir);
775 CompilationTestUtils.testCompilation(sourcesOutputDir, compiledOutputDir);
776 CompilationTestUtils.cleanUp(sourcesOutputDir, compiledOutputDir);
780 public void testMdsal664() throws Exception {
781 final File sourcesOutputDir = CompilationTestUtils.generatorOutput("mdsal664");
782 final File compiledOutputDir = CompilationTestUtils.compilerOutput("mdsal664");
783 generateTestSources("/compilation/mdsal664", sourcesOutputDir);
784 CompilationTestUtils.testCompilation(sourcesOutputDir, compiledOutputDir);
785 CompilationTestUtils.cleanUp(sourcesOutputDir, compiledOutputDir);
789 public void testUnionStringPatterns() throws Exception {
790 final File sourcesOutputDir = CompilationTestUtils.generatorOutput("union-string-pattern");
791 final File compiledOutputDir = CompilationTestUtils.compilerOutput("union-string-pattern");
792 generateTestSources("/compilation/union-string-pattern", sourcesOutputDir);
793 CompilationTestUtils.testCompilation(sourcesOutputDir, compiledOutputDir);
795 final ClassLoader loader = new URLClassLoader(new URL[]{compiledOutputDir.toURI().toURL()});
796 final Class<?> fooClass = Class.forName(CompilationTestUtils.BASE_PKG + ".foo.norev.Foo", true, loader);
798 final Field patterns = fooClass.getDeclaredField(TypeConstants.PATTERN_CONSTANT_NAME);
799 assertEquals(List.class, patterns.getType());
801 CompilationTestUtils.cleanUp(sourcesOutputDir, compiledOutputDir);
805 public void yangDataCompilation() throws Exception {
806 final File sourcesOutputDir = CompilationTestUtils.generatorOutput("yang-data-gen");
807 final File compiledOutputDir = CompilationTestUtils.compilerOutput("yang-data-gen");
809 generateTestSources("/compilation/yang-data-gen", sourcesOutputDir);
810 CompilationTestUtils.testCompilation(sourcesOutputDir, compiledOutputDir);
812 final ClassLoader loader = new URLClassLoader(new URL[]{compiledOutputDir.toURI().toURL()});
813 final List<String> artifactNames = List.of(
814 // module with top level container
815 "$YangModuleInfoImpl", "YangDataDemoData", "RootContainer", "RootContainerBuilder",
817 // yang-data artifacts
818 "YangDataWithContainer", "YangDataWithContainerBuilder",
819 "YangDataWithList", "YangDataWithListBuilder",
820 "YangDataWithLeaf", "YangDataWithLeafBuilder",
821 "YangDataWithLeafList", "YangDataWithLeafListBuilder",
822 "YangDataWithAnydata", "YangDataWithAnydataBuilder",
823 "YangDataWithAnyxml", "YangDataWithAnyxmlBuilder",
825 // yang-data content artifacts
826 "yang.data.with.container.ContainerFromYangData",
827 "yang.data.with.container.ContainerFromYangDataBuilder",
828 "yang.data.with.list.ListFromYangData", "yang.data.with.list.ListFromYangDataBuilder",
829 "yang.data.with.anydata.AnydataFromYangData", "yang.data.with.anyxml.AnyxmlFromYangData",
831 // yang-data artifacts using groups
832 "YangDataWithContainerFromGroup", "YangDataWithContainerFromGroupBuilder",
833 "YangDataWithListFromGroup", "YangDataWithListFromGroupBuilder",
834 "YangDataWithLeafFromGroup", "YangDataWithLeafFromGroupBuilder",
835 "YangDataWithLeafListFromGroup", "YangDataWithLeafListFromGroupBuilder",
836 "YangDataWithAnydataFromGroup", "YangDataWithAnydataFromGroupBuilder",
837 "YangDataWithAnyxmlFromGroup", "YangDataWithAnyxmlFromGroupBuilder",
840 "GrpForContainer", "GrpForList", "GrpForLeaf", "GrpForLeafList", "GrpForAnydata", "GrpForAnyxml",
842 // group content artifacts
843 "grp._for.container.ContainerFromGroup", "grp._for.container.ContainerFromGroupBuilder",
844 "grp._for.list.ListFromGroup", "grp._for.list.ListFromGroupBuilder",
845 "grp._for.anydata.AnydataFromGroup", "grp._for.anyxml.AnyxmlFromGroup",
847 // artifacts for non-ascii template naming: yang data artifact, inner container + builder
848 "$ľaľaho$20$papľuhu", "$ľaľaho$20$papľuhuBuilder",
849 "$ľaľaho$20$papľuhu$.LatinNaming", "$ľaľaho$20$papľuhu$.LatinNamingBuilder",
850 "привет", "приветBuilder", "привет$.CyrillicNaming", "привет$.CyrillicNamingBuilder"
853 for (String name : artifactNames) {
854 final String className = CompilationTestUtils.BASE_PKG + ".urn.test.yang.data.demo.rev220222." + name;
855 // ensure class source is generated
856 final String srcPath = className.replace('.', File.separatorChar) + ".java";
857 assertTrue(srcPath + " exists", new File(sourcesOutputDir, srcPath).exists());
858 // ensure class is loadable
859 Class.forName(className, true, loader);
862 CompilationTestUtils.cleanUp(sourcesOutputDir, compiledOutputDir);
865 private static void testReturnTypeIdentityref(final Class<?> clazz, final String methodName,
866 final String returnTypeStr) throws NoSuchMethodException {
867 Class<?> returnType = clazz.getMethod(methodName).getReturnType();
868 assertTrue(returnType.isInterface());
869 assertEquals(returnTypeStr, returnType.getName());
872 private static void testReturnTypeInstanceIdentitifer(final ClassLoader loader, final Class<?> clazz,
873 final String methodName) throws ClassNotFoundException, NoSuchMethodException, SecurityException {
874 final Method method = clazz.getMethod(methodName);
875 final Class<?> rawReturnType = Class.forName("org.opendaylight.yangtools.yang.binding.InstanceIdentifier", true,
877 assertEquals(rawReturnType, method.getReturnType());
878 final Type returnType = method.getGenericReturnType();
879 assertTrue(returnType instanceof ParameterizedType);
880 final ParameterizedType pt = (ParameterizedType) returnType;
881 final Type[] parameters = pt.getActualTypeArguments();
882 assertEquals(1, parameters.length);
883 final Type parameter = parameters[0];
884 assertTrue(parameter instanceof WildcardType);
885 final WildcardType wildcardType = (WildcardType) parameter;
886 assertEquals("?", wildcardType.toString());