GJL commented on a change in pull request #7986: [FLINK-10517][rest] Add stability test URL: https://github.com/apache/flink/pull/7986#discussion_r274479508
########## File path: flink-runtime/src/test/java/org/apache/flink/runtime/rest/compatibility/CompatibilityRoutines.java ########## @@ -0,0 +1,270 @@ +/* + * 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.runtime.rest.compatibility; + +import org.apache.flink.api.java.tuple.Tuple2; +import org.apache.flink.runtime.rest.handler.RestHandlerSpecification; +import org.apache.flink.runtime.rest.messages.UntypedResponseMessageHeaders; + +import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.core.JsonProcessingException; +import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.databind.JsonNode; +import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.databind.ObjectMapper; +import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.module.jsonSchema.JsonSchema; +import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.module.jsonSchema.JsonSchemaGenerator; + +import org.junit.Assert; + +import java.util.ArrayDeque; +import java.util.Arrays; +import java.util.Collection; +import java.util.Collections; +import java.util.Deque; +import java.util.Iterator; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.stream.Collectors; + +/** + * Contains the compatibility checks that are applied by the {@link RestAPIStabilityTest}. New checks must be added to + * the {@link CompatibilityRoutines#ROUTINES} collection. + */ +enum CompatibilityRoutines { + ; + + private static final CompatibilityRoutine<String> URL_ROUTINE = new CompatibilityRoutine<>( + "url", + String.class, + RestHandlerSpecification::getTargetRestEndpointURL, + Assert::assertEquals); + + private static final CompatibilityRoutine<String> METHOD_ROUTINE = new CompatibilityRoutine<>( + "method", + String.class, + header -> header.getHttpMethod().getNettyHttpMethod().name(), + Assert::assertEquals); + + private static final CompatibilityRoutine<String> STATUS_CODE_ROUTINE = new CompatibilityRoutine<>( + "status-code", + String.class, + header -> header.getResponseStatusCode().toString(), + Assert::assertEquals); + + private static final CompatibilityRoutine<Boolean> FILE_UPLOAD_ROUTINE = new CompatibilityRoutine<>( + "file-upload", + Boolean.class, + UntypedResponseMessageHeaders::acceptsFileUploads, + Assert::assertEquals); + + private static final CompatibilityRoutine<PathParameterContainer> PATH_PARAMETER_ROUTINE = new CompatibilityRoutine<>( + "path-parameters", + PathParameterContainer.class, + header -> { + List<PathParameterContainer.PathParameter> pathParameters = header.getUnresolvedMessageParameters().getPathParameters().stream() + .map(param -> new PathParameterContainer.PathParameter(param.getKey())) + .collect(Collectors.toList()); + return new PathParameterContainer(pathParameters); + }, + CompatibilityRoutines::assertCompatible); + + private static final CompatibilityRoutine<QueryParameterContainer> QUERY_PARAMETER_ROUTINE = new CompatibilityRoutine<>( + "query-parameters", + QueryParameterContainer.class, + header -> { + List<QueryParameterContainer.QueryParameter> pathParameters = header.getUnresolvedMessageParameters().getQueryParameters().stream() + .map(param -> new QueryParameterContainer.QueryParameter(param.getKey(), param.isMandatory())) + .collect(Collectors.toList()); + return new QueryParameterContainer(pathParameters); + }, + CompatibilityRoutines::assertCompatible); + + private static final CompatibilityRoutine<JsonNode> REQUEST_ROUTINE = new CompatibilityRoutine<>( + "request", + JsonNode.class, + header -> extractSchema(header.getRequestClass()), + CompatibilityRoutines::assertCompatible + ); + + private static final CompatibilityRoutine<JsonNode> RESPONSE_ROUTINE = new CompatibilityRoutine<>( + "response", + JsonNode.class, + header -> extractSchema(header.getResponseClass()), + CompatibilityRoutines::assertCompatible + ); + + static final Collection<CompatibilityRoutine<?>> ROUTINES = Collections.unmodifiableList(Arrays.asList( + URL_ROUTINE, + METHOD_ROUTINE, + STATUS_CODE_ROUTINE, + FILE_UPLOAD_ROUTINE, + PATH_PARAMETER_ROUTINE, + QUERY_PARAMETER_ROUTINE, + REQUEST_ROUTINE, + RESPONSE_ROUTINE + )); + + private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper(); + private static final JsonSchemaGenerator schemaGen = new JsonSchemaGenerator(OBJECT_MAPPER); Review comment: nit: Why is `schemaGen` not uppercased like `OBJECT_MAPPER`? ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
