com.ning.maven.plugins.dependencyversionscheck.strategy.APRVersionStrategy Maven / Gradle / Ivy

Go to download

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

The maven-dependency-versions-check-plugin is a Maven plugin that verifies that the resolved versions of dependencies are at least the versions specified by the dependencies (or their dependencies etc.) if not higher. More specifically, it will check that * The resolved version of every dependency declared explicitly in the current POM is the same or a newer one than what was stated. If the resolved version has a higher major version number than the declared version, then the plugin will issue a warning if configured to do so. Note that enforced declared versions are ignored by the plugin. * For every explicitly declared dependency in the current POM, all its dependency versions are met. I.e. the resolved versions for all dependencies in that dependency's POM are the same or higher than the one stated in that dependency's POM. This is basically the same check as the one above, but using the dependency's POM! Also, if the current POM has exclusions specified for the dependency, then these transitive dependencies are ignored when checking this particular dependency.

There is a newer version: 2.0.4

Show newest version

/*
 * Copyright (C) 2011 Henning Schmiedehausen
 *
 * 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 com.ning.maven.plugins.dependencyversionscheck.strategy;

import org.apache.commons.lang.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.ning.maven.plugins.dependencyversionscheck.version.Version;
import com.ning.maven.plugins.dependencyversionscheck.version.VersionElement;

/**
 * Implements Apache versioning strategy for two or three digits. It expects versions formatted as x.y, x.y.z. Versions
 * can have an additional qualifier.
 *
 * Version A (xa.ya.za) can replace Version B (xb.yb.zb) if xa == xb and xa >= xb. component z is always compatible.
 *
 * If an additional qualifier exists, the qualifiers must match.
 *
 * @plexus.component role="com.ning.maven.plugins.dependencyversionscheck.strategy.Strategy" role-hint="apr"
 */
public class APRVersionStrategy implements Strategy
{
    protected final Logger LOG = LoggerFactory.getLogger(this.getClass());

    public String getName()
    {
        return "apr";
    }

    public final boolean isCompatible(final Version versionA, final Version versionB)
    {
        LOG.debug("Is {} compatible to {}... ", versionA, versionB);
        final VersionElement [] versionAElements = versionA.getVersionElements();
        final VersionElement [] versionBElements = versionB.getVersionElements();

        final AprVersion aprVersionA = getAprVersion(versionAElements);
        final AprVersion aprVersionB = getAprVersion(versionBElements);

        return checkCompatible(aprVersionA, aprVersionB);
    }

    protected boolean checkCompatible(final AprVersion aprVersionA, final AprVersion aprVersionB)
    {
        if (aprVersionA == null || aprVersionB == null) {
            LOG.debug("... no, could not parse versions.");
            return false;
        }

        if (aprVersionA.getMajor() != aprVersionB.getMajor()) {
            LOG.debug("... no, different major versions!");
            return false;
        }

        if (aprVersionA.getMinor() >= aprVersionB.getMinor()) {
            LOG.debug("... yes, minor version is ok!");
            return true;
        }

        final boolean res = StringUtils.equals(aprVersionA.getQualifier(), aprVersionB.getQualifier());
        if (!res) {
            LOG.debug("... no, qualifiers don't match!");
        }
        else {
            LOG.debug("... yes!");
        }
        return res;
    }

    private final AprVersion getAprVersion(final VersionElement [] versionElements)
    {
        if (versionElements.length < 2) {
            return null;
        }

        if (!(versionElements[0].isNumber()
              && versionElements[0].hasDot()
              && versionElements[1].isNumber()))
        {
            return null;
        }

        final int major = versionElements[0].getNumber();
        final int minor = versionElements[1].getNumber();

        int patch = 0;
        int qualifierStart = 1;

        if (versionElements.length > 2) {
            if (versionElements[1].hasDot() && versionElements[2].isNumber()) {
                patch = versionElements[2].getNumber();
                qualifierStart = 2;
            }
        }

        StringBuffer qualifier = new StringBuffer();
        while(!versionElements[qualifierStart++].hasEndOfVersion()) {
            qualifier.append(versionElements[qualifierStart]);
        }

        return new AprVersion(major, minor, patch, qualifier.toString());
    }

    public static final class AprVersion
    {
        private final int major;
        private final int minor;
        private final int patch;
        private final String qualifier;

        public AprVersion(int major, int minor, int patch, String qualifier)
        {
            this.major = major;
            this.minor = minor;
            this.patch = patch;
            this.qualifier = qualifier;
        }

        public int getMajor()
        {
            return major;
        }

        public int getMinor()
        {
            return minor;
        }

        public int getPatch()
        {
            return patch;
        }

        public String getQualifier()
        {
            return qualifier;
        }
    }
}