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