Fix CodeGeneratorImpl checkstyle
[mdsal.git] / binding / maven-sal-api-gen-plugin / src / main / java / org / opendaylight / mdsal / binding / maven / api / gen / plugin / CodeGeneratorImpl.java
index 2c437eeaa665e1399a23a1fb7f91c16f1f08361d..4fa2004d095bbff94dc826b3d92f454c100ceb5a 100644 (file)
@@ -7,13 +7,16 @@
  */
 package org.opendaylight.mdsal.binding.maven.api.gen.plugin;
 
+import static java.util.Objects.requireNonNull;
+
 import com.google.common.base.Joiner;
-import com.google.common.base.Preconditions;
+import com.google.common.base.Stopwatch;
 import com.google.common.collect.ImmutableSet;
 import com.google.common.collect.ImmutableSet.Builder;
+import com.google.common.collect.ListMultimap;
+import com.google.common.collect.MultimapBuilder;
 import com.google.common.collect.Table;
 import com.google.common.collect.Table.Cell;
-import com.google.common.io.Files;
 import java.io.BufferedWriter;
 import java.io.File;
 import java.io.IOException;
@@ -21,28 +24,30 @@ import java.io.OutputStream;
 import java.io.OutputStreamWriter;
 import java.io.Writer;
 import java.nio.charset.StandardCharsets;
-import java.util.ArrayList;
+import java.nio.file.Files;
+import java.nio.file.Path;
 import java.util.Collection;
 import java.util.List;
 import java.util.Map;
-import java.util.Optional;
+import java.util.ServiceLoader;
 import java.util.Set;
-import java.util.function.Function;
 import java.util.function.Supplier;
+import java.util.stream.Collectors;
 import org.apache.maven.project.MavenProject;
-import org.opendaylight.mdsal.binding.generator.impl.BindingGeneratorImpl;
+import org.opendaylight.mdsal.binding.generator.api.BindingGenerator;
 import org.opendaylight.mdsal.binding.java.api.generator.GeneratorJavaFile;
 import org.opendaylight.mdsal.binding.java.api.generator.GeneratorJavaFile.FileKind;
 import org.opendaylight.mdsal.binding.java.api.generator.YangModuleInfoTemplate;
 import org.opendaylight.mdsal.binding.model.api.Type;
-import org.opendaylight.mdsal.binding.model.util.BindingGeneratorUtil;
 import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
 import org.opendaylight.yangtools.yang.binding.YangModelBindingProvider;
+import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
 import org.opendaylight.yangtools.yang.model.api.Module;
-import org.opendaylight.yangtools.yang.model.api.SchemaContext;
+import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
 import org.opendaylight.yangtools.yang2sources.spi.BasicCodeGenerator;
 import org.opendaylight.yangtools.yang2sources.spi.BuildContextAware;
 import org.opendaylight.yangtools.yang2sources.spi.MavenProjectAware;
+import org.opendaylight.yangtools.yang2sources.spi.ModuleResourceResolver;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.sonatype.plexus.build.incremental.BuildContext;
@@ -53,6 +58,7 @@ public final class CodeGeneratorImpl implements BasicCodeGenerator, BuildContext
 
     private static final Logger LOG = LoggerFactory.getLogger(CodeGeneratorImpl.class);
     private static final String FS = File.separator;
+
     private BuildContext buildContext;
     private File projectBaseDir;
     private Map<String, String> additionalConfig;
@@ -60,14 +66,19 @@ public final class CodeGeneratorImpl implements BasicCodeGenerator, BuildContext
     private File resourceBaseDir;
 
     @Override
-    public Collection<File> generateSources(final SchemaContext context, final File outputDir,
-            final Set<Module> yangModules, final Function<Module, Optional<String>> moduleResourcePathResolver)
-                    throws IOException {
+    public Collection<File> generateSources(final EffectiveModelContext context, final File outputDir,
+            final Set<Module> yangModules, final ModuleResourceResolver moduleResourcePathResolver) throws IOException {
         final File outputBaseDir;
 
         outputBaseDir = outputDir == null ? getDefaultOutputBaseDir() : outputDir;
 
-        final List<Type> types = new BindingGeneratorImpl().generateTypes(context, yangModules);
+        // Step one: determine binding types which we are generating
+        final Stopwatch sw = Stopwatch.createStarted();
+        final List<Type> types = ServiceLoader.load(BindingGenerator.class)
+                .findFirst().orElseThrow(() -> new IllegalStateException("No BindingGenerator implementation found"))
+                .generateTypes(context, yangModules);
+        LOG.info("Found {} Binding types in {}", types.size(), sw);
+
         final GeneratorJavaFile generator = new GeneratorJavaFile(types);
 
         File persistentSourcesDir = null;
@@ -88,7 +99,9 @@ public final class CodeGeneratorImpl implements BasicCodeGenerator, BuildContext
 
         final Table<FileKind, String, Supplier<String>> generatedFiles = generator.generateFileContent(
             ignoreDuplicateFiles);
-        final List<File> result = new ArrayList<>(generatedFiles.size());
+
+        // Step two: create generation tasks for each target file and group them by parent directory
+        final ListMultimap<Path, GenerationTask> dirs = MultimapBuilder.hashKeys().arrayListValues().build();
         for (Cell<FileKind, String, Supplier<String>> cell : generatedFiles.cellSet()) {
             final File target;
             switch (cell.getRowKey()) {
@@ -106,27 +119,36 @@ public final class CodeGeneratorImpl implements BasicCodeGenerator, BuildContext
                     throw new IllegalStateException("Unsupported file type in " + cell);
             }
 
-            Files.createParentDirs(target);
-            try (OutputStream stream = buildContext.newFileOutputStream(target)) {
-                try (Writer fw = new OutputStreamWriter(stream, StandardCharsets.UTF_8)) {
-                    try (BufferedWriter bw = new BufferedWriter(fw)) {
-                        bw.write(cell.getValue().get());
-                    }
-                } catch (IOException e) {
-                    LOG.error("Failed to write generate output into {}", target.getPath(), e);
-                    throw e;
-                }
+            dirs.put(target.getParentFile().toPath(), new GenerationTask(buildContext, target, cell.getValue()));
+        }
+        LOG.info("Generating {} Binding source files into {} directories", dirs.size(), dirs.keySet().size());
+
+        // Step three: submit parent directory creation tasks (via parallelStream()) and wait for them to complete
+        sw.reset().start();
+        dirs.keySet().parallelStream().forEach(path -> {
+            try {
+                Files.createDirectories(path);
+            } catch (IOException e) {
+                throw new IllegalStateException("Failed to create " + path, e);
             }
+        });
+        LOG.debug("Parent directories created in {}", sw);
 
-            result.add(target);
-        }
+        // Step four: submit all code generation tasks (via parallelStream()) and wait for them to complete
+        sw.reset().start();
+        final List<File> result = dirs.values().parallelStream()
+                .map(GenerationTask::generateFile)
+                .collect(Collectors.toList());
+        LOG.debug("{} Binding source type files generated in {}", result.size(), sw);
 
+        // Step five: generate auxiliary files
         result.addAll(generateModuleInfos(outputBaseDir, yangModules, context, moduleResourcePathResolver));
         return result;
     }
 
     private Collection<? extends File> generateModuleInfos(final File outputBaseDir, final Set<Module> yangModules,
-            final SchemaContext context, final Function<Module, Optional<String>> moduleResourcePathResolver) {
+            final EffectiveModelContext context, final ModuleResourceResolver moduleResourcePathResolver)
+                throws IOException {
         Builder<File> result = ImmutableSet.builder();
         Builder<String> bindingProviders = ImmutableSet.builder();
         for (Module module : yangModules) {
@@ -145,9 +167,9 @@ public final class CodeGeneratorImpl implements BasicCodeGenerator, BuildContext
     }
 
     private File writeMetaInfServices(final File outputBaseDir, final Class<YangModelBindingProvider> serviceClass,
-            final ImmutableSet<String> services) {
+            final ImmutableSet<String> services) throws IOException {
         File metainfServicesFolder = new File(outputBaseDir, "META-INF" + File.separator + "services");
-        metainfServicesFolder.mkdirs();
+        Files.createDirectories(metainfServicesFolder.toPath());
         File serviceFile = new File(metainfServicesFolder, serviceClass.getName());
 
         String src = Joiner.on('\n').join(services);
@@ -162,12 +184,12 @@ public final class CodeGeneratorImpl implements BasicCodeGenerator, BuildContext
         File outputBaseDir;
         outputBaseDir = new File(DEFAULT_OUTPUT_BASE_DIR_PATH);
         setOutputBaseDirAsSourceFolder(outputBaseDir, mavenProject);
-        LOG.debug("Adding " + outputBaseDir.getPath() + " as compile source root");
+        LOG.debug("Adding {} as compile source root", outputBaseDir.getPath());
         return outputBaseDir;
     }
 
     private static void setOutputBaseDirAsSourceFolder(final File outputBaseDir, final MavenProject mavenProject) {
-        Preconditions.checkNotNull(mavenProject, "Maven project needs to be set in this phase");
+        requireNonNull(mavenProject, "Maven project needs to be set in this phase");
         mavenProject.addCompileSourceRoot(outputBaseDir.getPath());
     }
 
@@ -189,15 +211,16 @@ public final class CodeGeneratorImpl implements BasicCodeGenerator, BuildContext
 
     @Override
     public void setBuildContext(final BuildContext buildContext) {
-        this.buildContext = Preconditions.checkNotNull(buildContext);
+        this.buildContext = requireNonNull(buildContext);
     }
 
-    private Set<File> generateYangModuleInfo(final File outputBaseDir, final Module module, final SchemaContext ctx,
-            final Function<Module, Optional<String>> moduleResourcePathResolver,
-            final Builder<String> providerSourceSet) {
+    private Set<File> generateYangModuleInfo(final File outputBaseDir, final Module module,
+            final EffectiveModelContext ctx, final ModuleResourceResolver moduleResourcePathResolver,
+            final Builder<String> providerSourceSet) throws IOException {
         Builder<File> generatedFiles = ImmutableSet.builder();
 
-        final YangModuleInfoTemplate template = new YangModuleInfoTemplate(module, ctx, moduleResourcePathResolver);
+        final YangModuleInfoTemplate template = new YangModuleInfoTemplate(module, ctx,
+            mod -> moduleResourcePathResolver.findModuleResourcePath(module, YangTextSchemaSource.class));
         String moduleInfoSource = template.generate();
         if (moduleInfoSource.isEmpty()) {
             throw new IllegalStateException("Generated code should not be empty!");
@@ -205,21 +228,20 @@ public final class CodeGeneratorImpl implements BasicCodeGenerator, BuildContext
         String providerSource = template.generateModelProvider();
 
         final File packageDir = GeneratorJavaFile.packageToDirectory(outputBaseDir,
-                BindingGeneratorUtil.moduleNamespaceToPackageName(module));
+            BindingMapping.getRootPackageName(module.getQNameModule()));
 
         generatedFiles.add(writeJavaSource(packageDir, BindingMapping.MODULE_INFO_CLASS_NAME, moduleInfoSource));
-        generatedFiles
-                .add(writeJavaSource(packageDir, BindingMapping.MODEL_BINDING_PROVIDER_CLASS_NAME, providerSource));
+        generatedFiles.add(writeJavaSource(packageDir, BindingMapping.MODEL_BINDING_PROVIDER_CLASS_NAME,
+            providerSource));
         providerSourceSet.add(template.getModelBindingProviderName());
 
         return generatedFiles.build();
 
     }
 
-    private File writeJavaSource(final File packageDir, final String className, final String source) {
-        if (!packageDir.exists()) {
-            packageDir.mkdirs();
-        }
+    private File writeJavaSource(final File packageDir, final String className, final String source)
+            throws IOException {
+        Files.createDirectories(packageDir.toPath());
         final File file = new File(packageDir, className + ".java");
         writeFile(file, source);
         return file;
@@ -232,12 +254,39 @@ public final class CodeGeneratorImpl implements BasicCodeGenerator, BuildContext
                 try (BufferedWriter bw = new BufferedWriter(fw)) {
                     bw.write(source);
                 }
-            } catch (Exception e) {
-                LOG.error("Could not write file: {}",file,e);
+            } catch (RuntimeException e) {
+                LOG.error("Could not write file: {}", file, e);
             }
-        } catch (Exception e) {
-            LOG.error("Could not create file: {}",file,e);
+        } catch (IOException e) {
+            LOG.error("Could not create file: {}", file, e);
         }
         return file;
     }
+
+    private static final class GenerationTask {
+        private final BuildContext buildContext;
+        private final Supplier<String> contentSupplier;
+        private final File target;
+
+        GenerationTask(final BuildContext buildContext, final File target, final Supplier<String> contentSupplier) {
+            this.buildContext = requireNonNull(buildContext);
+            this.target = requireNonNull(target);
+            this.contentSupplier = requireNonNull(contentSupplier);
+        }
+
+        File generateFile() {
+            try {
+                try (OutputStream stream = buildContext.newFileOutputStream(target)) {
+                    try (Writer fw = new OutputStreamWriter(stream, StandardCharsets.UTF_8)) {
+                        try (BufferedWriter bw = new BufferedWriter(fw)) {
+                            bw.write(contentSupplier.get());
+                        }
+                    }
+                }
+            } catch (IOException e) {
+                throw new IllegalStateException("Failed to generate file " + target, e);
+            }
+            return target;
+        }
+    }
 }