Added unit tests + Keycloak Auth URL is now configurable

Author: Flurb

__snapshots__/compas-settings.md

@@ -19,6 +19,14 @@
   value="http://localhost:9091/compas-cim-mapping"
 >
 </mwc-textfield>
+<mwc-textfield
+  dialoginitialfocus=""
+  id="keycloakAuthUrl"
+  label="[compas.settings.keycloakAuthUrl]"
+  required=""
+  value="http://localhost:8089/auth/"
+>
+</mwc-textfield>
 <mwc-button style="--mdc-theme-primary: var(--mdc-theme-error)">
   [reset]
 </mwc-button>

src/compas/CompasSettingsElement.ts

@@ -8,10 +8,12 @@ import {TextFieldBase} from "@material/mwc-textfield/mwc-textfield-base";
 export type CompasSettingsRecord = {
   sclDataServiceUrl: string;
   cimMappingServiceUrl: string;
+  keycloakAuthUrl: string;
 };
 export const defaults: CompasSettingsRecord = {
   sclDataServiceUrl: 'http://localhost:9090/compas-scl-data-service',
-  cimMappingServiceUrl: 'http://localhost:9091/compas-cim-mapping'
+  cimMappingServiceUrl: 'http://localhost:9091/compas-cim-mapping',
+  keycloakAuthUrl: 'http://localhost:8089/auth/'
 };
 
 export function CompasSettings() {
@@ -21,6 +23,7 @@ export function CompasSettings() {
       return {
         sclDataServiceUrl: this.getCompasSetting('sclDataServiceUrl'),
         cimMappingServiceUrl: this.getCompasSetting('cimMappingServiceUrl'),
+        keycloakAuthUrl: this.getCompasSetting('keycloakAuthUrl')
       };
     },
 
@@ -52,9 +55,14 @@ export class CompasSettingsElement extends LitElement {
     return <TextFieldBase>this.shadowRoot!.querySelector('mwc-textfield[id="cimMappingServiceUrl"]');
   }
 
+  getKeycloakAuthUrlField(): TextFieldBase {
+    return <TextFieldBase>this.shadowRoot!.querySelector('mwc-textfield[id="keycloakAuthUrl"]');
+  }
+
   valid(): boolean {
     return this.getSclDataServiceUrlField().checkValidity()
-      && this.getCimMappingServiceUrlField().checkValidity();
+      && this.getCimMappingServiceUrlField().checkValidity()
+      && this.getKeycloakAuthUrlField().checkValidity();
   }
 
   save(): boolean {
@@ -65,6 +73,7 @@ export class CompasSettingsElement extends LitElement {
     // Update settings from TextField.
     CompasSettings().setCompasSetting('sclDataServiceUrl', this.getSclDataServiceUrlField().value);
     CompasSettings().setCompasSetting('cimMappingServiceUrl', this.getCimMappingServiceUrlField().value);
+    CompasSettings().setCompasSetting('keycloakAuthUrl', this.getKeycloakAuthUrlField().value);
     return true;
   }
 
@@ -91,6 +100,10 @@ export class CompasSettingsElement extends LitElement {
                      label="${translate('compas.settings.cimMappingServiceUrl')}"
                      value="${this.compasSettings.cimMappingServiceUrl}" required>
       </mwc-textfield>
+      <mwc-textfield dialogInitialFocus id="keycloakAuthUrl"
+                     label="${translate('compas.settings.keycloakAuthUrl')}"
+                     value="${this.compasSettings.keycloakAuthUrl}" required>
+      </mwc-textfield>
 
       <mwc-button style="--mdc-theme-primary: var(--mdc-theme-error)"
                   @click=${() => {

src/state/auth/KeycloakManager.ts

@@ -1,7 +1,8 @@
 import Keycloak from 'keycloak-js';
+import { CompasSettings } from '../../compas/CompasSettingsElement';
 
 const keycloakInstance = Keycloak({
-    url: 'http://localhost:8089/auth/',
+    url: CompasSettings().compasSettings.keycloakAuthUrl,
     realm: 'compas',
     clientId: 'openscd'
 });

src/translations/de.ts

@@ -370,6 +370,7 @@ export const de: Translations = {
       name: "CoMPAS Einstellungen",
       sclDataServiceUrl: "CoMPAS SCL Data Service URL",
       cimMappingServiceUrl: "CoMPAS CIM Mapping Service URL",
+      keycloakAuthUrl: "Keycloak Auth URL",
     }
   }
 };

src/translations/en.ts

@@ -367,6 +367,7 @@ export const en = {
       name: "CoMPAS Settings",
       sclDataServiceUrl: "CoMPAS SCL Data Service URL",
       cimMappingServiceUrl: "CoMPAS CIM Mapping Service URL",
+      keycloakAuthUrl: "Keycloak Auth URL",
     }
   }
 };

test/unit/compas/CompasSettingsElement.test.ts

@@ -23,28 +23,35 @@ describe('compas-settings', () => {
   it('stores settings to localStorage', () => {
     CompasSettings().setCompasSetting('sclDataServiceUrl', 'http://localhost:9090/compas-scl-data-service');
     CompasSettings().setCompasSetting('cimMappingServiceUrl', 'http://localhost:9091/compas-cim-mapping');
+    CompasSettings().setCompasSetting('keycloakAuthUrl', 'http://localhost:8089/auth/');
     expect(localStorage.getItem('sclDataServiceUrl')).to.equal('http://localhost:9090/compas-scl-data-service');
     expect(localStorage.getItem('cimMappingServiceUrl')).to.equal('http://localhost:9091/compas-cim-mapping');
+    expect(localStorage.getItem('keycloakAuthUrl')).to.equal('http://localhost:8089/auth/');
   });
 
   it('retrieves settings from localStorage', () => {
     localStorage.setItem('sclDataServiceUrl', 'http://localhost:9090/compas-scl-data-service');
     localStorage.setItem('cimMappingServiceUrl', 'http://localhost:9091/compas-cim-mapping');
+    localStorage.setItem('keycloakAuthUrl', 'http://localhost:8089/auth/');
     expect(CompasSettings().compasSettings).to.have.property('sclDataServiceUrl', 'http://localhost:9090/compas-scl-data-service');
     expect(CompasSettings().compasSettings).to.have.property('cimMappingServiceUrl', 'http://localhost:9091/compas-cim-mapping');
+    expect(CompasSettings().compasSettings).to.have.property('keycloakAuthUrl', 'http://localhost:8089/auth/');
   });
 
   it('saves chosen settings on save button click', async () => {
     await element.updateComplete;
 
     element.getSclDataServiceUrlField().value = 'http://localhost:9091/compas-scl-data-service';
     element.getCimMappingServiceUrlField().value = 'http://localhost:9092/compas-cim-mapping';
+    element.getKeycloakAuthUrlField().value = 'http://localhost:9089/auth/';
     await element.getSclDataServiceUrlField().updateComplete;
     await element.getCimMappingServiceUrlField().updateComplete;
+    await element.getKeycloakAuthUrlField().updateComplete;
 
     expect(element.save()).to.be.true;
     expect(element.compasSettings).to.have.property('sclDataServiceUrl', 'http://localhost:9091/compas-scl-data-service');
     expect(element.compasSettings).to.have.property('cimMappingServiceUrl', 'http://localhost:9092/compas-cim-mapping');
+    expect(element.compasSettings).to.have.property('keycloakAuthUrl', 'http://localhost:9089/auth/');
   });
 
   it('save will not be done when invalid value (Scl Data Service)', async () => {
@@ -65,10 +72,20 @@ describe('compas-settings', () => {
     expect(element).to.have.deep.property('compasSettings', defaults);
   });
 
+  it('save will not be done when invalid value (Keycloak Auth URL)', async () => {
+    await element.updateComplete;
+    element.getKeycloakAuthUrlField().value = '';
+    await element.getKeycloakAuthUrlField().updateComplete;
+
+    expect(element.save()).to.be.false;
+    expect(element).to.have.deep.property('compasSettings', defaults);
+  });
+
   it('resets settings to default on reset button click', async () => {
     await element.updateComplete;
     CompasSettings().setCompasSetting('sclDataServiceUrl', 'http://localhost:9091/compas-scl-data-service');
     CompasSettings().setCompasSetting('cimMappingServiceUrl', 'http://localhost:9092/compas-cim-mapping');
+    CompasSettings().setCompasSetting('keycloakAuthUrl', 'http://localhost:9089/auth/');
 
     expect(element).to.not.have.deep.property('compasSettings', defaults);
     expect(element.reset()).to.be.true;