update UserManual for 0.6

As implemented in #36

CMakeLists.txt

@@ -58,7 +58,7 @@ add_custom_command(OUTPUT laminar.capnp.c++ laminar.capnp.h
 
 # Zip and compile statically served resources
 generate_compressed_bins(${CMAKE_SOURCE_DIR}/src/resources index.html js/app.js
-    favicon.ico favicon-152.png icon.png tick.gif cross.gif spin.gif)
+    favicon.ico favicon-152.png icon.png)
 
 # Download 3rd-party frontend JS libs...
 file(DOWNLOAD https://cdnjs.cloudflare.com/ajax/libs/vue/2.3.4/vue.min.js
@@ -88,6 +88,16 @@ target_link_libraries(laminard capnp-rpc capnp kj-async kj pthread boost_filesys
 add_executable(laminarc src/client.cpp laminar.capnp.c++)
 target_link_libraries(laminarc capnp-rpc capnp kj-async kj pthread)
 
+## Tests
+set(BUILD_TESTS FALSE CACHE BOOL "Build tests")
+if(BUILD_TESTS)
+    find_package(GTest REQUIRED)
+    include_directories(${GTEST_INCLUDE_DIRS} src)
+    add_executable(laminar-tests src/conf.cpp src/database.cpp src/laminar.cpp src/run.cpp src/server.cpp laminar.capnp.c++ src/resources.cpp ${COMPRESSED_BINS} test/test-conf.cpp test/test-database.cpp test/test-laminar.cpp test/test-run.cpp test/test-server.cpp)
+    target_link_libraries(laminar-tests ${GTEST_BOTH_LIBRARIES} gmock capnp-rpc capnp kj-async kj pthread boost_filesystem boost_system sqlite3 z)
+endif()
+
+set(SYSTEMD_UNITDIR /lib/systemd/system CACHE PATH "Path to systemd unit files")
 install(TARGETS laminard laminarc RUNTIME DESTINATION usr/bin)
-install(FILES laminar.service DESTINATION usr/lib/systemd/system)
+install(FILES laminar.service DESTINATION ${SYSTEMD_UNITDIR})
 install(FILES laminar.conf DESTINATION etc)

README.md

@@ -1,14 +1,14 @@
 # Laminar CI
 
-[Laminar](http://laminar.ohwg.net) is a lightweight and modular Continuous Integration service for Linux. It is self-hosted and developer-friendly, eschewing a configuration web UI in favor of simple version-controllable configuration files and scripts.
+Laminar (http://laminar.ohwg.net) is a lightweight and modular Continuous Integration service for Linux. It is self-hosted and developer-friendly, eschewing a configuration UI in favor of simple version-controllable configuration files and scripts.
 
 Laminar encourages the use of existing GNU/Linux tools such as `bash` and `cron` instead of reinventing them.
 
-Although the status and progress front-end is very user-friendly, administering a Laminar instance requires writing shell scripts and manually editing configuration files. That being said, there is nothing esoteric here and the tutorial below should be straightforward for anyone with even very basic Linux server administration experience.
+Although the status and progress front-end is very user-friendly, administering a Laminar instance requires writing shell scripts and manually editing configuration files. That being said, there is nothing esoteric here and the [guide](http://laminar.ohwg.net/docs.html) should be straightforward for anyone with even very basic Linux server administration experience.
 
-## Getting Started
+See [the website](http://laminar.ohwg.net) and the [documentation](http://laminar.ohwg.net/docs.html) for more information.
 
-### Building from source
+## Building from source
 
 First install development packages for `capnproto (git)`, `rapidjson`, `websocketpp`, `sqlite` and `boost-filesystem` from your distribution's repository or other source. Then:
 
@@ -22,521 +22,3 @@ sudo make install
 
 `make install` includes a systemd unit file. If you intend to use it, consider creating a new user `laminar` or modifying the user specified in the unit file.
 
-### Installation from binaries
-
-Alternatively to the source-based approach shown above, precompiled packages are supplied for x86_64 Debian Stretch and CentOS 7.
-
-Under Debian:
-
-```bash
-wget https://github.com/ohwgiles/laminar/releases/download/0.5/laminar-0.5-1-amd64.deb
-sudo apt install laminar-0.5-1-amd64.deb
-```
-
-Under CentOS:
-
-```bash
-wget https://github.com/ohwgiles/laminar/releases/download/0.5/laminar-0.5-1.x86_64.rpm
-sudo yum install laminar-0.5-1.x86_64.rpm
-```
-
-Both install packages will create a new `laminar` user and install (but not activate) a systemd service for launching the laminar daemon.
-
-### Service Configuration
-
-Use `systemctl start laminar` to start the laminar system service and `systemctl enable laminar` to launch it automatically on system boot.
-
-After starting the service, an empty laminar dashboard should be available at http://localhost:8080
-
-Laminar's configuration file may be found at `/etc/laminar.conf`. Laminar will start with reasonable defaults if no configuration can be found.
-
-#### Running on a different HTTP port or Unix socket
-
-Edit `/etc/laminar.conf` and change `LAMINAR_BIND_HTTP` to `IPADDR:PORT`, `unix:PATH/TO/SOCKET` or `unix-abstract:SOCKETNAME`. `IPADDR` may be `*` to bind on all interfaces. The default is `*:8080`.
-
-Do not attempt to run laminar on port 80. This requires running as `root`, and Laminar will not drop privileges when executing job scripts! For a more complete integrated solution (including SSL), simply run laminar as a reverse proxy behind a regular webserver.
-
-#### Running behind a reverse proxy
-
-Laminar relies on WebSockets to provide a responsive, auto-updating display without polling. This may require extra support from your frontend webserver.
-
-For nginx, see [NGINX Reverse Proxy](https://www.nginx.com/resources/admin-guide/reverse-proxy/) and [WebSocket proxying](http://nginx.org/en/docs/http/websocket.html).
-
-For Apache, see [Apache Reverse Proxy](https://httpd.apache.org/docs/2.4/howto/reverse_proxy.html) and [mod_proxy_wstunnel](https://httpd.apache.org/docs/2.4/mod/mod_proxy_wstunnel.html).
-
-#### Set the page title
-
-Change `LAMINAR_TITLE` in `/etc/laminar.conf` to your preferred page title.
-
-#### More configuration options
-
-See the [reference section](#reference)
-
-## User Guide
-
-### Terminology
-
-- *job*: a task, identified by a name, comprising of one or more executable scripts.
-- *run*: a numbered execution of a *job*
-
-Throughout this document, the fixed path `/var/lib/laminar` is used. This is simply a default value and can be changed by setting `LAMINAR_HOME` in `/etc/laminar.conf` as desired.
-
-### Creating a job
-
-To create a job that downloads and compiles [GNU Hello](https://www.gnu.org/software/hello/), create the file `/var/lib/laminar/cfg/jobs/hello.run` with the following content:
-
-```bash
-#!/bin/bash -ex
-wget ftp://ftp.gnu.org/gnu/hello/hello-2.10.tar.gz
-tar xzf hello-2.10.tar.gz
-cd hello-2.10
-./configure
-make
-```
-
-Laminar uses your script's exit code to determine whether to mark the run as successful or failed. If your script is written in bash, the [`-e` option](http://tldp.org/LDP/abs/html/options.html) is helpful for this. See also [Exit and Exit Status](http://tldp.org/LDP/abs/html/exit-status.html).
-
-Don't forget to mark the script executable:
-
-```bash
-chmod +x /var/lib/laminar/cfg/hello.run
-```
-
-### Triggering a run
-
-To trigger a run of the `hello` job, execute
-
-```bash
-laminarc trigger hello
-```
-
-This causes the `/var/lib/laminar/cfg/hello.run` script to be executed, with a working directory of `/var/lib/laminar/run/hello/1`
-
-The result and log output should be visible in the Web UI at http://localhost:8080/jobs/hello/1
-
-#### Isn't there a "Build Now" button I can click?
-
-This is against the design principles of Laminar and was deliberately excluded. Laminar's web UI is strictly read-only, making it simple to deploy in mixed-permission or public environments without an authentication layer. Furthermore, Laminar tries to encourage ideal continuous integration, where manual triggering is an anti-pattern. Want to make a release? Push a git tag and implement a post-receive hook. Want to re-run a build due to sporadic failure/flaky tests? Fix the tests locally and push a patch. Experience shows that a manual trigger such as a "Build Now" button is often used as a crutch to avoid doing the correct thing, negatively impacting traceability and quality.
-
-#### Triggering a job at a certain time
-
-This is what `cron` is for. To trigger a build of `hello` every day at 0300, add
-
-```
-0 3 * * * LAMINAR_REASON="Nightly build" laminarc trigger hello
-```
-
-to `laminar`'s crontab. For more information about `cron`, see `man crontab`.
-
-`LAMINAR_REASON` is an optional human-readable string that will be displayed in the web UI as the cause of the build.
-
-#### Triggering on a git commit
-
-This is what [git hooks](https://git-scm.com/book/gr/v2/Customizing-Git-Git-Hooks) are for. To create a hook that triggers the `example-build` job when a push is made to the `example` repository, create the file `hooks/post-receive` in the `example.git` bare repository.
-
-```bash
-#!/bin/bash
-LAMINAR_REASON="Push to git repository" laminarc trigger example-build
-```
-
-What if your git server is not the same machine as the laminar instance?
-
-#### Triggering on a remote laminar instance
-
-`laminarc` and `laminard` communicate by default over an [abstract unix socket](http://man7.org/linux/man-pages/man7/unix.7.html). This means that any user **on the same machine** can send commands to the laminar service.
-
-On a trusted network, you might want `laminard` to listen for commands on a TCP port instead. To achieve this, in `/etc/laminar.conf`, set
-
-```
-LAMINAR_BIND_RPC=*:9997
-```
-
-or any interface/port combination you like. This option uses the same syntax as `LAMINAR_BIND_HTTP`.
-
-Then, point `laminarc` to the new location using an environment variable:
-
-```bash
-LAMINAR_HOST=192.168.1.1:9997 laminarc trigger example
-```
-
-##### Access control
-
-If you need more flexibility, consider running the communication channel as a regular unix socket and applying user and group permissions to the file. To achieve this, set
-
-```
-LAMINAR_BIND_RPC=unix:/var/run/laminar.sock
-```
-
-or similar path in `/etc/laminar.conf`.
-
-This can be securely and flexibly combined with remote triggering using `ssh`. There is no need to allow the client full shell access to the server machine, the ssh server can restrict certain users to certain commands (in this case `laminarc`). See [the authorized_keys section of the sshd man page](https://man.openbsd.org/sshd#AUTHORIZED_KEYS_FILE_FORMAT) for further information.
-
-### Job chains
-
-A typical pipeline may involve several steps, such as build, test and deploy. Depending on the project, these may be broken up into seperate laminar jobs for maximal flexibility.
-
-The preferred way to accomplish this in Laminar is to use the same method as [regular run triggering](#triggering-a-run), that is, calling `laminarc` directly in your `example.run` scripts.
-
-In addition to `laminarc trigger`, `laminar start` triggers a job run, but waits for its completion and returns a non-zero exit code if the run failed. Furthermore, both `trigger` and `start` will accept multiple jobs in a single invocation:
-
-```bash
-#!/bin/bash -xe
-
-# simultaneously starts example-test-qemu and example-test-target
-# and returns a non-zero error code if either of them fail
-laminarc start example-test-qemu example-test-target
-```
-
-An advantage to using this `laminarc` approach from bash or other scripting language is that it enables highly dynamic pipelines, since you can execute commands like
-
-```bash
-if [ ... ]; then
-  laminarc start example-downstream-special
-else
-  laminarc start example-downstream-regular
-fi
-
-laminarc start example-test-$TARGET_PLATFORM
-```
-
-`laminarc` reads the `$JOB` and `$RUN` variables set by `laminard` and passes them as part of the trigger/start request so the dependency chain can always be traced back.
-
-### Parameterized runs
-
-Any argument passed to `laminarc` of the form `var=value` will be exposed as an environment variable in the corresponding build scripts. For example:
-
-```bash
-laminarc trigger example foo=bar
-```
-
-In `/var/lib/laminar/cfg/jobs/example.run`:
-
-```bash
-#!/bin/bash
-if [ "$foo" == "bar" ]; then
-   ...
-else
-   ...
-fi
-```
-
-### Pre-build actions
-
-If the script `/var/lib/laminar/cfg/jobs/example.before` exists, it will be executed as part of the `example` job, before the primary `/var/lib/laminar/cfg/jobs/example.run` script.
-
-See also [script execution order](#script-execution-order)
-
-#### Passing variables between run scripts
-
-Any script can set environment variables that will stay exposed for subsequent scripts of the same run using `laminarc set`. In `example.before`:
-```bash
-#!/bin/bash
-laminarc set foo=bar
-```
-
-Then in `example.run`
-```bash
-#!/bin/bash
-echo $foo            # prints "bar"
-```
-
-This works because laminarc reads `$JOB` and `$NUM` and passes them to the laminar daemon as part of the `set` request. (It is thus possible to set environment variables on other jobs by overriding these variables, but this is not very useful).
-
-### Post-build actions
-
-Analagously to [Pre-build actions](#pre-build-actions), if the script `example.after` exists, it will be executed after the primary `example.run` script.
-
-The `$RESULT` environment variable will contain the run result. See also [Environment variables](#environment-variables).
-
-#### Archiving artefacts
-
-Laminar's default behaviour is to remove the run directory `/var/lib/laminar/run/JOB/RUN` after its completion. This prevents the typical CI disk usage explosion and encourages the user to judiciously select artefacts for archive.
-
-Laminar provides an archive directory `/var/lib/laminar/archive/JOB/RUN` and exposes its path in `$ARCHIVE`. `example-build.after` might look like this:
-
-```bash
-#!/bin/bash -xe
-cp example.out $ARCHIVE/
-```
-
-This folder structure has been chosen to make it easy for system administrators to host the archive on a separate partition or network drive.
-
-
-#### Conditionally trigger a downstream job
-
-Often, you may wish to only trigger the `example-test` job if the `example-build` job completed successfully. `example-build.after` might look like this:
-
-```bash
-#!/bin/bash -xe
-if [ "$RESULT" == "success" ]; then
-  laminarc trigger example-test
-fi
-```
-
-#### Accessing artifacts from an upstream build
-
-Rather than implementing a separate mechanism for this, the path of the upstream's archive should be passed to the downstream run as a parameter. See [Parameterized runs](#parameterized-runs).
-
-#### Email and IM Notifications
-
-As well as per-job `.after` scripts, a common use case is to send a notification for every job completion. If the global `after` script at `/var/lib/laminar/cfg/after` exists, it will be executed after every job. One way to use this might be:
-
-```bash
-#!/bin/bash -xe
-if [ "$RESULT" != "$LAST_RESULT" ]; then
-  sendmail -t <<EOF
-To: engineering@company.com
-Subject: Laminar $JOB #$RUN: $RESULT
-From: laminar-ci@company.com
-
-Laminar $JOB #$RUN: $RESULT
-EOF
-fi
-```
-
-Of course, you can make this as pretty as you like. A [helper script](#helper-scripts) can be a good choice here.
-
-If you want to send to different addresses dependending on the job, replace `engineering@company.com` above with a variable, e.g. `$RECIPIENTS`, and set `RECIPIENTS=nora@company.com,joe@company.com` in `/var/lib/laminar/cfg/jobs/JOB.env`. See [Environment variables](#environment-variables).
-
-You could also update the `$RECIPIENTS` variable dynamically based on the build itself. For example, if your run script accepts a parameter `$rev` which is a git commit id, as part of your job's `.after` script you could do the following:
-
-```bash
-author_email=$(git show -s --format='%ae' $rev)
-laminarc set RECIPIENTS $author_email
-```
-
-### Helper scripts
-
-The directory `/var/lib/laminar/cfg/scripts` is automatically prepended to the `PATH` of all runs. It is a convenient place to drop executables or scripts to help keep individual job scripts clean and concise. A simple example might be `/var/lib/laminar/cfg/scripts/success_trigger`:
-
-```bash
-#!/bin/bash -e
-if [ "$RESULT" == "success" ]; then
-  laminarc trigger "$@"
-fi
-```
-
-With this in place, any `.after` script can conditionally trigger a downstream job more succinctly:
-
-```bash
-success_trigger example-test
-```
-
-Another excellent candidate for helper scripts is automatically sending notifications on job status change. See [Example scripts](#appendix-example-scripts) for more useful starting points.
-
-### Data sharing and Workspaces
-
-Often, a job will require a (relatively) large block of (relatively) unchanging data. Examples are a git repository with a long history, or static asset files. Instead of fetching everything from scratch for every run, a job may make use a *workspace*, a per-job folder that is reused between builds.
-
-For example, the following script creates a tarball containing both compiled output and some static asset files from the workspace:
-
-```bash
-#!/bin/bash -ex
-git clone /path/to/sources .
-make
-# Use a hardlink so the arguments to tar will be relative to the CWD
-ln $WORKSPACE/StaticAsset.bin ./
-tar zc a.out StaticAsset.bin > MyProject.tar.gz
-# Archive the artifact (consider moving this to the .after script)
-mv MyProject.tar.gz $ARCHIVE/
-```
-
-For a project with a large git history, it can be more efficient to store the sources in the workspace:
-
-```bash
-#!/bin/bash -ex
-cd $WORKSPACE/myproject
-git pull
-cd -
-
-cmake $WORKSPACE/myproject
-make -j4
-```
-
-**CAUTION**: By default, laminar permits multiple simultaneous runs of the same job. If a job can **modify** the workspace, this might result in inconsistent builds when the job has multiple simultaneous runs. This is unlikely to be an issue for nightly builds, but for SCM-triggered builds it will be. To solve this, use [nodes](#nodes-and-tags) to restrict simultaneous execution of jobs, or [locks](#locks) to temporarily take exclusive control of a resource.
-
-Laminar will automatically create the workspace for a job if it doesn't exist when a job is executed. In this case, the `/var/lib/laminar/cfg/jobs/JOBNAME.init` will be executed if it exists. This is an excellent place to prepare the workspace to a state where subsequent builds can rely on its content.
-
-### Nodes and Tags
-
-In Laminar, a *node* is an abstract concept allowing more fine-grained control over job execution scheduling. Each node can be defined to support an integer number of *executors*, which defines how many runs can be executed simultaneously.
-
-A typical example would be to allow only a few concurrent CPU-intensive jobs (such as compilation), while simultaneously allowing many more less-intensive jobs (such as monitoring or remote jobs). To create a node named `build` with 3 executors, create the file `/var/lib/laminar/cfg/nodes/build.conf` with the following content:
-
-```
-EXECUTORS=3
-```
-
-To associate jobs with nodes, laminar uses *tags*. Tags may be applied to nodes and jobs. If a node has tags, only jobs with a matching tag will be executed on it. If a node has no tags, it will accept any job. To tag a node, add them to `/var/lib/laminar/cfg/nodes/NODENAME.conf`:
-
-```
-EXECUTORS=3
-TAGS=tag1,tag2
-```
-
-To add a tag to a job, add the following to `/var/lib/laminar/cfg/jobs/JOBNAME.conf`:
-
-```
-TAGS=tag2
-```
-
-If Laminar cannot find any node configuration, it will assume a single node with 6 executors and no tags.
-
-#### Grouping jobs with tags
-
-Tags are also used to group jobs in the web UI. Each tag will presented as a tab in the "Jobs" page.
-
-#### Node scripts
-
-If `/var/lib/laminar/cfg/nodes/NODENAME.before` exists, it will be executed before the run script of a job scheduled to that node. Similarly, if `/var/lib/laminar/cfg/nodes/NODENAME.after` exists, it will be executed after the run script of a job scheduled to that node.
-
-#### Node environment
-
-If `/var/lib/laminar/cfg/nodes/NODENAME.env` exists and can be parsed as a list of `KEY=VALUE` pairs, these variables will be exposed as part of the run's environment.
-
-### Remote jobs
-
-Laminar provides no specific support, `bash`, `ssh` and possibly NFS are all you need. For example, consider two identical target devices on which test jobs can be run in parallel. You might create a [node](#nodes-and-tags) for each, `/var/lib/laminar/cfg/nodes/target{1,2}.conf` with a common tag:
-
-```
-EXECUTORS=1
-TAGS=remote-target
-```
-
-In each node's `.env` file, set the individual device's IP address:
-
-```
-TARGET_IP=192.168.0.123
-```
-
-And tag the job accordingly in `/var/lib/laminar/cfg/jobs/myproject-test.conf`:
-
-```
-TAGS=remote-target
-```
-
-This means the job script `/var/lib/laminar/cfg/jobs/myproject-test.run` can be generic:
-
-```bash
-#!/bin/bash -e
-
-ssh root@$TARGET_IP /bin/bash -xe <<"EOF"
-  uname -a
-  ...
-EOF
-scp root@$TARGET_IP:result.xml "$ARCHIVE/"
-```
-
-Don't forget to add the `laminar` user's public ssh key to the remote's `authorized_keys`.
-
-### Docker container jobs
-
-Laminar provides no specific support, but just like [remote jobs](#remote-jobs) these are easily implementable in plain bash:
-
-```bash
-#!/bin/bash
-
-docker run --rm -ti -v $PWD:/root ubuntu /bin/bash -xe <<EOF
-  git clone http://...
-  ...
-EOF
-```
-
-### Locks
-
-*Locks* are a simple way to control access to shared resources. Any string may be used as a lock name. The command `laminarc lock mylock` locks `mylock`. Subsequent calls to `laminarc lock mylock` will block until `laminarc release mylock` is called a corresponding number of times.
-
-**CAUTION**: Locks are independent of any other job control mechanism in laminar, and will not be released automatically. Making sure calls to lock and release are symmetric is the administrator's responsibility.
-
-An example use builds on the situation described in [Data sharing and Workspaces](#data-sharing-and-workspaces), where a large git repository is stored in the workspace. Conisder this run script:
-
-```bash
-#!/bin/bash -x
-
-# This script expects to be passed the parameter `rev` which
-# should refer to a specific git commit in its source repository.
-# The commit ids could have been read from a server-side
-# post-commit git hook, where many commits could have been pushed
-# at once, but we want to check them all individually. This means
-# this job can be executed several times (with different commit ids)
-# at once.
-
-cd $WORKSPACE
-# Acquire a lock for modifying the workspace
-laminarc lock $JOB-workspace
-# Download all the latest commits
-git fetch
-git checkout $rev
-cd -
-# Fast copy (hard-link) the specific checkout to the build dir
-cp -al $WORKSPACE/src src
-# Release the lock to allow other jobs to do the same
-laminarc release $JOB-workspace
-
-# run the (much longer) build process
-set -e
-cmake src
-make
-```
-
-
-## Reference
-
-### Server options
-
-`laminard` reads the following variables from the environment, which are expected to be sourced by `systemd` from `/etc/laminar.conf`:
-
-- `LAMINAR_HOME`: The directory in which `laminard` should find job configuration and create run directories. Default `/var/lib/laminar`
-- `LAMINAR_BIND_HTTP`: The interface/port or unix socket on which `laminard` should listen for incoming connections to the web frontend. Default `*:8080`
-- `LAMINAR_BIND_RPC`: The interface/port or unix socket on which `laminard` should listen for incoming commands such as build triggers. Default `unix-abstract:laminar`
-- `LAMINAR_TITLE`: The page title to show in the web frontend.
-- `LAMINAR_KEEP_RUNDIRS`: Set to an integer defining how many rundirs to keep per job. The lowest-numbered ones will be deleted. The default is 0, meaning all run dirs will be immediately deleted.
-- `LAMINAR_ARCHIVE_URL`: If set, the web frontend served by `laminard` will use this URL to form links to artefacts archived jobs. Must be synchronized with web server configuration.
-
-### Script execution order
-
-When `$JOB` is triggered on `$NODE`, the following scripts (relative to `$LAMINAR_HOME/cfg`) may be triggered:
-
-- `jobs/$JOB.init` if the [workspace](#data-sharing-and-workspaces) did not exist
-- `before`
-- `nodes/$NODE.before`
-- `jobs/$JOB.before`
-- `jobs/$JOB.run`
-- `jobs/$JOB.after`
-- `nodes/$NODE.after`
-- `after`
-
-### Environment variables
-
-The following variables are available in run scripts:
-
-- `RUN` integer number of this *run*
-- `JOB` string name of this *job*
-- `RESULT` string run status: "success", "failed", etc.
-- `LAST_RESULT` string previous run status
-- `WORKSPACE` path to this job's workspace
-- `ARCHIVE` path to this run's archive
-
-In addition, `$LAMINAR_HOME/cfg/scripts` is prepended to `$PATH`. See [helper scripts](#helper-scripts).
-
-Laminar will also export variables in the form `KEY=VALUE` found in these files:
-
-- `env`
-- `nodes/$NODE.env`
-- `jobs/$JOB.env`
-
-Finally, variables supplied on the command-line call to `laminarc start` or `laminarc trigger` will be available. See [parameterized builds](#parameterized-builds)
-
-### `laminarc`
-
-`laminarc` commands are:
-
-- `trigger [JOB [PARAMS...]]...` triggers one or more jobs with optional parameters, returning immediately.
-- `start [JOB [PARAMS...]]...` triggers one or more jobs with optional parameters and waits for the completion of all jobs. Returns a non-zero error code if any job failed.
-- `set [VARIABLE=VALUE]...` sets one or more variables to be exported in subsequent scripts for the run identified by the `$JOB` and `$RUN` environment variables
-- `lock [NAME]` acquires the [lock](#locks) named `NAME`
-- `release [NAME]` releases the lock named `NAME`
-
-`laminarc` connects to `laminard` using the address supplied by the `LAMINAR_HOST` environment variable. If it is not set, `laminarc` will first attempt to use `LAMINAR_BIND_RPC`, which will be available if `laminarc` is executed from a script within `laminard`. If neither `LAMINAR_HOST` nor `LAMINAR_BIND_RPC` is set, `laminarc` will assume a default host of `unix-abstract:laminar`.
-
-## Appendix: Example scripts

UserManual.md

@@ -0,0 +1,603 @@
+# Introduction
+
+[Laminar](http://laminar.ohwg.net) is a lightweight and modular Continuous Integration service for Linux. It is self-hosted and developer-friendly, eschewing a configuration web UI in favor of simple version-controllable configuration files and scripts.
+
+Laminar encourages the use of existing GNU/Linux tools such as `bash` and `cron` instead of reinventing them.
+
+Although the status and progress front-end is very user-friendly, administering a Laminar instance requires writing shell scripts and manually editing configuration files. That being said, there is nothing esoteric here and the tutorial below should be straightforward for anyone with even very basic Linux server administration experience.
+
+Throughout this document, the fixed base path `/var/lib/laminar` is used. This is the default path and can be changed by setting `LAMINAR_HOME` in `/etc/laminar.conf` as desired.
+
+## Terminology
+
+- *job*: a task, identified by a name, comprising of one or more executable scripts.
+- *run*: a numbered execution of a *job*
+
+---
+
+# Installing Laminar
+
+Pre-built packages are available for Debian 9 (Stretch) and CentOS 7 on x86_64. Alternatively, Laminar may be built from source for any Linux distribution.
+
+## Installation from binaries
+
+Alternatively to the source-based approach shown above, precompiled packages are supplied for x86_64 Debian 9 (Stretch) and CentOS 7
+
+Under Debian:
+
+```bash
+wget https://github.com/ohwgiles/laminar/releases/download/0.6/laminar-0.6-1-amd64.deb
+sudo apt install laminar-0.6-1-amd64.deb
+```
+
+Under CentOS:
+
+```bash
+wget https://github.com/ohwgiles/laminar/releases/download/0.5/laminar-0.6-1.x86_64.rpm
+sudo yum install laminar-0.6-1.x86_64.rpm
+```
+
+Both install packages will create a new `laminar` user and install (but not activate) a systemd service for launching the laminar daemon.
+
+## Building from source
+
+See the [development README](https://github.com/ohwgiles/laminar) for instructions for installing from source.
+
+---
+
+# Service configuration
+
+Use `systemctl start laminar` to start the laminar system service and `systemctl enable laminar` to launch it automatically on system boot.
+
+After starting the service, an empty laminar dashboard should be available at http://localhost:8080
+
+Laminar's configuration file may be found at `/etc/laminar.conf`. Laminar will start with reasonable defaults if no configuration can be found.
+
+## Running on a different HTTP port or Unix socket
+
+Edit `/etc/laminar.conf` and change `LAMINAR_BIND_HTTP` to `IPADDR:PORT`, `unix:PATH/TO/SOCKET` or `unix-abstract:SOCKETNAME`. `IPADDR` may be `*` to bind on all interfaces. The default is `*:8080`.
+
+Do not attempt to run laminar on port 80. This requires running as `root`, and Laminar will not drop privileges when executing job scripts! For a more complete integrated solution (including SSL), run laminar as a reverse proxy behind a regular webserver.
+
+## Running behind a reverse proxy
+
+Laminar relies on WebSockets to provide a responsive, auto-updating display without polling. This may require extra support from your frontend webserver.
+
+For nginx, see [NGINX Reverse Proxy](https://www.nginx.com/resources/admin-guide/reverse-proxy/) and [WebSocket proxying](http://nginx.org/en/docs/http/websocket.html).
+
+For Apache, see [Apache Reverse Proxy](https://httpd.apache.org/docs/2.4/howto/reverse_proxy.html) and [mod_proxy_wstunnel](https://httpd.apache.org/docs/2.4/mod/mod_proxy_wstunnel.html).
+
+If you use [artefacts](#Archiving-artefacts), note that Laminar is not designed as a file server, and better performance will be achieved by allowing the frontend web server to directly serve the archive directory directly (e.g. using a `Location` directive).
+
+## Set the page title
+
+Change `LAMINAR_TITLE` in `/etc/laminar.conf` to your preferred page title. For further WebUI customization, consider using a [custom style sheet](#Customizing-the-WebUI).
+
+## More configuration options
+
+See the [reference section](#Service-configuration-file)
+
+---
+
+# Defining a job
+
+To create a job that downloads and compiles [GNU Hello](https://www.gnu.org/software/hello/), create the file `/var/lib/laminar/cfg/jobs/hello.run` with the following content:
+
+```bash
+#!/bin/bash -ex
+wget ftp://ftp.gnu.org/gnu/hello/hello-2.10.tar.gz
+tar xzf hello-2.10.tar.gz
+cd hello-2.10
+./configure
+make
+```
+
+Laminar uses your script's exit code to determine whether to mark the run as successful or failed. If your script is written in bash, the [`-e` option](http://tldp.org/LDP/abs/html/options.html) is helpful for this. See also [Exit and Exit Status](http://tldp.org/LDP/abs/html/exit-status.html).
+
+Don't forget to mark the script executable:
+
+```bash
+chmod +x /var/lib/laminar/cfg/hello.run
+```
+
+---
+
+# Triggering a run
+
+When triggering a run, the job is first added to a queue of upcoming tasks. If the server is busy, the job may wait in this queue for a while. It will only be assigned a job number when it leaves this queue and starts executing. The job number may be useful to the client that triggers the run, so there are a few ways to trigger a run.
+
+To add the `hello` job to the queue ("fire-and-forget"), execute
+
+```bash
+laminarc queue hello
+```
+
+In this case, laminarc returns immediately, with its error code indicating whether adding the job to the queue was sucessful.
+
+To queue the job and wait until it leaves the queue and starts executing, use
+
+```bash
+laminarc start hello
+```
+
+In this case, laminarc blocks until the job starts executing, or returns immediately if queueing failed. The run number will be printed to standard output.
+
+To launch and run the `hello` job to completion, execute
+
+```bash
+laminarc run hello
+```
+
+In all cases, a started run means the `/var/lib/laminar/cfg/hello.run` script will be executed, with a working directory of `/var/lib/laminar/run/hello/1` (or current run number)
+
+The result and log output should be visible in the Web UI at http://localhost:8080/jobs/hello/1
+
+Also note that all the above commands can simultaneously trigger multiple different jobs:
+
+```bash
+laminarc queue test-host test-target
+```
+
+## Isn't there a "Build Now" button I can click?
+
+This is against the design principles of Laminar and was deliberately excluded. Laminar's web UI is strictly read-only, making it simple to deploy in mixed-permission or public environments without an authentication layer. Furthermore, Laminar tries to encourage ideal continuous integration, where manual triggering is an anti-pattern. Want to make a release? Push a git tag and implement a post-receive hook. Want to re-run a build due to sporadic failure/flaky tests? Fix the tests locally and push a patch. Experience shows that a manual trigger such as a "Build Now" button is often used as a crutch to avoid doing the correct thing, negatively impacting traceability and quality.
+
+## Triggering a job at a certain time
+
+This is what `cron` is for. To trigger a build of `hello` every day at 0300, add
+
+```
+0 3 * * * LAMINAR_REASON="Nightly build" laminarc queue hello
+```
+
+to `laminar`'s crontab. For more information about `cron`, see `man crontab`.
+
+`LAMINAR_REASON` is an optional human-readable string that will be displayed in the web UI as the cause of the build.
+
+## Triggering on a git commit
+
+This is what [git hooks](https://git-scm.com/book/gr/v2/Customizing-Git-Git-Hooks) are for. To create a hook that triggers the `example-build` job when a push is made to the `example` repository, create the file `hooks/post-receive` in the `example.git` bare repository.
+
+```bash
+#!/bin/bash
+LAMINAR_REASON="Push to git repository" laminarc queue example-build
+```
+
+What if your git server is not the same machine as the laminar instance?
+
+## Triggering on a remote laminar instance
+
+`laminarc` and `laminard` communicate by default over an [abstract unix socket](http://man7.org/linux/man-pages/man7/unix.7.html). This means that any user **on the same machine** can send commands to the laminar service.
+
+On a trusted network, you might want `laminard` to listen for commands on a TCP port instead. To achieve this, in `/etc/laminar.conf`, set
+
+```
+LAMINAR_BIND_RPC=*:9997
+```
+
+or any interface/port combination you like. This option uses the same syntax as `LAMINAR_BIND_HTTP`.
+
+Then, point `laminarc` to the new location using an environment variable:
+
+```bash
+LAMINAR_HOST=192.168.1.1:9997 laminarc queue example
+```
+
+If you need more flexibility, consider running the communication channel as a regular unix socket and applying user and group permissions to the file. To achieve this, set
+
+```
+LAMINAR_BIND_RPC=unix:/var/run/laminar.sock
+```
+
+or similar path in `/etc/laminar.conf`.
+
+This can be securely and flexibly combined with remote triggering using `ssh`. There is no need to allow the client full shell access to the server machine, the ssh server can restrict certain users to certain commands (in this case `laminarc`). See [the authorized_keys section of the sshd man page](https://man.openbsd.org/sshd#AUTHORIZED_KEYS_FILE_FORMAT) for further information.
+
+## Triggering on a push to GitHub
+
+Consider using [webhook](https://github.com/adnanh/webhook) or a similar application to call `laminarc`.
+
+---
+
+# Job chains
+
+A typical pipeline may involve several steps, such as build, test and deploy. Depending on the project, these may be broken up into seperate laminar jobs for maximal flexibility.
+
+The preferred way to accomplish this in Laminar is to use the same method as [regular run triggering](#Triggering-a-run), that is, calling `laminarc` directly in your `example.run` scripts.
+
+```bash
+#!/bin/bash -xe
+
+# simultaneously starts example-test-qemu and example-test-target
+# and returns a non-zero error code if either of them fail
+laminarc run example-test-qemu example-test-target
+```
+
+An advantage to using this `laminarc` approach from bash or other scripting language is that it enables highly dynamic pipelines, since you can execute commands like
+
+```bash
+if [ ... ]; then
+  laminarc run example-downstream-special
+else
+  laminarc run example-downstream-regular
+fi
+
+laminarc run example-test-$TARGET_PLATFORM
+```
+
+`laminarc` reads the `$JOB` and `$RUN` variables set by `laminard` and passes them as part of the queue/start/run request so the dependency chain can always be traced back.
+
+---
+
+# Parameterized runs
+
+Any argument passed to `laminarc` of the form `var=value` will be exposed as an environment variable in the corresponding build scripts. For example:
+
+```bash
+laminarc queue example foo=bar
+```
+
+In `/var/lib/laminar/cfg/jobs/example.run`:
+
+```bash
+#!/bin/bash
+if [ "$foo" == "bar" ]; then
+   ...
+else
+   ...
+fi
+```
+
+---
+
+# Pre- and post-build actions
+
+If the script `/var/lib/laminar/cfg/jobs/example.before` exists, it will be executed as part of the `example` job, before the primary `/var/lib/laminar/cfg/jobs/example.run` script.
+
+Similarly, if the script `/var/lib/laminar/cfg/jobs/example.after` script exists, it will be executed as part of the `example` job, after the primary `var/lib/laminar/cfg/jobs/example.run` script. In this script, the `$RESULT` variable will be `success`, `failed`, or `aborted` according to the result of `example.run`.
+
+See also [script execution order](#Script-execution-order)
+
+
+## Conditionally trigger a downstream job
+
+Often, you may wish to only trigger the `example-test` job if the `example-build` job completed successfully. `example-build.after` might look like this:
+
+```bash
+#!/bin/bash -xe
+if [ "$RESULT" == "success" ]; then
+  laminarc queue example-test
+fi
+```
+
+## Passing data between scripts
+
+Any script can set environment variables that will stay exposed for subsequent scripts of the same run using `laminarc set`. In `example.before`:
+
+```bash
+#!/bin/bash
+laminarc set foo=bar
+```
+
+Then in `example.run`
+
+```bash
+#!/bin/bash
+echo $foo            # prints "bar"
+```
+
+This works because laminarc reads `$JOB` and `$NUM` and passes them to the laminar daemon as part of the `set` request. (It is thus possible to set environment variables on other jobs by overriding these variables, but this is not very useful).
+
+---
+
+# Archiving artefacts
+
+Laminar's default behaviour is to remove the run directory `/var/lib/laminar/run/JOB/RUN` after its completion. This prevents the typical CI disk usage explosion and encourages the user to judiciously select artefacts for archive.
+
+Laminar provides an archive directory `/var/lib/laminar/archive/JOB/RUN` and exposes its path in `$ARCHIVE`. `example-build.after` might look like this:
+
+```bash
+#!/bin/bash -xe
+cp example.out $ARCHIVE/
+```
+
+This folder structure has been chosen to make it easy for system administrators to host the archive on a separate partition or network drive.
+
+
+## Accessing artefacts from an upstream build
+
+Rather than implementing a separate mechanism for this, the path of the upstream's archive should be passed to the downstream run as a parameter. See [Parameterized runs](#Parameterized-runs).
+
+---
+
+# Email and IM Notifications
+
+As well as per-job `.after` scripts, a common use case is to send a notification for every job completion. If the global `after` script at `/var/lib/laminar/cfg/after` exists, it will be executed after every job. One way to use this might be:
+
+```bash
+#!/bin/bash -xe
+if [ "$RESULT" != "$LAST_RESULT" ]; then
+  sendmail -t <<EOF
+To: engineering@company.com
+Subject: Laminar $JOB #$RUN: $RESULT
+From: laminar-ci@company.com
+
+Laminar $JOB #$RUN: $RESULT
+EOF
+fi
+```
+
+Of course, you can make this as pretty as you like. A [helper script](#Helper-scripts) can be a good choice here.
+
+If you want to send to different addresses dependending on the job, replace `engineering@company.com` above with a variable, e.g. `$RECIPIENTS`, and set `RECIPIENTS=nora@company.com,joe@company.com` in `/var/lib/laminar/cfg/jobs/JOB.env`. See [Environment variables](#Environment-variables).
+
+You could also update the `$RECIPIENTS` variable dynamically based on the build itself. For example, if your run script accepts a parameter `$rev` which is a git commit id, as part of your job's `.after` script you could do the following:
+
+```bash
+author_email=$(git show -s --format='%ae' $rev)
+laminarc set RECIPIENTS $author_email
+```
+
+---
+
+# Helper scripts
+
+The directory `/var/lib/laminar/cfg/scripts` is automatically prepended to the `PATH` of all runs. It is a convenient place to drop executables or scripts to help keep individual job scripts clean and concise. A simple example might be `/var/lib/laminar/cfg/scripts/success_trigger`:
+
+```bash
+#!/bin/bash -e
+if [ "$RESULT" == "success" ]; then
+  laminarc queue "$@"
+fi
+```
+
+With this in place, any `.after` script can conditionally trigger a downstream job more succinctly:
+
+```bash
+success_trigger example-test
+```
+
+Another excellent candidate for helper scripts is automatically sending notifications on job status change.
+
+---
+
+# Data sharing and Workspaces
+
+Often, a job will require a (relatively) large block of (relatively) unchanging data. Examples are a git repository with a long history, or static asset files. Instead of fetching everything from scratch for every run, a job may make use a *workspace*, a per-job folder that is reused between builds.
+
+For example, the following script creates a tarball containing both compiled output and some static asset files from the workspace:
+
+```bash
+#!/bin/bash -ex
+git clone /path/to/sources .
+make
+# Use a hardlink so the arguments to tar will be relative to the CWD
+ln $WORKSPACE/StaticAsset.bin ./
+tar zc a.out StaticAsset.bin > MyProject.tar.gz
+# Archive the artefact (consider moving this to the .after script)
+mv MyProject.tar.gz $ARCHIVE/
+```
+
+For a project with a large git history, it can be more efficient to store the sources in the workspace:
+
+```bash
+#!/bin/bash -ex
+cd $WORKSPACE/myproject
+git pull
+cd -
+
+cmake $WORKSPACE/myproject
+make -j4
+```
+
+**CAUTION**: By default, laminar permits multiple simultaneous runs of the same job. If a job can **modify** the workspace, this might result in inconsistent builds when the job has multiple simultaneous runs. This is unlikely to be an issue for nightly builds, but for SCM-triggered builds it will be. To solve this, use [nodes](#Nodes-and-Tags) to restrict simultaneous execution of jobs, or [locks](#Locks) to temporarily take exclusive control of a resource.
+
+Laminar will automatically create the workspace for a job if it doesn't exist when a job is executed. In this case, the `/var/lib/laminar/cfg/jobs/JOBNAME.init` will be executed if it exists. This is an excellent place to prepare the workspace to a state where subsequent builds can rely on its content.
+
+---
+
+# Abort on timeout
+
+To configure a maximum execution time in seconds for a job, add a line to `/var/lib/laminar/cfg/jobs/JOBNAME.conf`:
+
+```
+TIMEOUT=120
+```
+
+---
+
+# Nodes and Tags
+
+In Laminar, a *node* is an abstract concept allowing more fine-grained control over job execution scheduling. Each node can be defined to support an integer number of *executors*, which defines how many runs can be executed simultaneously.
+
+A typical example would be to allow only a few concurrent CPU-intensive jobs (such as compilation), while simultaneously allowing many more less-intensive jobs (such as monitoring or remote jobs). To create a node named `build` with 3 executors, create the file `/var/lib/laminar/cfg/nodes/build.conf` with the following content:
+
+```
+EXECUTORS=3
+```
+
+To associate jobs with nodes, laminar uses *tags*. Tags may be applied to nodes and jobs. If a node has tags, only jobs with a matching tag will be executed on it. If a node has no tags, it will accept any job. To tag a node, add them to `/var/lib/laminar/cfg/nodes/NODENAME.conf`:
+
+```
+EXECUTORS=3
+TAGS=tag1,tag2
+```
+
+To add a tag to a job, add the following to `/var/lib/laminar/cfg/jobs/JOBNAME.conf`:
+
+```
+TAGS=tag2
+```
+
+If Laminar cannot find any node configuration, it will assume a single node with 6 executors and no tags.
+
+## Grouping jobs with tags
+
+Tags are also used to group jobs in the web UI. Each tag will presented as a tab in the "Jobs" page.
+
+## Node scripts
+
+If `/var/lib/laminar/cfg/nodes/NODENAME.before` exists, it will be executed before the run script of a job scheduled to that node. Similarly, if `/var/lib/laminar/cfg/nodes/NODENAME.after` exists, it will be executed after the run script of a job scheduled to that node.
+
+## Node environment
+
+If `/var/lib/laminar/cfg/nodes/NODENAME.env` exists and can be parsed as a list of `KEY=VALUE` pairs, these variables will be exposed as part of the run's environment.
+
+# Remote jobs
+
+Laminar provides no specific support, `bash`, `ssh` and possibly NFS are all you need. For example, consider two identical target devices on which test jobs can be run in parallel. You might create a [node](#Nodes-and-Tags) for each, `/var/lib/laminar/cfg/nodes/target{1,2}.conf` with a common tag:
+
+```
+EXECUTORS=1
+TAGS=remote-target
+```
+
+In each node's `.env` file, set the individual device's IP address:
+
+```
+TARGET_IP=192.168.0.123
+```
+
+And tag the job accordingly in `/var/lib/laminar/cfg/jobs/myproject-test.conf`:
+
+```
+TAGS=remote-target
+```
+
+This means the job script `/var/lib/laminar/cfg/jobs/myproject-test.run` can be generic:
+
+```bash
+#!/bin/bash -e
+
+ssh root@$TARGET_IP /bin/bash -xe <<"EOF"
+  uname -a
+  ...
+EOF
+scp root@$TARGET_IP:result.xml "$ARCHIVE/"
+```
+
+Don't forget to add the `laminar` user's public ssh key to the remote's `authorized_keys`.
+
+---
+
+# Docker container jobs
+
+Laminar provides no specific support, but just like [remote jobs](#Remote-jobs) these are easily implementable in plain bash:
+
+```bash
+#!/bin/bash
+
+docker run --rm -ti -v $PWD:/root ubuntu /bin/bash -xe <<EOF
+  git clone http://...
+  ...
+EOF
+```
+
+---
+
+# Locks
+
+*Locks* are a simple way to control access to shared resources. Any string may be used as a lock name. The command `laminarc lock mylock` locks `mylock`. Subsequent calls to `laminarc lock mylock` will block until `laminarc release mylock` is called a corresponding number of times.
+
+**CAUTION**: Locks are independent of any other job control mechanism in laminar, and will not be released automatically. Making sure calls to lock and release are symmetric is the administrator's responsibility.
+
+An example use builds on the situation described in [Data sharing and Workspaces](#Data-sharing-and-Workspaces), where a large git repository is stored in the workspace. Conisder this run script:
+
+```bash
+#!/bin/bash -x
+
+# This script expects to be passed the parameter `rev` which
+# should refer to a specific git commit in its source repository.
+# The commit ids could have been read from a server-side
+# post-commit git hook, where many commits could have been pushed
+# at once, but we want to check them all individually. This means
+# this job can be executed several times (with different commit ids)
+# at once.
+
+cd $WORKSPACE
+# Acquire a lock for modifying the workspace
+laminarc lock $JOB-workspace
+# Download all the latest commits
+git fetch
+git checkout $rev
+cd -
+# Fast copy (hard-link) the specific checkout to the build dir
+cp -al $WORKSPACE/src src
+# Release the lock to allow other jobs to do the same
+laminarc release $JOB-workspace
+
+# run the (much longer) build process
+set -e
+cmake src
+make
+```
+
+---
+
+# Customizing the WebUI
+
+If it exists, the file `/var/lib/laminar/custom/style.css` will be served by laminar and may be used to change the appearance of Laminar's WebUI.
+
+This directory is also a good place to add any extra assets needed for this customization, but note that in this case you will need to serve this directory directly from your [HTTP reverse proxy](#Service-configuration) (highly recommended).
+
+---
+
+# Reference
+
+## Service configuration file
+
+`laminard` reads the following variables from the environment, which are expected to be sourced by `systemd` from `/etc/laminar.conf`:
+
+- `LAMINAR_HOME`: The directory in which `laminard` should find job configuration and create run directories. Default `/var/lib/laminar`
+- `LAMINAR_BIND_HTTP`: The interface/port or unix socket on which `laminard` should listen for incoming connections to the web frontend. Default `*:8080`
+- `LAMINAR_BIND_RPC`: The interface/port or unix socket on which `laminard` should listen for incoming commands such as build triggers. Default `unix-abstract:laminar`
+- `LAMINAR_TITLE`: The page title to show in the web frontend.
+- `LAMINAR_KEEP_RUNDIRS`: Set to an integer defining how many rundirs to keep per job. The lowest-numbered ones will be deleted. The default is 0, meaning all run dirs will be immediately deleted.
+- `LAMINAR_ARCHIVE_URL`: If set, the web frontend served by `laminard` will use this URL to form links to artefacts archived jobs. Must be synchronized with web server configuration.
+
+## Script execution order
+
+When `$JOB` is triggered on `$NODE`, the following scripts (relative to `$LAMINAR_HOME/cfg`) may be executed:
+
+- `jobs/$JOB.init` if the [workspace](#Data-sharing-and-Workspaces) did not exist
+- `before`
+- `nodes/$NODE.before`
+- `jobs/$JOB.before`
+- `jobs/$JOB.run`
+- `jobs/$JOB.after`
+- `nodes/$NODE.after`
+- `after`
+
+## Environment variables
+
+The following variables are available in run scripts:
+
+- `RUN` integer number of this *run*
+- `JOB` string name of this *job*
+- `RESULT` string run status: "success", "failed", etc.
+- `LAST_RESULT` string previous run status
+- `WORKSPACE` path to this job's workspace
+- `ARCHIVE` path to this run's archive
+
+In addition, `$LAMINAR_HOME/cfg/scripts` is prepended to `$PATH`. See [helper scripts](#Helper-scripts).
+
+Laminar will also export variables in the form `KEY=VALUE` found in these files:
+
+- `env`
+- `nodes/$NODE.env`
+- `jobs/$JOB.env`
+
+Finally, variables supplied on the command-line call to `laminarc queue`, `laminarc start` or `laminarc run` will be available. See [parameterized runs](#Parameterized-runs)
+
+## laminarc
+
+`laminarc` commands are:
+
+- `queue [JOB [PARAMS...]]...` adds one or more jobs to the queue with optional parameters, returning immediately.
+- `start [JOB [PARAMS...]]...` starts one or more jobs with optional parameters, returning when the jobs begin execution.
+- `run [JOB [PARAMS...]]...` triggers one or more jobs with optional parameters and waits for the completion of all jobs. Returns a non-zero error code if any job failed.
+- `set [VARIABLE=VALUE]...` sets one or more variables to be exported in subsequent scripts for the run identified by the `$JOB` and `$RUN` environment variables
+- `lock [NAME]` acquires the [lock](#Locks) named `NAME`
+- `release [NAME]` releases the lock named `NAME`
+
+`laminarc` connects to `laminard` using the address supplied by the `LAMINAR_HOST` environment variable. If it is not set, `laminarc` will first attempt to use `LAMINAR_BIND_RPC`, which will be available if `laminarc` is executed from a script within `laminard`. If neither `LAMINAR_HOST` nor `LAMINAR_BIND_RPC` is set, `laminarc` will assume a default host of `unix-abstract:laminar`.

docker-build-centos.sh

@@ -1,24 +1,27 @@
-#!/bin/bash
+#!/bin/bash -e
 
 OUTPUT_DIR=$PWD
 
 SOURCE_DIR=$(readlink -f $(dirname ${BASH_SOURCE[0]}))
 
-VERSION=$(cd "$SOURCE_DIR" && git describe --tags --abbrev=8 --dirty)
+VERSION=$(cd "$SOURCE_DIR" && git describe --tags --abbrev=8 --dirty | tr - .)
 
-docker run --rm -i -v $SOURCE_DIR:/root/rpmbuild/SOURCES/laminar-$VERSION:ro -v $OUTPUT_DIR:/output centos bash -xe <<EOS
+DOCKER_TAG=$(docker build -q - <<EOS
+FROM centos:7
+RUN yum -y install epel-release && yum -y install rpm-build cmake3 make gcc gcc-c++ wget sqlite-devel boost-devel zlib-devel
+EOS
+)
 
-yum -y install epel-release
-yum -y install rpm-build cmake3 make gcc gcc-c++ wget sqlite-devel boost-devel zlib-devel
+docker run --rm -i -v $SOURCE_DIR:/root/rpmbuild/SOURCES/laminar-$VERSION:ro -v $OUTPUT_DIR:/output $DOCKER_TAG bash -xe <<EOS
 
 mkdir /build
 cd /build
 
-wget -O capnproto.tar.gz https://github.com/capnproto/capnproto/archive/7a7c4007e3e1b249f078a246749a584c96bf7503.tar.gz
+wget -O capnproto.tar.gz https://github.com/capnproto/capnproto/archive/3079784bfaf3ba05edacfc63d6d494b76a85a3a5.tar.gz
 wget -O websocketpp.tar.gz https://github.com/zaphoyd/websocketpp/archive/0.7.0.tar.gz
 wget -O rapidjson.tar.gz https://github.com/miloyip/rapidjson/archive/v1.1.0.tar.gz
 md5sum -c <<EOF
-58d238ffbb19152f04d2bff520847788  capnproto.tar.gz
+c5c04c1892a381e30bd032a6bceef111  capnproto.tar.gz
 5027c20cde76fdaef83a74acfcf98e23  websocketpp.tar.gz
 badd12c511e081fec6c89c43a7027bce  rapidjson.tar.gz
 EOF
@@ -27,7 +30,7 @@ tar xzf capnproto.tar.gz
 tar xzf websocketpp.tar.gz
 tar xzf rapidjson.tar.gz
 
-cd /build/capnproto-7a7c4007e3e1b249f078a246749a584c96bf7503/c++/
+cd /build/capnproto-3079784bfaf3ba05edacfc63d6d494b76a85a3a5/c++/
 cmake3 -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTING=off .
 make -j4
 make install
@@ -56,7 +59,7 @@ Lightweight Continuous Integration Service
 %prep
 
 %build
-cmake3 -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/ %{_sourcedir}/laminar-$VERSION
+cmake3 -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/ -DSYSTEMD_UNITDIR=%{_unitdir} %{_sourcedir}/laminar-$VERSION
 pwd
 make
 

docker-build-debian.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/bin/bash -e
 
 OUTPUT_DIR=$PWD
 
@@ -6,19 +6,22 @@ SOURCE_DIR=$(readlink -f $(dirname ${BASH_SOURCE[0]}))
 
 VERSION=$(cd "$SOURCE_DIR" && git describe --tags --abbrev=8 --dirty)
 
-docker run --rm -i -v $SOURCE_DIR:/laminar:ro -v $OUTPUT_DIR:/output debian:stable bash -xe <<EOS
+DOCKER_TAG=$(docker build -q - <<EOS
+FROM debian:9-slim
+RUN apt-get update && apt-get install -y wget cmake g++ libsqlite3-dev libboost-filesystem1.62-dev zlib1g-dev
+EOS
+)
 
-apt-get update
-apt-get install -y wget cmake g++ libsqlite3-dev libboost-filesystem1.62-dev zlib1g-dev
+docker run --rm -i -v $SOURCE_DIR:/laminar:ro -v $OUTPUT_DIR:/output $DOCKER_TAG bash -xe <<EOS
 
 mkdir /build
 cd /build
 
-wget -O capnproto.tar.gz https://github.com/capnproto/capnproto/archive/7a7c4007e3e1b249f078a246749a584c96bf7503.tar.gz
+wget -O capnproto.tar.gz https://github.com/capnproto/capnproto/archive/3079784bfaf3ba05edacfc63d6d494b76a85a3a5.tar.gz
 wget -O websocketpp.tar.gz https://github.com/zaphoyd/websocketpp/archive/0.7.0.tar.gz
 wget -O rapidjson.tar.gz https://github.com/miloyip/rapidjson/archive/v1.1.0.tar.gz
 md5sum -c <<EOF
-58d238ffbb19152f04d2bff520847788  capnproto.tar.gz
+c5c04c1892a381e30bd032a6bceef111  capnproto.tar.gz
 5027c20cde76fdaef83a74acfcf98e23  websocketpp.tar.gz
 badd12c511e081fec6c89c43a7027bce  rapidjson.tar.gz
 EOF
@@ -27,7 +30,7 @@ tar xzf capnproto.tar.gz
 tar xzf websocketpp.tar.gz
 tar xzf rapidjson.tar.gz
 
-cd /build/capnproto-7a7c4007e3e1b249f078a246749a584c96bf7503/c++/
+cd /build/capnproto-3079784bfaf3ba05edacfc63d6d494b76a85a3a5/c++/
 cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTING=off .
 make -j4
 make install

src/client.cpp

@@ -84,16 +84,16 @@ int main(int argc, char** argv) {
 
     auto& waitScope = client.getWaitScope();
 
-    if(strcmp(argv[1], "trigger") == 0) {
+    if(strcmp(argv[1], "queue") == 0) {
         if(argc < 3) {
-            fprintf(stderr, "Usage %s trigger <jobName>\n", argv[0]);
+            fprintf(stderr, "Usage %s queue <jobName>\n", argv[0]);
             return EINVAL;
         }
-        kj::Vector<capnp::RemotePromise<LaminarCi::TriggerResults>> promises;
+        kj::Vector<capnp::RemotePromise<LaminarCi::QueueResults>> promises;
         int jobNameIndex = 2;
         // make a request for each job specified on the commandline
         do {
-            auto req = laminar.triggerRequest();
+            auto req = laminar.queueRequest();
             req.setJobName(argv[jobNameIndex]);
             int n = setParams(argc - jobNameIndex - 1, &argv[jobNameIndex + 1], req);
             promises.add(req.send());
@@ -106,27 +106,58 @@ int main(int argc, char** argv) {
                 return ENOENT;
             }
         }
-    } else if(strcmp(argv[1], "start") == 0) {
+    } else if(strcmp(argv[1], "start") == 0 || strcmp(argv[1], "trigger") == 0) {
+        if(strcmp(argv[1], "trigger") == 0)
+            fprintf(stderr, "Warning: 'trigger' is deprecated, use 'queue' for the old behavior\n");
         if(argc < 3) {
-            fprintf(stderr, "Usage %s start <jobName>\n", argv[0]);
+            fprintf(stderr, "Usage %s queue <jobName>\n", argv[0]);
             return EINVAL;
         }
         kj::Vector<capnp::RemotePromise<LaminarCi::StartResults>> promises;
+        struct: public kj::TaskSet::ErrorHandler {
+            void taskFailed(kj::Exception&&) override {}
+        } ignoreFailed;
+        kj::TaskSet ts(ignoreFailed);
         int jobNameIndex = 2;
         // make a request for each job specified on the commandline
         do {
             auto req = laminar.startRequest();
             req.setJobName(argv[jobNameIndex]);
             int n = setParams(argc - jobNameIndex - 1, &argv[jobNameIndex + 1], req);
-            promises.add(req.send());
+            ts.add(req.send().then([&ret,argv,jobNameIndex](capnp::Response<LaminarCi::StartResults> resp){
+                if(resp.getResult() != LaminarCi::MethodResult::SUCCESS) {
+                    fprintf(stderr, "Failed to start job '%s'\n", argv[2]);
+                    ret = ENOENT;
+                }
+                printf("%s:%d\n", argv[jobNameIndex], resp.getBuildNum());
+            }));
             jobNameIndex += n + 1;
         } while(jobNameIndex < argc);
-        // pend on the promises
-        for(auto& p : promises) {
-            if(p.wait(waitScope).getResult() != LaminarCi::JobResult::SUCCESS) {
-                ret = EFAILED;
-            }
+        ts.onEmpty().wait(waitScope);
+    } else if(strcmp(argv[1], "run") == 0) {
+        if(argc < 3) {
+            fprintf(stderr, "Usage %s run <jobName>\n", argv[0]);
+            return EINVAL;
         }
+        struct: public kj::TaskSet::ErrorHandler {
+            void taskFailed(kj::Exception&&) override {}
+        } ignoreFailed;
+        kj::TaskSet ts(ignoreFailed);
+        int jobNameIndex = 2;
+        // make a request for each job specified on the commandline
+        do {
+            auto req = laminar.runRequest();
+            req.setJobName(argv[jobNameIndex]);
+            int n = setParams(argc - jobNameIndex - 1, &argv[jobNameIndex + 1], req);
+            ts.add(req.send().then([&ret,argv,jobNameIndex](capnp::Response<LaminarCi::RunResults> resp){
+                printf("%s:%d\n", argv[jobNameIndex], resp.getBuildNum());
+                if(resp.getResult() != LaminarCi::JobResult::SUCCESS) {
+                    ret = EFAILED;
+                }
+            }));
+            jobNameIndex += n + 1;
+        } while(jobNameIndex < argc);
+        ts.onEmpty().wait(waitScope);
     } else if(strcmp(argv[1], "set") == 0) {
         if(argc < 3) {
             fprintf(stderr, "Usage %s set param=value\n", argv[0]);

src/conf.cpp

@@ -25,13 +25,13 @@ int StringMap::convert(std::string e) { return atoi(e.c_str()); }
 
 StringMap parseConfFile(const char* path) {
     StringMap result;
-    std::fstream f(path);
+    std::ifstream f(path);
     std::string line;
     while(std::getline(f, line)) {
         if(line[0] == '#')
             continue;
-        int p = line.find('=');
-        if(p > 0) {
+        size_t p = line.find('=');
+        if(p != std::string::npos) {
             result.emplace(line.substr(0, p), line.substr(p+1));
         }
     }

src/conf.h

@@ -16,8 +16,8 @@
 /// You should have received a copy of the GNU General Public License
 /// along with Laminar.  If not, see <http://www.gnu.org/licenses/>
 ///
-#ifndef _LAMINAR_CONF_H_
-#define _LAMINAR_CONF_H_
+#ifndef LAMINAR_CONF_H_
+#define LAMINAR_CONF_H_
 
 #include <unordered_map>
 
@@ -41,4 +41,4 @@ int StringMap::convert(std::string e);
 StringMap parseConfFile(const char* path);
 
 
-#endif // _LAMINAR_CONF_H_
+#endif // LAMINAR_CONF_H_

src/database.cpp

@@ -29,8 +29,10 @@ Database::~Database() {
     sqlite3_close(hdl);
 }
 
-Database::Statement::Statement(sqlite3 *db, const char *query) {
-    sqlite3_prepare_v2(db, query, -1, &stmt, NULL);
+Database::Statement::Statement(sqlite3 *db, const char *query) :
+    stmt(nullptr)
+{
+    sqlite3_prepare_v2(db, query, -1, &stmt, nullptr);
 }
 
 Database::Statement::~Statement() {
@@ -39,38 +41,59 @@ Database::Statement::~Statement() {
 
 
 bool Database::Statement::exec() {
-    return sqlite3_step(stmt) == SQLITE_OK;
+    return sqlite3_step(stmt) == SQLITE_DONE;
 }
 
 void Database::Statement::bindValue(int i, int e) {
     sqlite3_bind_int(stmt, i, e);
 }
 
+void Database::Statement::bindValue(int i, uint e) {
+    sqlite3_bind_int(stmt, i, static_cast<int32_t>(e));
+}
+
+void Database::Statement::bindValue(int i, long e) {
+    sqlite3_bind_int64(stmt, i, e);
+}
+
+void Database::Statement::bindValue(int i, ulong e) {
+    sqlite3_bind_int64(stmt, i, static_cast<int64_t>(e));
+}
+
 void Database::Statement::bindValue(int i, const char* e) {
-    sqlite3_bind_text(stmt, i, e, -1, NULL);
+    sqlite3_bind_text(stmt, i, e, -1, nullptr);
 }
 
 void Database::Statement::bindValue(int i, const std::string& e) {
-    sqlite3_bind_text(stmt, i, e.data(), e.size(), NULL);
+    sqlite3_bind_text(stmt, i, e.data(), static_cast<int>(e.size()), nullptr);
 }
 
 template<> std::string Database::Statement::fetchColumn(int col) {
-    int sz = sqlite3_column_bytes(stmt, col);
+    uint sz = static_cast<uint>(sqlite3_column_bytes(stmt, col)); // according to documentation will never be negative
     std::string res(sz, '\0');
     memcpy(&res[0], sqlite3_column_text(stmt, col), sz);
     return res;
 }
 
 template<> const char* Database::Statement::fetchColumn(int col) {
-    return (char*)sqlite3_column_text(stmt, col);
+    // while sqlite3_column_text maybe more correctly returns an unsigned const char*, signed const char* is more consistent
+    return reinterpret_cast<const char*>(sqlite3_column_text(stmt, col));
 }
 
 template<> int Database::Statement::fetchColumn(int col) {
     return sqlite3_column_int(stmt, col);
 }
 
-template<> time_t Database::Statement::fetchColumn(int col) {
-    return sqlite3_column_int64(stmt, col);
+template<> uint Database::Statement::fetchColumn(int col) {
+    return static_cast<uint>(sqlite3_column_int(stmt, col));
+}
+
+template<> long Database::Statement::fetchColumn(int col) {
+    return static_cast<long>(sqlite3_column_int64(stmt, col));
+}
+
+template<> ulong Database::Statement::fetchColumn(int col) {
+    return static_cast<ulong>(sqlite3_column_int64(stmt, col));
 }
 
 bool Database::Statement::row() {

src/database.h

@@ -16,8 +16,8 @@
 /// You should have received a copy of the GNU General Public License
 /// along with Laminar.  If not, see <http://www.gnu.org/licenses/>
 ///
-#ifndef _LAMINAR_DATABASE_H_
-#define _LAMINAR_DATABASE_H_
+#ifndef LAMINAR_DATABASE_H_
+#define LAMINAR_DATABASE_H_
 
 #include <string>
 #include <functional>
@@ -52,6 +52,11 @@ private:
 
     public:
         Statement(sqlite3* db, const char* query);
+        Statement(const Statement&) =delete;
+        Statement(Statement&& other) {
+            stmt = other.stmt;
+            other.stmt = nullptr;
+        }
         ~Statement();
 
         // Bind several parameters in a single call. They are bound
@@ -98,7 +103,7 @@ private:
             }
         };
         template<typename...Args>
-        friend class FetchMarshaller;
+        friend struct FetchMarshaller;
 
         bool row();
 
@@ -114,6 +119,9 @@ private:
 
         // Bind value specializations
         void bindValue(int i, int e);
+        void bindValue(int i, uint e);
+        void bindValue(int i, long e);
+        void bindValue(int i, unsigned long e);
         void bindValue(int i, const char* e);
         void bindValue(int i, const std::string& e);
 
@@ -140,6 +148,8 @@ private:
 template<> std::string Database::Statement::fetchColumn(int col);
 template<> const char* Database::Statement::fetchColumn(int col);
 template<> int Database::Statement::fetchColumn(int col);
-template<> time_t Database::Statement::fetchColumn(int col);
+template<> uint Database::Statement::fetchColumn(int col);
+template<> long Database::Statement::fetchColumn(int col);
+template<> ulong Database::Statement::fetchColumn(int col);
 
-#endif // _LAMINAR_DATABASE_H_
+#endif // LAMINAR_DATABASE_H_

src/interface.h

@@ -16,8 +16,8 @@
 /// You should have received a copy of the GNU General Public License
 /// along with Laminar.  If not, see <http://www.gnu.org/licenses/>
 ///
-#ifndef INTERFACE_H
-#define INTERFACE_H
+#ifndef LAMINAR_INTERFACE_H_
+#define LAMINAR_INTERFACE_H_
 
 #include "run.h"
 
@@ -39,35 +39,35 @@ struct MonitorScope {
         LOG   // a run's log page
     };
 
-    MonitorScope(Type type = HOME, std::string job = std::string(), int num = 0) :
+    MonitorScope(Type type = HOME, std::string job = std::string(), uint num = 0) :
         type(type),
         job(job),
         num(num)
     {}
 
     // whether this scope wants status information about the given job or run
-    bool wantsStatus(std::string ajob, int anum = 0) const {
+    bool wantsStatus(std::string ajob, uint anum = 0) const {
         if(type == HOME || type == ALL) return true;
         if(type == JOB) return ajob == job;
         if(type == RUN) return ajob == job && anum == num;
         return false;
     }
 
-    bool wantsLog(std::string ajob, int anum) const {
+    bool wantsLog(std::string ajob, uint anum) const {
         return type == LOG && ajob == job && anum == num;
     }
 
     Type type;
     std::string job;
-    int num = 0;
+    uint num = 0;
 };
 
 // Represents a (websocket) client that wants to be notified about events
 // matching the supplied scope. Pass instances of this to LaminarInterface
 // registerClient and deregisterClient
 struct LaminarClient {
+    virtual ~LaminarClient() =default;
     virtual void sendMessage(std::string payload) = 0;
-    virtual void close(bool now = true) = 0;
     MonitorScope scope;
 };
 
@@ -75,6 +75,7 @@ struct LaminarClient {
 // Pass instances of this to LaminarInterface registerWaiter and
 // deregisterWaiter
 struct LaminarWaiter {
+    virtual ~LaminarWaiter() =default;
     virtual void complete(const Run*) = 0;
 };
 
@@ -82,6 +83,8 @@ struct LaminarWaiter {
 // logic. These methods fulfil the requirements of both the HTTP/Websocket
 // and RPC interfaces.
 struct LaminarInterface {
+    virtual ~LaminarInterface() =default;
+
     // Queues a job, returns immediately. Return value will be nullptr if
     // the supplied name is not a known job.
     virtual std::shared_ptr<Run> queueJob(std::string name, ParamMap params = ParamMap()) = 0;
@@ -111,13 +114,27 @@ struct LaminarInterface {
     // Implements the laminar client interface allowing the setting of
     // arbitrary parameters on a run (usually itself) to be available in
     // the environment of subsequent scripts.
-    virtual bool setParam(std::string job, int buildNum, std::string param, std::string value) = 0;
+    virtual bool setParam(std::string job, uint buildNum, std::string param, std::string value) = 0;
 
     // Fetches the content of an artifact given its filename relative to
     // $LAMINAR_HOME/archive. This shouldn't be used, because the sysadmin
     // should have configured a real webserver to serve these things.
     virtual bool getArtefact(std::string path, std::string& result) = 0;
+
+    // Fetches the content of $LAMINAR_HOME/custom/style.css or an empty
+    // string. This shouldn't be used, because the sysadmin should have
+    // configured a real webserver to serve these things.
+    virtual std::string getCustomCss() = 0;
+
+    // Abort all running jobs
+    virtual void abortAll() = 0;
+
+    // Callback for laminar to reap child processes.
+    virtual void reapChildren() = 0;
+
+    // Callback to handle a configuration modification notification
+    virtual void notifyConfigChanged() = 0;
 };
 
-#endif // INTERFACE_H
+#endif // LAMINAR_INTERFACE_H_
 

src/laminar.capnp

@@ -2,11 +2,12 @@
 
 interface LaminarCi {
 
-    trigger @0 (jobName :Text, params :List(JobParam)) -> (result :MethodResult);
-    start @1 (jobName :Text, params :List(JobParam)) -> (result :JobResult);
-    set @2 (jobName :Text, buildNum :UInt32, param :JobParam) -> (result :MethodResult);
-    lock @3 (lockName :Text) -> ();
-    release @4 (lockName :Text) -> ();
+    queue @0 (jobName :Text, params :List(JobParam)) -> (result :MethodResult);
+    start @1 (jobName :Text, params :List(JobParam)) -> (result :MethodResult, buildNum :UInt32);
+    run @2 (jobName :Text, params :List(JobParam)) -> (result :JobResult, buildNum :UInt32);
+    set @3 (jobName :Text, buildNum :UInt32, param :JobParam) -> (result :MethodResult);
+    lock @4 (lockName :Text) -> ();
+    release @5 (lockName :Text) -> ();
 
     struct JobParam {
         name @0 :Text;

src/laminar.cpp

@@ -1,5 +1,5 @@
 ///
-/// Copyright 2015-2017 Oliver Giles
+/// Copyright 2015-2018 Oliver Giles
 ///
 /// This file is part of Laminar
 ///
@@ -22,7 +22,6 @@
 #include "log.h"
 
 #include <sys/wait.h>
-#include <sys/signalfd.h>
 #include <fstream>
 #include <zlib.h>
 
@@ -41,7 +40,7 @@ class Json : public rapidjson::Writer<rapidjson::StringBuffer> {
 public:
     Json() : rapidjson::Writer<rapidjson::StringBuffer>(buf) { StartObject(); }
     template<typename T>
-    Json& set(const char* key, T value);
+    Json& set(const char* key, T value) { String(key); Int64(value); return *this; }
     Json& startObject(const char* key) { String(key); StartObject(); return *this; }
     Json& startArray(const char* key) { String(key); StartArray(); return *this; }
     const char* str() { EndObject(); return buf.GetString(); }
@@ -50,8 +49,6 @@ private:
 };
 template<> Json& Json::set(const char* key, const char* value) { String(key); String(value); return *this; }
 template<> Json& Json::set(const char* key, std::string value) { String(key); String(value.c_str()); return *this; }
-template<> Json& Json::set(const char* key, int value) { String(key); Int(value); return *this; }
-template<> Json& Json::set(const char* key, time_t value) { String(key); Int64(value); return *this; }
 
 namespace {
 // Default values when none were supplied in $LAMINAR_CONF_FILE (/etc/laminar.conf)
@@ -89,14 +86,14 @@ Laminar::Laminar() {
 
     // retrieve the last build numbers
     db->stmt("SELECT name, MAX(number) FROM builds GROUP BY name")
-    .fetch<str,int>([this](str name, int build){
+    .fetch<str,uint>([this](str name, uint build){
         buildNums[name] = build;
     });
 
-    // This is only a separate function because I imagined that it would
-    // be nice to reload some configuration during runtime without restarting
-    // the server completely. Currently not called from anywhere else
-    // TODO: implement that
+    srv = nullptr;
+
+    // Load configuration, may be called again in response to an inotify event
+    // that the configuration files have been modified
     loadConfiguration();
 }
 
@@ -116,7 +113,7 @@ void Laminar::deregisterWaiter(LaminarWaiter *waiter) {
     waiters.erase(waiter);
 }
 
-bool Laminar::setParam(std::string job, int buildNum, std::string param, std::string value) {
+bool Laminar::setParam(std::string job, uint buildNum, std::string param, std::string value) {
     if(Run* run = activeRun(job, buildNum)) {
         run->params[param] = value;
         return true;
@@ -125,11 +122,11 @@ bool Laminar::setParam(std::string job, int buildNum, std::string param, std::st
 }
 
 
-void Laminar::populateArtifacts(Json &j, std::string job, int num) const {
+void Laminar::populateArtifacts(Json &j, std::string job, uint num) const {
     fs::path dir(fs::path(homeDir)/"archive"/job/std::to_string(num));
     if(fs::is_directory(dir)) {
-        int prefixLen = (fs::path(homeDir)/"archive").string().length();
-        int scopeLen = dir.string().length();
+        size_t prefixLen = (fs::path(homeDir)/"archive").string().length();
+        size_t scopeLen = dir.string().length();
         for(fs::recursive_directory_iterator it(dir); it != fs::recursive_directory_iterator(); ++it) {
             if(!fs::is_regular_file(*it))
                 continue;
@@ -150,10 +147,10 @@ void Laminar::sendStatus(LaminarClient* client) {
             db->stmt("SELECT output, outputLen FROM builds WHERE name = ? AND number = ?")
               .bind(client->scope.job, client->scope.num)
               .fetch<str,int>([=](str maybeZipped, unsigned long sz) {
-                std::string log(sz+1,'\0');
+                str log(sz+1,'\0');
                 if(sz >= COMPRESS_LOG_MIN_SIZE) {
-                    int res = ::uncompress((unsigned char*)&log[0], &sz,
-                         (unsigned char*)maybeZipped.data(), maybeZipped.size());
+                    int res = ::uncompress((uint8_t*) log.data(), &sz,
+                         (const uint8_t*) maybeZipped.data(), maybeZipped.size());
                     if(res == Z_OK)
                         client->sendMessage(log);
                     else
@@ -169,6 +166,7 @@ void Laminar::sendStatus(LaminarClient* client) {
     Json j;
     j.set("type", "status");
     j.set("title", getenv("LAMINAR_TITLE") ?: "Laminar");
+    j.set("time", time(nullptr));
     j.startObject("data");
     if(client->scope.type == MonitorScope::RUN) {
         db->stmt("SELECT queuedAt,startedAt,completedAt, result, reason FROM builds WHERE name = ? AND number = ?")
@@ -187,7 +185,7 @@ void Laminar::sendStatus(LaminarClient* client) {
             j.set("result", to_string(RunState::RUNNING));
             db->stmt("SELECT completedAt - startedAt FROM builds WHERE name = ? ORDER BY completedAt DESC LIMIT 1")
              .bind(run->name)
-             .fetch<int>([&](int lastRuntime){
+             .fetch<uint>([&](uint lastRuntime){
                 j.set("etc", run->startedAt + lastRuntime);
             });
         }
@@ -199,7 +197,7 @@ void Laminar::sendStatus(LaminarClient* client) {
         j.startArray("recent");
         db->stmt("SELECT number,startedAt,completedAt,result,reason FROM builds WHERE name = ? ORDER BY completedAt DESC LIMIT 25")
         .bind(client->scope.job)
-        .fetch<int,time_t,time_t,int,str>([&](int build,time_t started,time_t completed,int result,str reason){
+        .fetch<uint,time_t,time_t,int,str>([&](uint build,time_t started,time_t completed,int result,str reason){
             j.StartObject();
             j.set("number", build)
              .set("completed", completed)
@@ -210,7 +208,7 @@ void Laminar::sendStatus(LaminarClient* client) {
         });
         j.EndArray();
         j.startArray("running");
-        auto p = activeJobs.get<4>().equal_range(client->scope.job);
+        auto p = activeJobs.byJobName().equal_range(client->scope.job);
         for(auto it = p.first; it != p.second; ++it) {
             const std::shared_ptr<Run> run = *it;
             j.StartObject();
@@ -223,7 +221,7 @@ void Laminar::sendStatus(LaminarClient* client) {
         }
         j.EndArray();
         int nQueued = 0;
-        for(const std::shared_ptr<Run> run : queuedJobs) {
+        for(const auto& run : queuedJobs) {
             if (run->name == client->scope.job) {
                 nQueued++;
             }
@@ -247,7 +245,7 @@ void Laminar::sendStatus(LaminarClient* client) {
     } else if(client->scope.type == MonitorScope::ALL) {
         j.startArray("jobs");
         db->stmt("SELECT name,number,startedAt,completedAt,result FROM builds GROUP BY name ORDER BY number DESC")
-        .fetch<str,int,time_t,time_t,int>([&](str name,int number, time_t started, time_t completed, int result){
+        .fetch<str,uint,time_t,time_t,int>([&](str name,uint number, time_t started, time_t completed, int result){
             j.StartObject();
             j.set("name", name);
             j.set("number", number);
@@ -263,7 +261,7 @@ void Laminar::sendStatus(LaminarClient* client) {
         });
         j.EndArray();
         j.startArray("running");
-        for(const std::shared_ptr<Run> run : activeJobs.get<3>()) {
+        for(const auto& run : activeJobs.byStartedAt()) {
             j.StartObject();
             j.set("name", run->name);
             j.set("number", run->build);
@@ -280,7 +278,7 @@ void Laminar::sendStatus(LaminarClient* client) {
     } else { // Home page
         j.startArray("recent");
         db->stmt("SELECT * FROM builds ORDER BY completedAt DESC LIMIT 15")
-        .fetch<str,int,str,time_t,time_t,time_t,int>([&](str name,int build,str node,time_t,time_t started,time_t completed,int result){
+        .fetch<str,uint,str,time_t,time_t,time_t,int>([&](str name,uint build,str node,time_t,time_t started,time_t completed,int result){
             j.StartObject();
             j.set("name", name)
              .set("number", build)
@@ -292,7 +290,7 @@ void Laminar::sendStatus(LaminarClient* client) {
         });
         j.EndArray();
         j.startArray("running");
-        for(const std::shared_ptr<Run> run : activeJobs.get<3>()) {
+        for(const auto& run : activeJobs.byStartedAt()) {
             j.StartObject();
             j.set("name", run->name);
             j.set("number", run->build);
@@ -300,14 +298,14 @@ void Laminar::sendStatus(LaminarClient* client) {
             j.set("started", run->startedAt);
             db->stmt("SELECT completedAt - startedAt FROM builds WHERE name = ? ORDER BY completedAt DESC LIMIT 1")
              .bind(run->name)
-             .fetch<int>([&](int lastRuntime){
+             .fetch<uint>([&](uint lastRuntime){
                 j.set("etc", run->startedAt + lastRuntime);
             });
             j.EndObject();
         }
         j.EndArray();
         j.startArray("queued");
-        for(const std::shared_ptr<Run> run : queuedJobs) {
+        for(const auto& run : queuedJobs) {
             j.StartObject();
             j.set("name", run->name);
             j.EndObject();
@@ -316,9 +314,9 @@ void Laminar::sendStatus(LaminarClient* client) {
         int execTotal = 0;
         int execBusy = 0;
         for(const auto& it : nodes) {
-            const Node& node = it.second;
-            execTotal += node.numExecutors;
-            execBusy += node.busyExecutors;
+            const std::shared_ptr<Node>& node = it.second;
+            execTotal += node->numExecutors;
+            execBusy += node->busyExecutors;
         }
         j.set("executorsTotal", execTotal);
         j.set("executorsBusy", execBusy);
@@ -326,7 +324,7 @@ void Laminar::sendStatus(LaminarClient* client) {
         for(int i = 6; i >= 0; --i) {
             j.StartObject();
             db->stmt("SELECT result, COUNT(*) FROM builds WHERE completedAt > ? AND completedAt < ? GROUP by result")
-                    .bind(86400*(time(0)/86400 - i), 86400*(time(0)/86400 - (i-1)))
+                    .bind(86400*(time(nullptr)/86400 - i), 86400*(time(nullptr)/86400 - (i-1)))
                     .fetch<int,int>([&](int result, int num){
                 j.set(to_string(RunState(result)).c_str(), num);
             });
@@ -335,15 +333,15 @@ void Laminar::sendStatus(LaminarClient* client) {
         j.EndArray();
         j.startObject("buildsPerJob");
         db->stmt("SELECT name, COUNT(*) FROM builds WHERE completedAt > ? GROUP BY name")
-                .bind(time(0) - 86400)
+                .bind(time(nullptr) - 86400)
                 .fetch<str, int>([&](str job, int count){
             j.set(job.c_str(), count);
         });
         j.EndObject();
         j.startObject("timePerJob");
         db->stmt("SELECT name, AVG(completedAt-startedAt) FROM builds WHERE completedAt > ? GROUP BY name")
-                .bind(time(0) - 7 * 86400)
-                .fetch<str, int>([&](str job, int time){
+                .bind(time(nullptr) - 7 * 86400)
+                .fetch<str, uint>([&](str job, uint time){
             j.set(job.c_str(), time);
         });
         j.EndObject();
@@ -364,39 +362,20 @@ void Laminar::run() {
     const char* listen_http = getenv("LAMINAR_BIND_HTTP") ?: INTADDR_HTTP_DEFAULT;
 
     srv = new Server(*this, listen_rpc, listen_http);
-
-    // handle SIGCHLD
-    sigset_t mask;
-    sigemptyset(&mask);
-    sigaddset(&mask, SIGCHLD);
-    sigprocmask(SIG_BLOCK, &mask, NULL);
-    int sigchld = signalfd(-1, &mask, SFD_NONBLOCK|SFD_CLOEXEC);
-    srv->addDescriptor(sigchld, [this](const char* buf, size_t sz){
-        struct signalfd_siginfo* siginfo = (struct signalfd_siginfo*) buf;
-        // TODO: re-enable assertion when the cause for its triggering
-        // is discovered and solved
-        //KJ_ASSERT(siginfo->ssi_signo == SIGCHLD);
-        if(siginfo->ssi_signo == SIGCHLD) {
-            reapAdvance();
-            assignNewJobs();
-        } else {
-            LLOG(ERROR, "Unexpected signo", siginfo->ssi_signo);
-        }
-    });
-
+    srv->addWatchPath(fs::path(fs::path(homeDir)/"cfg"/"nodes").string().c_str());
+    srv->addWatchPath(fs::path(fs::path(homeDir)/"cfg"/"jobs").string().c_str());
     srv->start();
 }
 
 void Laminar::stop() {
-    clients.clear();
     srv->stop();
 }
 
 bool Laminar::loadConfiguration() {
     if(const char* ndirs = getenv("LAMINAR_KEEP_RUNDIRS"))
-        numKeepRunDirs = atoi(ndirs);
+        numKeepRunDirs = static_cast<uint>(atoi(ndirs));
 
-    NodeMap nm;
+    std::set<std::string> knownNodes;
 
     fs::path nodeCfg = fs::path(homeDir)/"cfg"/"nodes";
 
@@ -407,9 +386,11 @@ bool Laminar::loadConfiguration() {
 
             StringMap conf = parseConfFile(it->path().string().c_str());
 
-            Node node;
-            node.name = it->path().stem().string();
-            node.numExecutors = conf.get<int>("EXECUTORS", 6);
+            std::string nodeName = it->path().stem().string();
+            auto existingNode = nodes.find(nodeName);
+            std::shared_ptr<Node> node = existingNode == nodes.end() ? nodes.emplace(nodeName, std::shared_ptr<Node>(new Node)).first->second : existingNode->second;
+            node->name = nodeName;
+            node->numExecutors = conf.get<int>("EXECUTORS", 6);
 
             std::string tags = conf.get<std::string>("TAGS");
             if(!tags.empty()) {
@@ -418,22 +399,29 @@ bool Laminar::loadConfiguration() {
                 std::string tag;
                 while(std::getline(iss, tag, ','))
                     tagList.insert(tag);
-                node.tags = tagList;
+                node->tags = tagList;
             }
 
-            nm.emplace(node.name, std::move(node));
+            knownNodes.insert(nodeName);
         }
     }
 
-    if(nm.empty()) {
-        // add a default node
-        Node node;
-        node.name = "";
-        node.numExecutors = 6;
-        nm.emplace("", std::move(node));
+    // remove any nodes whose config files disappeared.
+    // if there are no known nodes, take care not to remove and re-add the default node
+    for(auto it = nodes.begin(); it != nodes.end();) {
+        if((it->first == "" && knownNodes.size() == 0) || knownNodes.find(it->first) != knownNodes.end())
+            it++;
+        else
+            it = nodes.erase(it);
     }
 
-    nodes = nm;
+    // add a default node
+    if(nodes.empty()) {
+        std::shared_ptr<Node> node(new Node);
+        node->name = "";
+        node->numExecutors = 6;
+        nodes.emplace("", node);
+    }
 
     fs::path jobsDir = fs::path(homeDir)/"cfg"/"jobs";
     if(fs::is_directory(jobsDir)) {
@@ -467,7 +455,7 @@ std::shared_ptr<Run> Laminar::queueJob(std::string name, ParamMap params) {
 
     std::shared_ptr<Run> run = std::make_shared<Run>();
     run->name = name;
-    run->queuedAt = time(0);
+    run->queuedAt = time(nullptr);
     for(auto it = params.begin(); it != params.end();) {
         if(it->first[0] == '=') {
             if(it->first == "=parentJob") {
@@ -522,30 +510,46 @@ void Laminar::handleRunLog(std::shared_ptr<Run> run, std::string s) {
 
 // Reaps a zombie and steps the corresponding Run to its next state.
 // Should be called on SIGCHLD
-void Laminar::reapAdvance() {
+void Laminar::reapChildren() {
     int ret = 0;
     pid_t pid;
-    static thread_local char buf[1024];
+    constexpr int bufsz = 1024;
+    static thread_local char buf[bufsz];
     while((pid = waitpid(-1, &ret, WNOHANG)) > 0) {
         LLOG(INFO, "Reaping", pid);
-        auto it = activeJobs.get<0>().find(pid);
+        auto it = activeJobs.byPid().find(pid);
         std::shared_ptr<Run> run = *it;
         // The main event loop might schedule this SIGCHLD handler before the final
         // output handler (from addDescriptor). In that case, because it keeps a
         // shared_ptr to the run it would successfully add to the log output buffer,
         // but by then reapAdvance would have stored the log and ensured no-one cares.
         // Preempt this case by forcing a final (non-blocking) read here.
-        for(ssize_t n = read(run->fd, buf, 1024); n > 0; n = read(run->fd, buf, 1024)) {
-            handleRunLog(run, std::string(buf, n));
+        for(ssize_t n = read(run->fd, buf, bufsz); n > 0; n = read(run->fd, buf, bufsz)) {
+            handleRunLog(run, std::string(buf, static_cast<size_t>(n)));
         }
         bool completed = true;
-        activeJobs.get<0>().modify(it, [&](std::shared_ptr<Run> run){
+        activeJobs.byPid().modify(it, [&](std::shared_ptr<Run> run){
             run->reaped(ret);
             completed = stepRun(run);
         });
         if(completed)
             run->complete();
     }
+
+    assignNewJobs();
+}
+
+void Laminar::notifyConfigChanged()
+{
+    loadConfiguration();
+    // config change may allow stuck jobs to dequeue
+    assignNewJobs();
+}
+
+void Laminar::abortAll() {
+    for(std::shared_ptr<Run> run : activeJobs) {
+        run->abort();
+    }
 }
 
 bool Laminar::nodeCanQueue(const Node& node, const Run& run) const {
@@ -576,9 +580,9 @@ void Laminar::assignNewJobs() {
     while(it != queuedJobs.end()) {
         bool assigned = false;
         for(auto& sn : nodes) {
-            Node& node = sn.second;
+            std::shared_ptr<Node> node = sn.second;
             std::shared_ptr<Run> run = *it;
-            if(nodeCanQueue(node, *run)) {
+            if(nodeCanQueue(*node.get(), *run)) {
                 fs::path cfgDir = fs::path(homeDir)/"cfg";
                 boost::system::error_code err;
 
@@ -594,7 +598,7 @@ void Laminar::assignNewJobs() {
                         run->addScript((cfgDir/"jobs"/run->name+".init").string(), ws.string());
                 }
 
-                int buildNum = buildNums[run->name] + 1;
+                uint buildNum = buildNums[run->name] + 1;
                 // create the run directory
                 fs::path rd = fs::path(homeDir)/"run"/run->name/std::to_string(buildNum);
                 bool createWorkdir = true;
@@ -626,8 +630,8 @@ void Laminar::assignNewJobs() {
                 if(fs::exists(cfgDir/"before"))
                     run->addScript((cfgDir/"before").string());
                 // per-node before-run script
-                if(fs::exists(cfgDir/"nodes"/node.name+".before"))
-                    run->addScript((cfgDir/"nodes"/node.name+".before").string());
+                if(fs::exists(cfgDir/"nodes"/node->name+".before"))
+                    run->addScript((cfgDir/"nodes"/node->name+".before").string());
                 // job before-run script
                 if(fs::exists(cfgDir/"jobs"/run->name+".before"))
                     run->addScript((cfgDir/"jobs"/run->name+".before").string());
@@ -637,8 +641,8 @@ void Laminar::assignNewJobs() {
                 if(fs::exists(cfgDir/"jobs"/run->name+".after"))
                     run->addScript((cfgDir/"jobs"/run->name+".after").string());
                 // per-node after-run script
-                if(fs::exists(cfgDir/"nodes"/node.name+".after"))
-                    run->addScript((cfgDir/"nodes"/node.name+".after").string());
+                if(fs::exists(cfgDir/"nodes"/node->name+".after"))
+                    run->addScript((cfgDir/"nodes"/node->name+".after").string());
                 // global after-run script
                 if(fs::exists(cfgDir/"after"))
                     run->addScript((cfgDir/"after").string());
@@ -646,15 +650,29 @@ void Laminar::assignNewJobs() {
                 // add environment files
                 if(fs::exists(cfgDir/"env"))
                     run->addEnv((cfgDir/"env").string());
-                if(fs::exists(cfgDir/"nodes"/node.name+".env"))
-                    run->addEnv((cfgDir/"nodes"/node.name+".env").string());
+                if(fs::exists(cfgDir/"nodes"/node->name+".env"))
+                    run->addEnv((cfgDir/"nodes"/node->name+".env").string());
                 if(fs::exists(cfgDir/"jobs"/run->name+".env"))
                     run->addEnv((cfgDir/"jobs"/run->name+".env").string());
 
+                // add job timeout if specified
+                if(fs::exists(cfgDir/"jobs"/run->name+".conf")) {
+                    int timeout = parseConfFile(fs::path(cfgDir/"jobs"/run->name+".conf").string().c_str()).get<int>("TIMEOUT", 0);
+                    if(timeout > 0) {
+                        // A raw pointer to run is used here so as not to have a circular reference.
+                        // The captured raw pointer is safe because if the Run is destroyed the Promise
+                        // will be cancelled and the callback never called.
+                        Run* r = run.get();
+                        r->timeout = srv->addTimeout(timeout, [r](){
+                            r->abort();
+                        });
+                    }
+                }
+
                 // start the job
-                node.busyExecutors++;
-                run->node = &node;
-                run->startedAt = time(0);
+                node->busyExecutors++;
+                run->node = node;
+                run->startedAt = time(nullptr);
                 run->laminarHome = homeDir;
                 run->build = buildNum;
                 // set the last known result if exists
@@ -666,7 +684,7 @@ void Laminar::assignNewJobs() {
                 // update next build number
                 buildNums[run->name] = buildNum;
 
-                LLOG(INFO, "Queued job to node", run->name, run->build, node.name);
+                LLOG(INFO, "Queued job to node", run->name, run->build, node->name);
 
                 // notify clients
                 Json j;
@@ -680,8 +698,8 @@ void Laminar::assignNewJobs() {
                  .set("reason", run->reason());
                 db->stmt("SELECT completedAt - startedAt FROM builds WHERE name = ? ORDER BY completedAt DESC LIMIT 1")
                  .bind(run->name)
-                 .fetch<int>([&](int etc){
-                    j.set("etc", time(0) + etc);
+                 .fetch<uint>([&](uint etc){
+                    j.set("etc", time(nullptr) + etc);
                 });
                 j.EndObject();
                 const char* msg = j.str();
@@ -694,6 +712,9 @@ void Laminar::assignNewJobs() {
                         c->sendMessage(msg);
                 }
 
+                // notify the rpc client if the start command was used
+                run->started.fulfiller->fulfill();
+
                 // setup run completion handler
                 run->notifyCompletion = [this](Run* r) { runFinished(r); };
 
@@ -718,11 +739,11 @@ void Laminar::assignNewJobs() {
 }
 
 void Laminar::runFinished(Run * r) {
-    Node* node = r->node;
+    std::shared_ptr<Node> node = r->node;
 
     node->busyExecutors--;
     LLOG(INFO, "Run completed", r->name, to_string(r->result));
-    time_t completedAt = time(0);
+    time_t completedAt = time(nullptr);
 
     // compress log
     std::string maybeZipped = r->log;
@@ -730,8 +751,8 @@ void Laminar::runFinished(Run * r) {
     if(r->log.length() >= COMPRESS_LOG_MIN_SIZE) {
         std::string zipped(r->log.size(), '\0');
         unsigned long zippedSize = zipped.size();
-        if(::compress((unsigned char*)&zipped[0], &zippedSize,
-            (unsigned char*)&r->log[0], logsize) == Z_OK) {
+        if(::compress((uint8_t*) zipped.data(), &zippedSize,
+            (const uint8_t*) r->log.data(), logsize) == Z_OK) {
             zipped.resize(zippedSize);
             std::swap(maybeZipped, zipped);
         }
@@ -770,7 +791,7 @@ void Laminar::runFinished(Run * r) {
     }
 
     // erase reference to run from activeJobs
-    activeJobs.get<2>().erase(r);
+    activeJobs.byRunPtr().erase(r);
 
     // remove old run directories
     // We cannot count back the number of directories to keep from the currently
@@ -780,9 +801,9 @@ void Laminar::runFinished(Run * r) {
     // from the oldest among them. If there are none, count back from the latest
     // known build number of this job, which may not be that of the run that
     // finished here.
-    auto it = activeJobs.get<4>().equal_range(r->name);
+    auto it = activeJobs.byJobName().equal_range(r->name);
     uint oldestActive = (it.first == it.second)? buildNums[r->name] : (*it.first)->build - 1;
-    for(int i = oldestActive - numKeepRunDirs; i > 0; i--) {
+    for(int i = static_cast<int>(oldestActive - numKeepRunDirs); i > 0; i--) {
         fs::path d = fs::path(homeDir)/"run"/r->name/std::to_string(i);
         // Once the directory does not exist, it's probably not worth checking
         // any further. 99% of the time this loop should only ever have 1 iteration
@@ -793,25 +814,38 @@ void Laminar::runFinished(Run * r) {
     }
 }
 
+// Small helper function to return the full contents of a file given its path.
+// It reads in the whole file into the given string reference.
+// This is a terrible way to serve files (especially large ones). Hopefully
+// no-one uses this function and configures their webservers appropriately.
+static bool slurp(fs::path path, std::string& output) {
+    if(!fs::is_regular_file(path))
+        return false;
+    std::ifstream fstr(path.string());
+    fstr.seekg(0, std::ios::end);
+    ssize_t sz = fstr.tellg();
+    if(fstr.good()) {
+        output.resize(static_cast<size_t>(sz));
+        fstr.seekg(0);
+        fstr.read(&output[0], sz);
+        return true;
+    }
+    return false;
+}
+
 bool Laminar::getArtefact(std::string path, std::string& result) {
     if(archiveUrl != ARCHIVE_URL_DEFAULT) {
         // we shouldn't have got here. Probably an invalid link.
         return false;
     }
-    // Reads in the whole file into the given string reference.
-    // This is a terrible way to serve files (especially large ones).
     fs::path file(fs::path(homeDir)/"archive"/path);
-    // no support for browsing archived directories
-    if(fs::is_directory(file))
-        return false;
-    std::ifstream fstr(file.string());
-    fstr.seekg(0, std::ios::end);
-    size_t sz = fstr.tellg();
-    if(fstr.rdstate() == 0) {
-        result.resize(sz);
-        fstr.seekg(0);
-        fstr.read(&result[0], sz);
-        return true;
-    }
-    return false;
+    return slurp(file, result);
+}
+
+std::string Laminar::getCustomCss()
+{
+    fs::path file(fs::path(homeDir)/"custom"/"style.css");
+    std::string result;
+    slurp(file, result);
+    return result;
 }

src/laminar.h

@@ -16,8 +16,8 @@
 /// You should have received a copy of the GNU General Public License
 /// along with Laminar.  If not, see <http://www.gnu.org/licenses/>
 ///
-#ifndef _LAMINAR_LAMINAR_H_
-#define _LAMINAR_LAMINAR_H_
+#ifndef LAMINAR_LAMINAR_H_
+#define LAMINAR_LAMINAR_H_
 
 #include "interface.h"
 #include "run.h"
@@ -27,7 +27,7 @@
 #include <unordered_map>
 
 // Node name to node object map
-typedef std::unordered_map<std::string,Node> NodeMap;
+typedef std::unordered_map<std::string, std::shared_ptr<Node>> NodeMap;
 
 struct Server;
 class Json;
@@ -39,7 +39,7 @@ class Json;
 class Laminar final : public LaminarInterface {
 public:
     Laminar();
-    ~Laminar();
+    ~Laminar() override;
 
     // Runs the application forever
     void run();
@@ -54,23 +54,26 @@ public:
     void deregisterWaiter(LaminarWaiter* waiter) override;
 
     void sendStatus(LaminarClient* client) override;
-    bool setParam(std::string job, int buildNum, std::string param, std::string value) override;
+    bool setParam(std::string job, uint buildNum, std::string param, std::string value) override;
     bool getArtefact(std::string path, std::string& result) override;
+    std::string getCustomCss() override;
+    void abortAll() override;
+    void reapChildren() override;
+    void notifyConfigChanged() override;
 
 private:
     bool loadConfiguration();
-    void reapAdvance();
     void assignNewJobs();
     bool stepRun(std::shared_ptr<Run> run);
     void handleRunLog(std::shared_ptr<Run> run, std::string log);
     void runFinished(Run*);
     bool nodeCanQueue(const Node&, const Run&) const;
     // expects that Json has started an array
-    void populateArtifacts(Json& out, std::string job, int num) const;
+    void populateArtifacts(Json& out, std::string job, uint num) const;
 
-    Run* activeRun(std::string name, int num) {
-        auto it = activeJobs.get<1>().find(boost::make_tuple(name, num));
-        return it == activeJobs.get<1>().end() ? nullptr : it->get();
+    Run* activeRun(std::string name, uint num) {
+        auto it = activeJobs.byRun().find(boost::make_tuple(name, num));
+        return it == activeJobs.byRun().end() ? nullptr : it->get();
     }
 
     std::list<std::shared_ptr<Run>> queuedJobs;
@@ -90,4 +93,4 @@ private:
     std::string archiveUrl;
 };
 
-#endif // _LAMINAR_LAMINAR_H_
+#endif // LAMINAR_LAMINAR_H_

src/log.h

@@ -16,8 +16,8 @@
 /// You should have received a copy of the GNU General Public License
 /// along with Laminar.  If not, see <http://www.gnu.org/licenses/>
 ///
-#ifndef _LAMINAR_LOG_H_
-#define _LAMINAR_LOG_H_
+#ifndef LAMINAR_LOG_H_
+#define LAMINAR_LOG_H_
 
 #include <kj/debug.h>
 
@@ -33,5 +33,5 @@
                         #__VA_ARGS__, __VA_ARGS__)
 
 
-#endif // _LAMINAR_LOG_H_
+#endif // LAMINAR_LOG_H_
 

src/node.h

@@ -16,8 +16,8 @@
 /// You should have received a copy of the GNU General Public License
 /// along with Laminar.  If not, see <http://www.gnu.org/licenses/>
 ///
-#ifndef _LAMINAR_NODE_H_
-#define _LAMINAR_NODE_H_
+#ifndef LAMINAR_NODE_H_
+#define LAMINAR_NODE_H_
 
 #include <string>
 #include <set>
@@ -40,4 +40,4 @@ public:
 };
 
 
-#endif // _LAMINAR_NODE_H_
+#endif // LAMINAR_NODE_H_

src/resources.cpp

@@ -27,7 +27,6 @@
 #define CONTENT_TYPE_HTML "text/html; charset=utf-8"
 #define CONTENT_TYPE_ICO  "image/x-icon"
 #define CONTENT_TYPE_PNG  "image/png"
-#define CONTENT_TYPE_GIF  "image/gif"
 #define CONTENT_TYPE_JS   "application/javascript; charset=utf-8"
 #define CONTENT_TYPE_CSS  "text/css; charset=utf-8"
 
@@ -37,9 +36,6 @@ Resources::Resources()
     INIT_RESOURCE("/favicon.ico", favicon_ico, CONTENT_TYPE_ICO);
     INIT_RESOURCE("/favicon-152.png", favicon_152_png, CONTENT_TYPE_PNG);
     INIT_RESOURCE("/icon.png", icon_png, CONTENT_TYPE_PNG);
-    INIT_RESOURCE("/tick.gif", tick_gif, CONTENT_TYPE_GIF);
-    INIT_RESOURCE("/cross.gif", cross_gif, CONTENT_TYPE_GIF);
-    INIT_RESOURCE("/spin.gif", spin_gif, CONTENT_TYPE_GIF);
     INIT_RESOURCE("/js/app.js", js_app_js, CONTENT_TYPE_JS);
     INIT_RESOURCE("/js/Chart.HorizontalBar.js", js_Chart_HorizontalBar_js, CONTENT_TYPE_JS);
     INIT_RESOURCE("/js/ansi_up.js", js_ansi_up_js, CONTENT_TYPE_JS);

src/resources.h

@@ -16,8 +16,8 @@
 /// You should have received a copy of the GNU General Public License
 /// along with Laminar.  If not, see <http://www.gnu.org/licenses/>
 ///
-#ifndef _LAMINAR_RESOURCES_H_
-#define _LAMINAR_RESOURCES_H_
+#ifndef LAMINAR_RESOURCES_H_
+#define LAMINAR_RESOURCES_H_
 
 #include <unordered_map>
 #include <utility>
@@ -43,4 +43,4 @@ private:
     std::unordered_map<std::string, const Resource> resources;
 };
 
-#endif // _LAMINAR_RESOURCES_H_
+#endif // LAMINAR_RESOURCES_H_

src/resources/index.html

@@ -14,6 +14,7 @@
  <script src="/js/Chart.min.js"></script>
  <script src="/js/Chart.HorizontalBar.js"></script>
  <link href="/css/bootstrap.min.css" rel="stylesheet">
+ <link href="/custom/style.css" rel="stylesheet">
  <script src="/js/app.js" defer></script>
  <style>
   body, html { height: 100%; }
@@ -24,6 +25,9 @@
   a.navbar-btn.active { color: #fff; }
   a.navbar-btn:hover { color: #fff; text-decoration: none; }
   a.navbar-btn:focus { color: #fff; }
+  .bell { margin: 8px 15px; color: #9d9d9d; }
+  .bell:hover { text-decoration: none; color: #9d9d9d; cursor: pointer; }
+  .bell.active { color: #333; }
   dt,dd { line-height: 2; }
   canvas {
    width: 100% !important;
@@ -36,6 +40,30 @@
    margin-bottom: 0;
   }
   table#joblist tr:first-child td { border-top: 0; }
+  #popup-connecting {
+    position: fixed;
+    background: white;
+    border: 1px solid #ddd;
+    bottom: 10px;
+    right: 10px;
+    padding: 20px;
+  }
+  span.status {
+    display: inline-block;
+    width: 1em;
+    text-align: center;
+    font-family: sans-serif;
+  }
+  span.success { color: forestgreen; }
+  span.failed { color: firebrick; }
+  span.aborted { color: indigo; }
+  span.spin {
+    color: steelblue;
+    animation: 2s linear infinite spin;
+  }
+  @keyframes spin {
+    to { transform: rotate(360deg); }
+  }
  </style>
 </head>
 <body>
@@ -210,14 +238,14 @@
 
  <div id="app">
   <nav class="navbar navbar-inverse">
-   <div class="container-fluid">
-    <div>
-     <router-link to="/" class="navbar-brand"><img src="/icon.png">{{title}}</router-link>
-     <router-link to="/jobs" class="btn navbar-btn pull-right">Jobs</router-link>
-    </div>
+   <div>
+    <router-link to="/" class="navbar-brand"><img src="/icon.png">{{title}}</router-link>
+    <router-link to="/jobs" class="btn navbar-btn pull-right">Jobs</router-link>
    </div>
   </nav>
+  <a v-on:click="toggleNotifications(!notify)" v-show="supportsNotifications" class="bell pull-right" :class="{'active':notify}" :title="(notify?'Disable':'Enable')+' notifications'">&#128276;</a>
   <router-view></router-view>
+  <div v-show="!connected" id="popup-connecting"><span class="status spin">⚙&#xfe0e;</span>&nbsp;Connecting...</div>
  </div>
 </body>
 </html>

src/resources/js/app.js

@@ -24,6 +24,9 @@ const WebsocketHandler = function() {
           comp.ws = this;
           // Update html and nav titles
           document.title = comp.$root.title = msg.title;
+          // Calculate clock offset (used by ProgressUpdater)
+          comp.$root.clockSkew = msg.time - Math.floor((new Date()).getTime()/1000);
+          comp.$root.connected = true;
           // Component-specific callback handler
           comp[msg.type](msg.data);
         });
@@ -31,10 +34,28 @@ const WebsocketHandler = function() {
         // at this point, the component must be defined
         if (!this.comp)
           return console.error("Page component was undefined");
-        else if (typeof this.comp[msg.type] === 'function')
-          this.comp[msg.type](msg.data);
+        else {
+          this.comp.$root.showNotify(msg.type, msg.data);
+          if(typeof this.comp[msg.type] === 'function')
+            this.comp[msg.type](msg.data);
+        }
       }
     };
+    ws.onclose = function(ev) {
+      // if this.comp isn't set, this connection has never been used
+      // and a re-connection isn't meaningful
+      if(!ev.wasClean && 'comp' in this) {
+        this.comp.$root.connected = false;
+        this.reconnectTimeout = setTimeout(()=>{
+          var newWs = setupWebsocket(path, (fn) => { fn(this.comp); });
+          // pass on the current component for the cases where the
+          // connection fails (onclose is called again) before the
+          // status message can reassign the current component
+          newWs.comp = this.comp;
+        }, 2000);
+      }
+    }
+    return ws;
   };
   return {
     beforeRouteEnter(to, from, next) {
@@ -42,19 +63,29 @@ const WebsocketHandler = function() {
     },
     beforeRouteUpdate(to, from, next) {
       this.ws.close();
+      clearTimeout(this.ws.reconnectTimeout);
       setupWebsocket(to.path, (fn) => { fn(this); next(); });
     },
     beforeRouteLeave(to, from, next) {
       this.ws.close();
+      clearTimeout(this.ws.reconnectTimeout);
       next();
-    },
+    }
   };
 }();
 
 const Utils = {
   methods: {
     runIcon(result) {
-      return result === "success" ? '<img src="/tick.gif">' : result === "failed" || result === "aborted" ? '<img src="/cross.gif">' : '<img src="/spin.gif">';
+      var marker = '⚙';
+      var classname = result;
+      if (result === 'success')
+         marker = '✔';
+      else if (result === 'failed' || result === 'aborted')
+         marker = '✘';
+      else
+         classname = 'spin';
+      return '<span title="' + result + '" class="status ' + classname + '">' + marker + '&#xfe0e;</span>';
     },
     formatDate: function(unix) {
       // TODO: reimplement when toLocaleDateString() accepts formatting options on most browsers
@@ -69,7 +100,7 @@ const Utils = {
     },
     formatDuration: function(start, end) {
       if(!end)
-        end = Math.floor(Date.now()/1000);
+        end = Math.floor(Date.now()/1000) + this.$root.clockSkew;
       if(end - start > 3600)
         return Math.floor((end-start)/3600) + ' hours, ' + Math.floor(((end-start)%3600)/60) + ' minutes';
       else if(end - start > 60)
@@ -85,7 +116,7 @@ const ProgressUpdater = {
   methods: {
     updateProgress(o) {
       if (o.etc) {
-        var p = ((new Date()).getTime() / 1000 - o.started) / (o.etc - o.started);
+        var p = (Math.floor(Date.now()/1000) + this.$root.clockSkew - o.started) / (o.etc - o.started);
         if (p > 1.2) {
           o.overtime = true;
         } else if (p >= 1) {
@@ -430,7 +461,7 @@ const Run = function() {
   };
   var firstLog = false;
   var logHandler = function(vm, d) {
-    state.log += d;
+    state.log += ansi_up.ansi_to_html(d.replace(/</g,'&lt;').replace(/>/g,'&gt;'));
     vm.$forceUpdate();
     if (!firstLog) {
       firstLog = true;
@@ -448,7 +479,6 @@ const Run = function() {
     methods: {
       status: function(data) {
         state.jobsRunning = [];
-        state.log = '';
         state.job = data;
         state.latestNum = data.latestNum;
         state.jobsRunning = [data];
@@ -468,6 +498,7 @@ const Run = function() {
     },
     beforeRouteEnter(to, from, next) {
       next(vm => {
+        state.log = '';
         vm.logws = wsp(to.path + '/log');
         vm.logws.onmessage = function(msg) {
           logHandler(vm, msg.data);
@@ -477,6 +508,7 @@ const Run = function() {
     beforeRouteUpdate(to, from, next) {
       var vm = this;
       vm.logws.close();
+      state.log = '';
       vm.logws = wsp(to.path + '/log');
       vm.logws.onmessage = function(msg) {
         logHandler(vm, msg.data);
@@ -493,7 +525,32 @@ const Run = function() {
 new Vue({
   el: '#app',
   data: {
-    title: '' // populated by status ws message
+    title: '', // populated by status ws message
+    clockSkew: 0,
+    connected: false,
+    notify: 'localStorage' in window && localStorage.getItem('showNotifications') == 1
+  },
+  computed: {
+    supportsNotifications() {
+      return 'Notification' in window && Notification.permission !== 'denied';
+    }
+  },
+  methods: {
+    toggleNotifications(en) {
+      if(Notification.permission !== 'granted')
+        Notification.requestPermission(p => this.notify = (p === 'granted'))
+      else
+        this.notify = en;
+    },
+    showNotify(msg, data) {
+      if(this.notify && msg === 'job_completed')
+        new Notification('Job ' + data.result, {
+          body: data.name + ' ' + '#' + data.number + ': ' + data.result
+        });
+    }
+  },
+  watch: {
+    notify(e) { localStorage.setItem('showNotifications', e ? 1 : 0); }
   },
   router: new VueRouter({
     mode: 'history',

src/run.cpp

@@ -35,7 +35,6 @@ std::string to_string(const RunState& rs) {
     case RunState::ABORTED: return "aborted";
     case RunState::FAILED: return "failed";
     case RunState::SUCCESS: return "success";
-    case RunState::UNKNOWN:
     default:
          return "unknown";
     }
@@ -59,9 +58,6 @@ std::string Run::reason() const {
 }
 
 bool Run::step() {
-    if(!currentScript.path.empty() && procStatus != 0)
-        result = RunState::FAILED;
-
     if(scripts.size()) {
         currentScript = scripts.front();
         scripts.pop();
@@ -74,7 +70,10 @@ bool Run::step() {
             sigset_t mask;
             sigemptyset(&mask);
             sigaddset(&mask, SIGCHLD);
-            sigprocmask(SIG_UNBLOCK, &mask, NULL);
+            sigprocmask(SIG_UNBLOCK, &mask, nullptr);
+
+            // set pgid == pid for easy killing on abort
+            setpgid(0, 0);
 
             close(pfd[0]);
             dup2(pfd[1], 1);
@@ -128,14 +127,31 @@ bool Run::step() {
         return true;
     }
 }
+
 void Run::addScript(std::string scriptPath, std::string scriptWorkingDir) {
     scripts.push({scriptPath, scriptWorkingDir});
 }
+
 void Run::addEnv(std::string path) {
     env.push_back(path);
 }
+
+void Run::abort() {
+    // clear all pending scripts
+    std::queue<Script>().swap(scripts);
+    kill(-pid, SIGTERM);
+}
+
 void Run::reaped(int status) {
-    procStatus = status;
+    // once state is non-success it cannot change again
+    if(result != RunState::SUCCESS)
+        return;
+
+    if(WIFSIGNALED(status) && (WTERMSIG(status) == SIGTERM || WTERMSIG(status) == SIGKILL))
+        result = RunState::ABORTED;
+    else if(status != 0)
+        result = RunState::FAILED;
+    // otherwise preserve earlier status
 }
 
 void Run::complete() {

src/run.h

@@ -16,8 +16,8 @@
 /// You should have received a copy of the GNU General Public License
 /// along with Laminar.  If not, see <http://www.gnu.org/licenses/>
 ///
-#ifndef _LAMINAR_RUN_H_
-#define _LAMINAR_RUN_H_
+#ifndef LAMINAR_RUN_H_
+#define LAMINAR_RUN_H_
 
 #include <string>
 #include <queue>
@@ -25,6 +25,8 @@
 #include <functional>
 #include <ostream>
 #include <unordered_map>
+#include <memory>
+#include <kj/async.h>
 
 enum class RunState {
     UNKNOWN,
@@ -65,6 +67,9 @@ public:
     // adds an environment file that will be sourced before this run
     void addEnv(std::string path);
 
+    // aborts this run
+    void abort();
+
     // called when a process owned by this run has been reaped. The status
     // may be used to set the run's job status
     void reaped(int status);
@@ -72,7 +77,7 @@ public:
     std::string reason() const;
 
     std::function<void(Run*)> notifyCompletion;
-    Node* node;
+    std::shared_ptr<Node> node;
     RunState result;
     RunState lastResult;
     std::string laminarHome;
@@ -81,12 +86,13 @@ public:
     std::string parentName;
     int parentBuild = 0;
     std::string reasonMsg;
-    int build = 0;
+    uint build = 0;
     std::string log;
     pid_t pid;
     int fd;
-    int procStatus;
     std::unordered_map<std::string, std::string> params;
+    kj::Promise<void> timeout = kj::NEVER_DONE;
+    kj::PromiseFulfillerPair<void> started = kj::newPromiseAndFulfiller<void>();
 
     time_t queuedAt;
     time_t startedAt;
@@ -132,7 +138,7 @@ struct _run_index : bmi::indexed_by<
             std::shared_ptr<Run>,
         // a combination of their job name and build number
             bmi::member<Run, std::string, &Run::name>,
-            bmi::member<Run, int, &Run::build>
+            bmi::member<Run, uint, &Run::build>
         >>,
         // or a pointer to a Run object.
         bmi::hashed_unique<_run_same>,
@@ -147,7 +153,20 @@ struct RunSet: public boost::multi_index_container<
     std::shared_ptr<Run>,
     _run_index
 > {
-    // TODO: getters for each index
+    typename bmi::nth_index<RunSet, 0>::type& byPid() { return get<0>(); }
+    typename bmi::nth_index<RunSet, 0>::type const& byPid() const { return get<0>(); }
+
+    typename bmi::nth_index<RunSet, 1>::type& byRun() { return get<1>(); }
+    typename bmi::nth_index<RunSet, 1>::type const& byRun() const { return get<1>(); }
+
+    typename bmi::nth_index<RunSet, 2>::type& byRunPtr() { return get<2>(); }
+    typename bmi::nth_index<RunSet, 2>::type const& byRunPtr() const { return get<2>(); }
+
+    typename bmi::nth_index<RunSet, 3>::type& byStartedAt() { return get<3>(); }
+    typename bmi::nth_index<RunSet, 3>::type const& byStartedAt() const { return get<3>(); }
+
+    typename bmi::nth_index<RunSet, 4>::type& byJobName() { return get<4>(); }
+    typename bmi::nth_index<RunSet, 4>::type const& byJobName() const { return get<4>(); }
 };
 
-#endif // _LAMINAR_RUN_H_
+#endif // LAMINAR_RUN_H_

src/server.cpp

@@ -1,5 +1,5 @@
 ///
-/// Copyright 2015-2017 Oliver Giles
+/// Copyright 2015-2018 Oliver Giles
 ///
 /// This file is part of Laminar
 ///
@@ -32,6 +32,9 @@
 #include <websocketpp/server.hpp>
 
 #include <sys/eventfd.h>
+#include <sys/inotify.h>
+#include <sys/signal.h>
+#include <sys/signalfd.h>
 
 // Size of buffer used to read from file descriptors. Should be
 // a multiple of sizeof(struct signalfd_siginfo) == 128
@@ -83,14 +86,14 @@ public:
         laminar.registerWaiter(this);
     }
 
-    ~RpcImpl() {
+    ~RpcImpl() override {
         laminar.deregisterWaiter(this);
     }
 
-    // Start a job, without waiting for it to finish
-    kj::Promise<void> trigger(TriggerContext context) override {
+    // Queue a job, without waiting for it to start
+    kj::Promise<void> queue(QueueContext context) override {
         std::string jobName = context.getParams().getJobName();
-        LLOG(INFO, "RPC trigger", jobName);
+        LLOG(INFO, "RPC queue", jobName);
         ParamMap params;
         for(auto p : context.getParams().getParams()) {
             params[p.getName().cStr()] = p.getValue().cStr();
@@ -102,7 +105,7 @@ public:
         return kj::READY_NOW;
     }
 
-    // Start a job and wait for the result
+    // Start a job, without waiting for it to finish
     kj::Promise<void> start(StartContext context) override {
         std::string jobName = context.getParams().getJobName();
         LLOG(INFO, "RPC start", jobName);
@@ -111,10 +114,31 @@ public:
             params[p.getName().cStr()] = p.getValue().cStr();
         }
         std::shared_ptr<Run> run = laminar.queueJob(jobName, params);
+        if(Run* r = run.get()) {
+            return r->started.promise.then([context,r]() mutable {
+                context.getResults().setResult(LaminarCi::MethodResult::SUCCESS);
+                context.getResults().setBuildNum(r->build);
+            });
+        } else {
+            context.getResults().setResult(LaminarCi::MethodResult::FAILED);
+            return kj::READY_NOW;
+        }
+    }
+
+    // Start a job and wait for the result
+    kj::Promise<void> run(RunContext context) override {
+        std::string jobName = context.getParams().getJobName();
+        LLOG(INFO, "RPC run", jobName);
+        ParamMap params;
+        for(auto p : context.getParams().getParams()) {
+            params[p.getName().cStr()] = p.getValue().cStr();
+        }
+        std::shared_ptr<Run> run = laminar.queueJob(jobName, params);
         if(const Run* r = run.get()) {
             runWaiters[r].emplace_back(kj::newPromiseAndFulfiller<RunState>());
-            return runWaiters[r].back().promise.then([context](RunState state) mutable {
+            return runWaiters[r].back().promise.then([context,run](RunState state) mutable {
                 context.getResults().setResult(fromRunState(state));
+                context.getResults().setBuildNum(run->build);
             });
         } else {
             context.getResults().setResult(LaminarCi::JobResult::UNKNOWN);
@@ -125,7 +149,7 @@ public:
     // Set a parameter on a running build
     kj::Promise<void> set(SetContext context) override {
         std::string jobName = context.getParams().getJobName();
-        int buildNum = context.getParams().getBuildNum();
+        uint buildNum = context.getParams().getBuildNum();
         LLOG(INFO, "RPC set", jobName, buildNum);
 
         LaminarCi::MethodResult result = laminar.setParam(jobName, buildNum,
@@ -170,7 +194,6 @@ private:
     }
 private:
     LaminarInterface& laminar;
-    kj::LowLevelAsyncIoProvider* asyncio;
     std::unordered_map<std::string, std::list<kj::PromiseFulfillerPair<void>>> locks;
     std::unordered_map<const Run*, std::list<kj::PromiseFulfillerPair<RunState>>> runWaiters;
 };
@@ -211,6 +234,11 @@ public:
                 } else {
                     c->set_status(websocketpp::http::status_code::not_found);
                 }
+            } else if(resource.compare("/custom/style.css") == 0) {
+                c->set_status(websocketpp::http::status_code::ok);
+                c->append_header("Content-Type", "text/css; charset=utf-8");
+                c->append_header("Content-Transfer-Encoding", "binary");
+                c->set_body(laminar.getCustomCss());
             } else if(resources.handleRequest(resource, &start, &end, &content_type)) {
                 c->set_status(websocketpp::http::status_code::ok);
                 c->append_header("Content-Type", content_type);
@@ -222,7 +250,6 @@ public:
                 // 404
                 c->set_status(websocketpp::http::status_code::not_found);
             }
-            c->lc->close(false);
         });
 
         // Handle new websocket connection. Parse the URL to determine
@@ -236,17 +263,17 @@ public:
                     c->lc->scope.type = MonitorScope::ALL;
                 } else {
                     res = res.substr(5);
-                    int split = res.find('/',1);
+                    size_t split = res.find('/',1);
                     std::string job = res.substr(1,split-1);
                     if(!job.empty()) {
                         c->lc->scope.job = job;
                         c->lc->scope.type = MonitorScope::JOB;
                     }
                     if(split != std::string::npos) {
-                        int split2 = res.find('/', split+1);
+                        size_t split2 = res.find('/', split+1);
                         std::string run = res.substr(split+1, split2-split);
                         if(!run.empty()) {
-                            c->lc->scope.num = atoi(run.c_str());
+                            c->lc->scope.num = static_cast<uint>(atoi(run.c_str()));
                             c->lc->scope.type = MonitorScope::RUN;
                         }
                         if(split2 != std::string::npos && res.compare(split2, 4, "/log") == 0) {
@@ -255,15 +282,13 @@ public:
                     }
                 }
             }
+            // registerClient can happen after a successful websocket handshake.
+            // However, the connection might not be closed gracefully, so the
+            // corresponding deregister operation happens in the connection
+            // destructor rather than the close handler
             laminar.registerClient(c->lc);
             laminar.sendStatus(c->lc);
         });
-
-        wss.set_close_handler([this](websocketpp::connection_hdl hdl){
-            websocket::connection_ptr c = wss.get_con_from_hdl(hdl);
-            laminar.deregisterClient(c->lc);
-            c->lc->close();
-        });
     }
 
     // Return a new connection object linked with the context defined below.
@@ -275,6 +300,12 @@ public:
         return c;
     }
 
+    void connectionDestroyed(LaminarClient* lc) {
+        // This will be called for all connections, not just websockets, so
+        // the laminar instance should silently ignore unknown clients
+        laminar.deregisterClient(lc);
+    }
+
 private:
     Resources resources;
     LaminarInterface& laminar;
@@ -297,31 +328,35 @@ struct RpcConnection {
 };
 
 // Context for a WebsocketConnection (implements LaminarClient)
-// This object is a streambuf and reimplements xsputn so that it can follow any
-// write the websocketpp library makes to it with a write to the appropriate
-// descriptor in the kj-async context.
-struct Server::WebsocketConnection : public LaminarClient, public std::streambuf {
+// This object maps read and write handlers between the websocketpp library
+// and the corresponding kj async methods
+struct Server::WebsocketConnection : public LaminarClient {
     WebsocketConnection(kj::Own<kj::AsyncIoStream>&& stream, Server::HttpImpl& http) :
+        http(http),
         stream(kj::mv(stream)),
-        out(this),
         cn(http.newConnection(this)),
-        writePaf(kj::newPromiseAndFulfiller<void>()),
-        closeOnComplete(false)
+        writePaf(kj::newPromiseAndFulfiller<void>())
     {
-        cn->register_ostream(&out);
+        cn->set_write_handler([this](websocketpp::connection_hdl, const char* s, size_t sz) {
+            outputBuffer.append(std::string(s, sz));
+            writePaf.fulfiller->fulfill();
+            return std::error_code();
+        });
         cn->start();
     }
 
-    ~WebsocketConnection() noexcept(true) {
-        outputBuffer.clear();
-        writePaf.fulfiller->fulfill();
+    virtual ~WebsocketConnection() noexcept(true) override {
+        // Removes the connection from the list of registered clients. Must be
+        // here rather than in the websocket closing handshake because connections
+        // might be unexpectedly/aggressively closed and any references must be
+        // removed.
+        http.connectionDestroyed(this);
     }
 
     kj::Promise<void> pend() {
         return stream->tryRead(ibuf, 1, sizeof(ibuf)).then([this](size_t sz){
-            cn->read_all(ibuf, sz);
+            cn->read_some(ibuf, sz);
             if(sz == 0 || cn->get_state() == websocketpp::session::state::closed) {
-                cn->eof();
                 return kj::Promise<void>(kj::READY_NOW);
             }
             return pend();
@@ -335,14 +370,13 @@ struct Server::WebsocketConnection : public LaminarClient, public std::streambuf
             // to send now
             payload.swap(outputBuffer);
             writePaf = kj::newPromiseAndFulfiller<void>();
-            if(payload.empty()) {
-                stream->shutdownWrite();
-                return kj::Promise<void>(kj::READY_NOW);
-            } else {
-                return stream->write(payload.data(), payload.size()).then([this](){
-                    return closeOnComplete ? stream->shutdownWrite(), kj::Promise<void>(kj::READY_NOW) : writeTask();
-                }).attach(kj::mv(payload));
-            }
+            KJ_ASSERT(!payload.empty());
+            return stream->write(payload.data(), payload.size()).then([this](){
+                if(cn->get_state() == websocketpp::session::state::closed) {
+                    return kj::Promise<void>(kj::READY_NOW);
+                }
+                return writeTask();
+            }).attach(kj::mv(payload));
         });
     }
 
@@ -350,107 +384,139 @@ struct Server::WebsocketConnection : public LaminarClient, public std::streambuf
         cn->send(payload, websocketpp::frame::opcode::text);
     }
 
-    void close(bool now) override {
-        closeOnComplete = true;
-        if(now) {
-            outputBuffer.clear();
-            writePaf.fulfiller->fulfill();
-        }
-    }
-
-    std::streamsize xsputn(const char* s, std::streamsize sz) override {
-        outputBuffer.append(std::string(s, sz));
-        writePaf.fulfiller->fulfill();
-        return sz;
-    }
-
+    HttpImpl& http;
     kj::Own<kj::AsyncIoStream> stream;
-    std::ostream out;
     websocket::connection_ptr cn;
     std::string outputBuffer;
     kj::PromiseFulfillerPair<void> writePaf;
     char ibuf[131072];
-    bool closeOnComplete;
 };
 
 Server::Server(LaminarInterface& li, kj::StringPtr rpcBindAddress,
                kj::StringPtr httpBindAddress) :
     rpcInterface(kj::heap<RpcImpl>(li)),
-    httpInterface(new HttpImpl(li)),
+    laminarInterface(li),
+    httpInterface(kj::heap<HttpImpl>(li)),
     ioContext(kj::setupAsyncIo()),
-    tasks(*this)
+    listeners(kj::heap<kj::TaskSet>(*this)),
+    childTasks(*this),
+    httpConnections(*this),
+    httpReady(kj::newPromiseAndFulfiller<void>())
 {
     // RPC task
     if(rpcBindAddress.startsWith("unix:"))
         unlink(rpcBindAddress.slice(strlen("unix:")).cStr());
-    tasks.add(ioContext.provider->getNetwork().parseAddress(rpcBindAddress)
+    listeners->add(ioContext.provider->getNetwork().parseAddress(rpcBindAddress)
               .then([this](kj::Own<kj::NetworkAddress>&& addr) {
-        acceptRpcClient(addr->listen());
+        return acceptRpcClient(addr->listen());
     }));
 
     // HTTP task
     if(httpBindAddress.startsWith("unix:"))
         unlink(httpBindAddress.slice(strlen("unix:")).cStr());
-    tasks.add(ioContext.provider->getNetwork().parseAddress(httpBindAddress)
+    listeners->add(ioContext.provider->getNetwork().parseAddress(httpBindAddress)
               .then([this](kj::Own<kj::NetworkAddress>&& addr) {
-        acceptHttpClient(addr->listen());
+        // TODO: a better way? Currently used only for testing
+        httpReady.fulfiller->fulfill();
+        return acceptHttpClient(addr->listen());
     }));
+
+    // handle SIGCHLD
+    {
+        sigset_t mask;
+        sigemptyset(&mask);
+        sigaddset(&mask, SIGCHLD);
+        sigprocmask(SIG_BLOCK, &mask, nullptr);
+        int sigchld = signalfd(-1, &mask, SFD_NONBLOCK|SFD_CLOEXEC);
+        auto event = ioContext.lowLevelProvider->wrapInputFd(sigchld, kj::LowLevelAsyncIoProvider::TAKE_OWNERSHIP);
+        auto buffer = kj::heapArrayBuilder<char>(PROC_IO_BUFSIZE);
+        reapWatch = handleFdRead(event, buffer.asPtr().begin(), [this](const char* buf, size_t){
+            const struct signalfd_siginfo* siginfo = reinterpret_cast<const struct signalfd_siginfo*>(buf);
+            KJ_ASSERT(siginfo->ssi_signo == SIGCHLD);
+            laminarInterface.reapChildren();
+        }).attach(std::move(event)).attach(std::move(buffer));
+    }
+
+    // handle watched paths
+    {
+        inotify_fd = inotify_init1(IN_NONBLOCK | IN_CLOEXEC);
+        auto event = ioContext.lowLevelProvider->wrapInputFd(inotify_fd, kj::LowLevelAsyncIoProvider::TAKE_OWNERSHIP);
+        auto buffer = kj::heapArrayBuilder<char>(PROC_IO_BUFSIZE);
+        pathWatch = handleFdRead(event, buffer.asPtr().begin(), [this](const char*, size_t){
+            laminarInterface.notifyConfigChanged();
+        }).attach(std::move(event)).attach(std::move(buffer));
+    }
 }
 
 Server::~Server() {
-    // RpcImpl is deleted through Capability::Client.
-    // Deal with the HTTP interface the old-fashioned way
-    delete httpInterface;
 }
 
 void Server::start() {
-    // this eventfd is just to allow us to quit the server at some point
-    // in the future by adding this event to the async loop. I couldn't see
-    // a simpler way...
+    // The eventfd is used to quit the server later since we need to trigger
+    // a reaction from the event loop
     efd_quit = eventfd(0, EFD_CLOEXEC|EFD_NONBLOCK);
-    kj::Promise<void> quit = kj::evalLater([this](){
+    kj::evalLater([this](){
         static uint64_t _;
         auto wakeEvent = ioContext.lowLevelProvider->wrapInputFd(efd_quit);
         return wakeEvent->read(&_, sizeof(uint64_t)).attach(std::move(wakeEvent));
-    });
-    quit.wait(ioContext.waitScope);
+    }).wait(ioContext.waitScope);
+    // Execution arrives here when the eventfd is triggered (in stop())
+
+    // Shutdown sequence:
+    // 1. stop accepting new connections
+    listeners = nullptr;
+    // 2. abort current jobs. Most of the time this isn't necessary since
+    // systemd stop or other kill mechanism will send SIGTERM to the whole
+    // process group.
+    laminarInterface.abortAll();
+    // 3. wait for all children to close
+    childTasks.onEmpty().wait(ioContext.waitScope);
+    // 4. run the loop once more to send any pending output to websocket clients
+    ioContext.waitScope.poll();
+    // 5. return: websockets will be destructed
 }
 
 void Server::stop() {
+    // This method is expected to be called in signal context, so an eventfd
+    // is used to get the main loop to react. See run()
     eventfd_write(efd_quit, 1);
 }
 
 void Server::addDescriptor(int fd, std::function<void(const char*,size_t)> cb) {
     auto event = this->ioContext.lowLevelProvider->wrapInputFd(fd, kj::LowLevelAsyncIoProvider::TAKE_OWNERSHIP);
     auto buffer = kj::heapArrayBuilder<char>(PROC_IO_BUFSIZE);
-    tasks.add(handleFdRead(event, buffer.asPtr().begin(), cb).attach(std::move(event)).attach(std::move(buffer)));
+    childTasks.add(handleFdRead(event, buffer.asPtr().begin(), cb).attach(std::move(event)).attach(std::move(buffer)));
 }
 
-void Server::acceptHttpClient(kj::Own<kj::ConnectionReceiver>&& listener) {
-    auto ptr = listener.get();
-    tasks.add(ptr->accept().then(kj::mvCapture(kj::mv(listener),
-        [this](kj::Own<kj::ConnectionReceiver>&& listener,
-                            kj::Own<kj::AsyncIoStream>&& connection) {
-            acceptHttpClient(kj::mv(listener));
+kj::Promise<void> Server::addTimeout(int seconds, std::function<void ()> cb) {
+    return ioContext.lowLevelProvider->getTimer().afterDelay(seconds * kj::SECONDS).then([cb](){
+        cb();
+    }).eagerlyEvaluate(nullptr);
+}
+
+void Server::addWatchPath(const char* dpath) {
+    inotify_add_watch(inotify_fd, dpath, IN_ONLYDIR | IN_CLOSE_WRITE | IN_CREATE | IN_DELETE);
+}
+
+kj::Promise<void> Server::acceptHttpClient(kj::Own<kj::ConnectionReceiver>&& listener) {
+    kj::ConnectionReceiver& cr = *listener.get();
+    return cr.accept().then(kj::mvCapture(kj::mv(listener),
+        [this](kj::Own<kj::ConnectionReceiver>&& listener, kj::Own<kj::AsyncIoStream>&& connection) {
             auto conn = kj::heap<WebsocketConnection>(kj::mv(connection), *httpInterface);
-            auto promises = kj::heapArrayBuilder<kj::Promise<void>>(2);
-            promises.add(std::move(conn->pend()));
-            promises.add(std::move(conn->writeTask()));
-            return kj::joinPromises(promises.finish()).attach(std::move(conn));
-        }))
-    );
+            // delete the connection when either the read or write task completes
+            httpConnections.add(conn->pend().exclusiveJoin(conn->writeTask()).attach(kj::mv(conn)));
+            return acceptHttpClient(kj::mv(listener));
+        }));
 }
 
-void Server::acceptRpcClient(kj::Own<kj::ConnectionReceiver>&& listener) {
-    auto ptr = listener.get();
-    tasks.add(ptr->accept().then(kj::mvCapture(kj::mv(listener),
-        [this](kj::Own<kj::ConnectionReceiver>&& listener,
-                            kj::Own<kj::AsyncIoStream>&& connection) {
-            acceptRpcClient(kj::mv(listener));
+kj::Promise<void> Server::acceptRpcClient(kj::Own<kj::ConnectionReceiver>&& listener) {
+    kj::ConnectionReceiver& cr = *listener.get();
+    return cr.accept().then(kj::mvCapture(kj::mv(listener),
+        [this](kj::Own<kj::ConnectionReceiver>&& listener, kj::Own<kj::AsyncIoStream>&& connection) {
             auto server = kj::heap<RpcConnection>(kj::mv(connection), rpcInterface, capnp::ReaderOptions());
-            tasks.add(server->network.onDisconnect().attach(kj::mv(server)));
-        }))
-    );
+            childTasks.add(server->network.onDisconnect().attach(kj::mv(server)));
+            return acceptRpcClient(kj::mv(listener));
+        }));
 }
 
 // returns a promise which will read a chunk of data from the file descriptor
@@ -465,3 +531,10 @@ kj::Promise<void> Server::handleFdRead(kj::AsyncInputStream* stream, char* buffe
         return kj::Promise<void>(kj::READY_NOW);
     });
 }
+
+void Server::taskFailed(kj::Exception &&exception) {
+    // An unexpected http connection close can cause an exception, so don't re-throw.
+    // TODO: consider re-throwing selected exceptions
+    LLOG(INFO, exception);
+    //kj::throwFatalException(kj::mv(exception));
+}

src/server.h

@@ -16,8 +16,8 @@
 /// You should have received a copy of the GNU General Public License
 /// along with Laminar.  If not, see <http://www.gnu.org/licenses/>
 ///
-#ifndef _LAMINAR_SERVER_H_
-#define _LAMINAR_SERVER_H_
+#ifndef LAMINAR_SERVER_H_
+#define LAMINAR_SERVER_H_
 
 #include <kj/async-io.h>
 #include <capnp/message.h>
@@ -43,24 +43,38 @@ public:
     // invoked with the read data
     void addDescriptor(int fd, std::function<void(const char*,size_t)> cb);
 
+    // add a one-shot timer callback
+    kj::Promise<void> addTimeout(int seconds, std::function<void()> cb);
+
+    // add a path to be watched for changes
+    void addWatchPath(const char* dpath);
+
 private:
-    void acceptHttpClient(kj::Own<kj::ConnectionReceiver>&& listener);
-    void acceptRpcClient(kj::Own<kj::ConnectionReceiver>&& listener);
+    kj::Promise<void> acceptHttpClient(kj::Own<kj::ConnectionReceiver>&& listener);
+    kj::Promise<void> acceptRpcClient(kj::Own<kj::ConnectionReceiver>&& listener);
     kj::Promise<void> handleFdRead(kj::AsyncInputStream* stream, char* buffer, std::function<void(const char*,size_t)> cb);
 
-    void taskFailed(kj::Exception&& exception) override {
-        kj::throwFatalException(kj::mv(exception));
-    }
+    void taskFailed(kj::Exception&& exception) override;
 
 private:
     struct WebsocketConnection;
-    struct HttpImpl;
+    class HttpImpl;
 
     int efd_quit;
     capnp::Capability::Client rpcInterface;
-    HttpImpl* httpInterface;
+    LaminarInterface& laminarInterface;
+    kj::Own<HttpImpl> httpInterface;
     kj::AsyncIoContext ioContext;
-    kj::TaskSet tasks;
+    kj::Own<kj::TaskSet> listeners;
+    kj::TaskSet childTasks;
+    kj::TaskSet httpConnections;
+    kj::Maybe<kj::Promise<void>> reapWatch;
+    int inotify_fd;
+    kj::Maybe<kj::Promise<void>> pathWatch;
+
+    // TODO: restructure so this isn't necessary
+    friend class ServerTest;
+    kj::PromiseFulfillerPair<void> httpReady;
 };
 
-#endif // _LAMINAR_SERVER_H_
+#endif // LAMINAR_SERVER_H_

test/test-conf.cpp

@@ -0,0 +1,63 @@
+///
+/// Copyright 2018 Oliver Giles
+///
+/// This file is part of Laminar
+///
+/// Laminar is free software: you can redistribute it and/or modify
+/// it under the terms of the GNU General Public License as published by
+/// the Free Software Foundation, either version 3 of the License, or
+/// (at your option) any later version.
+///
+/// Laminar is distributed in the hope that it will be useful,
+/// but WITHOUT ANY WARRANTY; without even the implied warranty of
+/// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+/// GNU General Public License for more details.
+///
+/// You should have received a copy of the GNU General Public License
+/// along with Laminar.  If not, see <http://www.gnu.org/licenses/>
+///
+#include <gtest/gtest.h>
+#include "conf.h"
+
+class ConfTest : public ::testing::Test {
+protected:
+    void SetUp() override {
+        fd = mkstemp(tmpFile);
+    }
+    void TearDown() override {
+        close(fd);
+        unlink(tmpFile);
+    }
+    void parseConf(std::string conf) {
+        lseek(fd, SEEK_SET, 0);
+        write(fd, conf.data(), conf.size());
+        cfg = parseConfFile(tmpFile);
+    }
+    StringMap cfg;
+    int fd;
+    char tmpFile[32] = "/tmp/lt.XXXXXX";
+};
+
+TEST_F(ConfTest, Empty) {
+    EXPECT_TRUE(cfg.empty());
+    parseConf("");
+    EXPECT_TRUE(cfg.empty());
+}
+
+TEST_F(ConfTest, Comments) {
+    parseConf("#");
+    EXPECT_TRUE(cfg.empty());
+    parseConf("#foo=bar");
+    EXPECT_TRUE(cfg.empty());
+}
+
+TEST_F(ConfTest, Parse) {
+    parseConf("foo=bar\nbar=3");
+    ASSERT_EQ(2, cfg.size());
+    EXPECT_EQ("bar", cfg.get("foo", std::string("fallback")));
+    EXPECT_EQ(3, cfg.get("bar", 0));
+}
+
+TEST_F(ConfTest, Fallback) {
+    EXPECT_EQ("foo", cfg.get("test", std::string("foo")));
+}

test/test-database.cpp

@@ -0,0 +1,75 @@
+///
+/// Copyright 2018 Oliver Giles
+///
+/// This file is part of Laminar
+///
+/// Laminar is free software: you can redistribute it and/or modify
+/// it under the terms of the GNU General Public License as published by
+/// the Free Software Foundation, either version 3 of the License, or
+/// (at your option) any later version.
+///
+/// Laminar is distributed in the hope that it will be useful,
+/// but WITHOUT ANY WARRANTY; without even the implied warranty of
+/// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+/// GNU General Public License for more details.
+///
+/// You should have received a copy of the GNU General Public License
+/// along with Laminar.  If not, see <http://www.gnu.org/licenses/>
+///
+#include <gtest/gtest.h>
+#include "database.h"
+
+class DatabaseTest : public ::testing::Test {
+protected:
+    DatabaseTest() :
+        ::testing::Test(),
+        db(":memory:")
+    {}
+    Database db;
+};
+
+TEST_F(DatabaseTest, Exec) {
+    EXPECT_FALSE(db.exec("garbage non-sql"));
+    EXPECT_TRUE(db.exec("create temporary table test(id int)"));
+}
+
+TEST_F(DatabaseTest, Fetch) {
+    int n = 0;
+    db.stmt("select 2, 'cat', 4294967299").fetch<int, std::string, uint64_t>([&](int i, std::string s, uint64_t ui){
+        n++;
+        EXPECT_EQ(2, i);
+        EXPECT_EQ("cat", s);
+        EXPECT_EQ(4294967299, ui);
+    });
+    EXPECT_EQ(1, n);
+}
+
+TEST_F(DatabaseTest, Bind) {
+    int n = 0;
+    db.stmt("select ? * 2").bind(2).fetch<int>([&](int i){
+        n++;
+        EXPECT_EQ(4, i);
+    });
+    EXPECT_EQ(1, n);
+}
+
+TEST_F(DatabaseTest, Strings) {
+    std::string res;
+    db.stmt("select ? || ?").bind("a", "b").fetch<std::string>([&res](std::string s){
+        EXPECT_TRUE(res.empty());
+        res = s;
+    });
+    EXPECT_EQ("ab", res);
+}
+
+TEST_F(DatabaseTest, MultiRow) {
+    ASSERT_TRUE(db.exec("create table test(id int)"));
+    int i = 0;
+    while(i < 10)
+        EXPECT_TRUE(db.stmt("insert into test values(?)").bind(i++).exec());
+    i = 0;
+    db.stmt("select * from test").fetch<int>([&](int r){
+        EXPECT_EQ(i++, r);
+    });
+    EXPECT_EQ(10, i);
+}

test/test-laminar.cpp

@@ -0,0 +1,43 @@
+///
+/// Copyright 2018 Oliver Giles
+///
+/// This file is part of Laminar
+///
+/// Laminar is free software: you can redistribute it and/or modify
+/// it under the terms of the GNU General Public License as published by
+/// the Free Software Foundation, either version 3 of the License, or
+/// (at your option) any later version.
+///
+/// Laminar is distributed in the hope that it will be useful,
+/// but WITHOUT ANY WARRANTY; without even the implied warranty of
+/// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+/// GNU General Public License for more details.
+///
+/// You should have received a copy of the GNU General Public License
+/// along with Laminar.  If not, see <http://www.gnu.org/licenses/>
+///
+#include <gtest/gtest.h>
+#include <rapidjson/stringbuffer.h>
+#include <rapidjson/document.h>
+#include "laminar.h"
+
+class TestLaminarClient : public LaminarClient {
+public:
+    virtual void sendMessage(std::string p) { payload = p; }
+    std::string payload;
+};
+
+class LaminarTest : public ::testing::Test {
+protected:
+    Laminar laminar;
+};
+
+TEST_F(LaminarTest, StatusMessageContainsTime) {
+    TestLaminarClient testClient;
+    laminar.sendStatus(&testClient);
+    rapidjson::Document d;
+    d.Parse(testClient.payload.c_str());
+    ASSERT_TRUE(d.IsObject());
+    ASSERT_TRUE(d.HasMember("time"));
+    EXPECT_GE(1, d["time"].GetInt() - time(nullptr));
+}

test/test-run.cpp

@@ -0,0 +1,122 @@
+///
+/// Copyright 2018 Oliver Giles
+///
+/// This file is part of Laminar
+///
+/// Laminar is free software: you can redistribute it and/or modify
+/// it under the terms of the GNU General Public License as published by
+/// the Free Software Foundation, either version 3 of the License, or
+/// (at your option) any later version.
+///
+/// Laminar is distributed in the hope that it will be useful,
+/// but WITHOUT ANY WARRANTY; without even the implied warranty of
+/// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+/// GNU General Public License for more details.
+///
+/// You should have received a copy of the GNU General Public License
+/// along with Laminar.  If not, see <http://www.gnu.org/licenses/>
+///
+#include <gtest/gtest.h>
+#include "run.h"
+#include "log.h"
+#include "node.h"
+#include "conf.h"
+
+class RunTest : public ::testing::Test {
+protected:
+    virtual ~RunTest() noexcept override {}
+
+    void SetUp() override {
+        run.node = node;
+    }
+    void wait() {
+        int state = -1;
+        waitpid(run.pid, &state, 0);
+        run.reaped(state);
+    }
+    void runAll() {
+        while(!run.step())
+            wait();
+    }
+    std::string readAllOutput() {
+        std::string res;
+        char tmp[64];
+        for(ssize_t n = read(run.fd, tmp, 64); n > 0; n = read(run.fd, tmp, 64))
+            res += std::string(tmp, n);
+        // strip the first "[laminar] executing.. line
+        return strchr(res.c_str(), '\n') + 1;
+    }
+    StringMap parseFromString(std::string content) {
+        char tmp[16] = "/tmp/lt.XXXXXX";
+        int fd = mkstemp(tmp);
+        write(fd, content.data(), content.size());
+        close(fd);
+        StringMap map = parseConfFile(tmp);
+        unlink(tmp);
+        return map;
+    }
+
+    class Run run;
+    std::shared_ptr<Node> node = std::shared_ptr<Node>(new Node);
+};
+
+TEST_F(RunTest, WorkingDirectory) {
+    run.addScript("/bin/pwd", "/home");
+    runAll();
+    EXPECT_EQ("/home\n", readAllOutput());
+}
+
+TEST_F(RunTest, SuccessStatus) {
+    run.addScript("/bin/true");
+    runAll();
+    EXPECT_EQ(RunState::SUCCESS, run.result);
+}
+
+TEST_F(RunTest, FailedStatus) {
+    run.addScript("/bin/false");
+    runAll();
+    EXPECT_EQ(RunState::FAILED, run.result);
+}
+
+TEST_F(RunTest, Environment) {
+    run.name = "foo";
+    run.build = 1234;
+    run.laminarHome = "/tmp";
+    run.addScript("/usr/bin/env");
+    runAll();
+    StringMap map = parseFromString(readAllOutput());
+    EXPECT_EQ("1234", map["RUN"]);
+    EXPECT_EQ("foo", map["JOB"]);
+    EXPECT_EQ("success", map["RESULT"]);
+    EXPECT_EQ("unknown", map["LAST_RESULT"]);
+    EXPECT_EQ("/tmp/run/foo/workspace", map["WORKSPACE"]);
+    EXPECT_EQ("/tmp/archive/foo/1234", map["ARCHIVE"]);
+}
+
+TEST_F(RunTest, ParamsToEnv) {
+    run.params["foo"] = "bar";
+    run.addScript("/usr/bin/env");
+    runAll();
+    StringMap map = parseFromString(readAllOutput());
+    EXPECT_EQ("bar", map["foo"]);
+}
+
+TEST_F(RunTest, Abort) {
+    run.addScript("/usr/bin/yes");
+    run.step();
+    usleep(200); // TODO fix
+    run.abort();
+    wait();
+    EXPECT_EQ(RunState::ABORTED, run.result);
+}
+
+TEST_F(RunTest, AbortAfterFailed) {
+    run.addScript("/bin/false");
+    runAll();
+    run.addScript("/usr/bin/yes");
+    run.step();
+    usleep(200); // TODO fix
+    run.abort();
+    wait();
+    EXPECT_EQ(RunState::FAILED, run.result);
+}

test/test-server.cpp

@@ -0,0 +1,145 @@
+///
+/// Copyright 2018 Oliver Giles
+///
+/// This file is part of Laminar
+///
+/// Laminar is free software: you can redistribute it and/or modify
+/// it under the terms of the GNU General Public License as published by
+/// the Free Software Foundation, either version 3 of the License, or
+/// (at your option) any later version.
+///
+/// Laminar is distributed in the hope that it will be useful,
+/// but WITHOUT ANY WARRANTY; without even the implied warranty of
+/// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+/// GNU General Public License for more details.
+///
+/// You should have received a copy of the GNU General Public License
+/// along with Laminar.  If not, see <http://www.gnu.org/licenses/>
+///
+#include <gtest/gtest.h>
+#include <gmock/gmock.h>
+#include <boost/filesystem.hpp>
+#include <thread>
+#include <sys/socket.h>
+#include "server.h"
+#include "log.h"
+#include "interface.h"
+#include "laminar.capnp.h"
+
+namespace fs = boost::filesystem;
+
+class TempDir : public fs::path {
+public:
+    TempDir(const char* tmpl) {
+        char* t = strdup(tmpl);
+        mkdtemp(t);
+        *static_cast<fs::path*>(this) = t;
+        free(t);
+    }
+    ~TempDir() {
+        fs::remove_all(*this);
+    }
+};
+
+class MockLaminar : public LaminarInterface {
+public:
+    LaminarClient* client = nullptr;
+    virtual void registerClient(LaminarClient* c) override {
+        ASSERT_EQ(nullptr, client);
+        client = c;
+        EXPECT_CALL(*this, sendStatus(client)).Times(testing::Exactly(1));
+    }
+
+    virtual void deregisterClient(LaminarClient* c) override {
+        ASSERT_EQ(client, c);
+        client = nullptr;
+    }
+
+    MOCK_METHOD2(queueJob, std::shared_ptr<Run>(std::string name, ParamMap params));
+    MOCK_METHOD1(registerWaiter, void(LaminarWaiter* waiter));
+    MOCK_METHOD1(deregisterWaiter, void(LaminarWaiter* waiter));
+    MOCK_METHOD1(sendStatus, void(LaminarClient* client));
+    MOCK_METHOD4(setParam, bool(std::string job, uint buildNum, std::string param, std::string value));
+    MOCK_METHOD2(getArtefact, bool(std::string path, std::string& result));
+    MOCK_METHOD0(getCustomCss, std::string());
+    MOCK_METHOD0(abortAll, void());
+    MOCK_METHOD0(reapChildren, void());
+    MOCK_METHOD0(notifyConfigChanged, void());
+};
+
+class ServerTest : public ::testing::Test {
+protected:
+    ServerTest() :
+        tempDir("/tmp/laminar-test-XXXXXX")
+    {
+    }
+    void SetUp() override {
+        EXPECT_CALL(mockLaminar, registerWaiter(testing::_));
+        EXPECT_CALL(mockLaminar, deregisterWaiter(testing::_));
+        server = new Server(mockLaminar, "unix:"+fs::path(tempDir/"rpc.sock").string(), "127.0.0.1:8080");
+    }
+    void TearDown() override {
+        delete server;
+    }
+
+    LaminarCi::Client client() const {
+        return server->rpcInterface.castAs<LaminarCi>();
+    }
+    kj::WaitScope& ws() const {
+        return server->ioContext.waitScope;
+    }
+    void waitForHttpReady() {
+        server->httpReady.promise.wait(server->ioContext.waitScope);
+    }
+
+    kj::Network& network() { return server->ioContext.provider->getNetwork(); }
+    TempDir tempDir;
+    MockLaminar mockLaminar;
+    Server* server;
+};
+
+TEST_F(ServerTest, RpcQueue) {
+    auto req = client().queueRequest();
+    req.setJobName("foo");
+    EXPECT_CALL(mockLaminar, queueJob("foo", ParamMap())).Times(testing::Exactly(1));
+    req.send().wait(ws());
+}
+
+// Tests that agressively closed websockets are properly removed
+// and will not be attempted to be contacted again
+TEST_F(ServerTest, HttpWebsocketRST) {
+    waitForHttpReady();
+
+    // TODO: generalize
+    constexpr const char* WS =
+        "GET / HTTP/1.1\r\n"
+        "Host: localhost:8080\r\n"
+        "Connection: Upgrade\r\n"
+        "Upgrade: websocket\r\n"
+        "Sec-WebSocket-Key: GTFmrUCM9N6B32LdDE3Rzw==\r\n"
+        "Sec-WebSocket-Version: 13\r\n\r\n";
+
+    static char buffer[256];
+    network().parseAddress("localhost:8080").then([this](kj::Own<kj::NetworkAddress>&& addr){
+        return addr->connect().attach(kj::mv(addr)).then([this](kj::Own<kj::AsyncIoStream>&& stream){
+            kj::AsyncIoStream* s = stream.get();
+            return s->write(WS, strlen(WS)).then([this,s](){
+                // Read the websocket header response, ensure the client has been registered
+                return s->tryRead(buffer, 64, 256).then([this,s](size_t sz){
+                    EXPECT_LE(64, sz);
+                    EXPECT_NE(nullptr, mockLaminar.client);
+                    // agressively abort the connection
+                    struct linger so_linger;
+                    so_linger.l_onoff = 1;
+                    so_linger.l_linger = 0;
+                    s->setsockopt(SOL_SOCKET, SO_LINGER, &so_linger, sizeof(so_linger));
+                    return kj::Promise<void>(kj::READY_NOW);
+                });
+            }).attach(kj::mv(stream));
+        });
+    }).wait(ws());
+    ws().poll();
+    // Expect that the client has been cleared. If it has not, Laminar could
+    // try to write to the closed file descriptor, causing an exception
+    EXPECT_EQ(nullptr, mockLaminar.client);
+}