Skip to content

Commit

Permalink
Merge pull request #5926 from pferraro/WFCORE-6765
Browse files Browse the repository at this point in the history 
WFCORE-6765 Schema version comparison should require compatible stability level
  • Loading branch information
@yersan
yersan committed Apr 10, 2024
2 parents 5bf0546 + 34e8af2 commit 022c37b
Show file tree
Hide file tree
Showing 6 changed files with 96 additions and 21 deletions.
3 changes: 1 addition & 2 deletions controller/src/main/java/org/jboss/as/controller/xml/SimpleVersionedNamespace.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,14 @@
package org.jboss.as.controller.xml;

import org.jboss.as.version.Stability;
import org.jboss.staxmapper.Versioned;

/**
* Simple {@link VersionedNamespace} implementation.
* @author Paul Ferraro
* @param <V> the namespace version
* @param <N> the namespace type
*/
public class SimpleVersionedNamespace<V extends Comparable<V>, N extends Versioned<V, N>> extends SimpleNamespace implements VersionedNamespace<V, N> {
public class SimpleVersionedNamespace<V extends Comparable<V>, N extends VersionedFeature<V, N>> extends SimpleNamespace implements VersionedNamespace<V, N> {

private final V version;
private final Stability stability;
Expand Down
23 changes: 23 additions & 0 deletions controller/src/main/java/org/jboss/as/controller/xml/VersionedFeature.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
/*
* Copyright The WildFly Authors
* SPDX-License-Identifier: Apache-2.0
*/

package org.jboss.as.controller.xml;

import org.jboss.as.controller.Feature;
import org.jboss.staxmapper.Versioned;

/**
* A versioned feature.
* @param <V> the version type
* @param <F> the versioned feature type
*/
public interface VersionedFeature<V extends Comparable<V>, F extends VersionedFeature<V, F>> extends Versioned<V, F>, Feature {

@Override
default boolean since(F feature) {
// Also ensure that our stability enables the stability of the feature
return Versioned.super.since(feature) && this.getStability().enables(feature.getStability());
}
}
12 changes: 5 additions & 7 deletions controller/src/main/java/org/jboss/as/controller/xml/VersionedNamespace.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,15 @@
import java.util.List;
import java.util.function.Function;

import org.jboss.as.controller.FeatureRegistry;
import org.jboss.as.version.Stability;
import org.jboss.staxmapper.Namespace;
import org.jboss.staxmapper.Versioned;
import org.wildfly.common.iteration.CompositeIterable;

/**
* A versioned namespace.
* @author Paul Ferraro
*/
public interface VersionedNamespace<V extends Comparable<V>, N extends Versioned<V, N>> extends Versioned<V, N>, Namespace, FeatureRegistry {
public interface VersionedNamespace<V extends Comparable<V>, N extends VersionedFeature<V, N>> extends VersionedFeature<V, N>, Namespace {

/**
* Equivalent to {@link #createURN(List, Comparable, Function)} using {@link Object#toString()}.
Expand All @@ -27,7 +25,7 @@ public interface VersionedNamespace<V extends Comparable<V>, N extends Versioned
* @param version a version
* @return a versioned URN
*/
static <V extends Comparable<V>, N extends Versioned<V, N>> VersionedNamespace<V, N> createURN(List<String> identifiers, V version) {
static <V extends Comparable<V>, N extends VersionedFeature<V, N>> VersionedNamespace<V, N> createURN(List<String> identifiers, V version) {
return createURN(identifiers, Stability.DEFAULT, version);
}

Expand All @@ -40,7 +38,7 @@ static <V extends Comparable<V>, N extends Versioned<V, N>> VersionedNamespace<V
* @param version a version
* @return a versioned URN
*/
static <V extends Comparable<V>, N extends Versioned<V, N>> VersionedNamespace<V, N> createURN(List<String> identifiers, Stability stability, V version) {
static <V extends Comparable<V>, N extends VersionedFeature<V, N>> VersionedNamespace<V, N> createURN(List<String> identifiers, Stability stability, V version) {
return createURN(identifiers, stability, version, Object::toString);
}

Expand All @@ -53,7 +51,7 @@ static <V extends Comparable<V>, N extends Versioned<V, N>> VersionedNamespace<V
* @param versionFormatter a version formatter
* @return a versioned URN
*/
static <V extends Comparable<V>, N extends Versioned<V, N>> VersionedNamespace<V, N> createURN(List<String> identifiers, V version, Function<V, String> versionFormatter) {
static <V extends Comparable<V>, N extends VersionedFeature<V, N>> VersionedNamespace<V, N> createURN(List<String> identifiers, V version, Function<V, String> versionFormatter) {
return createURN(identifiers, Stability.DEFAULT, version, versionFormatter);
}

Expand All @@ -67,7 +65,7 @@ static <V extends Comparable<V>, N extends Versioned<V, N>> VersionedNamespace<V
* @param versionFormatter a version formatter
* @return a versioned URN
*/
static <V extends Comparable<V>, N extends Versioned<V, N>> VersionedNamespace<V, N> createURN(List<String> identifiers, Stability stability, V version, Function<V, String> versionFormatter) {
static <V extends Comparable<V>, N extends VersionedFeature<V, N>> VersionedNamespace<V, N> createURN(List<String> identifiers, Stability stability, V version, Function<V, String> versionFormatter) {
return new SimpleVersionedNamespace<>(String.join(":", new CompositeIterable<>(List.of("urn"), identifiers, !Stability.DEFAULT.enables(stability) ? List.of(stability.toString(), versionFormatter.apply(version)) : List.of(versionFormatter.apply(version)))), version, stability);
}
}
4 changes: 1 addition & 3 deletions controller/src/main/java/org/jboss/as/controller/xml/VersionedSchema.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,14 @@
*/
package org.jboss.as.controller.xml;

import org.jboss.as.controller.Feature;
import org.jboss.as.controller.FeatureRegistry;
import org.jboss.as.version.Stability;
import org.jboss.staxmapper.Versioned;

/**
* A versioned schema, whose namespace is a versioned namespace.
* @author Paul Ferraro
*/
public interface VersionedSchema<V extends Comparable<V>, S extends VersionedSchema<V, S>> extends Versioned<V, S>, Schema, Feature, FeatureRegistry {
public interface VersionedSchema<V extends Comparable<V>, S extends VersionedFeature<V, S>> extends VersionedFeature<V, S>, Schema, FeatureRegistry {

/**
* Returns the versioned namespace of this attribute/element.
Expand Down
3 changes: 1 addition & 2 deletions controller/src/main/java/org/jboss/as/controller/xml/VersionedURN.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
import java.util.List;

import org.jboss.staxmapper.IntVersion;
import org.jboss.staxmapper.Versioned;
import org.wildfly.common.iteration.CompositeIterable;

/**
Expand All @@ -16,7 +15,7 @@
* @deprecated Use {@link IntVersionSchema#createURN(List, IntVersion) instead.
*/
@Deprecated(forRemoval = true)
public class VersionedURN<N extends Versioned<IntVersion, N>> extends SimpleVersionedNamespace<IntVersion, N> {
public class VersionedURN<N extends VersionedFeature<IntVersion, N>> extends SimpleVersionedNamespace<IntVersion, N> {
public static final String JBOSS_IDENTIFIER = IntVersionSchema.JBOSS_IDENTIFIER;
public static final String WILDFLY_IDENTIFIER = IntVersionSchema.WILDFLY_IDENTIFIER;

Expand Down
72 changes: 65 additions & 7 deletions controller/src/test/java/org/jboss/as/controller/xml/VersionedNamespaceTestCase.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@
*/
package org.jboss.as.controller.xml;

import java.util.EnumSet;
import java.util.List;
import java.util.Set;

import org.jboss.as.controller.SubsystemSchema;
import org.jboss.as.version.Stability;
Expand All @@ -18,15 +20,46 @@
*/
public class VersionedNamespaceTestCase {

enum Schema implements VersionedSchema<IntVersion, Schema> {
VERSION_1_DEFAULT(1, Stability.DEFAULT),
VERSION_1_COMMUNITY(1, Stability.COMMUNITY),
VERSION_1_PREVIEW(1, Stability.PREVIEW),
VERSION_1_EXPERIMENTAL(1, Stability.EXPERIMENTAL),

VERSION_2_EXPERIMENTAL(2, Stability.EXPERIMENTAL),
VERSION_2_PREVIEW(2, Stability.PREVIEW),
VERSION_2_COMMUNITY(2, Stability.COMMUNITY),
VERSION_2_DEFAULT(2, Stability.DEFAULT),
;

private final VersionedNamespace<IntVersion, Schema> namespace;

Schema(int version, Stability stability) {
this.namespace = VersionedNamespace.createURN(List.of("foo", "bar"), stability, new IntVersion(version));
}

@Override
public String getLocalName() {
return "";
}

@Override
public VersionedNamespace<IntVersion, Schema> getNamespace() {
return this.namespace;
}
}

@Test
public void test() {
Assert.assertEquals("urn:foo:bar:1", VersionedNamespace.createURN(List.of("foo", "bar"), new IntVersion(1)).getUri());
Assert.assertEquals("urn:foo:bar:1", VersionedNamespace.createURN(List.of("foo", "bar"), Stability.DEFAULT, new IntVersion(1)).getUri());
Assert.assertEquals("urn:foo:bar:experimental:1.0.0", VersionedNamespace.createURN(List.of("foo", "bar"), Stability.EXPERIMENTAL, new IntVersion(1), IntVersionSchema.MAJOR_MINOR_MICRO).getUri());
public void uri() {
Assert.assertEquals("urn:foo:bar:1", Schema.VERSION_1_DEFAULT.getNamespace().getUri());
Assert.assertEquals("urn:foo:bar:community:1", Schema.VERSION_1_COMMUNITY.getNamespace().getUri());
Assert.assertEquals("urn:foo:bar:preview:1", Schema.VERSION_1_PREVIEW.getNamespace().getUri());
Assert.assertEquals("urn:foo:bar:experimental:1", Schema.VERSION_1_EXPERIMENTAL.getNamespace().getUri());

Assert.assertEquals("urn:foo:bar:2.0", IntVersionSchema.createURN(List.of("foo", "bar"), new IntVersion(2)).getUri());
Assert.assertEquals("urn:foo:bar:2.0", IntVersionSchema.createURN(List.of("foo", "bar"), Stability.DEFAULT, new IntVersion(2)).getUri());
Assert.assertEquals("urn:foo:bar:preview:2.0", IntVersionSchema.createURN(List.of("foo", "bar"), Stability.PREVIEW, new IntVersion(2)).getUri());
Assert.assertEquals("urn:foo:bar:2", Schema.VERSION_2_DEFAULT.getNamespace().getUri());
Assert.assertEquals("urn:foo:bar:community:2", Schema.VERSION_2_COMMUNITY.getNamespace().getUri());
Assert.assertEquals("urn:foo:bar:preview:2", Schema.VERSION_2_PREVIEW.getNamespace().getUri());
Assert.assertEquals("urn:foo:bar:experimental:2", Schema.VERSION_2_EXPERIMENTAL.getNamespace().getUri());

Assert.assertEquals("urn:jboss:domain:foo:1.0", SubsystemSchema.createLegacySubsystemURN("foo", new IntVersion(1)).getUri());
Assert.assertEquals("urn:jboss:domain:foo:1.0", SubsystemSchema.createLegacySubsystemURN("foo", Stability.DEFAULT, new IntVersion(1)).getUri());
Expand All @@ -36,4 +69,29 @@ public void test() {
Assert.assertEquals("urn:wildfly:foo:2.0", SubsystemSchema.createSubsystemURN("foo", Stability.DEFAULT, new IntVersion(2)).getUri());
Assert.assertEquals("urn:wildfly:foo:preview:2.0", SubsystemSchema.createSubsystemURN("foo", Stability.PREVIEW, new IntVersion(2)).getUri());
}

@Test
public void stability() {
Assert.assertSame(Schema.VERSION_1_COMMUNITY.getStability(), Stability.COMMUNITY);
Assert.assertSame(Schema.VERSION_1_COMMUNITY.getNamespace().getStability(), Stability.COMMUNITY);
}

@Test
public void since() {
since(Schema.VERSION_1_DEFAULT, EnumSet.allOf(Schema.class));
since(Schema.VERSION_1_COMMUNITY, EnumSet.complementOf(EnumSet.of(Schema.VERSION_1_DEFAULT, Schema.VERSION_2_DEFAULT)));
since(Schema.VERSION_1_PREVIEW, EnumSet.of(Schema.VERSION_1_EXPERIMENTAL, Schema.VERSION_2_EXPERIMENTAL, Schema.VERSION_1_PREVIEW, Schema.VERSION_2_PREVIEW));
since(Schema.VERSION_1_EXPERIMENTAL, EnumSet.of(Schema.VERSION_1_EXPERIMENTAL, Schema.VERSION_2_EXPERIMENTAL));
since(Schema.VERSION_2_EXPERIMENTAL, EnumSet.of(Schema.VERSION_2_EXPERIMENTAL));
since(Schema.VERSION_2_PREVIEW, EnumSet.of(Schema.VERSION_2_EXPERIMENTAL, Schema.VERSION_2_PREVIEW));
since(Schema.VERSION_2_PREVIEW, EnumSet.of(Schema.VERSION_2_EXPERIMENTAL, Schema.VERSION_2_PREVIEW));
since(Schema.VERSION_2_COMMUNITY, EnumSet.of(Schema.VERSION_2_EXPERIMENTAL, Schema.VERSION_2_PREVIEW, Schema.VERSION_2_COMMUNITY));
since(Schema.VERSION_2_DEFAULT, EnumSet.of(Schema.VERSION_2_EXPERIMENTAL, Schema.VERSION_2_PREVIEW, Schema.VERSION_2_COMMUNITY, Schema.VERSION_2_DEFAULT));
}

private static void since(Schema testSchema, Set<Schema> since) {
for (Schema schema : EnumSet.allOf(Schema.class)) {
Assert.assertEquals(schema.name(), since.contains(schema), schema.since(testSchema));
}
}
}

0 comments on commit 022c37b

Please sign in to comment.