Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hmcts/document-management-store-app
Spring Boot Application to store Documents
https://github.com/hmcts/document-management-store-app
application docker document-management java jenkins-cft jenkins-cft-d-i spring-boot
Last synced: about 2 hours ago
JSON representation
Spring Boot Application to store Documents
- Host: GitHub
- URL: https://github.com/hmcts/document-management-store-app
- Owner: hmcts
- License: mit
- Created: 2017-12-07T15:11:57.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T09:24:26.000Z (19 days ago)
- Last Synced: 2024-10-29T09:42:50.650Z (19 days ago)
- Topics: application, docker, document-management, java, jenkins-cft, jenkins-cft-d-i, spring-boot
- Language: Java
- Homepage:
- Size: 64 MB
- Stars: 43
- Watchers: 67
- Forks: 32
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Audit: audit.json
Awesome Lists containing this project
README
# Document Management Store App
[](https://opensource.org/licenses/MIT)
[](https://travis-ci.org/hmcts/document-management-store-app)
[](https://codecov.io/gh/hmcts/document-management-store-app)
[](https://www.codacy.com/app/HMCTS/document-management-store-app)
[](https://www.codacy.com/app/HMCTS/document-management-store-app)
[](https://snyk.io/test/github/hmcts/document-management-store-app)
Document Management is a backend service to store and retrieve documents.
### Tech
It uses:
* Java
* Spring boot
* Junit, Mockito and SpringBootTest and Powermockito
* Gradle
* [lombok project](https://projectlombok.org/) - Lombok project
### Plugins
* [lombok plugin](https://plugins.jetbrains.com/idea/plugin/6317-lombok-plugin) - Lombok IDEA plugin
#### Environment variables
The following environment variables are required:
| Name | Default | Description |
|------|---------|-------------|
| IDAM_USER_BASE_URI | - | Base URL for IdAM's User API service (idam-app). `http://localhost:4501` for the dockerised local instance or tunneled `dev` instance. |
| IDAM_S2S_BASE_URI | - | Base URL for IdAM's S2S API service (service-auth-provider). `http://localhost:4502` for the dockerised local instance or tunneled `dev` instance. |
| MAX_FILE_SIZE | 100MB | Max file size |
**Note:** The MAX_FILE_SIZE enforces limit on the document upload in the document management backend service.
Additionally, the max request content length (including file sizes) need to be configured for the IIS web server (on
Azure) via *maxAllowedContentLength* property for request filter in **web.config** (config file within source
repository).
## Setup
```bash
# Get the connection string for Azure Blob Store and put it in place of getOneFromPortalAzure in application.yaml
# Do not commit it!!!
azure:
storage:
connection-string: ${STORAGEACCOUNT_PRIMARY_CONNECTION_STRING:getOneFromPortalAzure}
```
```bash
# Cloning repo and running though docker
git clone https://github.com/hmcts/document-management-store-app.git
cd document-management-store-app/
az login
az acr login --name hmctspublic && az acr login --name hmctsprivate
docker-compose -f docker-compose-dev.yml pull
docker-compose -f docker-compose-dev.yml up -d
#Run below script to create the Batch related tables for local set up ONLY
./bin/create-batch-related-tables-postresql.sh
# Run application
./gradlew bootRun
```
### Integration
There is currently a Java Client available here:
https://github.com/hmcts/document-management-client
### 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:4603/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/reform-api-docs/swagger.html?url=https://hmcts.github.io/reform-api-docs/specs/document-management-store-app.json
### Functional Tests
To use the functional tests locally for large .mp4 and .doc files please first download them
from here : [Large Files](https://portal.azure.com/#blade/Microsoft_Azure_Storage/ContainerMenuBlade/overview/storageAccountId/%2Fsubscriptions%2Fbf308a5c-0624-4334-8ff8-8dca9fd43783%2FresourceGroups%2Fdm-store-sandbox%2Fproviders%2FMicrosoft.Storage%2FstorageAccounts%2Fdmstorefiles/path/dm-store-files/etag/%220x8D83471B8B0648C%22/defaultEncryptionScope/%24account-encryption-key/denyEncryptionScopeOverride//defaultId//publicAccessVal/None)
and place them under your resources folder document-management-store-app/src/functionalTest/resources
This would make them available to be used in the Functional Test -
```bash
MV1 (R1) As authenticated user I should not be able to upload files that exceed permitted sizes
```
- Ensure the @Pending annotation is removed before running the test locally.
- Revert your changes after tests are run as these are for running the above F-Test on local only.
### Contract Tests (Pact)
For Executing the contract provider test execute
```./gradlew contractTest```
For Publishing the verification results to broker execute
```./gradlew runProviderPactVerification```