Clojure Microservice Boilerplate: Components, Reitit, Pedestal, Schema, Postgresql and Tests
-
microservice-boilerplate: An example of how use the boilerplate, it's a simple btc wallet that fetch the current btc price in USD and you can check your transaction history, do deposits and withdrawals.
-
parenthesin/components: Helpers and component wrappers to give a foundation to create new services in clojure, you can find components for database, http, webserver and tools for db migrations.
| Verb | URL | Description |
|---|---|---|
| GET | /wallet/history | get all wallet entries and current total |
| POST | /wallet/deposit | do a deposit in btc in the wallet |
| POST | /wallet/withdrawal | do a withdrawal in btc in the wallet if possible |
To open a nrepl
clj -M:nreplTo open a nrepl with all test extra-deps on it
clj -M:test:nreplTo run unit tests inside ./test/unit
clj -M:test :unitTo run integration tests inside ./test/integration
clj -M:test :integrationTo run all tests inside ./test
clj -M:testTo generate a coverage report
clj -M:test --plugin kaocha.plugin/cloverageclj -M:clojure-lsp format
clj -M:clojure-lsp clean-ns
clj -M:clojure-lsp diagnosticsTo create a new migration with a name
clj -M:migratus create migration-nameTo execute all pending migrations
clj -M:migratus migrationTo rollback the latest migration
clj -M:migratus rollbackSee Migratus Usage for documentation on each command.
Start containers with postgres user: postgres, password: postgres, hostname: db, port: 5432
and pg-admin email: pg@pg.cc, password: pg, port: 5433
docker-compose -f docker/docker-compose.yml up -dStop containers
docker-compose -f docker/docker-compose.yml stopFirst you need to have the database running, for this you can use the docker command in the step above.
You can start a repl open and evaluate the file src/microservice_boilerplate/server.clj and execute following code:
(start-system! (build-system-map))You can generate an uberjar and execute it via java in the terminal:
# genarate a target/service.jar
clj -T:build uberjar
# execute it via java
java -jar target/service.jar- schema Types and Schemas
- component System Lifecycle and Dependencies
- pedestal Http Server
- reitit Http Routes System
- clj-http Http Client
- cheshire JSON encoding
- aero Configuration file and enviroment variables manager
- timbre Logging library
- next-jdbc JDBC-based layer to access databases
- hikaricp A solid, high-performance, JDBC connection pool at last
- tools.build Clojure builds as Clojure programs
- kaocha Test runner
- kaocha-cloverage Kaocha plugin for code coverage reports
- schema-generators Data generation and generative testing
- state-flow Testing framework for integration tests
- matcher-combinators Assertions in data structures
- pg-embedded-clj Embedded PostgreSQL for integration tests
- clojure-lsp Code Format, Namespace Check and Diagnosis
./
├── .clj-kondo -- clj-kondo configuration and classes
├── .lsp -- clojure-lsp configuration
├── .github
│ └── workflows -- Github workflows folder.
├── docker -- docker and docker-compose files for the database
├── resources -- Application resources assets folder and configuration files.
│ └── migrations -- Current database schemas, synced on service startup.
├── src -- Library source code and headers.
│ └── microservice_boilerplate -- Source for the service example (wallet).
└── test -- Test source code.
├── integration -- Integration tests source (uses state-flow).
│ └── microservice_boilerplate -- Tests for service example (wallet).
└── unit -- Unity tests source (uses clojure.test).
└── microservice_boilerplate -- Tests for service example (wallet).
This is free and unencumbered software released into the public domain.
For more information, please refer to http://unlicense.org