Added data bridge api healthcheck and tests. (#10)

* Added data bridge api healthcheck and tests. Updated docker compose settings to enable services to run along side each other.

* We must disable Data Bridge API health check for integration tests.

* Enabled HealthcheckEnabled for component test

---------

Co-authored-by: Mark Gent <Mark.Gent@homesengland.gov.uk>

Author: MarkGent1

.github/workflows/check-pull-request.yml

@@ -83,7 +83,7 @@ jobs:
       - name: Make script executable
         run: chmod +x ./working-dir/wait-for-docker-logs.sh
       - name: Wait for localstack
-        run: ./working-dir/wait-for-docker-logs.sh localstack-emulator "Bootstrapping Complete" 60
+        run: ./working-dir/wait-for-docker-logs.sh kda-localstack-emulator "Bootstrapping Complete" 60
       - name: Wait for keeperdata_api to be ready
         run: ./working-dir/wait-for-docker-logs.sh keeperdata_api "Now listening on" 60
       - name: Run integration tests

docker-compose.override.yml

@@ -4,13 +4,14 @@ services:
       com.microsoft.visual-studio.project-name: "KeeperData.Api"
     environment:
       - ASPNETCORE_ENVIRONMENT=Development
-      - ASPNETCORE_HTTP_PORTS=8080
-      - AWS__ServiceURL=http://localstack-emulator:4566
-      - Mongo__DatabaseUri=mongodb://mongodb:27017
+      - ASPNETCORE_HTTP_PORTS=5555
+      - AWS__ServiceURL=http://kda-localstack-emulator:4566
+      - Mongo__DatabaseUri=mongodb://kda_mongodb:27017
       - StorageConfiguration__ComparisonReportsStorage__BucketName=test-comparison-reports-bucket
       - QueueConsumerOptions__IntakeEventQueueOptions__QueueUrl=http://sqs.eu-west-2.127.0.0.1:4566/000000000000/ls_keeper_data_intake_queue
+      - ApiClients__DataBridgeApi__BaseUrl=http://keeperdata_bridge:5560/
     ports:
-      - "8080"
+      - "5555"
     volumes:
       - ${APPDATA}/Microsoft/UserSecrets:/home/app/.microsoft/usersecrets:ro
       - ${APPDATA}/Microsoft/UserSecrets:/root/.microsoft/usersecrets:ro

docker-compose.yml

@@ -1,11 +1,10 @@
 name: 'keeperdata_api'
 services:
   localstack:
-    container_name: "localstack-emulator"
+    container_name: "kda-localstack-emulator"
     image: localstack/localstack:3.0.2
     ports:
-      - '4566:4566' # LocalStack Gateway
-      - '4510-4559:4510-4559' # external services port range
+      - '4568:4566'
     env_file:
       - 'compose/aws.env'
     environment:
@@ -18,28 +17,29 @@ services:
       - "/var/run/docker.sock:/var/run/docker.sock"
       - ./compose/start-localstack.sh:/etc/localstack/init/ready.d/start-localstack.sh
     healthcheck:
-      test: ['CMD', 'curl', 'http://localstack-emulator:4566/health']
+      test: ['CMD', 'curl', 'http://kda-localstack-emulator:4566/health']
       interval: 5s
       start_period: 5s
       retries: 3
     networks:
       - cdp-tenant
 
   redis:
+    container_name: "kda-redis"
     image: redis:7.2.3-alpine3.18
     ports:
-      - '6379:6379'
+      - '6381:6379'
     restart: always
     networks:
       - cdp-tenant
 
   mongodb:
-    container_name: mongodb
+    container_name: kda_mongodb
     image: mongo:6.0.13
     networks:
       - cdp-tenant
     ports:
-      - '27018:27017'
+      - '27019:27017'
     volumes:
       - mongodb-data:/data
     restart: always
@@ -50,10 +50,7 @@ services:
     image: keeperdata_api
     build: ./
     ports:
-      - '8080:8080'
-    links:
-      - 'localstack:localstack'
-      - 'mongodb:mongodb'
+      - '5555:5555'
     depends_on:
       localstack:
         condition: service_healthy
@@ -62,8 +59,8 @@ services:
     env_file:
       - 'compose/aws.env'
     environment:
-      PORT: 8080
-      LOCALSTACK_ENDPOINT: http://localstack-emulator:4566
+      PORT: 5555
+      LOCALSTACK_ENDPOINT: http://kda-localstack-emulator:4566
     networks:
       - cdp-tenant
 
@@ -72,4 +69,4 @@ volumes:
 
 networks:
   cdp-tenant:
-    driver: bridge
+    name: cdp-tenant

src/KeeperData.Api/KeeperData.Api.csproj

@@ -8,12 +8,6 @@
     <DockerDefaultTargetOS>Linux</DockerDefaultTargetOS>
     <DockerComposeProjectPath>..\docker-compose.dcproj</DockerComposeProjectPath>
   </PropertyGroup>
-
-  <ItemGroup>
-    <Content Include="..\..\.dockerignore">
-      <Link>.dockerignore</Link>
-    </Content>
-  </ItemGroup>
 
   <ItemGroup>
     <PackageReference Include="Asp.Versioning.Mvc.ApiExplorer" Version="8.1.0" />

src/KeeperData.Api/Setup/ServiceCollectionExtensions.cs

@@ -1,5 +1,6 @@
 using Asp.Versioning;
 using KeeperData.Application.Setup;
+using KeeperData.Infrastructure.ApiClients.Setup;
 using KeeperData.Infrastructure.Database.Setup;
 using KeeperData.Infrastructure.Messaging.Setup;
 using KeeperData.Infrastructure.Storage.Setup;
@@ -41,6 +42,8 @@ public static void ConfigureApi(this IServiceCollection services, IConfiguration
         services.AddMessagingDependencies(configuration);
 
         services.AddStorageDependencies(configuration);
+
+        services.AddApiClientDependencies(configuration);
     }
 
     private static void ConfigureHealthChecks(this IServiceCollection services)

src/KeeperData.Api/appsettings.Development.json

@@ -1,11 +1,4 @@
 {
-  "AWS": {
-    "ServiceURL": "http://sqs.eu-west-2.localhost.localstack.cloud:4566/"
-  },
-  "Mongo": {
-    "DatabaseUri": "mongodb://127.0.0.1:27017",
-    "DatabaseName": "ls-keeper-data-api"
-  },
   "DetailedErrors": true,
   "AllowedHosts": "*",
   "Serilog": {

src/KeeperData.Api/appsettings.json

@@ -22,6 +22,18 @@
       "BucketName": "Set in cdp-app-config (or for local development using docker-compose.override.yml)"
     }
   },
+  "ApiClients": {
+    "DataBridgeApi": {
+      "BaseUrl": "Set in cdp-app-config (or for local development using docker-compose.override.yml",
+      "HealthcheckEnabled": false,
+      "ResiliencePolicy": {
+        "Retries": 3,
+        "BaseDelaySeconds": 2,
+        "UseJitter": true,
+        "TimeoutPeriodSeconds": 30
+      }
+    }
+  },
   "AllowedHosts": "*",
   "TraceHeader": "x-cdp-request-id",
   "Serilog": {

src/KeeperData.Infrastructure/ApiClients/Configuration/ApiClientConfiguration.cs

@@ -0,0 +1,8 @@
+namespace KeeperData.Infrastructure.ApiClients.Configuration;
+
+public class ApiClientConfiguration
+{
+    public string BaseUrl { get; set; } = string.Empty;
+    public bool HealthcheckEnabled { get; set; } = false;
+    public ResiliencePolicy ResiliencePolicy { get; set; } = new();
+}

src/KeeperData.Infrastructure/ApiClients/Configuration/ApiClientsConfiguration.cs

@@ -0,0 +1,6 @@
+namespace KeeperData.Infrastructure.ApiClients.Configuration;
+
+public class ApiClientsConfiguration
+{
+    public Dictionary<string, ApiClientConfiguration> Clients { get; set; } = [];
+}

src/KeeperData.Infrastructure/ApiClients/Configuration/ResiliencePolicy.cs

@@ -0,0 +1,12 @@
+using Polly;
+
+namespace KeeperData.Infrastructure.ApiClients.Configuration;
+
+public class ResiliencePolicy
+{
+    public int Retries { get; set; } = 3; // Total retry attempts
+    public int BaseDelaySeconds { get; set; } = 2; // Base delay before first retry
+    public bool UseJitter { get; set; } = true; // Adds randomness to avoid thundering herd
+    public int TimeoutPeriodSeconds { get; set; } = 30; // Canceling execution if it does not complete within a specified time
+    public DelayBackoffType BackoffType { get; set; } = DelayBackoffType.Exponential; // Retry strategy
+}