feat: add realm translation resource (#1123)

* feat: add realm translation resource

Signed-off-by: Jonathan Davies <[email protected]>

* feat: remove redundant code

Signed-off-by: Jonathan Davies <[email protected]>

* feat: add documentation, expand tests and rename language->locale

Signed-off-by: Jonathan Davies <[email protected]>

* fix: revert tflog

Signed-off-by: Jonathan Davies <[email protected]>

* feat: readd tflog

Signed-off-by: Jonathan Davies <[email protected]>

* feat: rename translations to localization texts

Signed-off-by: Jonathan Davies <[email protected]>

* fix: example tf

Signed-off-by: Jonathan Davies <[email protected]>

* fix: wrong resource

Signed-off-by: Jonathan Davies <[email protected]>

* fix: change back to 600

Signed-off-by: Jonathan Davies <[email protected]>

---------

Signed-off-by: Jonathan Davies <[email protected]>
Co-authored-by: Sebastian Schuster <[email protected]>

Author: jonathandavies-CS

docs/resources/realm_translation.md

@@ -0,0 +1,38 @@
+---
+page_title: "keycloak_realm_localization Resource"
+---
+
+# keycloak_realm_localization Resource
+
+Allows for managing Realm Localization Text overrides within Keycloak.
+
+A localization resource defines a schema for representing a locale with a map of key/value pairs and how they are managed within a realm.
+
+Note: whilst you can provide localization texts for unsupported locales, they will not take effect until they are defined within the realm resource.
+
+## Example Usage
+
+```hcl
+resource "keycloak_realm" "realm" {
+  realm = "my-realm"
+}
+
+resource "keycloak_realm_localization" "german_texts" {
+  realm_id = keycloak_realm.my_realm.id
+  locale = "de"
+  texts = {
+    "Hello" : "Hallo"
+  }
+}
+```
+
+## Argument Reference
+
+- `realm_id` - (Required) The ID of the realm the user profile applies to.
+- `locale` - (Required) The locale (language code) the texts apply to.
+- `texts` - (Optional) A map of translation keys to values.
+
+
+## Import
+
+This resource does not currently support importing.

example/main.tf

@@ -101,6 +101,14 @@ resource "keycloak_realm" "test" {
   }
 }
 
+resource "keycloak_realm_localization" "test_translation" {
+  realm_id = keycloak_realm.test.id
+  locale   = "en"
+  texts = {
+    "test" : "translation"
+  }
+}
+
 resource "keycloak_required_action" "custom-terms-and-conditions" {
   realm_id       = keycloak_realm.test.realm
   alias          = "TERMS_AND_CONDITIONS"
@@ -116,7 +124,7 @@ resource "keycloak_required_action" "update-password" {
   enabled        = true
   name           = "Update Password"
 
-  config {
+  config = {
     max_auth_age = "600"
   }
 }
@@ -439,25 +447,25 @@ resource "keycloak_ldap_full_name_mapper" "full_name_mapper" {
 }
 
 resource "keycloak_ldap_custom_mapper" "custom_mapper" {
-	name                    = "custom-mapper"
-	realm_id                = keycloak_ldap_user_federation.openldap.realm_id
-	ldap_user_federation_id = keycloak_ldap_user_federation.openldap.id
+  name                    = "custom-mapper"
+  realm_id                = keycloak_ldap_user_federation.openldap.realm_id
+  ldap_user_federation_id = keycloak_ldap_user_federation.openldap.id
 
-	provider_id        		= "msad-user-account-control-mapper"
-	provider_type           = "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"
+  provider_id   = "msad-user-account-control-mapper"
+  provider_type = "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"
 }
 
 resource "keycloak_ldap_custom_mapper" "custom_mapper_with_config" {
-	name                    = "custom-mapper-with-config"
-	realm_id                = keycloak_ldap_user_federation.openldap.realm_id
-	ldap_user_federation_id = keycloak_ldap_user_federation.openldap.id
-
-	provider_id             = "user-attribute-ldap-mapper"
-	provider_type           = "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"
-	config                  = {
-		"user.model.attribute" = "username"
-		"ldap.attribute"       = "cn"
-	}
+  name                    = "custom-mapper-with-config"
+  realm_id                = keycloak_ldap_user_federation.openldap.realm_id
+  ldap_user_federation_id = keycloak_ldap_user_federation.openldap.id
+
+  provider_id   = "user-attribute-ldap-mapper"
+  provider_type = "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"
+  config = {
+    "user.model.attribute" = "username"
+    "ldap.attribute"       = "cn"
+  }
 }
 
 

keycloak/keycloak_client.go

@@ -7,7 +7,6 @@ import (
 	"crypto/x509"
 	"encoding/json"
 	"fmt"
-	"github.com/hashicorp/terraform-plugin-log/tflog"
 	"io"
 	"net/http"
 	"net/http/cookiejar"
@@ -18,6 +17,7 @@ import (
 	"time"
 
 	"github.com/hashicorp/go-version"
+	"github.com/hashicorp/terraform-plugin-log/tflog"
 
 	"golang.org/x/net/publicsuffix"
 
@@ -293,7 +293,7 @@ func (keycloakClient *KeycloakClient) addRequestHeaders(request *http.Request) {
 		request.Header.Set("User-Agent", keycloakClient.userAgent)
 	}
 
-	if request.Method == http.MethodPost || request.Method == http.MethodPut || request.Method == http.MethodDelete {
+	if request.Header.Get("Content-type") == "" && (request.Method == http.MethodPost || request.Method == http.MethodPut || request.Method == http.MethodDelete) {
 		request.Header.Set("Content-type", "application/json")
 	}
 }

keycloak/realm_translation.go

@@ -0,0 +1,68 @@
+package keycloak
+
+import (
+	"bytes"
+	"context"
+	"encoding/json"
+	"fmt"
+	"net/http"
+)
+
+func (keycloakClient *KeycloakClient) UpdateRealmLocalizationTexts(ctx context.Context, realmId string, locale string, texts map[string]string) error {
+	var existingtexts map[string]string
+
+	data, _ := keycloakClient.getRaw(ctx, fmt.Sprintf("/realms/%s/localization/%s", realmId, locale), nil)
+	err := json.Unmarshal(data, &existingtexts)
+	if err != nil {
+		return nil
+	}
+	textsToDelete := make([]string, 0)
+	for key := range existingtexts {
+		if _, exists := texts[key]; !exists {
+			textsToDelete = append(textsToDelete, key)
+		}
+	}
+	for _, key := range textsToDelete {
+		err := keycloakClient.delete(ctx, fmt.Sprintf("/realms/%s/localization/%s/%s", realmId, locale, key), nil)
+		if err != nil {
+			return err
+		}
+	}
+	for key, value := range texts {
+		err := keycloakClient.putPlain(ctx, fmt.Sprintf("/realms/%s/localization/%s/%s", realmId, locale, key), value)
+		if err != nil {
+			return err
+		}
+	}
+	return nil
+}
+
+func (keycloakClient *KeycloakClient) putPlain(ctx context.Context, path string, requestBody string) error {
+	resourceUrl := keycloakClient.baseUrl + apiUrl + path
+	request, err := http.NewRequestWithContext(ctx, http.MethodPut, resourceUrl, bytes.NewReader([]byte(requestBody)))
+	if err != nil {
+		return err
+	}
+	request.Header.Set("Content-type", "text/plain")
+	_, _, err = keycloakClient.sendRequest(ctx, request, []byte(requestBody))
+	return err
+}
+
+func (keycloakClient *KeycloakClient) GetRealmLocalizationTexts(ctx context.Context, realmId string, locale string) (*map[string]string, error) {
+	keyValues := make(map[string]string)
+	err := keycloakClient.get(ctx, fmt.Sprintf("/realms/%s/localization/%s", realmId, locale), &keyValues, nil)
+	if err != nil {
+		return nil, err
+	}
+	return &keyValues, nil
+}
+
+func (keycloakClient *KeycloakClient) DeleteRealmLocalizationTexts(ctx context.Context, realmId string, locale string, texts map[string]string) error {
+	for key := range texts {
+		err := keycloakClient.delete(ctx, fmt.Sprintf("/realms/%s/localization/%s/%s", realmId, locale, key), nil)
+		if err != nil {
+			return err
+		}
+	}
+	return nil
+}

provider/provider.go

@@ -41,6 +41,7 @@ func KeycloakProvider(client *keycloak.KeycloakClient) *schema.Provider {
 			"keycloak_realm_keystore_rsa":                                resourceKeycloakRealmKeystoreRsa(),
 			"keycloak_realm_keystore_rsa_generated":                      resourceKeycloakRealmKeystoreRsaGenerated(),
 			"keycloak_realm_user_profile":                                resourceKeycloakRealmUserProfile(),
+			"keycloak_realm_localization":                                resourceKeycloakRealmLocalization(),
 			"keycloak_required_action":                                   resourceKeycloakRequiredAction(),
 			"keycloak_group":                                             resourceKeycloakGroup(),
 			"keycloak_group_memberships":                                 resourceKeycloakGroupMemberships(),

provider/resource_keycloak_realm.go

@@ -2,6 +2,7 @@ package provider
 
 import (
 	"context"
+
 	"github.com/hashicorp/go-version"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"

provider/resource_keycloak_realm_localization.go

@@ -0,0 +1,99 @@
+package provider
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"github.com/keycloak/terraform-provider-keycloak/keycloak"
+)
+
+func resourceKeycloakRealmLocalization() *schema.Resource {
+	return &schema.Resource{
+		CreateContext: resourceKeycloakRealmLocalizationTextsUpdate,
+		ReadContext:   resourceKeycloakRealmLocalizationTextsRead,
+		DeleteContext: resourceKeycloakRealmLocalizationTextsDelete,
+		UpdateContext: resourceKeycloakRealmLocalizationTextsUpdate,
+		Description:   "Manage realm-level localization texts.",
+		Schema: map[string]*schema.Schema{
+			"realm_id": {
+				Type:        schema.TypeString,
+				Required:    true,
+				ForceNew:    true,
+				Description: "The realm in which the texts exists.",
+			},
+			"locale": {
+				Type:        schema.TypeString,
+				Required:    true,
+				ForceNew:    true,
+				Description: "The locale for the localization texts.",
+			},
+			"texts": {
+				Optional: true,
+				Type:     schema.TypeMap,
+				Elem: &schema.Schema{
+					Type: schema.TypeString,
+				},
+				Description: "The mapping of localization texts keys to values.",
+			},
+		},
+	}
+}
+
+func resourceKeycloakRealmLocalizationTextsRead(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	keycloakClient := meta.(*keycloak.KeycloakClient)
+	realmId := data.Get("realm_id").(string)
+	locale := data.Get("locale").(string)
+	realmLocaleTexts, err := keycloakClient.GetRealmLocalizationTexts(ctx, realmId, locale)
+	if err != nil {
+		return diag.FromErr(err)
+	}
+	data.Set("texts", realmLocaleTexts)
+	return nil
+}
+
+func resourceKeycloakRealmLocalizationTextsUpdate(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	client := meta.(*keycloak.KeycloakClient)
+	realm := d.Get("realm_id").(string)
+	locale := d.Get("locale").(string)
+	texts := d.Get("texts").(map[string]interface{})
+	textsConverted := convertTexts(texts)
+
+	err := client.UpdateRealmLocalizationTexts(ctx, realm, locale, textsConverted)
+	if err != nil {
+		return diag.FromErr(err)
+	}
+
+	d.SetId(fmt.Sprintf("%s/%s", realm, locale)) // Set resource ID as "realm/locale"
+	return resourceKeycloakRealmLocalizationTextsRead(ctx, d, meta)
+}
+
+func resourceKeycloakRealmLocalizationTextsDelete(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	client := meta.(*keycloak.KeycloakClient)
+	realm := d.Get("realm_id").(string)
+	locale := d.Get("locale").(string)
+	texts := d.Get("texts").(map[string]interface{})
+	textsConverted := convertTexts(texts)
+
+	err := client.DeleteRealmLocalizationTexts(ctx, realm, locale, textsConverted)
+	if err != nil {
+		return diag.FromErr(err)
+	}
+
+	d.SetId("")
+	return nil
+}
+
+func convertTexts(texts map[string]interface{}) map[string]string {
+	translionsConverted := make(map[string]string)
+	for key, value := range texts {
+		strValue, ok := value.(string)
+		if !ok {
+			panic(fmt.Sprintf("expected string, got %T for key %s", value, key))
+		}
+		translionsConverted[key] = strValue
+	}
+
+	return translionsConverted
+}