Merge remote-tracking branch 'adorsys/main'

adorsys · Nov 13, 2024 · d227235 · d227235
2 parents cd40ca0 + bc525cc
commit d227235
Show file tree

Hide file tree

Showing 6 changed files with 46 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- Added Navigation in the readme [#1010](https://github.com/adorsys/keycloak-config-cli/issues/1010)
+### Added
+- improved logging for realm retrieval errors [#1010](https://github.com/adorsys/keycloak-config-cli/issues/1010)
+### Fixed
+- Fix required action import handling for no-delete option [#834](https://github.com/adorsys/keycloak-config-cli/issues/834)
+
+### Fixed
+- Allow environment variables from existing secrets [#822](https://github.com/adorsys/keycloak-config-cli/issues/822)
 ### Fixed
 - Fix  versioning in artifact to contain the correct keycloak version [#1097](https://github.com/adorsys/keycloak-config-cli/issues/1097)
 

diff --git a/README.md b/README.md
@@ -5,6 +5,22 @@
 [![codecov](https://codecov.io/gh/adorsys/keycloak-config-cli/branch/main/graph/badge.svg)](https://codecov.io/gh/adorsys/keycloak-config-cli)
 [![GitHub license](https://img.shields.io/github/license/adorsys/keycloak-config-cli)](https://github.com/adorsys/keycloak-config-cli/blob/main/LICENSE.txt)
 
+# Table of Contents
+
+- [Config Files](#config-files)
+- [Variable Substitution](#variable-substitution)
+- [Logging](#logging)
+- [Supported Features](#supported-features)
+- [Compatibility with Keycloak](#compatibility-with-keycloak)
+- [Build this Project](#build-this-project)
+- [Run Integration Tests](#run-integration-tests)
+- [Run this Project](#run-this-project)
+- [Docker](#docker)
+- [Helm](#helm)
+- [Configuration](#configuration)
+- [Perform Release](#perform-release)
+- [Commercial Support](#commercial-support)
+
 # keycloak-config-cli
 
 keycloak-config-cli is a Keycloak utility to ensure the desired configuration state for a realm based on a JSON/YAML file. The format of the JSON/YAML file based on the export realm format. Store and handle the configuration files inside git just like normal code. A Keycloak restart isn't required to apply the configuration.
@@ -91,6 +107,8 @@ Further development requirements
 - Java Development Kit (JDK)
 - Docker Desktop or an alternative replacement (e.g Rancher Desktop)
 
+Before running `mvn verify`, you have to set the JAVA_HOME environment variable to prevent some test failures.
+
 ```shell
 ./mvnw verify
 

diff --git a/contrib/charts/keycloak-config-cli/templates/job.yaml b/contrib/charts/keycloak-config-cli/templates/job.yaml
@@ -54,7 +54,16 @@ spec:
                 secretKeyRef:
                   name: "{{ tpl .Values.existingSecret . }}"
                   key: "{{ .Values.existingSecretKey }}"
-          {{- end }}
+            {{- end }}
+            {{- if .Values.existingSecrets }}
+            {{- range .Values.existingSecrets }}
+            - name: {{ .envVar }}
+              valueFrom:
+                secretKeyRef:
+                  name: {{ .name }}
+                  key: {{ .key }}
+            {{- end }}
+            {{- end }}
           {{- with .Values.containerSecurityContext }}
           securityContext:
           {{- toYaml . | nindent 12 }}

diff --git a/contrib/charts/keycloak-config-cli/values.yaml b/contrib/charts/keycloak-config-cli/values.yaml
@@ -55,6 +55,11 @@ podLabels: {}
 
 ## Extra Annotations to be added to pod
 podAnnotations: {}
+# New section for existing secrets
+existingSecrets:
+# - name: my-existing-secret
+#   key: my-secret-key
+#   envVar: MY_ENV_VAR
 
 config: {}
   # <realm name>:

diff --git a/src/main/java/de/adorsys/keycloak/config/service/RequiredActionsImportService.java b/src/main/java/de/adorsys/keycloak/config/service/RequiredActionsImportService.java
@@ -63,7 +63,7 @@ public void doImport(RealmImport realmImport) {
 
         List<RequiredActionProviderRepresentation> existingRequiredActions = requiredActionRepository.getAll(realmName);
 
-        if (importConfigProperties.getManaged().getClientScope() == ImportManagedPropertiesValues.FULL) {
+        if (importConfigProperties.getManaged().getRequiredAction() == ImportManagedPropertiesValues.FULL) {
             deleteRequiredActionsMissingInImport(realmName, requiredActions, existingRequiredActions);
         }
 

diff --git a/src/main/java/de/adorsys/keycloak/config/service/checksum/ChecksumService.java b/src/main/java/de/adorsys/keycloak/config/service/checksum/ChecksumService.java
@@ -64,6 +64,9 @@ public void doImport(RealmImport realmImport) {
 
     public boolean hasToBeUpdated(RealmImport realmImport) {
         RealmRepresentation existingRealm = realmRepository.get(realmImport.getRealm());
+        if (existingRealm == null) {
+            throw new InvalidImportException("The specified realm does not exist: " + realmImport.getRealm());
+        }
         Map<String, String> customAttributes = existingRealm.getAttributes();
 
         String readChecksum = customAttributes.get(getCustomAttributeKey(realmImport));