org.jboss.maven.plugins.qstools.checkers.FinalNameChecker Maven / Gradle / Ivy

Go to download
/*
 * JBoss, Home of Professional Open Source
 * Copyright 2013, Red Hat, Inc. and/or its affiliates, and individual
 * contributors by the @authors tag. See the copyright.txt in the 
 * distribution for a full listing of individual contributors.
 *
 * 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.jboss.maven.plugins.qstools.checkers;

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

import javax.xml.xpath.XPathConstants;

import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.component.annotations.Component;
import org.jboss.maven.plugins.qstools.QSChecker;
import org.jboss.maven.plugins.qstools.Violation;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

import edu.emory.mathcs.backport.java.util.Arrays;

/**
 * @author Rafael Benevides
 * 
 */
@Component(role = QSChecker.class, hint = "finalNameChecker")
public class FinalNameChecker extends AbstractProjectChecker {

    private String[] projectPlugins = new String[] { "maven-ear-plugin", "maven-war-plugin", "maven-ejb-plugin", "maven-jar-plugin", "maven-rar-plugin" };

    /*
     * (non-Javadoc)
     * 
     * @see org.jboss.maven.plugins.qstools.QSChecker#getCheckerDescription()
     */
    @Override
    public String getCheckerDescription() {
        return "Checks if the EAR, WAR, JAR, EJB pom.xml contains ${project.artifactId} | ${project.parent.artifactId}";
    }

    /*
     * (non-Javadoc)
     * 
     * @see
     * org.jboss.maven.plugins.qstools.checkers.AbstractProjectChecker#processProject(org.apache.maven.project.MavenProject,
     * org.w3c.dom.Document, java.util.Map)
     */
    @Override
    @SuppressWarnings("unchecked")
    public void processProject(MavenProject project, Document doc, Map> results) throws Exception {
        NodeList plugins = (NodeList) getxPath().evaluate("//plugin/artifactId", doc, XPathConstants.NODESET);
        List pluginsList = Arrays.asList(projectPlugins);
        for (int x = 0; x < plugins.getLength(); x++) {
            Node pluginArtifact = plugins.item(x);
            if (pluginsList.contains(pluginArtifact.getTextContent())) {
                Node finalNameNode = (Node) getxPath().evaluate("//finalName", doc, XPathConstants.NODE);
                if (finalNameNode == null || (
                        !finalNameNode.getTextContent().equals("${project.artifactId}") && ( //General final name
                            project.getPackaging().equals("ear") &&
                            !finalNameNode.getTextContent().equals("${project.parent.artifactId}") //Allowed only for EAR
                        )
                    
                    )) {
                    int lineNumber = finalNameNode == null ? 0 : getLineNumberFromNode(finalNameNode);
                    addViolation(project.getFile(), results, lineNumber, "File doesn't contain ${project.artifactId} or ${project.parent.artifactId} (allowed for EAR only)");
                }
            }
        }
    }
}