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