org.xwiki.tool.enforcer.AbstractPomCheck.java Source code

Introduction

Here is the source code for org.xwiki.tool.enforcer.AbstractPomCheck.java

Source

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.tool.enforcer;

import java.io.FileReader;
import java.io.Reader;

import org.apache.maven.enforcer.rule.api.EnforcerRule;
import org.apache.maven.enforcer.rule.api.EnforcerRuleException;
import org.apache.maven.enforcer.rule.api.EnforcerRuleHelper;
import org.apache.maven.model.Model;
import org.apache.maven.model.io.xpp3.MavenXpp3Reader;
import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException;

/**
 * Allows to write Enforcer Rules that perform checks on the POM.
 *
 * @version $Id: 7fe52152f05de2b39b75862c0cf0640f02b8cc30 $
 * @since 7.4RC1
 */
public abstract class AbstractPomCheck implements EnforcerRule {
    /**
     * @param helper the enforcer helper object
     * @return the MavenProject instance for the current Maven project
     * @throws EnforcerRuleException if an error occurred getting the MavenProject instance
     */
    protected MavenProject getMavenProject(EnforcerRuleHelper helper) throws EnforcerRuleException {
        MavenProject project;
        try {
            project = (MavenProject) helper.evaluate("${project}");
        } catch (ExpressionEvaluationException e) {
            throw new EnforcerRuleException("Failed to get Maven project", e);
        }
        return project;
    }

    /**
     * The Maven model as it's present in the project's {@code pom.xml} (non resolved).
     *
     * @param helper the enforcer helper object
     * @return the Model instance for the current Maven project (this contains the raw data from the pom.xml file
     *         before any interpolation)
     * @throws EnforcerRuleException if an error occurred getting the Model instance
     */
    protected Model getModel(EnforcerRuleHelper helper) throws EnforcerRuleException {
        MavenProject project = getMavenProject(helper);
        Model model;
        Reader reader = null;
        try {
            reader = new FileReader(project.getFile());
            MavenXpp3Reader xpp3Reader = new MavenXpp3Reader();
            model = xpp3Reader.read(reader);
        } catch (Exception e) {
            throw new EnforcerRuleException("Failed to read pom file [" + project.getFile() + "]", e);
        } finally {
            if (reader != null) {
                try {
                    reader.close();
                } catch (Exception ee) {
                    throw new EnforcerRuleException(
                            "Failed to close stream after reading pom file [" + project.getFile() + "]", ee);
                }
            }
        }
        return model;
    }

    /**
     * The resolved Maven model (i.e. with parent poms taken into account).
     *
     * @param helper the enforcer helper object
     * @return the resolved Model instance for the current Maven project (this contains the data from the pom.xml file
     *         after interpolation)
     * @throws EnforcerRuleException if an error occurred getting the Model instance
     */
    protected Model getResolvedModel(EnforcerRuleHelper helper) throws EnforcerRuleException {
        MavenProject project = getMavenProject(helper);
        // Note: the model is resolved at this point, which means the Model contains
        return project.getModel();
    }

    @Override
    public boolean isCacheable() {
        return false;
    }

    @Override
    public boolean isResultValid(EnforcerRule enforcerRule) {
        return false;
    }

    @Override
    public String getCacheId() {
        // Not used since caching if off for this rule
        return "";
    }
}