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