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 com.google.common.base.Joiner;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.collect.ImmutableSet;
  13 import com.google.common.collect.ImmutableSet.Builder;
  14 import java.io.BufferedWriter;
  15 import java.io.File;
  16 import java.io.IOException;
  17 import java.io.OutputStream;
  18 import java.io.OutputStreamWriter;
  19 import java.io.Writer;
  20 import java.nio.charset.StandardCharsets;
  21 import java.util.Collection;
  22 import java.util.List;
  23 import java.util.Map;
  24 import java.util.Optional;
  25 import java.util.Set;
  26 import java.util.function.Function;
  27 import org.apache.maven.project.MavenProject;
  28 import org.opendaylight.mdsal.binding.generator.api.BindingGenerator;
  29 import org.opendaylight.mdsal.binding.generator.impl.BindingGeneratorImpl;
  30 import org.opendaylight.mdsal.binding.java.api.generator.GeneratorJavaFile;
  31 import org.opendaylight.mdsal.binding.java.api.generator.YangModuleInfoTemplate;
  32 import org.opendaylight.mdsal.binding.model.api.Type;
  33 import org.opendaylight.mdsal.binding.model.util.BindingGeneratorUtil;
  34 import org.opendaylight.yangtools.yang.binding.BindingMapping;
  35 import org.opendaylight.yangtools.yang.binding.YangModelBindingProvider;
  36 import org.opendaylight.yangtools.yang.model.api.Module;
  37 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  38 import org.opendaylight.yangtools.yang2sources.spi.BasicCodeGenerator;
  39 import org.opendaylight.yangtools.yang2sources.spi.BuildContextAware;
  40 import org.opendaylight.yangtools.yang2sources.spi.MavenProjectAware;
  41 import org.slf4j.Logger;
  42 import org.slf4j.LoggerFactory;
  43 import org.sonatype.plexus.build.incremental.BuildContext;
  44
  45 public final class CodeGeneratorImpl implements BasicCodeGenerator, BuildContextAware, MavenProjectAware {
  46     private static final Logger LOG = LoggerFactory.getLogger(CodeGeneratorImpl.class);
  47     private static final String FS = File.separator;
  48     private BuildContext buildContext;
  49     private File projectBaseDir;
  50     private Map<String, String> additionalConfig;
  51     private MavenProject mavenProject;
  52     private File resourceBaseDir;
  53
  54     @Override
  55     public Collection<File> generateSources(final SchemaContext context, final File outputBaseDir,
  56             final Set<Module> currentModules) throws IOException {
  57         return generateSources(context, outputBaseDir, currentModules,
  58             module -> Optional.of("/" + module.getModuleSourcePath().replace(File.separator, "/")));
  59     }
  60
  61     @Override
  62     public Collection<File> generateSources(final SchemaContext context, final File outputDir,
  63             final Set<Module> yangModules, final Function<Module, Optional<String>> moduleResourcePathResolver)
  64                     throws IOException {
  65         final File outputBaseDir;
  66
  67         outputBaseDir = outputDir == null ? getDefaultOutputBaseDir() : outputDir;
  68
  69         final BindingGenerator bindingGenerator = new BindingGeneratorImpl(true);
  70         final List<Type> types = bindingGenerator.generateTypes(context, yangModules);
  71         final GeneratorJavaFile generator = new GeneratorJavaFile(buildContext, types);
  72
  73         File persistentSourcesDir = null;
  74         if (additionalConfig != null) {
  75             String persistenSourcesPath = additionalConfig.get("persistentSourcesDir");
  76             if (persistenSourcesPath != null) {
  77                 persistentSourcesDir = new File(persistenSourcesPath);
  78             }
  79         }
  80         if (persistentSourcesDir == null) {
  81             persistentSourcesDir = new File(projectBaseDir, "src" + FS + "main" + FS + "java");
  82         }
  83
  84         List<File> result = generator.generateToFile(outputBaseDir, persistentSourcesDir);
  85
  86         result.addAll(generateModuleInfos(outputBaseDir, yangModules, context, moduleResourcePathResolver));
  87         return result;
  88     }
  89
  90     private Collection<? extends File> generateModuleInfos(final File outputBaseDir, final Set<Module> yangModules,
  91             final SchemaContext context, final Function<Module, Optional<String>> moduleResourcePathResolver) {
  92         Builder<File> result = ImmutableSet.builder();
  93         Builder<String> bindingProviders = ImmutableSet.builder();
  94         for (Module module : yangModules) {
  95             Builder<String> currentProvidersBuilder = ImmutableSet.builder();
  96             // TODO: do not mutate parameters, output of a method is defined by its return value
  97             Set<File> moduleInfoProviders = generateYangModuleInfo(outputBaseDir, module, context,
  98                 moduleResourcePathResolver, currentProvidersBuilder);
  99             ImmutableSet<String> currentProviders = currentProvidersBuilder.build();
 100             LOG.info("Adding ModuleInfo providers {}", currentProviders);
 101             bindingProviders.addAll(currentProviders);
 102             result.addAll(moduleInfoProviders);
 103         }
 104
 105         result.add(writeMetaInfServices(resourceBaseDir, YangModelBindingProvider.class, bindingProviders.build()));
 106         return result.build();
 107     }
 108
 109     private File writeMetaInfServices(final File outputBaseDir, final Class<YangModelBindingProvider> serviceClass,
 110             final ImmutableSet<String> services) {
 111         File metainfServicesFolder = new File(outputBaseDir, "META-INF" + File.separator + "services");
 112         metainfServicesFolder.mkdirs();
 113         File serviceFile = new File(metainfServicesFolder, serviceClass.getName());
 114
 115         String src = Joiner.on('\n').join(services);
 116
 117         return writeFile(serviceFile, src);
 118     }
 119
 120     public static final String DEFAULT_OUTPUT_BASE_DIR_PATH = "target" + File.separator + "generated-sources"
 121             + File.separator + "maven-sal-api-gen";
 122
 123     private File getDefaultOutputBaseDir() {
 124         File outputBaseDir;
 125         outputBaseDir = new File(DEFAULT_OUTPUT_BASE_DIR_PATH);
 126         setOutputBaseDirAsSourceFolder(outputBaseDir, mavenProject);
 127         LOG.debug("Adding " + outputBaseDir.getPath() + " as compile source root");
 128         return outputBaseDir;
 129     }
 130
 131     private static void setOutputBaseDirAsSourceFolder(final File outputBaseDir, final MavenProject mavenProject) {
 132         Preconditions.checkNotNull(mavenProject, "Maven project needs to be set in this phase");
 133         mavenProject.addCompileSourceRoot(outputBaseDir.getPath());
 134     }
 135
 136     @Override
 137     public void setAdditionalConfig(final Map<String, String> additionalConfiguration) {
 138         this.additionalConfig = additionalConfiguration;
 139     }
 140
 141     @Override
 142     public void setResourceBaseDir(final File resourceBaseDir) {
 143         this.resourceBaseDir = resourceBaseDir;
 144     }
 145
 146     @Override
 147     public void setMavenProject(final MavenProject project) {
 148         this.mavenProject = project;
 149         this.projectBaseDir = project.getBasedir();
 150     }
 151
 152     @Override
 153     public void setBuildContext(final BuildContext buildContext) {
 154         this.buildContext = Preconditions.checkNotNull(buildContext);
 155     }
 156
 157     private Set<File> generateYangModuleInfo(final File outputBaseDir, final Module module, final SchemaContext ctx,
 158             final Function<Module, Optional<String>> moduleResourcePathResolver,
 159             final Builder<String> providerSourceSet) {
 160         Builder<File> generatedFiles = ImmutableSet.builder();
 161
 162         final YangModuleInfoTemplate template = new YangModuleInfoTemplate(module, ctx, moduleResourcePathResolver);
 163         String moduleInfoSource = template.generate();
 164         if (moduleInfoSource.isEmpty()) {
 165             throw new IllegalStateException("Generated code should not be empty!");
 166         }
 167         String providerSource = template.generateModelProvider();
 168
 169         final File packageDir = GeneratorJavaFile.packageToDirectory(outputBaseDir,
 170                 BindingGeneratorUtil.moduleNamespaceToPackageName(module));
 171
 172         generatedFiles.add(writeJavaSource(packageDir, BindingMapping.MODULE_INFO_CLASS_NAME, moduleInfoSource));
 173         generatedFiles
 174                 .add(writeJavaSource(packageDir, BindingMapping.MODEL_BINDING_PROVIDER_CLASS_NAME, providerSource));
 175         providerSourceSet.add(template.getModelBindingProviderName());
 176
 177         return generatedFiles.build();
 178
 179     }
 180
 181     private File writeJavaSource(final File packageDir, final String className, final String source) {
 182         if (!packageDir.exists()) {
 183             packageDir.mkdirs();
 184         }
 185         final File file = new File(packageDir, className + ".java");
 186         writeFile(file, source);
 187         return file;
 188     }
 189
 190     @SuppressWarnings("checkstyle:illegalCatch")
 191     private File writeFile(final File file, final String source) {
 192         try (OutputStream stream = buildContext.newFileOutputStream(file)) {
 193             try (Writer fw = new OutputStreamWriter(stream, StandardCharsets.UTF_8)) {
 194                 try (BufferedWriter bw = new BufferedWriter(fw)) {
 195                     bw.write(source);
 196                 }
 197             } catch (Exception e) {
 198                 LOG.error("Could not write file: {}",file,e);
 199             }
 200         } catch (Exception e) {
 201             LOG.error("Could not create file: {}",file,e);
 202         }
 203         return file;
 204     }
 205 }