Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace version parsing and handling with SemVer4j library #1

Open
wants to merge 2 commits into
base: mck/16649
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -79,3 +79,4 @@ doc/source/tools/nodetool

# Python virtual environment
venv/
/nbproject/
27 changes: 5 additions & 22 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,11 @@
<artifactId>slf4j-api</artifactId>
<version>1.7.25</version>
</dependency>
<dependency>
<groupId>com.vdurmont</groupId>
<artifactId>semver4j</artifactId>
<version>3.1.0</version>
</dependency>

<dependency>
<groupId>org.junit.jupiter</groupId>
Expand Down Expand Up @@ -90,10 +95,6 @@
</excludes>
</configuration>
</plugin>
<plugin>
<artifactId>maven-surefire-plugin</artifactId>
<version>2.22.2</version>
</plugin>
</plugins>
</pluginManagement>
<plugins>
Expand Down Expand Up @@ -122,7 +123,6 @@
<plugin>
<groupId>org.apache.rat</groupId>
<artifactId>apache-rat-plugin</artifactId>
<version>0.13</version>
<configuration>
<addLicenseHeaders>true</addLicenseHeaders>
</configuration>
Expand Down Expand Up @@ -151,30 +151,13 @@
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.0.1</version>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
<configuration>
<doclint>none</doclint>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>

<scm>
<connection>scm:git:https://gitbox.apache.org/repos/asf/cassandra-in-jvm-dtest-api.git</connection>
<developerConnection>scm:git:https://gitbox.apache.org/repos/asf/cassandra-in-jvm-dtest-api.git</developerConnection>
<url>https://gitbox.apache.org/repos/asf/cassandra-in-jvm-dtest-api.git</url>
<tag>0.0.6</tag>
</scm>
</project>

110 changes: 49 additions & 61 deletions src/main/java/org/apache/cassandra/distributed/shared/Versions.java
Original file line number Diff line number Diff line change
Expand Up @@ -24,18 +24,19 @@
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.Collectors;

import com.vdurmont.semver4j.Semver;
import com.vdurmont.semver4j.Semver.SemverType;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class Versions
public final class Versions
{
private static final Logger logger = LoggerFactory.getLogger(Versions.class);

Expand Down Expand Up @@ -73,98 +74,82 @@ public enum Major
v4X("4\\.([1-9][0-9]*)(\\.([0-9]+))?");
final Pattern pattern;

Major(String verify)
private Major(String verify)
{
this.pattern = Pattern.compile(verify);
}

static Major fromFull(String version)
static Major of(Semver version)
{
if (version.isEmpty())
throw new IllegalArgumentException(version);
switch (version.charAt(0))
switch (version.getMajor())
{
case '2':
if (version.startsWith("2.2"))
case 2:
if (2 == version.getMinor())
return v22;
throw new IllegalArgumentException(version);
case '3':
if (version.startsWith("3.0"))
throw new IllegalArgumentException(version.getOriginalValue());
case 3:
if (0 == version.getMinor())
return v30;
return v3X;
case '4':
if (version.startsWith("4.0"))
case 4:
if (0 == version.getMinor())
return v40;
return v4X;
default:
throw new IllegalArgumentException(version);
throw new IllegalArgumentException(version.getOriginalValue());
}
}

// verify that the version string is valid for this major version
boolean verify(String version)
boolean verify(Semver version)
{
return pattern.matcher(version).matches();
}

// sort two strings of the same major version as this enum instance
int compare(String a, String b)
{
Matcher ma = pattern.matcher(a);
Matcher mb = pattern.matcher(b);
if (!ma.matches()) throw new IllegalArgumentException(a);
if (!mb.matches()) throw new IllegalArgumentException(b);
int result = Integer.compare(Integer.parseInt(ma.group(1)), Integer.parseInt(mb.group(1)));
if (result == 0 && this == v3X && (ma.group(3) != null || mb.group(3) != null))
{
if (ma.group(3) != null && mb.group(3) != null)
{
// XXX likely wrong for alpha|beta|rc versions
result = Integer.compare(Integer.parseInt(ma.group(3)), Integer.parseInt(mb.group(3)));
}
else
{
result = ma.group(3) != null ? 1 : -1;
}
}
// sort descending
return -result;
return pattern.matcher(version.getOriginalValue()).matches();
}
}

public static class Version
public static final class Version implements Comparable<Version>
{
public final Major major;
public final String version;
public final Semver version;
public final URL[] classpath;

public Version(String version, URL[] classpath)
{
this(Major.fromFull(version), version, classpath);
this(new Semver(version, SemverType.LOOSE), classpath);
}

public Version(Major major, String version, URL[] classpath)
public Version(Semver version, URL[] classpath)
{
this.major = major;
this.major = Major.of(version);
this.version = version;
this.classpath = classpath;
}

@Override
public int compareTo(Version o) {
return version.compareTo(o.version);
}
}

private final Map<Major, List<Version>> versions;

public Versions(Map<Major, List<Version>> versions)
private Versions(Map<Major, List<Version>> versions)
{
this.versions = versions;
}

public Version get(String full)
{
return versions.get(Major.fromFull(full))
return get(new Semver(full, SemverType.LOOSE));
}

public Version get(Semver version)
{
return versions.get(Major.of(version))
.stream()
.filter(v -> full.equals(v.version))
.filter(v -> version.equals(v.version))
.findFirst()
.orElseThrow(() -> new RuntimeException("No version " + full + " found"));
.orElseThrow(() -> new RuntimeException("No version " + version.getOriginalValue() + " found"));
}

public Version getLatest(Major major)
Expand All @@ -177,33 +162,36 @@ public static Versions find()
final String dtestJarDirectory = System.getProperty(PROPERTY_PREFIX + "test.dtest_jar_path", "build");
final File sourceDirectory = new File(dtestJarDirectory);
logger.info("Looking for dtest jars in " + sourceDirectory.getAbsolutePath());
final Pattern pattern = Pattern.compile("dtest-(?<fullversion>(\\d+)\\.(\\d+)(\\.\\d+)?(\\.\\d+)?)([~\\-]\\w[.\\w]*(?:\\-\\w[.\\w]*)*)?(\\+[.\\w]+)?\\.jar");
final Pattern pattern = Pattern.compile("dtest-(?<fullversion>(\\d+)\\.(\\d+)(\\.|-alpha|-beta|-rc)([0-9]+)?(\\.\\d+)?)([~\\-]\\w[.\\w]*(?:\\-\\w[.\\w]*)*)?(\\+[.\\w]+)?\\.jar");
final Map<Major, List<Version>> versions = new HashMap<>();
for (Major major : Major.values())
versions.put(major, new ArrayList<>());

for (File file : sourceDirectory.listFiles())
if (sourceDirectory.exists())
{
Matcher m = pattern.matcher(file.getName());
if (!m.matches())
continue;
String version = m.group(1);
Major major = Major.fromFull(version);
versions.get(major).add(new Version(major, version, new URL[]{ toURL(file) }));
for (File file : sourceDirectory.listFiles())
{
Matcher m = pattern.matcher(file.getName());
if (!m.matches())
continue;
Semver sem = new Semver(m.group(1), SemverType.LOOSE);
Major major = Major.of(sem);
versions.get(major).add(new Version(sem, new URL[]{ toURL(file) }));
}
}

for (Map.Entry<Major, List<Version>> e : versions.entrySet())
{
if (e.getValue().isEmpty())
continue;
Collections.sort(e.getValue(), Comparator.comparing(v -> v.version, e.getKey()::compare));
System.out.println("Found " + e.getValue().stream().map(v -> v.version).collect(Collectors.joining(", ")));
Collections.sort(e.getValue(), Collections.reverseOrder());
System.out.println("Found " + e.getValue().stream().map(v -> v.version.getOriginalValue()).collect(Collectors.joining(", ")));
}

return new Versions(versions);
}

public static URL toURL(File file)
private static URL toURL(File file)
{
try
{
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
/*
* 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.apache.cassandra.distributed.shared;

import org.junit.jupiter.api.Assertions;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;

import com.vdurmont.semver4j.Semver;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;

import static org.assertj.core.api.Assertions.assertThat;

public class VersionsTest
{
public static final String[] VERSIONS = new String[]
{
"2.2.12",
"2.2.2",
"3.0.0",
"3.0.10",
"3.11.10",
"3.11.9",
"4.0-alpha1",
"4.0-beta1",
"4.0-rc1",
"4.0.0",
"4.1.0"
};

@BeforeAll
public static void beforeAll() throws IOException
{
Path root = Files.createTempDirectory("versions");
System.setProperty(Versions.PROPERTY_PREFIX + "test.dtest_jar_path", root.toAbsolutePath().toString());

for (String version : VERSIONS)
Files.createFile(Paths.get(root.toAbsolutePath().toString(), "dtest-" + version + ".jar"));
}

@AfterAll
public static void afterAll() throws IOException
{
System.clearProperty(Versions.PROPERTY_PREFIX + "test.dtest_jar_path");
}

@Test
public void testVersions() throws IOException
{
Versions versions = Versions.find();
for (String version : VERSIONS)
assertThat(versions.get(version)).isNotNull();
}

@Test
public void testGet()
{
assertThat(Versions.find().get("2.2.2")).isNotNull();
}

@Test
public void testGetLatest()
{
Versions.find().getLatest(Versions.Major.v22);
}

@Test
public void testFind()
{
Versions versions = Versions.find();
assertThat(versions).isNotNull();

}

@Test
public void testToURL()
{
assertThat(Versions.getClassPath()).isNotEmpty();
}

}