Evidence Management Native PDF Annotator App

Native PDF Annotator is a backend service that manages native annotations on PDF documents. In addition, the Native PDF Annotator handles requests from the Media Viewer to markup sensitive content in a case document and subsequent requests to redact marked up content..

Tech

It uses:

• Java21
• Spring boot
• Junit, Mockito and SpringBootTest
• Gradle
• lombok project - Lombok project

Plugins

• lombok plugin - Lombok IDEA plugin

Quickstart

To clone repo and prepare to pull containers:

git clone https://github.com/hmcts/em-native-pdf-annotator-app.git
cd em-native-pdf-annotator-app/

Clean and build the application:

./gradlew clean
./gradlew build

To run just the unit tests:

./gradlew test

To run the integration tests:

Requires docker desktop running

./gradlew integration

To run the application:

Requires docker desktop running

./gradlew bootWithCCD

Swagger UI

To view our REST API go to http://{HOST}/swagger-ui/index.html On local machine with server up and running, link to swagger is as below

http://localhost:8080/swagger-ui/index.html if running on AAT, replace localhost with ingressHost data inside values.yaml class in the necessary component, making sure port number is also removed.

API Endpoints

A list of our endpoints can be found here

https://hmcts.github.io/cnp-api-docs/swagger.html?url=https://hmcts.github.io/cnp-api-docs/specs/em-native-pdf-annotator-app.json

Building the application

The project uses Gradle as a build tool. It already contains ./gradlew wrapper script, so there's no need to install gradle.

To build the project execute the following command:

./gradlew build

To run the project unit tests execute the following command:

./gradlew test

To run the project functional tests, first ensure you have run ./gradlew bootWithCCD as in the above setup instructions, then run

./gradlew functional 

License

This project is licensed under the MIT License - see the LICENSE file for details

Running contract or pact tests:

For executing the pact consumer test run

./gradlew contract

The results of the consumer test will be published to the pact folder in the root directory of the project.

To run the provider pact tests, first comment the broker configuration in the NpaPactProviderTest and NpaPactRedactionProviderTest classes and uncomment the pact folder configuration, then run the below command to execute the provider pact tests locally.

./gradlew providerContractTests