Skip to content

Aliyun: align property names with AWS module #3659

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
openinx merged 2 commits into from
Dec 7, 2021
Merged

Aliyun: align property names with AWS module #3659

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
168858c
Aliyun: align property names with AWS module
Dec 3, 2021
58f8bd1
rename secret-access-key to access-key-secret
Dec 6, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions aliyun/src/main/java/org/apache/iceberg/aliyun/AliyunClientFactories.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import java.util.Map;
import org.apache.iceberg.common.DynConstructors;
import org.apache.iceberg.relocated.com.google.common.base.Preconditions;
import org.apache.iceberg.util.PropertyUtil;

public class AliyunClientFactories {

Expand All @@ -36,12 +37,10 @@ public static AliyunClientFactory defaultFactory() {
return ALIYUN_CLIENT_FACTORY_DEFAULT;
}

public static AliyunClientFactory load(Map<String, String> properties) {
if (properties.containsKey(AliyunProperties.CLIENT_FACTORY)) {
return load(properties.get(AliyunProperties.CLIENT_FACTORY), properties);
} else {
return defaultFactory();
}
public static AliyunClientFactory from(Map<String, String> properties) {
String factoryImpl = PropertyUtil.propertyAsString(
properties, AliyunProperties.CLIENT_FACTORY, DefaultAliyunClientFactory.class.getName());
Copy link
Member

@openinx openinx Dec 7, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the previous version has a small bug, because the DefaultAliyunClientFactory forget to initialize the aliyun properties in the constructors. This PR unified the default aliyun client factory and customized client factory, it's great to avoid the the properties initialization !

return loadClientFactory(factoryImpl, properties);
}

/**
Expand All @@ -51,10 +50,10 @@ public static AliyunClientFactory load(Map<String, String> properties) {
* @param properties to initialize the factory.
* @return an initialized {@link AliyunClientFactory}.
*/
private static AliyunClientFactory load(String impl, Map<String, String> properties) {
private static AliyunClientFactory loadClientFactory(String impl, Map<String, String> properties) {
DynConstructors.Ctor<AliyunClientFactory> ctor;
try {
ctor = DynConstructors.builder(AliyunClientFactory.class).impl(impl).buildChecked();
ctor = DynConstructors.builder(AliyunClientFactory.class).hiddenImpl(impl).buildChecked();
} catch (NoSuchMethodException e) {
throw new IllegalArgumentException(String.format(
"Cannot initialize AliyunClientFactory, missing no-arg constructor: %s", impl), e);
Expand Down
10 changes: 5 additions & 5 deletions aliyun/src/main/java/org/apache/iceberg/aliyun/AliyunProperties.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,17 +40,17 @@ public class AliyunProperties implements Serializable {
* For more information about how to obtain an AccessKey pair, see:
* https://www.alibabacloud.com/help/doc-detail/53045.htm
*/
public static final String ACCESS_KEY_ID = "access.key.id";
public static final String CLIENT_ACCESS_KEY_ID = "client.access-key-id";

/**
* Aliyun uses an AccessKey pair, which includes an AccessKey ID and an AccessKey secret to implement symmetric
* encryption and verify the identity of a requester. The AccessKey secret is used to encrypt and verify the
* encryption and verify the identity of a requester. The AccessKey secret is used to encrypt and verify the
* signature string.
* <p>
* For more information about how to obtain an AccessKey pair, see:
* https://www.alibabacloud.com/help/doc-detail/53045.htm
*/
public static final String ACCESS_KEY_SECRET = "access.key.secret";
public static final String CLIENT_ACCESS_KEY_SECRET = "client.access-key-secret";

/**
* The implementation class of {@link AliyunClientFactory} to customize Aliyun client configurations.
Expand All @@ -76,8 +76,8 @@ public AliyunProperties() {
public AliyunProperties(Map<String, String> properties) {
// OSS endpoint, accessKeyId, accessKeySecret.
this.ossEndpoint = properties.get(OSS_ENDPOINT);
this.accessKeyId = properties.get(ACCESS_KEY_ID);
this.accessKeySecret = properties.get(ACCESS_KEY_SECRET);
this.accessKeyId = properties.get(CLIENT_ACCESS_KEY_ID);
this.accessKeySecret = properties.get(CLIENT_ACCESS_KEY_SECRET);

this.ossStagingDirectory = PropertyUtil.propertyAsString(properties, OSS_STAGING_DIRECTORY,
System.getProperty("java.io.tmpdir"));
Expand Down
2 changes: 1 addition & 1 deletion aliyun/src/main/java/org/apache/iceberg/aliyun/oss/OSSFileIO.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ private OSS client() {

@Override
public void initialize(Map<String, String> properties) {
AliyunClientFactory factory = AliyunClientFactories.load(properties);
AliyunClientFactory factory = AliyunClientFactories.from(properties);
this.aliyunProperties = factory.aliyunProperties();
this.oss = factory::newOSSClient;
}
Expand Down
18 changes: 15 additions & 3 deletions aliyun/src/test/java/org/apache/iceberg/aliyun/TestAliyunClientFactories.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@

import com.aliyun.oss.OSS;
import java.util.Map;
import org.apache.iceberg.relocated.com.google.common.collect.ImmutableMap;
import org.apache.iceberg.relocated.com.google.common.collect.Maps;
import org.junit.Assert;
import org.junit.Test;
Expand All @@ -32,9 +33,20 @@ public void testLoadDefault() {
Assert.assertEquals("Default client should be singleton",
AliyunClientFactories.defaultFactory(), AliyunClientFactories.defaultFactory());

AliyunClientFactory defaultFactory = AliyunClientFactories.from(Maps.newHashMap());
Assert.assertTrue(
"Should load default when not configured",
AliyunClientFactories.load(Maps.newHashMap()) instanceof AliyunClientFactories.DefaultAliyunClientFactory);
"Should load default when factory impl not configured",
defaultFactory instanceof AliyunClientFactories.DefaultAliyunClientFactory);
Assert.assertNull("Should have no Aliyun properties set",
defaultFactory.aliyunProperties().accessKeyId());

AliyunClientFactory defaultFactoryWithConfig = AliyunClientFactories.from(
ImmutableMap.of(AliyunProperties.CLIENT_ACCESS_KEY_ID, "key"));
Assert.assertTrue(
"Should load default when factory impl not configured",
defaultFactoryWithConfig instanceof AliyunClientFactories.DefaultAliyunClientFactory);
Assert.assertEquals("Should have access key set",
"key", defaultFactoryWithConfig.aliyunProperties().accessKeyId());
}

@Test
Expand All @@ -43,7 +55,7 @@ public void testLoadCustom() {
properties.put(AliyunProperties.CLIENT_FACTORY, CustomFactory.class.getName());
Assert.assertTrue(
"Should load custom class",
AliyunClientFactories.load(properties) instanceof CustomFactory);
AliyunClientFactories.from(properties) instanceof CustomFactory);
}

public static class CustomFactory implements AliyunClientFactory {
Expand Down