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 13.1
edited by jklein
on 2025/01/30 10:14
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}}
... ... @@ -116,7 +116,8 @@
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.
123 +1. Erstellen Sie einen neuen Unterordner mit dem Namen //Modules.//
124 +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  
... ... @@ -166,7 +166,7 @@
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//.
174 +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  
... ... @@ -279,8 +279,99 @@
279 279  
280 280  === Testen der PowerShell-Module ===
281 281  
287 +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.
288 +
289 +{{aagon.infobox}}
290 +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]]__.
291 +{{/aagon.infobox}}
292 +
293 +Sie können das PowerShell-Modul folgendermaßen testen:
294 +
295 +1. Erstellen Sie im Unterordner //Modules //einen neuen Unterordner mit dem Namen //Tests.//
296 +1. Erstellen Sie im Unterordner //Tests// eine neue Datei mit dem Namen //ISSRestConnectorTests.ps1//.
297 +1. Fügen Sie den nachfolgenden Code in die Datei ein.
298 +1. Drücken Sie Strg + S, um die Datei zu speichern.
299 +1. Führen Sie das Script aus
300 +
301 +{{code language="PowerShell" layout="LINENUMBERS" title="**ISSRestConnectorTest.ps1**"}}
302 +Import-Module -Name Pester -MinimumVersion 5.5.0
303 +Remove-Module ".\Modules\ISSRestConnector.psm1" -Force -ErrorAction SilentlyContinue
304 +Import-Module -Name ".\Modules\ISSRestConnector.psm1" -Force
305 +
306 +Describe "Get-ISSData Function Tests" {
307 + BeforeAll {
308 + # Mock the API response
309 + $global:MockApiResponse = @{
310 + Name = "iss"
311 + Id = 25544
312 + Latitude = 12.34
313 + Longitude = 56.78
314 + Altitude = 408.5
315 + Velocity = 27600
316 + Visibility = "daylight"
317 + Timestamp = [datetime]::Now.ToUniversalTime().Subtract([datetime]::UnixEpoch).TotalSeconds
318 + }
319 + }
320 +
321 + Context "When the API responds successfully" {
322 + BeforeEach {
323 + # Mock the API call
324 + Mock -CommandName Invoke-RestMethod -ParameterFilter { $Method -eq 'GET' } -MockWith {
325 + return $global:MockApiResponse
326 + } -ModuleName "ISSRestConnector"
327 + }
328 +
329 + It "Should return a PSCustomObject with expected properties" {
330 + $result = Get-ISSData
331 + $result | Should -BeOfType PSCustomObject
332 + $result.Name | Should -Not -BeNullOrEmpty
333 + $result.Latitude | Should -Not -BeNullOrEmpty
334 + $result.Longitude | Should -Not -BeNullOrEmpty
335 + $result.Altitude | Should -Not -BeNullOrEmpty
336 + $result.Velocity | Should -Not -BeNullOrEmpty
337 + }
338 +
339 + It "Should correctly map the API response to the output object" {
340 + $result = Get-ISSData
341 + $result.Name | Should -Be "iss"
342 + $result.Latitude | Should -Be "12,34"
343 + $result.Longitude | Should -Be "56,78"
344 + $result.Altitude | Should -Be "408,5"
345 + $result.Velocity | Should -Be "27600"
346 + }
347 + }
348 +
349 + Context "When the API fails" {
350 +
351 + It "Should log an error when the API fails" {
352 + # Mock a failure in the API call
353 + Mock -CommandName Invoke-RestMethod -ParameterFilter { $Method -eq 'GET' } -MockWith {
354 + throw "API error"
355 + } -ModuleName "ISSRestConnector"
356 +
357 + $error.Clear() # Clear any pre-existing errors
358 + Get-ISSData
359 + $error[1].Exception.Message | Should -Contain "API error"
360 + }
361 + }
362 +}
363 +{{/code}}
364 +
365 +(% class="wikigeneratedid" %)
366 +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.
367 +
368 +(% class="wikigeneratedid" %)
369 +[[image:Output_Pester Testing.png||alt="Ergebnis des Modul-Tests mit Pester" data-xwiki-image-style-alignment="center"]]
370 +
282 282  === Erstellen der PowerShell-Microservices in AESB ===
283 283  
373 +
374 +Da die benötigten PowerShell-Module nun erstellt und getestet sind, kann mit der Erstellung der Microservices begonnen werden.
375 +
376 +1. Öffnen Sie die AESB Console und navigieren Sie zum Workspace //Creator - PowerShell//.
377 +1. Klicken Sie in der Ribbonleiste im Bereich //Ordner //auf den Button //Hinzufügen// und Erstellen Sie einen Ordner mit dem Namen// ISS_ACMP_Connector.//
378 +1.
379 +
284 284  === Integrieren der PowerShell-Module in die PowerShell-Microservices ===
285 285  
286 286  
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
© Aagon GmbH 2025
Besuchen Sie unsere neue Aagon-Community