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