Changes for page Entwicklung eines ACMP Connectors für die ISS

Last modified by jklein on 2025/02/13 13:15

From 7.1 to 8.1 From 12.1 to 13.1

From version 8.1

edited by jklein
on 2025/01/28 13:19

Change comment: There is no comment for this version

To version 12.1

edited by jklein
on 2025/01/29 13:24

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Attachments (0 modified, 2 added, 0 removed)
- 1738156789994-903.png
- Output_Pester Testing.png

Details

Page properties

Content

@@ -2,6 +2,10 @@
  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.
++{{aagon.infobox}}
++Am Ende des Best Practice finden Sie das Verzeichnis ISSACMPConnector.zip mit allen Dateien dieses ACMP Connectors zum Herunterladen.
++{{/aagon.infobox}}
++
  = Entwicklungsumgebung =
  Als Entwicklungsumgebung für die Umsetzung dieses Beispiel-Projekts benötigen Sie:
@@ -17,7 +17,7 @@
  Wenn Sie Visual Studio Code mit der PowerShell-Erweiterung installiert haben, können Sie die AESB Shell in Visual Studio Code einrichten:
--1. Legen Sie einen neuen Ordner im Datei-Explorer an.
++1. Legen Sie einen neuen Ordner mit dem Namen //ISSACMPConnector// im Datei-Explorer an.
 . Klicken Sie mit einem Rechtsklick auf den neuen Ordner, um das Kontextmenü zu öffnen.
 . Wählen Sie im Kontextmenü den Eintrag //Mit Code öffnen //aus, damit direkt das richtige Verzeichnis geöffnet wird.
 . 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}}
@@ -48,7 +48,7 @@
  Die Hauptaufgabe des ACMP Connector für die ISS ist es, die aktuellen Informationen zur Internationalen Raumstation (ISS) aus der öffentlichen REST API [[https:~~/~~/wheretheiss.at>>url:https://wheretheiss.at/]] abzurufen und über die ACMP Public API als Asset in dem ACMP anzulegen bzw. zu aktualisieren. Anhand dieser kurzen Projektdefinition lässt sich in diesem Beispiel erkennen, dass es zwei Teilaufgaben gibt: Erstens das Abrufen der Daten von der REST API und zweitens die Integration der bereitgestellten Daten in ACMP. Für jede Teilaufgabe wird ein eigener Service bzw. Microservice definiert:
--1. **Microservice 1: Datenabruf von der REST API**
++1. **Microservice 1: Datenabruf von der REST API **
  Der erste Service ruft die ISS-Daten (z.B. Position, Höhe, Geschwindigkeit) von der API ab und sendet diese an den zweiten Microservice.
 . **Microservice 2: Integration in ACMP**
  Der zweite Service liest die vom ersten Service bereitgestellten Daten und überträgt sie mithilfe der Public API an den ACMP. Dabei wird entweder ein neues Asset für die ISS erstellt oder ein bestehendes Asset aktualisiert.
@@ -96,8 +96,287 @@
  = Entwicklung der Microservices =
++Die Entwicklung der PowerShell-Microservices stellt den umfangreichsten Teil bei der Entwicklung dieses ACMP Connectors dar. Für die Entwicklung wird die eingangs beschriebene [[Entwicklungsumgebung >>doc:||anchor="HEntwicklungsumgebung"]]benötigt. Zur Sicherstellung eine sauberen, modularen und effizienten Umsetzung, wird für die Entwicklung von PowerShell-Microservices folgende Vorgehensweise empfohlen:
++1. Erstellen der PowerShell-Module
++1. Testen der PowerShell-Module
++1. Erstellen der PowerShell-Microservices in AESB
++1. Integrieren der PowerShell-Module in die PowerShell-Microservices
++=== Erstellen der PowerShell-Module ===
++
++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:
++
++* ISSRestConnector - Modul zum Abfragen der ISS-Daten
++* ISSAssetImporter - Modul zum Speichern des Assets und der zugehörigen Custom Fields
++
++**ISSRestConnector**
++
++Das Modul zum Abfragen der ISS-Daten besteht aus einer einfachen Funktion, welche die REST API aufruft und das Ergebnis in ein PSCustomObject konvertiert.
++
++1. Klicken Sie mit einem Rechtsklick auf den Ordner //ISS_ACMP_Connector//, um das Kontextmenü zu öffnen.
++1. Wählen Sie im Kontextmenü den Eintrag //Mit Code öffnen //aus, damit direkt das richtige Verzeichnis geöffnet wird.
++1. Erstellen Sie einen neuen Unterordner mit dem Namen //Modules.//
++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.
++1. Fügen Sie den nachfolgenden Code in die Datei ein.
++1. Drücken Sie Strg + S, um die Datei zu speichern.
++
++{{code language="PowerShell" layout="LINENUMBERS" title="**ISSRestConnector.psm1**"}}
++function Get-ISSData {
++    <#
++    .SYNOPSIS
++    Queries the "Where the ISS at?" API to retrieve satellite data.
++
++    .DESCRIPTION
++    This function fetches the data for the International Space Station (ISS) from the REST API endpoint
++    https://api.wheretheiss.at/v1/satellites/25544 and returns the parsed response.
++
++    .OUTPUTS
++    [PSCustomObject] - A custom object containing the ISS data.
++
++    .EXAMPLE
++    Get-ISSData
++    # Retrieves the current data for the ISS.
++    #>
++
++    param (
++        [string]$ApiUrl = "https://api.wheretheiss.at/v1/satellites/25544"
++    )
++
++    try {
++        # Perform the API request
++        $response = Invoke-RestMethod -Uri $ApiUrl -Method Get
++
++        # Convert the response into a PowerShell object
++        $result = [PSCustomObject]@{
++            Name          = $response.name
++            Latitude      = $response.latitude.ToString()
++            Longitude     = $response.longitude.ToString()
++            Altitude      = $response.altitude.ToString()
++            Velocity      = $response.velocity.ToString()
++        }
++
++        return $result
++    } catch {
++        Write-Error "Failed to fetch ISS data: $_"
++    }
++}
++{{/code}}
++
++**ISSAssetImporter**
++
++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.
++
++1. Erstellen Sie im Unterordner //Modules //eine neue Datei mit dem Namen //ISSAssetImporter.psm1//.
++1. Fügen Sie den nachfolgenden Code in die Datei ein.
++1. Drücken Sie Strg + S, um die Datei zu speichern.
++
++{{code language="PowerShell" layout="LINENUMBERS" title="**ISSAssetImporter.psm1**"}}
++function Get-AssetTypeId {
++    param (
++        [string] $AssetTypeName
++    )
++    $assetTypesResult = Acmp-GetAssetTypeList_V1
++    if ($assetTypesResult.ResultCode -ne 0) {
++        Throw "Error while fetching asset types: $($assetTypesResult.ResultMessage)"
++    }
++    $assetType = $assetTypesResult.AssetTypes | Where-Object { $_.Name -eq $assetTypeName }
++    $id = [guid]::Parse($assetType.Id).ToString()
++    Write-Output $id
++}
++
++function New-ISSAsset {
++    param (
++        [PSCustomObject] $Data,
++        [string] $AssetTypeId,
++        [string] $AssetTypeName,
++        [string] $AssetStateId
++    )
++    $newAsset = New-TAsset_V4
++    $newAsset.Id = [guid]::NewGuid().ToString()
++    $newAsset.Name = $Data.Name
++    $newAsset.AssetType = $AssetTypeName
++    $newAsset.AssetTypeId = $AssetTypeId
++    $newAsset.AssetStateId = $AssetStateId
++
++    Write-Output $newAsset
++}
++
++function Get-ISSAsset {
++    param(
++        [string] $AssetTypeId,
++        [string] $AssetTypeName,
++        [string] $AssetStateId,
++        $ISS
++    )
++    $assetListResult = Acmp-GetAssetList_V3 -AssetTypeId $AssetTypeId -FilterText "iss"
++    if ($assetListResult.ResultCode -ne 0) {
++        Throw "Error while fetching the asset: $($assetListResult.ResultMessage)"
++    }
++    $assetInfo = $assetListResult.Assets | Where-Object { $_.Name -eq $ISS.Name }
++    if ($null -eq $assetInfo) {
++        $asset = New-ISSAsset -Data $ISS -AssetTypeName $AssetTypeName -AssetTypeId $AssetTypeId -AssetStateId $AssetStateId
++    }
++    else {
++        $assetResult = Acmp-GetAsset_V4 -Id $assetInfo.Id
++        if ($assetResult.ResultCode -ne 0) {
++            Throw "Error while fetching the asset: $($assetResult.ResultMessage)"
++        }
++        $asset = $assetResult.Asset
++    }
++    Write-Output $asset
++}
++
++function New-CustomField {
++    param (
++        [string] $Id,
++        [string] $Value
++    )
++    $customfield = New-TCustomFieldValue_V1
++    $customfield.FieldId = $Id
++    $customfield.Value = $Value
++
++    Write-Output $customfield
++}
++
++function Save-CustomFieldList {
++    param (
++        $AssetId,
++        $CustomFieldList
++    )
++    $customFieldResult = Acmp-SaveSingleCustomFieldValues_V1 -QueryBase AssetManagement -ObjectId $AssetId -FieldValues $CustomFieldList
++    if ($customFieldResult.ResultCode -ne 0) {
++        Throw "Error while fetching the asset: $($customFieldResult.ResultMessage)"
++    }
++    Write-Host "Success!"
++}
++
++function ConvertTo-AssetV1 {
++    param (
++        [PSCustomObject] $AssetV4
++    )
++    $assetv1 = New-TAsset_V1
++    $assetv1.Id = $AssetV4.Id
++    $assetv1.Name = $AssetV4.Name
++    $assetv1.AssetType = $AssetV4.AssetType
++    $assetv1.AssetTypeId = $AssetV4.AssetTypeId
++    $assetv1.AssetStateId = $AssetV4.AssetStateId
++
++    Write-Output $assetv1
++}
++
++function Save-ISSAsset {
++    param(
++        [PSCustomObject] $ISSAsset
++    )
++    $convertedAsset = ConvertTo-AssetV1 -AssetV4 $ISSAsset
++    $saveAssetResult = Acmp-SaveAssets_V1 -Assets $convertedAsset
++    if ($saveAssetResult.ResultCode -ne 0) {
++        Throw "Error while saving the asset: $($saveAssetResult.ResultMessage)"
++    }
++    Write-Host "Success!"
++}
++{{/code}}
++
++=== Testen der PowerShell-Module ===
++
++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.
++
++{{aagon.infobox}}
++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]]__.
++{{/aagon.infobox}}
++
++Sie können das PowerShell-Modul folgendermaßen testen:
++
++1. Erstellen Sie im Unterordner //Modules //einen neuen Unterordner mit dem Namen //Tests.//
++1. Erstellen Sie im Unterordner //Tests// eine neue Datei mit dem Namen //ISSRestConnectorTests.ps1//.
++1. Fügen Sie den nachfolgenden Code in die Datei ein.
++1. Drücken Sie Strg + S, um die Datei zu speichern.
++1. Führen Sie das Script aus
++
++{{code language="PowerShell" layout="LINENUMBERS" title="**ISSRestConnectorTest.ps1**"}}
++Import-Module -Name Pester -MinimumVersion 5.5.0
++Remove-Module ".\Modules\ISSRestConnector.psm1" -Force -ErrorAction SilentlyContinue
++Import-Module -Name ".\Modules\ISSRestConnector.psm1" -Force
++
++Describe "Get-ISSData Function Tests" {
++    BeforeAll {
++        # Mock the API response
++        $global:MockApiResponse = @{
++            Name       = "iss"
++            Id         = 25544
++            Latitude   = 12.34
++            Longitude  = 56.78
++            Altitude   = 408.5
++            Velocity   = 27600
++            Visibility = "daylight"
++            Timestamp  = [datetime]::Now.ToUniversalTime().Subtract([datetime]::UnixEpoch).TotalSeconds
++        }
++    }
++
++    Context "When the API responds successfully" {
++        BeforeEach {
++            # Mock the API call
++            Mock -CommandName Invoke-RestMethod -ParameterFilter { $Method -eq 'GET' } -MockWith {
++                return $global:MockApiResponse
++            } -ModuleName "ISSRestConnector"
++        }
++
++        It "Should return a PSCustomObject with expected properties" {
++            $result = Get-ISSData
++            $result | Should -BeOfType PSCustomObject
++            $result.Name | Should -Not -BeNullOrEmpty
++            $result.Latitude | Should -Not -BeNullOrEmpty
++            $result.Longitude | Should -Not -BeNullOrEmpty
++            $result.Altitude | Should -Not -BeNullOrEmpty
++            $result.Velocity | Should -Not -BeNullOrEmpty
++        }
++
++        It "Should correctly map the API response to the output object" {
++            $result = Get-ISSData
++            $result.Name | Should -Be "iss"
++            $result.Latitude | Should -Be "12,34"
++            $result.Longitude | Should -Be "56,78"
++            $result.Altitude | Should -Be "408,5"
++            $result.Velocity | Should -Be "27600"
++        }
++    }
++
++    Context "When the API fails" {
++
++        It "Should log an error when the API fails" {
++            # Mock a failure in the API call
++            Mock -CommandName Invoke-RestMethod -ParameterFilter { $Method -eq 'GET' } -MockWith {
++                throw "API error"
++            } -ModuleName "ISSRestConnector"
++
++            $error.Clear() # Clear any pre-existing errors
++            Get-ISSData
++            $error[1].Exception.Message | Should -Contain "API error"
++        }
++    }
++}
++{{/code}}
++
++(% class="wikigeneratedid" %)
++Als Ergebnis sollten Ihnen der beabsichtigte Error //Failed to fetch ISS data: API error //angezeigt werden und die drei Tests sollten erfolgreich gewesen sein.
++
++(% class="wikigeneratedid" %)
++[[image:Output_Pester Testing.png||alt="Ergebnis des Modul-Tests mit Pester" data-xwiki-image-style-alignment="center"]]
++
++=== Erstellen der PowerShell-Microservices in AESB ===
++
++
++Da die benötigten PowerShell-Module nun erstellt und getestet sind, kann mit der Erstellung der Microservices begonnen werden.
++
++1. Öffnen Sie die AESB Console und navigieren Sie zum Workspace //Creator - PowerShell//.
++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.//
++1.
++
++=== Integrieren der PowerShell-Module in die PowerShell-Microservices ===
++
++
++
  = Fehlerbehandlung =
  = 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