Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hmcts/idam-web-public
Web Public Application for Reform IdAM (Strategic)
https://github.com/hmcts/idam-web-public
jenkins-cft jenkins-cft-d-i
Last synced: about 1 month ago
JSON representation
Web Public Application for Reform IdAM (Strategic)
- Host: GitHub
- URL: https://github.com/hmcts/idam-web-public
- Owner: hmcts
- License: mit
- Created: 2018-05-04T14:01:25.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-12T19:30:46.000Z (8 months ago)
- Last Synced: 2024-04-14T11:10:51.189Z (8 months ago)
- Topics: jenkins-cft, jenkins-cft-d-i
- Language: Java
- Size: 47.4 MB
- Stars: 1
- Watchers: 8
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Audit: audit.json
Awesome Lists containing this project
README
# IdAM Web Public
IdAM Web Public is a Spring Boot web application that provides the public facing UI for Reform
IdAM. This includes: login and sign-up page, page for requesting password reset.
## Getting started
### Prerequisites
- [JDK 8](https://www.oracle.com/java)
### Building
The project uses [Gradle](https://gradle.org) as a build tool but you don't have install it locally since there is a
`./gradlew` wrapper script.
To build the project please execute the following command:
```bash
$ ./gradlew build
```
## Developing
### Unit tests
To run all unit tests please execute the following command:
```bash
$ ./gradlew test
```
### Coding style tests
To run all checks (including unit tests) please execute the following command:
```bash
$ ./gradlew check
```
## Docker
Required tools for macOS
- docker (homebrew cask)
### Build
```bash
docker build -t hmcts/idam-web-public: .
```
### Run Interactively
```bash
# Running a temporary container?
docker run --rm -it -e STRATEGIC_SERVICE_URL=http:// --entrypoint /bin/sh hmcts/idam-web-public:
# Is the container already running?
docker exec -it /bin/sh
```
### Run as Daemon
See the webapps docker-compose.yml file.
Docker compose expects the image to tag to be `local`.
```bash
docker-compose up
```
### Docker Compose Notes
Expected error: Access denied. ForgeRock connection is not yet implemented. Please use the following URI to obtain the the security code page.
`http://localhost:18002/login/pin?client_id=tstsrv456&redirect_uri=http://localhost:8084/ui/login`
### AKS Troubleshooting Mode
Use the `/configprops` & `/env` endpoints to learn more about the target configuration. To bypass sanitisation, use either of the implemtations below.
```yaml
# application.yaml
management:
security:
enabled: false
endpoint:
configprops:
keys-to-sanitize:
- nothing
env:
keys-to-sanitize:
- nothing
endpoints:
web:
base-path: /
exposure:
include: health,info,configprops,env
...
# values.yaml
...
environment:
MANAGEMENT_ENDPOINT_CONFIGPROPS_KEYS-TO-SANITIZE_0: nothing
MANAGEMENT_ENDPOINT_ENV_KEYS-TO-SANITIZE_0: nothing
MANAGEMENT_ENDPOINTS_WEB_EXPOSURE_INCLUDE: health,info,configprops,env
...
# K8s manifest
- name: MANAGEMENT_ENDPOINT_CONFIGPROPS_KEYS-TO-SANITIZE_0
value: nothing
- name: MANAGEMENT_ENDPOINT_ENV_KEYS-TO-SANITIZE_0
value: nothing
- name: MANAMANAGEMENT_ENDPOINTS_WEB_EXPOSURE_INCLUDE
value: health,info,configprops,env
```
### Pipeline Overrides
You can add similar callbacks to the below to override the environment values and set testing variables.
```groovy
withPipeline(type, product, component) {
...
before('smoketest:idam-preview') {
env.PREVIEW_ENVIRONMENT_NAME = 'preview'
env.NONPROD_ENVIRONMENT_NAME = 'aat'
env.PUBLIC_URL = 'https://idam-web-public-pr-207.service.core-compute-preview.internal'
println """Using PREVIEW_ENVIRONMENT_NAME: ${env.PREVIEW_ENVIRONMENT_NAME}
Using NONPROD_ENVIRONMENT_NAME: ${env.NONPROD_ENVIRONMENT_NAME}
Using PUBLIC_URL: ${env.PUBLIC_URL}""".stripIndent()
}
...
}
```
## Versioning
We use [SemVer](http://semver.org/) for versioning.
For the versions available, see the tags on this repository.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE.md) file for details.
# Functional test reports
functional-output folder required to generate the reports, so the folder with the test file created as empty folder is not allowed to push to git.