Add public information about local development on audit endpoints (#495)

README.md

@@ -132,6 +132,12 @@ automatically recompile and reload when changes are made.
 
     sbt -Dconfig.file=<PATH>/janus.local.conf run
 
+#### Local audit log support
+
+To get the audit endpoints to work and test audit logging locally, follow the instructions in this 
+[README](local-dev/README.md).
+
+
 ## Configuration
 
 ### Janus' AWS config
@@ -242,4 +248,4 @@ Updates can be published by running the `release` workflow in GitHub Actions.
 
 This repo uses [`gha-scala-library-release-workflow`](https://github.com/guardian/gha-scala-library-release-workflow)
 to automate publishing the Scala client (both full and preview releases) - see
-[**Making a Release**](https://github.com/guardian/gha-scala-library-release-workflow/blob/main/docs/making-a-release.md) for more details.
+[**Making a Release**](https://github.com/guardian/gha-scala-library-release-workflow/blob/main/docs/making-a-release.md) for more details.

local-dev/README.md

@@ -0,0 +1,16 @@
+# Setting up Audit Database
+
+When running locally, the audit endpoints require a Dynamo DB service to be running on port 8000.
+
+The service hosts a database holding a table that stores audit logs.
+
+To make this table available for testing auditing functionality:
+
+1. Start Docker
+2. Start up a local Dynamo DB container:
+```shell
+cd local-dev
+docker-compose up -d
+```
+3. Create the audit table schema by running [Creation test](https://github.com/guardian/janus-app/blob/f522bca83d9d90657634b038c7734a9871974161/test/aws/AuditTrailDBTest.scala#L48-L50).
+4. Populate the table with some test data by running [Insertion test](https://github.com/guardian/janus-app/blob/f522bca83d9d90657634b038c7734a9871974161/test/aws/AuditTrailDBTest.scala#L16-L46).

local-dev/docker-compose.yml

@@ -0,0 +1,16 @@
+services:
+  dynamo:
+    container_name: local-dynamodb
+    image: amazon/dynamodb-local
+    networks:
+      - local-dynamodb
+    ports:
+      - "8000:8000"
+    volumes:
+      - ${HOME}/.gu/janus-app/data:/home/dynamodblocal/data
+    working_dir: /home/dynamodblocal
+    command: "-jar DynamoDBLocal.jar -sharedDb -dbPath data"
+
+networks:
+  local-dynamodb:
+    name: local-dynamodb