Light

hmcts / draft-store Goto Github PK

View Code? Open in Web Editor NEW

2.0 121.0 5.0 2.98 MB

Provides a ’save and resume’ feature for reform applications

License: MIT License

Shell 0.40% Java 84.64% Groovy 2.40% HCL 5.79% Dockerfile 0.27% Scala 6.51%

team-platform jenkins-cft jenkins-cft-d-i

draft-store's Introduction

Draft store

The Draft store micro-service provides a ’save and resume’ feature for reform applications via an internal API. It stores a draft json document against the userId provided.

Getting Started

Prerequisites

JDK 8

Building

To build the project execute the following command:

./gradlew build

Running

Before you run the application you have to define database connection.
You can do this be either setting environment variables or creating application-default.yaml file.
Run the application by executing:

./gradlew bootRun

Consuming this service locally

This image is available in the HMCTS azure container registry (currently private)
Image url is: hmcts.azurecr.io/hmcts/draft-store-service
See required config in: docker-compose.yml

Operational note

When operating this service with live data, no one should under any circumstances view the encrypted data. The reason for this is because it would be considered under Article 14 of GDPR that we had commenced processing data. Then we would have thirty days to notify any third party parties mentioned in the application that we had commenced processing their data. This must not happen as the citizen, who is creating the application, has not yet submitted their application.

API documentation

API documentation is provided with Swagger.
You can view the json spec here: http://localhost:8800/v2/api-docs
Swagger UI is available here: http://localhost:8800/swagger-ui.html
Updates to master documentation are reflected here: https://hmcts.github.io/reform-api-docs/swagger.html

Developing

Unit tests

To run all unit tests execute the following command:

./gradlew test

Integration tests

To run all integration tests execute the following command:

./gradlew integration

Code quality checks

We use checkstyle and PMD.
To run all checks execute the following command:

./lint.sh

License

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

draft-store's People

Contributors

Stargazers

Watchers

Forkers

gpressutto5 sunilkumarasp hmctsfork mdayican uk-gov-mirror

draft-store's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

Update org.apache.tomcat.embed:10.1.15 to v10.1.16 (org.apache.tomcat.embed:tomcat-embed-websocket, org.apache.tomcat.embed:tomcat-embed-el, org.apache.tomcat.embed:tomcat-embed-core)
Update plugin uk.gov.hmcts.java to v0.12.48
Update dependency io.micrometer:micrometer-registry-prometheus to v1.12.0
Update plugin com.github.ben-manes.versions to v0.50.0
🔐 Create all rate-limited PRs at once 🔐

Edited/Blocked

These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Update dependency hashicorp/terraform to v1.6.4
Update dependency microsoft/ApplicationInsights-Java to v3.4.18
Update dependency org.testcontainers:postgresql to v1.19.2
Update Terraform azurerm to v3.81.0
Update dependency org.flywaydb:flyway-core to v10
Update plugin org.flywaydb.flyway to v10
Update postgres Docker tag to v16
Click on this checkbox to rebase all open PRs at once

Detected dependencies

docker-compose

docker-compose.yml

dockerfile

Dockerfile

hmctspublic.azurecr.io/base/java 17-distroless

docker/database/Dockerfile

postgres 15-bullseye

gradle

settings.gradle

build.gradle

io.spring.dependency-management 1.1.3

org.flywaydb.flyway 9.22.3

org.springframework.boot 3.1.5

uk.gov.hmcts.java 0.12.47

se.patrikerdes.use-latest-versions 0.2.18

com.github.ben-manes.versions 0.49.0

org.sonarqube 4.4.1.3373

io.gatling.gradle 3.9.5.6

au.com.dius.pact 4.6.3

org.yaml:snakeyaml 2.2

org.apache.tomcat.embed:tomcat-embed-core 10.1.15

org.apache.tomcat.embed:tomcat-embed-el 10.1.15

org.apache.tomcat.embed:tomcat-embed-websocket 10.1.15

pmd 6.40.0

org.postgresql:postgresql 42.6.0

org.flywaydb:flyway-core 9.22.3

org.springdoc:springdoc-openapi-starter-webmvc-ui 2.2.0

com.google.guava:guava 32.1.3-jre

com.github.hmcts.java-logging:logging 6.0.1

com.github.hmcts:reform-api-standards 0.5.2

io.micrometer:micrometer-registry-prometheus 1.11.5

com.warrenstrange:googleauth 1.5.0

org.testcontainers:postgresql 1.19.1

org.scala-lang:scala-library 2.13.12

com.warrenstrange:googleauth 1.5.0

au.com.dius.pact.consumer:junit5 4.6.3

au.com.dius.pact.consumer:java8 4.1.42

au.com.dius.pact.provider:junit5 4.6.3

au.com.dius.pact.provider:spring 4.6.3

au.com.dius.pact.provider:junit5spring 4.6.3

gradle-wrapper

gradle/wrapper/gradle-wrapper.properties

gradle 8.4

helm-values

charts/draft-store-service/values.yaml

helmv3

charts/draft-store-service/Chart.yaml

java 5.0.2

postgresql 1.0.2

regex

Dockerfile

microsoft/ApplicationInsights-Java 3.4.17

Dockerfile

microsoft/ApplicationInsights-Java 3.4.17

terraform

infrastructure/alert_bad_response_code.tf

bad-response-codes-alert undefined

infrastructure/app-insights.tf

infrastructure/main.tf

infrastructure/state.tf

azurerm 3.79.0

infrastructure/versions.tf

hashicorp/terraform >= 0.13

terraform-version

infrastructure/.terraform-version

hashicorp/terraform 1.6.3

Check this box to trigger a request for Renovate to run again on this repository

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.