remove reference to helper script

more trouble than it's worth

CMakeLists.txt

@@ -1,5 +1,5 @@
 ###
-### Copyright 2015-2017 Oliver Giles
+### Copyright 2015-2019 Oliver Giles
 ###
 ### This file is part of Laminar
 ###
@@ -22,7 +22,7 @@ cmake_policy(SET CMP0058 NEW)
 
 set(CMAKE_INCLUDE_CURRENT_DIR ON)
 
-add_definitions("-std=c++11 -Wall -Wextra -Wno-unused-parameter -Wno-sign-compare")
+add_definitions("-std=c++14 -Wall -Wextra -Wno-unused-parameter -Wno-sign-compare")
 set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -Werror -DDEBUG")
 
 # This macro takes a list of files, gzips them and converts the output into
@@ -43,7 +43,11 @@ macro(generate_compressed_bins BASEDIR)
             DEPENDS ${BASEDIR}/${FILE}
         )
         add_custom_command(OUTPUT ${OUTPUT_FILE}
-            COMMAND ld -r -b binary -o ${OUTPUT_FILE} ${COMPRESSED_FILE}
+            COMMAND ${CMAKE_LINKER} -r -b binary -o ${OUTPUT_FILE} ${COMPRESSED_FILE}
+            COMMAND ${CMAKE_OBJCOPY}
+              --rename-section .data=.rodata.alloc,load,readonly,data,contents
+              --add-section .note.GNU-stack=/dev/null
+              --set-section-flags .note.GNU-stack=contents,readonly ${OUTPUT_FILE}
             DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${COMPRESSED_FILE}
         )
         list(APPEND COMPRESSED_BINS ${OUTPUT_FILE})
@@ -58,7 +62,12 @@ 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)
+
+# The code that allows dynamic modifying of index.html requires knowing its original size
+add_custom_command(OUTPUT index_html_size.h
+    COMMAND sh -c '( echo -n "\\#define INDEX_HTML_UNCOMPRESSED_SIZE " && wc -c < "${CMAKE_SOURCE_DIR}/src/resources/index.html" ) > index_html_size.h'
+    DEPENDS src/resources/index.html)
 
 # Download 3rd-party frontend JS libs...
 file(DOWNLOAD https://cdnjs.cloudflare.com/ajax/libs/vue/2.3.4/vue.min.js
@@ -67,27 +76,50 @@ file(DOWNLOAD https://cdnjs.cloudflare.com/ajax/libs/vue-router/2.7.0/vue-router
         js/vue-router.min.js EXPECTED_MD5 5d3e35710dbe02de78c39e3e439b8d4e)
 file(DOWNLOAD https://raw.githubusercontent.com/drudru/ansi_up/v1.3.0/ansi_up.js
         js/ansi_up.js EXPECTED_MD5 158566dc1ff8f2804de972f7e841e2f6)
-file(DOWNLOAD https://cdnjs.cloudflare.com/ajax/libs/Chart.js/1.0.2/Chart.min.js
-        js/Chart.min.js EXPECTED_MD5 0d3004601c1a855a3d203502549528a7)
-file(DOWNLOAD https://raw.githubusercontent.com/tomsouthall/Chart.HorizontalBar.js/v1.04/Chart.HorizontalBar.js
-        js/Chart.HorizontalBar.js EXPECTED_MD5 95070a38e69bc56534e1b2086d985270)
+file(DOWNLOAD https://cdnjs.cloudflare.com/ajax/libs/Chart.js/2.7.2/Chart.min.js
+        js/Chart.min.js EXPECTED_MD5 f6c8efa65711e0cbbc99ba72997ecd0e)
 file(DOWNLOAD https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css
         css/bootstrap.min.css EXPECTED_MD5 5d5357cb3704e1f43a1f5bfed2aebf42)
 # ...and compile them
 generate_compressed_bins(${CMAKE_BINARY_DIR} js/vue-router.min.js js/vue.min.js
-    js/ansi_up.js js/Chart.min.js js/Chart.HorizontalBar.js css/bootstrap.min.css)
+    js/ansi_up.js js/Chart.min.js css/bootstrap.min.css)
 # (see resources.cpp where these are fetched)
 
+set(LAMINARD_CORE_SOURCES
+    src/database.cpp
+    src/server.cpp
+    src/laminar.cpp
+    src/conf.cpp
+    src/http.cpp
+    src/resources.cpp
+    src/rpc.cpp
+    src/run.cpp
+    laminar.capnp.c++
+    index_html_size.h
+)
+
 ## Server
-add_executable(laminard src/database.cpp src/main.cpp src/server.cpp src/laminar.cpp
-    src/conf.cpp src/resources.cpp src/run.cpp laminar.capnp.c++ ${COMPRESSED_BINS})
-# TODO: some alternative to boost::filesystem?
-target_link_libraries(laminard capnp-rpc capnp kj-async kj pthread boost_filesystem boost_system sqlite3 z)
+add_executable(laminard ${LAMINARD_CORE_SOURCES} src/main.cpp ${COMPRESSED_BINS})
+target_link_libraries(laminard capnp-rpc capnp kj-http kj-async kj pthread sqlite3 z)
 
 ## Client
 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 ${LAMINARD_CORE_SOURCES} ${COMPRESSED_BINS} test/main.cpp test/laminar-functional.cpp test/unit-conf.cpp test/unit-database.cpp test/unit-run.cpp)
+    target_link_libraries(laminar-tests ${GTEST_LIBRARY} capnp-rpc capnp kj-http kj-async kj pthread sqlite3 z)
+endif()
+
+set(SYSTEMD_UNITDIR lib/systemd/system CACHE PATH "Path to systemd unit files")
+set(BASH_COMPLETIONS_DIR usr/share/bash-completion/completions CACHE PATH "Path to bash completions directory")
+set(ZSH_COMPLETIONS_DIR usr/share/zsh/site-functions CACHE PATH "Path to zsh completions directory")
 install(TARGETS laminard laminarc RUNTIME DESTINATION usr/bin)
-install(FILES laminar.service DESTINATION usr/lib/systemd/system)
-install(FILES laminar.conf DESTINATION etc)
+install(FILES etc/laminar.service DESTINATION ${SYSTEMD_UNITDIR})
+install(FILES etc/laminar.conf DESTINATION etc)
+install(FILES etc/laminarc-completion.bash DESTINATION ${BASH_COMPLETIONS_DIR} RENAME laminarc)
+install(FILES etc/laminarc-completion.zsh DESTINATION ${ZSH_COMPLETIONS_DIR} RENAME _laminarc)

README.md

@@ -1,16 +1,25 @@
-# Laminar CI
+# Laminar CI [![status](https://ci.ohwg.net/badge/laminar.svg)](https://ci.ohwg.net/jobs/laminar)
 
-[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 (https://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 favour 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](https://laminar.ohwg.net) and the [documentation](https://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:
+First install development packages for `capnproto (version 0.7.0 or newer)`, `rapidjson`, `sqlite` and `boost` (for the header-only `multi_index_container` library) from your distribution's repository or other source.
+
+On Debian Buster, this can be done with:
+
+```bash
+sudo apt install \
+		 capnproto cmake g++ libboost-dev libcapnp-dev libsqlite-dev libsqlite3-dev make rapidjson-dev zlib1g-dev
+```
+
+Then compile and install laminar with:
 
 ```bash
 git clone https://github.com/ohwgiles/laminar.git
@@ -22,521 +31,6 @@ 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
+## Packaging for distributions
 
-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
+The `pkg` directory contains shell scripts which use docker to build native packages (deb,rpm) for common Linux distributions. Note that these are very simple packages which may not completely conform to the distribution's packaging guidelines, however they may serve as a starting point for creating an official package, or may be useful if the official package lags.

UserManual.md

@@ -0,0 +1,686 @@
+# 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.
+
+## Building for Docker
+
+You can build an image that runs `laminard` by default, and contains `laminarc` for use based on `alpine:edge` using the `Dockerfile` in the `docker/` directory.
+
+```bash
+# from the repository root:
+docker build [-t image:tag] -f docker/Dockerfile .
+```
+
+Keep in mind that this is meant to be used as a base image to build from, so it contains only the minimum packages required to run laminar. The only shell available by default is sh and it does not even have ssh or git. You can use this image to run a basic build server, but it is recommended that you build a custom image from this base to better suit your needs.
+
+The container will execute `laminard` by default. To start a laminar server with docker you can simply run the image as a daemon.
+
+```bash
+docker run -d --name laminar_server -p 8080:8080 [-v laminardir|laminar.conf] laminar:latest
+```
+
+You can customize laminar and persist your data by mounting your laminar directory to `/var/lib/laminar` and/or mounting a custom configuration file to `/etc/laminar.conf`.
+
+Executing `laminarc` may be done in any of the usual ways, for example:
+
+```bash
+docker exec -i laminar_server laminarc queue example_task
+```
+
+Alternatively, you might [use an external `laminarc`](#Triggering-on-a-remote-laminar-instance).
+
+---
+
+# 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
+
+A reverse proxy is required if you want Laminar to share a port with other web services. It is also recommended to improve performance by serving artefacts directly or providing a caching layer for static assets.
+
+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 serve the archive directory directly (e.g. using a `Location` directive).
+
+Laminar uses Sever Sent Events to provide a responsive, auto-updating display without polling. Most frontend webservers should handle this without any extra configuration.
+
+If you use a reverse proxy to host Laminar at a subfolder instead of a subdomain root, the `<base href>` needs to be updated to ensure all links point to their proper targets. This can be done by setting `LAMINAR_BASE_URL` in `/etc/laminar.conf`.
+
+## 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/jobs/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/jobs/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.
+
+## Listing jobs from the command line
+
+`laminarc` may be used to inspect the server state:
+
+- `laminarc show-jobs`: Lists all files matching `/var/lib/laminar/cfg/jobs/*.run` on the server side.
+- `laminarc show-running`: Lists all currently running jobs and their run numbers.
+- `laminarc show-queued`: Lists all jobs waiting in the queue.
+
+## 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`.
+
+## Viewing job logs
+
+A job's console output can be viewed on the Web UI at http://localhost:8080/jobs/$NAME/$NUMBER.
+
+Additionally, the raw log output may be fetched over a plain HTTP request to http://localhost:8080/log/$NAME/$NUMBER. The response will be chunked, allowing this mechanism to also be used for in-progress jobs. Furthermore, the special endpoint http://localhost:8080/log/$NAME/latest will redirect to the most recent log output. Be aware that the use of this endpoint may be subject to races when new jobs start.
+
+---
+
+# 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
+```
+
+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:
+
+```bash
+#!/bin/bash -e
+echo Initializing workspace
+git clone git@example.com:company/project.git .
+```
+
+**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 simultaneous runs access the same content. This is unlikely to be an issue for nightly builds, but for SCM-triggered builds it will be. To solve this, use [contexts](#Contexts) to restrict simultaneous execution of jobs, or consider [flock](https://linux.die.net/man/1/flock).
+
+The following example uses [flock](https://linux.die.net/man/1/flock) to efficiently share a git repository workspace between multiple simultaneous builds:
+
+```bash
+#!/bin/bash -xe
+
+# 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 values
+# for $rev) simultaneously.
+
+# Locked subshell for modifying the workspace
+(
+  flock 200
+  cd $WORKSPACE
+  # Download all the latest commits
+  git fetch
+  git checkout $rev
+  cd -
+  # Fast copy (hard-link) the source from the specific checkout
+  # to the build dir. This relies on the fact that git unlinks
+  # during checkout, effectively implementing copy-on-write.
+  cp -al $WORKSPACE/src src
+) 200>$WORKSPACE
+
+# run the (much longer) regular build process
+make -C src
+```
+
+---
+
+# Aborting running jobs
+
+## After a 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
+```
+
+## Manually
+
+`laminarc abort $JOBNAME $NUMBER`
+
+---
+
+# Contexts
+
+In Laminar, each run of a job is associated with a context. The context defines an integer number of *executors*, which is the amount of runs which the context will accept simultaneously. A context may also provide additional environment variables.
+
+Uses for this feature include limiting the amount of concurrent CPU-intensive jobs (such as compilation); and controlling access to jobs [executed remotely](#Remote-jobs).
+
+If no contexts are defined, Laminar will behave as if there is a single context named "default", with `6` executors. This is a reasonable default that allows simple setups to work without any consideration of contexts.
+
+## Defining a context
+
+To create a context named "my-env" which only allows a single run at once, create `/var/lib/laminar/cfg/contexts/my-env.conf` with the content:
+
+```
+EXECUTORS=1
+```
+
+## Associating a job with a context
+
+When trying to start a job, laminar will wait until the job can be matched to a context which has at least one free executor. You can define which contexts the job will associate with by setting, for example,
+
+```
+CONTEXTS=my-env-*,special_context
+```
+
+in `/var/lib/laminar/cfg/jobs/JOB.conf`. For each of the patterns in the comma-separated list `CONTEXTS`, Laminar will iterate over the known contexts and associate the run with the first context with free executors. Patterns are [glob expressions](http://man7.org/linux/man-pages/man7/glob.7.html).
+
+If `CONTEXTS` is empty or absent (or if `JOB.conf` doesn't exist), laminar will behave as if `CONTEXTS=default` were defined.
+
+## Adding environment to a context
+
+Append desired environment variables to `/var/lib/laminar/cfg/contexts/CONTEXT_NAME.conf`:
+
+```
+DUT_IP=192.168.3.2
+FOO=bar
+```
+
+This environment will then be available the run script of jobs associated with this context.
+
+
+
+
+## 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.
+
+
+# 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 [context](#Contexts) for each, `/var/lib/laminar/cfg/contexts/target{1,2}.conf`:
+
+```
+EXECUTORS=1
+```
+
+In each context's `.env` file, set the individual device's IP address:
+
+```
+TARGET_IP=192.168.0.123
+```
+
+And mark the job accordingly in `/var/lib/laminar/cfg/jobs/myproject-test.conf`:
+
+```
+CONTEXTS=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
+```
+
+---
+
+# Customizing the WebUI
+
+## Organising jobs into groups
+
+*Groups* may be used to organise the "Jobs" page into tabs. Edit `/var/lib/laminar/cfg/groups.conf` and define the matched jobs as a [javascript regular expression](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions), for example:
+
+```
+Builds=compile-\w+
+My Fav Jobs=^(target-foo-(build|deploy)|run-benchmarks)$
+All=.*
+```
+
+Changes to this file are detected immediately and will be visible on next page refresh.
+
+## Setting the page title
+
+Change `LAMINAR_TITLE` in `/etc/laminar.conf` to your preferred page title. Laminar must be restarted for this change to take effect.
+
+## Custom stylesheet
+
+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).
+
+---
+
+# Badges
+
+Laminar will serve a job's current status as a pretty badge at the url `/badge/JOBNAME.svg`. This can be used as a link to your server instance from your Github README.md file or cat blog:
+
+```
+<a href="https://my-example-laminar-server.com/jobs/my-project">
+  <img src="https://my-example-laminar-server.com/badge/my-project.svg">
+</a>
+```
+
+---
+
+# 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, 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`
+- `jobs/$JOB.before`
+- `jobs/$JOB.run`
+- `jobs/$JOB.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
+- `CONTEXT` the context of this run
+
+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`
+- `contexts/$CONTEXT.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.
+- `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
+- `show-jobs` shows the known jobs on the server (`$LAMINAR_HOME/cfg/jobs/*.run`).
+- `show-running` shows the currently running jobs with their numbers.
+- `show-queued` shows the names of the jobs waiting in the queue.
+- `abort JOB NUMBER` manually aborts a currently running job by name and number.
+
+`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`.
+
+All commands return zero on success or a non-zero code if the command could not be executed. `laminarc run` will return a non-zero exit status if any executed job failed.

docker/Dockerfile

@@ -0,0 +1,45 @@
+FROM alpine:edge
+
+EXPOSE 8080
+
+LABEL org.label-schema.name="laminar" \
+      org.label-schema.description="Fast and lightweight Continuous Integration" \
+      org.label-schema.usage="/usr/doc/UserManual.md" \
+      org.label-schema.url="https://laminar.ohwg.net" \
+      org.label-schema.vcs-url="https://github.com/ohwgiles/laminar" \
+      org.label-schema.schema-version="1.0" \
+      org.label-schema.docker.cmd="docker run -d -p 8080:8080 laminar"
+
+RUN apk add --no-cache -X http://dl-3.alpinelinux.org/alpine/edge/testing/ \
+        sqlite-dev \
+        zlib \
+        capnproto \
+        tini
+
+ADD UserManual.md /usr/doc/
+
+ADD . /build/laminar
+
+RUN apk add --no-cache --virtual .build -X http://dl-3.alpinelinux.org/alpine/edge/testing/ \
+        build-base \
+        cmake \
+        capnproto-dev \
+        boost-dev \
+        zlib-dev \
+        rapidjson-dev && \
+    cd /build/laminar && \
+    cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/ && \
+    make -j4 && \
+    make install && \
+    apk del .build && \
+    rm -rf /build
+
+# Create laminar system user in "users" group
+RUN adduser -SDh /var/lib/laminar -g 'Laminar' -G users laminar
+# Set the working directory to the laminar user's home
+WORKDIR /var/lib/laminar
+# Run the preceeding as the user laminar
+USER laminar
+
+ENTRYPOINT [ "/sbin/tini", "--" ]
+CMD [ "laminard" ]

etc/laminar.conf

@@ -43,6 +43,16 @@
 ###
 #LAMINAR_KEEP_RUNDIRS=0
 
+
+###
+### LAMINAR_BASE_URL
+###
+### Base url for the frontend. This affects the <base href> tag and needs
+### to be set if Laminar runs behind a reverse-proxy that hosts Laminar
+### within a subfolder (rather than at a subdomain root)
+###
+#LAMINAR_BASE_URL=/
+
 ###
 ### LAMINAR_ARCHIVE_URL
 ###
@@ -51,4 +61,4 @@
 ### uses a very naive and inefficient method. Best to let a real
 ### webserver handle serving those requests.
 ###
-#LAMINAR_ARCHIVE_URL=http://backbone.example.com/ci/archive
+#LAMINAR_ARCHIVE_URL=http://backbone.example.com/ci/archive/

etc/laminar.service

@@ -1,5 +1,6 @@
 [Unit]
 Description=Laminar continuous integration service
+After=network.target
 
 [Service]
 User=laminar

etc/laminarc-completion.bash

@@ -0,0 +1,28 @@
+# Bash completion file for laminarc
+# vim: ft=sh
+
+_laminarc() {
+	local cur prev words cword
+	_init_completion || return
+	if [ "$cword" -gt 1 ]; then
+		case "${words[1]}" in
+			queue|start|run)
+				if [ "$cword" -eq 2 ]; then
+					COMPREPLY+=($(compgen -W "$(laminarc show-jobs)" -- ${cur}))
+				fi
+				;;
+			abort)
+				if [ "$cword" -eq 2 ]; then
+					COMPREPLY+=($(compgen -W "$(laminarc show-running | cut -d : -f 1)" -- ${cur}))
+				elif [ "$cword" -eq 3 ]; then
+					COMPREPLY+=($(compgen -W "$(laminarc show-running | cut -d : -f 2)" -- ${cur}))
+				fi
+				;;
+		esac
+	else
+		local cmds="queue start run set show-jobs show-queued show-running abort"
+		COMPREPLY+=($(compgen -W "${cmds}" -- ${cur}))
+	fi
+}
+
+complete  -F _laminarc laminarc

etc/laminarc-completion.zsh

@@ -0,0 +1,34 @@
+#compdef laminarc
+#autoload
+
+_laminarc() {
+	if (( CURRENT == 2 )); then
+		_values "Operation" \
+			"queue" \
+			"start" \
+			"run" \
+			"set" \
+			"show-jobs" \
+			"show-queued" \
+			"show-running" \
+			"abort"
+	else
+		case "${words[2]}" in
+			queue|start|run)
+				if (( CURRENT == 3 )); then
+					_values "Jobs" $(laminarc show-jobs)
+				fi
+				;;
+			abort)
+				if (( CURRENT == 3 )); then
+					_values "Jobs" $(laminarc show-running | cut -d : -f 1)
+				elif (( CURRENT == 4 )); then
+					_values "Runs" $(laminarc show-running | cut -d : -f 2)
+				fi
+				;;
+		esac
+	fi
+}
+
+_laminarc
+# vim: ft=zsh

pkg/centos7-x86_64.sh

@@ -0,0 +1,81 @@
+#!/bin/bash -e
+
+OUTPUT_DIR=$PWD
+
+SOURCE_DIR=$(readlink -f $(dirname ${BASH_SOURCE[0]})/..)
+
+VERSION=$(cd "$SOURCE_DIR" && git describe --tags --abbrev=8 --dirty | tr - .)~upstream_centos7
+
+DOCKER_TAG=$(docker build -q - <<EOS
+FROM centos:7
+RUN yum -y install epel-release centos-release-scl && yum-config-manager --enable rhel-server-rhscl-7-rpms && yum -y install rpm-build cmake3 make devtoolset-7-gcc-c++ wget sqlite-devel boost-devel zlib-devel
+EOS
+)
+
+docker run --rm -i -v $SOURCE_DIR:/root/rpmbuild/SOURCES/laminar-$VERSION:ro -v $OUTPUT_DIR:/output $DOCKER_TAG bash -xe <<EOS
+# for new gcc
+export PATH=/opt/rh/devtoolset-7/root/usr/bin:\$PATH
+
+mkdir /build
+cd /build
+
+wget -O capnproto.tar.gz https://github.com/capnproto/capnproto/archive/v0.7.0.tar.gz
+wget -O rapidjson.tar.gz https://github.com/miloyip/rapidjson/archive/v1.1.0.tar.gz
+md5sum -c <<EOF
+a9de5f042f4cf05515c2d7dfc7f5df21  capnproto.tar.gz
+badd12c511e081fec6c89c43a7027bce  rapidjson.tar.gz
+EOF
+
+tar xzf capnproto.tar.gz
+tar xzf rapidjson.tar.gz
+
+cd /build/capnproto-0.7.0/c++/
+cmake3 -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTING=off .
+make -j4
+make install
+
+cd /build/rapidjson-1.1.0/
+cmake3 -DRAPIDJSON_BUILD_EXAMPLES=off .
+make install
+
+cd
+cat <<EOF > laminar.spec
+Summary: Lightweight Continuous Integration Service
+Name: laminar
+Version: $VERSION
+Release: 1
+License: GPL
+BuildRequires: systemd-units
+Requires: sqlite zlib
+
+%description
+Lightweight Continuous Integration Service
+
+%prep
+
+%build
+cmake3 -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/ -DSYSTEMD_UNITDIR=%{_unitdir} %{_sourcedir}/laminar-$VERSION
+pwd
+make
+
+%install
+%make_install
+
+%files
+%{_bindir}/laminarc
+%{_bindir}/laminard
+%{_unitdir}/laminar.service
+%config(noreplace) %{_sysconfdir}/laminar.conf
+%{_datarootdir}/bash-completion/completions/laminarc
+%{_datarootdir}/zsh/site-functions/_laminarc
+
+%post
+echo Creating laminar user with home in %{_sharedstatedir}/laminar
+useradd -r -d %{_sharedstatedir}/laminar -s %{_sbindir}/nologin laminar
+mkdir -p %{_sharedstatedir}/laminar/cfg/{jobs,contexts,scripts}
+chown -R laminar: %{_sharedstatedir}/laminar
+EOF
+
+rpmbuild -ba laminar.spec
+mv rpmbuild/RPMS/x86_64/laminar-$VERSION-1.x86_64.rpm /output/
+EOS

pkg/centos8-x86_64.sh

@@ -1,43 +1,38 @@
-#!/bin/bash
+#!/bin/bash -e
 
 OUTPUT_DIR=$PWD
 
-SOURCE_DIR=$(readlink -f $(dirname ${BASH_SOURCE[0]}))
+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 - .)~upstream_centos8
 
-docker run --rm -i -v $SOURCE_DIR:/root/rpmbuild/SOURCES/laminar-$VERSION:ro -v $OUTPUT_DIR:/output centos bash -xe <<EOS
-
-yum -y install epel-release
-yum -y install rpm-build cmake3 make gcc gcc-c++ wget sqlite-devel boost-devel zlib-devel
+DOCKER_TAG=$(docker build -q - <<EOS
+FROM centos:8
+RUN dnf -y install rpm-build cmake make gcc-c++ wget sqlite-devel boost-devel zlib-devel
+EOS
+)
 
+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 websocketpp.tar.gz https://github.com/zaphoyd/websocketpp/archive/0.7.0.tar.gz
+wget -O capnproto.tar.gz https://github.com/capnproto/capnproto/archive/v0.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
-5027c20cde76fdaef83a74acfcf98e23  websocketpp.tar.gz
+a9de5f042f4cf05515c2d7dfc7f5df21  capnproto.tar.gz
 badd12c511e081fec6c89c43a7027bce  rapidjson.tar.gz
 EOF
 
 tar xzf capnproto.tar.gz
-tar xzf websocketpp.tar.gz
 tar xzf rapidjson.tar.gz
 
-cd /build/capnproto-7a7c4007e3e1b249f078a246749a584c96bf7503/c++/
+cd /build/capnproto-0.7.0/c++/
 cmake3 -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTING=off .
 make -j4
 make install
 
-cd /build/websocketpp-0.7.0/
-cmake3 .
-make install
-
 cd /build/rapidjson-1.1.0/
-cmake3 -DRAPIDJSON_BUILD_EXAMPLES=off .
+cmake -DRAPIDJSON_BUILD_EXAMPLES=off .
 make install
 
 cd
@@ -48,7 +43,7 @@ Version: $VERSION
 Release: 1
 License: GPL
 BuildRequires: systemd-units
-Requires: sqlite boost-filesystem zlib
+Requires: sqlite-libs zlib
 
 %description
 Lightweight Continuous Integration Service
@@ -56,7 +51,7 @@ Lightweight Continuous Integration Service
 %prep
 
 %build
-cmake3 -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/ %{_sourcedir}/laminar-$VERSION
+cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/ -DSYSTEMD_UNITDIR=%{_unitdir} %{_sourcedir}/laminar-$VERSION
 pwd
 make
 
@@ -68,11 +63,13 @@ make
 %{_bindir}/laminard
 %{_unitdir}/laminar.service
 %config(noreplace) %{_sysconfdir}/laminar.conf
+%{_datarootdir}/bash-completion/completions/laminarc
+%{_datarootdir}/zsh/site-functions/_laminarc
 
 %post
 echo Creating laminar user with home in %{_sharedstatedir}/laminar
 useradd -r -d %{_sharedstatedir}/laminar -s %{_sbindir}/nologin laminar
-mkdir -p %{_sharedstatedir}/laminar/cfg/{jobs,nodes,scripts}
+mkdir -p %{_sharedstatedir}/laminar/cfg/{jobs,contexts,scripts}
 chown -R laminar: %{_sharedstatedir}/laminar
 EOF
 

pkg/debian10-amd64.sh

@@ -0,0 +1,48 @@
+#!/bin/bash -e
+
+OUTPUT_DIR=$PWD
+
+SOURCE_DIR=$(readlink -f $(dirname ${BASH_SOURCE[0]})/..)
+
+VERSION=$(cd "$SOURCE_DIR" && git describe --tags --abbrev=8 --dirty)-1~upstream-debian10
+
+DOCKER_TAG=$(docker build -q - <<EOS
+FROM debian:10-slim
+RUN apt-get update && apt-get install -y wget cmake g++ capnproto libcapnp-dev rapidjson-dev libsqlite3-dev libboost-dev zlib1g-dev
+EOS
+)
+
+docker run --rm -i -v $SOURCE_DIR:/laminar:ro -v $OUTPUT_DIR:/output $DOCKER_TAG bash -xe <<EOS
+
+mkdir /build
+cd /build
+
+cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/ -DZSH_COMPLETIONS_DIR=/usr/share/zsh/functions/Completion/Unix /laminar
+make -j4
+mkdir laminar
+make DESTDIR=laminar install/strip
+
+mkdir laminar/DEBIAN
+cat <<EOF > laminar/DEBIAN/control
+Package: laminar
+Version: $VERSION
+Section: 
+Priority: optional
+Architecture: amd64
+Maintainer: Oliver Giles <web ohwg net>
+Depends: libcapnp-0.7.0, libsqlite3-0, zlib1g
+Description: Lightweight Continuous Integration Service
+EOF
+echo /etc/laminar.conf > laminar/DEBIAN/conffiles
+cat <<EOF > laminar/DEBIAN/postinst
+#!/bin/bash
+echo Creating laminar user with home in /var/lib/laminar
+useradd -r -d /var/lib/laminar -s /usr/sbin/nologin laminar
+mkdir -p /var/lib/laminar/cfg/{jobs,contexts,scripts}
+chown -R laminar: /var/lib/laminar
+EOF
+chmod +x laminar/DEBIAN/postinst
+
+dpkg-deb --build laminar
+mv laminar.deb /output/laminar_${VERSION}_amd64.deb
+EOS

pkg/debian10-armhf.sh

@@ -0,0 +1,63 @@
+#!/bin/bash -e
+
+OUTPUT_DIR=$PWD
+
+SOURCE_DIR=$(readlink -f $(dirname ${BASH_SOURCE[0]})/..)
+
+VERSION=$(cd "$SOURCE_DIR" && git describe --tags --abbrev=8 --dirty)-1~upstream-debian10
+
+DOCKER_TAG=$(docker build -q - <<EOS
+FROM debian:10-slim
+RUN dpkg --add-architecture armhf && apt-get update && apt-get install -y wget cmake crossbuild-essential-armhf capnproto libcapnp-dev:armhf rapidjson-dev libsqlite3-dev:armhf libboost-dev:armhf zlib1g-dev:armhf
+EOS
+)
+
+docker run --rm -i -v $SOURCE_DIR:/laminar:ro -v $OUTPUT_DIR:/output $DOCKER_TAG bash -xe <<EOS
+
+mkdir /build
+cd /build
+
+cat > toolchain.cmake <<EOF
+SET(CMAKE_C_COMPILER arm-linux-gnueabihf-gcc)
+SET(CMAKE_CXX_COMPILER arm-linux-gnueabihf-g++)
+set(CMAKE_LIBRARY_ARCHITECTURE arm-linux-gnueabihf)
+EOF
+
+cd /build
+cmake \
+	-DCMAKE_TOOLCHAIN_FILE=toolchain.cmake \
+	-DCMAKE_LINKER=/usr/bin/arm-linux-gnueabihf-ld \
+	-DCMAKE_OBJCOPY=/usr/bin/arm-linux-gnueabihf-objcopy \
+	-DCMAKE_STRIP=/usr/bin/arm-linux-gnueabihf-strip \
+	-DCMAKE_BUILD_TYPE=Release \
+	-DCMAKE_INSTALL_PREFIX=/ \
+	-DZSH_COMPLETIONS_DIR=/usr/share/zsh/functions/Completion/Unix \
+	/laminar
+make -j4
+mkdir laminar
+make DESTDIR=laminar install/strip
+
+mkdir laminar/DEBIAN
+cat <<EOF > laminar/DEBIAN/control
+Package: laminar
+Version: $VERSION
+Section: 
+Priority: optional
+Architecture: armhf
+Maintainer: Oliver Giles <web ohwg net>
+Depends: libcapnp-0.7.0, libsqlite3-0, zlib1g
+Description: Lightweight Continuous Integration Service
+EOF
+echo /etc/laminar.conf > laminar/DEBIAN/conffiles
+cat <<EOF > laminar/DEBIAN/postinst
+#!/bin/bash
+echo Creating laminar user with home in /var/lib/laminar
+useradd -r -d /var/lib/laminar -s /usr/sbin/nologin laminar
+mkdir -p /var/lib/laminar/cfg/{jobs,contexts,scripts}
+chown -R laminar: /var/lib/laminar
+EOF
+chmod +x laminar/DEBIAN/postinst
+
+dpkg-deb --build laminar
+mv laminar.deb /output/laminar_${VERSION}_armhf.deb
+EOS

pkg/debian9-amd64.sh

@@ -1,47 +1,43 @@
-#!/bin/bash
+#!/bin/bash -e
 
 OUTPUT_DIR=$PWD
 
-SOURCE_DIR=$(readlink -f $(dirname ${BASH_SOURCE[0]}))
+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)-1~upstream-debian9
 
-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-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 websocketpp.tar.gz https://github.com/zaphoyd/websocketpp/archive/0.7.0.tar.gz
+wget -O capnproto.tar.gz https://github.com/capnproto/capnproto/archive/v0.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
-5027c20cde76fdaef83a74acfcf98e23  websocketpp.tar.gz
+a9de5f042f4cf05515c2d7dfc7f5df21  capnproto.tar.gz
 badd12c511e081fec6c89c43a7027bce  rapidjson.tar.gz
 EOF
 
 tar xzf capnproto.tar.gz
-tar xzf websocketpp.tar.gz
 tar xzf rapidjson.tar.gz
 
-cd /build/capnproto-7a7c4007e3e1b249f078a246749a584c96bf7503/c++/
+cd /build/capnproto-0.7.0/c++/
 cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTING=off .
 make -j4
 make install
 
-cd /build/websocketpp-0.7.0/
-cmake .
-make install
-
 cd /build/rapidjson-1.1.0/
 cmake -DRAPIDJSON_BUILD_EXAMPLES=off .
 make install
 
 cd /build
-cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/ /laminar
+cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/ -DZSH_COMPLETIONS_DIR=/usr/share/zsh/functions/Completion/Unix /laminar
 make -j4
 mkdir laminar
 make DESTDIR=laminar install/strip
@@ -54,18 +50,19 @@ Section:
 Priority: optional
 Architecture: amd64
 Maintainer: Oliver Giles <web ohwg net>
-Depends: libsqlite3-0, libboost-filesystem1.62.0, zlib1g
+Depends: libsqlite3-0, zlib1g
 Description: Lightweight Continuous Integration Service
 EOF
+echo /etc/laminar.conf > laminar/DEBIAN/conffiles
 cat <<EOF > laminar/DEBIAN/postinst
 #!/bin/bash
 echo Creating laminar user with home in /var/lib/laminar
 useradd -r -d /var/lib/laminar -s /usr/sbin/nologin laminar
-mkdir -p /var/lib/laminar/cfg/{jobs,nodes,scripts}
+mkdir -p /var/lib/laminar/cfg/{jobs,contexts,scripts}
 chown -R laminar: /var/lib/laminar
 EOF
 chmod +x laminar/DEBIAN/postinst
 
 dpkg-deb --build laminar
-mv laminar.deb /output/laminar-$VERSION-1-amd64.deb
+mv laminar.deb /output/laminar_${VERSION}_amd64.deb
 EOS

pkg/debian9-armhf.sh

@@ -0,0 +1,88 @@
+#!/bin/bash -e
+
+OUTPUT_DIR=$PWD
+
+SOURCE_DIR=$(readlink -f $(dirname ${BASH_SOURCE[0]})/..)
+
+VERSION=$(cd "$SOURCE_DIR" && git describe --tags --abbrev=8 --dirty)-1~upstream-debian9
+
+DOCKER_TAG=$(docker build -q - <<EOS
+FROM debian:9-slim
+RUN dpkg --add-architecture armhf && apt-get update && apt-get install -y wget cmake crossbuild-essential-armhf libsqlite3-dev:armhf libboost-dev:armhf zlib1g-dev:armhf
+EOS
+)
+
+docker run --rm -i -v $SOURCE_DIR:/laminar:ro -v $OUTPUT_DIR:/output $DOCKER_TAG bash -xe <<EOS
+
+mkdir /build
+cd /build
+
+cat > toolchain.cmake <<EOF
+SET(CMAKE_C_COMPILER arm-linux-gnueabihf-gcc)
+SET(CMAKE_CXX_COMPILER arm-linux-gnueabihf-g++)
+set(CMAKE_LIBRARY_ARCHITECTURE arm-linux-gnueabihf)
+EOF
+
+wget -O capnproto.tar.gz https://github.com/capnproto/capnproto/archive/v0.7.0.tar.gz
+wget -O rapidjson.tar.gz https://github.com/miloyip/rapidjson/archive/v1.1.0.tar.gz
+md5sum -c <<EOF
+a9de5f042f4cf05515c2d7dfc7f5df21  capnproto.tar.gz
+badd12c511e081fec6c89c43a7027bce  rapidjson.tar.gz
+EOF
+
+tar xzf capnproto.tar.gz
+tar xzf rapidjson.tar.gz
+
+mkdir capnproto-host
+cd capnproto-host
+cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTING=off /build/capnproto-0.7.0/c++/
+make -j4
+make install
+
+cd /build/capnproto-0.7.0/c++/
+cmake -DCMAKE_TOOLCHAIN_FILE=../../toolchain.cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTING=OFF -DCMAKE_INSTALL_PREFIX=/usr/arm-linux-gnueabihf/ .
+make -j4
+make install
+
+cd /build/rapidjson-1.1.0/
+cmake -DRAPIDJSON_BUILD_EXAMPLES=off -DCMAKE_INSTALL_PREFIX=/usr/arm-linux-gnueabihf/ .
+make install
+
+cd /build
+cmake \
+	-DCMAKE_TOOLCHAIN_FILE=toolchain.cmake \
+	-DCMAKE_LINKER=/usr/bin/arm-linux-gnueabihf-ld \
+	-DCMAKE_OBJCOPY=/usr/bin/arm-linux-gnueabihf-objcopy \
+	-DCMAKE_STRIP=/usr/bin/arm-linux-gnueabihf-strip \
+	-DCMAKE_BUILD_TYPE=Release \
+	-DCMAKE_INSTALL_PREFIX=/ \
+	-DZSH_COMPLETIONS_DIR=/usr/share/zsh/functions/Completion/Unix \
+	/laminar
+make -j4
+mkdir laminar
+make DESTDIR=laminar install/strip
+
+mkdir laminar/DEBIAN
+cat <<EOF > laminar/DEBIAN/control
+Package: laminar
+Version: $VERSION
+Section: 
+Priority: optional
+Architecture: armhf
+Maintainer: Oliver Giles <web ohwg net>
+Depends: libsqlite3-0, zlib1g
+Description: Lightweight Continuous Integration Service
+EOF
+echo /etc/laminar.conf > laminar/DEBIAN/conffiles
+cat <<EOF > laminar/DEBIAN/postinst
+#!/bin/bash
+echo Creating laminar user with home in /var/lib/laminar
+useradd -r -d /var/lib/laminar -s /usr/sbin/nologin laminar
+mkdir -p /var/lib/laminar/cfg/{jobs,contexts,scripts}
+chown -R laminar: /var/lib/laminar
+EOF
+chmod +x laminar/DEBIAN/postinst
+
+dpkg-deb --build laminar
+mv laminar.deb /output/laminar_${VERSION}_armhf.deb
+EOS

src/client.cpp

@@ -1,5 +1,5 @@
 ///
-/// Copyright 2015-2017 Oliver Giles
+/// Copyright 2015-2018 Oliver Giles
 ///
 /// This file is part of Laminar
 ///
@@ -23,9 +23,13 @@
 
 #include <stdio.h>
 #include <stdlib.h>
-#include <errno.h>
 
-#define EFAILED 55
+#define EXIT_BAD_ARGUMENT     1
+#define EXIT_OPERATION_FAILED 2
+#define EXIT_RUN_FAILED       3
+
+// Definition needed for musl
+typedef unsigned int uint;
 
 template<typename T>
 static int setParams(int argc, char** argv, T& request) {
@@ -36,20 +40,13 @@ static int setParams(int argc, char** argv, T& request) {
         n++;
     }
 
-    int argsConsumed = n;
-
     char* job = getenv("JOB");
     char* num = getenv("RUN");
     char* reason = getenv("LAMINAR_REASON");
 
-    if(job && num) n+=2;
-    else if(reason) n++;
+    auto params = request.initParams(n + (job&&num?2:0) + (reason?1:0));
 
-    if(n == 0) return argsConsumed;
-
-    auto params = request.initParams(n);
-
-    for(int i = 0; i < argsConsumed; ++i) {
+    for(int i = 0; i < n; ++i) {
         char* name = argv[i];
         char* val = strchr(name, '=');
         *val++ = '\0';
@@ -57,23 +54,32 @@ static int setParams(int argc, char** argv, T& request) {
         params[i].setValue(val);
     }
 
+    int argsConsumed = n;
+
     if(job && num) {
-        params[argsConsumed].setName("=parentJob");
-        params[argsConsumed].setValue(job);
-        params[argsConsumed+1].setName("=parentBuild");
-        params[argsConsumed+1].setValue(num);
-    } else if(reason) {
-        params[argsConsumed].setName("=reason");
-        params[argsConsumed].setValue(reason);
+        params[n].setName("=parentJob");
+        params[n++].setValue(job);
+        params[n].setName("=parentBuild");
+        params[n++].setValue(num);
+    }
+    if(reason) {
+        params[n].setName("=reason");
+        params[n].setValue(reason);
     }
 
     return argsConsumed;
 }
 
+static void printTriggerLink(const char* job, uint run) {
+    // use a private ANSI CSI sequence to mark the JOB:NUM so the
+    // frontend can recognise it and generate a hyperlink.
+    printf("\033[{%s:%d\033\\\n", job, run);
+}
+
 int main(int argc, char** argv) {
     if(argc < 2) {
         fprintf(stderr, "Usage: %s <command> [parameters...]\n", argv[0]);
-        return EINVAL;
+        return EXIT_BAD_ARGUMENT;
     }
 
     int ret = 0;
@@ -84,16 +90,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]);
-            return EINVAL;
+            fprintf(stderr, "Usage %s queue <jobName>\n", argv[0]);
+            return EXIT_BAD_ARGUMENT;
         }
-        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());
@@ -103,34 +109,65 @@ int main(int argc, char** argv) {
         for(auto& p : promises) {
             if(p.wait(waitScope).getResult() != LaminarCi::MethodResult::SUCCESS) {
                 fprintf(stderr, "Failed to queue job '%s'\n", argv[2]);
-                return ENOENT;
+                return EXIT_OPERATION_FAILED;
             }
         }
-    } 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]);
-            return EINVAL;
+            fprintf(stderr, "Usage %s queue <jobName>\n", argv[0]);
+            return EXIT_BAD_ARGUMENT;
         }
         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 = EXIT_OPERATION_FAILED;
+                }
+                printTriggerLink(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 EXIT_BAD_ARGUMENT;
         }
+        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){
+                printTriggerLink(argv[jobNameIndex], resp.getBuildNum());
+                if(resp.getResult() != LaminarCi::JobResult::SUCCESS) {
+                    ret = EXIT_RUN_FAILED;
+                }
+            }));
+            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]);
-            return EINVAL;
+            return EXIT_BAD_ARGUMENT;
         }
         auto req = laminar.setRequest();
         char* eq = strchr(argv[2], '=');
@@ -140,26 +177,52 @@ int main(int argc, char** argv) {
             char* name = argv[2];
             *eq++ = '\0';
             char* val = eq;
-            req.setJobName(job);
-            req.setBuildNum(atoi(num));
+            req.getRun().setJob(job);
+            req.getRun().setBuildNum(atoi(num));
             req.getParam().setName(name);
             req.getParam().setValue(val);
             req.send().wait(waitScope);
         } else {
             fprintf(stderr, "Missing $JOB or $RUN or param is not in the format key=value\n");
-            return EINVAL;
+            return EXIT_BAD_ARGUMENT;
+        }
+    } else if(strcmp(argv[1], "abort") == 0) {
+        if(argc != 4) {
+            fprintf(stderr, "Usage %s abort <jobName> <jobNumber>\n", argv[0]);
+            return EXIT_BAD_ARGUMENT;
+        }
+        auto req = laminar.abortRequest();
+        req.getRun().setJob(argv[2]);
+        req.getRun().setBuildNum(atoi(argv[3]));
+        if(req.send().wait(waitScope).getResult() != LaminarCi::MethodResult::SUCCESS)
+            ret = EXIT_OPERATION_FAILED;
+    } else if(strcmp(argv[1], "show-jobs") == 0) {
+        if(argc != 2) {
+            fprintf(stderr, "Usage: %s show-jobs\n", argv[0]);
+            return EXIT_BAD_ARGUMENT;
+        }
+        for(auto it : laminar.listKnownRequest().send().wait(waitScope).getResult()) {
+            printf("%s\n", it.cStr());
+        }
+    } else if(strcmp(argv[1], "show-queued") == 0) {
+        if(argc != 2) {
+            fprintf(stderr, "Usage: %s show-queued\n", argv[0]);
+            return EXIT_BAD_ARGUMENT;
+        }
+        for(auto it : laminar.listQueuedRequest().send().wait(waitScope).getResult()) {
+            printf("%s\n", it.cStr());
+        }
+    } else if(strcmp(argv[1], "show-running") == 0) {
+        if(argc != 2) {
+            fprintf(stderr, "Usage: %s show-running\n", argv[0]);
+            return EXIT_BAD_ARGUMENT;
+        }
+        for(auto it : laminar.listRunningRequest().send().wait(waitScope).getResult()) {
+            printf("%s:%d\n", it.getJob().cStr(), it.getBuildNum());
         }
-    } else if(strcmp(argv[1], "lock") == 0) {
-        auto req = laminar.lockRequest();
-        req.setLockName(argv[2]);
-        req.send().wait(waitScope);
-    } else if(strcmp(argv[1], "release") == 0) {
-        auto req = laminar.releaseRequest();
-        req.setLockName(argv[2]);
-        req.send().wait(waitScope);
     } else {
         fprintf(stderr, "Unknown command %s\n", argv[1]);
-        return EINVAL;
+        return EXIT_BAD_ARGUMENT;
     }
 
     return ret;

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/context.h

@@ -0,0 +1,51 @@
+///
+/// Copyright 2015-2019 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/>
+///
+#ifndef LAMINAR_CONTEXT_H_
+#define LAMINAR_CONTEXT_H_
+
+#include <fnmatch.h>
+#include <string>
+#include <set>
+class Run;
+
+// Represents a context within which a Run will be executed. Allows applying
+// a certain environment to a set of Jobs, or setting a limit on the number
+// of parallel Runs
+class Context {
+public:
+    Context() {}
+
+    std::string name;
+    int numExecutors;
+    int busyExecutors = 0;
+
+    bool canQueue(std::set<std::string>& patterns) {
+        if(busyExecutors >= numExecutors)
+            return false;
+
+        for(std::string pattern : patterns) {
+            if(fnmatch(pattern.c_str(), name.c_str(), FNM_EXTMATCH) == 0)
+                return true;
+        }
+        return false;
+    }
+};
+
+
+#endif // LAMINAR_CONTEXT_H_

src/database.cpp

@@ -1,5 +1,5 @@
 ///
-/// Copyright 2015-2016 Oliver Giles
+/// Copyright 2015-2018 Oliver Giles
 ///
 /// This file is part of Laminar
 ///
@@ -20,17 +20,52 @@
 
 #include <sqlite3.h>
 #include <string.h>
+#include <math.h>
+
+struct StdevCtx {
+    double mean;
+    double M2;
+    int64_t count;
+};
+
+static void stdevStep(sqlite3_context *ctx, int, sqlite3_value **args)
+{
+    StdevCtx* p = static_cast<StdevCtx*>(sqlite3_aggregate_context(ctx, sizeof(StdevCtx)));
+    // Welford's Online Algorithm
+    if(sqlite3_value_numeric_type(args[0]) != SQLITE_NULL) {
+        p->count++;
+        double val = sqlite3_value_double(args[0]);
+        double delta = val - p->mean;
+        p->mean += delta / p->count;
+        p->M2 += delta * (val - p->mean);
+    }
+}
+
+static void stdevFinalize(sqlite3_context *context){
+    StdevCtx* p = static_cast<StdevCtx*>(sqlite3_aggregate_context(context, 0));
+    if(p && p->count > 1)
+        sqlite3_result_double(context, sqrt(p->M2 / (p->count-1)));
+    else
+        sqlite3_result_null(context);
+}
 
 Database::Database(const char *path) {
     sqlite3_open(path, &hdl);
+    int create_func_flags = SQLITE_UTF8;
+#if SQLITE_VERSION_NUMBER >= 3008003
+    create_func_flags |= SQLITE_DETERMINISTIC;
+#endif
+    sqlite3_create_function(hdl, "STDEV", 1, create_func_flags, NULL, NULL, stdevStep, stdevFinalize);
 }
 
 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 +74,63 @@ 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));
+}
+
+template<> double Database::Statement::fetchColumn(int col) {
+    return sqlite3_column_double(stmt, col);
 }
 
 bool Database::Statement::row() {

src/database.h

@@ -1,5 +1,5 @@
 ///
-/// Copyright 2015-2016 Oliver Giles
+/// Copyright 2015-2018 Oliver Giles
 ///
 /// This file is part of Laminar
 ///
@@ -16,12 +16,16 @@
 /// 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>
 
+// Definition needed for musl
+typedef unsigned int uint;
+typedef unsigned long ulong;
+
 struct sqlite3;
 struct sqlite3_stmt;
 
@@ -52,6 +56,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 +107,7 @@ private:
             }
         };
         template<typename...Args>
-        friend class FetchMarshaller;
+        friend struct FetchMarshaller;
 
         bool row();
 
@@ -114,6 +123,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 +152,9 @@ 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);
+template<> double Database::Statement::fetchColumn(int col);
 
-#endif // _LAMINAR_DATABASE_H_
+#endif // LAMINAR_DATABASE_H_

src/http.cpp

@@ -0,0 +1,299 @@
+///
+/// Copyright 2015-2019 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 "http.h"
+#include "resources.h"
+#include "monitorscope.h"
+#include "log.h"
+
+#include "laminar.h"
+
+// Helper class which wraps another class with calls to
+// adding and removing a pointer to itself from a passed
+// std::set reference. Used to keep track of currently
+// connected clients
+template<typename T, typename ...Args>
+struct WithSetRef : public T {
+    WithSetRef(std::set<T*>& set, Args&& ...args) :
+        T(std::forward(args)...),
+        _set(set)
+    {
+        _set.insert(this);
+    }
+    ~WithSetRef() {
+        _set.erase(this);
+    }
+private:
+    std::set<T*>& _set;
+};
+
+struct EventPeer {
+    MonitorScope scope;
+    std::list<std::string> pendingOutput;
+    kj::Own<kj::PromiseFulfiller<void>> fulfiller;
+};
+
+struct LogWatcher {
+    std::string job;
+    uint run;
+    std::list<std::string> pendingOutput;
+    kj::Own<kj::PromiseFulfiller<bool>> fulfiller;
+};
+
+kj::Maybe<MonitorScope> fromUrl(std::string resource, char* query) {
+    MonitorScope scope;
+
+    if(query) {
+        char *sk;
+        for(char* k = strtok_r(query, "&", &sk); k; k = strtok_r(nullptr, "&", &sk)) {
+            if(char* v = strchr(k, '=')) {
+                *v++ = '\0';
+                if(strcmp(k, "page") == 0)
+                    scope.page = atoi(v);
+                else if(strcmp(k, "field") == 0)
+                    scope.field = v;
+                else if(strcmp(k, "order") == 0)
+                    scope.order_desc = (strcmp(v, "dsc") == 0);
+            }
+        }
+    }
+
+    if(resource == "/") {
+        scope.type = MonitorScope::HOME;
+        return kj::mv(scope);
+    }
+
+    if(resource.substr(0, 5) != "/jobs")
+        return nullptr;
+
+    if(resource.length() == 5) {
+        scope.type = MonitorScope::ALL;
+        return kj::mv(scope);
+    }
+
+    resource = resource.substr(5);
+    size_t split = resource.find('/',1);
+    std::string job = resource.substr(1,split-1);
+    if(job.empty())
+        return nullptr;
+
+    scope.job = job;
+    scope.type = MonitorScope::JOB;
+    if(split == std::string::npos)
+        return kj::mv(scope);
+
+    size_t split2 = resource.find('/', split+1);
+    std::string run = resource.substr(split+1, split2-split);
+    if(run.empty())
+        return nullptr;
+
+    scope.num = static_cast<uint>(atoi(run.c_str()));
+    scope.type = MonitorScope::RUN;
+    return kj::mv(scope);
+}
+
+// Parses the url of the form /log/NAME/NUMBER, filling in the passed
+// references and returning true if successful. /log/NAME/latest is
+// also allowed, in which case the num reference is set to 0
+bool Http::parseLogEndpoint(kj::StringPtr url, std::string& name, uint& num) {
+    if(url.startsWith("/log/")) {
+        kj::StringPtr path = url.slice(5);
+        KJ_IF_MAYBE(sep, path.findFirst('/')) {
+            name = path.slice(0, *sep).begin();
+            kj::StringPtr tail = path.slice(*sep+1);
+            num = static_cast<uint>(atoi(tail.begin()));
+            name.erase(*sep);
+            if(tail == "latest")
+                num = laminar.latestRun(name);
+            if(num > 0)
+                return true;
+        }
+    }
+    return false;
+}
+
+kj::Promise<void> Http::cleanupPeers(kj::Timer& timer)
+{
+    return timer.afterDelay(15 * kj::SECONDS).then([&]{
+        for(EventPeer* p : eventPeers) {
+            // an empty SSE message is a colon followed by two newlines
+            p->pendingOutput.push_back(":\n\n");
+            p->fulfiller->fulfill();
+        }
+        return cleanupPeers(timer);
+    }).eagerlyEvaluate(nullptr);
+}
+
+kj::Promise<void> writeEvents(EventPeer* peer, kj::AsyncOutputStream* stream) {
+    auto paf = kj::newPromiseAndFulfiller<void>();
+    peer->fulfiller = kj::mv(paf.fulfiller);
+    return paf.promise.then([=]{
+        kj::Promise<void> p = kj::READY_NOW;
+        std::list<std::string> chunks = kj::mv(peer->pendingOutput);
+        for(std::string& s : chunks) {
+            p = p.then([=,&s]{
+                return stream->write(s.data(), s.size());
+            });
+        }
+        return p.attach(kj::mv(chunks)).then([=]{
+            return writeEvents(peer, stream);
+        });
+    });
+}
+
+kj::Promise<void> writeLogChunk(LogWatcher* client, kj::AsyncOutputStream* stream) {
+    auto paf = kj::newPromiseAndFulfiller<bool>();
+    client->fulfiller = kj::mv(paf.fulfiller);
+    return paf.promise.then([=](bool done){
+        kj::Promise<void> p = kj::READY_NOW;
+        std::list<std::string> chunks = kj::mv(client->pendingOutput);
+        for(std::string& s : chunks) {
+            p = p.then([=,&s]{
+                return stream->write(s.data(), s.size());
+            });
+        }
+        return p.attach(kj::mv(chunks)).then([=]{
+            return done ? kj::Promise<void>(kj::READY_NOW) : writeLogChunk(client, stream);
+        });
+    });
+}
+
+kj::Promise<void> Http::request(kj::HttpMethod method, kj::StringPtr url, const kj::HttpHeaders &headers, kj::AsyncInputStream &requestBody, HttpService::Response &response)
+{
+    const char* start, *end, *content_type;
+    std::string badge;
+    // for log requests
+    std::string name;
+    uint num;
+    kj::HttpHeaders responseHeaders(*headerTable);
+    responseHeaders.clear();
+    bool is_sse = false;
+    char* queryString = nullptr;
+    // Clients usually expect that http servers will ignore unknown query parameters,
+    // and expect to use this feature to work around browser limitations like there
+    // being no way to programatically force a resource to be reloaded from the server
+    // (without "Cache-Control: no-store", which is overkill). See issue #89.
+    // So first parse any query parameters we *are* interested in, then simply remove
+    // them from the URL, to make comparisions easier.
+    KJ_IF_MAYBE(queryIdx, url.findFirst('?')) {
+        const_cast<char*>(url.begin())[*queryIdx] = '\0';
+        queryString = const_cast<char*>(url.begin() + *queryIdx + 1);
+        url = url.begin();
+    }
+
+    KJ_IF_MAYBE(accept, headers.get(ACCEPT)) {
+        is_sse = (*accept == "text/event-stream");
+    }
+
+    if(is_sse) {
+        KJ_IF_MAYBE(s, fromUrl(url.cStr(), queryString)) {
+            responseHeaders.set(kj::HttpHeaderId::CONTENT_TYPE, "text/event-stream");
+            auto peer = kj::heap<WithSetRef<EventPeer>>(eventPeers);
+            peer->scope = *s;
+            std::string st = "data: " + laminar.getStatus(peer->scope) + "\n\n";
+            auto stream = response.send(200, "OK", responseHeaders);
+            return stream->write(st.data(), st.size()).attach(kj::mv(st)).then([=,s=stream.get(),p=peer.get()]{
+                return writeEvents(p,s);
+            }).attach(kj::mv(stream)).attach(kj::mv(peer));
+        }
+    } else if(url.startsWith("/archive/")) {
+        KJ_IF_MAYBE(file, laminar.getArtefact(url.slice(strlen("/archive/")))) {
+            auto array = (*file)->mmap(0, (*file)->stat().size);
+            responseHeaders.add("Content-Transfer-Encoding", "binary");
+            auto stream = response.send(200, "OK", responseHeaders, array.size());
+            return stream->write(array.begin(), array.size()).attach(kj::mv(array)).attach(kj::mv(file)).attach(kj::mv(stream));
+        }
+    } else if(parseLogEndpoint(url, name, num)) {
+        auto lw = kj::heap<WithSetRef<LogWatcher>>(logWatchers);
+        lw->job = name;
+        lw->run = num;
+        bool complete;
+        std::string output;
+        if(laminar.handleLogRequest(name, num, output, complete)) {
+            responseHeaders.set(kj::HttpHeaderId::CONTENT_TYPE, "text/plain; charset=utf-8");
+            responseHeaders.add("Content-Transfer-Encoding", "binary");
+            // Disables nginx reverse-proxy's buffering. Necessary for dynamic log output.
+            responseHeaders.add("X-Accel-Buffering", "no");
+            auto stream = response.send(200, "OK", responseHeaders, nullptr);
+            return stream->write(output.data(), output.size()).then([=,s=stream.get(),c=lw.get()]{
+                if(complete)
+                    return kj::Promise<void>(kj::READY_NOW);
+                return writeLogChunk(c, s);
+            }).attach(kj::mv(output)).attach(kj::mv(stream)).attach(kj::mv(lw));
+        }
+    } else if(url == "/custom/style.css") {
+        responseHeaders.set(kj::HttpHeaderId::CONTENT_TYPE, "text/css; charset=utf-8");
+        responseHeaders.add("Content-Transfer-Encoding", "binary");
+        std::string css = laminar.getCustomCss();
+        auto stream = response.send(200, "OK", responseHeaders, css.size());
+        return stream->write(css.data(), css.size()).attach(kj::mv(css)).attach(kj::mv(stream));
+    } else if(resources->handleRequest(url.cStr(), &start, &end, &content_type)) {
+        responseHeaders.set(kj::HttpHeaderId::CONTENT_TYPE, content_type);
+        responseHeaders.add("Content-Encoding", "gzip");
+        responseHeaders.add("Content-Transfer-Encoding", "binary");
+        auto stream = response.send(200, "OK", responseHeaders, end-start);
+        return stream->write(start, end-start).attach(kj::mv(stream));
+    } else if(url.startsWith("/badge/") && url.endsWith(".svg") && laminar.handleBadgeRequest(std::string(url.begin()+7, url.size()-11), badge)) {
+        responseHeaders.set(kj::HttpHeaderId::CONTENT_TYPE, "image/svg+xml");
+        responseHeaders.add("Cache-Control", "no-cache");
+        auto stream = response.send(200, "OK", responseHeaders, badge.size());
+        return stream->write(badge.data(), badge.size()).attach(kj::mv(badge)).attach(kj::mv(stream));
+    }
+    return response.sendError(404, "Not Found", responseHeaders);
+}
+
+Http::Http(Laminar &li) :
+  laminar(li),
+  resources(kj::heap<Resources>())
+{
+    kj::HttpHeaderTable::Builder builder;
+    ACCEPT = builder.add("Accept");
+    headerTable = builder.build();
+}
+
+Http::~Http()
+{
+    KJ_ASSERT(logWatchers.size() == 0);
+    KJ_ASSERT(eventPeers.size() == 0);
+}
+
+kj::Promise<void> Http::startServer(kj::Timer& timer, kj::Own<kj::ConnectionReceiver>&& listener)
+{
+    kj::Own<kj::HttpServer> server = kj::heap<kj::HttpServer>(timer, *headerTable, *this);
+    return server->listenHttp(*listener).attach(cleanupPeers(timer)).attach(kj::mv(listener)).attach(kj::mv(server));
+}
+
+void Http::notifyEvent(const char *data, std::string job)
+{
+    for(EventPeer* c : eventPeers) {
+        if(c->scope.wantsStatus(job)) {
+            c->pendingOutput.push_back("data: " + std::string(data) + "\n\n");
+            c->fulfiller->fulfill();
+        }
+    }
+}
+
+void Http::notifyLog(std::string job, uint run, std::string log_chunk, bool eot)
+{
+    for(LogWatcher* lw : logWatchers) {
+        if(lw->job == job && lw->run == run) {
+            lw->pendingOutput.push_back(kj::mv(log_chunk));
+            lw->fulfiller->fulfill(kj::mv(eot));
+        }
+    }
+}

src/http.h

@@ -0,0 +1,66 @@
+///
+/// Copyright 2019 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/>
+///
+#ifndef LAMINAR_HTTP_H_
+#define LAMINAR_HTTP_H_
+
+#include <kj/memory.h>
+#include <kj/compat/http.h>
+#include <string>
+#include <set>
+
+// Definition needed for musl
+typedef unsigned int uint;
+typedef unsigned long ulong;
+
+struct Laminar;
+struct Resources;
+struct LogWatcher;
+struct EventPeer;
+
+class Http : public kj::HttpService {
+public:
+    Http(Laminar&li);
+    virtual ~Http();
+
+    kj::Promise<void> startServer(kj::Timer &timer, kj::Own<kj::ConnectionReceiver> &&listener);
+
+    void notifyEvent(const char* data, std::string job = nullptr);
+    void notifyLog(std::string job, uint run, std::string log_chunk, bool eot);
+
+private:
+    virtual kj::Promise<void> request(kj::HttpMethod method, kj::StringPtr url, const kj::HttpHeaders& headers,
+                                      kj::AsyncInputStream& requestBody, Response& response) override;
+    bool parseLogEndpoint(kj::StringPtr url, std::string &name, uint &num);
+
+    // With SSE, there is no notification if a client disappears. Also, an idle
+    // client must be kept alive if there is no activity in their MonitorScope.
+    // Deal with these by sending a periodic keepalive and reaping the client if
+    // the write fails.
+    kj::Promise<void> cleanupPeers(kj::Timer &timer);
+
+    Laminar& laminar;
+    std::set<EventPeer*> eventPeers;
+    kj::Own<kj::HttpHeaderTable> headerTable;
+    kj::Own<Resources> resources;
+    std::set<LogWatcher*> logWatchers;
+
+    kj::HttpHeaderId ACCEPT;
+};
+
+#endif //LAMINAR_HTTP_H_

src/interface.h

@@ -1,123 +0,0 @@
-///
-/// Copyright 2015 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/>
-///
-#ifndef INTERFACE_H
-#define INTERFACE_H
-
-#include "run.h"
-
-#include <string>
-#include <memory>
-#include <unordered_map>
-
-typedef std::unordered_map<std::string, std::string> ParamMap;
-
-// Simple struct to define which information a frontend client is interested
-// in, both in initial request phase and real-time updates. It corresponds
-// loosely to frontend URLs
-struct MonitorScope {
-    enum Type {
-        HOME, // home page: recent builds and statistics
-        ALL,  // browse jobs
-        JOB,  // a specific job page
-        RUN,  // a specific run page
-        LOG   // a run's log page
-    };
-
-    MonitorScope(Type type = HOME, std::string job = std::string(), int 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 {
-        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 {
-        return type == LOG && ajob == job && anum == num;
-    }
-
-    Type type;
-    std::string job;
-    int 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 void sendMessage(std::string payload) = 0;
-    virtual void close(bool now = true) = 0;
-    MonitorScope scope;
-};
-
-// Represents a (rpc) client that wants to be notified about run completion.
-// Pass instances of this to LaminarInterface registerWaiter and
-// deregisterWaiter
-struct LaminarWaiter {
-    virtual void complete(const Run*) = 0;
-};
-
-// The interface connecting the network layer to the application business
-// logic. These methods fulfil the requirements of both the HTTP/Websocket
-// and RPC interfaces.
-struct LaminarInterface {
-    // 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;
-
-    // Register a client (but don't give up ownership). The client will be
-    // notified with a JSON message of any events matching its scope
-    // (see LaminarClient and MonitorScope above)
-    virtual void registerClient(LaminarClient* client) = 0;
-
-    // Call this before destroying a client so that Laminar doesn't try
-    // to call LaminarClient::sendMessage on invalid data
-    virtual void deregisterClient(LaminarClient* client) = 0;
-
-    // Register a waiter (but don't give up ownership). The waiter will be
-    // notified with a callback of any run completion (see LaminarWaiter above)
-    virtual void registerWaiter(LaminarWaiter* waiter) = 0;
-
-    // Call this before destroying a waiter so that Laminar doesn't try
-    // to call LaminarWaiter::complete on invalid data
-    virtual void deregisterWaiter(LaminarWaiter* waiter) = 0;
-
-    // Synchronously send a snapshot of the current status to the given
-    // client (as governed by the client's MonitorScope). This is called on
-    // initial websocket connect.
-    virtual void sendStatus(LaminarClient* client) = 0;
-
-    // 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;
-
-    // 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;
-};
-
-#endif // INTERFACE_H
-

src/laminar.capnp

@@ -2,11 +2,19 @@
 
 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 (run :Run, param :JobParam) -> (result :MethodResult);
+    listQueued @4 () -> (result :List(Text));
+    listRunning @5 () -> (result :List(Run));
+    listKnown @6 () -> (result :List(Text));
+    abort @7 (run :Run) -> (result :MethodResult);
+
+    struct Run {
+        job @0 :Text;
+        buildNum @1 :UInt32;
+    }
 
     struct JobParam {
         name @0 :Text;

src/laminar.h

@@ -1,5 +1,5 @@
 ///
-/// Copyright 2015-2017 Oliver Giles
+/// Copyright 2015-2019 Oliver Giles
 ///
 /// This file is part of Laminar
 ///
@@ -16,78 +16,125 @@
 /// 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"
-#include "node.h"
+#include "monitorscope.h"
+#include "context.h"
 #include "database.h"
 
 #include <unordered_map>
+#include <kj/filesystem.h>
+#include <kj/async-io.h>
 
-// Node name to node object map
-typedef std::unordered_map<std::string,Node> NodeMap;
+// Context name to context object map
+typedef std::unordered_map<std::string, std::shared_ptr<Context>> ContextMap;
 
 struct Server;
 class Json;
 
+class Http;
+class Rpc;
+
+struct Settings {
+    const char* home;
+    const char* bind_rpc;
+    const char* bind_http;
+    const char* archive_url;
+};
+
 // The main class implementing the application's business logic.
-// It owns a Server to manage the HTTP/websocket and Cap'n Proto RPC
-// interfaces and communicates via the LaminarInterface methods and
-// the LaminarClient objects (see interface.h)
-class Laminar final : public LaminarInterface {
+class Laminar final {
 public:
-    Laminar();
-    ~Laminar();
+    Laminar(Server& server, Settings settings);
+    ~Laminar() noexcept;
 
-    // Runs the application forever
-    void run();
-    // Call this in a signal handler to make run() return
-    void stop();
+    // Queues a job, returns immediately. Return value will be nullptr if
+    // the supplied name is not a known job.
+    std::shared_ptr<Run> queueJob(std::string name, ParamMap params = ParamMap());
 
-    // Implementations of LaminarInterface
-    std::shared_ptr<Run> queueJob(std::string name, ParamMap params = ParamMap()) override;
-    void registerClient(LaminarClient* client) override;
-    void deregisterClient(LaminarClient* client) override;
-    void registerWaiter(LaminarWaiter* waiter) override;
-    void deregisterWaiter(LaminarWaiter* waiter) override;
+    // Return the latest known number of the named job
+    uint latestRun(std::string job);
 
-    void sendStatus(LaminarClient* client) override;
-    bool setParam(std::string job, int buildNum, std::string param, std::string value) override;
-    bool getArtefact(std::string path, std::string& result) override;
+    // Given a job name and number, return existence and (via reference params)
+    // its current log output and whether the job is ongoing
+    bool handleLogRequest(std::string name, uint num, std::string& output, bool& complete);
+
+    // Given a relevant scope, returns a JSON string describing the current
+    // server status. Content differs depending on the page viewed by the user,
+    // which should be provided as part of the scope.
+    std::string getStatus(MonitorScope scope);
+
+    // Implements the laminarc function of setting arbitrary parameters on a run,
+    // (typically the current run) which will be made available in the environment
+    // of subsequent scripts.
+    bool setParam(std::string job, uint buildNum, std::string param, std::string value);
+
+    // Gets the list of jobs currently waiting in the execution queue
+    const std::list<std::shared_ptr<Run>>& listQueuedJobs();
+
+    // Gets the list of currently executing jobs
+    const RunSet& listRunningJobs();
+
+    // Gets the list of known jobs - scans cfg/jobs for *.run files
+    std::list<std::string> listKnownJobs();
+
+    // Fetches the content of an artifact given its filename relative to
+    // $LAMINAR_HOME/archive. Ideally, this would instead be served by a
+    // proper web server which handles this url.
+    kj::Maybe<kj::Own<const kj::ReadableFile>> getArtefact(std::string path);
+
+    // Given the name of a job, populate the provided string reference with
+    // SVG content describing the last known state of the job. Returns false
+    // if the job is unknown.
+    bool handleBadgeRequest(std::string job, std::string& badge);
+
+    // Fetches the content of $LAMINAR_HOME/custom/style.css or an empty
+    // string. Ideally, this would instead be served by a proper web server
+    // which handles this url.
+    std::string getCustomCss();
+
+    // Aborts a single job
+    bool abort(std::string job, uint buildNum);
+
+    // Abort all running jobs
+    void abortAll();
 
 private:
     bool loadConfiguration();
-    void reapAdvance();
     void assignNewJobs();
-    bool stepRun(std::shared_ptr<Run> run);
-    void handleRunLog(std::shared_ptr<Run> run, std::string log);
+    bool tryStartRun(std::shared_ptr<Run> run, int queueIndex);
+    kj::Promise<void> handleRunStep(Run *run);
     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(const std::string name, uint num) {
+        auto it = activeJobs.byNameNumber().find(boost::make_tuple(name, num));
+        return it == activeJobs.byNameNumber().end() ? nullptr : it->get();
     }
 
     std::list<std::shared_ptr<Run>> queuedJobs;
 
     std::unordered_map<std::string, uint> buildNums;
 
-    std::unordered_map<std::string, std::set<std::string>> jobTags;
+    std::unordered_map<std::string, std::set<std::string>> jobContexts;
 
+    std::unordered_map<std::string, std::string> jobGroups;
+
+    Settings settings;
     RunSet activeJobs;
     Database* db;
-    Server* srv;
-    NodeMap nodes;
-    std::string homeDir;
-    std::set<LaminarClient*> clients;
-    std::set<LaminarWaiter*> waiters;
+    Server& srv;
+    ContextMap contexts;
+    kj::Path homePath;
+    kj::Own<const kj::Directory> fsHome;
     uint numKeepRunDirs;
     std::string archiveUrl;
+
+    kj::Own<Http> http;
+    kj::Own<Rpc> rpc;
 };
 
-#endif // _LAMINAR_LAMINAR_H_
+#endif // LAMINAR_LAMINAR_H_

src/log.h

@@ -1,5 +1,5 @@
 ///
-/// Copyright 2015 Oliver Giles
+/// Copyright 2015-2019 Oliver Giles
 ///
 /// This file is part of Laminar
 ///
@@ -16,22 +16,56 @@
 /// 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>
+#include <utility>
 
-// Simple override to prevent full paths to source files from
-// appearing in log messages. Assumes / is the path separator.
-// @see kj/debug.h
-
-#define _LBASENAME(path) strrchr(path, '/') ? strrchr(path, '/') + 1 : path
+// Prevent full file paths from appearing in log messages. With compiler
+// optimization, this compile-time method should completely prevent the
+// paths from being encoded into the binary at all. Assumes / is the
+// path separator.
+namespace _ {
+    constexpr const char* static_basename_impl(const char* b, const char* t) {
+        return *t == '\0' ? b : static_basename_impl(*t == '/' ? t+1 : b, t+1);
+    }
+    constexpr const char* static_basename(const char* p) {
+        return static_basename_impl(p, p);
+    }
+    constexpr int static_strlen(const char* s) {
+        return *s == '\0' ? 0 : static_strlen(s + 1) + 1;
+    }
+    template<int N, int...I>
+    static constexpr decltype(auto) static_alloc_str_impl(const char* str, std::integer_sequence<int, I...>) {
+        typedef struct {char buf[N+1];} static_null_terminated;
+        return (static_null_terminated) {str[I]..., '\0'};
+    }
+    template<int N>
+    static constexpr decltype(auto) static_alloc_str(const char* str) {
+        return static_alloc_str_impl<N>(str, std::make_integer_sequence<int, N>());
+    }
+}
+#define __FILE_BASE__ (::_::static_alloc_str<::_::static_strlen(::_::static_basename(__FILE__))>\
+                        (::_::static_basename(__FILE__)).buf)
 
+// Provide alternative implementations to those from kj/debug.h which
+// use __FILE__ directly and thus cause the full path to be encoded in
+// the final binary
 #define LLOG(severity, ...) \
   if (!::kj::_::Debug::shouldLog(::kj::_::Debug::Severity::severity)) {} else \
-    ::kj::_::Debug::log(_LBASENAME(__FILE__), __LINE__, ::kj::_::Debug::Severity::severity, \
-                        #__VA_ARGS__, __VA_ARGS__)
+    ::kj::_::Debug::log(__FILE_BASE__, __LINE__, \
+      ::kj::_::Debug::Severity::severity, #__VA_ARGS__, __VA_ARGS__)
 
+#define LASSERT(cond, ...) \
+  if (KJ_LIKELY(cond)) {} else \
+    for (::kj::_::Debug::Fault f(__FILE_BASE__, __LINE__, \
+      ::kj::Exception::Type::FAILED, #cond, #__VA_ARGS__, ##__VA_ARGS__);; f.fatal())
 
-#endif // _LAMINAR_LOG_H_
+#define LSYSCALL(call, ...) \
+  if (auto _kjSyscallResult = ::kj::_::Debug::syscall([&](){return (call);}, false)) {} else \
+    for (::kj::_::Debug::Fault f(__FILE_BASE__, __LINE__, \
+      _kjSyscallResult.getErrorNumber(), #call, #__VA_ARGS__, ##__VA_ARGS__);; f.fatal())
+
+#endif // LAMINAR_LOG_H_
 

src/main.cpp

@@ -17,16 +17,31 @@
 /// along with Laminar.  If not, see <http://www.gnu.org/licenses/>
 ///
 #include "laminar.h"
+#include "server.h"
 #include "log.h"
-
 #include <signal.h>
+#include <kj/async-unix.h>
+#include <kj/filesystem.h>
 
 static Laminar* laminar;
+static Server* server;
 
 static void laminar_quit(int) {
-    laminar->stop();
+    // 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.
+    laminar->abortAll();
+    server->stop();
 }
 
+namespace {
+constexpr const char* INTADDR_RPC_DEFAULT = "unix-abstract:laminar";
+constexpr const char* INTADDR_HTTP_DEFAULT = "*:8080";
+constexpr const char* ARCHIVE_URL_DEFAULT = "/archive/";
+}
+
+
+
 int main(int argc, char** argv) {
     for(int i = 1; i < argc; ++i) {
         if(strcmp(argv[i], "-v") == 0) {
@@ -34,13 +49,27 @@ int main(int argc, char** argv) {
         }
     }
 
-    laminar = new Laminar;
+    auto ioContext = kj::setupAsyncIo();
+
+    Settings settings;
+    // Default values when none were supplied in $LAMINAR_CONF_FILE (/etc/laminar.conf)
+    settings.home = getenv("LAMINAR_HOME") ?: "/var/lib/laminar";
+    settings.bind_rpc = getenv("LAMINAR_BIND_RPC") ?: INTADDR_RPC_DEFAULT;
+    settings.bind_http = getenv("LAMINAR_BIND_HTTP") ?: INTADDR_HTTP_DEFAULT;
+    settings.archive_url = getenv("LAMINAR_ARCHIVE_URL") ?: ARCHIVE_URL_DEFAULT;
+
+    server = new Server(ioContext);
+    laminar = new Laminar(*server, settings);
+
+    kj::UnixEventPort::captureChildExit();
 
     signal(SIGINT, &laminar_quit);
     signal(SIGTERM, &laminar_quit);
-    laminar->run();
+
+    server->start();
 
     delete laminar;
+    delete server;
 
     LLOG(INFO, "Clean exit");
     return 0;

src/monitorscope.h

@@ -0,0 +1,63 @@
+///
+/// Copyright 2015-2019 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/>
+///
+#ifndef LAMINAR_MONITORSCOPE_H_
+#define LAMINAR_MONITORSCOPE_H_
+
+#include <string>
+
+// Simple struct to define which information a frontend client is interested
+// in, both in initial request phase and real-time updates. It corresponds
+// loosely to frontend URLs
+struct MonitorScope {
+    enum Type {
+        HOME, // home page: recent builds and statistics
+        ALL,  // browse jobs
+        JOB,  // a specific job page
+        RUN,  // a specific run page
+    };
+
+    MonitorScope(Type type = HOME, std::string job = std::string(), uint num = 0) :
+        type(type),
+        job(job),
+        num(num),
+        page(0),
+        field("number"),
+        order_desc(true)
+    {}
+
+    // whether this scope wants status information for the specified job
+    bool wantsStatus(std::string ajob, uint anum = 0) const {
+        if(type == HOME || type == ALL) return true;
+        else return ajob == job;
+        // we could have checked that the run number matches, but actually the
+        // run page needs to know about a non-matching run number in order to
+        // know whether to display the "next" arrow.
+    }
+
+    Type type;
+    std::string job;
+    uint num ;
+    // sorting
+    uint page;
+    std::string field;
+    bool order_desc;
+};
+
+#endif // LAMINAR_MONITORSCOPE_H_
+

src/resources.cpp

@@ -1,5 +1,5 @@
 ///
-/// Copyright 2015-2017 Oliver Giles
+/// Copyright 2015-2019 Oliver Giles
 ///
 /// This file is part of Laminar
 ///
@@ -17,7 +17,10 @@
 /// along with Laminar.  If not, see <http://www.gnu.org/licenses/>
 ///
 #include "resources.h"
+#include "log.h"
+#include "index_html_size.h"
 #include <string.h>
+#include <zlib.h>
 
 #define INIT_RESOURCE(route, name, content_type) \
     extern const char _binary_##name##_z_start[];\
@@ -27,28 +30,64 @@
 #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"
 
+#define GZIP_FORMAT 16
+
 Resources::Resources()
 {
     INIT_RESOURCE("/", index_html, CONTENT_TYPE_HTML);
     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);
     INIT_RESOURCE("/js/vue.min.js", js_vue_min_js, CONTENT_TYPE_JS);
     INIT_RESOURCE("/js/vue-router.min.js", js_vue_router_min_js, CONTENT_TYPE_JS);
     INIT_RESOURCE("/js/ansi_up.js", js_ansi_up_js, CONTENT_TYPE_JS);
     INIT_RESOURCE("/js/Chart.min.js", js_Chart_min_js, CONTENT_TYPE_JS);
-    INIT_RESOURCE("/js/Chart.HorizontalBar.js", js_Chart_HorizontalBar_js, CONTENT_TYPE_JS);
     INIT_RESOURCE("/css/bootstrap.min.css", css_bootstrap_min_css, CONTENT_TYPE_CSS);
+
+    if(const char* baseUrl = getenv("LAMINAR_BASE_URL")) {
+        // The administrator needs to customize the <base href>. Unfortunately this seems
+        // to be the only thing that needs to be customizable but cannot be done via dynamic
+        // DOM manipulation without heavy compromises. So replace the static char array with
+        // a modified buffer accordingly.
+        z_stream strm;
+        memset(&strm, 0, sizeof(z_stream));
+        std::string tmp;
+        tmp.resize(INDEX_HTML_UNCOMPRESSED_SIZE);
+        // inflate
+        inflateInit2(&strm, MAX_WBITS|GZIP_FORMAT);
+        strm.next_in = (unsigned char*) _binary_index_html_z_start;
+        strm.avail_in = _binary_index_html_z_end - _binary_index_html_z_start;
+        strm.next_out = (unsigned char*) tmp.data();
+        strm.avail_out = INDEX_HTML_UNCOMPRESSED_SIZE;
+        if(inflate(&strm, Z_FINISH) != Z_STREAM_END) {
+            LLOG(FATAL, "Failed to uncompress index_html");
+        }
+        // replace
+        // There's no validation on the replacement string, so you can completely mangle
+        // the html if you like. This isn't really an issue because if you can modify laminar's
+        // environment you already have elevated permissions
+        if(auto it = tmp.find("base href=\"/"))
+            tmp.replace(it+11, 1, baseUrl);
+        // deflate
+        index_html.resize(tmp.size());
+        deflateInit2(&strm, Z_DEFAULT_COMPRESSION, Z_DEFLATED, MAX_WBITS|GZIP_FORMAT, 8, Z_DEFAULT_STRATEGY);
+        strm.next_in = (unsigned char*) tmp.data();
+        strm.avail_in = tmp.size();
+        strm.next_out = (unsigned char*) index_html.data();
+        strm.avail_out = tmp.size();
+        if(deflate(&strm, Z_FINISH) != Z_STREAM_END) {
+            LLOG(FATAL, "Failed to compress index.html");
+        }
+        index_html.resize(strm.total_out);
+        // update resource map
+        resources["/"].start = index_html.data();
+        resources["/"].end = index_html.data() + index_html.size();
+    }
 }
 
 inline bool beginsWith(std::string haystack, const char* needle) {

src/resources.h

@@ -1,5 +1,5 @@
 ///
-/// Copyright 2015-2017 Oliver Giles
+/// Copyright 2015-2019 Oliver Giles
 ///
 /// This file is part of Laminar
 ///
@@ -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>
@@ -40,7 +40,8 @@ private:
         const char* end;
         const char* content_type;
     };
-    std::unordered_map<std::string, const Resource> resources;
+    std::unordered_map<std::string, Resource> resources;
+    std::string index_html;
 };
 
-#endif // _LAMINAR_RESOURCES_H_
+#endif // LAMINAR_RESOURCES_H_

src/resources/index.html

@@ -6,15 +6,16 @@
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <meta name="apple-mobile-web-app-capable" content="yes" />
- <link rel="apple-touch-icon-precomposed" href="/favicon-152.png">
+ <link rel="apple-touch-icon-precomposed" href="favicon-152.png">
+ <link rel="icon" href="favicon.ico">
  <title>Laminar</title>
- <script src="/js/vue.min.js"></script>
- <script src="/js/vue-router.min.js"></script>
- <script src="/js/ansi_up.js"></script>
- <script src="/js/Chart.min.js"></script>
- <script src="/js/Chart.HorizontalBar.js"></script>
- <link href="/css/bootstrap.min.css" rel="stylesheet">
- <script src="/js/app.js" defer></script>
+ <script src="js/vue.min.js"></script>
+ <script src="js/vue-router.min.js"></script>
+ <script src="js/ansi_up.js"></script>
+ <script src="js/Chart.min.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%; }
   .navbar { margin-bottom: 0; border-radius: 0; }
@@ -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,68 @@
    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;
+  }
+  /* status icons */
+  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); }
+  }
+  /* chart overlay */
+  li.chart-overlay {
+    position: absolute;
+    display: inline-block;
+    background: white;
+    border: 1px solid lightgray;
+    padding: 3px;
+  }
+  /* sort indicators */
+  a.sort {
+    position: relative;
+    margin-left: 7px;
+  }
+  a.sort:before, a.sort:after {
+    border: 4px solid transparent;
+    content: "";
+    position: absolute;
+    display: block;
+    height: 0;
+    width: 0;
+    right: 0;
+    top: 50%;
+  }
+  a.sort:before {
+    border-bottom-color: #ccc;
+    margin-top: -9px;
+  }
+  a.sort:after {
+    border-top-color: #ccc;
+    margin-top: 1px;
+  }
+  a.sort.dsc:after { border-top-color: #000; }
+  a.sort.asc:before { border-bottom-color: #000; }
+  a.sort:hover { text-decoration: none; cursor:pointer; }
+  a.sort:not(.asc):hover:before { border-bottom-color: #777;  }
+  a.sort:not(.dsc):hover:after { border-top-color: #777;  }
+
  </style>
 </head>
 <body>
@@ -63,7 +129,7 @@
    <div class="col-sm-7 col-md-8 col-lg-9"><div class="row">
     <div class="col-md-6">
      <div class="panel panel-default">
-      <div class="panel-heading">Total builds per day this week</div>
+      <div class="panel-heading">Total runs per day this week</div>
       <div class="panel-body">
        <canvas id="chartBpd"></canvas>
       </div>
@@ -71,15 +137,15 @@
     </div>
     <div class="col-md-6">
      <div class="panel panel-default">
-      <div class="panel-heading">Builds per job in the last 24 hours</div>
+      <div class="panel-heading">Most runs per job in the last 24 hours</div>
       <div class="panel-body" id="chartStatus">
        <canvas id="chartBpj"></canvas>
       </div>
      </div>
-    </div>
+    </div></div><div class="row">
     <div class="col-md-6">
      <div class="panel panel-default">
-      <div class="panel-heading">Average build time per job this week</div>
+      <div class="panel-heading">Longest average run time per job this week</div>
       <div class="panel-body">
        <canvas id="chartTpj"></canvas>
       </div>
@@ -92,6 +158,42 @@
        <canvas id="chartUtil"></canvas>
       </div>
      </div>
+    </div></div><div class="row">
+    <div class="col-md-6">
+     <div class="panel panel-default">
+      <div class="panel-heading">Regressions and recoveries</div>
+      <div class="panel-body"><div style="position:relative">
+       <canvas id="chartResultChanges"></canvas>
+       <ul v-for="job in resultChanged">
+         <li v-if="job.lastFailure>job.lastSuccess" :id="'rcd_'+job.name" class="chart-overlay"><router-link :to="'/jobs/'+job.name">{{job.name}}</router-link>: <span v-html="runIcon('failed')"></span> <router-link :to="'/jobs/'+job.name+'/'+job.lastFailure">#{{job.lastFailure}}</router-link> since <span v-html="runIcon('success')"></span> <router-link :to="'/jobs/'+job.name+'/'+job.lastSuccess">#{{job.lastSuccess}}</router-link></li>
+         <li v-if="job.lastFailure<job.lastSuccess" :id="'rcd_'+job.name" class="chart-overlay"><router-link :to="'/jobs/'+job.name">{{job.name}}</router-link>: <span v-html="runIcon('success')"></span> <router-link :to="'/jobs/'+job.name+'/'+job.lastSuccess">#{{job.lastSuccess}}</router-link> since <span v-html="runIcon('failed')"></span> <router-link :to="'/jobs/'+job.name+'/'+job.lastFailure">#{{job.lastFailure}}</router-link></li>
+       </ul>
+      </div></div>
+     </div>
+    </div>
+    <div class="col-md-6">
+     <div class="panel panel-default">
+      <div class="panel-heading">Low pass rates</div>
+      <div class="panel-body">
+       <canvas id="chartPassRates"></canvas>
+      </div>
+     </div>
+    </div></div><div class="row">
+    <div class="col-md-6">
+     <div class="panel panel-default">
+      <div class="panel-heading">Run time changes</div>
+      <div class="panel-body">
+       <canvas id="chartBuildTimeChanges"></canvas>
+      </div>
+     </div>
+    </div>
+    <div class="col-md-6">
+     <div class="panel panel-default">
+      <div class="panel-heading">Average run time distribution</div>
+      <div class="panel-body">
+       <canvas id="chartBuildTimeDist"></canvas>
+      </div>
+     </div>
     </div>
    </div></div>
   </div></div> 
@@ -105,11 +207,11 @@
      <input class="form-control" id="jobFilter" v-model="search" placeholder="Filter...">
     </div>
     <ul class="nav nav-tabs">
-     <li :class="{'active':tag==null}"><a href v-on:click.prevent="tag = null">All Jobs</a></li>
-     <li v-for="t in tags" :class="{'active':t==tag}"><a href v-on:click.prevent="tag = t">{{t}}</a></li>
+     <li v-show="ungrouped.length" :class="{'active':group==null}"><a href v-on:click.prevent="group = null">Ungrouped Jobs</a></li>
+     <li v-for="g in Object.keys(groups)" :class="{'active':g==group}"><a href v-on:click.prevent="group = g">{{g}}</a></li>
     </ul>
     <table class="table table-striped" id="joblist">
-     <tr   v-for="job in filteredJobs">
+     <tr   v-for="job in filteredJobs()">
       <td><router-link :to="'/jobs/'+job.name">{{job.name}}</router-link></td>
       <td class="text-center"><span v-html="runIcon(job.result)"></span> <router-link :to="'/jobs/'+job.name+'/'+job.number">#{{job.number}}</router-link></td>
       <td class="text-center">{{formatDate(job.started)}}</td>
@@ -143,24 +245,37 @@
     </div>
    </div>
    <div class="row"><div class="col-xs-12">
-    <table class="table table-striped"><thead>
-     <tr><th>Run</th><th class="text-center">Started</th><th class="text-center">Duration</th><th class="text-center hidden-xs">Reason</th></tr></thead>
+    <table class="table table-striped">
+     <thead><tr>
+      <th><a class="sort" :class="(sort.field=='result'?sort.order:'')" v-on:click="do_sort('result')">&nbsp;</a></th>
+      <th>Run <a class="sort" :class="(sort.field=='number'?sort.order:'')" v-on:click="do_sort('number')">&nbsp;</a></th>
+      <th class="text-center">Started <a class="sort" :class="(sort.field=='started'?sort.order:'')" v-on:click="do_sort('started')">&nbsp;</a></th>
+      <th class="text-center">Duration <a class="sort" :class="(sort.field=='duration'?sort.order:'')" v-on:click="do_sort('duration')">&nbsp;</a></th>
+      <th class="text-center hidden-xs">Reason <a class="sort" :class="(sort.field=='reason'?sort.order:'')" v-on:click="do_sort('reason')">&nbsp;</a></th>
+     </tr></thead>
      <tr v-show="nQueued">
-      <td colspan="4"><i>{{nQueued}} run(s) queued</i></td>
+      <td colspan="5"><i>{{nQueued}} run(s) queued</i></td>
      </tr>
      <tr v-for="job in jobsRunning" track-by="$index">
-      <td><span v-html="runIcon(job.result)"></span> <router-link :to="'/jobs/'+$route.params.name+'/'+job.number">#{{job.number}}</router-link></td>
+      <td style="width:1px"><span v-html="runIcon(job.result)"></span></td>
+      <td><router-link :to="'/jobs/'+$route.params.name+'/'+job.number">#{{job.number}}</router-link></td>
       <td class="text-center">{{formatDate(job.started)}}</td>
       <td class="text-center">{{formatDuration(job.started, job.completed)}}</td>
       <td class="text-center hidden-xs">{{job.reason}}</td>
      </tr>
      <tr v-for="job in jobsRecent" track-by="$index">
-      <td><span v-html="runIcon(job.result)"></span> <router-link :to="'/jobs/'+$route.params.name+'/'+job.number">#{{job.number}}</router-link></td>
+      <td style="width:1px"><span v-html="runIcon(job.result)"></span></td>
+      <td><router-link :to="'/jobs/'+$route.params.name+'/'+job.number">#{{job.number}}</router-link></td>
       <td class="text-center">{{formatDate(job.started)}}</td>
       <td class="text-center">{{formatDuration(job.started, job.completed)}}</td>
       <td class="text-center hidden-xs">{{job.reason}}</td>
      </tr>
     </table>
+    <ul class="pagination pull-right">
+      <li><button class="btn btn-default" v-on:click="page_prev" :disabled="sort.page==0">&laquo;</button></li>
+      <li>Page {{sort.page+1}} of {{pages}}</li>
+      <li><button class="btn btn-default" v-on:click="page_next" :disabled="sort.page==pages-1">&raquo;</button></li>
+    </ul>
    </div></div>
   </div>
  </div></template>
@@ -180,6 +295,7 @@
      <div style="clear:both;"></div>
      <dl class="dl-horizontal">
       <dt>Reason</dt><dd>{{job.reason}}</dd>
+      <dt v-show="job.upstream.num > 0">Upstream</dt><dd v-show="job.upstream.num > 0"><router-link :to="'/jobs/'+job.upstream.name">{{job.upstream.name}}</router-link> <router-link :to="'/jobs/'+job.upstream.name+'/'+job.upstream.num">#{{job.upstream.num}}</router-link></li></dd>
       <dt>Queued for</dt><dd>{{job.queued}}s</dd>
       <dt>Started</dt><dd>{{formatDate(job.started)}}</dd>
       <dt v-show="runComplete(job)">Completed</dt><dd v-show="job.completed">{{formatDate(job.completed)}}</dd>
@@ -194,7 +310,7 @@
       <div class="panel-heading">Artifacts</div>
       <div class="panel-body">
        <ul class="list-unstyled" style="margin-bottom: 0">
-        <li v-for="art in job.artifacts"><a :href="art.url" target="_self">{{art.filename}}</a></li>
+        <li v-for="art in job.artifacts"><a :href="art.url" target="_self">{{art.filename}}</a> [{{ art.size | iecFileSize }}]</li>
        </ul>
       </div>
      </div>
@@ -210,14 +326,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

@@ -2,28 +2,55 @@
  * frontend application for Laminar Continuous Integration
  * https://laminar.ohwg.net
  */
-const wsp = function(path) {
-  return new WebSocket((location.protocol === 'https:'?'wss://':'ws://')
-                          + location.host + path);
+
+String.prototype.hashCode = function() {
+  for(var r=0, i=0; i<this.length; i++)
+    r=(r<<5)-r+this.charCodeAt(i),r&=r;
+  return r;
+};
+
+Vue.filter('iecFileSize', function(bytes) {
+  var exp = Math.floor(Math.log(bytes) / Math.log(1024));
+  return (bytes / Math.pow(1024, exp)).toFixed(1) + ' ' +
+    ['B', 'KiB', 'MiB', 'GiB', 'TiB'][exp];
+});
+
+const timeScale = function(max){
+  return max > 3600
+  ? { scale:function(v){return Math.round(v/360)/10}, label:'Hours' }
+  : max > 60
+  ? { scale:function(v){return Math.round(v/60)/10}, label:'Minutes' }
+  : { scale:function(v){return v;}, label:'Seconds' };
 }
-const WebsocketHandler = function() {
-  function setupWebsocket(path, next) {
-    var ws = wsp(path);
-    ws.onmessage = function(msg) {
+const ServerEventHandler = function() {
+  function setupEventSource(path, query, next) {
+    const es = new EventSource(document.head.baseURI + path.substr(1) + query);
+    es.path = path; // save for later in case we need to add query params
+    es.onmessage = function(msg) {
       msg = JSON.parse(msg.data);
-      // "status" is the first message the websocket always delivers.
+      // "status" is the first message the server always delivers.
       // Use this to confirm the navigation. The component is not
       // created until next() is called, so creating a reference
-      // for other message types must be deferred
-      if (msg.type === 'status') {
+      // for other message types must be deferred. There are some extra
+      // subtle checks here. If this eventsource already has a component,
+      // then this is not the first time the status message has been
+      // received. If the frontend requests an update, the status message
+      // should not be handled here, but treated the same as any other
+      // message. An exception is if the connection has been lost - in
+      // that case we should treat this as a "first-time" status message.
+      // this.comp.es is used as a proxy for this.
+      if (msg.type === 'status' && (!this.comp || !this.comp.es)) {
         next(comp => {
           // Set up bidirectional reference
           // 1. needed to reference the component for other msg types
           this.comp = comp;
           // 2. needed to close the ws on navigation away
-          comp.ws = this;
+          comp.es = 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,30 +58,52 @@ 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.connected = true;
+          this.comp.$root.showNotify(msg.type, msg.data);
+          if(typeof this.comp[msg.type] === 'function')
+            this.comp[msg.type](msg.data);
+        }
       }
-    };
-  };
+    }
+    es.onerror = function() {
+      this.comp.$root.connected = false;
+    }
+    return es;
+  }
   return {
     beforeRouteEnter(to, from, next) {
-      setupWebsocket(to.path, (fn) => { next(fn); });
+      setupEventSource(to.path, '', (fn) => { next(fn); });
     },
     beforeRouteUpdate(to, from, next) {
-      this.ws.close();
-      setupWebsocket(to.path, (fn) => { fn(this); next(); });
+      this.es.close();
+      setupEventSource(to.path, '', (fn) => { fn(this); next(); });
     },
     beforeRouteLeave(to, from, next) {
-      this.ws.close();
+      this.es.close();
       next();
     },
+    methods: {
+      query(q) {
+        this.es.close();
+        setupEventSource(this.es.path, '?' + Object.entries(q).map(([k,v])=>`${k}=${v}`).join('&'), (fn) => { fn(this); });
+      }
+    }
   };
 }();
 
 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 +118,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 +134,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) {
@@ -120,20 +169,21 @@ const ProgressUpdater = {
 const Home = function() {
   var state = {
     jobsQueued: [],
-    jobsRecent: []
+    jobsRecent: [],
+    resultChanged: []
   };
 
   var chtUtilization, chtBuildsPerDay, chtBuildsPerJob, chtTimePerJob;
 
   var updateUtilization = function(busy) {
-    chtUtilization.segments[0].value += busy ? 1 : -1;
-    chtUtilization.segments[1].value -= busy ? 1 : -1;
+    chtUtilization.data.datasets[0].data[0] += busy ? 1 : -1;
+    chtUtilization.data.datasets[0].data[1] -= busy ? 1 : -1;
     chtUtilization.update();
   }
 
   return {
     template: '#home',
-    mixins: [WebsocketHandler, Utils, ProgressUpdater],
+    mixins: [ServerEventHandler, Utils, ProgressUpdater],
     data: function() {
       return state;
     },
@@ -142,72 +192,185 @@ const Home = function() {
         state.jobsQueued = msg.queued;
         state.jobsRunning = msg.running;
         state.jobsRecent = msg.recent;
+        state.resultChanged = msg.resultChanged;
         this.$forceUpdate();
 
         // setup charts
-        chtUtilization = new Chart(document.getElementById("chartUtil").getContext("2d")).Pie(
-          [{
-              value: msg.executorsBusy,
-              color: "tan",
-              label: "Busy"
-            },
-            {
-              value: msg.executorsTotal - msg.executorsBusy,
-              color: "darkseagreen",
-              label: "Idle"
-            }
-          ], {
-            animationEasing: 'easeInOutQuad'
+        chtUtilization = new Chart(document.getElementById("chartUtil"), {
+          type: 'pie',
+          data: {
+            labels: ["Busy", "Idle"],
+            datasets: [{
+              data: [ msg.executorsBusy, msg.executorsTotal - msg.executorsBusy ],
+              backgroundColor: ["darkgoldenrod", "forestgreen"]
+            }]
+          }
+        });
+        var buildsPerDayDates = function(){
+          res = [];
+          var now = new Date();
+          for (var i = 6; i >= 0; --i) {
+            var then = new Date(now.getTime() - i * 86400000);
+            res.push({
+              short: ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"][then.getDay()],
+              long: then.toLocaleDateString()}
+            );
+          }
+          return res;
+        }();
+        chtBuildsPerDay = new Chart(document.getElementById("chartBpd"), {
+          type: 'line',
+          data: {
+            labels: buildsPerDayDates.map((e)=>{ return e.short; }),
+            datasets: [{
+              label: 'Successful Builds',
+              backgroundColor: "rgba(34,139,34,0.65)", //forestgreen at 0.65
+              borderColor: "forestgreen",
+              data: msg.buildsPerDay.map((e)=>{ return e.success || 0; })
+            }, {
+              label: 'Failed Builds',
+              backgroundColor: "rgba(178,34,34,0.65)", //firebrick at 0.65
+              borderColor: "firebrick",
+              data: msg.buildsPerDay.map((e)=>{ return e.failed || 0; })
+            }]
+          },
+          options:{
+            tooltips:{callbacks:{title: function(tip, data) {
+              return buildsPerDayDates[tip[0].index].long;
+            }}},
+            scales:{yAxes:[{ticks:{userCallback: (label, index, labels)=>{
+              if(Number.isInteger(label))
+                return label;
+            }}}]}
+          }
+        });
+        chtBuildsPerJob = new Chart(document.getElementById("chartBpj"), {
+          type: 'horizontalBar',
+          data: {
+            labels: Object.keys(msg.buildsPerJob),
+            datasets: [{
+              label: 'Runs in last 24 hours',
+              backgroundColor: "steelblue",
+              data: Object.keys(msg.buildsPerJob).map((e)=>{ return msg.buildsPerJob[e]; })
+            }]
+          },
+          options:{
+            scales:{xAxes:[{ticks:{userCallback: (label, index, labels)=>{
+              if(Number.isInteger(label))
+                return label;
+            }}}]}
+          }
+        });
+        var tpjScale = timeScale(Math.max(Object.values(msg.timePerJob)));
+        chtTimePerJob = new Chart(document.getElementById("chartTpj"), {
+          type: 'horizontalBar',
+          data: {
+            labels: Object.keys(msg.timePerJob),
+            datasets: [{
+              label: 'Mean run time this week',
+              backgroundColor: "steelblue",
+              data: Object.keys(msg.timePerJob).map((e)=>{ return msg.timePerJob[e]; })
+            }]
+          },
+          options:{
+            scales:{xAxes:[{
+              ticks:{userCallback: tpjScale.scale},
+              scaleLabel: {
+                display: true,
+                labelString: tpjScale.label
+              }
+            }]},
+            tooltips:{callbacks:{label:(tip, data)=>{
+              return data.datasets[tip.datasetIndex].label + ': ' + tip.xLabel + ' ' + tpjScale.label.toLowerCase();
+            }}}
+          }
+        });
+        var chtResultChanges = new Chart(document.getElementById("chartResultChanges"), {
+          type: 'horizontalBar',
+          data: {
+            labels: msg.resultChanged.map((e)=>{ return e.name; }),
+            datasets: [{
+              //label: '% Passed',
+              backgroundColor: msg.resultChanged.map((e)=>{return e.lastFailure > e.lastSuccess ? 'firebrick' : 'forestgreen';}),
+              data: msg.resultChanged.map((e)=>{ return e.lastSuccess - e.lastFailure; }),
+              itemid: msg.resultChanged.map((e)=> { return 'rcd_' + e.name; })
+            }]
+          },
+          options:{
+            scales:{
+              xAxes:[{ticks:{display: false}}],
+              yAxes:[{ticks:{display: false}}]
+            },
+            tooltips:{
+              enabled:false
+            }
+          }
+        });
+        var chtPassRates = new Chart(document.getElementById("chartPassRates"), {
+          type: 'horizontalBar',
+          data: {
+            labels: msg.lowPassRates.map((e)=>{ return e.name }),
+            datasets: [{
+              stack: 'passrate',
+              label: '% Passed',
+              backgroundColor: "forestgreen",
+              data: msg.lowPassRates.map((e)=>{ return e.passRate*100; })
+            },{
+              stack:'passrate',
+              label: '% Failed',
+              backgroundColor: "firebrick",
+              data: msg.lowPassRates.map((e)=>{ return (1-e.passRate)*100; })
+            }],
+          },
+          options:{
+            scales:{xAxes:[{ticks:{callback:(val,idx,values)=>{
+              return val + '%';
+            }}}]},
+            tooltips:{
+              enabled:false
+            }
+          }
+        });
+        var btcScale = timeScale(Math.max(msg.buildTimeChanges.map((e)=>{return Math.max(e.durations)})));
+        var chtBuildTimeChanges = new Chart(document.getElementById("chartBuildTimeChanges"), {
+          type: 'line',
+          data: {
+            labels: [...Array(10).keys()],
+            datasets: msg.buildTimeChanges.map((e)=>{return {
+              label: e.name,
+              data: e.durations,
+              borderColor: 'hsl('+(e.name.hashCode() % 360)+', 61%, 34%)',
+              backgroundColor: 'transparent'
+            }})
+          },
+          options:{
+            legend:{display:true},
+            scales:{
+              xAxes:[{ticks:{display: false}}],
+              yAxes:[{
+                ticks:{userCallback: btcScale.scale},
+                scaleLabel: {
+                  display: true,
+                  labelString: btcScale.label
+                }
+              }]
+            },
+            tooltips:{
+              enabled:false
+            }
+          }
+        });
+        var chtBuildTimeDist = new Chart(document.getElementById("chartBuildTimeDist"), {
+          type: 'line',
+          data: {
+            labels: ['<30s','30s-1m','1m-5m','5m-10m','10m-20m','20m-40m','40m-60m','>60m'],
+            datasets: [{
+              label: 'Number jobs with average build time in range',
+              data: msg.buildTimeDist,
+              backgroundColor: "steelblue",
+            }]
           }
-        );
-        chtBuildsPerDay = new Chart(document.getElementById("chartBpd").getContext("2d")).Line({
-          labels: function() {
-            res = [];
-            var now = new Date();
-            for (var i = 6; i >= 0; --i) {
-              var then = new Date(now.getTime() - i * 86400000);
-              res.push(["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"][then.getDay()]);
-            }
-            return res;
-          }(),
-          datasets: [{
-            label: "Successful Builds",
-            fillColor: "rgba(143,188,143,0.65)", //darkseagreen at 0.65
-            strokeColor: "forestgreen",
-            data: msg.buildsPerDay.map(function(e) {
-              return e.success || 0;
-            })
-          }, {
-            label: "Failed Bulids",
-            fillColor: "rgba(233,150,122,0.65)", //darksalmon at 0.65
-            strokeColor: "crimson",
-            data: msg.buildsPerDay.map(function(e) {
-              return e.failed || 0;
-            })
-          }]
-        }, {
-          showTooltips: false
         });
-        chtBuildsPerJob = new Chart(document.getElementById("chartBpj").getContext("2d")).HorizontalBar({
-          labels: Object.keys(msg.buildsPerJob),
-          datasets: [{
-            fillColor: "lightsteelblue",
-            data: Object.keys(msg.buildsPerJob).map(function(e) {
-              return msg.buildsPerJob[e];
-            })
-          }]
-        }, {});
-        chtTimePerJob = new Chart(document.getElementById("chartTpj").getContext("2d")).HorizontalBar({
-          labels: Object.keys(msg.timePerJob),
-          datasets: [{
-            fillColor: "lightsteelblue",
-            data: Object.keys(msg.timePerJob).map(function(e) {
-              return msg.timePerJob[e];
-            })
-          }]
-        }, {});
-
-
       },
       job_queued: function(data) {
         state.jobsQueued.splice(0, 0, data);
@@ -221,9 +384,9 @@ const Home = function() {
       },
       job_completed: function(data) {
         if (data.result === "success")
-          chtBuildsPerDay.datasets[0].points[6].value++;
+          chtBuildsPerDay.data.datasets[0].data[6]++;
         else
-          chtBuildsPerDay.datasets[1].points[6].value++;
+          chtBuildsPerDay.data.datasets[1].data[6]++;
         chtBuildsPerDay.update();
 
         for (var i = 0; i < state.jobsRunning.length; ++i) {
@@ -236,9 +399,9 @@ const Home = function() {
           }
         }
         updateUtilization(false);
-        for (var j = 0; j < chtBuildsPerJob.datasets[0].bars.length; ++j) {
-          if (chtBuildsPerJob.datasets[0].bars[j].label == job.name) {
-            chtBuildsPerJob.datasets[0].bars[j].value++;
+        for (var j = 0; j < chtBuildsPerJob.data.datasets[0].data.length; ++j) {
+          if (chtBuildsPerJob.data.labels[j] == job.name) {
+            chtBuildsPerJob.data.datasets[0].data[j]++;
             chtBuildsPerJob.update();
             break;
           }
@@ -252,31 +415,14 @@ const Jobs = function() {
   var state = {
     jobs: [],
     search: '',
-    tags: [],
-    tag: null
+    groups: {},
+    group: null,
+    ungrouped: []
   };
   return {
     template: '#jobs',
-    mixins: [WebsocketHandler, Utils, ProgressUpdater],
+    mixins: [ServerEventHandler, Utils, ProgressUpdater],
     data: function() { return state; },
-    computed: {
-      filteredJobs() {
-        var ret = this.jobs;
-        var tag = this.tag;
-        if (tag) {
-          ret = ret.filter(function(job) {
-            return job.tags.indexOf(tag) >= 0;
-          });
-        }
-        var search = this.search;
-        if (search) {
-          ret = ret.filter(function(job) {
-            return job.name.indexOf(search) > -1;
-          });
-        }
-        return ret;
-      }
-    },
     methods: {
       status: function(msg) {
         state.jobs = msg.jobs;
@@ -292,16 +438,14 @@ const Jobs = function() {
             state.jobs.sort(function(a, b){return a.name < b.name ? -1 : a.name > b.name ? 1 : 0;});
           }
         }
-        var tags = {};
-        for (var i in state.jobs) {
-          for (var j in state.jobs[i].tags) {
-            tags[state.jobs[i].tags[j]] = true;
-          }
-        }
-        state.tags = Object.keys(tags);
+        state.groups = {};
+        Object.keys(msg.groups).map(k => state.groups[k] = new RegExp(msg.groups[k]));
+        state.ungrouped = state.jobs.filter(j => !Object.values(state.groups).some(r => r.test(j.name))).map(j => j.name);
+        state.group = state.ungrouped.length ? null : Object.keys(state.groups)[0];
       },
       job_started: function(data) {
         var updAt = null;
+        // jobsRunning must be maintained for ProgressUpdater
         for (var i in state.jobsRunning) {
           if (state.jobsRunning[i].name === data.name) {
             updAt = i;
@@ -324,6 +468,8 @@ const Jobs = function() {
           // first execution of new job. TODO insert without resort
           state.jobs.unshift(data);
           state.jobs.sort(function(a, b){return a.name < b.name ? -1 : a.name > b.name ? 1 : 0;});
+          if(!Object.values(state.groups).some(r => r.test(data.name)))
+              state.ungrouped.push(data.name);
         } else {
           state.jobs[updAt] = data;
         }
@@ -344,7 +490,17 @@ const Jobs = function() {
             break;
           }
         }
-      }
+      },
+      filteredJobs: function() {
+        let ret = [];
+        if (state.group)
+          ret = state.jobs.filter(job => state.groups[state.group].test(job.name));
+        else
+          ret = state.jobs.filter(job => state.ungrouped.includes(job.name));
+        if (this.search)
+          ret = ret.filter(job => job.name.indexOf(this.search) > -1);
+        return ret;
+      },
     }
   };
 }();
@@ -356,10 +512,13 @@ var Job = function() {
     lastSuccess: null,
     lastFailed: null,
     nQueued: 0,
+    pages: 0,
+    sort: {}
   };
+  var chtBt = null;
   return Vue.extend({
     template: '#job',
-    mixins: [WebsocketHandler, Utils, ProgressUpdater],
+    mixins: [ServerEventHandler, Utils, ProgressUpdater],
     data: function() {
       return state;
     },
@@ -370,32 +529,70 @@ var Job = function() {
         state.lastSuccess = msg.lastSuccess;
         state.lastFailed = msg.lastFailed;
         state.nQueued = msg.nQueued;
+        state.pages = msg.pages;
+        state.sort = msg.sort;
 
-        var chtBt = new Chart(document.getElementById("chartBt").getContext("2d")).Bar({
-          labels: msg.recent.map(function(e) {
-            return '#' + e.number;
-          }).reverse(),
-          datasets: [{
-            fillColor: "darkseagreen",
-            strokeColor: "forestgreen",
-            data: msg.recent.map(function(e) {
-              return e.completed - e.started;
-            }).reverse()
-          }]
-        }, {
-          barValueSpacing: 1,
-          barStrokeWidth: 1,
-          barDatasetSpacing: 0
+        // "status" comes again if we change page/sorting. Delete the
+        // old chart and recreate it to prevent flickering of old data
+        if(chtBt)
+          chtBt.destroy();
+        var btScale = timeScale(Math.max(msg.recent.map(v=>{v.completed-v.started})));
+        chtBt = new Chart(document.getElementById("chartBt"), {
+          type: 'bar',
+          data: {
+            labels: msg.recent.map(function(e) {
+              return '#' + e.number;
+            }).reverse(),
+            datasets: [{
+              label: 'Average',
+              type: 'line',
+              data: [{x:0,y:msg.averageRuntime},{x:1,y:msg.averageRuntime}],
+              borderColor: 'steelblue',
+              backgroundColor: 'transparent',
+              xAxisID: 'avg',
+              pointRadius: 0,
+              pointHitRadius: 0,
+              pointHoverRadius: 0,
+            },{
+              label: 'Build time',
+              backgroundColor: (new Array(msg.recent.length)).fill('darkseagreen'),
+              borderColor: (new Array(msg.recent.length)).fill('forestgreen'),
+              data: msg.recent.map(function(e) {
+                return e.completed - e.started;
+              }).reverse()
+            }]
+          },
+          options: {
+            scales:{
+              xAxes:[{},{
+                id: 'avg',
+                type: 'linear',
+                ticks: {
+                  display: false
+                },
+                gridLines: {
+                  display: false,
+                  drawBorder: false
+                }
+              }],
+              yAxes:[{
+                ticks:{userCallback: btScale.scale},
+                scaleLabel:{display: true, labelString: btScale.label}
+              }]
+            },
+            tooltips:{callbacks:{label:(tip, data)=>{
+              return data.datasets[tip.datasetIndex].label + ': ' + tip.yLabel + ' ' + btScale.label.toLowerCase();
+            }}}
+          }
         });
 
         for (var i = 0, n = msg.recent.length; i < n; ++i) {
           if (msg.recent[i].result != "success") {
-            chtBt.datasets[0].bars[n - i - 1].fillColor = "darksalmon";
-            chtBt.datasets[0].bars[n - i - 1].strokeColor = "crimson";
+            chtBt.data.datasets[0].backgroundColor[n - i - 1] = "darksalmon";
+            chtBt.data.datasets[0].borderColor[n - i - 1] = "crimson";
           }
         }
         chtBt.update();
-
       },
       job_queued: function() {
         state.nQueued++;
@@ -416,39 +613,80 @@ var Job = function() {
             break;
           }
         }
+      },
+      page_next: function() {
+        state.sort.page++;
+        this.query(state.sort)
+      },
+      page_prev: function() {
+        state.sort.page--;
+        this.query(state.sort)
+      },
+      do_sort: function(field) {
+        if(state.sort.field == field) {
+          state.sort.order = state.sort.order == 'asc' ? 'dsc' : 'asc';
+        } else {
+          state.sort.order = 'dsc';
+          state.sort.field = field;
+        }
+        this.query(state.sort)
       }
     }
   });
 }();
 
 const Run = function() {
+  const utf8decoder = new TextDecoder('utf-8');
   var state = {
-    job: { artifacts: [] },
+    job: { artifacts: [], upstream: {} },
     latestNum: null,
     log: '',
     autoscroll: false
   };
   var firstLog = false;
-  var logHandler = function(vm, d) {
-    state.log += d;
-    vm.$forceUpdate();
-    if (!firstLog) {
-      firstLog = true;
-    } else if (state.autoscroll) {
-      window.scrollTo(0, document.body.scrollHeight);
-    }
-  };
+  const logFetcher = (vm, name, num) => {
+    const abort = new AbortController();
+    fetch('log/'+name+'/'+num, {signal:abort.signal}).then(res => {
+      // ATOW pipeThrough not supported in Firefox
+      //const reader = res.body.pipeThrough(new TextDecoderStream).getReader();
+      const reader = res.body.getReader();
+      let total = 0;
+      return function pump() {
+        return reader.read().then(({done, value}) => {
+          value = utf8decoder.decode(value);
+          if (done)
+            return;
+          state.log += ansi_up.ansi_to_html(value.replace(/</g,'&lt;').replace(/>/g,'&gt;').replace(/\033\[\{([^:]+):(\d+)\033\\/g, (m,$1,$2)=>{return '<a href="jobs/'+$1+'" onclick="return vroute(this);">'+$1+'</a>:<a href="jobs/'+$1+'/'+$2+'" onclick="return vroute(this);">#'+$2+'</a>';}));
+          vm.$forceUpdate();
+          if (!firstLog) {
+            firstLog = true;
+          } else if (state.autoscroll) {
+            window.scrollTo(0, document.body.scrollHeight);
+          }
+          return pump();
+        });
+      }();
+    }).catch(e => {});
+    return abort;
+  }
 
   return {
     template: '#run',
-    mixins: [WebsocketHandler, Utils, ProgressUpdater],
+    mixins: [ServerEventHandler, Utils, ProgressUpdater],
     data: function() {
       return state;
     },
     methods: {
       status: function(data) {
+        // Check for the /latest endpoint. An intuitive check might be
+        //  if(this.$route.params.number == 'latest'), but unfortunately
+        // after calling $router.replace, we re-enter status() before
+        // $route.params is updated. Instead, assume that if there is
+        // no 'started' field, we should redirect to the latest number
+        if(!('started' in data) && 'latestNum' in data)
+          return this.$router.replace('/jobs/' + this.$route.params.name + '/' + data.latestNum);
+
         state.jobsRunning = [];
-        state.log = '';
         state.job = data;
         state.latestNum = data.latestNum;
         state.jobsRunning = [data];
@@ -458,7 +696,7 @@ const Run = function() {
         this.$forceUpdate();
       },
       job_completed: function(data) {
-        state.job = data;
+        state.job = Object.assign(state.job, data);
         state.jobsRunning = [];
         this.$forceUpdate();
       },
@@ -468,35 +706,78 @@ const Run = function() {
     },
     beforeRouteEnter(to, from, next) {
       next(vm => {
-        vm.logws = wsp(to.path + '/log');
-        vm.logws.onmessage = function(msg) {
-          logHandler(vm, msg.data);
-        }
+        state.log = '';
+        vm.logstream = logFetcher(vm, to.params.name, to.params.number);
       });
     },
     beforeRouteUpdate(to, from, next) {
       var vm = this;
-      vm.logws.close();
-      vm.logws = wsp(to.path + '/log');
-      vm.logws.onmessage = function(msg) {
-        logHandler(vm, msg.data);
-      }
+      vm.logstream.abort();
+      state.log = '';
+      vm.logstream = logFetcher(vm, to.params.name, to.params.number);
       next();
     },
     beforeRouteLeave(to, from, next) {
-      this.logws.close();
+      this.logstream.abort();
       next();
     }
   };
 }();
 
+// For all charts, set miniumum Y to 0
+Chart.scaleService.updateScaleDefaults('linear', {
+    ticks: { suggestedMin: 0 }
+});
+// Don't display legend by default
+Chart.defaults.global.legend.display = false;
+// Plugin to move a DOM item on top of a chart element
+Chart.plugins.register({
+  afterDatasetsDraw: (chart) => {
+    chart.data.datasets.forEach((dataset, i) => {
+      var meta = chart.getDatasetMeta(i);
+      if(dataset.itemid)
+        meta.data.forEach((e,j) => {
+          var pos = e.getCenterPoint();
+          var node = document.getElementById(dataset.itemid[j]);
+          node.style.top = (pos.y - node.clientHeight/2) + 'px';
+        });
+    });
+  }
+});
+
 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',
+    base: document.head.baseURI.substr(location.origin.length),
     routes: [
       { path: '/',                   component: Home },
       { path: '/jobs',               component: Jobs },

src/rpc.cpp

@@ -0,0 +1,191 @@
+///
+/// Copyright 2015-2019 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 "rpc.h"
+#include "laminar.capnp.h"
+#include "laminar.h"
+#include "log.h"
+
+namespace {
+
+// Used for returning run state to RPC clients
+LaminarCi::JobResult fromRunState(RunState state) {
+    switch(state) {
+    case RunState::SUCCESS: return LaminarCi::JobResult::SUCCESS;
+    case RunState::FAILED:  return LaminarCi::JobResult::FAILED;
+    case RunState::ABORTED: return LaminarCi::JobResult::ABORTED;
+    default:
+        return LaminarCi::JobResult::UNKNOWN;
+    }
+}
+
+}
+// This is the implementation of the Laminar Cap'n Proto RPC interface.
+// As such, it implements the pure virtual interface generated from
+// laminar.capnp with calls to the primary Laminar class
+class RpcImpl : public LaminarCi::Server {
+public:
+    RpcImpl(Laminar& l) :
+        LaminarCi::Server(),
+        laminar(l)
+    {
+    }
+
+    virtual ~RpcImpl() {
+    }
+
+    // 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 queue", jobName);
+        LaminarCi::MethodResult result = laminar.queueJob(jobName, params(context.getParams().getParams()))
+                ? LaminarCi::MethodResult::SUCCESS
+                : LaminarCi::MethodResult::FAILED;
+        context.getResults().setResult(result);
+        return kj::READY_NOW;
+    }
+
+    // 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);
+        std::shared_ptr<Run> run = laminar.queueJob(jobName, params(context.getParams().getParams()));
+        if(Run* r = run.get()) {
+            return r->whenStarted().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);
+        std::shared_ptr<Run> run = laminar.queueJob(jobName, params(context.getParams().getParams()));
+        if(Run* r = run.get()) {
+            return r->whenFinished().then([context,r](RunState state) mutable {
+                context.getResults().setResult(fromRunState(state));
+                context.getResults().setBuildNum(r->build);
+            });
+        } else {
+            context.getResults().setResult(LaminarCi::JobResult::UNKNOWN);
+            return kj::READY_NOW;
+        }
+    }
+
+    // Set a parameter on a running build
+    kj::Promise<void> set(SetContext context) override {
+        std::string jobName = context.getParams().getRun().getJob();
+        uint buildNum = context.getParams().getRun().getBuildNum();
+        LLOG(INFO, "RPC set", jobName, buildNum);
+
+        LaminarCi::MethodResult result = laminar.setParam(jobName, buildNum,
+            context.getParams().getParam().getName(), context.getParams().getParam().getValue())
+                ? LaminarCi::MethodResult::SUCCESS
+                : LaminarCi::MethodResult::FAILED;
+        context.getResults().setResult(result);
+        return kj::READY_NOW;
+    }
+
+    // List jobs in queue
+    kj::Promise<void> listQueued(ListQueuedContext context) override {
+        const std::list<std::shared_ptr<Run>>& queue = laminar.listQueuedJobs();
+        auto res = context.getResults().initResult(queue.size());
+        int i = 0;
+        for(auto it : queue) {
+            res.set(i++, it->name);
+        }
+        return kj::READY_NOW;
+    }
+
+    // List running jobs
+    kj::Promise<void> listRunning(ListRunningContext context) override {
+        const RunSet& active = laminar.listRunningJobs();
+        auto res = context.getResults().initResult(active.size());
+        int i = 0;
+        for(auto it : active) {
+            res[i].setJob(it->name);
+            res[i].setBuildNum(it->build);
+            i++;
+        }
+        return kj::READY_NOW;
+    }
+
+    // List known jobs
+    kj::Promise<void> listKnown(ListKnownContext context) override {
+        std::list<std::string> known = laminar.listKnownJobs();
+        auto res = context.getResults().initResult(known.size());
+        int i = 0;
+        for(auto it : known) {
+            res.set(i++, it);
+        }
+        return kj::READY_NOW;
+    }
+
+    kj::Promise<void> abort(AbortContext context) override {
+        std::string jobName = context.getParams().getRun().getJob();
+        uint buildNum = context.getParams().getRun().getBuildNum();
+        LLOG(INFO, "RPC abort", jobName, buildNum);
+        LaminarCi::MethodResult result = laminar.abort(jobName, buildNum)
+                ? LaminarCi::MethodResult::SUCCESS
+                : LaminarCi::MethodResult::FAILED;
+        context.getResults().setResult(result);
+        return kj::READY_NOW;
+    }
+
+private:
+    // Helper to convert an RPC parameter list to a hash map
+    ParamMap params(const capnp::List<LaminarCi::JobParam>::Reader& paramReader) {
+        ParamMap res;
+        for(auto p : paramReader) {
+            res[p.getName().cStr()] = p.getValue().cStr();
+        }
+        return res;
+    }
+
+    Laminar& laminar;
+    std::unordered_map<const Run*, std::list<kj::PromiseFulfillerPair<RunState>>> runWaiters;
+};
+
+Rpc::Rpc(Laminar& li) :
+    rpcInterface(kj::heap<RpcImpl>(li))
+{}
+
+// Context for an RPC connection
+struct RpcConnection {
+    RpcConnection(kj::Own<kj::AsyncIoStream>&& stream,
+                  capnp::Capability::Client bootstrap,
+                  capnp::ReaderOptions readerOpts) :
+        stream(kj::mv(stream)),
+        network(*this->stream, capnp::rpc::twoparty::Side::SERVER, readerOpts),
+        rpcSystem(capnp::makeRpcServer(network, bootstrap))
+    {
+    }
+    kj::Own<kj::AsyncIoStream> stream;
+    capnp::TwoPartyVatNetwork network;
+    capnp::RpcSystem<capnp::rpc::twoparty::VatId> rpcSystem;
+};
+
+kj::Promise<void> Rpc::accept(kj::Own<kj::AsyncIoStream>&& connection) {
+    auto server = kj::heap<RpcConnection>(kj::mv(connection), rpcInterface, capnp::ReaderOptions());
+    return server->network.onDisconnect().attach(kj::mv(server));
+}

src/rpc.h

@@ -1,5 +1,5 @@
 ///
-/// Copyright 2015 Oliver Giles
+/// Copyright 2019 Oliver Giles
 ///
 /// This file is part of Laminar
 ///
@@ -16,28 +16,21 @@
 /// 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_RPC_H_
+#define LAMINAR_RPC_H_
 
-#include <string>
-#include <set>
+#include <capnp/ez-rpc.h>
+#include <capnp/rpc-twoparty.h>
+#include <capnp/rpc.capnp.h>
 
-class Run;
+struct Laminar;
 
-// Represents a group of executors. Currently almost unnecessary POD
-// abstraction, but may be enhanced in the future to support e.g. tags
-class Node {
+class Rpc {
 public:
-    Node() {}
+    Rpc(Laminar&li);
+    kj::Promise<void> accept(kj::Own<kj::AsyncIoStream>&& connection);
 
-    std::string name;
-    int numExecutors;
-    int busyExecutors = 0;
-    std::set<std::string> tags;
-
-    // Attempts to queue the given run to this node. Returns true if succeeded.
-    bool queue(const Run& run);
+    capnp::Capability::Client rpcInterface;
 };
 
-
-#endif // _LAMINAR_NODE_H_
+#endif //LAMINAR_RPC_H_

src/run.cpp

@@ -1,5 +1,5 @@
 ///
-/// Copyright 2015-2017 Oliver Giles
+/// Copyright 2015-2018 Oliver Giles
 ///
 /// This file is part of Laminar
 ///
@@ -17,7 +17,7 @@
 /// along with Laminar.  If not, see <http://www.gnu.org/licenses/>
 ///
 #include "run.h"
-#include "node.h"
+#include "context.h"
 #include "conf.h"
 #include "log.h"
 
@@ -25,8 +25,11 @@
 #include <unistd.h>
 #include <signal.h>
 
-#include <boost/filesystem.hpp>
-namespace fs = boost::filesystem;
+// short syntax helper for kj::Path
+template<typename T>
+inline kj::Path operator/(const kj::Path& p, const T& ext) {
+    return p.append(ext);
+}
 
 std::string to_string(const RunState& rs) {
     switch(rs) {
@@ -35,109 +38,223 @@ 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";
     }
 }
 
 
-Run::Run() {
-    result = RunState::SUCCESS;
-    lastResult = RunState::UNKNOWN;
+Run::Run(std::string name, ParamMap pm, kj::Path&& rootPath) :
+    result(RunState::SUCCESS),
+    lastResult(RunState::UNKNOWN),
+    name(name),
+    params(kj::mv(pm)),
+    queuedAt(time(nullptr)),
+    rootPath(kj::mv(rootPath)),
+    started(kj::newPromiseAndFulfiller<void>()),
+    finished(kj::newPromiseAndFulfiller<RunState>())
+{
+    for(auto it = params.begin(); it != params.end();) {
+        if(it->first[0] == '=') {
+            if(it->first == "=parentJob") {
+                parentName = it->second;
+            } else if(it->first == "=parentBuild") {
+                parentBuild = atoi(it->second.c_str());
+            } else if(it->first == "=reason") {
+                reasonMsg = it->second;
+            } else {
+                LLOG(ERROR, "Unknown internal job parameter", it->first);
+            }
+            it = params.erase(it);
+        } else
+            ++it;
+    }
 }
 
 Run::~Run() {
     LLOG(INFO, "Run destroyed");
 }
 
-std::string Run::reason() const {
-    if(!parentName.empty()) {
-        return std::string("Triggered by upstream ") + parentName + " #" + std::to_string(parentBuild);
+bool Run::configure(uint buildNum, std::shared_ptr<Context> nd, const kj::Directory& fsHome)
+{
+    kj::Path cfgDir{"cfg"};
+
+    // create the run directory
+    kj::Path rd{"run",name,std::to_string(buildNum)};
+    bool createWorkdir = true;
+    KJ_IF_MAYBE(ls, fsHome.tryLstat(rd)) {
+        LASSERT(ls->type == kj::FsNode::Type::DIRECTORY);
+        LLOG(WARNING, "Working directory already exists, removing", rd.toString());
+        if(fsHome.tryRemove(rd) == false) {
+            LLOG(WARNING, "Failed to remove working directory");
+            createWorkdir = false;
+        }
     }
+    if(createWorkdir && fsHome.tryOpenSubdir(rd, kj::WriteMode::CREATE|kj::WriteMode::CREATE_PARENT) == nullptr) {
+        LLOG(ERROR, "Could not create working directory", rd.toString());
+        return false;
+    }
+
+    // create an archive directory
+    kj::Path archive = kj::Path{"archive",name,std::to_string(buildNum)};
+    if(fsHome.exists(archive)) {
+        LLOG(WARNING, "Archive directory already exists", archive.toString());
+    } else if(fsHome.tryOpenSubdir(archive, kj::WriteMode::CREATE|kj::WriteMode::CREATE_PARENT) == nullptr) {
+        LLOG(ERROR, "Could not create archive directory", archive.toString());
+        return false;
+    }
+
+    // create a workspace for this job if it doesn't exist
+    kj::Path ws{"run",name,"workspace"};
+    if(!fsHome.exists(ws)) {
+        fsHome.openSubdir(ws, kj::WriteMode::CREATE|kj::WriteMode::CREATE_PARENT);
+        // prepend the workspace init script
+        if(fsHome.exists(cfgDir/"jobs"/(name+".init")))
+            addScript(cfgDir/"jobs"/(name+".init"), kj::mv(ws));
+    }
+
+    // add scripts
+    // global before-run script
+    if(fsHome.exists(cfgDir/"before"))
+        addScript(cfgDir/"before", rd.clone());
+    // job before-run script
+    if(fsHome.exists(cfgDir/"jobs"/(name+".before")))
+        addScript(cfgDir/"jobs"/(name+".before"), rd.clone());
+    // main run script. must exist.
+    addScript(cfgDir/"jobs"/(name+".run"), rd.clone());
+    // job after-run script
+    if(fsHome.exists(cfgDir/"jobs"/(name+".after")))
+        addScript(cfgDir/"jobs"/(name+".after"), rd.clone(), true);
+    // global after-run script
+    if(fsHome.exists(cfgDir/"after"))
+        addScript(cfgDir/"after", rd.clone(), true);
+
+    // add environment files
+    if(fsHome.exists(cfgDir/"env"))
+        addEnv(cfgDir/"env");
+    if(fsHome.exists(cfgDir/"contexts"/(nd->name+".env")))
+        addEnv(cfgDir/"contexts"/(nd->name+".env"));
+    if(fsHome.exists(cfgDir/"jobs"/(name+".env")))
+        addEnv(cfgDir/"jobs"/(name+".env"));
+
+    // add job timeout if specified
+    if(fsHome.exists(cfgDir/"jobs"/(name+".conf"))) {
+        timeout = parseConfFile((rootPath/cfgDir/"jobs"/(name+".conf")).toString(true).cStr()).get<int>("TIMEOUT", 0);
+    }
+
+    // All good, we've "started"
+    startedAt = time(nullptr);
+    build = buildNum;
+    context = nd;
+
+    // notifies the rpc client if the start command was used
+    started.fulfiller->fulfill();
+
+    return true;
+}
+
+std::string Run::reason() const {
     return reasonMsg;
 }
 
 bool Run::step() {
-    if(!currentScript.path.empty() && procStatus != 0)
-        result = RunState::FAILED;
+    if(!scripts.size())
+        return true;
 
-    if(scripts.size()) {
-        currentScript = scripts.front();
-        scripts.pop();
+    Script currentScript = kj::mv(scripts.front());
+    scripts.pop();
 
-        int pfd[2];
-        pipe(pfd);
-        pid_t pid = fork();
-        if(pid == 0) { // child
-            // reset signal mask (SIGCHLD blocked in Laminar::start)
-            sigset_t mask;
-            sigemptyset(&mask);
-            sigaddset(&mask, SIGCHLD);
-            sigprocmask(SIG_UNBLOCK, &mask, NULL);
+    int pfd[2];
+    pipe(pfd);
+    pid_t pid = fork();
+    if(pid == 0) { // child
+        // reset signal mask (SIGCHLD blocked in Laminar::start)
+        sigset_t mask;
+        sigemptyset(&mask);
+        sigaddset(&mask, SIGCHLD);
+        sigprocmask(SIG_UNBLOCK, &mask, nullptr);
 
-            close(pfd[0]);
-            dup2(pfd[1], 1);
-            dup2(pfd[1], 2);
-            close(pfd[1]);
-            std::string buildNum = std::to_string(build);
+        // set pgid == pid for easy killing on abort
+        setpgid(0, 0);
 
-            std::string PATH = (fs::path(laminarHome)/"cfg"/"scripts").string() + ":";
-            if(const char* p = getenv("PATH")) {
-                PATH.append(p);
-            }
+        close(pfd[0]);
+        dup2(pfd[1], 1);
+        dup2(pfd[1], 2);
+        close(pfd[1]);
+        std::string buildNum = std::to_string(build);
 
-            chdir(currentScript.cwd.c_str());
-
-            // conf file env vars
-            for(std::string file : env) {
-                StringMap vars = parseConfFile(file.c_str());
-                for(auto& it : vars) {
-                    setenv(it.first.c_str(), it.second.c_str(), true);
-                }
-            }
-            // parameterized vars
-            for(auto& pair : params) {
-                setenv(pair.first.c_str(), pair.second.c_str(), false);
-            }
-
-            setenv("PATH", PATH.c_str(), true);
-            setenv("RUN", buildNum.c_str(), true);
-            setenv("JOB", name.c_str(), true);
-            if(!node->name.empty())
-                setenv("NODE", node->name.c_str(), true);
-            setenv("RESULT", to_string(result).c_str(), true);
-            setenv("LAST_RESULT", to_string(lastResult).c_str(), true);
-            setenv("WORKSPACE", (fs::path(laminarHome)/"run"/name/"workspace").string().c_str(), true);
-            setenv("ARCHIVE", (fs::path(laminarHome)/"archive"/name/buildNum.c_str()).string().c_str(), true);
-
-            fprintf(stderr, "[laminar] Executing %s\n", currentScript.path.c_str());
-            execl(currentScript.path.c_str(), currentScript.path.c_str(), NULL);
-            // cannot use LLOG because stdout/stderr are captured
-            fprintf(stderr, "[laminar] Failed to execute %s\n", currentScript.path.c_str());
-            _exit(1);
+        std::string PATH = (rootPath/"cfg"/"scripts").toString(true).cStr();
+        if(const char* p = getenv("PATH")) {
+            PATH.append(":");
+            PATH.append(p);
         }
 
-        LLOG(INFO, "Forked", currentScript.path, currentScript.cwd, pid);
-        close(pfd[1]);
-        fd = pfd[0];
-        this->pid = pid;
+        LSYSCALL(chdir((rootPath/currentScript.cwd).toString(true).cStr()));
 
-        return false;
-    } else {
-        return true;
+        // conf file env vars
+        for(kj::Path& file : env) {
+            StringMap vars = parseConfFile((rootPath/file).toString(true).cStr());
+            for(auto& it : vars) {
+                setenv(it.first.c_str(), it.second.c_str(), true);
+            }
+        }
+        // parameterized vars
+        for(auto& pair : params) {
+            setenv(pair.first.c_str(), pair.second.c_str(), false);
+        }
+
+        setenv("PATH", PATH.c_str(), true);
+        setenv("RUN", buildNum.c_str(), true);
+        setenv("JOB", name.c_str(), true);
+        setenv("CONTEXT", context->name.c_str(), true);
+        setenv("RESULT", to_string(result).c_str(), true);
+        setenv("LAST_RESULT", to_string(lastResult).c_str(), true);
+        setenv("WORKSPACE", (rootPath/"run"/name/"workspace").toString(true).cStr(), true);
+        setenv("ARCHIVE", (rootPath/"archive"/name/buildNum).toString(true).cStr(), true);
+
+        fprintf(stderr, "[laminar] Executing %s\n", currentScript.path.toString().cStr());
+        kj::String execPath = (rootPath/currentScript.path).toString(true);
+        execl(execPath.cStr(), execPath.cStr(), NULL);
+        // cannot use LLOG because stdout/stderr are captured
+        fprintf(stderr, "[laminar] Failed to execute %s\n", currentScript.path.toString().cStr());
+        _exit(1);
+    }
+
+    LLOG(INFO, "Forked", currentScript.path, currentScript.cwd, pid);
+    close(pfd[1]);
+
+    current_pid = pid;
+    output_fd = pfd[0];
+    return false;
+}
+
+void Run::addScript(kj::Path scriptPath, kj::Path scriptWorkingDir, bool runOnAbort) {
+    scripts.push({kj::mv(scriptPath), kj::mv(scriptWorkingDir), runOnAbort});
+}
+
+void Run::addEnv(kj::Path path) {
+    env.push_back(kj::mv(path));
+}
+
+void Run::abort(bool respectRunOnAbort) {
+    while(scripts.size() && (!respectRunOnAbort || !scripts.front().runOnAbort))
+        scripts.pop();
+    // if the Maybe is empty, wait() was already called on this process
+    KJ_IF_MAYBE(p, current_pid) {
+        kill(-*p, SIGTERM);
     }
 }
-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::reaped(int status) {
-    procStatus = status;
-}
 
-void Run::complete() {
-    notifyCompletion(this);
+void Run::reaped(int 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
+
+    finished.fulfiller->fulfill(RunState(result));
 }

src/run.h

@@ -1,5 +1,5 @@
 ///
-/// Copyright 2015-2017 Oliver Giles
+/// Copyright 2015-2018 Oliver Giles
 ///
 /// This file is part of Laminar
 ///
@@ -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,12 @@
 #include <functional>
 #include <ostream>
 #include <unordered_map>
+#include <memory>
+#include <kj/async.h>
+#include <kj/filesystem.h>
+
+// Definition needed for musl
+typedef unsigned int uint;
 
 enum class RunState {
     UNKNOWN,
@@ -37,33 +43,29 @@ enum class RunState {
 
 std::string to_string(const RunState& rs);
 
-class Node;
+class Context;
 
-// Represents an execution of a job. Not much more than POD
+typedef std::unordered_map<std::string, std::string> ParamMap;
+
+// Represents an execution of a job.
 class Run {
 public:
-    Run();
+    Run(std::string name, ParamMap params, kj::Path&& rootPath);
     ~Run();
 
     // copying this class would be asking for trouble...
     Run(const Run&) = delete;
     Run& operator=(const Run&) = delete;
 
+    // Call this to "start" the run with a specific number and context
+    bool configure(uint buildNum, std::shared_ptr<Context> context, const kj::Directory &fsHome);
+
     // executes the next script (if any), returning true if there is nothing
-    // more to be done - in this case the caller should call complete()
+    // more to be done.
     bool step();
 
-    // call this when all scripts are done to get the notifyCompletion callback
-    void complete();
-
-    // adds a script to the queue of scripts to be executed by this run
-    void addScript(std::string scriptPath, std::string scriptWorkingDir);
-
-    // adds a script to the queue using the runDir as the scripts CWD
-    void addScript(std::string script) { addScript(script, runDir); }
-
-    // adds an environment file that will be sourced before this run
-    void addEnv(std::string path);
+    // aborts this run
+    void abort(bool respectRunOnAbort);
 
     // called when a process owned by this run has been reaped. The status
     // may be used to set the run's job status
@@ -71,35 +73,43 @@ public:
 
     std::string reason() const;
 
-    std::function<void(Run*)> notifyCompletion;
-    Node* node;
+    kj::Promise<void>&& whenStarted() { return kj::mv(started.promise); }
+    kj::Promise<RunState>&& whenFinished() { return kj::mv(finished.promise); }
+
+    std::shared_ptr<Context> context;
     RunState result;
     RunState lastResult;
-    std::string laminarHome;
     std::string name;
-    std::string runDir;
     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;
+    kj::Maybe<pid_t> current_pid;
+    int output_fd;
     std::unordered_map<std::string, std::string> params;
+    int timeout = 0;
 
     time_t queuedAt;
     time_t startedAt;
 private:
+    // adds a script to the queue of scripts to be executed by this run
+    void addScript(kj::Path scriptPath, kj::Path scriptWorkingDir, bool runOnAbort = false);
+
+    // adds an environment file that will be sourced before this run
+    void addEnv(kj::Path path);
 
     struct Script {
-        std::string path;
-        std::string cwd;
+        kj::Path path;
+        kj::Path cwd;
+        bool runOnAbort;
     };
 
+    kj::Path rootPath;
     std::queue<Script> scripts;
-    Script currentScript;
-    std::list<std::string> env;
+    std::list<kj::Path> env;
+    std::string reasonMsg;
+    kj::PromiseFulfillerPair<void> started;
+    kj::PromiseFulfillerPair<RunState> finished;
 };
 
 
@@ -126,13 +136,11 @@ struct _run_same {
 
 // A single Run can be fetched by...
 struct _run_index : bmi::indexed_by<
-        // their current running pid
-        bmi::hashed_unique<bmi::member<Run, pid_t, &Run::pid>>,
         bmi::hashed_unique<bmi::composite_key<
             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 +155,17 @@ 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& byNameNumber() { return get<0>(); }
+    typename bmi::nth_index<RunSet, 0>::type const& byNameNumber() const { return get<0>(); }
+
+    typename bmi::nth_index<RunSet, 1>::type& byRunPtr() { return get<1>(); }
+    typename bmi::nth_index<RunSet, 1>::type const& byRunPtr() const { return get<1>(); }
+
+    typename bmi::nth_index<RunSet, 2>::type& byStartedAt() { return get<2>(); }
+    typename bmi::nth_index<RunSet, 2>::type const& byStartedAt() const { return get<2>(); }
+
+    typename bmi::nth_index<RunSet, 3>::type& byJobName() { return get<3>(); }
+    typename bmi::nth_index<RunSet, 3>::type const& byJobName() const { return get<3>(); }
 };
 
-#endif // _LAMINAR_RUN_H_
+#endif // LAMINAR_RUN_H_

src/server.cpp

@@ -1,5 +1,5 @@
 ///
-/// Copyright 2015-2017 Oliver Giles
+/// Copyright 2015-2019 Oliver Giles
 ///
 /// This file is part of Laminar
 ///
@@ -17,440 +17,129 @@
 /// along with Laminar.  If not, see <http://www.gnu.org/licenses/>
 ///
 #include "server.h"
-#include "interface.h"
-#include "laminar.capnp.h"
-#include "resources.h"
 #include "log.h"
+#include "rpc.h"
+#include "http.h"
+#include "laminar.h"
 
-#include <capnp/ez-rpc.h>
-#include <capnp/rpc-twoparty.h>
-#include <capnp/rpc.capnp.h>
 #include <kj/async-io.h>
+#include <kj/async-unix.h>
 #include <kj/threadlocal.h>
 
-#include <websocketpp/config/core.hpp>
-#include <websocketpp/server.hpp>
-
+#include <signal.h>
 #include <sys/eventfd.h>
+#include <sys/inotify.h>
+#include <sys/signalfd.h>
 
 // Size of buffer used to read from file descriptors. Should be
 // a multiple of sizeof(struct signalfd_siginfo) == 128
 #define PROC_IO_BUFSIZE 4096
 
-// Configuration struct for the websocketpp template library.
-struct wsconfig : public websocketpp::config::core {
-//    static const websocketpp::log::level elog_level =
-//        websocketpp::log::elevel::info;
-
-//    static const websocketpp::log::level alog_level =
-//        websocketpp::log::alevel::access_core |
-//        websocketpp::log::alevel::message_payload ;
-
-    static const websocketpp::log::level elog_level =
-        websocketpp::log::elevel::none;
-
-    static const websocketpp::log::level alog_level =
-        websocketpp::log::alevel::none;
-
-    typedef struct { LaminarClient* lc; } connection_base;
-};
-typedef websocketpp::server<wsconfig> websocket;
-
-namespace {
-
-// Used for returning run state to RPC clients
-LaminarCi::JobResult fromRunState(RunState state) {
-    switch(state) {
-    case RunState::SUCCESS: return LaminarCi::JobResult::SUCCESS;
-    case RunState::FAILED:  return LaminarCi::JobResult::FAILED;
-    case RunState::ABORTED: return LaminarCi::JobResult::ABORTED;
-    default:
-        return LaminarCi::JobResult::UNKNOWN;
-    }
-}
-
-}
-
-// This is the implementation of the Laminar Cap'n Proto RPC interface.
-// As such, it implements the pure virtual interface generated from
-// laminar.capnp with calls to the LaminarInterface
-class RpcImpl : public LaminarCi::Server, public LaminarWaiter {
-public:
-    RpcImpl(LaminarInterface& l) :
-        LaminarCi::Server(),
-        laminar(l)
-    {
-        laminar.registerWaiter(this);
-    }
-
-    ~RpcImpl() {
-        laminar.deregisterWaiter(this);
-    }
-
-    // Start a job, without waiting for it to finish
-    kj::Promise<void> trigger(TriggerContext context) override {
-        std::string jobName = context.getParams().getJobName();
-        LLOG(INFO, "RPC trigger", jobName);
-        ParamMap params;
-        for(auto p : context.getParams().getParams()) {
-            params[p.getName().cStr()] = p.getValue().cStr();
-        }
-        LaminarCi::MethodResult result = laminar.queueJob(jobName, params)
-                ? LaminarCi::MethodResult::SUCCESS
-                : LaminarCi::MethodResult::FAILED;
-        context.getResults().setResult(result);
-        return kj::READY_NOW;
-    }
-
-    // Start a job and wait for the result
-    kj::Promise<void> start(StartContext context) override {
-        std::string jobName = context.getParams().getJobName();
-        LLOG(INFO, "RPC start", 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 {
-                context.getResults().setResult(fromRunState(state));
-            });
-        } else {
-            context.getResults().setResult(LaminarCi::JobResult::UNKNOWN);
-            return kj::READY_NOW;
-        }
-    }
-
-    // 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();
-        LLOG(INFO, "RPC set", jobName, buildNum);
-
-        LaminarCi::MethodResult result = laminar.setParam(jobName, buildNum,
-            context.getParams().getParam().getName(), context.getParams().getParam().getValue())
-                ? LaminarCi::MethodResult::SUCCESS
-                : LaminarCi::MethodResult::FAILED;
-        context.getResults().setResult(result);
-        return kj::READY_NOW;
-    }
-
-    // Take a named lock
-    kj::Promise<void> lock(LockContext context) override {
-        std::string lockName = context.getParams().getLockName();
-        LLOG(INFO, "RPC lock", lockName);
-        auto& lockList = locks[lockName];
-        lockList.emplace_back(kj::newPromiseAndFulfiller<void>());
-        if(lockList.size() == 1)
-            lockList.front().fulfiller->fulfill();
-        return std::move(lockList.back().promise);
-    }
-
-    // Release a named lock
-    kj::Promise<void> release(ReleaseContext context) override {
-        std::string lockName = context.getParams().getLockName();
-        LLOG(INFO, "RPC release", lockName);
-        auto& lockList = locks[lockName];
-        if(lockList.size() == 0) {
-            LLOG(INFO, "Attempt to release unheld lock", lockName);
-            return kj::READY_NOW;
-        }
-        lockList.erase(lockList.begin());
-        if(lockList.size() > 0)
-            lockList.front().fulfiller->fulfill();
-        return kj::READY_NOW;
-    }
-private:
-    // Implements LaminarWaiter::complete
-    void complete(const Run* r) override {
-        for(kj::PromiseFulfillerPair<RunState>& w : runWaiters[r])
-            w.fulfiller->fulfill(RunState(r->result));
-        runWaiters.erase(r);
-    }
-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;
-};
-
-
-// This is the implementation of the HTTP/Websocket interface. It exposes
-// websocket connections as LaminarClients and registers them with the
-// LaminarInterface so that status messages will be delivered to the client.
-// On opening a websocket connection, it delivers a status snapshot message
-// (see LaminarInterface::sendStatus)
-class Server::HttpImpl {
-public:
-    HttpImpl(LaminarInterface& l) :
-        laminar(l)
-    {
-        // debug logging
-        // wss.set_access_channels(websocketpp::log::alevel::all);
-        // wss.set_error_channels(websocketpp::log::elevel::all);
-
-        // TODO: This could be used in the future to trigger actions on the
-        // server in response to a web client request. Currently not supported.
-        // wss.set_message_handler([](std::weak_ptr<void> s, websocket::message_ptr msg){
-        //     msg->get_payload();
-        // });
-
-        // Handle plain HTTP requests by delivering the binary resource
-        wss.set_http_handler([this](websocketpp::connection_hdl hdl){
-            websocket::connection_ptr c = wss.get_con_from_hdl(hdl);
-            const char* start, *end, *content_type;
-            std::string resource = c->get_resource();
-            if(resource.compare(0, strlen("/archive/"), "/archive/") == 0) {
-                std::string file(resource.substr(strlen("/archive/")));
-                std::string content;
-                if(laminar.getArtefact(file, content)) {
-                    c->set_status(websocketpp::http::status_code::ok);
-                    c->append_header("Content-Transfer-Encoding", "binary");
-                    c->set_body(content);
-                } else {
-                    c->set_status(websocketpp::http::status_code::not_found);
-                }
-            } else if(resources.handleRequest(resource, &start, &end, &content_type)) {
-                c->set_status(websocketpp::http::status_code::ok);
-                c->append_header("Content-Type", content_type);
-                c->append_header("Content-Encoding", "gzip");
-                c->append_header("Content-Transfer-Encoding", "binary");
-                std::string response(start,end);
-                c->set_body(response);
-            } else {
-                // 404
-                c->set_status(websocketpp::http::status_code::not_found);
-            }
-            c->lc->close(false);
-        });
-
-        // Handle new websocket connection. Parse the URL to determine
-        // the client's scope of interest, register the client for update
-        // messages, and call sendStatus.
-        wss.set_open_handler([this](websocketpp::connection_hdl hdl){
-            websocket::connection_ptr c = wss.get_con_from_hdl(hdl);
-            std::string res = c->get_resource();
-            if(res.substr(0, 5) == "/jobs") {
-                if(res.length() == 5) {
-                    c->lc->scope.type = MonitorScope::ALL;
-                } else {
-                    res = res.substr(5);
-                    int 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);
-                        std::string run = res.substr(split+1, split2-split);
-                        if(!run.empty()) {
-                            c->lc->scope.num = atoi(run.c_str());
-                            c->lc->scope.type = MonitorScope::RUN;
-                        }
-                        if(split2 != std::string::npos && res.compare(split2, 4, "/log") == 0) {
-                            c->lc->scope.type = MonitorScope::LOG;
-                        }
-                    }
-                }
-            }
-            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.
-    // This is a bit untidy, it would be better to make them a single object,
-    // but I didn't yet figure it out
-    websocket::connection_ptr newConnection(LaminarClient* lc) {
-        websocket::connection_ptr c = wss.get_connection();
-        c->lc = lc;
-        return c;
-    }
-
-private:
-    Resources resources;
-    LaminarInterface& laminar;
-    websocket wss;
-};
-
-// Context for an RPC connection
-struct RpcConnection {
-    RpcConnection(kj::Own<kj::AsyncIoStream>&& stream,
-                  capnp::Capability::Client bootstrap,
-                  capnp::ReaderOptions readerOpts) :
-        stream(kj::mv(stream)),
-        network(*this->stream, capnp::rpc::twoparty::Side::SERVER, readerOpts),
-        rpcSystem(capnp::makeRpcServer(network, bootstrap))
-    {
-    }
-    kj::Own<kj::AsyncIoStream> stream;
-    capnp::TwoPartyVatNetwork network;
-    capnp::RpcSystem<capnp::rpc::twoparty::VatId> rpcSystem;
-};
-
-// 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 {
-    WebsocketConnection(kj::Own<kj::AsyncIoStream>&& stream, Server::HttpImpl& http) :
-        stream(kj::mv(stream)),
-        out(this),
-        cn(http.newConnection(this)),
-        writePaf(kj::newPromiseAndFulfiller<void>()),
-        closeOnComplete(false)
-    {
-        cn->register_ostream(&out);
-        cn->start();
-    }
-
-    ~WebsocketConnection() noexcept(true) {
-        outputBuffer.clear();
-        writePaf.fulfiller->fulfill();
-    }
-
-    kj::Promise<void> pend() {
-        return stream->tryRead(ibuf, 1, sizeof(ibuf)).then([this](size_t sz){
-            cn->read_all(ibuf, sz);
-            if(sz == 0 || cn->get_state() == websocketpp::session::state::closed) {
-                cn->eof();
-                return kj::Promise<void>(kj::READY_NOW);
-            }
-            return pend();
-        });
-    }
-
-    kj::Promise<void> writeTask() {
-        return writePaf.promise.then([this]() {
-            std::string payload;
-            // clear the outputBuffer for more context, and take a chunk
-            // 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));
-            }
-        });
-    }
-
-    void sendMessage(std::string payload) override {
-        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;
-    }
-
-    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)),
-    ioContext(kj::setupAsyncIo()),
-    tasks(*this)
+Server::Server(kj::AsyncIoContext& io) :
+    ioContext(io),
+    listeners(kj::heap<kj::TaskSet>(*this)),
+    childTasks(*this)
 {
-    // RPC task
-    if(rpcBindAddress.startsWith("unix:"))
-        unlink(rpcBindAddress.slice(strlen("unix:")).cStr());
-    tasks.add(ioContext.provider->getNetwork().parseAddress(rpcBindAddress)
-              .then([this](kj::Own<kj::NetworkAddress>&& addr) {
-        acceptRpcClient(addr->listen());
-    }));
-
-    // HTTP task
-    if(httpBindAddress.startsWith("unix:"))
-        unlink(httpBindAddress.slice(strlen("unix:")).cStr());
-    tasks.add(ioContext.provider->getNetwork().parseAddress(httpBindAddress)
-              .then([this](kj::Own<kj::NetworkAddress>&& addr) {
-        acceptHttpClient(addr->listen());
-    }));
 }
 
 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. wait for all children to close
+    childTasks.onEmpty().wait(ioContext.waitScope);
+    // TODO not sure the comments below are true
+    // 3. run the loop once more to send any pending output to http clients
+    ioContext.waitScope.poll();
+    // 4. return: http connections will be destructed when class is deleted
 }
 
 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) {
+kj::Promise<void> Server::readDescriptor(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)));
+    return 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));
-            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));
-        }))
-    );
+void Server::addTask(kj::Promise<void>&& task) {
+    childTasks.add(kj::mv(task));
 }
 
-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));
-            auto server = kj::heap<RpcConnection>(kj::mv(connection), rpcInterface, capnp::ReaderOptions());
-            tasks.add(server->network.onDisconnect().attach(kj::mv(server)));
-        }))
-    );
+kj::Promise<void> Server::addTimeout(int seconds, std::function<void ()> cb) {
+    return ioContext.lowLevelProvider->getTimer().afterDelay(seconds * kj::SECONDS).then([cb](){
+        cb();
+    }).eagerlyEvaluate(nullptr);
+}
+
+kj::Promise<int> Server::onChildExit(kj::Maybe<pid_t> &pid) {
+    return ioContext.unixEventPort.onChildExit(pid);
+}
+
+Server::PathWatcher& Server::watchPaths(std::function<void()> fn)
+{
+    struct PathWatcherImpl : public PathWatcher {
+        PathWatcher& addPath(const char* path) override {
+            inotify_add_watch(fd, path, IN_ONLYDIR | IN_CLOSE_WRITE | IN_CREATE | IN_DELETE);
+            return *this;
+        }
+        int fd;
+    };
+    auto pwi = kj::heap<PathWatcherImpl>();
+    PathWatcher* pw = pwi.get();
+
+    pwi->fd = inotify_init1(IN_NONBLOCK | IN_CLOEXEC);
+    listeners->add(readDescriptor(pwi->fd, [fn](const char*, size_t){
+        fn();
+    }).attach(kj::mv(pwi)));
+    return *pw;
+}
+
+void Server::listenRpc(Rpc &rpc, kj::StringPtr rpcBindAddress)
+{
+    if(rpcBindAddress.startsWith("unix:"))
+        unlink(rpcBindAddress.slice(strlen("unix:")).cStr());
+    listeners->add(ioContext.provider->getNetwork().parseAddress(rpcBindAddress)
+              .then([this,&rpc](kj::Own<kj::NetworkAddress>&& addr) {
+        return acceptRpcClient(rpc, addr->listen());
+    }));
+
+}
+
+void Server::listenHttp(Http &http, kj::StringPtr httpBindAddress)
+{
+    if(httpBindAddress.startsWith("unix:"))
+        unlink(httpBindAddress.slice(strlen("unix:")).cStr());
+    listeners->add(ioContext.provider->getNetwork().parseAddress(httpBindAddress)
+              .then([this,&http](kj::Own<kj::NetworkAddress>&& addr) {
+        return http.startServer(ioContext.lowLevelProvider->getTimer(), addr->listen());
+    }));
+}
+
+kj::Promise<void> Server::acceptRpcClient(Rpc& rpc, kj::Own<kj::ConnectionReceiver>&& listener) {
+    kj::ConnectionReceiver& cr = *listener.get();
+    return cr.accept().then(kj::mvCapture(kj::mv(listener),
+        [this, &rpc](kj::Own<kj::ConnectionReceiver>&& listener, kj::Own<kj::AsyncIoStream>&& connection) {
+            addTask(rpc.accept(kj::mv(connection)));
+            return acceptRpcClient(rpc, kj::mv(listener));
+        }));
 }
 
 // returns a promise which will read a chunk of data from the file descriptor
@@ -465,3 +154,10 @@ kj::Promise<void> Server::handleFdRead(kj::AsyncInputStream* stream, char* buffe
         return kj::Promise<void>(kj::READY_NOW);
     });
 }
+
+void Server::taskFailed(kj::Exception &&exception) {
+    //kj::throwFatalException(kj::mv(exception));
+    // prettier
+    fprintf(stderr, "fatal: %s\n", exception.getDescription().cStr());
+    exit(EXIT_FAILURE);
+}

src/server.h

@@ -16,51 +16,59 @@
 /// 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 <kj/compat/http.h>
 #include <capnp/message.h>
 #include <capnp/capability.h>
 #include <functional>
 
-struct LaminarInterface;
+struct Laminar;
+struct Http;
+struct Rpc;
 
-// This class abstracts the HTTP/Websockets and Cap'n Proto RPC interfaces
-// and manages the program's asynchronous event loop
+// This class manages the program's asynchronous event loop
 class Server final : public kj::TaskSet::ErrorHandler {
 public:
-    // Initializes the server with a LaminarInterface to handle requests from
-    // HTTP/Websocket or RPC clients and bind addresses for each of those
-    // interfaces. See the documentation for kj::AsyncIoProvider::getNetwork
-    // for a description of the address format
-    Server(LaminarInterface& li, kj::StringPtr rpcBindAddress, kj::StringPtr httpBindAddress);
+    Server(kj::AsyncIoContext& ioContext);
     ~Server();
     void start();
     void stop();
 
     // add a file descriptor to be monitored for output. The callback will be
     // invoked with the read data
-    void addDescriptor(int fd, std::function<void(const char*,size_t)> cb);
+    kj::Promise<void> readDescriptor(int fd, std::function<void(const char*,size_t)> cb);
+
+    void addTask(kj::Promise<void> &&task);
+    // add a one-shot timer callback
+    kj::Promise<void> addTimeout(int seconds, std::function<void()> cb);
+
+    // get a promise which resolves when a child process exits
+    kj::Promise<int> onChildExit(kj::Maybe<pid_t>& pid);
+
+    struct PathWatcher {
+        virtual PathWatcher& addPath(const char* path) = 0;
+    };
+
+    PathWatcher& watchPaths(std::function<void()>);
+
+    void listenRpc(Rpc& rpc, kj::StringPtr rpcBindAddress);
+    void listenHttp(Http& http, kj::StringPtr httpBindAddress);
 
 private:
-    void acceptHttpClient(kj::Own<kj::ConnectionReceiver>&& listener);
-    void acceptRpcClient(kj::Own<kj::ConnectionReceiver>&& listener);
+    kj::Promise<void> acceptRpcClient(Rpc& rpc, 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;
-
     int efd_quit;
-    capnp::Capability::Client rpcInterface;
-    HttpImpl* httpInterface;
-    kj::AsyncIoContext ioContext;
-    kj::TaskSet tasks;
+    kj::AsyncIoContext& ioContext;
+    kj::Own<kj::TaskSet> listeners;
+    kj::TaskSet childTasks;
+    kj::Maybe<kj::Promise<void>> reapWatch;
 };
 
-#endif // _LAMINAR_SERVER_H_
+#endif // LAMINAR_SERVER_H_

test/eventsource.h

@@ -0,0 +1,71 @@
+///
+/// Copyright 2019 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/>
+///
+#ifndef LAMINAR_EVENTSOURCE_H_
+#define LAMINAR_EVENTSOURCE_H_
+
+#include <kj/async-io.h>
+#include <kj/compat/http.h>
+#include <rapidjson/document.h>
+#include <vector>
+
+class EventSource {
+public:
+    EventSource(kj::AsyncIoContext& ctx, const char* httpConnectAddr, const char* path) :
+        networkAddress(ctx.provider->getNetwork().parseAddress(httpConnectAddr).wait(ctx.waitScope)),
+        httpClient(kj::newHttpClient(ctx.lowLevelProvider->getTimer(), headerTable, *networkAddress)),
+        headerTable(),
+        headers(headerTable),
+        buffer(kj::heapArrayBuilder<char>(BUFFER_SIZE))
+    {
+        headers.add("Accept", "text/event-stream");
+        auto resp = httpClient->request(kj::HttpMethod::GET, path, headers).response.wait(ctx.waitScope);
+        promise = waitForMessages(resp.body.get(), 0).attach(kj::mv(resp));
+    }
+
+    const std::vector<rapidjson::Document>& messages() {
+        return receivedMessages;
+    }
+
+private:
+    kj::Own<kj::NetworkAddress> networkAddress;
+    kj::Own<kj::HttpClient> httpClient;
+    kj::HttpHeaderTable headerTable;
+    kj::HttpHeaders headers;
+    kj::ArrayBuilder<char> buffer;
+    kj::Maybe<kj::Promise<void>> promise;
+    std::vector<rapidjson::Document> receivedMessages;
+
+    kj::Promise<void> waitForMessages(kj::AsyncInputStream* stream, ulong offset) {
+        return stream->read(buffer.asPtr().begin() + offset, 1, BUFFER_SIZE).then([=](size_t s) {
+            ulong end = offset + s;
+            buffer.asPtr().begin()[end] = '\0';
+            if(strcmp(&buffer.asPtr().begin()[end - 2], "\n\n") == 0) {
+                rapidjson::Document d;
+                d.Parse(buffer.begin() + strlen("data: "));
+                receivedMessages.emplace_back(kj::mv(d));
+                end = 0;
+            }
+            return waitForMessages(stream, end);
+        });
+    }
+
+    static const int BUFFER_SIZE = 1024;
+};
+
+#endif // LAMINAR_EVENTSOURCE_H_

test/laminar-fixture.h

@@ -0,0 +1,82 @@
+///
+/// Copyright 2019 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/>
+///
+#ifndef LAMINAR_FIXTURE_H_
+#define LAMINAR_FIXTURE_H_
+
+#include <capnp/rpc-twoparty.h>
+#include <gtest/gtest.h>
+#include "laminar.capnp.h"
+#include "eventsource.h"
+#include "tempdir.h"
+#include "laminar.h"
+#include "server.h"
+
+class LaminarFixture : public ::testing::Test {
+public:
+    LaminarFixture() {
+        bind_rpc = std::string("unix:/") + tmp.path.toString(true).cStr() + "/rpc.sock";
+        bind_http = std::string("unix:/") + tmp.path.toString(true).cStr() + "/http.sock";
+        home = tmp.path.toString(true).cStr();
+        tmp.fs->openSubdir(kj::Path{"cfg", "jobs"}, kj::WriteMode::CREATE | kj::WriteMode::CREATE_PARENT);
+        settings.home = home.c_str();
+        settings.bind_rpc = bind_rpc.c_str();
+        settings.bind_http = bind_http.c_str();
+        settings.archive_url = "/test-archive/";
+        server = new Server(ioContext);
+        laminar = new Laminar(*server, settings);
+    }
+    ~LaminarFixture() noexcept(true) {
+        delete server;
+        delete laminar;
+    }
+
+    kj::Own<EventSource> eventSource(const char* path) {
+        return kj::heap<EventSource>(ioContext, bind_http.c_str(), path);
+    }
+
+    void defineJob(const char* name, const char* scriptContent) {
+        KJ_IF_MAYBE(f, tmp.fs->tryOpenFile(kj::Path{"cfg", "jobs", std::string(name) + ".run"},
+                kj::WriteMode::CREATE | kj::WriteMode::CREATE_PARENT | kj::WriteMode::EXECUTABLE)) {
+            (*f)->writeAll(std::string("#!/bin/sh\n") + scriptContent + "\n");
+        }
+    }
+
+    LaminarCi::Client client() {
+        if(!rpc) {
+            auto stream = ioContext.provider->getNetwork().parseAddress(bind_rpc).wait(ioContext.waitScope)->connect().wait(ioContext.waitScope);
+            auto net = kj::heap<capnp::TwoPartyVatNetwork>(*stream, capnp::rpc::twoparty::Side::CLIENT);
+            rpc = kj::heap<capnp::RpcSystem<capnp::rpc::twoparty::VatId>>(*net, nullptr).attach(kj::mv(net), kj::mv(stream));
+        }
+        static capnp::word scratch[4];
+        memset(scratch, 0, sizeof(scratch));
+        auto hostId = capnp::MallocMessageBuilder(scratch).getRoot<capnp::rpc::twoparty::VatId>();
+        hostId.setSide(capnp::rpc::twoparty::Side::SERVER);
+        return rpc->bootstrap(hostId).castAs<LaminarCi>();
+    }
+
+    kj::Own<capnp::RpcSystem<capnp::rpc::twoparty::VatId>> rpc;
+    TempDir tmp;
+    std::string home, bind_rpc, bind_http;
+    Settings settings;
+    Server* server;
+    Laminar* laminar;
+    static kj::AsyncIoContext ioContext;
+};
+
+#endif // LAMINAR_FIXTURE_H_

test/laminar-functional.cpp

@@ -0,0 +1,103 @@
+///
+/// Copyright 2019 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 <kj/async-unix.h>
+#include "laminar-fixture.h"
+
+// TODO: consider handling this differently
+kj::AsyncIoContext LaminarFixture::ioContext = kj::setupAsyncIo();
+
+TEST_F(LaminarFixture, EmptyStatusMessageStructure) {
+    auto es = eventSource("/");
+    ioContext.waitScope.poll();
+    ASSERT_EQ(1, es->messages().size());
+
+    auto json = es->messages().front().GetObject();
+    EXPECT_STREQ("status", json["type"].GetString());
+    EXPECT_STREQ("Laminar", json["title"].GetString());
+    EXPECT_LT(time(nullptr) - json["time"].GetInt64(), 1);
+
+    auto data = json["data"].GetObject();
+    EXPECT_TRUE(data.HasMember("recent"));
+    EXPECT_TRUE(data.HasMember("running"));
+    EXPECT_TRUE(data.HasMember("queued"));
+    EXPECT_TRUE(data.HasMember("executorsTotal"));
+    EXPECT_TRUE(data.HasMember("executorsBusy"));
+    EXPECT_TRUE(data.HasMember("buildsPerDay"));
+    EXPECT_TRUE(data.HasMember("buildsPerJob"));
+    EXPECT_TRUE(data.HasMember("timePerJob"));
+    EXPECT_TRUE(data.HasMember("resultChanged"));
+    EXPECT_TRUE(data.HasMember("lowPassRates"));
+    EXPECT_TRUE(data.HasMember("buildTimeChanges"));
+    EXPECT_TRUE(data.HasMember("buildTimeDist"));
+}
+
+TEST_F(LaminarFixture, JobNotifyHomePage) {
+    defineJob("foo", "true");
+    auto es = eventSource("/");
+
+    auto req = client().runRequest();
+    req.setJobName("foo");
+    ASSERT_EQ(LaminarCi::JobResult::SUCCESS, req.send().wait(ioContext.waitScope).getResult());
+
+    // wait for job completed
+    ioContext.waitScope.poll();
+
+    ASSERT_EQ(4, es->messages().size());
+
+    auto job_queued = es->messages().at(1).GetObject();
+    EXPECT_STREQ("job_queued", job_queued["type"].GetString());
+    EXPECT_STREQ("foo", job_queued["data"]["name"].GetString());
+
+    auto job_started = es->messages().at(2).GetObject();
+    EXPECT_STREQ("job_started", job_started["type"].GetString());
+    EXPECT_STREQ("foo", job_started["data"]["name"].GetString());
+
+    auto job_completed = es->messages().at(3).GetObject();
+    EXPECT_STREQ("job_completed", job_completed["type"].GetString());
+    EXPECT_STREQ("foo", job_completed["data"]["name"].GetString());
+}
+
+TEST_F(LaminarFixture, OnlyRelevantNotifications) {
+    defineJob("job1", "true");
+    defineJob("job2", "true");
+
+    auto esHome = eventSource("/");
+    auto esJobs = eventSource("/jobs");
+    auto es1Job = eventSource("/jobs/job1");
+    auto es2Job = eventSource("/jobs/job2");
+    auto es1Run = eventSource("/jobs/job1/1");
+    auto es2Run = eventSource("/jobs/job2/1");
+
+    auto req1 = client().runRequest();
+    req1.setJobName("job1");
+    ASSERT_EQ(LaminarCi::JobResult::SUCCESS, req1.send().wait(ioContext.waitScope).getResult());
+    auto req2 = client().runRequest();
+    req2.setJobName("job2");
+    ASSERT_EQ(LaminarCi::JobResult::SUCCESS, req2.send().wait(ioContext.waitScope).getResult());
+    ioContext.waitScope.poll();
+
+    EXPECT_EQ(7, esHome->messages().size());
+    EXPECT_EQ(7, esJobs->messages().size());
+
+    EXPECT_EQ(4, es1Job->messages().size());
+    EXPECT_EQ(4, es2Job->messages().size());
+
+    EXPECT_EQ(4, es1Run->messages().size());
+    EXPECT_EQ(4, es2Run->messages().size());
+}

test/main.cpp

@@ -0,0 +1,28 @@
+///
+/// Copyright 2019 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 <kj/async-unix.h>
+#include <gtest/gtest.h>
+
+// gtest main supplied in order to call captureChildExit
+int main(int argc, char **argv) {
+    kj::UnixEventPort::captureChildExit();
+
+    ::testing::InitGoogleTest(&argc, argv);
+    return RUN_ALL_TESTS();
+}

test/tempdir.h

@@ -0,0 +1,45 @@
+///
+/// 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/>
+///
+#ifndef LAMINAR_TEMPDIR_H_
+#define LAMINAR_TEMPDIR_H_
+
+#include <kj/filesystem.h>
+#include <stdlib.h>
+
+class TempDir {
+public:
+    TempDir() :
+        path(mkdtemp()),
+        fs(kj::newDiskFilesystem()->getRoot().openSubdir(path, kj::WriteMode::CREATE|kj::WriteMode::MODIFY))
+    {
+    }
+    ~TempDir() noexcept {
+        kj::newDiskFilesystem()->getRoot().remove(path);
+    }
+    kj::Path path;
+    kj::Own<const kj::Directory> fs;
+private:
+    static kj::Path mkdtemp() {
+        char dir[] = "/tmp/laminar-test-XXXXXX";
+        ::mkdtemp(dir);
+        return kj::Path::parse(&dir[1]);
+    }
+};
+
+#endif // LAMINAR_TEMPDIR_H_

test/unit-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/unit-database.cpp

@@ -0,0 +1,83 @@
+///
+/// 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_F(DatabaseTest, StdevFunc) {
+    double res = 0;
+    db.stmt("with a (x) as (values (7),(3),(45),(23)) select stdev(x) from a").fetch<double>([&](double r){
+        res = r;
+    });
+    EXPECT_FLOAT_EQ(19.0700463205171, res);
+}

test/unit-run.cpp

@@ -0,0 +1,136 @@
+///
+/// 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 "context.h"
+#include "conf.h"
+#include "tempdir.h"
+
+class RunTest : public testing::Test {
+protected:
+    RunTest() :
+        testing::Test(),
+        context(std::make_shared<Context>()),
+        tmp(),
+        run("foo", ParamMap{}, tmp.path.clone())
+    {
+    }
+
+    ~RunTest() noexcept {}
+
+    void wait() {
+        int state = -1;
+        waitpid(run.current_pid.orDefault(0), &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.output_fd, tmp, 64); n > 0; n = read(run.output_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;
+    }
+
+    std::shared_ptr<Context> context;
+    TempDir tmp;
+    class Run run;
+
+    void setRunLink(const char * path) {
+        KJ_IF_MAYBE(f, tmp.fs->tryOpenFile(kj::Path{"cfg", "jobs", run.name + ".run"},
+                kj::WriteMode::CREATE | kj::WriteMode::CREATE_PARENT | kj::WriteMode::EXECUTABLE)) {
+            (f->get())->writeAll(std::string("#!/bin/sh\nexec ") + path + "\n");
+        }
+    }
+};
+
+TEST_F(RunTest, WorkingDirectory) {
+    setRunLink("pwd");
+    run.configure(1, context, *tmp.fs);
+    runAll();
+    std::string cwd{tmp.path.append(kj::Path{"run","foo","1"}).toString(true).cStr()};
+    EXPECT_EQ(cwd + "\n", readAllOutput());
+}
+
+TEST_F(RunTest, SuccessStatus) {
+    setRunLink("true");
+    run.configure(1, context, *tmp.fs);
+    runAll();
+    EXPECT_EQ(RunState::SUCCESS, run.result);
+}
+
+TEST_F(RunTest, FailedStatus) {
+    setRunLink("false");
+    run.configure(1, context, *tmp.fs);
+    runAll();
+    EXPECT_EQ(RunState::FAILED, run.result);
+}
+
+TEST_F(RunTest, Environment) {
+    setRunLink("env");
+    run.configure(1234, context, *tmp.fs);
+    runAll();
+
+    std::string ws{tmp.path.append(kj::Path{"run","foo","workspace"}).toString(true).cStr()};
+    std::string archive{tmp.path.append(kj::Path{"archive","foo","1234"}).toString(true).cStr()};
+
+    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(ws, map["WORKSPACE"]);
+    EXPECT_EQ(archive, map["ARCHIVE"]);
+}
+
+TEST_F(RunTest, ParamsToEnv) {
+    setRunLink("env");
+    run.params["foo"] = "bar";
+    run.configure(1, context, *tmp.fs);
+    runAll();
+    StringMap map = parseFromString(readAllOutput());
+    EXPECT_EQ("bar", map["foo"]);
+}
+
+TEST_F(RunTest, Abort) {
+    setRunLink("yes");
+    run.configure(1, context, *tmp.fs);
+    run.step();
+    usleep(200); // TODO fix
+    run.abort(false);
+    wait();
+    EXPECT_EQ(RunState::ABORTED, run.result);
+}
+