RunMojo.java

/*
 * Copyright 2011-2012 Brian Matthews
 *
 * 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.btmatthews.maven.plugins.inmemdb.mojo;

import com.btmatthews.maven.plugins.inmemdb.Database;
import com.btmatthews.maven.plugins.inmemdb.Source;
import com.btmatthews.utils.monitor.Logger;
import com.btmatthews.utils.monitor.Server;
import com.btmatthews.utils.monitor.mojo.AbstractRunMojo;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;

import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * This plug-in Mojo starts an In Memory Database.
 *
 * @author <a href="mailto:brian@btmatthews.com">Brian Matthews</a>
 * @version 1.2.0
 */
@Mojo(name = "run", defaultPhase = LifecyclePhase.PRE_INTEGRATION_TEST)
public final class RunMojo extends AbstractRunMojo {

    /**
     * The source files used to populate the database.
     */
    @Parameter
    private List<? extends Source> sources;
    /**
     * The database type.
     */
    @Parameter(property = "inmemdb.type", defaultValue = "hsqldb")
    private String type = "hsqldb";
    /**
     * The database name.
     */
    @Parameter(property = "inmemdb.database", defaultValue = ".")
    private String database = ".";
    /**
     * The username for database connections.
     */
    @Parameter(property = "inmemdb.username", defaultValue = "sa")
    private String username = "sa";
    /**
     * The password for database connections.
     */
    @Parameter(property = "inmemdb.password", defaultValue = "")
    private String password = "";
    /**
     * The port for database connections.
     */
    @Parameter(property = "inmemdb.port")
    private Integer port;

    /**
     * Additional attributes used to configure the database connection.
     */
    @Parameter(property = "inmemdb.attribute")
    private Map<String, String> attributes;

    /**
     * Indicates whether or not the Mojo execution should be skipped.
     * @since 1.4.0
     */
    @Parameter(property = "inmemdb.skip", defaultValue = "false")
    private boolean skip;

    /**
     * Checks whether the Mojo execution is being skipped before delegating to the super class to
     * run the in-memory database.
     *
     * @throws MojoFailureException If there was a problem executing the Mojo.
     * @since 1.4.0
     */
    @Override
    public void execute() throws MojoFailureException {
        if (skip) {
            getLog().info("Skipping inmemdb:run because inmemdb.skip=='true'");
        } else {
            super.execute();
        }
    }

    /**
     * Get the server type.
     *
     * @return The value of {@link #type}.
     */
    @Override
    public String getServerType() {
        return type;
    }

    /**
     * Get the server configuration parameters. These are {@link #database}, {@link #port}, {@link #username} and {@link #password}.
     *
     * @return A {@link Map} containing the configuration parameters.
     */
    @Override
    public Map<String, Object> getServerConfig() {
        final Map<String, Object> config = new HashMap<String, Object>();
        config.put("database", database);
        config.put("username", username);
        if (port != null) {
            config.put("port", port);
        }
        if (password == null) {
            config.put("password", "");
        } else {
            config.put("password", password);
        }

        if (attributes != null) {
            config.put("attributes", attributes);
        }

        return config;
    }

    /**
     * This callback is invoked after the server has started and is used load the scripts
     * and datasets that will initialise the database.
     *
     * @param server The database server.
     * @param logger Used to log information and error messages.
     */
    @Override
    public void started(final Server server, final Logger logger) {
        logger.logInfo("Server has been started");
        if (sources != null) {
            logger.logInfo("Executing initialization scripts and loading data sets");
            for (final Source source : sources) {
                logger.logInfo("Loading " + source.toString());
                ((Database) server).load(this, source);
            }
        }
    }
}