Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hmcts/pre-api
Pre-recorded Evidence API
https://github.com/hmcts/pre-api
jenkins-sds
Last synced: about 2 months ago
JSON representation
Pre-recorded Evidence API
- Host: GitHub
- URL: https://github.com/hmcts/pre-api
- Owner: hmcts
- License: mit
- Created: 2023-08-10T12:36:26.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-10-29T10:02:18.000Z (2 months ago)
- Last Synced: 2024-10-29T11:02:37.984Z (2 months ago)
- Topics: jenkins-sds
- Language: Java
- Homepage:
- Size: 87.6 MB
- Stars: 0
- Watchers: 10
- Forks: 0
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# pre-api
# Pre-Recorded Evidence API
[](https://opensource.org/licenses/MIT) [](https://sonarcloud.io/summary/new_code?id=uk.gov.hmcts.reform%3Apre-api) [](https://sonarcloud.io/summary/new_code?id=uk.gov.hmcts.reform%3Apre-api) [](https://sonarcloud.io/summary/new_code?id=uk.gov.hmcts.reform%3Apre-api) [](https://sonarcloud.io/summary/new_code?id=uk.gov.hmcts.reform%3Apre-api)
## Purpose
This code repository contains the source code for the Pre-Recorded Evidence API.
The API hosts numerous endpoints, which are [documented in Swagger](https://hmcts.github.io/cnp-api-docs/swagger.html?url=https://hmcts.github.io/cnp-api-docs/specs/pre-api.json#/)
This diagram gives an overview of the PRE system which the pre-api connects to in its current state (not yet live).
```mermaid
C4Context
title System Context diagram for Pre-Recorded Evidence
Person(adminUser, "Admin User", "")
Person(judicialUser, "Judicial User", "")
Person(professionalUser, "Professional User", "")
System_Boundary(PowerPlatform, "Power Platform") {
System(PowerApps, "Power Apps Forms", "User Authentication via MS Teams")
System(PowerFlows, "Power Flows", "")
SystemDb(Dataverse, "Dataverse", "")
}
Enterprise_Boundary(a0, "SDS Azure Tenant",) {
System(Portal, "Portal", "User Authentication via Azure B2C")
System_Boundary(api, "API") {
System(api, "pre-api", "System Authentication via Azure APIm.
User Authorisation via X-User-Id header")
SystemDb(db, "API db")
}
System_Boundary(media, "Media") {
SystemDb(blob, "Azure Blob Storage")
}
}
Enterprise_Boundary(a1, "Media Kinda Azure Tenant",) {
System(mk, "Media Kind")
}
BiRel(judicialUser, Portal, "")
BiRel(adminUser, Portal, "")
BiRel(adminUser, PowerApps, "")
BiRel(professionalUser, Portal, "")
BiRel(PowerApps, PowerFlows, "")
Rel(Portal, PowerFlows, "")
Rel(Portal, api, "")
BiRel(PowerFlows, Dataverse, "")
Rel(PowerApps, api, "")
BiRel(PowerFlows, api, "")
Rel(api, db, "")
Rel(Portal, mk, "")
Rel(PowerApps, mk, "")
Rel(PowerFlows, mk, "")
Rel(api, mk, "")
Rel(mk, blob, "")
UpdateElementStyle(api, $bgColor="green", $borderColor="black")
UpdateElementStyle(PowerPlatform)
UpdateLayoutConfig($c4ShapeInRow="3", $c4BoundaryInRow="1")
```
## Related Repositories
* [PRE Power Platform Frontend](https://github.com/hmcts/pre-power-platform)
* [PRE Shared Infrastructure](https://github.com/hmcts/pre-shared-infrastructure)
* [PRE Function Apps](https://github.com/hmcts/pre-functions)
* [PRE Portal](https://github.com/hmcts/pre-portal)
## What's inside
The template is a working application with a minimal setup. It contains:
* application code
* setup script to prepare project
* common plugins and libraries
* docker setup
* automatically publishes API documentation to [hmcts/cnp-api-docs](https://github.com/hmcts/cnp-api-docs)
* code quality tools already set up
* MIT license and contribution information
* Helm chart using chart-java.
The application exposes health endpoint (http://localhost:4550/health) and metrics endpoint
(http://localhost:4550/metrics).
## Plugins
The template contains the following plugins:
* checkstyle
https://docs.gradle.org/current/userguide/checkstyle_plugin.html
Performs code style checks on Java source files using Checkstyle and generates reports from these checks.
The checks are included in gradle's *check* task (you can run them by executing `./gradlew check` command).
* pmd
https://docs.gradle.org/current/userguide/pmd_plugin.html
Performs static code analysis to finds common programming flaws. Included in gradle `check` task.
* jacoco
https://docs.gradle.org/current/userguide/jacoco_plugin.html
Provides code coverage metrics for Java code via integration with JaCoCo.
You can create the report by running the following command:
```bash
./gradlew jacocoTestReport
```
The report will be created in build/reports subdirectory in your project directory.
* io.spring.dependency-management
https://github.com/spring-gradle-plugins/dependency-management-plugin
Provides Maven-like dependency management. Allows you to declare dependency management
using `dependency 'groupId:artifactId:version'`
or `dependency group:'group', name:'name', version:version'`.
* org.springframework.boot
http://projects.spring.io/spring-boot/
Reduces the amount of work needed to create a Spring application
* org.owasp.dependencycheck
https://jeremylong.github.io/DependencyCheck/dependency-check-gradle/index.html
Provides monitoring of the project's dependent libraries and creating a report
of known vulnerable components that are included in the build. To run it
execute `gradle dependencyCheck` command.
* com.github.ben-manes.versions
https://github.com/ben-manes/gradle-versions-plugin
Provides a task to determine which dependencies have updates. Usage:
```bash
./gradlew dependencyUpdates -Drevision=release
```
## Setup
Located in `./bin/init.sh`. Simply run and follow the explanation how to execute it.
## Building and deploying the application
### Building the application
The project uses [Gradle](https://gradle.org) as a build tool. It already contains
`./gradlew` wrapper script, so there's no need to install gradle.
In order for integration tests to run, a docker image is needed for the
postgres testcontainers.
For this to pull from hmcts ACR you must login to the ACR first:
```bash
az login # if not logged in already
az acr login --name hmctspublic
```
To build the project execute the following command:
```bash
./gradlew build
```
### Running the application
Create the image of the application by executing the following command:
```bash
./gradlew assemble
```
Create docker image:
```bash
docker-compose build
```
Run the distribution (created in `build/install/pre-api` directory)
by executing the following command:
```bash
docker-compose up
```
This will start the API container exposing the application's port
(set to `4550` in this template app).
In order to test if the application is up, you can call its health endpoint:
```bash
curl http://localhost:4550/health
```
You should get a response similar to this:
```
{"status":"UP","diskSpace":{"status":"UP","total":249644974080,"free":137188298752,"threshold":10485760}}
```
### Alternative script to run application
To skip all the setting up and building, just execute the following command:
```bash
./bin/run-in-docker.sh
```
For more information:
```bash
./bin/run-in-docker.sh -h
```
Script includes bare minimum environment variables necessary to start api instance. Whenever any variable is changed or any other script regarding docker image/container build, the suggested way to ensure all is cleaned up properly is by this command:
```bash
docker-compose rm
```
It clears stopped containers correctly. Might consider removing clutter of images too, especially the ones fiddled with:
```bash
docker images
docker image rm
```
There is no need to remove postgres and java or similar core images.
## How to generate a Power Platform Custom Connector
Copy the [Swagger v2 spec](https://raw.githubusercontent.com/hmcts/pre-api/master/pre-api-stg.yaml) and paste it into the [Power Platform Custom Connector](https://make.powerautomate.com/environments/3df85815-859a-e884-8b20-6a6dac1054a1/connections/custom) edit page. There will need to be a connector for prod and staging. The swagger spec is automatically updated in each PR.
## Crons
You can manually run a cron task from the cli:
```
TASK_NAME=[task] java -jar pre-api.jar run
# E.g.
TASK_NAME=CleanupLiveEvents java -jar pre-api.jar
# or
TASK_NAME=CleanupLiveEvents ./gradlew bootRun
```
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details