Skip to content

Latest commit

 

History

History
162 lines (103 loc) · 9.15 KB

startingUp.md

File metadata and controls

162 lines (103 loc) · 9.15 KB
Raw

Starting up and trying the whole thing

  • Author: Damir Murat
  • Created: 26.05.2020.
  • Updated: 17.11.2021.

Environment:

  • OSX (should work with any desktop Linux distro and with Windows with appropriate bash-shell like git-bash)
  • JDK 11 (should work with JDK 8)
  • Gradle 7.0.2
  • IDEA Ultimate 2021.2.3 (should work with IDEA Community except for http client which is part of the Ultimate edition)
  • Docker
  • httpie

Running from the shell

Open your shell at the project root and execute following commands (shell-1):

cd support/docker
./dockerComposeInfrastructureUp.sh

Open another shell (shell-2) at the project root and execute following command (generating Groovydoc is skipped to speed things up)

./gradlew clean assemble testClasses testIntegrationClasses testComponentClasses -x groovydoc --parallel

Open next shell (shell-3) where we will run cargotracker-booking-rdbms-management-app. It will migrate the database schema to the state expected by applications (it wraps flyway for implementing database migrations).

./gradlew -p cargotracker/cargotracker-booking-rdbms-management-app bootRun

We have three functional apps that needs to be run, and for each open a new shell at the project root (shell-3, shell-4 and shell-5 where shell-3 is reused from previous step)

./gradlew -p cargotracker/cargotracker-booking-commandside-app bootRun
./gradlew -p cargotracker/cargotracker-booking-queryside-rdbms-projection-app bootRun
./gradlew -p cargotracker/cargotracker-booking-queryside-app bootRun

Going back to shell-2, some HTTP requests can be tried via httpie:

  • commandside

    http POST http://localhost:8080/cargotracker-booking-commandside/cargo-booking/book-cargo \
  Content-Type:application/json Accept:application/json Accept-Charset:utf-8 Accept-Language:hr-HR \
  originLocation=NLRTM \
  destinationLocation=USNYC

http POST http://localhost:8080/cargotracker-booking-commandside/cargo-booking/book-cargo \
  Content-Type:application/json Accept:application/json Accept-Charset:utf-8 Accept-Language:en \
  originLocation=NLRTM \
  destinationLocation=USNYC

  • queryside

    To be able to execute queryside request, from the previous commandside output we need to take the value of cargoIdentifier element, and then try some queryside requests. For example:

    http POST http://localhost:8084/cargotracker-booking-queryside/cargo-info/cargo-summary \
  Content-Type:application/json Accept:application/json Accept-Charset:utf-8 Accept-Language:hr-HR \
  cargoIdentifier=9e4a13c8-cb74-4a01-9717-f41aaba5428d

http POST http://localhost:8084/cargotracker-booking-queryside/cargo-info/cargo-summary \
  Content-Type:application/json Accept:application/json Accept-Charset:utf-8 Accept-Language:en \
  cargoIdentifier=9e4a13c8-cb74-4a01-9717-f41aaba5428d

When finished experimenting, applications can be stopped by CTRL+C (shell-3, shell-4, shell-5). For stopping infrastructural components (shell-1), first we need to stop docker-compose log tailing by CTRL+C, and then do some cleanup with ./dockerComposeInfrastructureDown.sh.

Running from IDEA

Executing HTTP requests from CLI can be cumbersome, and many prefer some more user-friendly tool like Postman. If you develop from IDEA, you can also use IDEA's http client. Although it does not have all niceties of Postman it can be really useful for storing series of requests as code artifacts in the project.

First, the project needs to be imported in IDEA as Gradle project. Next, either from the IDEA terminal or from external shell, infrastructural components needs to be started:

cd support/docker
./dockerComposeInfrastructureUp.sh

Applications can also be started from CLI, but it might be preferable to use UI.

After starting up infrastructural services, we need to run a utility application for database schema migration:

Starting database migration from IDE

After migrating database schema, functional applications can be started in any order:

  • Start commandside app by double-clicking on its bootRun Gradle task and wait until it is started up:

    Starting commandside application from IDE

  • Start queryside projection app by double-clicking on its bootRun Gradle task and wait until it is started up:

    Starting projection application from IDE

  • Start queryside app by double-clicking on its bootRun Gradle task and wait until it is started up:

    Starting queryside application from IDE

When all applications are started up, we can try executing some requests:

  • Find and open support/http-request/commandsideRequests.http.

  • Click on Run All Requests in File and select Run with 'development' environment.

    Running IDEA HTTP client for executing commands

  • Repeat the same with support/http-request/querysideRequests.http.

When finished experimenting, applications can be stopped by CMD+F2 shortcut or via IDEA "Run" tool window. For stopping infrastructural components, stop docker-compose log tailing with CTRL+C, and then do some cleanup with ./dockerComposeInfrastructureDown.sh.

Supportive Gradle tasks

While working on a project, a developer often needs access to various pieces of information about the current state of a project. These reports might provide beneficial information about code quality and can point to the areas which require some attention and improvements. Project Klokwrk has a dozen of Gradle tasks that provide such information. They can be run for each individual project, or for a project root.

Before executing any of commands bellow, position your terminal prompt at the project's root:

  • ./gradlew test --parallel

    Executes all unit tests while providing convenient colored CLI output.

  • ./gradlew testIntegration --parallel

    Executes all Docker containerized integration tests (for more details, take a look at ADR-0010 - Integration Testing with Containerized Infrastructure).

  • ./gradlew testComponent --parallel

    Executes all Docker containerized component tests (for more details, take a look at ADR-0011 - Component Testing).

  • ./gradlew allTestReports

    Creates a cumulative report of all unit, integration and component tests for all subprojects. Report can be accessed via klokwrk-project/build/reports/allTestReports/index.html. It can be opened from IDEA using Open in Browser action.

    Opening All Tests report from IDEA

    Behind the scenes, IDEA uses an internal HTTP server, which is very convenient for looking at statically generated pages like these.

    Alternatively, you can open it from CLI with

    open build/reports/allTestReports/index.html

  • ./gradlew allTestUnitReports, gradlew allTestIntegrationReports, gradlew allTestComponentReports

    These commands create cumulative reports for each supported test type.

  • ./gradlew aggregateJacocoReport

    Creates a cumulative code coverage report accessible at klokwrk-project/build/reports/jacoco/aggregate/html/index.html

  • ./gradlew aggregateCodenarc

    Creates a cumulative CodeNarc report accessible at klokwrk-project/build/reports/codenarc/aggregate.html.

  • ./gradlew aggregateGroovydoc

    Creates a cumulative documentation for the whole project accessible at klokwrk-project/build/docs/aggregate-groovydoc/index.html.

Exploring Wavefront integration

Since the 2.3.0 version, Spring Boot provides out-of-the-box free integration with Wavefront observability service. It offers zero-setup and feature-rich alternative to the standard observability solutions like Prometheus (metrics collection), Zipkin (distributed tracing) and Grafana (visualization) combo. Wavefront is very convenient and effortless to use, even from a development environment.

Here is a very brief overview of Wavefront usage for a klokwrk-project: