binding/maven-sal-api-gen-plugin/src/main/java/org/opendaylight/mdsal/binding/maven/api/gen/plugin/CodeGeneratorImpl.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.mdsal.binding.maven.api.gen.plugin;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.base.Joiner;
  13 import com.google.common.base.Stopwatch;
  14 import com.google.common.collect.ImmutableSet;
  15 import com.google.common.collect.ImmutableSet.Builder;
  16 import com.google.common.collect.ListMultimap;
  17 import com.google.common.collect.MultimapBuilder;
  18 import com.google.common.collect.Table;
  19 import com.google.common.collect.Table.Cell;
  20 import java.io.BufferedWriter;
  21 import java.io.File;
  22 import java.io.IOException;
  23 import java.io.OutputStream;
  24 import java.io.OutputStreamWriter;
  25 import java.io.Writer;
  26 import java.nio.charset.StandardCharsets;
  27 import java.nio.file.Files;
  28 import java.nio.file.Path;
  29 import java.util.Collection;
  30 import java.util.List;
  31 import java.util.Map;
  32 import java.util.Optional;
  33 import java.util.Set;
  34 import java.util.function.Function;
  35 import java.util.function.Supplier;
  36 import java.util.stream.Collectors;
  37 import org.apache.maven.project.MavenProject;
  38 import org.opendaylight.mdsal.binding.generator.impl.BindingGeneratorImpl;
  39 import org.opendaylight.mdsal.binding.java.api.generator.GeneratorJavaFile;
  40 import org.opendaylight.mdsal.binding.java.api.generator.GeneratorJavaFile.FileKind;
  41 import org.opendaylight.mdsal.binding.java.api.generator.YangModuleInfoTemplate;
  42 import org.opendaylight.mdsal.binding.model.api.Type;
  43 import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
  44 import org.opendaylight.yangtools.yang.binding.YangModelBindingProvider;
  45 import org.opendaylight.yangtools.yang.model.api.Module;
  46 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  47 import org.opendaylight.yangtools.yang2sources.spi.BasicCodeGenerator;
  48 import org.opendaylight.yangtools.yang2sources.spi.BuildContextAware;
  49 import org.opendaylight.yangtools.yang2sources.spi.MavenProjectAware;
  50 import org.slf4j.Logger;
  51 import org.slf4j.LoggerFactory;
  52 import org.sonatype.plexus.build.incremental.BuildContext;
  53
  54 public final class CodeGeneratorImpl implements BasicCodeGenerator, BuildContextAware, MavenProjectAware {
  55     public static final String CONFIG_PERSISTENT_SOURCES_DIR = "persistentSourcesDir";
  56     public static final String CONFIG_IGNORE_DUPLICATE_FILES = "ignoreDuplicateFiles";
  57
  58     private static final Logger LOG = LoggerFactory.getLogger(CodeGeneratorImpl.class);
  59     private static final String FS = File.separator;
  60     private BuildContext buildContext;
  61     private File projectBaseDir;
  62     private Map<String, String> additionalConfig;
  63     private MavenProject mavenProject;
  64     private File resourceBaseDir;
  65
  66     @Override
  67     public Collection<File> generateSources(final SchemaContext context, final File outputDir,
  68             final Set<Module> yangModules, final Function<Module, Optional<String>> moduleResourcePathResolver)
  69                     throws IOException {
  70         final File outputBaseDir;
  71
  72         outputBaseDir = outputDir == null ? getDefaultOutputBaseDir() : outputDir;
  73
  74         // Step one: determine binding types which we are generating
  75         final Stopwatch sw = Stopwatch.createStarted();
  76         final List<Type> types = new BindingGeneratorImpl().generateTypes(context, yangModules);
  77         LOG.info("Found {} Binding types in {}", types.size(), sw);
  78
  79         final GeneratorJavaFile generator = new GeneratorJavaFile(types);
  80
  81         File persistentSourcesDir = null;
  82         boolean ignoreDuplicateFiles = true;
  83         if (additionalConfig != null) {
  84             String persistenSourcesPath = additionalConfig.get(CONFIG_PERSISTENT_SOURCES_DIR);
  85             if (persistenSourcesPath != null) {
  86                 persistentSourcesDir = new File(persistenSourcesPath);
  87             }
  88             String ignoreDuplicateFilesString = additionalConfig.get(CONFIG_IGNORE_DUPLICATE_FILES);
  89             if (ignoreDuplicateFilesString != null) {
  90                 ignoreDuplicateFiles = Boolean.parseBoolean(ignoreDuplicateFilesString);
  91             }
  92         }
  93         if (persistentSourcesDir == null) {
  94             persistentSourcesDir = new File(projectBaseDir, "src" + FS + "main" + FS + "java");
  95         }
  96
  97         final Table<FileKind, String, Supplier<String>> generatedFiles = generator.generateFileContent(
  98             ignoreDuplicateFiles);
  99
 100         // Step two: create generation tasks for each target file and group them by parent directory
 101         final ListMultimap<Path, GenerationTask> dirs = MultimapBuilder.hashKeys().arrayListValues().build();
 102         for (Cell<FileKind, String, Supplier<String>> cell : generatedFiles.cellSet()) {
 103             final File target;
 104             switch (cell.getRowKey()) {
 105                 case PERSISTENT:
 106                     target = new File(persistentSourcesDir, cell.getColumnKey());
 107                     if (target.exists()) {
 108                         LOG.debug("Skipping existing persistent {}", target);
 109                         continue;
 110                     }
 111                     break;
 112                 case TRANSIENT:
 113                     target = new File(outputBaseDir, cell.getColumnKey());
 114                     break;
 115                 default:
 116                     throw new IllegalStateException("Unsupported file type in " + cell);
 117             }
 118
 119             dirs.put(target.getParentFile().toPath(), new GenerationTask(buildContext, target, cell.getValue()));
 120         }
 121         LOG.info("Generating {} Binding source files into {} directories", dirs.size(), dirs.keySet().size());
 122
 123         // Step three: submit parent directory creation tasks (via parallelStream()) and wait for them to complete
 124         sw.reset().start();
 125         dirs.keySet().parallelStream().forEach(path -> {
 126             try {
 127                 Files.createDirectories(path);
 128             } catch (IOException e) {
 129                 throw new IllegalStateException("Failed to create " + path, e);
 130             }
 131         });
 132         LOG.debug("Parent directories created in {}", sw);
 133
 134         // Step four: submit all code generation tasks (via parallelStream()) and wait for them to complete
 135         sw.reset().start();
 136         final List<File> result = dirs.values().parallelStream()
 137                 .map(GenerationTask::generateFile)
 138                 .collect(Collectors.toList());
 139         LOG.debug("{} Binding source type files generated in {}", result.size(), sw);
 140
 141         // Step five: generate auxiliary files
 142         result.addAll(generateModuleInfos(outputBaseDir, yangModules, context, moduleResourcePathResolver));
 143         return result;
 144     }
 145
 146     private Collection<? extends File> generateModuleInfos(final File outputBaseDir, final Set<Module> yangModules,
 147             final SchemaContext context, final Function<Module, Optional<String>> moduleResourcePathResolver) {
 148         Builder<File> result = ImmutableSet.builder();
 149         Builder<String> bindingProviders = ImmutableSet.builder();
 150         for (Module module : yangModules) {
 151             Builder<String> currentProvidersBuilder = ImmutableSet.builder();
 152             // TODO: do not mutate parameters, output of a method is defined by its return value
 153             Set<File> moduleInfoProviders = generateYangModuleInfo(outputBaseDir, module, context,
 154                 moduleResourcePathResolver, currentProvidersBuilder);
 155             ImmutableSet<String> currentProviders = currentProvidersBuilder.build();
 156             LOG.debug("Adding ModuleInfo providers {}", currentProviders);
 157             bindingProviders.addAll(currentProviders);
 158             result.addAll(moduleInfoProviders);
 159         }
 160
 161         result.add(writeMetaInfServices(resourceBaseDir, YangModelBindingProvider.class, bindingProviders.build()));
 162         return result.build();
 163     }
 164
 165     private File writeMetaInfServices(final File outputBaseDir, final Class<YangModelBindingProvider> serviceClass,
 166             final ImmutableSet<String> services) {
 167         File metainfServicesFolder = new File(outputBaseDir, "META-INF" + File.separator + "services");
 168         metainfServicesFolder.mkdirs();
 169         File serviceFile = new File(metainfServicesFolder, serviceClass.getName());
 170
 171         String src = Joiner.on('\n').join(services);
 172
 173         return writeFile(serviceFile, src);
 174     }
 175
 176     public static final String DEFAULT_OUTPUT_BASE_DIR_PATH = "target" + File.separator + "generated-sources"
 177             + File.separator + "maven-sal-api-gen";
 178
 179     private File getDefaultOutputBaseDir() {
 180         File outputBaseDir;
 181         outputBaseDir = new File(DEFAULT_OUTPUT_BASE_DIR_PATH);
 182         setOutputBaseDirAsSourceFolder(outputBaseDir, mavenProject);
 183         LOG.debug("Adding {} as compile source root", outputBaseDir.getPath());
 184         return outputBaseDir;
 185     }
 186
 187     private static void setOutputBaseDirAsSourceFolder(final File outputBaseDir, final MavenProject mavenProject) {
 188         requireNonNull(mavenProject, "Maven project needs to be set in this phase");
 189         mavenProject.addCompileSourceRoot(outputBaseDir.getPath());
 190     }
 191
 192     @Override
 193     public void setAdditionalConfig(final Map<String, String> additionalConfiguration) {
 194         this.additionalConfig = additionalConfiguration;
 195     }
 196
 197     @Override
 198     public void setResourceBaseDir(final File resourceBaseDir) {
 199         this.resourceBaseDir = resourceBaseDir;
 200     }
 201
 202     @Override
 203     public void setMavenProject(final MavenProject project) {
 204         this.mavenProject = project;
 205         this.projectBaseDir = project.getBasedir();
 206     }
 207
 208     @Override
 209     public void setBuildContext(final BuildContext buildContext) {
 210         this.buildContext = requireNonNull(buildContext);
 211     }
 212
 213     private Set<File> generateYangModuleInfo(final File outputBaseDir, final Module module, final SchemaContext ctx,
 214             final Function<Module, Optional<String>> moduleResourcePathResolver,
 215             final Builder<String> providerSourceSet) {
 216         Builder<File> generatedFiles = ImmutableSet.builder();
 217
 218         final YangModuleInfoTemplate template = new YangModuleInfoTemplate(module, ctx, moduleResourcePathResolver);
 219         String moduleInfoSource = template.generate();
 220         if (moduleInfoSource.isEmpty()) {
 221             throw new IllegalStateException("Generated code should not be empty!");
 222         }
 223         String providerSource = template.generateModelProvider();
 224
 225         final File packageDir = GeneratorJavaFile.packageToDirectory(outputBaseDir,
 226             BindingMapping.getRootPackageName(module.getQNameModule()));
 227
 228         generatedFiles.add(writeJavaSource(packageDir, BindingMapping.MODULE_INFO_CLASS_NAME, moduleInfoSource));
 229         generatedFiles
 230                 .add(writeJavaSource(packageDir, BindingMapping.MODEL_BINDING_PROVIDER_CLASS_NAME, providerSource));
 231         providerSourceSet.add(template.getModelBindingProviderName());
 232
 233         return generatedFiles.build();
 234
 235     }
 236
 237     private File writeJavaSource(final File packageDir, final String className, final String source) {
 238         if (!packageDir.exists()) {
 239             packageDir.mkdirs();
 240         }
 241         final File file = new File(packageDir, className + ".java");
 242         writeFile(file, source);
 243         return file;
 244     }
 245
 246     @SuppressWarnings("checkstyle:illegalCatch")
 247     private File writeFile(final File file, final String source) {
 248         try (OutputStream stream = buildContext.newFileOutputStream(file)) {
 249             try (Writer fw = new OutputStreamWriter(stream, StandardCharsets.UTF_8)) {
 250                 try (BufferedWriter bw = new BufferedWriter(fw)) {
 251                     bw.write(source);
 252                 }
 253             } catch (Exception e) {
 254                 LOG.error("Could not write file: {}", file, e);
 255             }
 256         } catch (Exception e) {
 257             LOG.error("Could not create file: {}", file, e);
 258         }
 259         return file;
 260     }
 261
 262     private static final class GenerationTask {
 263         private final BuildContext buildContext;
 264         private final Supplier<String> contentSupplier;
 265         private final File target;
 266
 267         GenerationTask(final BuildContext buildContext, final File target, final Supplier<String> contentSupplier) {
 268             this.buildContext = requireNonNull(buildContext);
 269             this.target = requireNonNull(target);
 270             this.contentSupplier = requireNonNull(contentSupplier);
 271         }
 272
 273         File generateFile() {
 274             try {
 275                 try (OutputStream stream = buildContext.newFileOutputStream(target)) {
 276                     try (Writer fw = new OutputStreamWriter(stream, StandardCharsets.UTF_8)) {
 277                         try (BufferedWriter bw = new BufferedWriter(fw)) {
 278                             bw.write(contentSupplier.get());
 279                         }
 280                     }
 281                 }
 282             } catch (IOException e) {
 283                 throw new IllegalStateException("Failed to generate file " + target, e);
 284             }
 285             return target;
 286         }
 287     }
 288 }