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