org.universAAL.support.directives.checks.ParentGForgePropertyCheck.java Source code

Introduction

Here is the source code for org.universAAL.support.directives.checks.ParentGForgePropertyCheck.java

Source

/*******************************************************************************
 * Copyright 2011 Universidad Politcnica de Madrid
 *
 * 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 org.universAAL.support.directives.checks;

import java.io.File;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.Properties;

import org.apache.maven.model.Model;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.project.MavenProject;
import org.tmatesoft.svn.core.SVNException;
import org.tmatesoft.svn.core.SVNURL;
import org.tmatesoft.svn.core.wc.SVNClientManager;
import org.tmatesoft.svn.core.wc.SVNStatus;
import org.universAAL.support.directives.api.APIFixableCheck;
import org.universAAL.support.directives.util.PomFixer;
import org.universAAL.support.directives.util.PomWriter;

/**
 * @author amedrano
 */
public class ParentGForgePropertyCheck implements APIFixableCheck, PomFixer {

    /**
     * Variable to check
     */
    private static final String PROP = "gforge.project.name";

    /**
     * Message content when check fails
     */
    private static final String VARIABLE_NOT_CONFIGURED = "Parent Property Conformance Directive Fail :\n"
            + "It seems the POM does not contain a <" + PROP + "> property, "
            + "add such property, which must be equal to gforge's short project name.";

    private static final Object UAAL_GID = "org.universAAL";

    private static final String UAAL_AID = "uAAL.pom";

    private String correctValue;

    /** {@inheritDoc} */
    public boolean check(MavenProject mavenProject, Log log) throws MojoExecutionException, MojoFailureException {
        if (isParentRootPOM(mavenProject) && !hasProperty(mavenProject, PROP)) {
            try {
                throw new MojoFailureException(
                        VARIABLE_NOT_CONFIGURED + "\n\t may be the correct value for the property is: "
                                + getCorrectPropValue(mavenProject, log) + " ?");
            } catch (Exception e) {
                throw new MojoFailureException(VARIABLE_NOT_CONFIGURED);
            }
        }
        return true;
    }

    private String getCorrectPropValue(MavenProject mavenProject, Log log)
            throws SVNException, MalformedURLException, Exception {

        String correctValue = getSVNURL(mavenProject.getBasedir());
        URL u = new URL(correctValue);
        correctValue = u.getPath().split("/")[1];
        log.debug("Determined Correct Value for " + PROP + ": " + correctValue);
        return correctValue;
    }

    /** {@inheritDoc} */
    public void fix(MavenProject mavenProject, Log log) throws MojoExecutionException, MojoFailureException {
        try {
            correctValue = getCorrectPropValue(mavenProject, log);
            new PomWriter(this, mavenProject).fix();
        } catch (MalformedURLException e) {
            throw new MojoExecutionException("wrong URL", e);
        } catch (SVNException e) {
            throw new MojoExecutionException("unexpected SVN Exception, unable to retrieve URL", e);
        } catch (Exception e) {
            throw new MojoExecutionException("WTH? Exception.", e);
        }
    }

    public static boolean hasProperty(MavenProject mp, String prop) {
        return mp.getProperties().containsKey(prop);
    }

    public static boolean isParentRootPOM(MavenProject mavenProject2) {
        MavenProject parent = mavenProject2.getParent();
        if (parent == null)
            return false;
        String parentID = parent.getArtifactId();
        return (parent.getGroupId().equals(UAAL_GID) && parentID.endsWith(UAAL_AID));
    }

    public static String getSVNURL(File dir) throws Exception, SVNException {
        SVNClientManager cli = SVNClientManager.newInstance();
        SVNStatus status;
        status = cli.getStatusClient().doStatus(dir, false);
        if (status != null) {
            SVNURL url = status.getURL();
            return url.toDecodedString();
        }
        throw new Exception("unable to find URL from svn info.");
    }

    /** {@inheritDoc} */
    public void fix(Model model) {
        Properties p = model.getProperties();
        p.setProperty(PROP, correctValue);
        model.setProperties(p);
    }
}