dapr
/
java-sdk
mirror of https://github.com/dapr/java-sdk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Adding GetBulkSecret API.

This commit is contained in:
Artur Souza 2021-01-24 22:07:57 -08:00
parent 57345ebf3e
commit 907748f162
14 changed files with 390 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.github/workflows/build.yml vendored
View File

@ -26,7 +26,7 @@ jobs:
DAPR_RUNTIME_VER: 1.0.0-rc.2
DAPR_INSTALL_URL: https://raw.githubusercontent.com/dapr/cli/3dacfb672d55f1436c249057aaebbe597e1066f3/install/install.sh
DAPR_CLI_REF:
DAPR_REF: 4678e477562e7e35a1d6ba04a9b17b6c9c00a025
DAPR_REF: f4327d91c3cd921b26077d99abe0f237c9a38f5d
OSSRH_USER_TOKEN: ${{ secrets.OSSRH_USER_TOKEN }}
OSSRH_PWD_TOKEN: ${{ secrets.OSSRH_PWD_TOKEN }}
GPG_KEY: ${{ secrets.GPG_KEY }}
@ -91,8 +91,6 @@ jobs:
run: |
docker-compose -f ./sdk-tests/deploy/local-test-vault.yml up -d
docker ps
- name: Setup Vault's test token
run: echo myroot > /tmp/.hashicorp_vault_token
- name: Clean up files
run: mvn clean
- name: Build sdk

2
pom.xml
View File

@ -16,7 +16,7 @@
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<grpc.version>1.33.1</grpc.version>
<protobuf.version>3.13.0</protobuf.version>
<dapr.proto.baseurl>https://raw.githubusercontent.com/dapr/dapr/33dc3361e99f75e88628e0abfc8b04d3d7e8bc5f/dapr/proto</dapr.proto.baseurl>
<dapr.proto.baseurl>https://raw.githubusercontent.com/dapr/dapr/4a6369caaba9cf46eae9bfa4fa6e76b474854c89/dapr/proto</dapr.proto.baseurl>
<os-maven-plugin.version>1.6.2</os-maven-plugin.version>
<maven-dependency-plugin.version>3.1.1</maven-dependency-plugin.version>
<maven-antrun-plugin.version>1.8</maven-antrun-plugin.version>

1
sdk-tests/.hashicorp_vault_token Normal file
View File

@ -0,0 +1 @@
myroot

2
sdk-tests/components/vault.yaml
View File

@ -10,6 +10,6 @@ spec:
- name: skipVerify
value : true
- name: vaultTokenMountPath
value : "/tmp/.hashicorp_vault_token"
value : ".hashicorp_vault_token"
- name: vaultKVPrefix
value : "dapr"

27
sdk-tests/src/test/java/io/dapr/it/secrets/SecretsClientIT.java
View File

@ -21,10 +21,12 @@ import org.junit.runners.Parameterized;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.UUID;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
/**
* Test Secrets Store APIs using Harshicorp's vault.
@ -104,6 +106,26 @@ public class SecretsClientIT extends BaseIT {
assertEquals("The Metrics IV", data.get("title"));
}
@Test
public void getBulkSecret() throws Exception {
String key1 = UUID.randomUUID().toString();
writeSecret(key1, new HashMap<>() {{
put("title", "The Metrics IV");
put("year", "2020");
}});
String key2 = UUID.randomUUID().toString();
writeSecret(key2, "name", "Jon Doe");
Map<String, Map<String, String>> data = daprClient.getBulkSecret(SECRETS_STORE_NAME).block();
// There can be other keys from other runs or test cases, so we are good with at least two.
assertTrue(data.size() >= 2);
assertEquals(2, data.get(key1).size());
assertEquals("The Metrics IV", data.get(key1).get("title"));
assertEquals("2020", data.get(key1).get("year"));
assertEquals(1, data.get(key2).size());
assertEquals("Jon Doe", data.get(key2).get("name"));
}
@Test(expected = RuntimeException.class)
public void getSecretKeyNotFound() {
daprClient.getSecret(SECRETS_STORE_NAME, "unknownKey").block();
@ -115,7 +137,10 @@ public class SecretsClientIT extends BaseIT {
}
private static void writeSecret(String secretName, String key, String value) throws Exception {
Map<String, Object> secrets = Collections.singletonMap(key, value);
writeSecret(secretName, Collections.singletonMap(key, value));
}
private static void writeSecret(String secretName, Map<String, Object> secrets) throws Exception {
vault.logical().write("secret/" + PREFIX + "/" + secretName, secrets);
}

21
sdk/src/main/java/io/dapr/client/AbstractDaprClient.java
View File

@ -9,6 +9,8 @@ import io.dapr.client.domain.DeleteStateRequest;
import io.dapr.client.domain.DeleteStateRequestBuilder;
import io.dapr.client.domain.ExecuteStateTransactionRequest;
import io.dapr.client.domain.ExecuteStateTransactionRequestBuilder;
import io.dapr.client.domain.GetBulkSecretRequest;
import io.dapr.client.domain.GetBulkSecretRequestBuilder;
import io.dapr.client.domain.GetBulkStateRequestBuilder;
import io.dapr.client.domain.GetSecretRequest;
import io.dapr.client.domain.GetSecretRequestBuilder;
@ -395,4 +397,23 @@ abstract class AbstractDaprClient implements DaprClient {
return this.getSecret(storeName, secretName, null);
}
/**
* {@inheritDoc}
*/
@Override
public Mono<Map<String, Map<String, String>>> getBulkSecret(String storeName) {
return this.getBulkSecret(storeName, null);
}
/**
* {@inheritDoc}
*/
@Override
public Mono<Map<String, Map<String, String>>> getBulkSecret(String storeName, Map<String, String> metadata) {
GetBulkSecretRequest request = new GetBulkSecretRequestBuilder(storeName)
.withMetadata(metadata)
.build();
return this.getBulkSecret(request).map(r -> r.getObject() == null ? Collections.EMPTY_MAP : r.getObject());
}
}

26
sdk/src/main/java/io/dapr/client/DaprClient.java
View File

@ -7,6 +7,7 @@ package io.dapr.client;
import io.dapr.client.domain.DeleteStateRequest;
import io.dapr.client.domain.ExecuteStateTransactionRequest;
import io.dapr.client.domain.GetBulkSecretRequest;
import io.dapr.client.domain.GetBulkStateRequest;
import io.dapr.client.domain.GetSecretRequest;
import io.dapr.client.domain.GetStateRequest;
@ -525,4 +526,29 @@ public interface DaprClient extends AutoCloseable {
* @return Key-value pairs for the secret.
*/
Mono<Response<Map<String, String>>> getSecret(GetSecretRequest request);
/**
* Fetches all secrets from the configured vault.
*
* @param storeName Name of vault component in Dapr.
* @return Key-value pairs for all the secrets in the state store.
*/
Mono<Map<String, Map<String, String>>> getBulkSecret(String storeName);
/**
* Fetches all secrets from the configured vault.
*
* @param storeName Name of vault component in Dapr.
* @param metadata Optional metadata.
* @return Key-value pairs for all the secrets in the state store.
*/
Mono<Map<String, Map<String, String>>> getBulkSecret(String storeName, Map<String, String> metadata);
/**
* Fetches all secrets from the configured vault.
*
* @param request Request to fetch secret.
* @return Key-value pairs for the secret.
*/
Mono<Response<Map<String, Map<String, String>>>> getBulkSecret(GetBulkSecretRequest request);
}

45
sdk/src/main/java/io/dapr/client/DaprClientGrpc.java
View File

@ -11,6 +11,7 @@ import com.google.protobuf.ByteString;
import com.google.protobuf.Empty;
import io.dapr.client.domain.DeleteStateRequest;
import io.dapr.client.domain.ExecuteStateTransactionRequest;
import io.dapr.client.domain.GetBulkSecretRequest;
import io.dapr.client.domain.GetBulkStateRequest;
import io.dapr.client.domain.GetSecretRequest;
import io.dapr.client.domain.GetStateRequest;
@ -55,9 +56,11 @@ import reactor.core.publisher.MonoSink;
import java.io.Closeable;
import java.io.IOException;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.concurrent.ExecutionException;
import java.util.function.Consumer;
import java.util.stream.Collectors;
@ -469,7 +472,7 @@ public class DaprClientGrpc extends AbstractDaprClient {
CommonProtos.StateItem.Builder stateBuilder = CommonProtos.StateItem.newBuilder();
if (state.getEtag() != null) {
stateBuilder.setEtag(state.getEtag());
stateBuilder.setEtag(CommonProtos.Etag.newBuilder().setValue(state.getEtag()).build());
}
if (state.getMetadata() != null) {
stateBuilder.putAllMetadata(state.getMetadata());
@ -532,7 +535,7 @@ public class DaprClientGrpc extends AbstractDaprClient {
builder.putAllMetadata(metadata);
}
if (etag != null) {
builder.setEtag(etag);
builder.setEtag(CommonProtos.Etag.newBuilder().setValue(etag).build());
}
if (optionBuilder != null) {
@ -626,6 +629,44 @@ public class DaprClientGrpc extends AbstractDaprClient {
).map(it -> new Response<>(context, it.getDataMap()));
}
/**
* {@inheritDoc}
*/
@Override
public Mono<Response<Map<String, Map<String, String>>>> getBulkSecret(GetBulkSecretRequest request) {
try {
final String storeName = request.getStoreName();
final Map<String, String> metadata = request.getMetadata();
final Context context = request.getContext();
if ((storeName == null) || (storeName.trim().isEmpty())) {
throw new IllegalArgumentException("Secret store name cannot be null or empty.");
}
DaprProtos.GetBulkSecretRequest.Builder builder = DaprProtos.GetBulkSecretRequest.newBuilder()
.setStoreName(storeName);
if (metadata != null) {
builder.putAllMetadata(metadata);
}
DaprProtos.GetBulkSecretRequest envelope = builder.build();
return this.<DaprProtos.GetBulkSecretResponse>createMono(context, it -> asyncStub.getBulkSecret(envelope, it))
.map(it -> {
Map<String, DaprProtos.SecretResponse> secretsMap = it.getDataMap();
if (secretsMap == null) {
return Collections.EMPTY_MAP;
}
return secretsMap
.entrySet()
.stream()
.collect(Collectors.toMap(s -> s.getKey(), s -> s.getValue().getSecretsMap()));
})
.map(s -> new Response<>(context, s));
} catch (Exception ex) {
return DaprException.wrapMono(ex);
}
}
/**
* Closes the ManagedChannel for GRPC.
* @see io.grpc.ManagedChannel#shutdown()

37
sdk/src/main/java/io/dapr/client/DaprClientHttp.java
View File

@ -9,6 +9,7 @@ import com.fasterxml.jackson.databind.JsonNode;
import com.google.common.base.Strings;
import io.dapr.client.domain.DeleteStateRequest;
import io.dapr.client.domain.ExecuteStateTransactionRequest;
import io.dapr.client.domain.GetBulkSecretRequest;
import io.dapr.client.domain.GetBulkStateRequest;
import io.dapr.client.domain.GetSecretRequest;
import io.dapr.client.domain.GetStateRequest;
@ -591,6 +592,42 @@ public class DaprClientHttp extends AbstractDaprClient {
.map(m -> new Response<>(context, m));
}
/**
* {@inheritDoc}
*/
@Override
public Mono<Response<Map<String, Map<String, String>>>> getBulkSecret(GetBulkSecretRequest request) {
String secretStoreName = request.getStoreName();
Map<String, String> metadata = request.getMetadata();
Context context = request.getContext();
try {
if ((secretStoreName == null) || (secretStoreName.trim().isEmpty())) {
throw new IllegalArgumentException("Secret store name cannot be null or empty.");
}
} catch (Exception e) {
return DaprException.wrapMono(e);
}
Map<String, String> queryArgs = metadataToQueryArgs(metadata);
String[] pathSegments = new String[]{ DaprHttp.API_VERSION, "secrets", secretStoreName, "bulk"};
return this.client
.invokeApi(DaprHttp.HttpMethods.GET.name(), pathSegments, queryArgs, (String)null, null, context)
.flatMap(response -> {
try {
Map m = INTERNAL_SERIALIZER.deserialize(response.getBody(), Map.class);
if (m == null) {
return Mono.just(Collections.EMPTY_MAP);
}
return Mono.just(m);
} catch (IOException e) {
return DaprException.wrapMono(e);
}
})
.map(m -> (Map<String, Map<String, String>>)m)
.map(m -> new Response<>(context, m));
}
/**
* {@inheritDoc}
*/

25
sdk/src/main/java/io/dapr/client/DaprClientProxy.java
View File

@ -7,6 +7,7 @@ package io.dapr.client;
import io.dapr.client.domain.DeleteStateRequest;
import io.dapr.client.domain.ExecuteStateTransactionRequest;
import io.dapr.client.domain.GetBulkSecretRequest;
import io.dapr.client.domain.GetBulkStateRequest;
import io.dapr.client.domain.GetSecretRequest;
import io.dapr.client.domain.GetStateRequest;
@ -465,6 +466,30 @@ class DaprClientProxy implements DaprClient {
return client.getSecret(request);
}
/**
* {@inheritDoc}
*/
@Override
public Mono<Map<String, Map<String, String>>> getBulkSecret(String storeName) {
return client.getBulkSecret(storeName);
}
/**
* {@inheritDoc}
*/
@Override
public Mono<Map<String, Map<String, String>>> getBulkSecret(String storeName, Map<String, String> metadata) {
return client.getBulkSecret(storeName, metadata);
}
/**
* {@inheritDoc}
*/
@Override
public Mono<Response<Map<String, Map<String, String>>>> getBulkSecret(GetBulkSecretRequest request) {
return client.getBulkSecret(request);
}
/**
* {@inheritDoc}
*/

46
sdk/src/main/java/io/dapr/client/domain/GetBulkSecretRequest.java Normal file
View File

@ -0,0 +1,46 @@
/*
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*/
package io.dapr.client.domain;
import io.opentelemetry.context.Context;
import java.util.Map;
/**
* A request to get a secret by key.
*/
public class GetBulkSecretRequest {
private String storeName;
private Map<String, String> metadata;
private Context context;
public String getStoreName() {
return storeName;
}
void setStoreName(String storeName) {
this.storeName = storeName;
}
public Map<String, String> getMetadata() {
return metadata;
}
void setMetadata(Map<String, String> metadata) {
this.metadata = metadata;
}
public Context getContext() {
return context;
}
void setContext(Context context) {
this.context = context;
}
}

50
sdk/src/main/java/io/dapr/client/domain/GetBulkSecretRequestBuilder.java Normal file
View File

@ -0,0 +1,50 @@
/*
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*/
package io.dapr.client.domain;
import io.opentelemetry.context.Context;
import java.util.Collections;
import java.util.Map;
/**
* Builds a request to fetch all secrets of a secret store.
*/
public class GetBulkSecretRequestBuilder {
private final String storeName;
private Map<String, String> metadata;
private Context context;
public GetBulkSecretRequestBuilder(String storeName) {
this.storeName = storeName;
}
public GetBulkSecretRequestBuilder withMetadata(Map<String, String> metadata) {
this.metadata = metadata == null ? null : Collections.unmodifiableMap(metadata);
return this;
}
public GetBulkSecretRequestBuilder withContext(Context context) {
this.context = context;
return this;
}
/**
* Builds a request object.
* @return Request object.
*/
public GetBulkSecretRequest build() {
GetBulkSecretRequest request = new GetBulkSecretRequest();
request.setStoreName(this.storeName);
request.setMetadata(this.metadata);
request.setContext(this.context);
return request;
}
}

79
sdk/src/test/java/io/dapr/client/DaprClientGrpcTest.java
View File

@ -50,6 +50,7 @@ import java.util.List;
import java.util.Map;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.stream.Collectors;
import static io.dapr.utils.TestUtils.assertThrowsDaprException;
import static io.dapr.utils.TestUtils.findFreePort;
@ -1927,6 +1928,74 @@ public class DaprClientGrpcTest {
assertEquals(expectedValue, result.get(expectedKey));
}
@Test
public void getBulkSecrets() {
DaprProtos.GetBulkSecretResponse responseEnvelope = buildGetBulkSecretResponse(
new HashMap<String, Map<String, String>>() {{
put("one", Collections.singletonMap("mysecretkey", "mysecretvalue"));
put("two", new HashMap<String, String>() {{
put("a", "1");
put("b", "2");
}});
}});
doAnswer((Answer<Void>) invocation -> {
DaprProtos.GetBulkSecretRequest req = invocation.getArgument(0);
assertEquals(SECRET_STORE_NAME, req.getStoreName());
assertEquals(0, req.getMetadataCount());
StreamObserver<DaprProtos.GetBulkSecretResponse> observer =
(StreamObserver<DaprProtos.GetBulkSecretResponse>) invocation.getArguments()[1];
observer.onNext(responseEnvelope);
observer.onCompleted();
return null;
}).when(daprStub).getBulkSecret(any(DaprProtos.GetBulkSecretRequest.class), any());
Map<String, Map<String, String>> secrets = client.getBulkSecret(SECRET_STORE_NAME).block();
assertEquals(2, secrets.size());
assertEquals(1, secrets.get("one").size());
assertEquals("mysecretvalue", secrets.get("one").get("mysecretkey"));
assertEquals(2, secrets.get("two").size());
assertEquals("1", secrets.get("two").get("a"));
assertEquals("2", secrets.get("two").get("b"));
}
@Test
public void getBulkSecretsWithMetadata() {
DaprProtos.GetBulkSecretResponse responseEnvelope = buildGetBulkSecretResponse(
new HashMap<String, Map<String, String>>() {{
put("one", Collections.singletonMap("mysecretkey", "mysecretvalue"));
put("two", new HashMap<String, String>() {{
put("a", "1");
put("b", "2");
}});
}});
doAnswer((Answer<Void>) invocation -> {
DaprProtos.GetBulkSecretRequest req = invocation.getArgument(0);
assertEquals(SECRET_STORE_NAME, req.getStoreName());
assertEquals(1, req.getMetadataCount());
assertEquals("metavalue", req.getMetadataOrThrow("metakey"));
StreamObserver<DaprProtos.GetBulkSecretResponse> observer =
(StreamObserver<DaprProtos.GetBulkSecretResponse>) invocation.getArguments()[1];
observer.onNext(responseEnvelope);
observer.onCompleted();
return null;
}).when(daprStub).getBulkSecret(any(DaprProtos.GetBulkSecretRequest.class), any());
Map<String, Map<String, String>> secrets = client.getBulkSecret(
SECRET_STORE_NAME, Collections.singletonMap("metakey", "metavalue")).block();
assertEquals(2, secrets.size());
assertEquals(1, secrets.get("one").size());
assertEquals("mysecretvalue", secrets.get("one").get("mysecretkey"));
assertEquals(2, secrets.get("two").size());
assertEquals("1", secrets.get("two").get("a"));
assertEquals("2", secrets.get("two").get("b"));
}
/* If this test is failing, it means that a new value was added to StateOptions.Consistency
* enum, without creating a mapping to one of the proto defined gRPC enums
*/
@ -1992,6 +2061,16 @@ public class DaprClientGrpcTest {
return DaprProtos.GetSecretResponse.newBuilder().build();
}
private DaprProtos.GetBulkSecretResponse buildGetBulkSecretResponse(Map<String, Map<String, String>> res) {
Map<String, DaprProtos.SecretResponse> map = res.entrySet().stream().collect(
Collectors.toMap(
e -> e.getKey(),
e -> DaprProtos.SecretResponse.newBuilder().putAllSecrets(e.getValue()).build()));
return DaprProtos.GetBulkSecretResponse.newBuilder()
.putAllData(map)
.build();
}
private StateOptions buildStateOptions(StateOptions.Consistency consistency, StateOptions.Concurrency concurrency) {
StateOptions options = null;
if (consistency != null || concurrency != null) {

33
sdk/src/test/java/io/dapr/client/DaprClientHttpTest.java
View File

@ -1098,6 +1098,39 @@ public class DaprClientHttpTest {
}
}
@Test
public void getBulkSecrets() {
mockInterceptor.addRule()
.get("http://127.0.0.1:3000/v1.0/secrets/MySecretStore/bulk")
.respond("{ \"one\": { \"mysecretkey\": \"mysecretvalue\"}, \"two\": { \"a\": \"1\", \"b\": \"2\"}}");
Map<String, Map<String, String>> secrets = daprClientHttp.getBulkSecret(SECRET_STORE_NAME).block();
assertEquals(2, secrets.size());
assertEquals(1, secrets.get("one").size());
assertEquals("mysecretvalue", secrets.get("one").get("mysecretkey"));
assertEquals(2, secrets.get("two").size());
assertEquals("1", secrets.get("two").get("a"));
assertEquals("2", secrets.get("two").get("b"));
}
@Test
public void getBulkSecretsWithMetadata() {
mockInterceptor.addRule()
.get("http://127.0.0.1:3000/v1.0/secrets/MySecretStore/bulk?metadata.metakey=metavalue")
.respond("{ \"one\": { \"mysecretkey\": \"mysecretvalue\"}, \"two\": { \"a\": \"1\", \"b\": \"2\"}}");
Map<String, Map<String, String>> secrets =
daprClientHttp.getBulkSecret(SECRET_STORE_NAME, Collections.singletonMap("metakey", "metavalue")).block();
assertEquals(2, secrets.size());
assertEquals(1, secrets.get("one").size());
assertEquals("mysecretvalue", secrets.get("one").get("mysecretkey"));
assertEquals(2, secrets.get("two").size());
assertEquals("1", secrets.get("two").get("a"));
assertEquals("2", secrets.get("two").get("b"));
}
@Test
public void closeException() {
DaprHttp daprHttp = Mockito.mock(DaprHttp.class);