Bug 5151 Java binding missing @return
[mdsal.git] / binding / mdsal-binding-java-api-generator / src / test / java / org / opendaylight / yangtools / sal / java / api / generator / test / Bug5151Test.java
1 package org.opendaylight.yangtools.sal.java.api.generator.test;
2
3 import static junit.framework.TestCase.assertTrue;
4 import static org.junit.Assert.assertEquals;
5 import static org.junit.Assert.assertNotNull;
6
7 import com.google.common.collect.ImmutableSet;
8 import com.google.common.collect.Maps;
9 import java.io.File;
10 import java.io.FileNotFoundException;
11 import java.util.List;
12 import java.util.Map;
13 import java.util.Scanner;
14 import org.junit.Test;
15 import org.opendaylight.yangtools.sal.binding.model.api.Type;
16 import org.opendaylight.yangtools.sal.java.api.generator.GeneratorJavaFile;
17 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
18
19 /**
20  * Bug5151 involves adding <code>{@literal @}return</code> annotations to accessor methods.
21  */
22 public class Bug5151Test extends BaseCompilationTest {
23
24     private static final String BUG_ID = "bug5151";
25
26     @Test
27     public void test() throws Exception {
28         final File sourcesOutputDir = new File(CompilationTestUtils.GENERATOR_OUTPUT_PATH + CompilationTestUtils.FS + BUG_ID);
29         assertTrue("Failed to create test file '" + sourcesOutputDir + "'", sourcesOutputDir.mkdir());
30         final File compiledOutputDir = new File(CompilationTestUtils.COMPILER_OUTPUT_PATH + CompilationTestUtils.FS + BUG_ID);
31         assertTrue("Failed to create test file '" + compiledOutputDir + "'", compiledOutputDir.mkdir());
32
33         generateTestSources(CompilationTestUtils.FS + "compilation" + CompilationTestUtils.FS + BUG_ID, sourcesOutputDir);
34
35         // Test if sources are compilable
36         CompilationTestUtils.testCompilation(sourcesOutputDir, compiledOutputDir);
37
38         final Map<String, File> generatedFiles = getFiles(sourcesOutputDir);
39         assertEquals(3, generatedFiles.size());
40
41         final File fooContainerFile = generatedFiles.get("FooContainer.java");
42         assertNotNull(fooContainerFile);
43         assertTrue(findInFile(fooContainerFile,
44                 "@return <code>java.lang.String</code> <code>fooInContainer</code>, "
45                         + "or <code>null</code> if not present"));
46
47         final File fooDataFile = generatedFiles.get("FooData.java");
48         assertNotNull(fooDataFile);
49         assertTrue(findInFile(fooDataFile, "FooContainer</code> <code>fooContainer</code>, or <code>null</code> if not present"));
50
51         CompilationTestUtils.cleanUp(sourcesOutputDir, compiledOutputDir);
52     }
53
54     private static boolean findInFile(final File file, final String searchText) throws FileNotFoundException {
55         final Scanner scanner = new Scanner(file);
56         while (scanner.hasNextLine()) {
57             final String nextLine = scanner.nextLine();
58             if (nextLine.contains(searchText)) {
59                 return true;
60             }
61         }
62         return false;
63     }
64
65     private void generateTestSources(final String resourceDirPath, final File sourcesOutputDir) throws Exception {
66         final List<File> sourceFiles = CompilationTestUtils.getSourceFiles(resourceDirPath);
67         final SchemaContext context = TestUtils.parseYangSources(sourceFiles);
68         final List<Type> types = bindingGenerator.generateTypes(context);
69         final GeneratorJavaFile generator = new GeneratorJavaFile(ImmutableSet.copyOf(types));
70         generator.generateToFile(sourcesOutputDir);
71     }
72
73     private static Map<String, File> getFiles(final File path) {
74         return getFiles(path, Maps.newHashMap());
75     }
76
77     private static Map<String, File> getFiles(final File path, final Map<String, File> files) {
78         final File [] dirFiles = path.listFiles();
79         for (File file : dirFiles) {
80             if (file.isDirectory()) {
81                 return getFiles(file, files);
82             } else {
83                 files.put(file.getName(), file);
84             }
85         }
86         return files;
87     }
88 }