Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hmcts/opal-legacy-db-stub
This is the stub test service for replicating the legacy GoB DB in environments where it is not available.
https://github.com/hmcts/opal-legacy-db-stub
jenkins-sds
Last synced: about 2 months ago
JSON representation
This is the stub test service for replicating the legacy GoB DB in environments where it is not available.
- Host: GitHub
- URL: https://github.com/hmcts/opal-legacy-db-stub
- Owner: hmcts
- License: mit
- Created: 2023-11-20T11:43:49.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-10-24T13:46:36.000Z (2 months ago)
- Last Synced: 2024-10-25T16:37:44.791Z (2 months ago)
- Topics: jenkins-sds
- Language: Java
- Homepage:
- Size: 244 KB
- Stars: 3
- Watchers: 7
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# opal-legacy-db-stub
This is the stub test service for replicating the legacy GoB DB in environments where it is not available.
## 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.
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/opal-legacy-db-stub` directory)
by executing the following command:
```bash
docker-compose up
```
This will start the API container exposing the application's port
(set to `4553` in this template app).
In order to test if the application is up, you can call its health endpoint:
```bash
curl http://localhost:4553/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.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details