feat(seeding): add userProfile and localizationTexts to seeding

Refs: #1150
eclipse-tractusx · Nov 17, 2024 · a0b42a1 · a0b42a1
1 parent ab3c230
commit a0b42a1
Show file tree

Hide file tree

Showing 26 changed files with 743 additions and 159 deletions.
diff --git a/src/keycloak/Keycloak.Library/Components/KeycloakClient.cs b/src/keycloak/Keycloak.Library/Components/KeycloakClient.cs
@@ -30,15 +30,15 @@ namespace Org.Eclipse.TractusX.Portal.Backend.Keycloak.Library;
 
 public partial class KeycloakClient
 {
-    public async Task CreateComponentAsync(string realm, Component componentRepresentation) =>
-        await (await GetBaseUrlAsync(realm).ConfigureAwait(ConfigureAwaitOptions.None))
+    public async Task CreateComponentAsync(string realm, Component componentRepresentation, CancellationToken cancellationToken) =>
+        await (await GetBaseUrlAsync(realm, cancellationToken).ConfigureAwait(ConfigureAwaitOptions.None))
             .AppendPathSegment("/admin/realms/")
             .AppendPathSegment(realm, true)
             .AppendPathSegment("/components")
-            .PostJsonAsync(componentRepresentation)
+            .PostJsonAsync(componentRepresentation, cancellationToken: cancellationToken)
             .ConfigureAwait(ConfigureAwaitOptions.None);
 
-    public async Task<IEnumerable<Component>> GetComponentsAsync(string realm, string? name = null, string? parent = null, string? type = null)
+    public async Task<IEnumerable<Component>> GetComponentsAsync(string realm, string? name = null, string? parent = null, string? type = null, CancellationToken cancellationToken = default)
     {
         var queryParams = new Dictionary<string, object?>
         {
@@ -47,58 +47,30 @@ public async Task<IEnumerable<Component>> GetComponentsAsync(string realm, strin
             [nameof(type)] = type
         };
 
-        return await (await GetBaseUrlAsync(realm).ConfigureAwait(ConfigureAwaitOptions.None))
+        return await (await GetBaseUrlAsync(realm, cancellationToken).ConfigureAwait(ConfigureAwaitOptions.None))
             .AppendPathSegment("/admin/realms/")
             .AppendPathSegment(realm, true)
             .AppendPathSegment("/components")
             .SetQueryParams(queryParams)
-            .GetJsonAsync<IEnumerable<Component>>()
+            .GetJsonAsync<IEnumerable<Component>>(cancellationToken: cancellationToken)
             .ConfigureAwait(ConfigureAwaitOptions.None);
     }
 
-    public async Task<Component> GetComponentAsync(string realm, string componentId) =>
-        await (await GetBaseUrlAsync(realm).ConfigureAwait(ConfigureAwaitOptions.None))
+    public async Task UpdateComponentAsync(string realm, string componentId, Component componentRepresentation, CancellationToken cancellationToken) =>
+        await (await GetBaseUrlAsync(realm, cancellationToken).ConfigureAwait(ConfigureAwaitOptions.None))
             .AppendPathSegment("/admin/realms/")
             .AppendPathSegment(realm, true)
             .AppendPathSegment("/components/")
             .AppendPathSegment(componentId, true)
-            .GetJsonAsync<Component>()
+            .PutJsonAsync(componentRepresentation, cancellationToken: cancellationToken)
             .ConfigureAwait(ConfigureAwaitOptions.None);
 
-    public async Task UpdateComponentAsync(string realm, string componentId, Component componentRepresentation) =>
-        await (await GetBaseUrlAsync(realm).ConfigureAwait(ConfigureAwaitOptions.None))
+    public async Task DeleteComponentAsync(string realm, string componentId, CancellationToken cancellationToken) =>
+        await (await GetBaseUrlAsync(realm, cancellationToken).ConfigureAwait(ConfigureAwaitOptions.None))
             .AppendPathSegment("/admin/realms/")
             .AppendPathSegment(realm, true)
             .AppendPathSegment("/components/")
             .AppendPathSegment(componentId, true)
-            .PutJsonAsync(componentRepresentation)
+            .DeleteAsync(cancellationToken: cancellationToken)
             .ConfigureAwait(ConfigureAwaitOptions.None);
-
-    public async Task DeleteComponentAsync(string realm, string componentId) =>
-        await (await GetBaseUrlAsync(realm).ConfigureAwait(ConfigureAwaitOptions.None))
-            .AppendPathSegment("/admin/realms/")
-            .AppendPathSegment(realm, true)
-            .AppendPathSegment("/components/")
-            .AppendPathSegment(componentId, true)
-            .DeleteAsync()
-            .ConfigureAwait(ConfigureAwaitOptions.None);
-
-    public async Task<IEnumerable<ComponentType>> GetSubcomponentTypesAsync(string realm, string componentId, string? type = null)
-    {
-        var queryParams = new Dictionary<string, object?>
-        {
-            [nameof(type)] = type
-        };
-
-        var result = await (await GetBaseUrlAsync(realm).ConfigureAwait(ConfigureAwaitOptions.None))
-            .AppendPathSegment("/admin/realms/")
-            .AppendPathSegment(realm, true)
-            .AppendPathSegment("/components/")
-            .AppendPathSegment(componentId, true)
-            .AppendPathSegment("/sub-component-types")
-            .SetQueryParams(queryParams)
-            .GetJsonAsync<IEnumerable<ComponentType>>()
-            .ConfigureAwait(ConfigureAwaitOptions.None);
-        return result;
-    }
 }
diff --git a/src/keycloak/Keycloak.Library/Keycloak.Library.csproj b/src/keycloak/Keycloak.Library/Keycloak.Library.csproj
@@ -31,6 +31,7 @@
     <TargetFramework>net8.0</TargetFramework>
     <Nullable>enable</Nullable>
     <ImplicitUsings>enable</ImplicitUsings>
+    <UserSecretsId>ef300f2e-b1c3-4ce1-b028-92533b71aa73</UserSecretsId>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/src/keycloak/Keycloak.Library/Localization/KeycloakClient.cs b/src/keycloak/Keycloak.Library/Localization/KeycloakClient.cs
@@ -0,0 +1,81 @@
+/********************************************************************************
+ * Copyright (c) 2024 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Apache License, Version 2.0 which is available at
+ * https://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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ ********************************************************************************/
+
+using Flurl.Http;
+using Org.Eclipse.TractusX.Portal.Backend.Framework.Linq;
+using System.Net.Http.Headers;
+
+namespace Org.Eclipse.TractusX.Portal.Backend.Keycloak.Library;
+
+public partial class KeycloakClient
+{
+    public async Task<IEnumerable<string>> GetLocaleAsync(string realm, CancellationToken cancellationToken = default)
+    {
+        return await (await GetBaseUrlAsync(realm, cancellationToken).ConfigureAwait(ConfigureAwaitOptions.None))
+            .AppendPathSegment("/admin/realms/")
+            .AppendPathSegment(realm, true)
+            .AppendPathSegment("/localization")
+            .GetJsonAsync<IEnumerable<string>>(cancellationToken: cancellationToken)
+            .ConfigureAwait(ConfigureAwaitOptions.None);
+    }
+
+    public async Task<IEnumerable<KeyValuePair<string, string>>> GetLocaleAsync(string realm, string locale, CancellationToken cancellationToken = default)
+    {
+        var response = await (await GetBaseUrlAsync(realm, cancellationToken).ConfigureAwait(ConfigureAwaitOptions.None))
+            .AppendPathSegment("/admin/realms/")
+            .AppendPathSegment(realm, true)
+            .AppendPathSegment("/localization/")
+            .AppendPathSegment(locale, true)
+            .GetJsonAsync<IDictionary<string, string>?>(cancellationToken: cancellationToken)
+            .ConfigureAwait(ConfigureAwaitOptions.None);
+
+        return response == null
+            ? Enumerable.Empty<KeyValuePair<string, string>>()
+            : response.FilterNotNull();
+    }
+
+    public async Task UpdateLocaleAsync(string realm, string locale, string key, string translation, CancellationToken cancellationToken) =>
+        await (await GetBaseUrlAsync(realm, cancellationToken).ConfigureAwait(ConfigureAwaitOptions.None))
+            .AppendPathSegment("/admin/realms/")
+            .AppendPathSegment(realm, true)
+            .AppendPathSegment("/localization/")
+            .AppendPathSegment(locale, true)
+            .AppendPathSegment(key, true)
+            .PutAsync(new StringContent(translation, MediaTypeHeaderValue.Parse("text/plain")), cancellationToken: cancellationToken)
+            .ConfigureAwait(ConfigureAwaitOptions.None);
+
+    public async Task DeleteLocaleAsync(string realm, string locale, string key, CancellationToken cancellationToken) =>
+        await (await GetBaseUrlAsync(realm, cancellationToken).ConfigureAwait(ConfigureAwaitOptions.None))
+            .AppendPathSegment("/admin/realms/")
+            .AppendPathSegment(realm, true)
+            .AppendPathSegment("/localization/")
+            .AppendPathSegment(locale, true)
+            .AppendPathSegment(key, true)
+            .DeleteAsync(cancellationToken: cancellationToken)
+            .ConfigureAwait(ConfigureAwaitOptions.None);
+
+    public async Task DeleteLocaleAsync(string realm, string locale, CancellationToken cancellationToken) =>
+        await (await GetBaseUrlAsync(realm, cancellationToken).ConfigureAwait(ConfigureAwaitOptions.None))
+            .AppendPathSegment("/admin/realms/")
+            .AppendPathSegment(realm, true)
+            .AppendPathSegment("/localization/")
+            .AppendPathSegment(locale, true)
+            .DeleteAsync(cancellationToken: cancellationToken)
+            .ConfigureAwait(ConfigureAwaitOptions.None);
+}
diff --git a/src/keycloak/Keycloak.Library/Models/Components/Component.cs b/src/keycloak/Keycloak.Library/Models/Components/Component.cs
@@ -31,17 +31,23 @@ namespace Org.Eclipse.TractusX.Portal.Backend.Keycloak.Library.Models.Components
 public class Component
 {
     [JsonPropertyName("id")]
-    public string Id { get; set; }
+    public string? Id { get; set; }
+
     [JsonPropertyName("name")]
-    public string Name { get; set; }
+    public string? Name { get; set; }
+
     [JsonPropertyName("providerId")]
-    public string ProviderId { get; set; }
+    public string? ProviderId { get; set; }
+
     [JsonPropertyName("providerType")]
-    public string ProviderType { get; set; }
+    public string? ProviderType { get; set; }
+
     [JsonPropertyName("parentId")]
-    public string ParentId { get; set; }
+    public string? ParentId { get; set; }
+
     [JsonPropertyName("config")]
-    public Config Config { get; set; }
+    public IReadOnlyDictionary<string, IEnumerable<string>?>? Config { get; set; }
+
     [JsonPropertyName("subType")]
-    public string SubType { get; set; }
+    public string? SubType { get; set; }
 }
diff --git a/src/keycloak/Keycloak.Library/Models/Components/Config.cs b/src/keycloak/Keycloak.Library/Models/Components/Config.cs
diff --git a/src/keycloak/Keycloak.Library/Models/RealmsAdmin/Realm.cs b/src/keycloak/Keycloak.Library/Models/RealmsAdmin/Realm.cs
@@ -176,4 +176,8 @@ public class Realm
     public bool? UserManagedAccessAllowed { get; set; }
     [JsonPropertyName("passwordPolicy")]
     public string? PasswordPolicy { get; set; }
+    [JsonPropertyName("defaultLocale")]
+    public string? DefaultLocale { get; set; }
+    [JsonPropertyName("localizationTexts")]
+    public IDictionary<string, IDictionary<string, string>?>? LocalizationTexts { get; set; }
 }
diff --git a/src/keycloak/Keycloak.Library/Models/Root/Locale.cs b/src/keycloak/Keycloak.Library/Models/Root/Locale.cs
@@ -34,5 +34,8 @@ namespace Org.Eclipse.TractusX.Portal.Backend.Keycloak.Library.Models.Root;
 public enum Locale
 {
     [EnumMember(Value = "en")]
-    En
+    En,
+
+    [EnumMember(Value = "de")]
+    De
 }