Skip to content
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

Allow to fetch multiple config parameters as a Map #17579

Closed
wants to merge 1 commit into from
Closed

Allow to fetch multiple config parameters as a Map #17579

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion bom/application/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
<microprofile-rest-client.version>2.0</microprofile-rest-client.version>
<microprofile-jwt.version>1.2</microprofile-jwt.version>
<smallrye-common.version>1.6.0</smallrye-common.version>
<smallrye-config.version>2.3.0</smallrye-config.version>
<smallrye-config.version>2.3.1-SNAPSHOT</smallrye-config.version>
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's make sure change this :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@geoand My bad I should have added a comment. It's ok @radcortez is aware and asked me to do it 😄

Copy link
Member

Choose a reason for hiding this comment

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

Yes, this is so we don't forget the changes required for the next SR Config version.

<smallrye-health.version>3.0.2</smallrye-health.version>
<smallrye-metrics.version>3.0.1</smallrye-metrics.version>
<smallrye-open-api.version>2.1.4</smallrye-open-api.version>
Expand Down
3 changes: 3 additions & 0 deletions extensions/arc/deployment/src/main/java/io/quarkus/arc/deployment/ConfigBuildStep.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.function.Supplier;
Expand Down Expand Up @@ -73,6 +74,7 @@ public class ConfigBuildStep {
private static final DotName MP_CONFIG_VALUE_NAME = DotName.createSimple(ConfigValue.class.getName());

private static final DotName CONFIG_MAPPING_NAME = DotName.createSimple(ConfigMapping.class.getName());
private static final DotName MAP_NAME = DotName.createSimple(Map.class.getName());
private static final DotName SET_NAME = DotName.createSimple(Set.class.getName());
private static final DotName LIST_NAME = DotName.createSimple(List.class.getName());
private static final DotName SUPPLIER_NAME = DotName.createSimple(Supplier.class.getName());
Expand Down Expand Up @@ -413,6 +415,7 @@ public static boolean isHandledByProducers(Type type) {
DotNames.OPTIONAL_INT.equals(type.name()) ||
DotNames.OPTIONAL_LONG.equals(type.name()) ||
DotNames.OPTIONAL_DOUBLE.equals(type.name()) ||
MAP_NAME.equals(type.name()) ||
SET_NAME.equals(type.name()) ||
LIST_NAME.equals(type.name()) ||
DotNames.LONG.equals(type.name()) ||
Expand Down
20 changes: 19 additions & 1 deletion extensions/arc/deployment/src/test/java/io/quarkus/arc/test/config/ConfigPropertiesTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;

import java.util.Map;

import javax.enterprise.context.Dependent;
import javax.enterprise.inject.spi.CDI;
import javax.inject.Inject;
Expand All @@ -26,10 +28,16 @@ public class ConfigPropertiesTest {
"smallrye.config.mapping.validate-unknown=false\n" +
"server.host=localhost\n" +
"server.port=8080\n" +
"server.reasons.200=OK Server\n" +
"server.reasons.201=Created Server\n" +
"cloud.host=cloud\n" +
"cloud.port=9090\n" +
"cloud.reasons.200=OK Cloud\n" +
"cloud.reasons.201=Created Cloud\n" +
"host=empty\n" +
"port=0\n"),
"port=0\n" +
"reasons.200=OK\n" +
"reasons.201=Created\n"),
"application.properties"));

@Inject
Expand Down Expand Up @@ -78,14 +86,23 @@ void configProperties() {
assertNotNull(configProperties);
assertEquals("localhost", configProperties.host);
assertEquals(8080, configProperties.port);
assertEquals(2, configProperties.reasons.size());
assertEquals("OK Server", configProperties.reasons.get(200));
assertEquals("Created Server", configProperties.reasons.get(201));

assertNotNull(configPropertiesCloud);
assertEquals("cloud", configPropertiesCloud.host);
assertEquals(9090, configPropertiesCloud.port);
assertEquals(2, configPropertiesCloud.reasons.size());
assertEquals("OK Cloud", configPropertiesCloud.reasons.get(200));
assertEquals("Created Cloud", configPropertiesCloud.reasons.get(201));

assertNotNull(configPropertiesEmpty);
assertEquals("empty", configPropertiesEmpty.host);
assertEquals(0, configPropertiesEmpty.port);
assertEquals(2, configPropertiesEmpty.reasons.size());
assertEquals("OK", configPropertiesEmpty.reasons.get(200));
assertEquals("Created", configPropertiesEmpty.reasons.get(201));
}

@Test
Expand Down Expand Up @@ -142,6 +159,7 @@ public interface Client {
public static class ServerConfigProperties {
public String host;
public int port;
public Map<Integer, String> reasons;
}

@Dependent
Expand Down
118 changes: 118 additions & 0 deletions ...c/deployment/src/test/java/io/quarkus/arc/test/config/ConfigPropertyMapInjectionTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
package io.quarkus.arc.test.config;

import static io.smallrye.common.constraint.Assert.assertTrue;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;

import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.Supplier;

import org.eclipse.microprofile.config.inject.ConfigProperty;
import org.eclipse.microprofile.config.spi.Converter;
import org.jboss.shrinkwrap.api.ShrinkWrap;
import org.jboss.shrinkwrap.api.asset.StringAsset;
import org.jboss.shrinkwrap.api.spec.JavaArchive;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;

import io.quarkus.test.QuarkusUnitTest;

public class ConfigPropertyMapInjectionTest {
@RegisterExtension
static final QuarkusUnitTest TEST = new QuarkusUnitTest()
.setArchiveProducer(() -> ShrinkWrap.create(JavaArchive.class)
.addAsServiceProvider(Converter.class, VersionConverter.class)
.addAsResource(new StringAsset(
"root.numbers.1=one\n" +
"root.numbers.2=two\n" +
"root.numbers.3=three\n" +
"versions.v1=1.The version 1.2.3\n" +
"versions.v1.2=1.The version 1.2.0\n" +
"versions.v2=2.The version 2.0.0\n"),
"application.properties"));

@ConfigProperty(name = "root.numbers")
Map<Integer, String> numbers;

@ConfigProperty(name = "root.numbers")
Optional<Map<Integer, String>> oNumbers;

@ConfigProperty(name = "root.numbers")
Supplier<Map<Integer, String>> sNumbers;

@ConfigProperty(name = "versions")
Map<String, Version> versions;

@ConfigProperty(name = "default.versions", defaultValue = "v0.1=0.The version 0;v1\\=1;2;3=1.The version 1\\;2\\;3;v2\\=2;1;0=2.The version 2\\;1\\;0")
Map<String, Version> versionsDefault;

@Test
void mapInjection() {
assertNotNull(numbers);
assertEquals(3, numbers.size());
assertEquals("one", numbers.get(1));
assertEquals("two", numbers.get(2));
assertEquals("three", numbers.get(3));

assertNotNull(numbers);
assertEquals(3, numbers.size());
assertEquals("one", numbers.get(1));
assertEquals("two", numbers.get(2));
assertEquals("three", numbers.get(3));

assertNotNull(oNumbers);
assertTrue(oNumbers.isPresent());
assertEquals(3, oNumbers.get().size());
assertEquals("one", oNumbers.get().get(1));
assertEquals("two", oNumbers.get().get(2));
assertEquals("three", oNumbers.get().get(3));

assertNotNull(sNumbers);
assertEquals(3, sNumbers.get().size());
assertEquals("one", sNumbers.get().get(1));
assertEquals("two", sNumbers.get().get(2));
assertEquals("three", sNumbers.get().get(3));

assertEquals(2, versions.size());
assertEquals(new Version(1, "The version 1.2.3"), versions.get("v1"));
assertEquals(new Version(2, "The version 2.0.0"), versions.get("v2"));
assertEquals(2, versionsDefault.size());
assertEquals(new Version(1, "The version 1;2;3"), versionsDefault.get("v1=1;2;3"));
assertEquals(new Version(2, "The version 2;1;0"), versionsDefault.get("v2=2;1;0"));
}

static class Version {
int id;
String name;

Version(int id, String name) {
this.id = id;
this.name = name;
}

@Override
public boolean equals(Object o) {
if (this == o)
return true;
if (o == null || getClass() != o.getClass())
return false;
Version version = (Version) o;
return id == version.id && Objects.equals(name, version.name);
}

@Override
public int hashCode() {
return Objects.hash(id, name);
}
}

public static class VersionConverter implements Converter<Version> {

@Override
public Version convert(String value) {
return new Version(Integer.parseInt(value.substring(0, 1)), value.substring(2));
}
}
}
3 changes: 2 additions & 1 deletion extensions/arc/runtime/src/main/java/io/quarkus/arc/runtime/ConfigRecorder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package io.quarkus.arc.runtime;

import java.util.Map;
import java.util.Objects;
import java.util.Set;

Expand Down Expand Up @@ -31,7 +32,7 @@ public void validateConfigProperties(Set<ConfigValidationMetadata> properties) {
for (ConfigValidationMetadata property : properties) {
Class<?> propertyClass = load(property.getType(), cl);
// For parameterized types and arrays, we only check if the property config exists without trying to convert it
if (propertyClass.isArray() || propertyClass.getTypeParameters().length > 0) {
if (propertyClass.isArray() || (propertyClass.getTypeParameters().length > 0 && propertyClass != Map.class)) {
propertyClass = String.class;
}

Expand Down