Skip to content

Ignore empty attribute values when retriveing boolean/int/long (#26729) #26737

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
stianst merged 1 commit into from
Feb 6, 2024
Merged

Ignore empty attribute values when retriveing boolean/int/long (#26729) #26737

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
6 changes: 3 additions & 3 deletions ...l/infinispan/src/main/java/org/keycloak/models/cache/infinispan/entities/CachedRealm.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -719,17 +719,17 @@ public String getAttribute(String name) {

public Integer getAttribute(String name, Integer defaultValue) {
String v = getAttribute(name);
return v != null ? Integer.valueOf(v) : defaultValue;
return v != null && !v.isEmpty() ? Integer.valueOf(v) : defaultValue;
}

public Long getAttribute(String name, Long defaultValue) {
String v = getAttribute(name);
return v != null ? Long.valueOf(v) : defaultValue;
return v != null && !v.isEmpty() ? Long.valueOf(v) : defaultValue;
}

public Boolean getAttribute(String name, Boolean defaultValue) {
String v = getAttribute(name);
return v != null ? Boolean.valueOf(v) : defaultValue;
return v != null && !v.isEmpty() ? Boolean.valueOf(v) : defaultValue;
}

public Map<String, String> getAttributes() {
Expand Down
1 change: 1 addition & 0 deletions model/jpa/src/main/java/org/keycloak/models/jpa/RealmAdapter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -589,6 +589,7 @@ public Map<String, Integer> getUserActionTokenLifespans() {
getAttributes().entrySet().stream()
.filter(Objects::nonNull)
.filter(entry -> nonNull(entry.getValue()))
.filter(entry -> !entry.getValue().isEmpty())
.filter(entry -> entry.getKey().startsWith(RealmAttributes.ACTION_TOKEN_GENERATED_BY_USER_LIFESPAN + "."))
.forEach(entry -> userActionTokens.put(entry.getKey().substring(RealmAttributes.ACTION_TOKEN_GENERATED_BY_USER_LIFESPAN.length() + 1), Integer.valueOf(entry.getValue())));

Expand Down
6 changes: 3 additions & 3 deletions server-spi/src/main/java/org/keycloak/models/RealmModel.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,15 +119,15 @@ default void setAttribute(String name, Long value) {
String getAttribute(String name);
default Integer getAttribute(String name, Integer defaultValue) {
String v = getAttribute(name);
return v != null ? Integer.valueOf(v) : defaultValue;
return v != null && !v.isEmpty() ? Integer.valueOf(v) : defaultValue;
}
default Long getAttribute(String name, Long defaultValue) {
String v = getAttribute(name);
return v != null ? Long.valueOf(v) : defaultValue;
return v != null && !v.isEmpty() ? Long.valueOf(v) : defaultValue;
}
default Boolean getAttribute(String name, Boolean defaultValue) {
String v = getAttribute(name);
return v != null ? Boolean.valueOf(v) : defaultValue;
return v != null && !v.isEmpty() ? Boolean.valueOf(v) : defaultValue;
}
Map<String, String> getAttributes();

Expand Down
49 changes: 46 additions & 3 deletions ...ion-arquillian/tests/base/src/test/java/org/keycloak/testsuite/admin/realm/RealmTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@
package org.keycloak.testsuite.admin.realm;

import com.google.common.collect.Sets;
import jakarta.ws.rs.BadRequestException;
import jakarta.ws.rs.NotFoundException;
import jakarta.ws.rs.core.Response;
import org.apache.commons.io.IOUtils;
import org.hamcrest.CoreMatchers;
import org.hamcrest.Matchers;
Expand All @@ -38,6 +41,10 @@
import org.keycloak.models.OAuth2DeviceConfig;
import org.keycloak.models.OTPPolicy;
import org.keycloak.models.ParConfig;
import org.keycloak.models.RealmModel;
import org.keycloak.models.RealmProvider;
import org.keycloak.models.cache.CacheRealmProvider;
import org.keycloak.models.jpa.entities.RealmAttributes;
import org.keycloak.protocol.oidc.OIDCLoginProtocol;
import org.keycloak.protocol.saml.SamlProtocol;
import org.keycloak.representations.adapters.action.GlobalRequestResult;
Expand Down Expand Up @@ -70,9 +77,6 @@
import org.keycloak.userprofile.UserProfileProvider;
import org.keycloak.util.JsonSerialization;

import jakarta.ws.rs.BadRequestException;
import jakarta.ws.rs.NotFoundException;
import jakarta.ws.rs.core.Response;
import java.io.IOException;
import java.nio.charset.Charset;
import java.util.ArrayList;
Expand Down Expand Up @@ -997,4 +1001,43 @@ public void testNoUserProfileProviderComponentUponRealmChange() {
// this used to return non-empty collection
assertThat(adminClient.realm(realmName).components().query(null, UserProfileProvider.class.getName()), empty());
}

@Test
public void testSetEmptyAttributeValues() {
String realmName = "testSetEmptyAttributeValues";
RealmRepresentation rep = new RealmRepresentation();
rep.setRealm(realmName);
rep.setAttributes(new HashMap<>());
rep.getAttributes().put("myboolean", "");
rep.getAttributes().put("mylong", "");
rep.getAttributes().put("myint", "");
rep.getAttributes().put(RealmAttributes.ACTION_TOKEN_GENERATED_BY_USER_LIFESPAN + ".something", "");

adminClient.realms().create(rep);

try {
adminClient.realm(realmName);

testingClient.server().run(session -> {
RealmModel realm = session.realms().getRealmByName(realmName);
Assert.assertTrue(realm instanceof org.keycloak.models.cache.infinispan.RealmAdapter);

Assert.assertNull(realm.getUserActionTokenLifespans().get("something"));
Assert.assertEquals(true, realm.getAttribute("myboolean", true));
Assert.assertEquals(Long.valueOf(123), realm.getAttribute("mylong", (long) 123));
Assert.assertEquals(Integer.valueOf(1234), realm.getAttribute("myint", 1234));

RealmProvider delegate = session.getProvider(CacheRealmProvider.class).getRealmDelegate();
RealmModel realm2 = delegate.getRealm(realm.getId());
Assert.assertTrue(realm2 instanceof org.keycloak.models.jpa.RealmAdapter);

Assert.assertNull(realm2.getUserActionTokenLifespans().get("something"));
Assert.assertEquals(true, realm2.getAttribute("myboolean", true));
Assert.assertEquals(Long.valueOf(123), realm2.getAttribute("mylong", (long) 123));
Assert.assertEquals(Integer.valueOf(1234), realm2.getAttribute("myint", 1234));
});
} finally {
adminClient.realm(realmName).remove();
}
}
Comment on lines +1006 to +1042

@mhajas mhajas Feb 2, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@stianst Should we use something more fancy for main?

Suggested change
public void testSetEmptyAttributeValues() {
String realmName = "testSetEmptyAttributeValues";
RealmRepresentation rep = new RealmRepresentation();
rep.setRealm(realmName);
rep.setAttributes(new HashMap<>());
rep.getAttributes().put("myboolean", "");
rep.getAttributes().put("mylong", "");
rep.getAttributes().put("myint", "");
rep.getAttributes().put(RealmAttributes.ACTION_TOKEN_GENERATED_BY_USER_LIFESPAN + ".something", "");
adminClient.realms().create(rep);
try {
adminClient.realm(realmName);
testingClient.server().run(session -> {
RealmModel realm = session.realms().getRealmByName(realmName);
Assert.assertTrue(realm instanceof org.keycloak.models.cache.infinispan.RealmAdapter);
Assert.assertNull(realm.getUserActionTokenLifespans().get("something"));
Assert.assertEquals(true, realm.getAttribute("myboolean", true));
Assert.assertEquals(Long.valueOf(123), realm.getAttribute("mylong", (long) 123));
Assert.assertEquals(Integer.valueOf(1234), realm.getAttribute("myint", 1234));
RealmProvider delegate = session.getProvider(CacheRealmProvider.class).getRealmDelegate();
RealmModel realm2 = delegate.getRealm(realm.getId());
Assert.assertTrue(realm2 instanceof org.keycloak.models.jpa.RealmAdapter);
Assert.assertNull(realm2.getUserActionTokenLifespans().get("something"));
Assert.assertEquals(true, realm2.getAttribute("myboolean", true));
Assert.assertEquals(Long.valueOf(123), realm2.getAttribute("mylong", (long) 123));
Assert.assertEquals(Integer.valueOf(1234), realm2.getAttribute("myint", 1234));
});
} finally {
adminClient.realm(realmName).remove();
}
}
public void testSetEmptyAttributeValues() {
final String realmName = "testSetEmptyAttributeValues";
try (Creator<RealmResource> c = Creator.create(adminClient, RealmBuilder.create()
.name(realmName)
.attribute("myboolean", "")
.attribute("mylong", "")
.attribute("myint", "")
.attribute(RealmAttributes.ACTION_TOKEN_GENERATED_BY_USER_LIFESPAN + ".something", "")
.build()
)) {
testingClient.server().run(session -> {
RealmModel realm = session.realms().getRealmByName(realmName);
Assert.assertTrue(realm instanceof org.keycloak.models.cache.infinispan.RealmAdapter);
Assert.assertNull(realm.getUserActionTokenLifespans().get("something"));
Assert.assertEquals(true, realm.getAttribute("myboolean", true));
Assert.assertEquals(Long.valueOf(123), realm.getAttribute("mylong", (long) 123));
Assert.assertEquals(Integer.valueOf(1234), realm.getAttribute("myint", 1234));
RealmProvider delegate = session.getProvider(CacheRealmProvider.class).getRealmDelegate();
RealmModel realm2 = delegate.getRealm(realm.getId());
Assert.assertTrue(realm2 instanceof org.keycloak.models.jpa.RealmAdapter);
Assert.assertNull(realm2.getUserActionTokenLifespans().get("something"));
Assert.assertEquals(true, realm2.getAttribute("myboolean", true));
Assert.assertEquals(Long.valueOf(123), realm2.getAttribute("mylong", (long) 123));
Assert.assertEquals(Integer.valueOf(1234), realm2.getAttribute("myint", 1234));
});
}
}

@stianst stianst Feb 6, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I'd rather just merge it as is, and if you want to polish the test afterwards feel free ;)

}