Enhance Playwright Test For /Submodels and /submodel-descriptors Pagination

source/AAS.TwinEngine.DataEngine.ModuleTests/Api/Services/AasRepository/AasRepositoryControllerTests.cs

@@ -11,7 +11,6 @@
 using AAS.TwinEngine.DataEngine.ApplicationLogic.Services.Shared.Providers;
 using AAS.TwinEngine.DataEngine.DomainModel.Shared;
 using AAS.TwinEngine.DataEngine.ApplicationLogic.Services.SubmodelRepository;
-using AAS.TwinEngine.DataEngine.DomainModel.Shared;
 using AAS.TwinEngine.DataEngine.DomainModel.SubmodelRepository;
 using AAS.TwinEngine.DataEngine.Infrastructure.Http.Clients;
 using AAS.TwinEngine.DataEngine.ModuleTests.Common;

source/AAS.TwinEngine.Plugin.TestPlugin.PlaywrightTests/AAS.TwinEngine.Plugin.TestPlugin.PlaywrightTests.csproj

@@ -102,6 +102,9 @@
     <None Update="SubmodelRegistry\TestData\GetSubmodelDescriptorById_CustomSubmodel_Expected.json">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>
+    <None Update="SubmodelRegistry\TestData\GetAllSubmodelDescriptors_WithTwoFieldCursor_Expected.json">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
     <None Update="SubmodelRepository\TestData\GetSubmodelElement_ContactInfo_ContactInformation_Expected.json">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>
@@ -141,6 +144,9 @@
     <None Update="SubmodelRepository\TestData\GetAllSubmodelElements_ContactInfo_With_Cursor_Expected.json">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>
+    <None Update="SubmodelRepository\TestData\GetAllSubmodels_WithTwoFieldCursor_Expected.json">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
     <None Update="Discovery\TestData\GetSpecificAssetIdByAasIdentifier_Expected.json">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>

source/AAS.TwinEngine.Plugin.TestPlugin.PlaywrightTests/AasRegistry/AasRegistryTests.cs

@@ -65,6 +65,47 @@ public async Task GetAllShellDescriptors_WithPagination()
         Assert.Equal(countLimit2 + 1, countLimit3);
     }
 
+    [Fact]
+    public async Task GetAllShellDescriptors_WithLimitAndCursor()
+    {
+        // Arrange
+        var urlLimit2 = "/shell-descriptors?limit=2";
+
+        // Act
+        var responseLimit2 = await ApiContext.GetAsync(urlLimit2);
+
+        // Assert
+        AssertSuccessResponse(responseLimit2);
+
+        var contentLimit2 = await responseLimit2.TextAsync();
+        Assert.False(string.IsNullOrEmpty(contentLimit2));
+
+        var jsonLimit2 = JsonDocument.Parse(contentLimit2);
+        var resultLimit2 = jsonLimit2.RootElement.GetProperty("result");
+        Assert.Equal(2, resultLimit2.GetArrayLength());
+
+        var cursor = jsonLimit2.RootElement.GetProperty("paging_metadata").GetProperty("cursor").GetString();
+        Assert.False(string.IsNullOrEmpty(cursor));
+
+        // Act - request next page using the cursor returned above
+        var urlWithCursor = $"/shell-descriptors?limit=2&cursor={cursor}";
+        var responseWithCursor = await ApiContext.GetAsync(urlWithCursor);
+
+        // Assert
+        AssertSuccessResponse(responseWithCursor);
+
+        var contentWithCursor = await responseWithCursor.TextAsync();
+        Assert.False(string.IsNullOrEmpty(contentWithCursor));
+
+        var jsonWithCursor = JsonDocument.Parse(contentWithCursor);
+        var resultWithCursor = jsonWithCursor.RootElement.GetProperty("result");
+
+        // Ensure the second page does not repeat the first element of the first page
+        var firstIdPage1 = resultLimit2[0].GetProperty("id").GetString();
+        var firstIdPage2 = resultWithCursor[0].GetProperty("id").GetString();
+        Assert.NotEqual(firstIdPage1, firstIdPage2);
+    }
+
     [Fact]
     public async Task GetShellDescriptorById_ShouldReturnSuccess_ContentAsExpected()
     {

source/AAS.TwinEngine.Plugin.TestPlugin.PlaywrightTests/SubmodelRegistry/SubmodelRegistryTests.cs

@@ -130,4 +130,27 @@ public async Task GetSubmodelDescriptorById_CustomSubmodel_ShouldReturnSuccess_C
 
         await CompareJsonAsync(json, Path.Combine(Directory.GetCurrentDirectory(), "SubmodelRegistry", "TestData", "GetSubmodelDescriptorById_CustomSubmodel_Expected.json"));
     }
+
+    [Fact]
+
+    public async Task GetAllSubmodelDescriptors_WithTwoFieldCursor_ShouldReturnSuccess_ContentAsExpected()
+    {
+
+        // Arrange
+        var url = "/submodel-descriptors?limit=2&cursor=aHR0cHM6Ly9tbS1zb2Z0d2FyZS5jb20vc3VibW9kZWwvMDAwLTAwMi9DdXN0b21TdWJtb2RlbHxodHRwczovL21tLXNvZnR3YXJlLmNvbS9pZHMvYWFzLzAwMC0wMDE";
+
+        // Act
+        var response = await ApiContext.GetAsync(url);
+
+        // Assert
+        AssertSuccessResponse(response);
+        var content = await response.TextAsync();
+        Assert.False(string.IsNullOrEmpty(content));
+
+        var json = JsonDocument.Parse(content);
+        Assert.NotNull(json);
+
+        await CompareJsonAsync(json, Path.Combine(Directory.GetCurrentDirectory(), "SubmodelRegistry", "TestData", "GetAllSubmodelDescriptors_WithTwoFieldCursor_Expected.json"));
+
+    }
 }

source/AAS.TwinEngine.Plugin.TestPlugin.PlaywrightTests/SubmodelRegistry/TestData/GetAllSubmodelDescriptors_WithTwoFieldCursor_Expected.json

@@ -0,0 +1,85 @@
+{
+  "paging_metadata": {
+    "cursor": "aHR0cHM6Ly9tbS1zb2Z0d2FyZS5jb20vc3VibW9kZWwvMDAwLTAwMi9IYW5kb3ZlckRvY3VtZW50YXRpb258aHR0cHM6Ly9tbS1zb2Z0d2FyZS5jb20vaWRzL2Fhcy8wMDAtMDAy"
+  },
+  "result": [
+    {
+      "description": null,
+      "displayName": null,
+      "extensions": null,
+      "administration": null,
+      "idShort": "ContactInformations",
+      "id": "https://mm-software.com/submodel/000-002/ContactInformation",
+      "semanticId": {
+        "type": "ModelReference",
+        "referredSemanticId": null,
+        "keys": [
+          {
+            "type": "Submodel",
+            "value": "https://admin-shell.io/zvei/nameplate/1/0/ContactInformations"
+          }
+        ]
+      },
+      "supplementalSemanticId": null,
+      "endpoints": [
+        {
+          "interface": "SUBMODEL-3.0",
+          "protocolInformation": {
+            "href": "http://localhost:8080/submodels/aHR0cHM6Ly9tbS1zb2Z0d2FyZS5jb20vc3VibW9kZWwvMDAwLTAwMi9Db250YWN0SW5mb3JtYXRpb24",
+            "endpointProtocol": "http",
+            "endpointProtocolVersion": null,
+            "subprotocol": null,
+            "subprotocolBody": null,
+            "subprotocolBodyEncoding": null,
+            "securityAttributes": null
+          }
+        }
+      ]
+    },
+    {
+      "description": [
+        {
+          "language": "en",
+          "text": "The Submodel defines a set meta data for the handover of documentation from the manufacturer to the operator for industrial equipment"
+        }
+      ],
+      "displayName": null,
+      "extensions": null,
+      "administration": {
+        "embeddedDataSpecifications": null,
+        "version": "2",
+        "revision": "0",
+        "creator": null,
+        "templateId": "https://admin-shell.io/idta-02004-2-0"
+      },
+      "idShort": "HandoverDocumentation",
+      "id": "https://mm-software.com/submodel/000-002/HandoverDocumentation",
+      "semanticId": {
+        "type": "ModelReference",
+        "referredSemanticId": null,
+        "keys": [
+          {
+            "type": "Submodel",
+            "value": "0173-1#01-AHF578#003"
+          }
+        ]
+      },
+      "supplementalSemanticId": null,
+      "endpoints": [
+        {
+          "interface": "SUBMODEL-3.0",
+          "protocolInformation": {
+            "href": "http://localhost:8080/submodels/aHR0cHM6Ly9tbS1zb2Z0d2FyZS5jb20vc3VibW9kZWwvMDAwLTAwMi9IYW5kb3ZlckRvY3VtZW50YXRpb24",
+            "endpointProtocol": "http",
+            "endpointProtocolVersion": null,
+            "subprotocol": null,
+            "subprotocolBody": null,
+            "subprotocolBodyEncoding": null,
+            "securityAttributes": null
+          }
+        }
+      ]
+    }
+  ]
+}
+

source/AAS.TwinEngine.Plugin.TestPlugin.PlaywrightTests/SubmodelRepository/GetAllSubmodelsTests.cs

@@ -128,4 +128,27 @@ public async Task GetAllSubmodels_PaginationFlow_SecondPageHasDistinctResults()
             Assert.NotEqual(firstResult, secondResult.GetProperty("id").GetString());
         }
     }
+
+    [Fact]
+
+    public async Task GetAllSubmodels_WithTwoFieldCursor_ShouldReturnSuccess_ContentAsExpected()
+    {
+
+        // Arrange
+        var url = "/submodels?limit=2&cursor=aHR0cHM6Ly9tbS1zb2Z0d2FyZS5jb20vc3VibW9kZWwvMDAwLTAwMi9DdXN0b21TdWJtb2RlbHxodHRwczovL21tLXNvZnR3YXJlLmNvbS9pZHMvYWFzLzAwMC0wMDE";
+
+        // Act
+        var response = await ApiContext.GetAsync(url);
+
+        // Assert
+        AssertSuccessResponse(response);
+        var content = await response.TextAsync();
+        Assert.False(string.IsNullOrEmpty(content));
+
+        var json = JsonDocument.Parse(content);
+        Assert.NotNull(json);
+
+        await CompareJsonAsync(json, Path.Combine(Directory.GetCurrentDirectory(), "SubmodelRepository", "TestData", "GetAllSubmodels_WithTwoFieldCursor_Expected.json"));
+
+    }
 }