Compare commits

...

No commits in common. "47d1525d82290ed93736345bf2ae9f27323e1301" and "1b91da0e3de671fd67d18453b5e02f54c4e0147b" have entirely different histories.

23 changed files with 1061 additions and 43 deletions

109
.cljstyle Normal file
View file

@ -0,0 +1,109 @@
;; cljstyle configuration
{:files
{:extensions #{"cljc" "cljs" "clj" "cljx" "edn"},
:ignore #{"checkouts" "dev" ".hg" "target" ".git" "mulog_publisher.clj"}},
:rules
{:namespaces
{:enabled? false,
:indent-size 2,
:break-libs? true,
:import-break-width 60},
:whitespace
{:enabled? true,
:remove-surrounding? true,
:remove-trailing? true,
:insert-missing? true},
:comments
{:enabled? true,
:inline-prefix " ", :leading-prefix "; "},
:functions {:enabled? true},
:eof-newline {:enabled? true},
:types
{:enabled? true,
:types? true,
:protocols? true,
:reifies? true,
:proxies? true},
:blank-lines
{:enabled? true,
:trim-consecutive? true,
:max-consecutive 2,
:insert-padding? false,
:padding-lines 2},
:indentation
{:enabled? true,
:list-indent 1,
:indents
{
#"^def" [[:inner 0]],
#"^with-" [[:inner 0]],
alt! [[:block 0]],
alt!! [[:block 0]],
are [[:block 2]],
as-> [[:block 1]],
binding [[:block 1]],
bound-fn [[:inner 0]],
case [[:block 1]],
catch [[:block 2]],
comment [[:block 0]],
cond [[:block 0]],
cond-> [[:block 1]],
cond->> [[:block 1]],
condp [[:block 2]],
def [[:inner 0]]},
defmacro [[:inner 0]],
defmethod [[:inner 0]],
defmulti [[:inner 0]],
defn [[:inner 0]],
defn- [[:inner 0]],
defonce [[:inner 0]],
defprotocol [[:block 1] [:inner 1]],
defrecord [[:block 1] [:inner 1]],
defstruct [[:block 1]],
deftest [[:inner 0]],
deftype [[:block 1] [:inner 1]],
do [[:block 0]],
doseq [[:block 1]],
dotimes [[:block 1]],
doto [[:block 1]],
extend [[:block 1]],
extend-protocol [[:block 1] [:inner 1]],
extend-type [[:block 1] [:inner 1]],
finally [[:block 0]],
fn [[:inner 0]],
for [[:block 1]],
future [[:block 0]],
go [[:block 0]],
go-loop [[:block 1]],
if [[:block 1]],
if-let [[:block 1]],
if-not [[:block 1]],
if-some [[:block 1]],
let [[:block 1]],
letfn [[:block 1] [:inner 2 0]],
locking [[:block 1]],
loop [[:block 1]],
match [[:block 1]],
ns [[:block 1]],
proxy [[:block 2] [:inner 1]],
reify [[:inner 0] [:inner 1]],
struct-map [[:block 1]],
testing [[:block 1]],
thread [[:block 0]],
thrown-with-msg? [[:block 2]],
thrown? [[:block 1]],
try [[:block 0]],
use-fixtures [[:inner 0]],
when [[:block 1]],
when-first [[:block 1]],
when-let [[:block 1]],
when-not [[:block 1]],
when-some [[:block 1]],
while [[:block 1]],
with-local-vars [[:block 1]],
with-open [[:block 1]],
with-out-str [[:block 0]],
with-precision [[:block 1]],
with-redefs [[:block 1]]}},
:vars
{:enabled? false}}}

2
.dir-locals.el Normal file
View file

@ -0,0 +1,2 @@
((clojure-mode . ((cider-preferred-build-tool . clojure-cli)
(cider-clojure-cli-aliases . ":test/env:dev/reloaded"))))

2
.envrc Normal file
View file

@ -0,0 +1,2 @@
export CLOJARS_USERNAME=$(gopass meissa/dev/clojars.org user)
export CLOJARS_PASSWORD=$(gopass show meissa/dev/clojars.org)

5
.gitattributes vendored Normal file
View file

@ -0,0 +1,5 @@
# Git Attributes
# reclassifies `.edn` as Clojure files for Linguist statistics
# https://github.com/github/linguist/blob/master/docs/overrides.md
**/*.edn linguist-language=Clojure

49
.gitignore vendored Normal file
View file

@ -0,0 +1,49 @@
# ------------------------
# Clojure Project Git Ignore file patterns
#
# Ignore all except patterns starting with !
# Add comments on separate lines, not same line as pattern
# ------------------------
# ------------------------
# Ignore everthing in root directory
/*
# ------------------------
# Common project files
!CHANGELOG.md
!README.md
!LICENSE
# ------------------------
# Include Clojure project & config
!build.clj
!deps.edn
!pom.xml
!dev/
!docs/
!resources/
!src/
!test/
# ------------------------
# Include Clojure tools
!.cljstyle
!.dir-locals.el
!compose.yaml
!Dockerfile
!.dockerignore
!Makefile
!tests.edn
!.envrc
# ------------------------
# Include Git & CI workflow
!.gitattributes
!.gitignore
!.github/
# ------------------------
# Include ClojureScript Figwheel
!figwheel-main.edn
!*.cljs.edn

1
CHANGELOG.md Normal file
View file

@ -0,0 +1 @@
#

176
LICENSE
View file

@ -6,57 +6,185 @@ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions. 1. Definitions.
"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. "Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: 4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices stating that You changed the files; and (b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. (d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. 9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work. APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner] Copyright [yyyy] [name of copyright owner]

181
Makefile Normal file
View file

@ -0,0 +1,181 @@
# ------------------------------------------
# Makefile
#
# Consistent set of targets to support local development of Clojure
# and build the Clojure service during CI deployment
#
# Requirements
# - cljstyle
# - Clojure CLI aliases
# - `:env/dev` to include `dev` directory on class path
# - `:env/test` to include `test` directory and libraries to support testing
# - `:test/run` to run kaocha kaocha test runner and supporting paths and dependencies
# - `:repl/rebel` to start a Rebel terminal UI
# - `:package/uberjar` to create an uberjar for the service
# - docker
# - mega-linter-runner
# ------------------------------------------
# .PHONY: ensures target used rather than matching file name
# https://makefiletutorial.com/#phony
.PHONY: all lint deps dist install deploy pre-commit-check repl test test-ci test-watch clean
# ------- Makefile Variables --------- #
# run help if no target specified
.DEFAULT_GOAL := help
# Column the target description is printed from
HELP-DESCRIPTION-SPACING := 24
# Tool variables
MEGALINTER_RUNNER = npx mega-linter-runner --flavor java --env "'MEGALINTER_CONFIG=.github/config/megalinter.yaml'" --remove-container
CLOJURE_TEST_RUNNER = clojure -M:test/env:test/run
CLOJURE_EXEC_TEST_RUNNER = clojure -X:test/env:test/run
# Makefile file and directory name wildcard
# EDN-FILES := $(wildcard *.edn)
# ------------------------------------ #
# ------- Help ----------------------- #
# Source: https://nedbatchelder.com/blog/201804/makefile_help_target.html
help: ## Describe available tasks in Makefile
@grep '^[a-zA-Z]' $(MAKEFILE_LIST) | \
sort | \
awk -F ':.*?## ' 'NF==2 {printf "\033[36m %-$(HELP-DESCRIPTION-SPACING)s\033[0m %s\n", $$1, $$2}'
# ------------------------------------ #
# ------- Clojure Development -------- #
repl: ## Run Clojure REPL with rich terminal UI (Rebel Readline)
$(info --------- Run Rebel REPL ---------)
clojure -M:test/env:repl/reloaded
deps: deps.edn ## Prepare dependencies for test and dist targets
$(info --------- Download test and service libraries ---------)
clojure -P -X:build
dist: build-uberjar ## Build and package Clojure service
$(info --------- Build and Package Clojure service ---------)
install: build-jar
$(info --------- install library jar ---------)
clojure -T:build install
deploy: build-jar
$(info --------- install library jar ---------)
clojure -T:build deploy
publish: build-jar
$(info --------- Build and Package Clojure lib ---------)
# Remove files and directories after build tasks
# `-` before the command ignores any errors returned
clean: ## Clean build temporary files
$(info --------- Clean Clojure classpath cache ---------)
- rm -rf ./.cpcache ./.clj-kondo ./.lsp
# ------------------------------------ #
# ------- Testing -------------------- #
test-config: ## Print Kaocha test runner configuration
$(info --------- Runner Configuration ---------)
$(CLOJURE_TEST_RUNNER) --print-config
test-profile: ## Profile unit test speed, showing 3 slowest tests
$(info --------- Runner Profile Tests ---------)
$(CLOJURE_TEST_RUNNER) --plugin kaocha.plugin/profiling
test: ## Run unit tests - stoping on first error
$(info --------- Runner for unit tests ---------)
$(CLOJURE_EXEC_TEST_RUNNER)
test-all: ## Run all unit tests regardless of failing tests
$(info --------- Runner for all unit tests ---------)
$(CLOJURE_EXEC_TEST_RUNNER) :fail-fast? false
test-watch: ## Run tests when changes saved, stopping test run on first error
$(info --------- Watcher for unit tests ---------)
$(CLOJURE_EXEC_TEST_RUNNER) :watch? true
test-watch-all: ## Run all tests when changes saved, regardless of failing tests
$(info --------- Watcher for unit tests ---------)
$(CLOJURE_EXEC_TEST_RUNNER) :fail-fast? false :watch? true
# ------------------------------------ #
# -------- Build tasks --------------- #
build-config: ## Pretty print build configuration
$(info --------- View current build config ---------)
clojure -T:build config
build-jar: ## Build a jar archive of Clojure project
$(info --------- Build library jar ---------)
clojure -T:build jar
build-uberjar: ## Build a uberjar archive of Clojure project & Clojure runtime
$(info --------- Build service Uberjar ---------)
clojure -T:build uberjar
build-clean: ## Clean build assets or given directory
$(info --------- Clean Build ---------)
clojure -T:build clean
# ------------------------------------ #
# ------- Code Quality --------------- #
pre-commit-check: format-check lint test ## Run format, lint and test targets
format-check: ## Run cljstyle to check the formatting of Clojure code
$(info --------- cljstyle Runner ---------)
cljstyle check
format-fix: ## Run cljstyle and fix the formatting of Clojure code
$(info --------- cljstyle Runner ---------)
cljstyle fix
lint: ## Run MegaLinter with custom configuration (node.js required)
$(info --------- MegaLinter Runner ---------)
$(MEGALINTER_RUNNER)
lint-fix: ## Run MegaLinter with applied fixes and custom configuration (node.js required)
$(info --------- MegaLinter Runner ---------)
$(MEGALINTER_RUNNER) --fix
lint-clean: ## Clean MegaLinter report information
$(info --------- MegaLinter Clean Reports ---------)
- rm -rf ./megalinter-reports
# ------------------------------------ #
# ------- Docker Containers ---------- #
docker-build: ## Build Clojure project and run with docker compose
$(info --------- Docker Compose Build ---------)
docker compose up --build --detach
docker-build-clean: ## Build Clojure project and run with docker compose, removing orphans
$(info --------- Docker Compose Build - remove orphans ---------)
docker compose up --build --remove-orphans --detach
docker-down: ## Shut down containers in docker compose
$(info --------- Docker Compose Down ---------)
docker compose down
swagger-editor: ## Start Swagger Editor in Docker
$(info --------- Run Swagger Editor at locahost:8282 ---------)
docker compose -f swagger-editor.yml up -d swagger-editor
swagger-editor-down: ## Stop Swagger Editor in Docker
$(info --------- Run Swagger Editor at locahost:8282 ---------)
docker compose -f swagger-editor.yml down
# ------------------------------------ #
# ------ Continuous Integration ------ #
# .DELETE_ON_ERROR: halts if command returns non-zero exit status
# https://makefiletutorial.com/#delete_on_error
# TODO: focus runner on ^:integration` tests
test-ci: deps ## Test runner for integration tests
$(info --------- Runner for integration tests ---------)
clojure -P -X:test/env:test/run
# Run tests, build & package the Clojure code and clean up afterward
# `make all` used in Docker builder stage
.DELETE_ON_ERROR:
all: test-ci dist clean ## Call test-ci dist and clean targets, used for CI
# ------------------------------------ #

View file

@ -1,2 +1 @@
# build #

117
build.clj Normal file
View file

@ -0,0 +1,117 @@
;; ---------------------------------------------------------
;; Build Script
;;
;; Build project and package for deployment
;; - `uberjar` - packaged application for deployment
;; - `clean` remove all build assets and jar files
;;
;; All functions are passed command line arguments
;; - `nil` is passed if there are no arguments
;;
;;
;; tools.build API commands
;; - `create-basis` create a project basis
;; - `copy-dir` copy Clojure source and resources into a working dir
;; - `compile-clj` compile Clojure source code to classes
;; - `delete` - remove path from file space
;; - `write-pom` - write pom.xml and pom.properties files
;; - `jar` - to jar up the working dir into a jar file
;;
;; ---------------------------------------------------------
(ns build
(:require
[clojure.tools.build.api :as build-api]
[clojure.edn :as edn]
[clojure.pprint :as pprint]))
;; ---------------------------------------------------------
;; Project configuration
(def project-config
"Project configuration to support all tasks"
(-> (edn/read-string (slurp "deps.edn"))
:project
(merge
{:class-directory "target/classes"
:project-basis (build-api/create-basis)
:main-namespace 'org.domaindrivenarchitecture/build})))
(defn config
"Display build configuration"
[config]
(pprint/pprint (or config project-config)))
;; End of Build configuration
;; ---------------------------------------------------------
;; ---------------------------------------------------------
;; Build tasks
(defn clean
"Remove a directory
- `:path '\"directory-name\"'` for a specific directory
- `nil` (or no command line arguments) to delete `target` directory
`target` is the default directory for build artefacts
Checks that `.` and `/` directories are not deleted"
[directory]
(when
(not (contains? #{"." "/"} directory))
(build-api/delete {:path (or (:path directory) "target")})))
(defn jar [_]
(let [{:keys [name version project-basis class-directory license]} project-config
jar-file (format "target/%s-%s.jar" name version)]
(clean "target")
(build-api/write-pom {:class-dir class-directory
:lib name
:version version
:basis project-basis
:src-dirs ["src"]})
(build-api/copy-dir {:src-dirs ["src" "resources"]
:target-dir class-directory})
(build-api/jar {:class-dir class-directory
:jar-file jar-file})))
(defn install [_]
(let [{:keys [name version project-basis class-directory]} project-config
jar-file (format "target/%s-%s.jar" name version)]
(build-api/install {:basis project-basis
:lib name
:version version
:jar-file jar-file
:class-dir class-directory})))
(defn deploy [opts]
(let [{:keys [name version class-directory]} project-config
jar-file (format "target/%s-%s.jar" name version)]
((requiring-resolve 'deps-deploy.deps-deploy/deploy)
(merge {:installer :remote
:artifact jar-file
:pom-file (build-api/pom-path {:lib name :class-dir class-directory})}
opts))
opts))
(defn uberjar
"Create an archive containing Clojure and the build of the project
Merge command line configuration to the default project config"
[options]
(let [config (merge project-config options)
{:keys [class-directory name main-namespace project-basis class-directory]} project-config
uberjar-file (str "target/" name "-standalone.jar")]
(clean "target")
(build-api/copy-dir {:src-dirs ["src" "resources"]
:target-dir class-directory})
(build-api/compile-clj {:basis project-basis
:class-dir class-directory
:src-dirs ["src"]})
(build-api/uber {:basis project-basis
:class-dir class-directory
:main main-namespace
:uber-file uberjar-file})))
;; End of Build tasks
;; ---------------------------------------------------------

42
deps.edn Normal file
View file

@ -0,0 +1,42 @@
{:project {:name org.domaindrivenarchitecture/build
:version "0.1.0"}
:paths
["src" "resources"]
:deps
{org.clojure/clojure {:mvn/version "1.11.1"}
org.clojure/spec.alpha {:mvn/version "0.4.233"}
orchestra/orchestra {:mvn/version "2021.01.01-1"}}
:aliases
{;; Clojure.main execution of application
:run/app
{:main-opts ["-m" "practicalli.playground"]}
;; Clojure.exec execution of specified function
:run/greet
{:exec-fn practicalli.playground/greet
:exec-args {:name "Clojure"}}
;; Add libraries and paths to support additional test tools
:test/env
{}
;; Test runner - local and CI
;; call with :watch? true to start file watcher and re-run tests on saved changes
:test/run
{:extra-paths ["test"]
:extra-deps {lambdaisland/kaocha {:mvn/version "1.87.1366"}}
:main-opts ["-m" "kaocha.runner"]
:exec-fn kaocha.runner/exec-fn
:exec-args {:randomize? false
:fail-fast? true}}
;; tools.build `build.clj` built script
:build
{:replace-paths ["."]
:replace-deps {io.github.clojure/tools.build
{:git/tag "v0.10.5" :git/sha "2a21b7a"}}
:extra-deps {slipset/deps-deploy {:mvn/version "0.2.2"}}
:ns-default build}}}

55
dev/mulog_events.clj Normal file
View file

@ -0,0 +1,55 @@
;; ---------------------------------------------------------
;; Mulog Global Context and Custom Publisher
;;
;; - set event log global context
;; - tap publisher for use with Portal and other tap sources
;; - publish all mulog events to Portal tap source
;; ---------------------------------------------------------
(ns mulog-events
(:require
[com.brunobonacci.mulog :as mulog]
[com.brunobonacci.mulog.buffer :as mulog-buffer]))
;; ---------------------------------------------------------
;; Set event global context
;; - information added to every event for REPL workflow
(mulog/set-global-context! {:app-name "playground Service",
:version "0.1.0", :env "dev"})
;; ---------------------------------------------------------
;; ---------------------------------------------------------
;; Mulog event publishing
(deftype TapPublisher
[buffer transform]
com.brunobonacci.mulog.publisher.PPublisher
(agent-buffer [_] buffer)
(publish-delay [_] 200)
(publish [_ buffer]
(doseq [item (transform (map second (mulog-buffer/items buffer)))]
(tap> item))
(mulog-buffer/clear buffer)))
#_{:clj-kondo/ignore [:unused-private-var]}
(defn ^:private tap-events
[{:keys [transform] :as _config}]
(TapPublisher. (mulog-buffer/agent-buffer 10000) (or transform identity)))
(def tap-publisher
"Start mulog custom tap publisher to send all events to Portal
and other tap sources
`mulog-tap-publisher` to stop publisher"
(mulog/start-publisher!
{:type :custom, :fqn-function "mulog-events/tap-events"}))
#_{:clj-kondo/ignore [:unused-public-var]}
(defn stop
"Stop mulog tap publisher to ensure multiple publishers are not started
Recommended before using `(restart)` or evaluating the `user` namespace"
[]
tap-publisher)
;; Example mulog event message
;; (mulog/log ::dev-user-ns :message "Example event message" :ns (ns-publics *ns*))
;; ---------------------------------------------------------

24
dev/portal.clj Normal file
View file

@ -0,0 +1,24 @@
(ns portal
(:require
;; Data inspector
[portal.api :as inspect]))
;; ---------------------------------------------------------
;; Start Portal and capture all evaluation results
;; Open Portal window in browser with dark theme
;; https://cljdoc.org/d/djblue/portal/0.37.1/doc/ui-concepts/themes
;; Portal options:
;; - light theme {:portal.colors/theme :portal.colors/solarized-light}
;; - dark theme {:portal.colors/theme :portal.colors/gruvbox}
(def instance
"Open portal window if no portal sessions have been created.
A portal session is created when opening a portal window"
(or (seq (inspect/sessions))
(inspect/open {:portal.colors/theme :portal.colors/gruvbox})))
;; Add portal as tapsource (add to clojure.core/tapset)
(add-tap #'portal.api/submit)
;; ---------------------------------------------------------

107
dev/user.clj Normal file
View file

@ -0,0 +1,107 @@
;; ---------------------------------------------------------
;; REPL workflow development tools
;;
;; Include development tool libraries vai aliases from practicalli/clojure-cli-config
;; Start Rich Terminal UI REPL prompt:
;; `clojure -M:repl/reloaded`
;;
;; Or call clojure jack-in from an editor to start a repl
;; including the `:dev/reloaded` alias
;; - alias included in the Emacs `.dir-locals.el` file
;; ---------------------------------------------------------
(ns user
"Tools for REPL Driven Development"
(:require
;; REPL Workflow
[mulog-events] ; Event Logging
[com.brunobonacci.mulog :as mulog] ; Global context & Tap publisher
[portal]
[portal.api :as inspect] ; Data inspector
[clojure.tools.namespace.repl :as namespace]))
;; ---------------------------------------------------------
;; Help
(println "---------------------------------------------------------")
(println "Loading custom user namespace tools...")
(println "---------------------------------------------------------")
(defn help
[]
(println "---------------------------------------------------------")
(println "Namesapece Management:")
(println "(namespace/refresh) ; refresh all changed namespaces")
(println "(namespace/refresh-all) ; refresh all namespaces")
(println)
(println "Hotload libraries: ; Clojure 1.12.x")
(println "(add-lib 'library-name)")
(println "(add-libs '{domain/library-name {:mvn/version \"v1.2.3\"}})")
(println "(sync-deps) ; load dependencies from deps.edn")
(println "- deps-* lsp snippets for adding library")
(println)
(println "Portal Inspector:")
(println "- portal started by default, listening to all evaluations")
(println "(inspect/clear) ; clear all values in portal")
(println "(remove-tap #'inspect/submit) ; stop sending to portal")
(println "(inspect/close) ; close portal")
(println)
(println "(help) ; print help text")
(println "---------------------------------------------------------"))
(help)
;; End of Help
;; ---------------------------------------------------------
;; ---------------------------------------------------------
;; Avoid reloading `dev` code
;; - code in `dev` directory should be evaluated if changed to reload into repl
(println
"Set REPL refresh directories to "
(namespace/set-refresh-dirs "src" "resources"))
;; ---------------------------------------------------------
;; ---------------------------------------------------------
;; Mulog event logging
;; `mulog-publisher` namespace used to launch tap> events to tap-source (portal)
;; and set global context for all events
;; Example mulog event message
(mulog/log ::dev-user-ns
:message "Example event from user namespace"
:ns (ns-publics *ns*))
;; ---------------------------------------------------------
;; ---------------------------------------------------------
;; Hotload libraries into running REPL
;; `deps-*` LSP snippets to add dependency forms
(comment
;; Require for Clojure 1.11.x and earlier
(require '[clojure.tools.deps.alpha.repl :refer [add-libs]])
(add-libs '{domain/library-name {:mvn/version "1.0.0"}})
;; Clojure 1.12.x only
#_(add-lib 'library-name) ; find and add library
#_(sync-deps) ; load dependencies in deps.edn (if not yet loaded)
#_()) ; End of rich comment
;; ---------------------------------------------------------
;; ---------------------------------------------------------
;; Portal Data Inspector
(comment
;; Open a portal inspector in browser window - light theme
;; (inspect/open {:portal.colors/theme :portal.colors/solarized-light})
(inspect/clear) ; Clear all values in portal window (allows garbage collection)
(remove-tap #'inspect/submit) ; Remove portal from `tap>` sources
(inspect/close) ; Close the portal window
(inspect/docs) ; View docs locally via Portal
#_()) ; End of rich comment
;; ---------------------------------------------------------

8
pom.xml Normal file
View file

@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<licenses>
<license>
<name>Apache License, Version 2.0</name>
<url>https://www.apache.org/licenses/LICENSE-2.0.html</url>
</license>
</licenses>
</project>

19
src/dda/build/devops.clj Normal file
View file

@ -0,0 +1,19 @@
(ns dda.build.devops
(:require
[clojure.spec.alpha :as s]
[dda.build.devops.domain :as domain]))
(s/def ::name ::domain/name)
(s/def ::module ::domain/module)
(s/def ::stage ::domain/stage)
(s/def ::project-root-path ::domain/project-root-path)
(s/def ::build-dir-name ::domain/build-dir-name)
(s/def ::devops
(s/keys :req-un [::name]
:opt-un [::module ::stage ::project-root-path ::build-dir-name]))
(def default {:name "dda-backup"
:project-root-path "."
:build-dir-name "target"
:stage "dev"})

View file

@ -0,0 +1,35 @@
(ns dda.build.devops.domain
(:require
[clojure.string :as str]
[clojure.spec.alpha :as s]
[orchestra.core :refer [defn-spec]]))
(s/def ::name string?)
(s/def ::module string?)
(s/def ::stage string?)
(s/def ::project-root-path string?)
(s/def ::build-dir-name string?)
(s/def ::devops
(s/keys :req-un [::name ::stage ::project-root-path ::build-dir-name]
:opt-un [::module]))
(defn-spec build-path string?
[devops ::devops]
(let
[{:keys [project-root-path build-dir-name name module]} devops]
(str/join
"/"
(filter
some?
[project-root-path build-dir-name name module]))))
(defn-spec clean-build-dir-command seq?
[devops ::devops]
(let [{:keys [name]} devops]
["rm" "-rf" (build-path devops)]))
(defn-spec create-build-dir-command seq?
[devops ::devops]
(let [{:keys [name]} devops]
["mkdir" "-p" (build-path devops)]))

17
src/dda/build/image.clj Normal file
View file

@ -0,0 +1,17 @@
(ns dda.build.image
(:require [orchestra.core :refer [defn-spec]]
[babashka.tasks :as t]
[dda.build.devops :as d]
[dda.build.devops.domain :as dd]
[dda.build.image.domain :as domain]))
(def default
(merge d/default {}))
(defn-spec dbuild nil?
[devops ::d/devops]
(let [final (merge default devops)]
(apply t/shell (dd/clean-build-dir-command final))
(apply t/shell (dd/create-build-dir-command final))
(apply t/shell (domain/copy-image-command final))
(apply t/shell (domain/dbuild-command final))))

View file

@ -0,0 +1,16 @@
(ns dda.build.image.domain
(:require [clojure.spec.alpha :as s]
[orchestra.core :refer [defn-spec]]
[dda.build.devops.domain :as d]))
(defn-spec copy-image-command seq?
[devops ::d/devops]
(let [{:keys [name]} devops]
["cp" "-r" "image" (d/build-path devops)]))
(defn-spec dbuild-command seq?
[devops ::d/devops]
(let [{:keys [name]} devops]
["docker" "build" "-t" name "--file"
(str (d/build-path devops) "/image/Dockerfile")
(str (d/build-path devops) "/image")]))

View file

@ -0,0 +1,17 @@
(ns dda.build.terragrunt
(:require [orchestra.core :refer [defn-spec]]
[babashka.tasks :as t]
[dda.build.devops :as d]
[dda.build.devops.domain :as dd]
[dda.build.terragrunt.domain :as dterra]))
(def default
(merge d/default {}))
(defn-spec plan nil?
[devops ::d/devops]
(let [final (merge default devops)]
(apply t/shell (dd/clean-build-dir-command final))
(apply t/shell (dd/create-build-dir-command final))
(apply t/shell (dterra/copy-terragrunt-command final))
(apply t/shell (dterra/plan-command final))))

View file

@ -0,0 +1,40 @@
(ns dda.build.devops.domain-test
(:require
[clojure.test :refer [deftest is are testing run-tests]]
[clojure.spec.test.alpha :as st]
[dda.build.devops.domain :as cut]))
(st/instrument `cut/build-path)
(st/instrument `cut/create-build-dir-command)
(deftest should-calculate-build-path
(is (= "../../target/dda-backup"
(cut/build-path {:name "dda-backup"
:project-root-path "../.."
:build-dir-name "target"
:version "4.11.8-dev"
:stage "dev"})))
(is (= "../../target/dda/backup"
(cut/build-path {:name "dda"
:module "backup"
:project-root-path "../.."
:build-dir-name "target"
:version "4.11.8-dev"
:stage "dev"}))))
(deftest should-calculate-clean-build-dir-command
(is (= ["rm" "-rf" "../../target/dda-backup"]
(cut/clean-build-dir-command {:name "dda-backup"
:project-root-path "../.."
:build-dir-name "target"
:version "4.11.8-dev"
:stage "dev"}))))
(deftest should-calculate-create-build-dir-command
(is (= ["mkdir" "-p" "../../target/dda-backup"]
(cut/create-build-dir-command {:name "dda-backup"
:project-root-path "../.."
:build-dir-name "target"
:version "4.11.8-dev"
:stage "dev"}))))

View file

@ -0,0 +1,32 @@
(ns dda.build.image.domain-test
(:require
[clojure.test :refer [deftest is are testing run-tests]]
[clojure.spec.test.alpha :as st]
[dda.build.image.domain :as cut]))
(st/instrument `cut/copy-image-command)
(st/instrument `cut/dbuild-command)
(deftest should-calculate-copy-image-command
(is (= ["cp" "-r" "image" "../../target/dda-backup"]
(cut/copy-image-command {:name "dda-backup"
:project-root-path "../.."
:build-dir-name "target"
:version "4.11.8-dev"
:stage "dev"}))))
(deftest should-calculate-dbuild-command
(is (= ["docker"
"build"
"-t"
"dda-backup"
"--file"
"../../target/dda-backup/image/Dockerfile"
"../../target/dda-backup/image"]
(cut/dbuild-command {:name "dda-backup"
:project-root-path "../.."
:build-dir-name "target"
:version "4.11.8-dev"
:stage "dev"}))))

13
tests.edn Normal file
View file

@ -0,0 +1,13 @@
;; ---------------------------------------------------------
;; Kaocha test runner configuration
;;
;; Default configuration
;; - show current config using either command:
;;
;; make test-config
;;
;; clojure -M:test/env:test/run --print-config
;; ---------------------------------------------------------
#kaocha/v1 {}