hmcts / em-ccd-orchestrator Goto Github PK

Orchestrator service that will facilitate interactions between CCD, the bundling stitching service, and any services using bundling.

License: MIT License

Dockerfile 0.06% Groovy 2.17% Shell 1.21% HCL 1.57% Java 94.99%

jenkins-cft jenkins-cft-d-i

em-ccd-orchestrator's Introduction

EVIDENCE MANAGEMENT CCD Orchestrator

CCD Orchestrator is a backend service that facilitates interactions between CCD, the EM Stitching service, and a calling service.

Setup

Install https://stedolan.github.io/jq/

For linux: sudo apt-get install jq

For mac: brew install jq

To clone repo and prepare to pull containers:

git clone https://github.com/hmcts/em-ccd-orchestrator.git
cd em-ccd-orchestrator

Clean and build the application:

./gradlew clean
./gradlew build

To run the application:

VPN connection is required

./gradlew bootRun

To run functional tests, em-stitching-api must also be running. Please follow the instructions in the README for em-stitching-api on how to do so.

This will start the API container exposing the application's port (set to 8080 in this template app).

In order to test if the application is up, you can call its health endpoint:

  curl http://localhost:8080/health

You should get a response similar to this:

  {"status":"UP","components":{"discoveryComposite":{"description":"Discovery Client not initialized","status":"UNKNOWN",
"components":{"discoveryClient":{"description":"Discovery Client not initialized","status":"UNKNOWN"}}},
"ping":{"status":"UP"},"refreshScope":{"status":"UP"},"serviceAuth":{"status":"UP"}}}

Tech

It uses:

Java 11
Spring boot
Junit, Mockito and SpringBootTest and Powermockito
Gradle
lombok project - Lombok project

Plugins

lombok plugin - Lombok IDEA plugin

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:8080/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/rpa-em-ccd-orchestrator.json

Automated Bundling Configuration Validation

The bundle configuration files can be validated by executing the validateYaml task:

./gradew validateYaml

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).
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:
```
  ./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:
```
  ./gradlew dependencyUpdates -Drevision=release
```

License

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

Check the build

Running contract or pact tests:

You can run contract or pact tests as follows:

./gradlew clean

./gradlew contract

You can then publish your pact tests locally by first running the pact docker-compose:

docker-compose -f docker-pactbroker-compose.yml up

and then using it to publish your tests:

./gradlew pactPublish

em-ccd-orchestrator's People

Contributors

Stargazers

Watchers

Forkers

jqurashi jackmaloney pd-dudkiewicz uk-gov-mirror bradsorour chromico

em-ccd-orchestrator's Issues

Dependabot couldn't authenticate with https://repo.spring.io/libs-snapshot

Dependabot couldn't authenticate with https://repo.spring.io/libs-snapshot.

You can provide authentication details in your Dependabot dashboard by clicking into the account menu (in the top right) and selecting 'Config variables'.

View the update logs.

Dependabot couldn't authenticate with https://repo.spring.io/libs-snapshot

Dependabot couldn't authenticate with https://repo.spring.io/libs-snapshot.

You can provide authentication details in your Dependabot dashboard by clicking into the account menu (in the top right) and selecting 'Config variables'.

View the update logs.

Dependabot couldn't authenticate with https://repo.spring.io/libs-snapshot

Dependabot couldn't authenticate with https://repo.spring.io/libs-snapshot.

You can provide authentication details in your Dependabot dashboard by clicking into the account menu (in the top right) and selecting 'Config variables'.

View the update logs.

Dependabot couldn't authenticate with https://repo.spring.io/libs-snapshot

Dependabot couldn't authenticate with https://repo.spring.io/libs-snapshot.

You can provide authentication details in your Dependabot dashboard by clicking into the account menu (in the top right) and selecting 'Config variables'.

View the update logs.

Use of mutation testing in em-ccd-orchestrator - Help needed

Hello there!

My name is Ana. I noted that you use the mutation testing tool Pit in the project.
I am a postdoctoral researcher at the University of Seville (Spain), and my colleagues and I are studying how mutation testing tools are used in practice. With this aim in mind, we have analysed over 3,500 public GitHub repositories using mutation testing tools, including yours! This work has recently been published in a journal paper available at https://link.springer.com/content/pdf/10.1007/s10664-022-10177-8.pdf.

To complete this study, we are asking for your help to understand better how mutation testing is used in practice, please! We would be extremely grateful if you could contribute to this study by answering a brief survey of 21 simple questions (no more than 6 minutes). This is the link to the questionnaire https://forms.gle/FvXNrimWAsJYC1zB9.

We apologize if you have already received message multiple times or if you have already had the opportunity to complete the survey. If you have already shared your feedback, we want to convey our appreciation, kindly disregard this message, and please accept our apologies for any inconvenience.

Drop me an e-mail if you have any questions or comments ([email protected]). Thank you very much in advance!!

Dependabot couldn't authenticate with https://repo.spring.io/libs-snapshot

Dependabot couldn't authenticate with https://repo.spring.io/libs-snapshot.

You can provide authentication details in your Dependabot dashboard by clicking into the account menu (in the top right) and selecting 'Config variables'.

View the update logs.

Dependabot couldn't authenticate with https://repo.spring.io/libs-snapshot

Dependabot couldn't authenticate with https://repo.spring.io/libs-snapshot.

You can provide authentication details in your Dependabot dashboard by clicking into the account menu (in the top right) and selecting 'Config variables'.

View the update logs.

Dependency Dashboard

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

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

Detected dependencies

dockerfile

Dockerfile

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

database/Dockerfile

postgres 16

gradle

gradle.properties

settings.gradle

build.gradle

io.spring.dependency-management 1.1.6

org.springframework.boot 3.3.3

uk.gov.hmcts.java 0.12.63

com.github.ben-manes.versions 0.51.0

org.sonarqube 5.1.0.4882

au.com.dius.pact 4.2.13

info.solidsoft.pitest 1.15.0

org.owasp.dependencycheck 9.2.0

net.serenity-bdd.serenity-gradle-plugin 3.0.0

com.google.guava:guava 33.3.0-jre

org.projectlombok:lombok 1.18.34

com.squareup.okhttp3:okhttp 4.12.0

com.squareup.okhttp3:logging-interceptor 4.12.0

commons-io:commons-io 2.16.1

org.springframework.cloud:spring-cloud-starter-bootstrap 4.1.4

org.springframework.cloud:spring-cloud-starter-openfeign 4.1.3

pl.touk:throwing-function 1.3

com.jayway.jsonpath:json-path 2.9.0

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

org.apache.commons:commons-lang3 3.17.0

commons-validator:commons-validator 1.9.0

com.github.hmcts:service-auth-provider-java-client 5.2.0

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

com.github.hmcts:ccd-case-document-am-client 1.59

com.github.hmcts:core-case-data-store-client 5.0.3

org.apache.httpcomponents:httpclient 4.5.14

com.fasterxml.jackson.dataformat:jackson-dataformat-yaml 2.17.2

org.springframework.security:spring-security-oauth2-resource-server 6.3.3

org.springframework.security:spring-security-oauth2-client 6.3.3

org.springframework.security:spring-security-oauth2-jose 6.3.3

org.springframework.security:spring-security-core 6.3.3

org.springframework.security:spring-security-config 6.3.3

io.github.openfeign:feign-httpclient 13.3

uk.gov.service.notify:notifications-java-client 5.2.0-RELEASE

org.apache.groovy:groovy 4.0.22

org.projectlombok:lombok 1.18.34

org.projectlombok:lombok 1.18.34

com.github.hmcts:fortify-client 1.4.4

com.github.gmazzo:okhttp-mock 2.0.0

org.mockito:mockito-core 5.13.0

org.mockito:mockito-junit-jupiter 5.13.0

org.junit.vintage:junit-vintage-engine 5.11.0

org.junit.jupiter:junit-jupiter-api 5.11.0

org.junit.jupiter:junit-jupiter-engine 5.11.0

org.apache.poi:poi 5.2.4

org.apache.poi:poi-ooxml 5.2.4

jakarta.xml.bind:jakarta.xml.bind-api 4.0.2

org.glassfish.jaxb:jaxb-runtime 4.0.5

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

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

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

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

org.junit.jupiter:junit-jupiter 5.11.0

com.github.hmcts:em-test-helper 2.0.8

xerces:xercesImpl 2.12.2

org.yaml:snakeyaml 2.3

ch.qos.logback:logback-classic 1.5.7

ch.qos.logback:logback-core 1.5.7

com.fasterxml.jackson.core:jackson-databind 2.17.2

com.fasterxml.jackson.core:jackson-annotations 2.17.2

com.fasterxml.jackson.core:jackson-core 2.17.2

org.junit.platform:junit-platform-commons 1.11.0

checkstyle 10.18.1

gradle-wrapper

gradle/wrapper/gradle-wrapper.properties

gradle 8.10

helm-requirements

charts/em-ccdorc/Chart.yaml

java 5.2.1

helm-values

charts/em-ccdorc/values.yaml

helmv3

charts/em-ccdorc/Chart.yaml

java 5.2.1

terraform

infrastructure/main.tf

infrastructure/state.tf

azuread 2.53.1

azurerm ~> 4.0.0

infrastructure/versions.tf

hashicorp/terraform >= 1.3

terraform-version

.terraform-version

hashicorp/terraform 1.9.5

infrastructure/.terraform-version

hashicorp/terraform 1.9.5

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

Dependabot couldn't authenticate with https://repo.spring.io/libs-snapshot

Dependabot couldn't authenticate with https://repo.spring.io/libs-snapshot.

You can provide authentication details in your Dependabot dashboard by clicking into the account menu (in the top right) and selecting 'Config variables'.

View the update logs.

Dependabot couldn't authenticate with https://repo.spring.io/libs-snapshot

Dependabot couldn't authenticate with https://repo.spring.io/libs-snapshot.

You can provide authentication details in your Dependabot dashboard by clicking into the account menu (in the top right) and selecting 'Config variables'.

View the update logs.

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Location: .github/renovate.json
Error type: Invalid JSON (parsing failed)
Message: Syntax error: expecting end of expression or separator near } "$sch

Dependabot couldn't authenticate with https://repo.spring.io/libs-snapshot

Dependabot couldn't authenticate with https://repo.spring.io/libs-snapshot.

You can provide authentication details in your Dependabot dashboard by clicking into the account menu (in the top right) and selecting 'Config variables'.

View the update logs.

Dependabot couldn't authenticate with https://repo.spring.io/libs-snapshot

Dependabot couldn't authenticate with https://repo.spring.io/libs-snapshot.

You can provide authentication details in your Dependabot dashboard by clicking into the account menu (in the top right) and selecting 'Config variables'.

View the update logs.

hmcts / em-ccd-orchestrator Goto Github PK

em-ccd-orchestrator's Introduction

EVIDENCE MANAGEMENT CCD Orchestrator

Setup

To clone repo and prepare to pull containers:

Clean and build the application:

To run the application:

Tech

Plugins

Swagger UI

API Endpoints

Automated Bundling Configuration Validation

Plugins

License

Check the build

Running contract or pact tests:

em-ccd-orchestrator's People

Contributors

Stargazers

Watchers

Forkers

em-ccd-orchestrator's Issues

Ignored or Blocked

Detected dependencies

Recommend Projects

Recommend Topics

Recommend Org