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