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

Summary

• Page properties (1 modified, 0 added, 0 removed)
• Attachments (0 modified, 3 added, 0 removed)
  • 1738156789994-903.png
  • Output_Pester Testing.png
  • Visual Studio Code_AESB Shell.png

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 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.
...	...	@@ -48,7 +48,7 @@
48	48
49	49	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:
50	50
51		-1. **Microservice 1: Datenabruf von der REST API**
	58	+1. **Microservice 1: Datenabruf von der REST API **
52	52	Der erste Service ruft die ISS-Daten (z.B. Position, Höhe, Geschwindigkeit) von der API ab und sendet diese an den zweiten Microservice.
53	53	1. **Microservice 2: Integration in ACMP**
54	54	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,290 @@
96	96
97	97	= Entwicklung der Microservices =
98	98
	106	+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:
99	99
	108	+1. Erstellen der PowerShell-Module
	109	+1. Testen der PowerShell-Module
	110	+1. Erstellen der PowerShell-Microservices in AESB
	111	+1. Integrieren der PowerShell-Module in die PowerShell-Microservices
100	100
	113	+== PowerShell-Module erstellen ==
	114	+
	115	+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:
	116	+
	117	+* ISSRestConnector - Modul zum Abfragen der ISS-Daten
	118	+* ISSAssetImporter - Modul zum Speichern des Assets und der zugehörigen Custom Fields
	119	+
	120	+=== **ISSRestConnector** ===
	121	+
	122	+Das Modul zum Abfragen der ISS-Daten besteht aus einer einfachen Funktion, welche die REST API aufruft und das Ergebnis in ein PSCustomObject konvertiert.
	123	+
	124	+1. Klicken Sie mit einem Rechtsklick auf den Ordner //ISS_ACMP_Connector//, um das Kontextmenü zu öffnen.
	125	+1. Wählen Sie im Kontextmenü den Eintrag //Mit Code öffnen //aus, damit direkt das richtige Verzeichnis geöffnet wird.
	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.
	128	+1. Fügen Sie den nachfolgenden Code in die Datei ein.
	129	+1. Drücken Sie Strg + S, um die Datei zu speichern.
	130	+
	131	+{{code language="PowerShell" layout="LINENUMBERS" title="**ISSRestConnector.psm1**"}}
	132	+function Get-ISSData {
	133	+ <#
	134	+ .SYNOPSIS
	135	+ Queries the "Where the ISS at?" API to retrieve satellite data.
	136	+
	137	+ .DESCRIPTION
	138	+ This function fetches the data for the International Space Station (ISS) from the REST API endpoint
	139	+ https://api.wheretheiss.at/v1/satellites/25544 and returns the parsed response.
	140	+
	141	+ .OUTPUTS
	142	+ [PSCustomObject] - A custom object containing the ISS data.
	143	+
	144	+ .EXAMPLE
	145	+ Get-ISSData
	146	+ # Retrieves the current data for the ISS.
	147	+ #>
	148	+
	149	+ param (
	150	+ [string]$ApiUrl = "https://api.wheretheiss.at/v1/satellites/25544"
	151	+ )
	152	+
	153	+ try {
	154	+ # Perform the API request
	155	+ $response = Invoke-RestMethod -Uri $ApiUrl -Method Get
	156	+
	157	+ # Convert the response into a PowerShell object
	158	+ $result = [PSCustomObject]@{
	159	+ Name = $response.name
	160	+ Latitude = $response.latitude.ToString()
	161	+ Longitude = $response.longitude.ToString()
	162	+ Altitude = $response.altitude.ToString()
	163	+ Velocity = $response.velocity.ToString()
	164	+ }
	165	+
	166	+ return $result
	167	+ } catch {
	168	+ Write-Error "Failed to fetch ISS data: $_"
	169	+ }
	170	+}
	171	+{{/code}}
	172	+
	173	+=== **ISSAssetImporter** ===
	174	+
	175	+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.
	176	+
	177	+1. Erstellen Sie im Unterordner //Modules //eine neue Datei mit dem Namen //ISSAssetImporter.psm1//.
	178	+1. Fügen Sie den nachfolgenden Code in die Datei ein.
	179	+1. Drücken Sie Strg + S, um die Datei zu speichern.
	180	+
	181	+{{code language="PowerShell" layout="LINENUMBERS" title="**ISSAssetImporter.psm1**"}}
	182	+function Get-AssetTypeId {
	183	+ param (
	184	+ [string] $AssetTypeName
	185	+ )
	186	+ $assetTypesResult = Acmp-GetAssetTypeList_V1
	187	+ if ($assetTypesResult.ResultCode -ne 0) {
	188	+ Throw "Error while fetching asset types: $($assetTypesResult.ResultMessage)"
	189	+ }
	190	+ $assetType = $assetTypesResult.AssetTypes | Where-Object { $_.Name -eq $assetTypeName }
	191	+ $id = [guid]::Parse($assetType.Id).ToString()
	192	+ Write-Output $id
	193	+}
	194	+
	195	+function New-ISSAsset {
	196	+ param (
	197	+ [PSCustomObject] $Data,
	198	+ [string] $AssetTypeId,
	199	+ [string] $AssetTypeName,
	200	+ [string] $AssetStateId
	201	+ )
	202	+ $newAsset = New-TAsset_V4
	203	+ $newAsset.Id = [guid]::NewGuid().ToString()
	204	+ $newAsset.Name = $Data.Name
	205	+ $newAsset.AssetType = $AssetTypeName
	206	+ $newAsset.AssetTypeId = $AssetTypeId
	207	+ $newAsset.AssetStateId = $AssetStateId
	208	+
	209	+ Write-Output $newAsset
	210	+}
	211	+
	212	+function Get-ISSAsset {
	213	+ param(
	214	+ [string] $AssetTypeId,
	215	+ [string] $AssetTypeName,
	216	+ [string] $AssetStateId,
	217	+ $ISS
	218	+ )
	219	+ $assetListResult = Acmp-GetAssetList_V3 -AssetTypeId $AssetTypeId -FilterText "iss"
	220	+ if ($assetListResult.ResultCode -ne 0) {
	221	+ Throw "Error while fetching the asset: $($assetListResult.ResultMessage)"
	222	+ }
	223	+ $assetInfo = $assetListResult.Assets | Where-Object { $_.Name -eq $ISS.Name }
	224	+ if ($null -eq $assetInfo) {
	225	+ $asset = New-ISSAsset -Data $ISS -AssetTypeName $AssetTypeName -AssetTypeId $AssetTypeId -AssetStateId $AssetStateId
	226	+ }
	227	+ else {
	228	+ $assetResult = Acmp-GetAsset_V4 -Id $assetInfo.Id
	229	+ if ($assetResult.ResultCode -ne 0) {
	230	+ Throw "Error while fetching the asset: $($assetResult.ResultMessage)"
	231	+ }
	232	+ $asset = $assetResult.Asset
	233	+ }
	234	+ Write-Output $asset
	235	+}
	236	+
	237	+function New-CustomField {
	238	+ param (
	239	+ [string] $Id,
	240	+ [string] $Value
	241	+ )
	242	+ $customfield = New-TCustomFieldValue_V1
	243	+ $customfield.FieldId = $Id
	244	+ $customfield.Value = $Value
	245	+
	246	+ Write-Output $customfield
	247	+}
	248	+
	249	+function Save-CustomFieldList {
	250	+ param (
	251	+ $AssetId,
	252	+ $CustomFieldList
	253	+ )
	254	+ $customFieldResult = Acmp-SaveSingleCustomFieldValues_V1 -QueryBase AssetManagement -ObjectId $AssetId -FieldValues $CustomFieldList
	255	+ if ($customFieldResult.ResultCode -ne 0) {
	256	+ Throw "Error while fetching the asset: $($customFieldResult.ResultMessage)"
	257	+ }
	258	+ Write-Host "Success!"
	259	+}
	260	+
	261	+function ConvertTo-AssetV1 {
	262	+ param (
	263	+ [PSCustomObject] $AssetV4
	264	+ )
	265	+ $assetv1 = New-TAsset_V1
	266	+ $assetv1.Id = $AssetV4.Id
	267	+ $assetv1.Name = $AssetV4.Name
	268	+ $assetv1.AssetType = $AssetV4.AssetType
	269	+ $assetv1.AssetTypeId = $AssetV4.AssetTypeId
	270	+ $assetv1.AssetStateId = $AssetV4.AssetStateId
	271	+
	272	+ Write-Output $assetv1
	273	+}
	274	+
	275	+function Save-ISSAsset {
	276	+ param(
	277	+ [PSCustomObject] $ISSAsset
	278	+ )
	279	+ $convertedAsset = ConvertTo-AssetV1 -AssetV4 $ISSAsset
	280	+ $saveAssetResult = Acmp-SaveAssets_V1 -Assets $convertedAsset
	281	+ if ($saveAssetResult.ResultCode -ne 0) {
	282	+ Throw "Error while saving the asset: $($saveAssetResult.ResultMessage)"
	283	+ }
	284	+ Write-Host "Success!"
	285	+}
	286	+{{/code}}
	287	+
	288	+== PowerShell-Module testen ==
	289	+
	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.
	291	+
	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}}
	295	+
	296	+Sie können das PowerShell-Modul folgendermaßen testen:
	297	+
	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
	303	+
	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 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 die 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 integrieren ==
	385	+
	386	+{{aagon.warnungsbox}}
	387	+In diesem Beispiel werden nur die
	388	+{{/aagon.warnungsbox}}
	389	+
101	101	= Fehlerbehandlung =
102	102
103	103	= 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