Last modified by jklein on 2025/02/13 13:15
From version 8.2
edited by jklein
on 2025/01/28 15:20
Change comment: There is no comment for this version
To version 17.1
edited by jklein
on 2025/02/06 12:02
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -2,6 +2,10 @@
2 2  
3 3  In diesem Best Practice möchten wir Ihnen anhand der Entwicklung eines ACMP Connectors aufzeigen, wie Sie PowerShell-Microservices für Ihre eigenen Projekte entwickeln und nutzen können. Als Beispiel-Projekt wird zur Veranschaulichung ein Connector entwickelt, mit dem die aktuellen Informationen zur Internationalen Raumstation (ISS) aus der öffentlichen REST API [[https:~~/~~/wheretheiss.at>>url:https://wheretheiss.at/]] abgerufen und über die ACMP Public API als Asset im ACMP angelegt bzw. aktualisiert werden. Ziel ist es, die Positions- und Statusdaten der ISS regelmäßig zu synchronisieren und damit immer auf die aktuellen Informationen im System zugreifen zu können.
4 4  
5 +{{aagon.infobox}}
6 +Am Ende des Best Practice finden Sie das Verzeichnis ISSACMPConnector.zip mit allen Dateien dieses ACMP Connectors zum Herunterladen.
7 +{{/aagon.infobox}}
8 +
5 5  = Entwicklungsumgebung =
6 6  
7 7  Als Entwicklungsumgebung für die Umsetzung dieses Beispiel-Projekts benötigen Sie:
... ... @@ -17,7 +17,7 @@
17 17  
18 18  Wenn Sie Visual Studio Code mit der PowerShell-Erweiterung installiert haben, können Sie die AESB Shell in Visual Studio Code einrichten:
19 19  
20 -1. Legen Sie einen neuen Ordner mit dem Namen //ISS_ACMP_Connector// im Datei-Explorer an.
24 +1. Legen Sie einen neuen Ordner mit dem Namen //ISSACMPConnector// im Datei-Explorer an.
21 21  1. Klicken Sie mit einem Rechtsklick auf den neuen Ordner, um das Kontextmenü zu öffnen.
22 22  1. Wählen Sie im Kontextmenü den Eintrag //Mit Code öffnen //aus, damit direkt das richtige Verzeichnis geöffnet wird.
23 23  1. Erstellen Sie eine neue Datei mit der Endung **//.psm1 //**(z.B. Microservice.psm1). Bei dieser Datei handelt es sich um ein PowerShell-Modul, in dem nun die Businesslogik implementiert werden kann.{{aagon.infobox}}Das Erstellen dieser Datei ist notwendig, damit eine PowerShell-Session mit dem Terminal in Visual Studio Code geöffnet wird.{{/aagon.infobox}}
... ... @@ -42,6 +42,9 @@
42 42  
43 43  Als Ergebnis wird in Visual Studio Code im Terminal-Bereich nun direkt die AESB Shell geladen. So können Sie ab jetzt einfach und effektiv neue Module entwickeln, um diese später in den Microservices zu nutzen.
44 44  
49 +[[Geladene AESB Shell in Visual Studio Code>>image:Visual Studio Code_AESB Shell.png||alt="Geladene AESB Shell in Visual Studio Code"]]
50 +
51 +
45 45  = Aufgabenteilung =
46 46  
47 47  Das Ziel der Aufgabenteilung ist es, die Hauptaufgabe auf kleinere Services aufzuteilen und damit zu modularisieren. Jeder Service soll dabei nur eine spezifische Funktion übernehmen. Somit wird gewährleistet, dass die verschiedenen Services unabhängig voneinander laufen.
... ... @@ -103,7 +103,7 @@
103 103  1. Erstellen der PowerShell-Microservices in AESB
104 104  1. Integrieren der PowerShell-Module in die PowerShell-Microservices
105 105  
106 -=== Erstellen der PowerShell-Module ===
113 +== PowerShell-Module erstellen ==
107 107  
108 108  Zu Beginn werden die einzelnen PowerShell-Module entwickelt, welche die benötigte Logik für die Microservices enthalten. Für den ACMP Connector in diesem Beispiel werden folgende Module benötigt:
109 109  
... ... @@ -110,13 +110,14 @@
110 110  * ISSRestConnector - Modul zum Abfragen der ISS-Daten
111 111  * ISSAssetImporter - Modul zum Speichern des Assets und der zugehörigen Custom Fields
112 112  
113 -**ISSRestConnector**
120 +=== **ISSRestConnector** ===
114 114  
115 115  Das Modul zum Abfragen der ISS-Daten besteht aus einer einfachen Funktion, welche die REST API aufruft und das Ergebnis in ein PSCustomObject konvertiert.
116 116  
117 117  1. Klicken Sie mit einem Rechtsklick auf den Ordner //ISS_ACMP_Connector//, um das Kontextmenü zu öffnen.
118 118  1. Wählen Sie im Kontextmenü den Eintrag //Mit Code öffnen //aus, damit direkt das richtige Verzeichnis geöffnet wird.
119 -1. Erstellen Sie eine neue Datei mit dem Namen //ISSRestConnector.psm1//. Alternativ können Sie auch die anfangs erstellte, leere Datei //Microservice.psm1// umbenennen.
126 +1. Erstellen Sie einen neuen Unterordner mit dem Namen //Modules.//
127 +1. Erstellen Sie im Unterordner //Modules //eine neue Datei mit dem Namen //ISSRestConnector.psm1//. Alternativ können Sie auch die anfangs erstellte, leere Datei //Microservice.psm1// umbenennen und in den Ordner verschieben.
120 120  1. Fügen Sie den nachfolgenden Code in die Datei ein.
121 121  1. Drücken Sie Strg + S, um die Datei zu speichern.
122 122  
... ... @@ -162,11 +162,11 @@
162 162  }
163 163  {{/code}}
164 164  
165 -**ISSAssetImporter**
173 +=== **ISSAssetImporter** ===
166 166  
167 167  Das Modul zum Speichern des Assets und der zugehörigen Custom Fields erstellt das Asset für die ISS, falls es noch nicht vorhanden ist. Außerdem konvertiert es das PSCustomObject zurück in ein integrierbares Datenformat.
168 168  
169 -1. Erstellen Sie eine neue Datei mit dem Namen //ISSAssetImporter.psm1//.
177 +1. Erstellen Sie im Unterordner //Modules //eine neue Datei mit dem Namen //ISSAssetImporter.psm1//.
170 170  1. Fügen Sie den nachfolgenden Code in die Datei ein.
171 171  1. Drücken Sie Strg + S, um die Datei zu speichern.
172 172  
... ... @@ -277,14 +277,108 @@
277 277  }
278 278  {{/code}}
279 279  
280 -=== Testen der PowerShell-Module ===
288 +== PowerShell-Module testen ==
281 281  
282 -=== Erstellen der PowerShell-Microservices in AESB ===
290 +Die Funktionalität des erstellten Moduls können Sie mithilfe von Pester (dem Standard-Framework für Unit-Testing in PowerShell) oder eines dedizierten PowerShell Scripts verifizieren. So stellen Sie sicher, dass die Logik fehlerfrei und robust ist. In diesem Beispiel wird das Modul //ISSRestConnector.psm1// mit Pester 5.5.0 getestet.
283 283  
284 -=== Integrieren der PowerShell-Module in die PowerShell-Microservices ===
292 +{{aagon.infobox}}
293 +Beachten Sie, dass Sie Pester für diesen Test ggf. vorher installieren oder updaten müssen. Weitere Informationen dazu finden Sie in der __[[Dokumentation von Pester>>https://pester.dev/docs/introduction/installation||rel=" noopener noreferrer" target="_blank"]]__.
294 +{{/aagon.infobox}}
285 285  
296 +Sie können das PowerShell-Modul folgendermaßen testen:
286 286  
298 +1. Erstellen Sie im Unterordner //Modules //einen neuen Unterordner mit dem Namen //Tests.//
299 +1. Erstellen Sie im Unterordner //Tests// eine neue Datei mit dem Namen //ISSRestConnectorTests.ps1//.
300 +1. Fügen Sie den nachfolgenden Code in die Datei ein.
301 +1. Drücken Sie Strg + S, um die Datei zu speichern.
302 +1. Führen Sie das Script aus
287 287  
304 +{{code language="PowerShell" layout="LINENUMBERS" title="**ISSRestConnectorTest.ps1**"}}
305 +Import-Module -Name Pester -MinimumVersion 5.5.0
306 +Remove-Module ".\Modules\ISSRestConnector.psm1" -Force -ErrorAction SilentlyContinue
307 +Import-Module -Name ".\Modules\ISSRestConnector.psm1" -Force
308 +
309 +Describe "Get-ISSData Function Tests" {
310 + BeforeAll {
311 + # Mock the API response
312 + $global:MockApiResponse = @{
313 + Name = "iss"
314 + Id = 25544
315 + Latitude = 12.34
316 + Longitude = 56.78
317 + Altitude = 408.5
318 + Velocity = 27600
319 + Visibility = "daylight"
320 + Timestamp = [datetime]::Now.ToUniversalTime().Subtract([datetime]::UnixEpoch).TotalSeconds
321 + }
322 + }
323 +
324 + Context "When the API responds successfully" {
325 + BeforeEach {
326 + # Mock the API call
327 + Mock -CommandName Invoke-RestMethod -ParameterFilter { $Method -eq 'GET' } -MockWith {
328 + return $global:MockApiResponse
329 + } -ModuleName "ISSRestConnector"
330 + }
331 +
332 + It "Should return a PSCustomObject with expected properties" {
333 + $result = Get-ISSData
334 + $result | Should -BeOfType PSCustomObject
335 + $result.Name | Should -Not -BeNullOrEmpty
336 + $result.Latitude | Should -Not -BeNullOrEmpty
337 + $result.Longitude | Should -Not -BeNullOrEmpty
338 + $result.Altitude | Should -Not -BeNullOrEmpty
339 + $result.Velocity | Should -Not -BeNullOrEmpty
340 + }
341 +
342 + It "Should correctly map the API response to the output object" {
343 + $result = Get-ISSData
344 + $result.Name | Should -Be "iss"
345 + $result.Latitude | Should -Be "12,34"
346 + $result.Longitude | Should -Be "56,78"
347 + $result.Altitude | Should -Be "408,5"
348 + $result.Velocity | Should -Be "27600"
349 + }
350 + }
351 +
352 + Context "When the API fails" {
353 +
354 + It "Should log an error when the API fails" {
355 + # Mock a failure in the API call
356 + Mock -CommandName Invoke-RestMethod -ParameterFilter { $Method -eq 'GET' } -MockWith {
357 + throw "API error"
358 + } -ModuleName "ISSRestConnector"
359 +
360 + $error.Clear() # Clear any pre-existing errors
361 + Get-ISSData
362 + $error[1].Exception.Message | Should -Contain "API error"
363 + }
364 + }
365 +}
366 +{{/code}}
367 +
368 +(% class="wikigeneratedid" %)
369 +Da in diesem Test kein Abruf der tatsächlichen API stattfindet, sondern die API-Daten simuliert werden, wird Ihnen als Ergebnis der beabsichtigte Error //Failed to fetch ISS data: API error //angezeigt. Darüber hinaus sollten die drei Tests erfolgreich gewesen sein.
370 +
371 +(% class="wikigeneratedid" %)
372 +[[image:Output_Pester Testing.png||alt="Ergebnis des Modul-Tests mit Pester" data-xwiki-image-style-alignment="center"]]
373 +
374 +== PowerShell-Microservices in AESB erstellen ==
375 +
376 +Da die benötigten PowerShell-Module nun erstellt und getestet sind, kann mit der Erstellung der Microservices begonnen werden.
377 +
378 +1. Öffnen Sie die AESB Console und navigieren Sie zum Workspace //Creator - PowerShell//.
379 +1. Klicken Sie in der Ribbonleiste im Bereich //Ordner //auf den Button //Hinzufügen// und erstellen Sie den Ordner// ISS ACMP Connector.//
380 +1. Wählen Sie den Ordner aus und klicken Sie in der Ribbonleiste im Bereich //PowerShell-Vorlagen //auf den Button //Hinzufügen.//
381 +1. Erstellen Sie eine Vorlage// ISSRestConnector. //Klicken Sie in der Ribbonleiste auf den Button //Speichern.//
382 +1. Wiederholen Sie Schritt 3 und Schritt 4 für die Erstellung der Vorlage //ISSAssetImporter//.
383 +
384 +== PowerShell-Module in die PowerShell-Microservices integrieren ==
385 +
386 +{{aagon.warnungsbox}}
387 +In diesem Beispiel werden nur die
388 +{{/aagon.warnungsbox}}
389 +
288 288  = Fehlerbehandlung =
289 289  
290 290  = Orchestrierung =
1738156789994-903.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.jklein
Size
... ... @@ -1,0 +1,1 @@
1 +33.7 KB
Content
Output_Pester Testing.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.jklein
Size
... ... @@ -1,0 +1,1 @@
1 +28.5 KB
Content
Visual Studio Code_AESB Shell.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.jklein
Size
... ... @@ -1,0 +1,1 @@
1 +21.5 KB
Content
© Aagon GmbH 2025
Besuchen Sie unsere neue Aagon-Community