opendaylight/sal/yang-prototype/code-generator/maven-yang-plugin/src/main/java/org/opendaylight/controller/yang2sources/plugin/YangToSourcesMojo.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.controller.yang2sources.plugin;
   9
  10 import java.io.File;
  11 import java.util.Arrays;
  12 import java.util.Collections;
  13 import java.util.List;
  14
  15 import org.apache.maven.plugin.AbstractMojo;
  16 import org.apache.maven.plugin.MojoExecutionException;
  17 import org.apache.maven.plugin.MojoFailureException;
  18 import org.apache.maven.plugins.annotations.LifecyclePhase;
  19 import org.apache.maven.plugins.annotations.Mojo;
  20 import org.apache.maven.plugins.annotations.Parameter;
  21 import org.apache.maven.plugins.annotations.ResolutionScope;
  22 import org.apache.maven.project.MavenProject;
  23 import org.opendaylight.controller.yang.model.api.SchemaContext;
  24 import org.opendaylight.controller.yang2sources.plugin.ConfigArg.CodeGeneratorArg;
  25 import org.opendaylight.controller.yang2sources.spi.CodeGenerator;
  26
  27 import com.google.common.annotations.VisibleForTesting;
  28
  29 /**
  30  * Generate sources from yang files using user provided set of
  31  * {@link CodeGenerator}s. Steps of this process:
  32  * <ol>
  33  * <li>List yang files from {@link #yangFilesRootDir}</li>
  34  * <li>Process yang files using {@link YangModelParserImpl}</li>
  35  * <li>For each {@link CodeGenerator} from {@link #codeGenerators}:</li>
  36  * <ol>
  37  * <li>Instantiate using default constructor</li>
  38  * <li>Call {@link CodeGenerator#generateSources(SchemaContext, File)}</li>
  39  * </ol>
  40  * </ol>
  41  */
  42 @Mojo(name = "generate-sources", defaultPhase = LifecyclePhase.GENERATE_SOURCES, requiresDependencyResolution = ResolutionScope.COMPILE, requiresProject = true)
  43 public final class YangToSourcesMojo extends AbstractMojo {
  44
  45     /**
  46      * Classes implementing {@link CodeGenerator} interface. An instance will be
  47      * created out of every class using default constructor. Method {@link
  48      * CodeGenerator#generateSources(SchemaContext, File, Set<String>
  49      * yangModulesNames)} will be called on every instance.
  50      */
  51     @Parameter(required = false)
  52     private CodeGeneratorArg[] codeGenerators;
  53
  54     /**
  55      * Source directory that will be recursively searched for yang files (ending
  56      * with .yang suffix).
  57      */
  58     @Parameter(required = false)
  59     private String yangFilesRootDir; // defaults to ${basedir}/src/main/yang
  60
  61     @Parameter(property = "project", required = true, readonly = true)
  62     protected MavenProject project;
  63
  64     @Parameter(property = "inspectDependencies", required = true, readonly = true)
  65     private boolean inspectDependencies;
  66
  67     private YangToSourcesProcessor yangToSourcesProcessor;
  68
  69     public YangToSourcesMojo() {
  70
  71     }
  72
  73     @VisibleForTesting
  74     YangToSourcesMojo(YangToSourcesProcessor processor) {
  75         this.yangToSourcesProcessor = processor;
  76     }
  77
  78     @Override
  79     public void execute() throws MojoExecutionException, MojoFailureException {
  80         if (yangToSourcesProcessor == null) {
  81             List<CodeGeneratorArg> codeGeneratorArgs = processCodeGenerators(codeGenerators);
  82
  83             // defaults to ${basedir}/src/main/yang
  84             File yangFilesRootFile = processYangFilesRootDir(yangFilesRootDir,
  85                     project.getBasedir());
  86
  87             yangToSourcesProcessor = new YangToSourcesProcessor(getLog(),
  88                     yangFilesRootFile, codeGeneratorArgs, project,
  89                     inspectDependencies);
  90         }
  91         yangToSourcesProcessor.execute();
  92     }
  93
  94     private static List<CodeGeneratorArg> processCodeGenerators(
  95             CodeGeneratorArg[] codeGenerators) {
  96         List<CodeGeneratorArg> codeGeneratorArgs;
  97         if (codeGenerators == null) {
  98             codeGeneratorArgs = Collections.emptyList();
  99         } else {
 100             codeGeneratorArgs = Arrays.asList(codeGenerators);
 101         }
 102         return codeGeneratorArgs;
 103     }
 104
 105     private static File processYangFilesRootDir(String yangFilesRootDir,
 106             File baseDir) {
 107         File yangFilesRootFile;
 108         if (yangFilesRootDir == null) {
 109             yangFilesRootFile = new File(baseDir, "src" + File.separator
 110                     + "main" + File.separator + "yang");
 111         } else {
 112             File file = new File(yangFilesRootDir);
 113             if (file.isAbsolute()) {
 114                 yangFilesRootFile = file;
 115             } else {
 116                 yangFilesRootFile = new File(baseDir, file.getPath());
 117             }
 118         }
 119         return yangFilesRootFile;
 120     }
 121 }