Aliyun: Mock aliyun OSS(Object Storage Service)

aliyun/src/test/java/org/apache/iceberg/aliyun/oss/AliyunOSSTestRule.java

@@ -0,0 +1,82 @@
+/*
+ * 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.aliyun.oss;
+
+import com.aliyun.oss.OSS;
+import java.util.UUID;
+import org.junit.rules.TestRule;
+import org.junit.runner.Description;
+import org.junit.runners.model.Statement;
+
+/**
+ * API for test Aliyun Object Storage Service (OSS) which is either local mock http server or remote aliyun oss server
+ * <p>
+ * This API includes start,stop OSS service, create OSS client, setup bucket and teardown bucket.
+ */
+public interface AliyunOSSTestRule extends TestRule {
+  UUID RANDOM_UUID = java.util.UUID.randomUUID();
+
+  /**
+   * Returns a specific bucket name for testing purpose.
+   */
+  default String testBucketName() {
+    return String.format("oss-testing-bucket-%s", RANDOM_UUID);
+  }
+
+  @Override
+  default Statement apply(Statement base, Description description) {
+    return new Statement() {
+      @Override
+      public void evaluate() throws Throwable {
+        start();
+        try {
+          base.evaluate();
+        } finally {
+          stop();
+        }
+      }
+    };
+  }
+
+  /**
+   * Start the Aliyun Object storage services application that the OSS client could connect to.
+   */
+  void start();
+
+  /**
+   * Stop the Aliyun object storage services.
+   */
+  void stop();
+
+  /**
+   * Returns an newly created {@link OSS} client.
+   */
+  OSS createOSSClient();
+
+  /**
+   * Preparation work of bucket for the test case, for example we need to check the existence of specific bucket.
+   */
+  void setUpBucket(String bucket);
+
+  /**
+   * Clean all the objects that created from this test suite in the bucket.
+   */
+  void tearDownBucket(String bucket);
+}

aliyun/src/test/java/org/apache/iceberg/aliyun/oss/mock/AliyunOSSMockApp.java

@@ -0,0 +1,156 @@
+/*
+ * 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.aliyun.oss.mock;
+
+import java.util.List;
+import java.util.Map;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import org.apache.iceberg.relocated.com.google.common.base.Preconditions;
+import org.apache.iceberg.relocated.com.google.common.collect.Lists;
+import org.apache.iceberg.relocated.com.google.common.collect.Maps;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.Banner;
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
+import org.springframework.boot.autoconfigure.security.servlet.SecurityAutoConfiguration;
+import org.springframework.boot.builder.SpringApplicationBuilder;
+import org.springframework.context.ConfigurableApplicationContext;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.ComponentScan;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.core.convert.converter.Converter;
+import org.springframework.http.MediaType;
+import org.springframework.http.converter.xml.MappingJackson2XmlHttpMessageConverter;
+import org.springframework.util.StringUtils;
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
+
+@SuppressWarnings("checkstyle:AnnotationUseStyle")
+@Configuration
+@EnableAutoConfiguration(exclude = {SecurityAutoConfiguration.class}, excludeName = {
+    "org.springframework.boot.actuate.autoconfigure.security.servlet.ManagementWebSecurityAutoConfiguration"
+})
+@ComponentScan
+public class AliyunOSSMockApp {
+
+  static final String PROP_ROOT_DIR = "root-dir";
+
+  static final String PROP_HTTP_PORT = "server.port";
+  static final int PORT_HTTP_PORT_DEFAULT = 9393;
+
+  static final String PROP_SILENT = "silent";
+
+  @Autowired
+  private ConfigurableApplicationContext context;
+
+  public static AliyunOSSMockApp start(Map<String, Object> properties, String... args) {
+    Map<String, Object> defaults = Maps.newHashMap();
+    defaults.put(PROP_HTTP_PORT, PORT_HTTP_PORT_DEFAULT);
+
+    Banner.Mode bannerMode = Banner.Mode.CONSOLE;
+
+    if (Boolean.parseBoolean(String.valueOf(properties.remove(PROP_SILENT)))) {
+      defaults.put("logging.level.root", "WARN");
+      bannerMode = Banner.Mode.OFF;
+    }
+
+    final ConfigurableApplicationContext ctx =
+        new SpringApplicationBuilder(AliyunOSSMockApp.class)
+            .properties(defaults)
+            .properties(properties)
+            .bannerMode(bannerMode)
+            .run(args);
+
+    return ctx.getBean(AliyunOSSMockApp.class);
+  }
+
+  public void stop() {
+    SpringApplication.exit(context, () -> 0);
+  }
+
+  @Configuration
+  static class Config implements WebMvcConfigurer {
+
+    @Bean
+    Converter<String, Range> rangeConverter() {
+      return new RangeConverter();
+    }
+
+    /**
+     * Creates an HttpMessageConverter for XML.
+     *
+     * @return The configured {@link MappingJackson2XmlHttpMessageConverter}.
+     */
+    @Bean
+    public MappingJackson2XmlHttpMessageConverter getMessageConverter() {
+      List<MediaType> mediaTypes = Lists.newArrayList();
+      mediaTypes.add(MediaType.APPLICATION_XML);
+      mediaTypes.add(MediaType.APPLICATION_FORM_URLENCODED);
+      mediaTypes.add(MediaType.APPLICATION_OCTET_STREAM);
+
+      final MappingJackson2XmlHttpMessageConverter xmlConverter = new MappingJackson2XmlHttpMessageConverter();
+      xmlConverter.setSupportedMediaTypes(mediaTypes);
+
+      return xmlConverter;
+    }
+  }
+
+  private static class RangeConverter implements Converter<String, Range> {
+
+    private static final Pattern REQUESTED_RANGE_PATTERN = Pattern.compile("^bytes=((\\d*)-(\\d*))((,\\d*-\\d*)*)");
+
+    @Override
+    public Range convert(String rangeString) {
+      Preconditions.checkNotNull(rangeString, "Range value should not be null.");
+
+      final Range range;
+
+      // parsing a range specification of format: "bytes=start-end" - multiple ranges not supported
+      final Matcher matcher = REQUESTED_RANGE_PATTERN.matcher(rangeString.trim());
+      if (matcher.matches()) {
+        final String rangeStart = matcher.group(2);
+        final String rangeEnd = matcher.group(3);
+
+        long start = StringUtils.isEmpty(rangeStart) ? -1L : Long.parseLong(rangeStart);
+        long end = StringUtils.isEmpty(rangeEnd) ? Long.MAX_VALUE : Long.parseLong(rangeEnd);
+        range = new Range(start, end);
+
+        if (matcher.groupCount() == 5 && !"".equals(matcher.group(4))) {
+          throw new IllegalArgumentException(
+              "Unsupported range specification. Only single range specifications allowed");
+        }
+        if (range.start() != -1 && range.start() < 0) {
+          throw new IllegalArgumentException(
+              "Unsupported range specification. A start byte must be supplied");
+        }
+
+        if (range.end() != -1 && range.end() < range.start()) {
+          throw new IllegalArgumentException(
+              "Range header is malformed. End byte is smaller than start byte.");
+        }
+      } else {
+        // Per Aliyun OSS behavior, return whole object content for illegal header
+        range = new Range(0, Long.MAX_VALUE);
+      }
+
+      return range;
+    }
+  }
+}