com.marvelution.bamboo.plugins.sonar.tasks.configuration.AbstractSonarMavenBuildTaskConfigurator Maven / Gradle / Ivy

Go to download
/*
 * Licensed to Marvelution under one or more contributor license 
 * agreements.  See the NOTICE file distributed with this work 
 * for additional information regarding copyright ownership.
 * Marvelution licenses this file to you 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.marvelution.bamboo.plugins.sonar.tasks.configuration;

import com.atlassian.bamboo.collections.ActionParametersMap;
import com.atlassian.bamboo.task.AbstractTaskConfigurator;
import com.atlassian.bamboo.task.TaskDefinition;
import com.atlassian.bamboo.utils.error.ErrorCollection;
import com.google.common.collect.ImmutableList;

import org.apache.commons.lang.StringUtils;
import org.apache.log4j.Logger;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

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

/**
 * {@link AbstractTaskConfigurator} implementation for the Sonar Maven builders
 * 
 * @author Mark Rekveld
 */
public abstract class AbstractSonarMavenBuildTaskConfigurator extends AbstractSonarBuildTaskConfigurator {

	private static final Logger LOGGER = Logger.getLogger(AbstractSonarMavenBuildTaskConfigurator.class);
	private static final List FIELDS_TO_COPY = ImmutableList.of(CFG_SONAR_JDBC_PROFILE,
		CFG_SONAR_JDBC_OPTION, CFG_SONAR_PLUGIN_PREINSTALLED);

	/**
	 * {@inheritDoc}
	 */
	@NotNull
	@Override
	public Map generateTaskConfigMap(@NotNull final ActionParametersMap params,
					@Nullable final TaskDefinition previousTaskDefinition) {
		Map config = super.generateTaskConfigMap(params, previousTaskDefinition);
		taskConfiguratorHelper.populateTaskConfigMapWithActionParameters(config, params, FIELDS_TO_COPY);
		return config;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public void populateContextForCreate(Map context) {
		super.populateContextForCreate(context);
		context.put(CFG_SONAR_JDBC_OPTION, CFG_SONAR_JDBC_USE_FORM);
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public void populateContextForEdit(@NotNull Map context, @NotNull TaskDefinition taskDefinition) {
		super.populateContextForEdit(context, taskDefinition);
		taskConfiguratorHelper.populateContextWithConfiguration(context, taskDefinition, FIELDS_TO_COPY);
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public void populateContextForView(@NotNull Map context, @NotNull TaskDefinition taskDefinition) {
		super.populateContextForView(context, taskDefinition);
		taskConfiguratorHelper.populateContextWithConfiguration(context, taskDefinition, FIELDS_TO_COPY);
		context.put(CTX_USES_PROFILE,
			CFG_SONAR_JDBC_USE_PROFILE.equals(taskDefinition.getConfiguration().get(CFG_SONAR_JDBC_OPTION)));
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	protected void populateContextForAllOperations(Map context) {
		super.populateContextForAllOperations(context);
		context.put(CTX_SONAR_JDBC_OPTIONS, CFG_SONAR_JDBC_OPTIONS);
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public void validate(@NotNull ActionParametersMap params, @NotNull ErrorCollection errorCollection) {
		super.validate(params, errorCollection);
		validateSonarServer(params, errorCollection);
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public void validateSonarServer(ActionParametersMap params, ErrorCollection errorCollection) {
		LOGGER.debug("Validating Sonar JDBC Properties");
		if (CFG_SONAR_JDBC_USE_PROFILE.equals(params.getString(CFG_SONAR_JDBC_OPTION))) {
			if (StringUtils.isBlank(params.getString(CFG_SONAR_JDBC_PROFILE))) {
				errorCollection.addError(CFG_SONAR_JDBC_PROFILE, getI18nBean().getText("sonar.jdbc.profile.mandatory"));
			}
		} else {
			super.validateSonarServer(params, errorCollection);
		}
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public void validateSonarProject(ActionParametersMap params, ErrorCollection errorCollection) {
		LOGGER.debug("Validating Sonar Project Properties");
		// Not needed yet for this task
	}

	/**
	 * Getter for the Maven plugin org.codehaus.mojo:sonar-maven-plugin
	 * 
	 * @return the version string
	 */
	protected abstract String getSonarMavenPluginVersion();

}