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