com.vmware.pscoe.iac.artifact.model.Version Maven / Gradle / Ivy

Go to download
/*
 * #%L
 * artifact-manager
 * %%
 * Copyright (C) 2023 VMware
 * %%
 * Build Tools for VMware Aria
 * Copyright 2023 VMware, Inc.
 * 
 * This product is licensed to you under the BSD-2 license (the "License"). You may not use this product except in compliance with the BSD-2 License.  
 * 
 * This product may include a number of subcomponents with separate copyright notices and license terms. Your use of these subcomponents is subject to the terms and conditions of the subcomponent's license, as noted in the LICENSE file.
 * #L%
 */
package com.vmware.pscoe.iac.artifact.model;

import org.apache.commons.lang3.StringUtils;

public class Version implements Comparable {
	private static final String SNAPSHOT_DELIMITER = "-";
	private static final String VERSION_DELIMITER = "\\.";
	private static final int MAJOR_VERSION_OFFSET = 0;
	private static final int MINOR_VERSION_OFFSET = 1;

	public final String version;

	public Version(String version) {
		this.version = version;
	}

	public String getString() {
		return this.version;
	}

	public String getVersion() {
		return this.version;
	}

	public Integer getMajorVersion() {
		return this.version.equalsIgnoreCase("cloud")
			? new Integer(Integer.MAX_VALUE)
			: this.parseVersion(MAJOR_VERSION_OFFSET);
	}

	public Integer getMinorVersion() {
		return this.version.equalsIgnoreCase("cloud")
			? new Integer(Integer.MAX_VALUE)
			: this.parseVersion(MINOR_VERSION_OFFSET);
	}

	private Integer parseVersion(int offset) {
		String[] verData = StringUtils.isEmpty(this.version) ? new String[]{} : this.version.split(VERSION_DELIMITER);
		String versionString = verData.length > offset - 1 ? verData[offset] : "";
		if (StringUtils.isEmpty(versionString)) {
			return null;
		}
		Integer retVal = null;
		try {
			retVal = Integer.valueOf(versionString);
		} catch (Exception e) {
			return null;
		}

		return retVal;
	}

	@Override
	public int compareTo(Version version) {
		if (version == null) {
			throw new NullPointerException("Object to be compared is Null.");
		}

		String a = this.getString();
		String b = version.getString();

		// cloud > anything
		if (!"cloud".equalsIgnoreCase(a) && "cloud".equalsIgnoreCase(b)) {
			return -1;
		} else if ("cloud".equalsIgnoreCase(a) && "cloud".equalsIgnoreCase(b)) {
			return 0;
		} else if ("cloud".equalsIgnoreCase(a) && !"cloud".equalsIgnoreCase(b)) {
			return 1;
		}

		// 1.0.0-SNAPSHOT
		String[] aVersionNottation = a.split(SNAPSHOT_DELIMITER);
		String[] bVersionNottation = b.split(SNAPSHOT_DELIMITER);

		// 1.0.0
		String[] aVersion = aVersionNottation[0].split(VERSION_DELIMITER);
		String[] bVersion = bVersionNottation[0].split(VERSION_DELIMITER);

		int compareTo = 0;
		for (int i = 0; i < aVersion.length && i < bVersion.length; i++) {
			// compare versions number by number, going from major to minor
			compareTo = Integer.parseInt(aVersion[i], 10) - Integer.parseInt(bVersion[i], 10);
			if (compareTo != 0) {
				return compareTo;
			}
		}
		// version < version.minor
		compareTo = aVersion.length - bVersion.length;
		if (compareTo != 0) {
			return compareTo;
		}

		// version > version-SNAPSHOT
		return bVersionNottation.length - aVersionNottation.length;
	}

	/**
	 * Compares semantic versions. The method works even for versions that have Build Numbers at the end or don't follow
	 * the syntax strictly, e.g. 8.8, 8.3.3.412333
	 * @param versionA Version in format x.y.z
	 * @param versionB Version in format x.y.z
	 * @return 0 - versions match, -1 - version A is older than B, 1 - version A is newer than B
	 */
	public static int compareSemanticVersions(String versionA, String versionB) {
		String[] versionASplit = versionA.split("\\.");
		String[] versionBSplit = versionB.split("\\.");

		for (int i = 0; i < Math.min(versionASplit.length, versionBSplit.length); i++) {
			int versionANumber = Integer.parseInt(versionASplit[i]);
			int versionBNumber = Integer.parseInt(versionBSplit[i]);

			if (versionANumber > versionBNumber) {
				return 1;
			} else if (versionANumber < versionBNumber) {
				return -1;
			}
		}
		if (versionASplit.length > versionBSplit.length) return 1;
		if (versionASplit.length < versionBSplit.length) return -1;
		return 0;
	}
}