Skip to content

Use Java Bean for connection details and add more tests #1317

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.

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
merged 4 commits into from
Apr 22, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -43,19 +43,31 @@
@Bean
@ConditionalOnMissingBean
DaprClientBuilder daprClientBuilder(DaprConnectionDetails daprConnectionDetails) {
DaprClientBuilder builder = new DaprClientBuilder();
if (daprConnectionDetails.httpEndpoint() != null) {
builder.withPropertyOverride(Properties.HTTP_ENDPOINT, daprConnectionDetails.httpEndpoint());
DaprClientBuilder builder = createDaprClientBuilder();
String httpEndpoint = daprConnectionDetails.getHttpEndpoint();

if (httpEndpoint != null) {
builder.withPropertyOverride(Properties.HTTP_ENDPOINT, httpEndpoint);
}
if (daprConnectionDetails.grpcEndpoint() != null) {
builder.withPropertyOverride(Properties.GRPC_ENDPOINT, daprConnectionDetails.grpcEndpoint());

String grpcEndpoint = daprConnectionDetails.getGrpcEndpoint();

if (grpcEndpoint != null) {
builder.withPropertyOverride(Properties.GRPC_ENDPOINT, grpcEndpoint);
}
if (daprConnectionDetails.httpPort() != null) {
builder.withPropertyOverride(Properties.HTTP_PORT, String.valueOf(daprConnectionDetails.httpPort()));

Integer httpPort = daprConnectionDetails.getHttpPort();

if (httpPort != null) {
builder.withPropertyOverride(Properties.HTTP_PORT, String.valueOf(httpPort));
}
if (daprConnectionDetails.grpcPort() != null) {
builder.withPropertyOverride(Properties.GRPC_PORT, String.valueOf(daprConnectionDetails.grpcPort()));

Integer grpcPort = daprConnectionDetails.getGrpcPort();

if (grpcPort != null) {
builder.withPropertyOverride(Properties.GRPC_PORT, String.valueOf(grpcPort));
}

return builder;
}

Expand Down Expand Up @@ -90,22 +102,33 @@
@ConditionalOnMissingBean
WorkflowRuntimeBuilder daprWorkflowRuntimeBuilder(DaprConnectionDetails daprConnectionDetails) {
Properties properties = createPropertiesFromConnectionDetails(daprConnectionDetails);

return new WorkflowRuntimeBuilder(properties);
}

/**
* We use this method in tests to override the default DaprClientBuilder.
*/
protected DaprClientBuilder createDaprClientBuilder() {
return new DaprClientBuilder();
}

private Properties createPropertiesFromConnectionDetails(DaprConnectionDetails daprConnectionDetails) {
final Map<String, String> propertyOverrides = new HashMap<>();
propertyOverrides.put(Properties.HTTP_ENDPOINT.getName(), daprConnectionDetails.httpEndpoint());
if (daprConnectionDetails.httpPort() != null) {
propertyOverrides.put(Properties.HTTP_PORT.getName(), String.valueOf(daprConnectionDetails.httpPort()));
Map<String, String> propertyOverrides = new HashMap<>();

propertyOverrides.put(Properties.HTTP_ENDPOINT.getName(), daprConnectionDetails.getHttpEndpoint());

if (daprConnectionDetails.getHttpPort() != null) {
propertyOverrides.put(Properties.HTTP_PORT.getName(), String.valueOf(daprConnectionDetails.getHttpPort()));

Check warning on line 122 in dapr-spring/dapr-spring-boot-autoconfigure/src/main/java/io/dapr/spring/boot/autoconfigure/client/DaprClientAutoConfiguration.java

View check run for this annotation

Codecov / codecov/patch

dapr-spring/dapr-spring-boot-autoconfigure/src/main/java/io/dapr/spring/boot/autoconfigure/client/DaprClientAutoConfiguration.java#L122

Added line #L122 was not covered by tests
}
propertyOverrides.put(Properties.GRPC_ENDPOINT.getName(), daprConnectionDetails.grpcEndpoint());
if (daprConnectionDetails.grpcPort() != null) {
propertyOverrides.put(Properties.GRPC_PORT.getName(), String.valueOf(daprConnectionDetails.grpcPort()));

propertyOverrides.put(Properties.GRPC_ENDPOINT.getName(), daprConnectionDetails.getGrpcEndpoint());

if (daprConnectionDetails.getGrpcPort() != null) {
propertyOverrides.put(Properties.GRPC_PORT.getName(), String.valueOf(daprConnectionDetails.getGrpcPort()));

Check warning on line 128 in dapr-spring/dapr-spring-boot-autoconfigure/src/main/java/io/dapr/spring/boot/autoconfigure/client/DaprClientAutoConfiguration.java

View check run for this annotation

Codecov / codecov/patch

dapr-spring/dapr-spring-boot-autoconfigure/src/main/java/io/dapr/spring/boot/autoconfigure/client/DaprClientAutoConfiguration.java#L128

Added line #L128 was not covered by tests
}

return new Properties(propertyOverrides);
}



}
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@
import org.springframework.boot.autoconfigure.service.connection.ConnectionDetails;

public interface DaprConnectionDetails extends ConnectionDetails {
String httpEndpoint();
String getHttpEndpoint();

String grpcEndpoint();
String getGrpcEndpoint();

Integer httpPort();
Integer getHttpPort();

Integer grpcPort();
Integer getGrpcPort();
}
Original file line number Diff line number Diff line change
Expand Up @@ -22,22 +22,22 @@ public PropertiesDaprConnectionDetails(DaprClientProperties daprClientProperties
}

@Override
public String httpEndpoint() {
public String getHttpEndpoint() {
return this.daprClientProperties.getHttpEndpoint();
}

@Override
public String grpcEndpoint() {
public String getGrpcEndpoint() {
return this.daprClientProperties.getGrpcEndpoint();
}

@Override
public Integer httpPort() {
public Integer getHttpPort() {
return this.daprClientProperties.getHttpPort();
}

@Override
public Integer grpcPort() {
public Integer getGrpcPort() {
return this.daprClientProperties.getGrpcPort();
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
/*
* Copyright 2024 The Dapr Authors
* Licensed 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 io.dapr.spring.boot.autoconfigure.client;

import io.dapr.client.DaprClient;
import io.dapr.client.DaprClientBuilder;
import io.dapr.config.Properties;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;
import org.springframework.boot.autoconfigure.AutoConfigurations;
import org.springframework.boot.test.context.runner.ApplicationContextRunner;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

/**
* Unit tests for {@link DaprClientAutoConfiguration}.
*/
@ExtendWith(MockitoExtension.class)
class DaprClientAutoConfigurationTest {

private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
.withConfiguration(AutoConfigurations.of(DaprClientAutoConfiguration.class));

@Mock
private DaprConnectionDetails connectionDetails;

@Mock
private DaprClientBuilder builder;

private DaprClientAutoConfiguration configuration;

@Test
void daprClientBuilder() {
contextRunner.run(context -> assertThat(context).hasSingleBean(DaprClientBuilder.class));
}

@Test
void daprClient() {
contextRunner.run(context -> assertThat(context).hasSingleBean(DaprClient.class));
}

@BeforeEach
void setUp() {
configuration = new TestDaprClientAutoConfiguration(builder);
}

@Test
@DisplayName("Should override HTTP endpoint if it exists")
void shouldOverrideHttpEndpointIfExists() {
String httpEndpoint = "http://localhost:3500";

when(connectionDetails.getHttpEndpoint()).thenReturn(httpEndpoint);
when(connectionDetails.getGrpcEndpoint()).thenReturn(null);
when(connectionDetails.getHttpPort()).thenReturn(null);
when(connectionDetails.getGrpcPort()).thenReturn(null);

configuration.daprClientBuilder(connectionDetails);

verify(builder).withPropertyOverride(Properties.HTTP_ENDPOINT, httpEndpoint);
}

@Test
@DisplayName("Should override GRPC endpoint if it exists")
void shouldOverrideGrpcEndpointIfExists() {
String grpcEndpoint = "grpc://localhost:5001";

when(connectionDetails.getHttpEndpoint()).thenReturn(null);
when(connectionDetails.getGrpcEndpoint()).thenReturn(grpcEndpoint);
when(connectionDetails.getHttpPort()).thenReturn(null);
when(connectionDetails.getGrpcPort()).thenReturn(null);

configuration.daprClientBuilder(connectionDetails);

verify(builder).withPropertyOverride(Properties.GRPC_ENDPOINT, grpcEndpoint);
}

@Test
@DisplayName("Should override HTTP port if it exists")
void shouldOverrideHttpPortIfExists() {
Integer httpPort = 3600;

when(connectionDetails.getHttpEndpoint()).thenReturn(null);
when(connectionDetails.getGrpcEndpoint()).thenReturn(null);
when(connectionDetails.getHttpPort()).thenReturn(httpPort);
when(connectionDetails.getGrpcPort()).thenReturn(null);

configuration.daprClientBuilder(connectionDetails);

verify(builder).withPropertyOverride(Properties.HTTP_PORT, String.valueOf(httpPort));
}

@Test
@DisplayName("Should override GRPC port if it exists")
void shouldOverrideGrpcPortIfExists() {
Integer grpcPort = 6001;

when(connectionDetails.getHttpEndpoint()).thenReturn(null);
when(connectionDetails.getGrpcEndpoint()).thenReturn(null);
when(connectionDetails.getHttpPort()).thenReturn(null);
when(connectionDetails.getGrpcPort()).thenReturn(grpcPort);

configuration.daprClientBuilder(connectionDetails);

verify(builder).withPropertyOverride(Properties.GRPC_PORT, String.valueOf(grpcPort));
}

private static class TestDaprClientAutoConfiguration extends DaprClientAutoConfiguration {

private final DaprClientBuilder daprClientBuilder;

public TestDaprClientAutoConfiguration(DaprClientBuilder daprClientBuilder) {
this.daprClientBuilder = daprClientBuilder;
}

@Override
protected DaprClientBuilder createDaprClientBuilder() {
return daprClientBuilder;
}
}

}

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -23,22 +23,22 @@ private DaprContainerConnectionDetails(ContainerConnectionSource<DaprContainer>
}

@Override
public String httpEndpoint() {
public String getHttpEndpoint() {
return getContainer().getHttpEndpoint();
}

@Override
public String grpcEndpoint() {
public String getGrpcEndpoint() {
return getContainer().getGrpcEndpoint();
}

@Override
public Integer httpPort() {
public Integer getHttpPort() {
return getContainer().getHttpPort();
}

@Override
public Integer grpcPort() {
public Integer getGrpcPort() {
return getContainer().getGrpcPort();
}
}
Expand Down
9 changes: 5 additions & 4 deletions sdk/src/main/java/io/dapr/client/DaprClientBuilder.java
Original file line number Diff line number Diff line change
Expand Up @@ -162,11 +162,12 @@ public DaprPreviewClient buildPreviewClient() {
* @throws java.lang.IllegalStateException if either host is missing or if port is missing or a negative number.
*/
private DaprClientImpl buildDaprClient() {
final Properties properties = new Properties(this.propertyOverrides);
final ManagedChannel channel = NetworkUtils.buildGrpcManagedChannel(properties);
final DaprHttp daprHttp = this.daprHttpBuilder.build(properties);
final GrpcChannelFacade channelFacade = new GrpcChannelFacade(channel);
Properties properties = new Properties(this.propertyOverrides);
ManagedChannel channel = NetworkUtils.buildGrpcManagedChannel(properties);
DaprHttp daprHttp = this.daprHttpBuilder.build(properties);
GrpcChannelFacade channelFacade = new GrpcChannelFacade(channel);
DaprGrpc.DaprStub asyncStub = DaprGrpc.newStub(channel);

return new DaprClientImpl(
channelFacade,
asyncStub,
Expand Down