2 * Copyright (c) 2013 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.yangtools.yang2sources.plugin.it;
10 import static org.hamcrest.CoreMatchers.containsString;
11 import static org.junit.Assert.assertThat;
12 import static org.junit.Assert.fail;
14 import com.google.common.base.Joiner;
15 import com.google.common.io.Resources;
17 import java.io.IOException;
18 import java.io.InputStream;
19 import java.net.URISyntaxException;
21 import java.nio.file.Files;
22 import java.nio.file.Path;
23 import java.util.Arrays;
24 import java.util.Optional;
25 import java.util.Properties;
26 import org.apache.maven.it.VerificationException;
27 import org.apache.maven.it.Verifier;
28 import org.junit.Test;
30 public class YangToSourcesPluginTestIT {
32 // TODO Test yang files in transitive dependencies
35 public void testYangRootNotExist() throws Exception {
36 setUp("test-parent/YangRootNotExist/", false)
37 .verifyTextInLog("[WARNING] yang-to-sources: YANG source directory");
41 public void testCorrect() throws VerificationException, URISyntaxException, IOException {
42 verifyCorrectLog(setUp("test-parent/Correct/", false));
46 public void testAdditionalConfiguration() throws Exception {
47 Verifier vrf = setUp("test-parent/AdditionalConfig/", false);
48 vrf.verifyTextInLog("[DEBUG] yang-to-sources: Additional configuration picked up for : "
49 + "org.opendaylight.yangtools.yang2sources.spi.CodeGeneratorTestImpl: "
50 + "{nm1=abcd=a.b.c.d, nm2=abcd2=a.b.c.d.2}");
51 vrf.verifyTextInLog("[DEBUG] yang-to-sources: Additional configuration picked up for : "
52 + "org.opendaylight.yangtools.yang2sources.spi.CodeGeneratorTestImpl: {c1=config}");
53 vrf.verifyTextInLog("[DEBUG] yang-to-sources: YANG files marked as resources:");
54 vrf.verifyTextInLog(Joiner.on(File.separator).join(Arrays.asList("target", "generated-sources", "spi"))
55 + " marked as resources for generator: org.opendaylight.yangtools.yang2sources.spi."
56 + "CodeGeneratorTestImpl");
60 public void testMissingYangInDep() throws Exception {
62 setUp("test-parent/MissingYangInDep/", false);
63 fail("Verification exception should have been thrown");
64 } catch (VerificationException e) {
65 assertVerificationException(e, "Imported module [unknownDep] was not found.");
70 static void verifyCorrectLog(final Verifier vrf) throws VerificationException {
71 vrf.verifyErrorFreeLog();
72 vrf.verifyTextInLog("[INFO] yang-to-sources: Project model files found: ");
73 vrf.verifyTextInLog("[INFO] yang-to-sources: Code generator instantiated from "
74 + "org.opendaylight.yangtools.yang2sources.spi.CodeGeneratorTestImpl");
75 vrf.verifyTextInLog("[INFO] yang-to-sources: Sources generated by "
76 + "org.opendaylight.yangtools.yang2sources.spi.CodeGeneratorTestImpl: 0");
80 public void testNoGenerators() throws Exception {
81 Verifier vrf = setUp("test-parent/NoGenerators/", false);
82 vrf.verifyErrorFreeLog();
83 vrf.verifyTextInLog("[WARNING] yang-to-sources: No code generators provided");
87 public void testInvalidVersion() throws Exception {
88 Verifier vrf = setUp("test-parent/InvalidVersion/", false);
89 vrf.verifyErrorFreeLog();
90 vrf.verifyTextInLog("[WARNING] yang-to-sources: Dependency resolution conflict:");
94 public void testUnknownGenerator() throws Exception {
95 Verifier vrf = setUp("test-parent/UnknownGenerator/", true);
96 vrf.verifyTextInLog("[INFO] yang-to-sources: Code generator instantiated from "
97 + "org.opendaylight.yangtools.yang2sources.spi.CodeGeneratorTestImpl");
98 vrf.verifyTextInLog("Failed to instantiate code generator unknown");
99 vrf.verifyTextInLog("java.lang.ClassNotFoundException: unknown");
103 public void testNoYangFiles() throws Exception {
104 setUp("test-parent/NoYangFiles/", false).verifyTextInLog("[INFO] yang-to-sources: No input files found");
107 static void assertVerificationException(final VerificationException ex, final String string) {
108 assertThat(ex.getMessage(), containsString(string));
111 static Verifier setUp(final String project, final boolean ignoreF)
112 throws VerificationException, URISyntaxException, IOException {
113 final URL path = YangToSourcesPluginTestIT.class.getResource("/" + project + "pom.xml");
114 final Verifier verifier = new Verifier(new File(path.toURI()).getParent());
116 verifier.addCliOption("-fn");
119 final Optional<String> maybeSettings = getEffectiveSettingsXML();
120 if (maybeSettings.isPresent()) {
121 verifier.addCliOption("-gs");
122 verifier.addCliOption(maybeSettings.get());
124 verifier.setMavenDebug(true);
125 verifier.executeGoal("generate-sources");
130 public void testNoOutputDir() throws Exception {
131 verifyCorrectLog(YangToSourcesPluginTestIT.setUp("test-parent/NoOutputDir/", false));
135 public void testFindResourceOnCp() throws Exception {
136 Verifier v1 = setUp("test-parent/GenerateTest1/", false);
137 v1.executeGoal("clean");
138 v1.executeGoal("package");
140 String buildDir = getMavenBuildDirectory(v1);
141 v1.assertFilePresent(buildDir + "/classes/META-INF/yang/types1@2013-02-27.yang");
142 v1.assertFilePresent(buildDir + "/classes/META-INF/yang/types2@2013-02-27.yang");
143 v1.assertFilePresent(buildDir + "/classes/META-INF/yang/types3@2013-02-27.yang");
145 Verifier v2 = setUp("test-parent/GenerateTest2/", false);
146 v2.executeGoal("clean");
147 v2.executeGoal("package");
149 buildDir = getMavenBuildDirectory(v2);
150 v2.assertFilePresent(buildDir + "/classes/META-INF/yang/private@2013-02-27.yang");
151 v2.assertFileNotPresent(buildDir + "/classes/META-INF/yang/types1@2013-02-27.yang");
152 v2.assertFileNotPresent(buildDir + "/classes/META-INF/yang/types2@2013-02-27.yang");
153 v2.assertFileNotPresent(buildDir + "/classes/META-INF/yang/types3@2013-02-27.yang");
156 private static String getMavenBuildDirectory(final Verifier verifier) throws IOException {
157 final Properties sp = new Properties();
158 final Path path = new File(verifier.getBasedir() + "/it-project.properties").toPath();
159 try (InputStream is = Files.newInputStream(path)) {
162 return sp.getProperty("target.dir");
165 private static Optional<String> getEffectiveSettingsXML() throws URISyntaxException, VerificationException,
167 final URL path = Resources.getResource(YangToSourcesPluginTestIT.class, "/test-parent/pom.xml");
168 final File buildDir = new File(path.toURI()).getParentFile().getParentFile().getParentFile();
169 final File effectiveSettingsXML = new File(buildDir, "effective-settings.xml");
170 if (effectiveSettingsXML.exists()) {
171 return Optional.of(effectiveSettingsXML.getAbsolutePath());
174 fail(effectiveSettingsXML.getAbsolutePath());
175 return Optional.empty();