2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.mdsal.binding.maven.api.gen.plugin;
10 import static java.util.Objects.requireNonNull;
12 import com.google.common.base.Joiner;
13 import com.google.common.base.Stopwatch;
14 import com.google.common.collect.ImmutableSet;
15 import com.google.common.collect.ImmutableSet.Builder;
16 import com.google.common.collect.ListMultimap;
17 import com.google.common.collect.MultimapBuilder;
18 import com.google.common.collect.Table;
19 import com.google.common.collect.Table.Cell;
20 import java.io.BufferedWriter;
22 import java.io.IOException;
23 import java.io.OutputStream;
24 import java.io.OutputStreamWriter;
25 import java.io.Writer;
26 import java.nio.charset.StandardCharsets;
27 import java.nio.file.Files;
28 import java.nio.file.Path;
29 import java.util.Collection;
30 import java.util.List;
32 import java.util.ServiceLoader;
34 import java.util.function.Supplier;
35 import java.util.stream.Collectors;
36 import org.apache.maven.project.MavenProject;
37 import org.opendaylight.mdsal.binding.generator.api.BindingGenerator;
38 import org.opendaylight.mdsal.binding.java.api.generator.GeneratorJavaFile;
39 import org.opendaylight.mdsal.binding.java.api.generator.GeneratorJavaFile.FileKind;
40 import org.opendaylight.mdsal.binding.java.api.generator.YangModuleInfoTemplate;
41 import org.opendaylight.mdsal.binding.model.api.GeneratedType;
42 import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
43 import org.opendaylight.yangtools.yang.binding.YangModelBindingProvider;
44 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
45 import org.opendaylight.yangtools.yang.model.api.Module;
46 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
47 import org.opendaylight.yangtools.yang2sources.spi.BasicCodeGenerator;
48 import org.opendaylight.yangtools.yang2sources.spi.BuildContextAware;
49 import org.opendaylight.yangtools.yang2sources.spi.MavenProjectAware;
50 import org.opendaylight.yangtools.yang2sources.spi.ModuleResourceResolver;
51 import org.slf4j.Logger;
52 import org.slf4j.LoggerFactory;
53 import org.sonatype.plexus.build.incremental.BuildContext;
55 public final class CodeGeneratorImpl implements BasicCodeGenerator, BuildContextAware, MavenProjectAware {
56 public static final String CONFIG_PERSISTENT_SOURCES_DIR = "persistentSourcesDir";
57 public static final String CONFIG_IGNORE_DUPLICATE_FILES = "ignoreDuplicateFiles";
59 private static final Logger LOG = LoggerFactory.getLogger(CodeGeneratorImpl.class);
60 private static final String FS = File.separator;
62 private BuildContext buildContext;
63 private File projectBaseDir;
64 private Map<String, String> additionalConfig;
65 private MavenProject mavenProject;
66 private File resourceBaseDir;
69 public Collection<File> generateSources(final EffectiveModelContext context, final File outputDir,
70 final Set<Module> yangModules, final ModuleResourceResolver moduleResourcePathResolver) throws IOException {
71 final File outputBaseDir;
73 outputBaseDir = outputDir == null ? getDefaultOutputBaseDir() : outputDir;
75 // Step one: determine binding types which we are generating
76 final Stopwatch sw = Stopwatch.createStarted();
77 final List<GeneratedType> types = ServiceLoader.load(BindingGenerator.class)
78 .findFirst().orElseThrow(() -> new IllegalStateException("No BindingGenerator implementation found"))
79 .generateTypes(context, yangModules);
80 LOG.info("Found {} Binding types in {}", types.size(), sw);
82 final GeneratorJavaFile generator = new GeneratorJavaFile(types);
84 File persistentSourcesDir = null;
85 boolean ignoreDuplicateFiles = true;
86 if (additionalConfig != null) {
87 String persistenSourcesPath = additionalConfig.get(CONFIG_PERSISTENT_SOURCES_DIR);
88 if (persistenSourcesPath != null) {
89 persistentSourcesDir = new File(persistenSourcesPath);
91 String ignoreDuplicateFilesString = additionalConfig.get(CONFIG_IGNORE_DUPLICATE_FILES);
92 if (ignoreDuplicateFilesString != null) {
93 ignoreDuplicateFiles = Boolean.parseBoolean(ignoreDuplicateFilesString);
96 if (persistentSourcesDir == null) {
97 persistentSourcesDir = new File(projectBaseDir, "src" + FS + "main" + FS + "java");
100 final Table<FileKind, String, Supplier<String>> generatedFiles = generator.generateFileContent(
101 ignoreDuplicateFiles);
103 // Step two: create generation tasks for each target file and group them by parent directory
104 final ListMultimap<Path, GenerationTask> dirs = MultimapBuilder.hashKeys().arrayListValues().build();
105 for (Cell<FileKind, String, Supplier<String>> cell : generatedFiles.cellSet()) {
107 switch (cell.getRowKey()) {
109 target = new File(persistentSourcesDir, cell.getColumnKey());
110 if (target.exists()) {
111 LOG.debug("Skipping existing persistent {}", target);
116 target = new File(outputBaseDir, cell.getColumnKey());
119 throw new IllegalStateException("Unsupported file type in " + cell);
122 dirs.put(target.getParentFile().toPath(), new GenerationTask(buildContext, target, cell.getValue()));
124 LOG.info("Generating {} Binding source files into {} directories", dirs.size(), dirs.keySet().size());
126 // Step three: submit parent directory creation tasks (via parallelStream()) and wait for them to complete
128 dirs.keySet().parallelStream().forEach(path -> {
130 Files.createDirectories(path);
131 } catch (IOException e) {
132 throw new IllegalStateException("Failed to create " + path, e);
135 LOG.debug("Parent directories created in {}", sw);
137 // Step four: submit all code generation tasks (via parallelStream()) and wait for them to complete
139 final List<File> result = dirs.values().parallelStream()
140 .map(GenerationTask::generateFile)
141 .collect(Collectors.toList());
142 LOG.debug("{} Binding source type files generated in {}", result.size(), sw);
144 // Step five: generate auxiliary files
145 result.addAll(generateModuleInfos(outputBaseDir, yangModules, context, moduleResourcePathResolver));
149 private Collection<? extends File> generateModuleInfos(final File outputBaseDir, final Set<Module> yangModules,
150 final EffectiveModelContext context, final ModuleResourceResolver moduleResourcePathResolver)
152 Builder<File> result = ImmutableSet.builder();
153 Builder<String> bindingProviders = ImmutableSet.builder();
154 for (Module module : yangModules) {
155 Builder<String> currentProvidersBuilder = ImmutableSet.builder();
156 // TODO: do not mutate parameters, output of a method is defined by its return value
157 Set<File> moduleInfoProviders = generateYangModuleInfo(outputBaseDir, module, context,
158 moduleResourcePathResolver, currentProvidersBuilder);
159 ImmutableSet<String> currentProviders = currentProvidersBuilder.build();
160 LOG.debug("Adding ModuleInfo providers {}", currentProviders);
161 bindingProviders.addAll(currentProviders);
162 result.addAll(moduleInfoProviders);
165 result.add(writeMetaInfServices(resourceBaseDir, YangModelBindingProvider.class, bindingProviders.build()));
166 return result.build();
169 private File writeMetaInfServices(final File outputBaseDir, final Class<YangModelBindingProvider> serviceClass,
170 final ImmutableSet<String> services) throws IOException {
171 File metainfServicesFolder = new File(outputBaseDir, "META-INF" + File.separator + "services");
172 Files.createDirectories(metainfServicesFolder.toPath());
173 File serviceFile = new File(metainfServicesFolder, serviceClass.getName());
175 String src = Joiner.on('\n').join(services);
177 return writeFile(serviceFile, src);
180 public static final String DEFAULT_OUTPUT_BASE_DIR_PATH = "target" + File.separator + "generated-sources"
181 + File.separator + "maven-sal-api-gen";
183 private File getDefaultOutputBaseDir() {
185 outputBaseDir = new File(DEFAULT_OUTPUT_BASE_DIR_PATH);
186 setOutputBaseDirAsSourceFolder(outputBaseDir, mavenProject);
187 LOG.debug("Adding {} as compile source root", outputBaseDir.getPath());
188 return outputBaseDir;
191 private static void setOutputBaseDirAsSourceFolder(final File outputBaseDir, final MavenProject mavenProject) {
192 requireNonNull(mavenProject, "Maven project needs to be set in this phase");
193 mavenProject.addCompileSourceRoot(outputBaseDir.getPath());
197 public void setAdditionalConfig(final Map<String, String> additionalConfiguration) {
198 this.additionalConfig = additionalConfiguration;
202 public void setResourceBaseDir(final File resourceBaseDir) {
203 this.resourceBaseDir = resourceBaseDir;
207 public void setMavenProject(final MavenProject project) {
208 this.mavenProject = project;
209 this.projectBaseDir = project.getBasedir();
213 public void setBuildContext(final BuildContext buildContext) {
214 this.buildContext = requireNonNull(buildContext);
217 private Set<File> generateYangModuleInfo(final File outputBaseDir, final Module module,
218 final EffectiveModelContext ctx, final ModuleResourceResolver moduleResourcePathResolver,
219 final Builder<String> providerSourceSet) throws IOException {
220 Builder<File> generatedFiles = ImmutableSet.builder();
222 final YangModuleInfoTemplate template = new YangModuleInfoTemplate(module, ctx,
223 mod -> moduleResourcePathResolver.findModuleResourcePath(mod, YangTextSchemaSource.class));
224 String moduleInfoSource = template.generate();
225 if (moduleInfoSource.isEmpty()) {
226 throw new IllegalStateException("Generated code should not be empty!");
228 String providerSource = template.generateModelProvider();
230 final File packageDir = GeneratorJavaFile.packageToDirectory(outputBaseDir,
231 BindingMapping.getRootPackageName(module.getQNameModule()));
233 generatedFiles.add(writeJavaSource(packageDir, BindingMapping.MODULE_INFO_CLASS_NAME, moduleInfoSource));
234 generatedFiles.add(writeJavaSource(packageDir, BindingMapping.MODEL_BINDING_PROVIDER_CLASS_NAME,
236 providerSourceSet.add(template.getModelBindingProviderName());
238 return generatedFiles.build();
242 private File writeJavaSource(final File packageDir, final String className, final String source)
244 Files.createDirectories(packageDir.toPath());
245 final File file = new File(packageDir, className + ".java");
246 writeFile(file, source);
250 @SuppressWarnings("checkstyle:illegalCatch")
251 private File writeFile(final File file, final String source) {
252 try (OutputStream stream = buildContext.newFileOutputStream(file)) {
253 try (Writer fw = new OutputStreamWriter(stream, StandardCharsets.UTF_8)) {
254 try (BufferedWriter bw = new BufferedWriter(fw)) {
257 } catch (RuntimeException e) {
258 LOG.error("Could not write file: {}", file, e);
260 } catch (IOException e) {
261 LOG.error("Could not create file: {}", file, e);
266 private static final class GenerationTask {
267 private final BuildContext buildContext;
268 private final Supplier<String> contentSupplier;
269 private final File target;
271 GenerationTask(final BuildContext buildContext, final File target, final Supplier<String> contentSupplier) {
272 this.buildContext = requireNonNull(buildContext);
273 this.target = requireNonNull(target);
274 this.contentSupplier = requireNonNull(contentSupplier);
277 File generateFile() {
279 try (OutputStream stream = buildContext.newFileOutputStream(target)) {
280 try (Writer fw = new OutputStreamWriter(stream, StandardCharsets.UTF_8)) {
281 try (BufferedWriter bw = new BufferedWriter(fw)) {
282 bw.write(contentSupplier.get());
286 } catch (IOException e) {
287 throw new IllegalStateException("Failed to generate file " + target, e);