This is an automated email from the ASF dual-hosted git repository.
gian pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/druid.git
The following commit(s) were added to refs/heads/master by this push:
new 80b212f druid.storage.maxListingLength should default to 1000 for s3
(#9858)
80b212f is described below
commit 80b212fe43af1f6d3272f84de506fd124f33fbd4
Author: zachjsh <[email protected]>
AuthorDate: Thu May 14 10:00:51 2020 -0400
druid.storage.maxListingLength should default to 1000 for s3 (#9858)
* druid.storage.maxListingLength should default to 1000 for s3
* * Address review comments
* * Address review comments
* * Address comments
---
.../apache/druid/storage/s3/S3InputDataConfig.java | 27 +++-
.../druid/storage/s3/S3InputDataConfigTest.java | 142 +++++++++++++++++++++
2 files changed, 166 insertions(+), 3 deletions(-)
diff --git
a/extensions-core/s3-extensions/src/main/java/org/apache/druid/storage/s3/S3InputDataConfig.java
b/extensions-core/s3-extensions/src/main/java/org/apache/druid/storage/s3/S3InputDataConfig.java
index ed97c47..7847ceb 100644
---
a/extensions-core/s3-extensions/src/main/java/org/apache/druid/storage/s3/S3InputDataConfig.java
+++
b/extensions-core/s3-extensions/src/main/java/org/apache/druid/storage/s3/S3InputDataConfig.java
@@ -20,7 +20,10 @@
package org.apache.druid.storage.s3;
import com.fasterxml.jackson.annotation.JsonProperty;
+import com.google.common.annotations.VisibleForTesting;
+import org.apache.druid.java.util.common.IAE;
+import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
/**
@@ -29,16 +32,34 @@ import javax.validation.constraints.Min;
*/
public class S3InputDataConfig
{
+ @VisibleForTesting
+ static final int MAX_LISTING_LENGTH_MIN = 1;
+
+ /**
+ * AWS S3 only allows listing and deleting 1000 elements at a time:
+ *
https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html#API_ListObjects_RequestSyntax
+ *
https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjects.html#API_DeleteObjects_RequestSyntax
+ */
+ @VisibleForTesting
+ static final int MAX_LISTING_LENGTH_MAX = 1000;
+
/**
* The maximum number of input files matching a given prefix to retrieve
- * from Amazon S3 at a time.
+ * or delete from Amazon S3 at a time.
*/
@JsonProperty
- @Min(1)
- private int maxListingLength = 1024;
+ @Min(MAX_LISTING_LENGTH_MIN)
+ @Max(MAX_LISTING_LENGTH_MAX)
+ private int maxListingLength = MAX_LISTING_LENGTH_MAX;
+ @VisibleForTesting
public void setMaxListingLength(int maxListingLength)
{
+ if (maxListingLength < MAX_LISTING_LENGTH_MIN || maxListingLength >
MAX_LISTING_LENGTH_MAX) {
+ throw new IAE("valid values for maxListingLength are between [%d, %d]",
MAX_LISTING_LENGTH_MIN,
+ MAX_LISTING_LENGTH_MAX
+ );
+ }
this.maxListingLength = maxListingLength;
}
diff --git
a/extensions-core/s3-extensions/src/test/java/org/apache/druid/storage/s3/S3InputDataConfigTest.java
b/extensions-core/s3-extensions/src/test/java/org/apache/druid/storage/s3/S3InputDataConfigTest.java
new file mode 100644
index 0000000..ab6185c
--- /dev/null
+++
b/extensions-core/s3-extensions/src/test/java/org/apache/druid/storage/s3/S3InputDataConfigTest.java
@@ -0,0 +1,142 @@
+/*
+ * 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.druid.storage.s3;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.apache.druid.java.util.common.IAE;
+import org.apache.druid.java.util.common.StringUtils;
+import org.junit.Assert;
+import org.junit.Test;
+
+public class S3InputDataConfigTest
+{
+ private static final int MAX_LISTING_LENGTH_TOO_LOW =
S3InputDataConfig.MAX_LISTING_LENGTH_MIN - 1;
+ private static final int MAX_LISTING_LENGTH_TOO_HIGH =
S3InputDataConfig.MAX_LISTING_LENGTH_MAX + 1;
+ private static final String INPUT_DATA_TEMPLATE_JSON_STR =
+ "{\n"
+ + " \"maxListingLength\": \"%1$d\"\n"
+ + "}";
+
+ private static final ObjectMapper JSON_MAPPER = new ObjectMapper();
+ private S3InputDataConfig inputDataConfig;
+
+ @Test
+ public void test_construct_maxListingLengthTooLow_throwsException()
+ {
+ boolean exceptionThrown = false;
+ try {
+ inputDataConfig =
JSON_MAPPER.readValue(formatTemplate(MAX_LISTING_LENGTH_TOO_LOW),
S3InputDataConfig.class);
+ }
+ catch (JsonProcessingException e) {
+ exceptionThrown = true;
+ }
+ Assert.assertTrue(exceptionThrown);
+ }
+
+ @Test
+ public void test_construct_maxListingLengthTooHigh_throwsException()
+ {
+ boolean exceptionThrown = false;
+ try {
+ inputDataConfig =
JSON_MAPPER.readValue(formatTemplate(MAX_LISTING_LENGTH_TOO_HIGH),
S3InputDataConfig.class);
+ }
+ catch (JsonProcessingException e) {
+ exceptionThrown = true;
+ }
+ Assert.assertTrue(exceptionThrown);
+ }
+
+ @Test
+ public void test_construct_maxListingLengthMin_succeeds() throws
JsonProcessingException
+ {
+ inputDataConfig = JSON_MAPPER.readValue(
+ formatTemplate(S3InputDataConfig.MAX_LISTING_LENGTH_MIN),
+ S3InputDataConfig.class
+ );
+ Assert.assertEquals(S3InputDataConfig.MAX_LISTING_LENGTH_MIN,
inputDataConfig.getMaxListingLength());
+ }
+
+ @Test
+ public void test_construct_maxListingLengthMax_succeeds() throws
JsonProcessingException
+ {
+ inputDataConfig = JSON_MAPPER.readValue(
+ formatTemplate(S3InputDataConfig.MAX_LISTING_LENGTH_MAX),
+ S3InputDataConfig.class
+ );
+ Assert.assertEquals(S3InputDataConfig.MAX_LISTING_LENGTH_MAX,
inputDataConfig.getMaxListingLength());
+ }
+
+ @Test
+ public void test_setMaxListingLength_maxListingLengthTooLow_throwsException()
+ {
+ boolean exceptionThrown = false;
+ try {
+ inputDataConfig = new S3InputDataConfig();
+ inputDataConfig.setMaxListingLength(MAX_LISTING_LENGTH_TOO_LOW);
+ }
+ catch (IAE e) {
+ exceptionThrown = true;
+ }
+ Assert.assertTrue(exceptionThrown);
+ }
+
+ @Test
+ public void
test_setMaxListingLength_maxListingLengthTooHigh_throwsException()
+ {
+ boolean exceptionThrown = false;
+ try {
+ inputDataConfig = new S3InputDataConfig();
+ inputDataConfig.setMaxListingLength(MAX_LISTING_LENGTH_TOO_HIGH);
+ }
+ catch (IAE e) {
+ exceptionThrown = true;
+ }
+ Assert.assertTrue(exceptionThrown);
+ }
+
+ @Test
+ public void test_setMaxListingLength_maxListingLengthMin_succeeds() throws
IAE
+ {
+ inputDataConfig = new S3InputDataConfig();
+
inputDataConfig.setMaxListingLength(S3InputDataConfig.MAX_LISTING_LENGTH_MIN);
+ Assert.assertEquals(S3InputDataConfig.MAX_LISTING_LENGTH_MIN,
inputDataConfig.getMaxListingLength());
+ }
+
+ @Test
+ public void test_setMaxListingLength_maxListingLengthMax_succeeds() throws
IAE
+ {
+ inputDataConfig = new S3InputDataConfig();
+
inputDataConfig.setMaxListingLength(S3InputDataConfig.MAX_LISTING_LENGTH_MAX);
+ Assert.assertEquals(S3InputDataConfig.MAX_LISTING_LENGTH_MAX,
inputDataConfig.getMaxListingLength());
+ }
+
+ @Test
+ public void test_construct_maxListingLengthDefaultsToMax()
+ {
+ inputDataConfig = new S3InputDataConfig();
+ Assert.assertEquals(S3InputDataConfig.MAX_LISTING_LENGTH_MAX,
inputDataConfig.getMaxListingLength());
+ }
+
+ private static String formatTemplate(int maxListingLength)
+ {
+ return StringUtils.format(INPUT_DATA_TEMPLATE_JSON_STR, maxListingLength);
+ }
+}
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
