-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Core: Add explicit JSON parser for LoadTableResponse (#11148)
- Loading branch information
Showing
4 changed files
with
322 additions
and
2 deletions.
There are no files selected for viewing
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
90 changes: 90 additions & 0 deletions
90
core/src/main/java/org/apache/iceberg/rest/responses/LoadTableResponseParser.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,90 @@ | ||
| /* | ||
| * 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.iceberg.rest.responses; | ||
|
|
||
| import com.fasterxml.jackson.core.JsonGenerator; | ||
| import com.fasterxml.jackson.databind.JsonNode; | ||
| import java.io.IOException; | ||
| import org.apache.iceberg.TableMetadata; | ||
| import org.apache.iceberg.TableMetadataParser; | ||
| import org.apache.iceberg.relocated.com.google.common.base.Preconditions; | ||
| import org.apache.iceberg.util.JsonUtil; | ||
|
|
||
| public class LoadTableResponseParser { | ||
|
|
||
| private static final String METADATA_LOCATION = "metadata-location"; | ||
| private static final String METADATA = "metadata"; | ||
| private static final String CONFIG = "config"; | ||
|
|
||
| private LoadTableResponseParser() {} | ||
|
|
||
| public static String toJson(LoadTableResponse response) { | ||
| return toJson(response, false); | ||
| } | ||
|
|
||
| public static String toJson(LoadTableResponse response, boolean pretty) { | ||
| return JsonUtil.generate(gen -> toJson(response, gen), pretty); | ||
| } | ||
|
|
||
| public static void toJson(LoadTableResponse response, JsonGenerator gen) throws IOException { | ||
| Preconditions.checkArgument(null != response, "Invalid load table response: null"); | ||
|
|
||
| gen.writeStartObject(); | ||
|
|
||
| if (null != response.metadataLocation()) { | ||
| gen.writeStringField(METADATA_LOCATION, response.metadataLocation()); | ||
| } | ||
|
|
||
| gen.writeFieldName(METADATA); | ||
| TableMetadataParser.toJson(response.tableMetadata(), gen); | ||
|
|
||
| if (!response.config().isEmpty()) { | ||
| JsonUtil.writeStringMap(CONFIG, response.config(), gen); | ||
| } | ||
|
|
||
| gen.writeEndObject(); | ||
| } | ||
|
|
||
| public static LoadTableResponse fromJson(String json) { | ||
| return JsonUtil.parse(json, LoadTableResponseParser::fromJson); | ||
| } | ||
|
|
||
| public static LoadTableResponse fromJson(JsonNode json) { | ||
| Preconditions.checkArgument(null != json, "Cannot parse load table response from null object"); | ||
|
|
||
| String metadataLocation = null; | ||
| if (json.hasNonNull(METADATA_LOCATION)) { | ||
| metadataLocation = JsonUtil.getString(METADATA_LOCATION, json); | ||
| } | ||
|
|
||
| TableMetadata metadata = TableMetadataParser.fromJson(JsonUtil.get(METADATA, json)); | ||
|
|
||
| if (null != metadataLocation) { | ||
| metadata = TableMetadata.buildFrom(metadata).withMetadataLocation(metadataLocation).build(); | ||
| } | ||
|
|
||
| LoadTableResponse.Builder builder = LoadTableResponse.builder().withTableMetadata(metadata); | ||
|
|
||
| if (json.hasNonNull(CONFIG)) { | ||
| builder.addAllConfig(JsonUtil.getStringMap(CONFIG, json)); | ||
| } | ||
|
|
||
| return builder.build(); | ||
| } | ||
| } |
203 changes: 203 additions & 0 deletions
203
core/src/test/java/org/apache/iceberg/rest/responses/TestLoadTableResponseParser.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,203 @@ | ||
| /* | ||
| * 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.iceberg.rest.responses; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static org.assertj.core.api.Assertions.assertThatThrownBy; | ||
|
|
||
| import com.fasterxml.jackson.databind.JsonNode; | ||
| import org.apache.iceberg.PartitionSpec; | ||
| import org.apache.iceberg.Schema; | ||
| import org.apache.iceberg.SortOrder; | ||
| import org.apache.iceberg.TableMetadata; | ||
| import org.apache.iceberg.relocated.com.google.common.collect.ImmutableMap; | ||
| import org.apache.iceberg.types.Types; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| public class TestLoadTableResponseParser { | ||
|
|
||
| @Test | ||
| public void nullAndEmptyCheck() { | ||
| assertThatThrownBy(() -> LoadTableResponseParser.toJson(null)) | ||
| .isInstanceOf(IllegalArgumentException.class) | ||
| .hasMessage("Invalid load table response: null"); | ||
|
|
||
| assertThatThrownBy(() -> LoadTableResponseParser.fromJson((JsonNode) null)) | ||
| .isInstanceOf(IllegalArgumentException.class) | ||
| .hasMessage("Cannot parse load table response from null object"); | ||
|
|
||
| assertThatThrownBy(() -> LoadTableResponseParser.fromJson("{}")) | ||
| .isInstanceOf(IllegalArgumentException.class) | ||
| .hasMessage("Cannot parse missing field: metadata"); | ||
| } | ||
|
|
||
| @Test | ||
| public void missingFields() { | ||
| assertThatThrownBy( | ||
| () -> LoadTableResponseParser.fromJson("{\"metadata-location\": \"custom-location\"}")) | ||
| .isInstanceOf(IllegalArgumentException.class) | ||
| .hasMessage("Cannot parse missing field: metadata"); | ||
| } | ||
|
|
||
| @Test | ||
| public void roundTripSerde() { | ||
| String uuid = "386b9f01-002b-4d8c-b77f-42c3fd3b7c9b"; | ||
| TableMetadata metadata = | ||
| TableMetadata.buildFromEmpty() | ||
| .assignUUID(uuid) | ||
| .setLocation("location") | ||
| .setCurrentSchema( | ||
| new Schema(Types.NestedField.required(1, "x", Types.LongType.get())), 1) | ||
| .addPartitionSpec(PartitionSpec.unpartitioned()) | ||
| .addSortOrder(SortOrder.unsorted()) | ||
| .discardChanges() | ||
| .withMetadataLocation("metadata-location") | ||
| .build(); | ||
|
|
||
| LoadTableResponse response = LoadTableResponse.builder().withTableMetadata(metadata).build(); | ||
|
|
||
| String expectedJson = | ||
| String.format( | ||
| "{\n" | ||
| + " \"metadata-location\" : \"metadata-location\",\n" | ||
| + " \"metadata\" : {\n" | ||
| + " \"format-version\" : 2,\n" | ||
| + " \"table-uuid\" : \"386b9f01-002b-4d8c-b77f-42c3fd3b7c9b\",\n" | ||
| + " \"location\" : \"location\",\n" | ||
| + " \"last-sequence-number\" : 0,\n" | ||
| + " \"last-updated-ms\" : %d,\n" | ||
| + " \"last-column-id\" : 1,\n" | ||
| + " \"current-schema-id\" : 0,\n" | ||
| + " \"schemas\" : [ {\n" | ||
| + " \"type\" : \"struct\",\n" | ||
| + " \"schema-id\" : 0,\n" | ||
| + " \"fields\" : [ {\n" | ||
| + " \"id\" : 1,\n" | ||
| + " \"name\" : \"x\",\n" | ||
| + " \"required\" : true,\n" | ||
| + " \"type\" : \"long\"\n" | ||
| + " } ]\n" | ||
| + " } ],\n" | ||
| + " \"default-spec-id\" : 0,\n" | ||
| + " \"partition-specs\" : [ {\n" | ||
| + " \"spec-id\" : 0,\n" | ||
| + " \"fields\" : [ ]\n" | ||
| + " } ],\n" | ||
| + " \"last-partition-id\" : 999,\n" | ||
| + " \"default-sort-order-id\" : 0,\n" | ||
| + " \"sort-orders\" : [ {\n" | ||
| + " \"order-id\" : 0,\n" | ||
| + " \"fields\" : [ ]\n" | ||
| + " } ],\n" | ||
| + " \"properties\" : { },\n" | ||
| + " \"current-snapshot-id\" : -1,\n" | ||
| + " \"refs\" : { },\n" | ||
| + " \"snapshots\" : [ ],\n" | ||
| + " \"statistics\" : [ ],\n" | ||
| + " \"partition-statistics\" : [ ],\n" | ||
| + " \"snapshot-log\" : [ ],\n" | ||
| + " \"metadata-log\" : [ ]\n" | ||
| + " }\n" | ||
| + "}", | ||
| metadata.lastUpdatedMillis()); | ||
|
|
||
| String json = LoadTableResponseParser.toJson(response, true); | ||
| assertThat(json).isEqualTo(expectedJson); | ||
| // can't do an equality comparison because Schema doesn't implement equals/hashCode | ||
| assertThat(LoadTableResponseParser.toJson(LoadTableResponseParser.fromJson(json), true)) | ||
| .isEqualTo(expectedJson); | ||
| } | ||
|
|
||
| @Test | ||
| public void roundTripSerdeWithConfig() { | ||
| String uuid = "386b9f01-002b-4d8c-b77f-42c3fd3b7c9b"; | ||
| TableMetadata metadata = | ||
| TableMetadata.buildFromEmpty() | ||
| .assignUUID(uuid) | ||
| .setLocation("location") | ||
| .setCurrentSchema( | ||
| new Schema(Types.NestedField.required(1, "x", Types.LongType.get())), 1) | ||
| .addPartitionSpec(PartitionSpec.unpartitioned()) | ||
| .addSortOrder(SortOrder.unsorted()) | ||
| .discardChanges() | ||
| .withMetadataLocation("metadata-location") | ||
| .build(); | ||
|
|
||
| LoadTableResponse response = | ||
| LoadTableResponse.builder() | ||
| .withTableMetadata(metadata) | ||
| .addAllConfig(ImmutableMap.of("key1", "val1", "key2", "val2")) | ||
| .build(); | ||
|
|
||
| String expectedJson = | ||
| String.format( | ||
| "{\n" | ||
| + " \"metadata-location\" : \"metadata-location\",\n" | ||
| + " \"metadata\" : {\n" | ||
| + " \"format-version\" : 2,\n" | ||
| + " \"table-uuid\" : \"386b9f01-002b-4d8c-b77f-42c3fd3b7c9b\",\n" | ||
| + " \"location\" : \"location\",\n" | ||
| + " \"last-sequence-number\" : 0,\n" | ||
| + " \"last-updated-ms\" : %d,\n" | ||
| + " \"last-column-id\" : 1,\n" | ||
| + " \"current-schema-id\" : 0,\n" | ||
| + " \"schemas\" : [ {\n" | ||
| + " \"type\" : \"struct\",\n" | ||
| + " \"schema-id\" : 0,\n" | ||
| + " \"fields\" : [ {\n" | ||
| + " \"id\" : 1,\n" | ||
| + " \"name\" : \"x\",\n" | ||
| + " \"required\" : true,\n" | ||
| + " \"type\" : \"long\"\n" | ||
| + " } ]\n" | ||
| + " } ],\n" | ||
| + " \"default-spec-id\" : 0,\n" | ||
| + " \"partition-specs\" : [ {\n" | ||
| + " \"spec-id\" : 0,\n" | ||
| + " \"fields\" : [ ]\n" | ||
| + " } ],\n" | ||
| + " \"last-partition-id\" : 999,\n" | ||
| + " \"default-sort-order-id\" : 0,\n" | ||
| + " \"sort-orders\" : [ {\n" | ||
| + " \"order-id\" : 0,\n" | ||
| + " \"fields\" : [ ]\n" | ||
| + " } ],\n" | ||
| + " \"properties\" : { },\n" | ||
| + " \"current-snapshot-id\" : -1,\n" | ||
| + " \"refs\" : { },\n" | ||
| + " \"snapshots\" : [ ],\n" | ||
| + " \"statistics\" : [ ],\n" | ||
| + " \"partition-statistics\" : [ ],\n" | ||
| + " \"snapshot-log\" : [ ],\n" | ||
| + " \"metadata-log\" : [ ]\n" | ||
| + " },\n" | ||
| + " \"config\" : {\n" | ||
| + " \"key1\" : \"val1\",\n" | ||
| + " \"key2\" : \"val2\"\n" | ||
| + " }\n" | ||
| + "}", | ||
| metadata.lastUpdatedMillis()); | ||
|
|
||
| String json = LoadTableResponseParser.toJson(response, true); | ||
| assertThat(json).isEqualTo(expectedJson); | ||
| // can't do an equality comparison because Schema doesn't implement equals/hashCode | ||
| assertThat(LoadTableResponseParser.toJson(LoadTableResponseParser.fromJson(json), true)) | ||
| .isEqualTo(expectedJson); | ||
| } | ||
| } |