test: Created an end-to-end test with Playwright

alex-clayton-1 · alex-clayton-1 · commit 7ba9b0d9868c · 2025-04-15T15:04:12.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -288,3 +288,6 @@ __queuestorage__
 
 # Gitleaks report
 gitleaks-report.json
+
+# Playwright
+test-results/
diff --git a/scripts/tests/e2e.sh b/scripts/tests/e2e.sh
@@ -0,0 +1,25 @@
+#!/bin/bash
+
+# Start the Service Layer in background
+cd src/ServiceLayer.API/
+func start &
+cd ../..
+
+# Start the LocalEventgridEmulator in detached mode
+cd tests/LocalEventgridEmulator
+docker-compose up -d
+cd ../..
+
+# Start the TestEventGridSubscriber in background
+cd tests/e2e/TestEventGridSubscriber
+func start &
+cd ..
+
+# Optional: Wait a few seconds to let services start
+sleep 15
+
+# Run the Playwright test
+npm test
+
+echo "Killing all background jobs"
+kill $(jobs -p)
diff --git a/tests/LocalEventgridEmulator/docker-compose.yml b/tests/LocalEventgridEmulator/docker-compose.yml
@@ -0,0 +1,31 @@
+services:
+  azureventgridsimulator:
+    image: acrukshubdevparman.azurecr.io/azureeventgridsimulator:latest
+    container_name: azureeventgridsimulator-dev
+    ports:
+      # add a port mapping for each topic in the settings file
+      - "60201:60201"
+    volumes:
+      # map a local folder './docker' to a read-only folder '/aegs' in the container
+      # this allows us to access files (e.g. settings or certificates) from within the container
+      - ./docker:/aegs:ro
+    environment:
+      - ASPNETCORE_ENVIRONMENT=Development
+      # specify cert details note: can be generated like so:
+      # dotnet dev-certs https --export-path ./docker/azureEventGridSimulator.pfx --password Y0urSup3rCrypt1cPa55w0rd! --trust
+      - ASPNETCORE_Kestrel__Certificates__Default__Path=/aegs/azureEventGridSimulator.pfx
+      - ASPNETCORE_Kestrel__Certificates__Default__Password=Y0urSup3rCrypt1cPa55w0rd!
+
+      # logging configuration
+      - AEGS_Serilog__MinimumLevel__Default=Verbose
+
+      # you could also define topics/subscribers via via a configfile
+      - AEGS_ConfigFile=/aegs/topics.config.json
+
+    #env_file:
+      # you can also define environment variables via a file
+      #- ./my.env
+
+volumes:
+  docker:
+  cosmosdb-data:
diff --git a/tests/LocalEventgridEmulator/docker/topics.config.json b/tests/LocalEventgridEmulator/docker/topics.config.json
@@ -0,0 +1,19 @@
+{
+  "topics": [
+    {
+      "name": "test-topic",
+      "type": "CloudEvent",
+      "port": 60201,
+      "key": "TheLocal+DevelopmentKey=",
+      "subscribers": {
+        "http": [
+          {
+            "name": "TestEventGridSubscriber",
+            "endpoint": "http://host.docker.internal:7010/runtime/webhooks/EventGrid?functionName=EventHandler",
+            "disableValidation": true
+          }
+        ]
+      }
+    }
+  ]
+}
diff --git a/tests/e2e/TestEventGridSubscriber/Program.cs b/tests/e2e/TestEventGridSubscriber/Program.cs
@@ -0,0 +1,10 @@
+using Azure.Identity;
+using Azure.Messaging.EventGrid;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Hosting;
+
+var host = new HostBuilder()
+    .ConfigureFunctionsWebApplication()
+    .Build();
+
+await host.RunAsync();
diff --git a/tests/e2e/TestEventGridSubscriber/Properties/launchSettings.json b/tests/e2e/TestEventGridSubscriber/Properties/launchSettings.json
@@ -0,0 +1,9 @@
+{
+  "profiles": {
+    "TestEventGridSubscriber": {
+      "commandName": "Project",
+      "commandLineArgs": "--port 7010",
+      "launchBrowser": false
+    }
+  }
+}
diff --git a/tests/e2e/TestEventGridSubscriber/TestEventGridSubscriber.cs b/tests/e2e/TestEventGridSubscriber/TestEventGridSubscriber.cs
@@ -0,0 +1,33 @@
+using Azure.Messaging;
+using Azure.Messaging.EventGrid;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Azure.Functions.Worker;
+using Microsoft.Azure.Functions.Worker.Http;
+
+namespace TestEventGridSubscriber;
+
+public class TestEventGridSubscriber
+{
+    public static List<CloudEvent> EventStore { get; } = [];
+
+    [Function("EventHandler")]
+    public static void Run([EventGridTrigger] CloudEvent cloudEvent)
+    {
+        EventStore.Add(cloudEvent);
+    }
+
+    [Function("ClearEventsStore")]
+    public static IActionResult ClearEventsStore(
+    [HttpTrigger(AuthorizationLevel.Anonymous, "delete", Route = "events")] HttpRequestData req)
+    {
+        EventStore.Clear();
+        return new NoContentResult();
+    }
+
+    [Function("GetEvents")]
+    public static IActionResult GetEvents(
+    [HttpTrigger(AuthorizationLevel.Anonymous, "get", Route = "events")] HttpRequestData req)
+    {
+        return new OkObjectResult(EventStore);
+    }
+}
diff --git a/tests/e2e/TestEventGridSubscriber/TestEventGridSubscriber.csproj b/tests/e2e/TestEventGridSubscriber/TestEventGridSubscriber.csproj
@@ -0,0 +1,30 @@
+﻿<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <TargetFramework>net9.0</TargetFramework>
+    <AzureFunctionsVersion>v4</AzureFunctionsVersion>
+    <OutputType>Exe</OutputType>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+  <ItemGroup>
+    <FrameworkReference Include="Microsoft.AspNetCore.App" />
+    <PackageReference Include="Azure.Identity" Version="1.13.2" />
+    <PackageReference Include="Microsoft.Azure.Functions.Worker" Version="2.0.0" />
+    <PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.EventGrid" Version="3.5.0" />
+    <PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.Http" Version="3.3.0" />
+    <PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.Http.AspNetCore" Version="2.0.1" />
+    <PackageReference Include="Microsoft.Azure.Functions.Worker.Sdk" Version="2.0.2" />
+  </ItemGroup>
+  <ItemGroup>
+    <None Update="host.json">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+    <None Update="local.settings.json">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+      <CopyToPublishDirectory>Never</CopyToPublishDirectory>
+    </None>
+  </ItemGroup>
+  <ItemGroup>
+    <Using Include="System.Threading.ExecutionContext" Alias="ExecutionContext" />
+  </ItemGroup>
+</Project>
diff --git a/tests/e2e/TestEventGridSubscriber/host.json b/tests/e2e/TestEventGridSubscriber/host.json
@@ -0,0 +1,3 @@
+{
+  "version": "2.0"
+}
diff --git a/tests/e2e/package-lock.json b/tests/e2e/package-lock.json
diff --git a/tests/e2e/package.json b/tests/e2e/package.json
@@ -0,0 +1,9 @@
+{
+  "name": "e2e",
+  "scripts": {
+    "test": "playwright test"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.51.1"
+  }
+}
diff --git a/tests/e2e/playwright.config.ts b/tests/e2e/playwright.config.ts
@@ -0,0 +1,7 @@
+import { defineConfig } from '@playwright/test';
+
+export default defineConfig({
+  use: {
+    baseURL: 'http://localhost:7002/api/',
+  }
+});
diff --git a/tests/e2e/post-bsselect-episode.test.ts b/tests/e2e/post-bsselect-episode.test.ts
@@ -0,0 +1,37 @@
+
+import { test, expect } from '@playwright/test';
+
+test('POST BS-Select episode to endpoint', async ({ request }) => {
+  // Clear any events from previous test runs
+  await request.delete('http://localhost:7010/api/events');
+
+  const triggerResponse = await request.post(`http://localhost:7002/api/bsselect/episodes/ingress`, {
+    data: {
+      episode_id: "123",
+      nhs_number: "9990000000",
+      date_of_birth: "1970-01-01",
+      first_given_name: "Test",
+      family_name: "User"
+    },
+    headers: {
+      'Content-Type': 'application/json',
+    }
+  });
+  expect(triggerResponse.ok()).toBeTruthy();
+
+  // 3000 milliseconds works for now but may need to increase this value in the future
+  await new Promise(resolve => setTimeout(resolve, 3000));
+
+  const eventsResponse = await request.get('http://localhost:7010/api/events');
+  const events: any[] = await eventsResponse.json();
+
+  expect(events.length).toBe(1);
+  expect(events[0].source).toBe('ServiceLayer');
+  expect(events[0].type).toBe('EpisodeEvent');
+  expect(events[0].data.PathwayTypeId).toBe('11111111-1111-1111-1111-111111111113');
+  expect(events[0].data.PathwayTypeName).toBe('Breast Screening Routine');
+  expect(events[0].data.ScreeningName).toBe('Breast Screening');
+  expect(events[0].data.NhsNumber).toBe('9990000000');
+  expect(events[0].data.DOB).toBe('1970-01-01');
+  expect(events[0].data.Name).toBe('Test User');
+});
