Files
qbit-authentik/src/test/java/com/kingsrook/qbits/authentik/AuthentikQBitConfigTest.java
T
james.maesandClaude Opus 5.5 d0c5c2971e fix(config): startup log lists the effective features (TOKENS on by default)
The "Authentik QBit produced" line logged the configured feature set, so
TOKENS (on by default whenever writes are enabled) never appeared.
getEffectiveFeatures() reports what hasFeature() says is on.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-14 12:42:58 -05:00

253 lines
13 KiB
Java

/*
* Copyright 2026 Kingsrook, LLC
*
* 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 com.kingsrook.qbits.authentik;
import java.util.ArrayList;
import java.util.EnumSet;
import java.util.List;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.assertThat;
/*******************************************************************************
** Tests for AuthentikQBitConfig.
*******************************************************************************/
class AuthentikQBitConfigTest
{
/*******************************************************************************
**
*******************************************************************************/
private static List<String> errors(AuthentikQBitConfig config)
{
List<String> errors = new ArrayList<>();
config.validate(new QInstance(), errors);
return (errors);
}
/*******************************************************************************
**
*******************************************************************************/
@Test
void validConfigHasNoErrors()
{
assertThat(errors(AuthentikTestSupport.unitConfig())).isEmpty();
}
/*******************************************************************************
**
*******************************************************************************/
@Test
void policyNames()
{
assertThat(AuthentikTestSupport.unitConfig().getPolicyFormat()).isEqualTo(com.kingsrook.qbits.authentik.policy.PolicyFormat.DEFAULT);
assertThat(AuthentikTestSupport.unitConfig().getPolicyTwoPersonApproval()).isFalse();
assertThat(errors(AuthentikTestSupport.unitConfig().withPolicySpec("acme-iam").withPolicyVersion("2.0.0").withPolicyAttribute("policies").withPolicyClaim("policies"))).isEmpty();
assertThat(errors(AuthentikTestSupport.unitConfig().withPolicyVersion("1"))).anyMatch(e -> e.contains("policyVersion"));
assertThat(errors(AuthentikTestSupport.unitConfig().withPolicySpec(""))).anyMatch(e -> e.contains("policySpec"));
assertThat(errors(AuthentikTestSupport.unitConfig().withPolicyClaim("a b"))).anyMatch(e -> e.contains("policyClaim"));
assertThat(errors(AuthentikTestSupport.unitConfig().withPolicyAttribute(null))).anyMatch(e -> e.contains("policyAttribute"));
assertThat(AuthentikTestSupport.unitConfig().withPolicyTwoPersonApproval(true).getPolicyTwoPersonApproval()).isTrue();
}
/*******************************************************************************
**
*******************************************************************************/
@Test
void requiredSettings()
{
List<String> errors = errors(new AuthentikQBitConfig());
assertThat(errors).anyMatch(e -> e.contains("baseUrl is required"));
assertThat(errors).anyMatch(e -> e.contains("apiToken is required"));
assertThat(errors).anyMatch(e -> e.contains("appKey is required"));
}
/*******************************************************************************
**
*******************************************************************************/
@Test
void baseUrlMustBeHostRoot()
{
assertThat(errors(AuthentikTestSupport.unitConfig().withBaseUrl("ftp://x"))).anyMatch(e -> e.contains("absolute http(s)"));
assertThat(errors(AuthentikTestSupport.unitConfig().withBaseUrl("https://auth.example.test/api/v3"))).anyMatch(e -> e.contains("host root"));
assertThat(errors(AuthentikTestSupport.unitConfig().withBaseUrl("not a url at all"))).isNotEmpty();
assertThat(AuthentikTestSupport.unitConfig().withBaseUrl("https://auth.example.test//").getApiRoot()).isEqualTo("https://auth.example.test/api/v3");
}
/*******************************************************************************
**
*******************************************************************************/
@Test
void unavailableFeaturesAndDependencies()
{
assertThat(errors(AuthentikTestSupport.unitConfig().withFeatures(EnumSet.of(AuthentikFeature.READ, AuthentikFeature.RBAC))))
.anyMatch(e -> e.contains("RBAC is not available"));
assertThat(errors(AuthentikTestSupport.unitConfig().withFeatures(EnumSet.of(AuthentikFeature.RBAC)))).anyMatch(e -> e.contains("READ is required"));
assertThat(errors(AuthentikTestSupport.unitConfig().withFeatures(EnumSet.of(AuthentikFeature.READ, AuthentikFeature.MEMBERSHIP)))).anyMatch(e -> e.contains("localBackendName"));
assertThat(errors(AuthentikTestSupport.unitConfig().withFeatures(EnumSet.of(AuthentikFeature.READ, AuthentikFeature.MEMBERSHIP)).withLocalBackendName("nope")))
.anyMatch(e -> e.contains("backend not found"));
assertThat(errors(AuthentikTestSupport.unitConfig().withFeatures(EnumSet.of(AuthentikFeature.READ, AuthentikFeature.USERS)))).anyMatch(e -> e.contains("recoveryEmailStage"));
assertThat(errors(AuthentikTestSupport.unitConfig().withFeatures(EnumSet.of(AuthentikFeature.READ, AuthentikFeature.WEBHOOK)).withWebhookSecret(null))).anyMatch(e -> e.contains("webhookSecret"));
}
/*******************************************************************************
**
*******************************************************************************/
@Test
void numericAndNameSettings()
{
assertThat(errors(AuthentikTestSupport.unitConfig().withThrottleRequestsPerSecond(0))).anyMatch(e -> e.contains("at least 1"));
assertThat(errors(AuthentikTestSupport.unitConfig().withListCacheTtlSeconds(-1))).anyMatch(e -> e.contains("non-negative"));
assertThat(errors(AuthentikTestSupport.unitConfig().withTableNamePrefix("9bad"))).anyMatch(e -> e.contains("tableNamePrefix"));
assertThat(errors(AuthentikTestSupport.unitConfig().withAppKey("Bad Key"))).anyMatch(e -> e.contains("appKey"));
}
/*******************************************************************************
**
*******************************************************************************/
@Test
void secretsResolveAndNeverPrint() throws Exception
{
AuthentikQBitConfig config = AuthentikTestSupport.unitConfig().withApiToken("${env.QBIT_AUTHENTIK_TEST_UNSET_VARIABLE}");
assertThat(config.getResolvedApiToken()).isNull();
assertThat(errors(config)).anyMatch(e -> e.contains("apiToken"));
AuthentikQBitConfig literal = AuthentikTestSupport.unitConfig();
assertThat(literal.getResolvedApiToken()).isEqualTo(AuthentikTestSupport.TEST_TOKEN);
assertThat(literal.toString()).doesNotContain(AuthentikTestSupport.TEST_TOKEN).contains("******");
String json = new ObjectMapper().writeValueAsString(literal.withWebhookSecret("hook-secret-value"));
assertThat(json).doesNotContain(AuthentikTestSupport.TEST_TOKEN).doesNotContain("hook-secret-value");
}
/*******************************************************************************
**
*******************************************************************************/
@Test
void derivedNames()
{
AuthentikQBitConfig config = AuthentikTestSupport.unitConfig();
assertThat(config.applyPrefix("admin")).isEqualTo("authentikAdmin");
assertThat(config.applyTablePrefix("user")).isEqualTo("authentik_user");
assertThat(config.applyTablePrefix("groupMember")).isEqualTo("authentik_group_member");
assertThat(config.getApiBackendName()).isEqualTo("authentikApi");
assertThat(config.getEffectiveServiceAccountUsername()).isEqualTo("qqq-kof22-admin-idadmin");
assertThat(config.withServiceAccountUsername("custom-sa").getEffectiveServiceAccountUsername()).isEqualTo("custom-sa");
assertThat(new AuthentikQBitConfig().withTableNamePrefix("").applyTablePrefix("user")).isEqualTo("user");
assertThat(new AuthentikQBitConfig().withTableNamePrefix("").applyTablePrefix("groupMember")).isEqualTo("group_member");
assertThat(new AuthentikQBitConfig().withTableNamePrefix("myAuth").applyTablePrefix("groupMember")).isEqualTo("my_auth_group_member");
assertThat(config.withBootstrapOperatorSubjects(" A1, ,b2 ").getResolvedBootstrapSubjects()).containsExactly("A1", "b2");
}
/*******************************************************************************
** Emails are refused as bootstrap subjects: users can change their own.
*******************************************************************************/
@Test
void bootstrapSubjectsRejectEmails()
{
assertThat(errors(AuthentikTestSupport.unitConfig().withBootstrapOperatorSubjects("owner@example.test"))).anyMatch(e -> e.contains("never emails"));
assertThat(errors(AuthentikTestSupport.unitConfig().withBootstrapOperatorSubjects("42"))).noneMatch(e -> e.contains("never emails"));
}
/*******************************************************************************
**
*******************************************************************************/
@Test
void toSnakeCase()
{
assertThat(AuthentikQBitConfig.toSnakeCase(null)).isNull();
assertThat(AuthentikQBitConfig.toSnakeCase("")).isEqualTo("");
assertThat(AuthentikQBitConfig.toSnakeCase("user")).isEqualTo("user");
assertThat(AuthentikQBitConfig.toSnakeCase("groupMember")).isEqualTo("group_member");
assertThat(AuthentikQBitConfig.toSnakeCase("GroupMember")).isEqualTo("group_member");
assertThat(AuthentikQBitConfig.toSnakeCase("group_member")).isEqualTo("group_member");
assertThat(AuthentikQBitConfig.toSnakeCase("mfaTOTPDevice")).isEqualTo("mfa_totp_device");
assertThat(AuthentikQBitConfig.toSnakeCase("auth2Factor")).isEqualTo("auth2_factor");
}
/*******************************************************************************
** Token defaults, minimum lifetimes and secret-safe diagnostics.
*******************************************************************************/
@Test
void tokenConfig()
{
AuthentikQBitConfig config = AuthentikTestSupport.unitConfig();
assertThat(config.getTokenMaxDaysUser()).isEqualTo(90);
assertThat(config.getTokenMaxDaysServiceAccount()).isEqualTo(365);
assertThat(config.getTokenUnusedDays()).isEqualTo(60);
assertThat(config.getTokenProtectedGroups()).containsExactly("authentik Admins", "identity-admins");
assertThat(config.getTokenScopesEnabled()).isFalse();
assertThat(config.getTokenTwoPersonApproval()).isFalse();
assertThat(config.getTokenEndpointUrl()).isEqualTo(config.getBaseUrl() + "/application/o/token/");
assertThat(config.getAuthentikPublicUrl()).isEqualTo(config.getBaseUrl());
assertThat(config.getServiceAccountTokenLifetime()).isEqualTo("days=365");
config.withServiceAccountTokenLifetime("days=200");
assertThat(config.getServiceAccountTokenLifetime()).isEqualTo("days=200");
config.setServiceAccountTokenLifetime("days=365");
config.withTokenBrokerClientSecret("do-not-serialize-this");
assertThat(config.toString()).doesNotContain("do-not-serialize-this");
assertThat(com.kingsrook.qqq.backend.core.utils.JsonUtils.toJson(config)).doesNotContain("do-not-serialize-this");
config.setTokenMaxDaysUser(0);
config.setTokenMaxDaysServiceAccount(-1);
config.setTokenUnusedDays(null);
assertThat(errors(config)).contains("tokenMaxDaysUser must be at least 1", "tokenMaxDaysServiceAccount must be at least 1", "tokenUnusedDays must be at least 1");
config.withTokenMaxDaysUser(1).withTokenMaxDaysServiceAccount(1).withTokenUnusedDays(1);
assertThat(errors(config)).isEmpty();
config.withTokenBrokerClientId("${env.QBIT_TEST_UNSET_BROKER_ID}").withTokenBrokerClientSecret("${env.QBIT_TEST_UNSET_BROKER_SECRET}");
assertThat(config.getTokenBrokerClientId()).isNull();
assertThat(config.getTokenBrokerClientSecret()).isNull();
}
/*******************************************************************************
** The startup log lists TOKENS when it is on by default (writes enabled).
*******************************************************************************/
@org.junit.jupiter.api.Test
void effectiveFeaturesIncludeDefaultTokens()
{
AuthentikQBitConfig writes = new AuthentikQBitConfig().withFeatures(java.util.EnumSet.of(AuthentikFeature.READ, AuthentikFeature.USERS)).withTokensEnabled(true);
org.assertj.core.api.Assertions.assertThat(writes.getEffectiveFeatures()).contains(AuthentikFeature.TOKENS, AuthentikFeature.READ, AuthentikFeature.USERS);
AuthentikQBitConfig readOnly = new AuthentikQBitConfig().withFeatures(java.util.EnumSet.of(AuthentikFeature.READ));
org.assertj.core.api.Assertions.assertThat(readOnly.getEffectiveFeatures()).containsExactly(AuthentikFeature.READ);
}
}