forked from apache/flink
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[FLINK-11753] [tests] Add hamcrest matchers for TypeSerializerSchemaC…
…ompatibility
- Loading branch information
Showing
4 changed files
with
215 additions
and
100 deletions.
There are no files selected for viewing
199 changes: 199 additions & 0 deletions
199
flink-core/src/test/java/org/apache/flink/api/common/typeutils/TypeSerializerMatchers.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,199 @@ | ||
/* | ||
* 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. | ||
*/ | ||
|
||
package org.apache.flink.api.common.typeutils; | ||
|
||
import org.hamcrest.CoreMatchers; | ||
import org.hamcrest.Description; | ||
import org.hamcrest.Matcher; | ||
import org.hamcrest.TypeSafeDiagnosingMatcher; | ||
import org.hamcrest.TypeSafeMatcher; | ||
|
||
import java.util.function.Predicate; | ||
|
||
import static org.apache.flink.util.Preconditions.checkNotNull; | ||
|
||
/** | ||
* A Collection of useful {@link Matcher}s for {@link TypeSerializer} and {@link TypeSerializerSchemaCompatibility}. | ||
*/ | ||
public final class TypeSerializerMatchers { | ||
|
||
private TypeSerializerMatchers() { | ||
} | ||
|
||
// ------------------------------------------------------------------------------------------------------------- | ||
// Matcher Factories | ||
// ------------------------------------------------------------------------------------------------------------- | ||
|
||
/** | ||
* Matches {@code compatibleAsIs} {@link TypeSerializerSchemaCompatibility}. | ||
* | ||
* @param <T> element type | ||
* @return a {@code Matcher} that matches {@code compatibleAsIs} {@link TypeSerializerSchemaCompatibility}. | ||
*/ | ||
public static <T> Matcher<TypeSerializerSchemaCompatibility<T>> isCompatibleAsIs() { | ||
return propertyMatcher(TypeSerializerSchemaCompatibility::isCompatibleAsIs, | ||
"type serializer schema that is a compatible as is"); | ||
} | ||
|
||
/** | ||
* Matches {@code isIncompatible} {@link TypeSerializerSchemaCompatibility}. | ||
* | ||
* @param <T> element type | ||
* @return a {@code Matcher} that matches {@code isIncompatible} {@link TypeSerializerSchemaCompatibility}. | ||
*/ | ||
public static <T> Matcher<TypeSerializerSchemaCompatibility<T>> isIncompatible() { | ||
return propertyMatcher(TypeSerializerSchemaCompatibility::isIncompatible, | ||
"type serializer schema that is incompatible"); | ||
} | ||
|
||
/** | ||
* Matches {@code isCompatibleAfterMigration} {@link TypeSerializerSchemaCompatibility}. | ||
* | ||
* @param <T> element type | ||
* @return a {@code Matcher} that matches {@code isCompatibleAfterMigration} {@link TypeSerializerSchemaCompatibility}. | ||
*/ | ||
public static <T> Matcher<TypeSerializerSchemaCompatibility<T>> isCompatibleAfterMigration() { | ||
return propertyMatcher(TypeSerializerSchemaCompatibility::isCompatibleAfterMigration, | ||
"type serializer schema that is compatible after migration"); | ||
} | ||
|
||
/** | ||
* Matches {@code isCompatibleWithReconfiguredSerializer} {@link TypeSerializerSchemaCompatibility}. | ||
* | ||
* @param <T> element type | ||
* @return a {@code Matcher} that matches {@code isCompatibleWithReconfiguredSerializer} {@link TypeSerializerSchemaCompatibility}. | ||
*/ | ||
public static <T> Matcher<TypeSerializerSchemaCompatibility<T>> isCompatibleWithReconfiguredSerializer() { | ||
@SuppressWarnings("unchecked") Matcher<TypeSerializer<T>> anything = | ||
(Matcher<TypeSerializer<T>>) (Matcher<?>) CoreMatchers.anything(); | ||
|
||
return new CompatibleAfterReconfiguration<>(anything); | ||
} | ||
|
||
/** | ||
* Matches {@code isCompatibleWithReconfiguredSerializer} {@link TypeSerializerSchemaCompatibility}. | ||
* | ||
* @param reconfiguredSerializerMatcher matches the reconfigured serializer. | ||
* @param <T> element type | ||
* @return a {@code Matcher} that matches {@code isCompatibleWithReconfiguredSerializer} {@link TypeSerializerSchemaCompatibility}. | ||
*/ | ||
public static <T> Matcher<TypeSerializerSchemaCompatibility<T>> isCompatibleWithReconfiguredSerializer( | ||
Matcher<? extends TypeSerializer<T>> reconfiguredSerializerMatcher) { | ||
|
||
return new CompatibleAfterReconfiguration<>(reconfiguredSerializerMatcher); | ||
} | ||
|
||
/** | ||
* Matches if the expected {@code TypeSerializerSchemaCompatibility} has the same compatibility as {@code expectedCompatibility}. | ||
* | ||
* @param expectedCompatibility the compatibility to match to. | ||
* @param <T> element type. | ||
* @return a {@code Matcher} that matches if it has the same compatibility as {@code expectedCompatibility}. | ||
*/ | ||
public static <T> Matcher<TypeSerializerSchemaCompatibility<T>> hasSameCompatibilityAs( | ||
TypeSerializerSchemaCompatibility<T> expectedCompatibility) { | ||
|
||
return new SchemaCompatibilitySameAs<>(expectedCompatibility); | ||
} | ||
|
||
// ------------------------------------------------------------------------------------------------------------- | ||
// Helpers | ||
// ------------------------------------------------------------------------------------------------------------- | ||
|
||
private static <T> Matcher<T> propertyMatcher(Predicate<T> predicate, String matcherDescription) { | ||
return new TypeSafeMatcher<T>() { | ||
|
||
@Override | ||
protected boolean matchesSafely(T item) { | ||
return predicate.test(item); | ||
} | ||
|
||
@Override | ||
public void describeTo(Description description) { | ||
description.appendText(matcherDescription); | ||
} | ||
}; | ||
} | ||
|
||
// ------------------------------------------------------------------------------------------------------------- | ||
// Matchers | ||
// ------------------------------------------------------------------------------------------------------------- | ||
|
||
private static final class CompatibleAfterReconfiguration<T> | ||
extends TypeSafeDiagnosingMatcher<TypeSerializerSchemaCompatibility<T>> { | ||
|
||
private final Matcher<? extends TypeSerializer<T>> reconfiguredSerializerMatcher; | ||
|
||
private CompatibleAfterReconfiguration(Matcher<? extends TypeSerializer<T>> reconfiguredSerializerMatcher) { | ||
this.reconfiguredSerializerMatcher = checkNotNull(reconfiguredSerializerMatcher); | ||
} | ||
|
||
@Override | ||
protected boolean matchesSafely(TypeSerializerSchemaCompatibility<T> item, Description mismatchDescription) { | ||
if (!item.isCompatibleWithReconfiguredSerializer()) { | ||
mismatchDescription.appendText("serializer schema is not compatible with a reconfigured serializer"); | ||
return false; | ||
} | ||
TypeSerializer<T> reconfiguredSerializer = item.getReconfiguredSerializer(); | ||
if (!reconfiguredSerializerMatcher.matches(reconfiguredSerializer)) { | ||
reconfiguredSerializerMatcher.describeMismatch(reconfiguredSerializer, mismatchDescription); | ||
return false; | ||
} | ||
return true; | ||
} | ||
|
||
@Override | ||
public void describeTo(Description description) { | ||
description.appendText("type serializer schema that is compatible after reconfiguration,") | ||
.appendText("with a reconfigured serializer matching ") | ||
.appendDescriptionOf(reconfiguredSerializerMatcher); | ||
} | ||
} | ||
|
||
private static class SchemaCompatibilitySameAs<T> extends TypeSafeMatcher<TypeSerializerSchemaCompatibility<T>> { | ||
|
||
private final TypeSerializerSchemaCompatibility<T> expectedCompatibility; | ||
|
||
private SchemaCompatibilitySameAs(TypeSerializerSchemaCompatibility<T> expectedCompatibility) { | ||
this.expectedCompatibility = checkNotNull(expectedCompatibility); | ||
} | ||
|
||
@Override | ||
protected boolean matchesSafely(TypeSerializerSchemaCompatibility<T> testResultCompatibility) { | ||
if (expectedCompatibility.isCompatibleAsIs()) { | ||
return testResultCompatibility.isCompatibleAsIs(); | ||
} | ||
else if (expectedCompatibility.isIncompatible()) { | ||
return testResultCompatibility.isIncompatible(); | ||
} | ||
else if (expectedCompatibility.isCompatibleAfterMigration()) { | ||
return testResultCompatibility.isCompatibleAfterMigration(); | ||
} | ||
else if (expectedCompatibility.isCompatibleWithReconfiguredSerializer()) { | ||
return testResultCompatibility.isCompatibleWithReconfiguredSerializer(); | ||
} | ||
return false; | ||
} | ||
|
||
@Override | ||
public void describeTo(Description description) { | ||
description.appendText("same compatibility as ").appendValue(expectedCompatibility); | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.