com.speedment.maven.abstractmojo.AbstractInitMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of speedment-maven-plugin
A neat plugin for using Speedment as a maven target.
The newest version!
/*
 *
 * Copyright (c) 2006-2020, Speedment, Inc. All Rights Reserved.
 *
 * 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.speedment.maven.abstractmojo;

import com.speedment.maven.parameter.ConfigParam;
import com.speedment.maven.typemapper.Mapping;
import com.speedment.runtime.config.DbmsUtil;
import com.speedment.runtime.config.Project;
import com.speedment.runtime.config.ProjectUtil;
import com.speedment.runtime.config.trait.HasEnableUtil;
import com.speedment.runtime.config.trait.HasIdUtil;
import com.speedment.runtime.config.trait.HasNameUtil;
import com.speedment.runtime.config.trait.HasPackageNameUtil;
import com.speedment.runtime.core.ApplicationBuilder;
import com.speedment.runtime.core.Speedment;
import com.speedment.tool.config.ProjectProperty;
import com.speedment.tool.config.internal.component.DocumentPropertyComponentImpl;
import com.speedment.tool.core.ToolBundle;
import com.speedment.tool.core.internal.util.ConfigFileHelper;
import org.apache.commons.lang3.StringUtils;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.project.MavenProject;

import java.util.*;
import java.util.function.Consumer;

/**
 * A maven goal (re)creates the configuration file with just the provided initialisation parameters.
 *
 * @author Mark Schrijver
 * @since 3.0.17
 */
public abstract class AbstractInitMojo extends AbstractSpeedmentMojo {

    @Parameter(defaultValue = "${project}", required = true, readonly = true)
    private MavenProject mavenProject;

    private @Parameter(defaultValue = "${debug}") Boolean debug;
    private @Parameter(defaultValue = "${companyName}") String companyName;
    private @Parameter(defaultValue = "${appName}") String appName;
    private @Parameter(defaultValue = "${package.location}") String packageLocation;
    private @Parameter(defaultValue = "${package.name}") String packageName;
    private @Parameter(defaultValue = "${dbms.type}") String dbmsType;
    private @Parameter(defaultValue = "${dbms.host}") String dbmsHost;
    private @Parameter(defaultValue = "${dbms.port}") Integer dbmsPort;
    private @Parameter(defaultValue = "${dbms.schemas}") String dbmsSchemas;
    private @Parameter(defaultValue = "${dbms.username}") String dbmsUsername;
    private @Parameter(defaultValue = "${dbms.password}") String dbmsPassword;
    private @Parameter(defaultValue = "${parameters}") ConfigParam[] parameters;
    private @Parameter(defaultValue = "${components}") String[] components;
    private @Parameter(defaultValue = "${typeMappers}") Mapping[] typeMappers;
    private @Parameter(defaultValue = "${configFile}") String configFile;

    protected AbstractInitMojo() {}

    protected AbstractInitMojo(Consumer> configurer) {
        super(configurer);
    }

    @Override
    protected void execute(Speedment speedment) throws MojoExecutionException, MojoFailureException {
        getLog().info("Saving default configuration from database to '" + configLocation().toAbsolutePath() + "'.");

        final ConfigFileHelper helper = speedment.getOrThrow(ConfigFileHelper.class);

        ProjectProperty project = createProject();

        helper.saveProjectToCurrentlyOpenFile(project);

        try {
            helper.setCurrentlyOpenFile(configLocation().toFile());
        } catch (final Exception ex) {
            final String err = "An error occurred while reloading.";
            getLog().error(err);
            throw new MojoExecutionException(err, ex);
        }
    }

    @Override
    protected void configureBuilder(ApplicationBuilder builder) {
        // https://github.com/speedment/speedment/issues/866
        builder.withBundle(ToolBundle.class);
    }

    @Override
    protected MavenProject project() {
        return mavenProject;
    }

    @Override
    protected boolean debug() {
        return (debug != null) && debug;
    }

    public String getConfigFile() {
        return configFile;
    }

    @Override
    protected String[] components() {
        return components;
    }

    @Override
    protected Mapping[] typeMappers() {
        return typeMappers;
    }

    @Override
    protected ConfigParam[] parameters() {
        return parameters;
    }

    @Override
    protected String dbmsHost() {
        return dbmsHost;
    }

    @Override
    protected int dbmsPort() {
        return (dbmsPort == null) ? 0 : dbmsPort;
    }

    @Override
    protected String dbmsUsername() {
        return dbmsUsername;
    }

    @Override
    protected String dbmsPassword() {
        return dbmsPassword;
    }

    private ProjectProperty createProject() {
        ProjectProperty projectProperty = new ProjectProperty();

        Map projectData = new HashMap<>();
        addStringToMap(ProjectUtil.COMPANY_NAME, companyName, getCompanyNameFromMavenProject(), projectData);
        addStringToMap(HasNameUtil.NAME, appName, mavenProject.getArtifactId(), projectData);
        addStringToMap(ProjectUtil.APP_ID, UUID.randomUUID().toString(), null, projectData);
        addStringToMap(HasPackageNameUtil.PACKAGE_NAME, packageName, (mavenProject.getGroupId() + "." + mavenProject.getArtifactId() + ".db").toLowerCase(), projectData);
        addStringToMap(ProjectUtil.PACKAGE_LOCATION, packageLocation, null, projectData);
        addStringToMap(HasIdUtil.ID, appName, mavenProject.getArtifactId(), projectData);
        addBooleanToMap(HasEnableUtil.ENABLED, Boolean.TRUE, projectData);
        addListToMap(ProjectUtil.DBMSES, createDbmses(), projectData);

        projectProperty.merge(new DocumentPropertyComponentImpl(), Project.create(projectData));

        return projectProperty;
    }

    private String getCompanyNameFromMavenProject() {
        if (mavenProject.getOrganization() != null) {
            return mavenProject.getOrganization().getName();
        } else {
            return null;
        }
    }

    private List> createDbmses() {
        List> dbmses = new ArrayList<>(1);
        dbmses.add(createDbms());
        return dbmses;
    }

    private Map createDbms() {
        Map dbmsData = new HashMap<>();
        addStringToMap(HasNameUtil.NAME, appName, mavenProject.getArtifactId(), dbmsData);
        addStringToMap(DbmsUtil.TYPE_NAME, dbmsType, "MySQL", dbmsData);
        addStringToMap(HasIdUtil.ID, appName, mavenProject.getArtifactId(), dbmsData);
        addIntegerToMap(DbmsUtil.PORT, dbmsPort, null, dbmsData);
        addStringToMap(DbmsUtil.IP_ADDRESS, dbmsHost, null, dbmsData);
        addStringToMap(DbmsUtil.CONNECTION_URL, dbmsConnectionUrl(), null, dbmsData);
        addStringToMap(DbmsUtil.USERNAME, dbmsUsername, null, dbmsData);
        addBooleanToMap(HasEnableUtil.ENABLED, Boolean.TRUE, dbmsData);
        addListToMap(DbmsUtil.SCHEMAS, createSchemas(), dbmsData);
        return dbmsData;
    }

    private List> createSchemas() {
        List> schemas = new ArrayList<>();
        if (StringUtils.isNotBlank(dbmsSchemas)) {
            Arrays.stream(dbmsSchemas.split(",")).forEach(schema ->
                schemas.add(createSchema(schema))
            );
        } else {
            if (StringUtils.isNotBlank(appName)) {
                schemas.add(createSchema(appName));
            } else {
                schemas.add(createSchema(mavenProject.getArtifactId()));
            }
        }
        return schemas;
    }

    private Map createSchema(String schema) {
        String schemaName = schema.trim();
        Map schemaData = new HashMap<>();
        if (StringUtils.isNotBlank(schemaName)) {
            addStringToMap(HasNameUtil.NAME, schemaName, null, schemaData);
            addStringToMap(HasIdUtil.ID, schemaName, null, schemaData);
            addBooleanToMap(HasEnableUtil.ENABLED, Boolean.TRUE, schemaData);
        }
        return schemaData;
    }

    private void addStringToMap(String key, String value, String defaultValue, Map map) {
        if (StringUtils.isNotBlank(value)) {
            map.put(key, value);
        } else if (StringUtils.isNotBlank(defaultValue)) {
            map.put(key, defaultValue);
        }
    }

    private void addIntegerToMap(String key, Integer value, Integer defaultValue, Map map) {
        if (value != null) {
            map.put(key, value);
        } else if (defaultValue != null) {
            map.put(key, defaultValue);
        }
    }

    private void addBooleanToMap(String key, Boolean value, Map map) {
        if (value != null) {
            map.put(key, value);
        }
    }

    private void addListToMap(String key, List> value, Map map) {
        if (value != null) {
            map.put(key, value);
        }
    }
}