You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by kw...@apache.org on 2021/11/29 15:37:41 UTC
[sling-org-apache-sling-testing-sling-mock-oak] branch master updated: SLING-10942 update to Oak 1.40 (#4)
This is an automated email from the ASF dual-hosted git repository.
kwin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-testing-sling-mock-oak.git
The following commit(s) were added to refs/heads/master by this push:
new 132a1c2 SLING-10942 update to Oak 1.40 (#4)
132a1c2 is described below
commit 132a1c2ced474820ec602023fc05a269f406c672
Author: Konrad Windszus <kw...@apache.org>
AuthorDate: Mon Nov 29 16:37:38 2021 +0100
SLING-10942 update to Oak 1.40 (#4)
add version check for Oak version
also shade Jackrabbit API and clarify clarify upgrades and downgrades in in README
---
README.md | 12 +-
pom.xml | 32 +-
.../mock/sling/oak/OakMockSlingRepository.java | 21 +-
.../mock/sling/oak/impl/ComparableVersion.java | 832 +++++++++++++++++++++
.../sling/testing/mock/sling/oak/oak.version | 1 +
5 files changed, 873 insertions(+), 25 deletions(-)
diff --git a/README.md b/README.md
index 0b32fda..89352c9 100644
--- a/README.md
+++ b/README.md
@@ -6,9 +6,15 @@
This module is part of the [Apache Sling](https://sling.apache.org) project.
-Implements a resource resolver type for Jackrabbit Oak that can be used in unit tests based on Sling Mocks.
+Implements a resource resolver type for [Jackrabbit Oak](https://jackrabbit.apache.org/oak) that can be used in unit tests based on Sling Mocks.
-This is a separate maven artifacts because it introduces a lot of further dependencies.
+This is a separate Maven artifact because it introduces a lot of further dependencies. In order to prevent dependency version overrides of Oak bundles via dependency management all necessary bundles are shaded into this JAR.
+
+Make sure to depend on this artifact prior to artifact `org.apache.sling.testing.sling-mock.*` in order to give the Oak classes in this JAR precedence in the Maven test class path and use the **shaded Oak version** from this artifact.
+
+In order to execute tests with a version **newer than the Oak version** shaded in this bundle, place all necessary bundles in the Maven test class path as dependencies prior to the dependency on this artifact.
+
+Downgrading to an **older Oak version** is not supported and will lead to an exception (if some earlier artifacts in the class path provide an old Oak implementation).
Documentation:
-http://sling.apache.org/documentation/development/sling-mock.html
+<https://sling.apache.org/documentation/development/sling-mock.html>
diff --git a/pom.xml b/pom.xml
index 830ae0e..666d9cf 100644
--- a/pom.xml
+++ b/pom.xml
@@ -28,15 +28,15 @@
</parent>
<artifactId>org.apache.sling.testing.sling-mock-oak</artifactId>
- <version>3.0.1-1.16.0-SNAPSHOT</version> <!-- second component is the oak version, please keep in sync with oak.version property -->
+ <version>3.0.1-1.40.0-SNAPSHOT</version> <!-- second component is the oak version, please keep in sync with oak.version property -->
<packaging>jar</packaging>
<name>Apache Sling Testing Sling Mock Oak</name>
<description>Implements a resource resolver type for Jackrabbit Oak that can be used in unit tests based on Sling Mocks.</description>
<properties>
- <oak.version>1.16.0</oak.version>
- <jackrabbit.version>2.18.2</jackrabbit.version>
+ <oak.version>1.40.0</oak.version>
+ <jackrabbit.version>2.20.2</jackrabbit.version>
<sling-mock.version>3.1.2</sling-mock.version>
<project.build.outputTimestamp>2021-08-30T16:55:49Z</project.build.outputTimestamp>
@@ -67,12 +67,6 @@
<artifactId>org.apache.sling.testing.sling-mock.core</artifactId>
<version>${sling-mock.version}</version>
<scope>provided</scope>
- <exclusions>
- <exclusion>
- <groupId>org.apache.jackrabbit</groupId>
- <artifactId>jackrabbit-api</artifactId>
- </exclusion>
- </exclusions>
</dependency>
<dependency>
<groupId>org.apache.sling</groupId>
@@ -80,14 +74,7 @@
<version>${sling-mock.version}</version>
<classifier>tests</classifier>
<scope>test</scope>
- <exclusions>
- <exclusion>
- <groupId>org.apache.jackrabbit</groupId>
- <artifactId>jackrabbit-api</artifactId>
- </exclusion>
- </exclusions>
</dependency>
-
<dependency>
<groupId>org.apache.sling</groupId>
<artifactId>org.apache.sling.testing.sling-mock.junit4</artifactId>
@@ -95,7 +82,6 @@
<scope>test</scope>
</dependency>
-
<!-- Depend on oak-jcr, which pulls in all needed Oak artifacts -->
<dependency>
<groupId>org.apache.jackrabbit</groupId>
@@ -164,6 +150,12 @@
</dependencies>
<build>
+ <resources>
+ <resource>
+ <filtering>true</filtering>
+ <directory>src/main/resources</directory>
+ </resource>
+ </resources>
<plugins>
<plugin>
@@ -180,7 +172,7 @@
<artifactId>maven-shade-plugin</artifactId>
<configuration>
<!--
- embed all jackrabbit artifacts to prevent classpath clashes
+ embed all jackrabbit artifacts, to prevent classpath clashes
also include selected Sling bundles which are required
at runtime. Note that we don't relocate the packages
since org.apache.sling.jcr.resource already embeds some
@@ -190,9 +182,6 @@
<includes>
<include>org.apache.jackrabbit:*</include>
</includes>
- <excludes>
- <include>org.apache.jackrabbit:oak-jackrabbit-api</include>
- </excludes>
</artifactSet>
<createSourcesJar>true</createSourcesJar>
</configuration>
@@ -213,6 +202,7 @@
<excludes>
<exclude>dependency-reduced-pom.xml</exclude>
<exclude>src/test/resources/**</exclude>
+ <exclude>src/main/resources/**</exclude>
</excludes>
</configuration>
</plugin>
diff --git a/src/main/java/org/apache/sling/testing/mock/sling/oak/OakMockSlingRepository.java b/src/main/java/org/apache/sling/testing/mock/sling/oak/OakMockSlingRepository.java
index 82f866a..a078deb 100644
--- a/src/main/java/org/apache/sling/testing/mock/sling/oak/OakMockSlingRepository.java
+++ b/src/main/java/org/apache/sling/testing/mock/sling/oak/OakMockSlingRepository.java
@@ -18,7 +18,12 @@
*/
package org.apache.sling.testing.mock.sling.oak;
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
import java.lang.reflect.Field;
+import java.nio.charset.StandardCharsets;
import java.util.concurrent.Executor;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
@@ -37,6 +42,7 @@ import org.apache.jackrabbit.api.JackrabbitRepository;
import org.apache.jackrabbit.oak.Oak;
import org.apache.jackrabbit.oak.jcr.Jcr;
import org.apache.sling.jcr.api.SlingRepository;
+import org.apache.sling.testing.mock.sling.oak.impl.ComparableVersion;
import org.osgi.framework.BundleContext;
import org.osgi.service.component.ComponentContext;
import org.osgi.service.component.annotations.Activate;
@@ -58,7 +64,7 @@ public final class OakMockSlingRepository implements SlingRepository {
private static final Logger log = LoggerFactory.getLogger(OakMockSlingRepository.class);
@Activate
- protected void activate(BundleContext bundleContext) {
+ protected void activate(BundleContext bundleContext) throws IOException {
executor = Executors.newSingleThreadExecutor();
scheduledExecutor = Executors.newSingleThreadScheduledExecutor();
@@ -76,6 +82,19 @@ public final class OakMockSlingRepository implements SlingRepository {
.with(scheduledExecutor);
this.repository = jcr.createRepository();
+ // check if the right Oak version is loaded (older versions may be loaded in case of non-deliberate class loader collisions)
+ String expectedVersion = getExpectedVersion();
+ String actualVersion = repository.getDescriptor(REP_VERSION_DESC);
+ if (new ComparableVersion(expectedVersion).compareTo(new ComparableVersion(actualVersion)) > 0) {
+ throw new IllegalStateException("Unexpected (too old) Oak version " + actualVersion + ", expected " + expectedVersion + ". Make sure to load the `org.apache.sling.testing.sling-mock-oak` dependency before any other dependency which may transitively depend on Apache Jackrabbit Oak as well!");
+ }
+ }
+
+ private static String getExpectedVersion() throws IOException {
+ try (InputStream inputStream = OakMockSlingRepository.class.getResourceAsStream("oak.version");
+ BufferedReader reader = new BufferedReader(new InputStreamReader(inputStream, StandardCharsets.UTF_8))) {
+ return reader.readLine();
+ }
}
@Deactivate
diff --git a/src/main/java/org/apache/sling/testing/mock/sling/oak/impl/ComparableVersion.java b/src/main/java/org/apache/sling/testing/mock/sling/oak/impl/ComparableVersion.java
new file mode 100644
index 0000000..1340acc
--- /dev/null
+++ b/src/main/java/org/apache/sling/testing/mock/sling/oak/impl/ComparableVersion.java
@@ -0,0 +1,832 @@
+package org.apache.sling.testing.mock.sling.oak.impl;
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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.
+ */
+
+//copied from https://github.com/apache/maven/blob/98a6c4f14c85f584e37773b86b448d36c30e0d93/maven-artifact/src/main/java/org/apache/maven/artifact/versioning/ComparableVersion.java#L1
+
+import java.math.BigInteger;
+import java.util.ArrayDeque;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Deque;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Locale;
+import java.util.Properties;
+
+/**
+ * <p>
+ * Generic implementation of version comparison.
+ * </p>
+ *
+ * Features:
+ * <ul>
+ * <li>mixing of '<code>-</code>' (hyphen) and '<code>.</code>' (dot) separators,</li>
+ * <li>transition between characters and digits also constitutes a separator:
+ * <code>1.0alpha1 => [1, 0, alpha, 1]</code></li>
+ * <li>unlimited number of version components,</li>
+ * <li>version components in the text can be digits or strings,</li>
+ * <li>strings are checked for well-known qualifiers and the qualifier ordering is used for version ordering.
+ * Well-known qualifiers (case insensitive) are:<ul>
+ * <li><code>alpha</code> or <code>a</code></li>
+ * <li><code>beta</code> or <code>b</code></li>
+ * <li><code>milestone</code> or <code>m</code></li>
+ * <li><code>rc</code> or <code>cr</code></li>
+ * <li><code>snapshot</code></li>
+ * <li><code>(the empty string)</code> or <code>ga</code> or <code>final</code></li>
+ * <li><code>sp</code></li>
+ * </ul>
+ * Unknown qualifiers are considered after known qualifiers, with lexical order (always case insensitive),
+ * </li>
+ * <li>a hyphen usually precedes a qualifier, and is always less important than something preceded with a dot.</li>
+ * </ul>
+ *
+ * @see <a href="https://cwiki.apache.org/confluence/display/MAVENOLD/Versioning">"Versioning" on Maven Wiki</a>
+ * @author <a href="mailto:kenney@apache.org">Kenney Westerhof</a>
+ * @author <a href="mailto:hboutemy@apache.org">Hervé Boutemy</a>
+ */
+public class ComparableVersion
+ implements Comparable<ComparableVersion>
+{
+ private static final int MAX_INTITEM_LENGTH = 9;
+
+ private static final int MAX_LONGITEM_LENGTH = 18;
+
+ private String value;
+
+ private String canonical;
+
+ private ListItem items;
+
+ private interface Item
+ {
+ int INT_ITEM = 3;
+ int LONG_ITEM = 4;
+ int BIGINTEGER_ITEM = 0;
+ int STRING_ITEM = 1;
+ int LIST_ITEM = 2;
+
+ int compareTo( Item item );
+
+ int getType();
+
+ boolean isNull();
+ }
+
+ /**
+ * Represents a numeric item in the version item list that can be represented with an int.
+ */
+ private static class IntItem
+ implements Item
+ {
+ private final int value;
+
+ public static final IntItem ZERO = new IntItem();
+
+ private IntItem()
+ {
+ this.value = 0;
+ }
+
+ IntItem( String str )
+ {
+ this.value = Integer.parseInt( str );
+ }
+
+ @Override
+ public int getType()
+ {
+ return INT_ITEM;
+ }
+
+ @Override
+ public boolean isNull()
+ {
+ return value == 0;
+ }
+
+ @Override
+ public int compareTo( Item item )
+ {
+ if ( item == null )
+ {
+ return ( value == 0 ) ? 0 : 1; // 1.0 == 1, 1.1 > 1
+ }
+
+ switch ( item.getType() )
+ {
+ case INT_ITEM:
+ int itemValue = ( (IntItem) item ).value;
+ return Integer.compare( value, itemValue );
+ case LONG_ITEM:
+ case BIGINTEGER_ITEM:
+ return -1;
+
+ case STRING_ITEM:
+ return 1; // 1.1 > 1-sp
+
+ case LIST_ITEM:
+ return 1; // 1.1 > 1-1
+
+ default:
+ throw new IllegalStateException( "invalid item: " + item.getClass() );
+ }
+ }
+
+ @Override
+ public boolean equals( Object o )
+ {
+ if ( this == o )
+ {
+ return true;
+ }
+ if ( o == null || getClass() != o.getClass() )
+ {
+ return false;
+ }
+
+ IntItem intItem = (IntItem) o;
+
+ return value == intItem.value;
+
+ }
+
+ @Override
+ public int hashCode()
+ {
+ return value;
+ }
+
+ @Override
+ public String toString()
+ {
+ return Integer.toString( value );
+ }
+ }
+
+ /**
+ * Represents a numeric item in the version item list that can be represented with a long.
+ */
+ private static class LongItem
+ implements Item
+ {
+ private final long value;
+
+ LongItem( String str )
+ {
+ this.value = Long.parseLong( str );
+ }
+
+ @Override
+ public int getType()
+ {
+ return LONG_ITEM;
+ }
+
+ @Override
+ public boolean isNull()
+ {
+ return value == 0;
+ }
+
+ @Override
+ public int compareTo( Item item )
+ {
+ if ( item == null )
+ {
+ return ( value == 0 ) ? 0 : 1; // 1.0 == 1, 1.1 > 1
+ }
+
+ switch ( item.getType() )
+ {
+ case INT_ITEM:
+ return 1;
+ case LONG_ITEM:
+ long itemValue = ( (LongItem) item ).value;
+ return Long.compare( value, itemValue );
+ case BIGINTEGER_ITEM:
+ return -1;
+
+ case STRING_ITEM:
+ return 1; // 1.1 > 1-sp
+
+ case LIST_ITEM:
+ return 1; // 1.1 > 1-1
+
+ default:
+ throw new IllegalStateException( "invalid item: " + item.getClass() );
+ }
+ }
+
+ @Override
+ public boolean equals( Object o )
+ {
+ if ( this == o )
+ {
+ return true;
+ }
+ if ( o == null || getClass() != o.getClass() )
+ {
+ return false;
+ }
+
+ LongItem longItem = (LongItem) o;
+
+ return value == longItem.value;
+
+ }
+
+ @Override
+ public int hashCode()
+ {
+ return (int) ( value ^ ( value >>> 32 ) );
+ }
+
+ @Override
+ public String toString()
+ {
+ return Long.toString( value );
+ }
+ }
+
+ /**
+ * Represents a numeric item in the version item list.
+ */
+ private static class BigIntegerItem
+ implements Item
+ {
+ private final BigInteger value;
+
+ BigIntegerItem( String str )
+ {
+ this.value = new BigInteger( str );
+ }
+
+ @Override
+ public int getType()
+ {
+ return BIGINTEGER_ITEM;
+ }
+
+ @Override
+ public boolean isNull()
+ {
+ return BigInteger.ZERO.equals( value );
+ }
+
+ @Override
+ public int compareTo( Item item )
+ {
+ if ( item == null )
+ {
+ return BigInteger.ZERO.equals( value ) ? 0 : 1; // 1.0 == 1, 1.1 > 1
+ }
+
+ switch ( item.getType() )
+ {
+ case INT_ITEM:
+ case LONG_ITEM:
+ return 1;
+
+ case BIGINTEGER_ITEM:
+ return value.compareTo( ( (BigIntegerItem) item ).value );
+
+ case STRING_ITEM:
+ return 1; // 1.1 > 1-sp
+
+ case LIST_ITEM:
+ return 1; // 1.1 > 1-1
+
+ default:
+ throw new IllegalStateException( "invalid item: " + item.getClass() );
+ }
+ }
+
+ @Override
+ public boolean equals( Object o )
+ {
+ if ( this == o )
+ {
+ return true;
+ }
+ if ( o == null || getClass() != o.getClass() )
+ {
+ return false;
+ }
+
+ BigIntegerItem that = (BigIntegerItem) o;
+
+ return value.equals( that.value );
+
+ }
+
+ @Override
+ public int hashCode()
+ {
+ return value.hashCode();
+ }
+
+ public String toString()
+ {
+ return value.toString();
+ }
+ }
+
+ /**
+ * Represents a string in the version item list, usually a qualifier.
+ */
+ private static class StringItem
+ implements Item
+ {
+ private static final List<String> QUALIFIERS =
+ Arrays.asList( "alpha", "beta", "milestone", "rc", "snapshot", "", "sp" );
+
+ private static final Properties ALIASES = new Properties();
+ static
+ {
+ ALIASES.put( "ga", "" );
+ ALIASES.put( "final", "" );
+ ALIASES.put( "release", "" );
+ ALIASES.put( "cr", "rc" );
+ }
+
+ /**
+ * A comparable value for the empty-string qualifier. This one is used to determine if a given qualifier makes
+ * the version older than one without a qualifier, or more recent.
+ */
+ private static final String RELEASE_VERSION_INDEX = String.valueOf( QUALIFIERS.indexOf( "" ) );
+
+ private final String value;
+
+ StringItem( String value, boolean followedByDigit )
+ {
+ if ( followedByDigit && value.length() == 1 )
+ {
+ // a1 = alpha-1, b1 = beta-1, m1 = milestone-1
+ switch ( value.charAt( 0 ) )
+ {
+ case 'a':
+ value = "alpha";
+ break;
+ case 'b':
+ value = "beta";
+ break;
+ case 'm':
+ value = "milestone";
+ break;
+ default:
+ }
+ }
+ this.value = ALIASES.getProperty( value , value );
+ }
+
+ @Override
+ public int getType()
+ {
+ return STRING_ITEM;
+ }
+
+ @Override
+ public boolean isNull()
+ {
+ return ( comparableQualifier( value ).compareTo( RELEASE_VERSION_INDEX ) == 0 );
+ }
+
+ /**
+ * Returns a comparable value for a qualifier.
+ *
+ * This method takes into account the ordering of known qualifiers then unknown qualifiers with lexical
+ * ordering.
+ *
+ * just returning an Integer with the index here is faster, but requires a lot of if/then/else to check for -1
+ * or QUALIFIERS.size and then resort to lexical ordering. Most comparisons are decided by the first character,
+ * so this is still fast. If more characters are needed then it requires a lexical sort anyway.
+ *
+ * @param qualifier
+ * @return an equivalent value that can be used with lexical comparison
+ */
+ public static String comparableQualifier( String qualifier )
+ {
+ int i = QUALIFIERS.indexOf( qualifier );
+
+ return i == -1 ? ( QUALIFIERS.size() + "-" + qualifier ) : String.valueOf( i );
+ }
+
+ @Override
+ public int compareTo( Item item )
+ {
+ if ( item == null )
+ {
+ // 1-rc < 1, 1-ga > 1
+ return comparableQualifier( value ).compareTo( RELEASE_VERSION_INDEX );
+ }
+ switch ( item.getType() )
+ {
+ case INT_ITEM:
+ case LONG_ITEM:
+ case BIGINTEGER_ITEM:
+ return -1; // 1.any < 1.1 ?
+
+ case STRING_ITEM:
+ return comparableQualifier( value ).compareTo( comparableQualifier( ( (StringItem) item ).value ) );
+
+ case LIST_ITEM:
+ return -1; // 1.any < 1-1
+
+ default:
+ throw new IllegalStateException( "invalid item: " + item.getClass() );
+ }
+ }
+
+ @Override
+ public boolean equals( Object o )
+ {
+ if ( this == o )
+ {
+ return true;
+ }
+ if ( o == null || getClass() != o.getClass() )
+ {
+ return false;
+ }
+
+ StringItem that = (StringItem) o;
+
+ return value.equals( that.value );
+
+ }
+
+ @Override
+ public int hashCode()
+ {
+ return value.hashCode();
+ }
+
+ public String toString()
+ {
+ return value;
+ }
+ }
+
+ /**
+ * Represents a version list item. This class is used both for the global item list and for sub-lists (which start
+ * with '-(number)' in the version specification).
+ */
+ private static class ListItem
+ extends ArrayList<Item>
+ implements Item
+ {
+ @Override
+ public int getType()
+ {
+ return LIST_ITEM;
+ }
+
+ @Override
+ public boolean isNull()
+ {
+ return ( size() == 0 );
+ }
+
+ void normalize()
+ {
+ for ( int i = size() - 1; i >= 0; i-- )
+ {
+ Item lastItem = get( i );
+
+ if ( lastItem.isNull() )
+ {
+ // remove null trailing items: 0, "", empty list
+ remove( i );
+ }
+ else if ( !( lastItem instanceof ListItem ) )
+ {
+ break;
+ }
+ }
+ }
+
+ @Override
+ public int compareTo( Item item )
+ {
+ if ( item == null )
+ {
+ if ( size() == 0 )
+ {
+ return 0; // 1-0 = 1- (normalize) = 1
+ }
+ // Compare the entire list of items with null - not just the first one, MNG-6964
+ for ( Item i : this )
+ {
+ int result = i.compareTo( null );
+ if ( result != 0 )
+ {
+ return result;
+ }
+ }
+ return 0;
+ }
+ switch ( item.getType() )
+ {
+ case INT_ITEM:
+ case LONG_ITEM:
+ case BIGINTEGER_ITEM:
+ return -1; // 1-1 < 1.0.x
+
+ case STRING_ITEM:
+ return 1; // 1-1 > 1-sp
+
+ case LIST_ITEM:
+ Iterator<Item> left = iterator();
+ Iterator<Item> right = ( (ListItem) item ).iterator();
+
+ while ( left.hasNext() || right.hasNext() )
+ {
+ Item l = left.hasNext() ? left.next() : null;
+ Item r = right.hasNext() ? right.next() : null;
+
+ // if this is shorter, then invert the compare and mul with -1
+ int result = l == null ? ( r == null ? 0 : -1 * r.compareTo( l ) ) : l.compareTo( r );
+
+ if ( result != 0 )
+ {
+ return result;
+ }
+ }
+
+ return 0;
+
+ default:
+ throw new IllegalStateException( "invalid item: " + item.getClass() );
+ }
+ }
+
+ @Override
+ public String toString()
+ {
+ StringBuilder buffer = new StringBuilder();
+ for ( Item item : this )
+ {
+ if ( buffer.length() > 0 )
+ {
+ buffer.append( ( item instanceof ListItem ) ? '-' : '.' );
+ }
+ buffer.append( item );
+ }
+ return buffer.toString();
+ }
+
+ /**
+ * Return the contents in the same format that is used when you call toString() on a List.
+ */
+ private String toListString()
+ {
+ StringBuilder buffer = new StringBuilder();
+ buffer.append( "[" );
+ for ( Item item : this )
+ {
+ if ( buffer.length() > 1 )
+ {
+ buffer.append( ", " );
+ }
+ if ( item instanceof ListItem )
+ {
+ buffer.append( ( (ListItem ) item ).toListString() );
+ }
+ else
+ {
+ buffer.append( item );
+ }
+ }
+ buffer.append( "]" );
+ return buffer.toString();
+ }
+ }
+
+ public ComparableVersion( String version )
+ {
+ parseVersion( version );
+ }
+
+ @SuppressWarnings( "checkstyle:innerassignment" )
+ public final void parseVersion( String version )
+ {
+ this.value = version;
+
+ items = new ListItem();
+
+ version = version.toLowerCase( Locale.ENGLISH );
+
+ ListItem list = items;
+
+ Deque<Item> stack = new ArrayDeque<>();
+ stack.push( list );
+
+ boolean isDigit = false;
+
+ int startIndex = 0;
+
+ for ( int i = 0; i < version.length(); i++ )
+ {
+ char c = version.charAt( i );
+
+ if ( c == '.' )
+ {
+ if ( i == startIndex )
+ {
+ list.add( IntItem.ZERO );
+ }
+ else
+ {
+ list.add( parseItem( isDigit, version.substring( startIndex, i ) ) );
+ }
+ startIndex = i + 1;
+ }
+ else if ( c == '-' )
+ {
+ if ( i == startIndex )
+ {
+ list.add( IntItem.ZERO );
+ }
+ else
+ {
+ list.add( parseItem( isDigit, version.substring( startIndex, i ) ) );
+ }
+ startIndex = i + 1;
+
+ list.add( list = new ListItem() );
+ stack.push( list );
+ }
+ else if ( Character.isDigit( c ) )
+ {
+ if ( !isDigit && i > startIndex )
+ {
+ list.add( new StringItem( version.substring( startIndex, i ), true ) );
+ startIndex = i;
+
+ list.add( list = new ListItem() );
+ stack.push( list );
+ }
+
+ isDigit = true;
+ }
+ else
+ {
+ if ( isDigit && i > startIndex )
+ {
+ list.add( parseItem( true, version.substring( startIndex, i ) ) );
+ startIndex = i;
+
+ list.add( list = new ListItem() );
+ stack.push( list );
+ }
+
+ isDigit = false;
+ }
+ }
+
+ if ( version.length() > startIndex )
+ {
+ list.add( parseItem( isDigit, version.substring( startIndex ) ) );
+ }
+
+ while ( !stack.isEmpty() )
+ {
+ list = (ListItem) stack.pop();
+ list.normalize();
+ }
+ }
+
+ private static Item parseItem( boolean isDigit, String buf )
+ {
+ if ( isDigit )
+ {
+ buf = stripLeadingZeroes( buf );
+ if ( buf.length() <= MAX_INTITEM_LENGTH )
+ {
+ // lower than 2^31
+ return new IntItem( buf );
+ }
+ else if ( buf.length() <= MAX_LONGITEM_LENGTH )
+ {
+ // lower than 2^63
+ return new LongItem( buf );
+ }
+ return new BigIntegerItem( buf );
+ }
+ return new StringItem( buf, false );
+ }
+
+ private static String stripLeadingZeroes( String buf )
+ {
+ if ( buf == null || buf.isEmpty() )
+ {
+ return "0";
+ }
+ for ( int i = 0; i < buf.length(); ++i )
+ {
+ char c = buf.charAt( i );
+ if ( c != '0' )
+ {
+ return buf.substring( i );
+ }
+ }
+ return buf;
+ }
+
+ @Override
+ public int compareTo( ComparableVersion o )
+ {
+ return items.compareTo( o.items );
+ }
+
+ @Override
+ public String toString()
+ {
+ return value;
+ }
+
+ public String getCanonical()
+ {
+ if ( canonical == null )
+ {
+ canonical = items.toString();
+ }
+ return canonical;
+ }
+
+ @Override
+ public boolean equals( Object o )
+ {
+ return ( o instanceof ComparableVersion ) && items.equals( ( (ComparableVersion) o ).items );
+ }
+
+ @Override
+ public int hashCode()
+ {
+ return items.hashCode();
+ }
+
+ // CHECKSTYLE_OFF: LineLength
+ /**
+ * Main to test version parsing and comparison.
+ * <p>
+ * To check how "1.2.7" compares to "1.2-SNAPSHOT", for example, you can issue
+ * <pre>java -jar ${maven.repo.local}/org/apache/maven/maven-artifact/${maven.version}/maven-artifact-${maven.version}.jar "1.2.7" "1.2-SNAPSHOT"</pre>
+ * command to command line. Result of given command will be something like this:
+ * <pre>
+ * Display parameters as parsed by Maven (in canonical form) and comparison result:
+ * 1. 1.2.7 == 1.2.7
+ * 1.2.7 > 1.2-SNAPSHOT
+ * 2. 1.2-SNAPSHOT == 1.2-snapshot
+ * </pre>
+ *
+ * @param args the version strings to parse and compare. You can pass arbitrary number of version strings and always
+ * two adjacent will be compared
+ */
+ // CHECKSTYLE_ON: LineLength
+ public static void main( String... args )
+ {
+ System.out.println( "Display parameters as parsed by Maven (in canonical form and as a list of tokens) and"
+ + " comparison result:" );
+ if ( args.length == 0 )
+ {
+ return;
+ }
+
+ ComparableVersion prev = null;
+ int i = 1;
+ for ( String version : args )
+ {
+ ComparableVersion c = new ComparableVersion( version );
+
+ if ( prev != null )
+ {
+ int compare = prev.compareTo( c );
+ System.out.println( " " + prev.toString() + ' '
+ + ( ( compare == 0 ) ? "==" : ( ( compare < 0 ) ? "<" : ">" ) ) + ' ' + version );
+ }
+
+ System.out.println( ( i++ ) + ". " + version + " -> " + c.getCanonical()
+ + "; tokens: " + c.items.toListString() );
+
+ prev = c;
+ }
+ }
+}
diff --git a/src/main/resources/org/apache/sling/testing/mock/sling/oak/oak.version b/src/main/resources/org/apache/sling/testing/mock/sling/oak/oak.version
new file mode 100644
index 0000000..d485764
--- /dev/null
+++ b/src/main/resources/org/apache/sling/testing/mock/sling/oak/oak.version
@@ -0,0 +1 @@
+${oak.version}
\ No newline at end of file