master
branchmaster
branchKetrew depends on
nonstd
: nano-library providing a portable extract of Core_kernel
pvem
: error monaddocout
: logging with smart-print
sosa
: String module/functorpvem_lwt_unix
: Lwt_unix
wrapped in a Pvem.t
(error monad) with more
precise error types.uri
: parse RFC-3986-compliant URIs
(uri
itself depends on camlp4
).cmdliner
: command line parsingppx_deriving_yojson
, ppx_deriving
, yojson
: JSON
parsing/printing and other code generationcohttp.lwt
, ssl
, and conduit
: HTTP server and clientfindlib
+ dynlink
: dynamic loading of plugins postgresql
: Ketrew uses a PostgreSQL database.js_of_ocaml
, tyxml
(with reactiveData
)and uses the omake
as a build system and the tool ocamlify
.
At runtime, Ketrew may use an ssh
client (tested only with OpenSSH; but SSH
calls are quite configurable).
Then you may setup and build the libraries and ketrew
the command line
application:
omake
to build also all the tests, use:
omake build-all
Ketrew is installed with:
omake install BINDIR=/path/to/bin
(it will use ocamlfind
to install the library and copy the executable to
BINDIR
).
There is also an opam
file in the repository:
opam pin add ketrew .
will pick it (Opam ≥ 1.2.0).
The documentation depends on oredoc:
omake doc
and check-out _doc/<branch>/index.html
(unless branch is master
, then
_doc/index.html
).
Simply,
omake .merlin
Run the tests like this:
export KETREW_TEST_DB="postgresql://example.com/?password=somepassword"
./ketrew-test [-no-color] <Test-names>
where a Test-names
is one or more of
ALL
all of the following.basic-test
automaton-graph
cli
TestThe workflow examples in the documentation
are actually interactive tests (cf. ./ketrew-workflow-examples-test
).
The build-system creates a plugin and a workflow which uses it:
In order to not impact a potential “global” installation of Ketrew, one can use:
omake test-env
### Preparing Test Environment
Docker ketrew_postgres already running
Using package lwt.react as findlin-plugin
Creating cert-key pair: _test_env/test-cert.pem, _test_env/test-key.pem
Creating _test_env/configuration.ml
Creating _test_env/test-authorized-tokens
Creating _test_env/env.env
The command creates the directory _test_env/
with a preconfigured
test-environment (a self-signed SSL certificate/key pair,
client/server configuration file, an “authorization-tokens”
configuration, … which all work together harmoniously).
It also uses docker
to start a PostgreSQL server daemon unless it is already
running; to stop it use docker kill ketrew_postgres
.
Sourcing _test_env/env.env
will give a few aliases to run the tests.
kserver
: the server ketrew
application.rokserver
: the server ketrew
application but running in “read-only” mode.kclient
: the client ketrew
application (talking to a kdserver
instance).ktest
: the cli
test with a client configuration file._test_env/env.env
for more.The URL to the postgres DB is also stored in KETREW_TEST_DB
.
To generate coverage reports you need to instrument the code by
recompiling from scratch using the environment variable
WITH_BISECT
equal to true
:
omake clean
WITH_BISECT=true omake
Running the instrumented versions of the code will generate bisect*.out
files
when run.
Then, omake bisect-report
will take these files
and generate an html file in _report_dir/index.html
. omake bisect-clean
removes the reports and _report_dir
.
To remove the instrumentation just use omake clean; omake
without
WITH_BISECT
set to true
.
Note that the Web-UI does not work when the code has been instrumented with
Bisect (You'll see errors in the JS-Console: “caml_mutex_new
not
implemented”).
In order to test the WebUI in more adverse conditions, the server can be asked to answer HTTP queries artificially slow:
KETREW_DEBUG_SLOW_SERVER=1.,0.5 kdserver start
The 2 floating-point numbers x,y
mean that, at each HTTP request, the server
will pause for Random.float x +. y
seconds.
Once we are somewhat happy about the state of the master
branch (tests,
documentation, issues that went into the “next release”
milestone), this is the
release workflow:
trakeva
,
sosa
, etc.).OMakeroot
README.md
file for the particular
version.ketrew.x.y.z
(put the change-log there, see
releases documentation).OCamlPro/opam-publish
doc.x,y,z
long-living
branch).