com.ariht.maven.plugins.config.ConfigGenerationMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of config-generation-maven-plugin Show documentation
Generates config and scripts for multiple target environments using template placeholder substitution from values in multiple filter files.
The newest version!
/*
 * Copyright 2014 Software Design Studio Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.ariht.maven.plugins.config;

import com.ariht.maven.plugins.config.generator.ConfigGeneratorImpl;
import com.ariht.maven.plugins.config.parameters.ConfigGeneratorParameters;
import com.ariht.maven.plugins.config.parameters.ConfigGeneratorParametersBuilder;
import com.google.common.base.Preconditions;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;

import java.util.List;

/**
 * Generates config and scripts for multiple target environments using
 * template placeholder substitution from values in multiple filter io.
 */
@Mojo(name = "generate", defaultPhase = LifecyclePhase.GENERATE_RESOURCES, requiresDirectInvocation = false)
public class ConfigGenerationMojo extends AbstractMojo {

    @Parameter (defaultValue = "${project.build.sourceEncoding}")
    protected String encoding;
    @Parameter (defaultValue = "${basedir}/src/config/templates")
    protected String templatesBasePath;
    @Parameter (defaultValue = "${basedir}/src/config/filters")
    protected String filtersBasePath;
    @Parameter
    protected List externalFilterBasePaths;
    @Parameter (defaultValue = "${basedir}/target/generated-config")
    protected String outputBasePath;
    @Parameter (defaultValue = "true")
    protected boolean logOutput;
    @Parameter
    protected List templatesToIgnore;
    @Parameter
    protected List filtersToIgnore;
    @Parameter (defaultValue = "filter.source")
    protected String filterSourcePropertyName;
    @Parameter (defaultValue = "${")
    protected String propertyPrefix;
    @Parameter (defaultValue = "}")
    protected String propertySuffix;
    @Parameter (defaultValue = "true")
    protected boolean failOnMissingProperty;


    /**
     * Clear target io and create new scripts and config io.
     */
    public void execute() throws MojoExecutionException, MojoFailureException {
        final Log log = getLog();
        Preconditions.checkNotNull(log);

        final ConfigGeneratorParameters parameters = new ConfigGeneratorParametersBuilder(log)
                                                                    .withEncoding(encoding)
                                                                    .withTemplatesBasePath(templatesBasePath)
                                                                    .withFiltersBasePath(filtersBasePath)
                                                                    .withExternalFilterBasePaths(externalFilterBasePaths)
                                                                    .withOutputBasePath(outputBasePath)
                                                                    .isWithLogOutput(logOutput)
                                                                    .withTemplatesToIgnore(templatesToIgnore)
                                                                    .withFiltersToIgnore(filtersToIgnore)
                                                                    .withFilterSourcePropertyName(filterSourcePropertyName)
                                                                    .withPropertyPrefix(propertyPrefix)
                                                                    .withPropertySuffix(propertySuffix)
                                                                    .isWithFailOnMissingProperty(failOnMissingProperty)
                                                                    .build();
        if (log.isDebugEnabled()) {
            log.debug("configGeneratorParameters: [" + parameters.toString() + "]");
        }

        final ConfigGeneratorImpl configGenerator = new ConfigGeneratorImpl(log, parameters);
        if (log.isDebugEnabled()) {

        }
        configGenerator.processFiltersIntoTemplates();

    }

}