org.kuali.maven.plugin.ValidateScmMojo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of extractor-maven-plugin Show documentation

Extract information contained in the pom as project properties. These are bits of information that are otherwise not directly available as properties eg major version, scm type

The newest version!

/**
 * Copyright 2004-2013 The Kuali Foundation
 *
 * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
 *
 * 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 org.kuali.maven.plugin;

import org.apache.maven.model.Scm;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.project.MavenProject;
import org.kuali.maven.common.Extractor;

/**
 * Validate that the URL provided in the scm section of the pom matches up with a property that contains the correct SCM URL.
 *
 * @goal validatescm
 */
public class ValidateScmMojo extends AbstractMojo {

	/**
	 * The Maven project this plugin runs in.
	 *
	 * @parameter expression="${project}"
	 * @required
	 * @readonly
	 */
	private MavenProject project;

	/**
	 * Property containing the correct SCM URL. This can be a project property, system property, or environment variable.
	 *
	 * @parameter expression="${extractor.scmUrlProperty}" default-value="scm.url"
	 * @required
	 */
	private String scmUrlProperty;

	/**
	 * If true, the plugin will operate silently without generating any logging output
	 *
	 * @parameter expression="${extractor.silent}" default-value="false"
	 * @required
	 */
	private boolean silent;

	/**
	 * If true, the plugin will skip executing
	 *
	 * @parameter expression="${extractor.skip}" default-value="false"
	 * @required
	 */
	private boolean skip;

	@Override
	public void execute() throws MojoExecutionException, MojoFailureException {
		if (skip) {
			getLog().info("Skipping execution");
			return;
		}
		Extractor extractor = new Extractor();
		Scm trimmedScm = extractor.getTrimmedScm(project.getScm());
		String actualUrl = extractor.getActualUrl(project, scmUrlProperty);
		extractor.validateTrimmedScm(trimmedScm, actualUrl);
		if (!silent) {
			getLog().info("The scm url's declared in the pom match the actual scm url");
			getLog().info("   Actual - " + actualUrl);
			getLog().info("      URL - " + project.getScm().getUrl());
			getLog().info("Developer - " + project.getScm().getDeveloperConnection());
			getLog().info("  Regular - " + project.getScm().getConnection());
		}
	}

	public MavenProject getProject() {
		return project;
	}

	public String getScmUrlProperty() {
		return scmUrlProperty;
	}

	public void setScmUrlProperty(String svnUrlProperty) {
		this.scmUrlProperty = svnUrlProperty;
	}

	public boolean isSilent() {
		return silent;
	}

	public void setSilent(boolean silent) {
		this.silent = silent;
	}

	public boolean isSkip() {
		return skip;
	}

	public void setSkip(boolean skip) {
		this.skip = skip;
	}
}