log.h: null-terminate compile-time filename strings

Fix all hrefs and vue routes to correctly operate against the
<base href> tag. Add a configuration parameter to override the
content of the href attribute, and describe its use.

CMakeLists.txt

@@ -1,5 +1,5 @@
 ###
-### Copyright 2016 Oliver Giles
+### Copyright 2015-2019 Oliver Giles
 ###
 ### This file is part of Laminar
 ###
@@ -18,10 +18,11 @@
 ###
 project(laminar)
 cmake_minimum_required(VERSION 2.8)
+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
@@ -42,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})
@@ -57,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 progress.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
@@ -66,27 +76,38 @@ 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)
 
 ## 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)
+    src/conf.cpp src/resources.cpp src/run.cpp laminar.capnp.c++ ${COMPRESSED_BINS} index_html_size.h)
+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 src/conf.cpp src/database.cpp src/laminar.cpp src/run.cpp src/server.cpp laminar.capnp.c++ src/resources.cpp ${COMPRESSED_BINS} test/test-conf.cpp test/test-database.cpp test/test-laminar.cpp test/test-run.cpp test/test-server.cpp)
+    target_link_libraries(laminar-tests ${GTEST_BOTH_LIBRARIES} gmock capnp-rpc capnp kj-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)

COPYING

@@ -0,0 +1,674 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program 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.
+
+    This program 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 this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

README.md

@@ -1,16 +1,16 @@
-# Laminar CI
+# Laminar CI [![status](https://ci.ohwg.net/badge/laminar.svg)](https://ci.ohwg.net/jobs/laminar)
 
-[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 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`, `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. Then:
 
 ```bash
 git clone https://github.com/ohwgiles/laminar.git
@@ -22,517 +22,3 @@ sudo make install
 
 `make install` includes a systemd unit file. If you intend to use it, consider creating a new user `laminar` or modifying the user specified in the unit file.
 
-### Installation from binaries
-
-Alternatively to the source-based approach shown above, precompiled packages are supplied for x86_64 Debian Stable and CentOS 7.
-
-Under Debian:
-
-```bash
-wget https://github.com/ohwgiles/laminar/releases/download/0.4/laminar-0.4-1-amd64.deb
-sudo dpkg -i laminar-0.4-1-amd64.deb
-```
-
-Under CentOS:
-
-```bash
-wget https://github.com/ohwgiles/laminar/releases/download/0.4/laminar-0.4-1.x86_64.rpm
-sudo rpm -i laminar-0.4-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. For instructions, see for example [NGINX Reverse Proxy](https://www.nginx.com/resources/admin-guide/reverse-proxy/) or [Apache Reverse Proxy](https://httpd.apache.org/docs/2.4/howto/reverse_proxy.html).
-
-#### Set the page title
-
-Change `LAMINAR_TITLE` 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
-```
-
-Don't forget to mark it 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 results and log output should be visible in the Web UI at http://localhost:8080
-
-#### 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 [that for the web UI](#running-on-a-different-http-port-or-unix-socket)
-
-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`
-```
-#!/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 `/var/lib/laminar/cfg/jobs/example.after` exists, it will be executed after the primary `/var/lib/laminar/cfg/jobs/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, the example shown above in [Conditionally trigger a downstream job](#conditionally-trigger-a-downstream-job) can be simplified to
-
-```bash
-success_trigger example-test
-```
-
-Another excellent candidate for helper scripts is automatically [sending notifications](#email-and-im-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.config` 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`.
-
-The call to ssh can itself be hidden with a [helper script](#helper-scripts) `/var/lib/laminar/cfg/scripts/remotebuild`:
-
-```bash
-#!/bin/bash -e
-ssh -E root@$TARGET_IP /bin/bash -xe < $1
-```
-
-Then simply use `#!/usr/bin/env remotebuild` instead of the `#!/bin/bash` hashbang.
-
-### 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 -v $WORKSPACE:/ws 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 (hard-link) copy 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_WORKDIR`: If set, do not delete run directories after completion
-- `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`
-- `JOB`
-- `RESULT`
-- `LAST_RESULT`
-- `WORKSPACE`
-- `ARCHIVE`
-
-In addition, `$LAMINAR_HOME/cfg/scripts` is prepended to `$PATH`. See [helper scripts](#helper-scripts).
-
-Laminar will also export variables in the form `KEY=VALUE` found in these files:
-
-- `env`
-- `nodes/$NODE.env`
-- `jobs/$JOB.env`
-
-Finally, variables supplied on the command-line call to `laminarc start` or `laminarc trigger` will be available. See [parameterized builds](#parameterized-builds)
-
-### `laminarc`
-
-`laminarc` commands are:
-
-- `trigger [JOB [PARAMS...]]...` triggers one or more jobs with optional parameters, returning immediately.
-- `start [JOB [PARAMS...]]...` triggers one or more jobs with optional parameters and waits for the completion of all jobs. Returns a non-zero error code if any job failed.
-- `set [VARIABLE=VALUE]...` sets one or more variables to be exported in subsequent scripts for the run identified by the `$JOB` and `$RUN` environment variables
-- `lock [NAME]` acquires the [lock](#locks) named `NAME`
-- `release [NAME]` releases the lock named `NAME`
-
-`laminarc` connects to `laminard` using the address supplied by the `LAMINAR_HOST` environment variable. If it is not set, `laminarc` will first attempt to use `LAMINAR_BIND_RPC`, which will be available if `laminarc` is executed from a script within `laminard`. If neither `LAMINAR_HOST` nor `LAMINAR_BIND_RPC` is set, `laminarc` will assume a default host of `unix-abstract:laminar`.
-
-## Appendix: Example scripts

UserManual.md

@@ -0,0 +1,639 @@
+# Introduction
+
+[Laminar](http://laminar.ohwg.net) is a lightweight and modular Continuous Integration service for Linux. It is self-hosted and developer-friendly, eschewing a configuration web UI in favor of simple version-controllable configuration files and scripts.
+
+Laminar encourages the use of existing GNU/Linux tools such as `bash` and `cron` instead of reinventing them.
+
+Although the status and progress front-end is very user-friendly, administering a Laminar instance requires writing shell scripts and manually editing configuration files. That being said, there is nothing esoteric here and the tutorial below should be straightforward for anyone with even very basic Linux server administration experience.
+
+Throughout this document, the fixed base path `/var/lib/laminar` is used. This is the default path and can be changed by setting `LAMINAR_HOME` in `/etc/laminar.conf` as desired.
+
+## Terminology
+
+- *job*: a task, identified by a name, comprising of one or more executable scripts.
+- *run*: a numbered execution of a *job*
+
+---
+
+# Installing Laminar
+
+Pre-built packages are available for Debian 9 (Stretch) and CentOS 7 on x86_64. Alternatively, Laminar may be built from source for any Linux distribution.
+
+## Installation from binaries
+
+Alternatively to the source-based approach shown above, precompiled packages are supplied for x86_64 Debian 9 (Stretch) and CentOS 7
+
+Under Debian:
+
+```bash
+wget https://github.com/ohwgiles/laminar/releases/download/0.6/laminar-0.6-1-amd64.deb
+sudo apt install laminar-0.6-1-amd64.deb
+```
+
+Under CentOS:
+
+```bash
+wget https://github.com/ohwgiles/laminar/releases/download/0.5/laminar-0.6-1.x86_64.rpm
+sudo yum install laminar-0.6-1.x86_64.rpm
+```
+
+Both install packages will create a new `laminar` user and install (but not activate) a systemd service for launching the laminar daemon.
+
+## Building from source
+
+See the [development README](https://github.com/ohwgiles/laminar) for instructions for installing from source.
+
+---
+
+# Service configuration
+
+Use `systemctl start laminar` to start the laminar system service and `systemctl enable laminar` to launch it automatically on system boot.
+
+After starting the service, an empty laminar dashboard should be available at http://localhost:8080
+
+Laminar's configuration file may be found at `/etc/laminar.conf`. Laminar will start with reasonable defaults if no configuration can be found.
+
+## Running on a different HTTP port or Unix socket
+
+Edit `/etc/laminar.conf` and change `LAMINAR_BIND_HTTP` to `IPADDR:PORT`, `unix:PATH/TO/SOCKET` or `unix-abstract:SOCKETNAME`. `IPADDR` may be `*` to bind on all interfaces. The default is `*:8080`.
+
+Do not attempt to run laminar on port 80. This requires running as `root`, and Laminar will not drop privileges when executing job scripts! For a more complete integrated solution (including SSL), run laminar as a reverse proxy behind a regular webserver.
+
+## Running behind a reverse proxy
+
+Laminar relies on WebSockets to provide a responsive, auto-updating display without polling. This may require extra support from your frontend webserver.
+
+For nginx, see [NGINX Reverse Proxy](https://www.nginx.com/resources/admin-guide/reverse-proxy/) and [WebSocket proxying](http://nginx.org/en/docs/http/websocket.html).
+
+For Apache, see [Apache Reverse Proxy](https://httpd.apache.org/docs/2.4/howto/reverse_proxy.html) and [mod_proxy_wstunnel](https://httpd.apache.org/docs/2.4/mod/mod_proxy_wstunnel.html).
+
+If you use [artefacts](#Archiving-artefacts), note that Laminar is not designed as a file server, and better performance will be achieved by allowing the frontend web server to directly serve the archive directory directly (e.g. using a `Location` directive).
+
+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`.
+
+## Set the page title
+
+Change `LAMINAR_TITLE` in `/etc/laminar.conf` to your preferred page title. For further WebUI customization, consider using a [custom style sheet](#Customizing-the-WebUI).
+
+## More configuration options
+
+See the [reference section](#Service-configuration-file)
+
+---
+
+# Defining a job
+
+To create a job that downloads and compiles [GNU Hello](https://www.gnu.org/software/hello/), create the file `/var/lib/laminar/cfg/jobs/hello.run` with the following content:
+
+```bash
+#!/bin/bash -ex
+wget ftp://ftp.gnu.org/gnu/hello/hello-2.10.tar.gz
+tar xzf hello-2.10.tar.gz
+cd hello-2.10
+./configure
+make
+```
+
+Laminar uses your script's exit code to determine whether to mark the run as successful or failed. If your script is written in bash, the [`-e` option](http://tldp.org/LDP/abs/html/options.html) is helpful for this. See also [Exit and Exit Status](http://tldp.org/LDP/abs/html/exit-status.html).
+
+Don't forget to mark the script executable:
+
+```bash
+chmod +x /var/lib/laminar/cfg/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 [nodes](#Nodes-and-Tags) 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`
+
+---
+
+# 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
+```
+
+---
+
+# Customizing the WebUI
+
+If it exists, the file `/var/lib/laminar/custom/style.css` will be served by laminar and may be used to change the appearance of Laminar's WebUI.
+
+This directory is also a good place to add any extra assets needed for this customization, but note that in this case you will need to serve this directory directly from your [HTTP reverse proxy](#Service-configuration) (highly recommended).
+
+---
+
+# 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 on `$NODE`, the following scripts (relative to `$LAMINAR_HOME/cfg`) may be executed:
+
+- `jobs/$JOB.init` if the [workspace](#Data-sharing-and-Workspaces) did not exist
+- `before`
+- `nodes/$NODE.before`
+- `jobs/$JOB.before`
+- `jobs/$JOB.run`
+- `jobs/$JOB.after`
+- `nodes/$NODE.after`
+- `after`
+
+## Environment variables
+
+The following variables are available in run scripts:
+
+- `RUN` integer number of this *run*
+- `JOB` string name of this *job*
+- `RESULT` string run status: "success", "failed", etc.
+- `LAST_RESULT` string previous run status
+- `WORKSPACE` path to this job's workspace
+- `ARCHIVE` path to this run's archive
+
+In addition, `$LAMINAR_HOME/cfg/scripts` is prepended to `$PATH`. See [helper scripts](#Helper-scripts).
+
+Laminar will also export variables in the form `KEY=VALUE` found in these files:
+
+- `env`
+- `nodes/$NODE.env`
+- `jobs/$JOB.env`
+
+Finally, variables supplied on the command-line call to `laminarc queue`, `laminarc start` or `laminarc run` will be available. See [parameterized runs](#Parameterized-runs)
+
+## laminarc
+
+`laminarc` commands are:
+
+- `queue [JOB [PARAMS...]]...` adds one or more jobs to the queue with optional parameters, returning immediately.
+- `start [JOB [PARAMS...]]...` starts one or more jobs with optional parameters, returning when the jobs begin execution.
+- `run [JOB [PARAMS...]]...` triggers one or more jobs with optional parameters and waits for the completion of all jobs.
+- `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-build-centos.sh

@@ -1,41 +1,39 @@
-#!/bin/bash
+#!/bin/bash -e
 
 OUTPUT_DIR=$PWD
 
 SOURCE_DIR=$(readlink -f $(dirname ${BASH_SOURCE[0]}))
 
-VERSION=$(cd "$SOURCE_DIR" && git describe --tags --abbrev=8 --dirty)
+VERSION=$(cd "$SOURCE_DIR" && git describe --tags --abbrev=8 --dirty | tr - .)
 
-docker run --rm -i -v $SOURCE_DIR:/root/rpmbuild/SOURCES/laminar-$VERSION:ro -v $OUTPUT_DIR:/output centos bash -xe <<EOS
+DOCKER_TAG=$(docker build -q - <<EOS
+FROM centos:7
+RUN yum -y install epel-release 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
+)
 
-yum -y install epel-release
-yum -y install rpm-build cmake3 make gcc gcc-c++ wget sqlite-devel boost-devel zlib-devel
+docker run --rm -i -v $SOURCE_DIR:/root/rpmbuild/SOURCES/laminar-$VERSION:ro -v $OUTPUT_DIR:/output $DOCKER_TAG bash -xe <<EOS
+# 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/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 .
 make install
@@ -48,7 +46,7 @@ Version: $VERSION
 Release: 1
 License: GPL
 BuildRequires: systemd-units
-Requires: boost-filesystem zlib
+Requires: sqlite zlib
 
 %description
 Lightweight Continuous Integration Service
@@ -56,7 +54,7 @@ Lightweight Continuous Integration Service
 %prep
 
 %build
-cmake3 -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/ %{_sourcedir}/laminar-$VERSION
+cmake3 -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/ -DSYSTEMD_UNITDIR=%{_unitdir} %{_sourcedir}/laminar-$VERSION
 pwd
 make
 
@@ -68,6 +66,8 @@ 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

docker-build-debian.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/bin/bash -e
 
 OUTPUT_DIR=$PWD
 
@@ -6,42 +6,38 @@ SOURCE_DIR=$(readlink -f $(dirname ${BASH_SOURCE[0]}))
 
 VERSION=$(cd "$SOURCE_DIR" && git describe --tags --abbrev=8 --dirty)
 
-docker run --rm -i -v $SOURCE_DIR:/laminar:ro -v $OUTPUT_DIR:/output debian:stable bash -xe <<EOS
+DOCKER_TAG=$(docker build -q - <<EOS
+FROM debian:9-slim
+RUN apt-get update && apt-get install -y wget cmake g++ libsqlite3-dev libboost-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,7 +50,7 @@ Section:
 Priority: optional
 Architecture: amd64
 Maintainer: Oliver Giles <web ohwg net>
-Depends: libboost-filesystem1.62.0, zlib1g
+Depends: libsqlite3-0, zlib1g
 Description: Lightweight Continuous Integration Service
 EOF
 cat <<EOF > laminar/DEBIAN/postinst

docker-xbuild-debian-armhf.sh

@@ -0,0 +1,87 @@
+#!/bin/bash -e
+
+OUTPUT_DIR=$PWD
+
+SOURCE_DIR=$(readlink -f $(dirname ${BASH_SOURCE[0]}))
+
+VERSION=$(cd "$SOURCE_DIR" && git describe --tags --abbrev=8 --dirty)
+
+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
+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}
+chown -R laminar: /var/lib/laminar
+EOF
+chmod +x laminar/DEBIAN/postinst
+
+dpkg-deb --build laminar
+mv laminar.deb /output/laminar-$VERSION-1-armhf.deb
+EOS

etc/laminar.conf

@@ -33,12 +33,25 @@
 #LAMINAR_TITLE=
 
 ###
-### LAMINAR_KEEP_WORKDIR
+### LAMINAR_KEEP_RUNDIRS
 ###
-### If set (to anything), the job workdir $LAMINAR_HOME/run/$JOB/$NUM
-### will not be deleted after the run has completed
+### Setting this prevents the immediate deletion of job rundirs
+### $LAMINAR_HOME/run/$JOB/$RUN. Value should be an integer represeting
+### the number of rundirs to keep.
 ###
-#LAMINAR_KEEP_WORKDIR=1
+### Default: 0
+###
+#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
@@ -48,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

src/client.cpp

@@ -1,5 +1,5 @@
 ///
-/// Copyright 2016 Oliver Giles
+/// Copyright 2015-2018 Oliver Giles
 ///
 /// This file is part of Laminar
 ///
@@ -23,9 +23,10 @@
 
 #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
 
 template<typename T>
 static int setParams(int argc, char** argv, T& request) {
@@ -36,20 +37,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 +51,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 +87,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 +106,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 +174,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 comand %s\n", argv[1]);
-        return EINVAL;
+        fprintf(stderr, "Unknown command %s\n", argv[1]);
+        return EXIT_BAD_ARGUMENT;
     }
 
     return ret;

src/conf.cpp

@@ -1,5 +1,5 @@
 ///
-/// Copyright 2016 Oliver Giles
+/// Copyright 2015 Oliver Giles
 ///
 /// This file is part of Laminar
 ///
@@ -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

@@ -1,5 +1,5 @@
 ///
-/// Copyright 2016 Oliver Giles
+/// Copyright 2015 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_CONF_H_
-#define _LAMINAR_CONF_H_
+#ifndef LAMINAR_CONF_H_
+#define LAMINAR_CONF_H_
 
 #include <unordered_map>
 
@@ -41,4 +41,4 @@ int StringMap::convert(std::string e);
 StringMap parseConfFile(const char* path);
 
 
-#endif // _LAMINAR_CONF_H_
+#endif // LAMINAR_CONF_H_

src/database.cpp

@@ -1,5 +1,5 @@
 ///
-/// Copyright 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 2016 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_DATABASE_H_
-#define _LAMINAR_DATABASE_H_
+#ifndef LAMINAR_DATABASE_H_
+#define LAMINAR_DATABASE_H_
 
 #include <string>
 #include <functional>
@@ -52,6 +52,11 @@ private:
 
     public:
         Statement(sqlite3* db, const char* query);
+        Statement(const Statement&) =delete;
+        Statement(Statement&& other) {
+            stmt = other.stmt;
+            other.stmt = nullptr;
+        }
         ~Statement();
 
         // Bind several parameters in a single call. They are bound
@@ -98,7 +103,7 @@ private:
             }
         };
         template<typename...Args>
-        friend class FetchMarshaller;
+        friend struct FetchMarshaller;
 
         bool row();
 
@@ -114,6 +119,9 @@ private:
 
         // Bind value specializations
         void bindValue(int i, int e);
+        void bindValue(int i, uint e);
+        void bindValue(int i, long e);
+        void bindValue(int i, unsigned long e);
         void bindValue(int i, const char* e);
         void bindValue(int i, const std::string& e);
 
@@ -140,6 +148,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/interface.h

@@ -1,5 +1,5 @@
 ///
-/// Copyright 2015 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 INTERFACE_H
-#define INTERFACE_H
+#ifndef LAMINAR_INTERFACE_H_
+#define LAMINAR_INTERFACE_H_
 
 #include "run.h"
 
@@ -25,8 +25,6 @@
 #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
@@ -39,35 +37,44 @@ struct MonitorScope {
         LOG   // a run's log page
     };
 
-    MonitorScope(Type type = HOME, std::string job = std::string(), int num = 0) :
+    MonitorScope(Type type = HOME, std::string job = std::string(), uint num = 0) :
         type(type),
         job(job),
-        num(num)
+        num(num),
+        page(0),
+        field("number"),
+        order_desc(true)
     {}
 
     // whether this scope wants status information about the given job or run
-    bool wantsStatus(std::string ajob, int anum = 0) const {
+    bool wantsStatus(std::string ajob, uint anum = 0) const {
         if(type == HOME || type == ALL) return true;
         if(type == JOB) return ajob == job;
         if(type == RUN) return ajob == job && anum == num;
         return false;
     }
 
-    bool wantsLog(std::string ajob, int anum) const {
+    bool wantsLog(std::string ajob, uint anum) const {
         return type == LOG && ajob == job && anum == num;
     }
 
     Type type;
     std::string job;
-    int num = 0;
+    uint num = 0;
+    // sorting
+    uint page = 0;
+    std::string field;
+    bool order_desc;
 };
 
 // Represents a (websocket) client that wants to be notified about events
 // matching the supplied scope. Pass instances of this to LaminarInterface
 // registerClient and deregisterClient
 struct LaminarClient {
+    virtual ~LaminarClient() noexcept(false) {}
     virtual void sendMessage(std::string payload) = 0;
-    virtual void close(bool now = true) = 0;
+    // TODO: redesign
+    virtual void notifyJobFinished() {}
     MonitorScope scope;
 };
 
@@ -75,13 +82,23 @@ struct LaminarClient {
 // Pass instances of this to LaminarInterface registerWaiter and
 // deregisterWaiter
 struct LaminarWaiter {
+    virtual ~LaminarWaiter() =default;
     virtual void complete(const Run*) = 0;
 };
 
+// Represents a file mapped in memory. Used to serve artefacts
+struct MappedFile {
+    virtual ~MappedFile() =default;
+    virtual const void* address() = 0;
+    virtual size_t size() = 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 {
+    virtual ~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;
@@ -103,6 +120,13 @@ struct LaminarInterface {
     // to call LaminarWaiter::complete on invalid data
     virtual void deregisterWaiter(LaminarWaiter* waiter) = 0;
 
+    // Return the latest known number of the named job
+    virtual uint latestRun(std::string job) = 0;
+
+    // Given a job name and number, return existence and (via reference params)
+    // its current log output and whether the job is ongoing
+    virtual bool handleLogRequest(std::string name, uint num, std::string& output, bool& complete) = 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.
@@ -111,13 +135,41 @@ struct LaminarInterface {
     // Implements the laminar client interface allowing the setting of
     // arbitrary parameters on a run (usually itself) to be available in
     // the environment of subsequent scripts.
-    virtual bool setParam(std::string job, int buildNum, std::string param, std::string value) = 0;
+    virtual bool setParam(std::string job, uint buildNum, std::string param, std::string value) = 0;
+
+    // Gets the list of jobs currently waiting in the execution queue
+    virtual const std::list<std::shared_ptr<Run>>& listQueuedJobs() = 0;
+
+    // Gets the list of currently executing jobs
+    virtual const RunSet& listRunningJobs() = 0;
+
+    // Gets the list of known jobs - scans cfg/jobs for *.run files
+    virtual std::list<std::string> listKnownJobs() = 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;
+    // $LAMINAR_HOME/archive. Ideally, this would instead be served by a
+    // proper web server which handles this url.
+    virtual kj::Maybe<kj::Own<const kj::ReadableFile>> getArtefact(std::string path) = 0;
+
+    // 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.
+    virtual bool handleBadgeRequest(std::string job, std::string& badge) = 0;
+
+    // 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.
+    virtual std::string getCustomCss() = 0;
+
+    // Aborts a single job
+    virtual bool abort(std::string job, uint buildNum) = 0;
+
+    // Abort all running jobs
+    virtual void abortAll() = 0;
+
+    // Callback to handle a configuration modification notification
+    virtual void notifyConfigChanged() = 0;
 };
 
-#endif // INTERFACE_H
+#endif // LAMINAR_INTERFACE_H_
 

src/laminar.capnp

@@ -2,11 +2,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 2016 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_LAMINAR_H_
-#define _LAMINAR_LAMINAR_H_
+#ifndef LAMINAR_LAMINAR_H_
+#define LAMINAR_LAMINAR_H_
 
 #include "interface.h"
 #include "run.h"
@@ -25,9 +25,10 @@
 #include "database.h"
 
 #include <unordered_map>
+#include <kj/filesystem.h>
 
 // Node name to node object map
-typedef std::unordered_map<std::string,Node> NodeMap;
+typedef std::unordered_map<std::string, std::shared_ptr<Node>> NodeMap;
 
 struct Server;
 class Json;
@@ -38,8 +39,8 @@ class Json;
 // the LaminarClient objects (see interface.h)
 class Laminar final : public LaminarInterface {
 public:
-    Laminar();
-    ~Laminar();
+    Laminar(const char* homePath);
+    ~Laminar() noexcept override;
 
     // Runs the application forever
     void run();
@@ -52,24 +53,34 @@ public:
     void deregisterClient(LaminarClient* client) override;
     void registerWaiter(LaminarWaiter* waiter) override;
     void deregisterWaiter(LaminarWaiter* waiter) override;
+    uint latestRun(std::string job) override;
+    bool handleLogRequest(std::string name, uint num, std::string& output, bool& complete) override;
 
     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;
+    bool setParam(std::string job, uint buildNum, std::string param, std::string value) override;
+    const std::list<std::shared_ptr<Run>>& listQueuedJobs() override;
+    const RunSet& listRunningJobs() override;
+    std::list<std::string> listKnownJobs() override;
+    kj::Maybe<kj::Own<const kj::ReadableFile>> getArtefact(std::string path) override;
+    bool handleBadgeRequest(std::string job, std::string& badge) override;
+    std::string getCustomCss() override;
+    bool abort(std::string job, uint buildNum) override;
+    void abortAll() override;
+    void notifyConfigChanged() override;
 
 private:
     bool loadConfiguration();
-    void reapAdvance();
     void assignNewJobs();
-    bool stepRun(std::shared_ptr<Run> run);
+    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;
+    bool nodeCanQueue(const Node&, std::string jobName) 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;
@@ -82,11 +93,12 @@ private:
     Database* db;
     Server* srv;
     NodeMap nodes;
-    std::string homeDir;
+    kj::Path homePath;
+    kj::Own<const kj::Directory> fsHome;
     std::set<LaminarClient*> clients;
     std::set<LaminarWaiter*> waiters;
-    bool eraseWorkdir;
+    uint numKeepRunDirs;
     std::string archiveUrl;
 };
 
-#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,55 @@
 /// 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
+// 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...>) { 
+		return (struct {char buf[N+1];}) {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)
 
-#define _LBASENAME(path) strrchr(path, '/') ? strrchr(path, '/') + 1 : path
 
+// 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

@@ -1,5 +1,5 @@
 ///
-/// Copyright 2016 Oliver Giles
+/// Copyright 2015-2016 Oliver Giles
 ///
 /// This file is part of Laminar
 ///
@@ -18,8 +18,9 @@
 ///
 #include "laminar.h"
 #include "log.h"
-
 #include <signal.h>
+#include <kj/async-unix.h>
+#include <kj/filesystem.h>
 
 static Laminar* laminar;
 
@@ -34,10 +35,12 @@ int main(int argc, char** argv) {
         }
     }
 
-    laminar = new Laminar;
+    laminar = new Laminar(getenv("LAMINAR_HOME") ?: "/var/lib/laminar");
+    kj::UnixEventPort::captureChildExit();
 
     signal(SIGINT, &laminar_quit);
     signal(SIGTERM, &laminar_quit);
+
     laminar->run();
 
     delete laminar;

src/node.h

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

src/resources.cpp

@@ -1,5 +1,5 @@
 ///
-/// Copyright 2016 Oliver Giles
+/// Copyright 2015-2019 Oliver Giles
 ///
 /// This file is part of Laminar
 ///
@@ -17,37 +17,84 @@
 /// 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) \
+#define INIT_RESOURCE(route, name, content_type) \
     extern const char _binary_##name##_z_start[];\
     extern const char _binary_##name##_z_end[]; \
-    resources[route] = std::make_pair(_binary_ ## name ## _z_start, _binary_ ## name ## _z_end)
+    resources.emplace(route, Resource{_binary_ ## name ## _z_start, _binary_ ## name ## _z_end, content_type})
+
+#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_JS   "application/javascript; charset=utf-8"
+#define CONTENT_TYPE_CSS  "text/css; charset=utf-8"
+
+#define GZIP_FORMAT 16
 
 Resources::Resources()
 {
-    // TODO: Content-type
-    INIT_RESOURCE("/", index_html);
-    INIT_RESOURCE("/favicon.ico", favicon_ico);
-    INIT_RESOURCE("/favicon-152.png", favicon_152_png);
-    INIT_RESOURCE("/progress.gif", progress_gif);
-    INIT_RESOURCE("/icon.png", icon_png);
-    INIT_RESOURCE("/js/app.js", js_app_js);
-    INIT_RESOURCE("/js/Chart.HorizontalBar.js", js_Chart_HorizontalBar_js);
-    INIT_RESOURCE("/js/ansi_up.js", js_ansi_up_js);
-    INIT_RESOURCE("/js/vue.min.js", js_vue_min_js);
-    INIT_RESOURCE("/js/vue-router.min.js", js_vue_router_min_js);
-    INIT_RESOURCE("/js/ansi_up.js", js_ansi_up_js);
-    INIT_RESOURCE("/js/Chart.min.js", js_Chart_min_js);
-    INIT_RESOURCE("/js/Chart.HorizontalBar.js", js_Chart_HorizontalBar_js);
-    INIT_RESOURCE("/css/bootstrap.min.css", css_bootstrap_min_css);
+    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("/js/app.js", js_app_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("/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) {
     return strncmp(haystack.c_str(), needle, strlen(needle)) == 0;
 }
 
-bool Resources::handleRequest(std::string path, const char **start, const char **end) {
+bool Resources::handleRequest(std::string path, const char** start, const char** end, const char** content_type) {
     // need to keep the list of "application links" synchronised with the angular
     // application. We cannot return a 404 for any of these
     auto it = beginsWith(path,"/jobs")
@@ -55,8 +102,9 @@ bool Resources::handleRequest(std::string path, const char **start, const char *
             : resources.find(path);
 
     if(it != resources.end()) {
-        *start = it->second.first;
-        *end = it->second.second;
+        *start = it->second.start;
+        *end = it->second.end;
+        *content_type = it->second.content_type;
         return true;
     }
 

src/resources.h

@@ -1,5 +1,5 @@
 ///
-/// Copyright 2016 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>
@@ -30,12 +30,18 @@ public:
     Resources();
 
     // If a resource is known for the given path, set start and end to the
-    // binary data to send to the client. Function returns false if no resource
-    // for the given path is known (404)
-    bool handleRequest(std::string path, const char** start, const char** end);
+    // binary data to send to the client, and content_type to its MIME
+    // type. Function returns false if no resource for the given path exists
+    bool handleRequest(std::string path, const char** start, const char** end, const char** content_type);
 
 private:
-    std::unordered_map<std::string, std::pair<const char*, const char*>> resources;
+    struct Resource {
+        const char* start;
+        const char* end;
+        const char* content_type;
+    };
+    std::unordered_map<std::string, Resource> resources;
+    std::string index_html;
 };
 
-#endif // _LAMINAR_RESOURCES_H_
+#endif // LAMINAR_RESOURCES_H_

src/resources/index.html

@@ -6,24 +6,28 @@
  <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; }
+  .navbar { margin-bottom: 0; border-radius: 0; }
   .navbar-brand { margin: 0 -15px; padding: 7px 15px }
   .navbar-brand>img { display: inline; }
   a.navbar-btn { color: #9d9d9d; }
   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>
@@ -48,20 +114,22 @@
       <td><router-link :to="'/jobs/'+job.name">{{job.name}}</router-link> <i>queued</i></td>
      </tr>
      <tr v-for="job in jobsRunning">
-      <td><img class="spin small" src="/progress.gif"> <router-link :to="'/jobs/'+job.name">{{job.name}}</router-link> <router-link :to="'/jobs/'+job.name+'/'+job.number">#{{job.number}}</router-link> <div class="progress">
-       <div class="progress-bar progress-bar-striped" :class="'progress-bar-'+(job.overtime?'warning':'info')" :class="job.etc?'':'active'" :style="'width:'+(!job.etc?'100':job.progress)+'%'"></div>
+      <td><span v-html="runIcon(job.result)"></span> <router-link :to="'/jobs/'+job.name">{{job.name}}</router-link> <router-link :to="'/jobs/'+job.name+'/'+job.number">#{{job.number}}</router-link>
+       <small class="pull-right">{{formatDuration(job.started, job.completed)}}</small>
+       <div class="progress">
+         <div class="progress-bar progress-bar-striped" :class="'progress-bar-'+(job.overtime?'warning':'info')" :class="job.etc?'':'active'" :style="'width:'+(!job.etc?'100':job.progress)+'%'"></div>
        </div>
       </td>
      </tr>
      <tr v-for="job in jobsRecent">
-      <td><span v-html="runIcon(job.result)"></span> <router-link :to="'/jobs/'+job.name">{{job.name}}</router-link> <router-link :to="'/jobs/'+job.name+'/'+job.number">#{{job.number}}</router-link><br><small>Took {{job.duration}}s at {{formatDate(job.started)}}</small></td>
+      <td><span v-html="runIcon(job.result)"></span> <router-link :to="'/jobs/'+job.name">{{job.name}}</router-link> <router-link :to="'/jobs/'+job.name+'/'+job.number">#{{job.number}}</router-link><br><small>Took {{formatDuration(job.started, job.completed)}} at {{formatDate(job.started)}}</small></td>
      </tr>
     </table>
    </div>
    <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>
@@ -69,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>
@@ -90,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> 
@@ -107,10 +211,11 @@
      <li v-for="t in tags" :class="{'active':t==tag}"><a href v-on:click.prevent="tag = t">{{t}}</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>
+      <td class="text-center">{{formatDuration(job.started,job.completed)}}</td>
      </tr>
     </table>
    </div>
@@ -140,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><img class="spin small" src="/progress.gif"> <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">--</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">{{job.duration + " seconds"}}</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>
@@ -167,7 +285,7 @@
   <div class="container-fluid">
    <div class="row">
     <div class="col-sm-5 col-md-6 col-lg-7">
-     <h3 style="float:left"><img class="spin" src="/progress.gif" v-show="job.result === 'running'"><span v-html="runIcon(job.result)"></span> {{$route.params.name}} #{{$route.params.number}}</h3>
+     <h3 style="float:left"><span v-html="runIcon(job.result)"></span> {{$route.params.name}} #{{$route.params.number}}</h3>
      <nav class="pull-left">
       <ul class="pagination" style="margin:15px 20px">
        <li v-show="$route.params.number > 1"><router-link :to="'/jobs/'+$route.params.name+'/'+($route.params.number-1)">&laquo;</router-link></li>
@@ -177,10 +295,11 @@
      <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>
-      <dt v-show="runComplete(job)">Duration</dt><dd v-show="runComplete(job)">{{job.duration}}s</dd>
+      <dt>Duration</dt><dd>{{formatDuration(job.started, job.completed)}}</dd>
      </dl>
     </div>
     <div class="col-sm-7 col-md-6 col-lg-5">
@@ -191,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"><router-link :to="art.url" target="_self">{{art.filename}}</router-link></li>
+        <li v-for="art in job.artifacts"><a :href="art.url" target="_self">{{art.filename}}</a> [{{ art.size | iecFileSize }}]</li>
        </ul>
       </div>
      </div>
@@ -207,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,16 +2,44 @@
  * frontend application for Laminar Continuous Integration
  * https://laminar.ohwg.net
  */
+
+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 = new WebSocket("ws://" + window.location.host + path);
+    let ws = new WebSocket(document.head.baseURI.replace(/^http/,'ws') + path.substr(1));
     ws.onmessage = function(msg) {
       msg = JSON.parse(msg.data);
       // "status" is the first message the websocket 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 websocket 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.ws is used as a proxy for this.
+      if (msg.type === 'status' && (!this.comp || !this.comp.ws)) {
         next(comp => {
           // Set up bidirectional reference
           // 1. needed to reference the component for other msg types
@@ -20,6 +48,9 @@ const WebsocketHandler = function() {
           comp.ws = this;
           // Update html and nav titles
           document.title = comp.$root.title = msg.title;
+          // Calculate clock offset (used by ProgressUpdater)
+          comp.$root.clockSkew = msg.time - Math.floor((new Date()).getTime()/1000);
+          comp.$root.connected = true;
           // Component-specific callback handler
           comp[msg.type](msg.data);
         });
@@ -27,10 +58,34 @@ const WebsocketHandler = function() {
         // at this point, the component must be defined
         if (!this.comp)
           return console.error("Page component was undefined");
-        else if (typeof this.comp[msg.type] === 'function')
-          this.comp[msg.type](msg.data);
+        else {
+          this.comp.$root.showNotify(msg.type, msg.data);
+          if(typeof this.comp[msg.type] === 'function')
+            this.comp[msg.type](msg.data);
+        }
       }
     };
+    ws.onclose = function(ev) {
+      // if this.comp isn't set, this connection has never been used
+      // and a re-connection isn't meaningful
+      if(!ev.wasClean && 'comp' in this) {
+        this.comp.$root.connected = false;
+        // remove the reference to the websocket from the component.
+        // This not only cleans up an unneeded reference but ensures a
+        // status message on reconnection is treated as "first-time"
+        delete this.comp.ws;
+        this.reconnectTimeout = setTimeout(()=>{
+          var newWs = setupWebsocket(path, (fn) => { fn(this.comp); });
+          // the next() callback won't happen if the server is still
+          // unreachable. Save the reference to the last component
+          // here so we can recover if/when it does return. This means
+          // passing this.comp in the next() callback above is redundant
+          // but necessary to keep the same implementation.
+          newWs.comp = this.comp;
+        }, 2000);
+      }
+    }
+    return ws;
   };
   return {
     beforeRouteEnter(to, from, next) {
@@ -38,19 +93,29 @@ const WebsocketHandler = function() {
     },
     beforeRouteUpdate(to, from, next) {
       this.ws.close();
+      clearTimeout(this.ws.reconnectTimeout);
       setupWebsocket(to.path, (fn) => { fn(this); next(); });
     },
     beforeRouteLeave(to, from, next) {
       this.ws.close();
+      clearTimeout(this.ws.reconnectTimeout);
       next();
-    },
+    }
   };
 }();
 
 const Utils = {
   methods: {
     runIcon(result) {
-      return result === "success" ? '<span style="color:forestgreen;font-family:\'Zapf Dingbats\';">✔</span>' : result === "failed" || result === "aborted" ? '<span style="color:crimson;">✘</span>' : '';
+      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
@@ -63,6 +128,16 @@ const Utils = {
         ][d.getMonth()] + ' ' +
         d.getFullYear();
     },
+    formatDuration: function(start, end) {
+      if(!end)
+        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)
+        return Math.floor((end-start)/60) + ' minutes, ' + ((end-start)%60) + ' seconds';
+      else
+        return (end-start) + ' seconds';
+    }
   }
 };
 
@@ -71,7 +146,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) {
@@ -106,14 +181,15 @@ 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();
   }
 
@@ -128,72 +204,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,
-              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: "darkseagreen",
-            strokeColor: "forestgreen",
-            data: msg.buildsPerDay.map(function(e) {
-              return e.success || 0;
-            })
-          }, {
-            label: "Failed Bulids",
-            fillColor: "darksalmon",
-            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);
@@ -207,9 +396,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) {
@@ -222,9 +411,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;
           }
@@ -243,12 +432,80 @@ const Jobs = function() {
   };
   return {
     template: '#jobs',
-    mixins: [WebsocketHandler, Utils],
+    mixins: [WebsocketHandler, Utils, ProgressUpdater],
     data: function() { return state; },
-    computed: {
-      filteredJobs() {
-        var ret = this.jobs;
-        var tag = this.tag;
+    methods: {
+      status: function(msg) {
+        state.jobs = msg.jobs;
+        state.jobsRunning = msg.running;
+        // mix running and completed jobs
+        for (var i in msg.running) {
+          var idx = state.jobs.findIndex(job => job.name === msg.running[i].name);
+          if (idx > -1)
+            state.jobs[idx] = msg.running[i];
+          else {
+            // special case: first run of a job.
+            state.jobs.unshift(msg.running[i]);
+            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);
+      },
+      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;
+            break;
+          }
+        }
+        if (updAt === null) {
+          state.jobsRunning.unshift(data);
+        } else {
+          state.jobsRunning[updAt] = data;
+        }
+        updAt = null;
+        for (var i in state.jobs) {
+          if (state.jobs[i].name === data.name) {
+            updAt = i;
+            break;
+          }
+        }
+        if (updAt === null) {
+          // 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;});
+        } else {
+          state.jobs[updAt] = data;
+        }
+        this.$forceUpdate();
+      },
+      job_completed: function(data) {
+        for (var i in state.jobs) {
+          if (state.jobs[i].name === data.name) {
+            state.jobs[i] = data;
+            // forceUpdate in second loop
+            break;
+          }
+        }
+        for (var i in state.jobsRunning) {
+          if (state.jobsRunning[i].name === data.name) {
+            state.jobsRunning.splice(i, 1);
+            this.$forceUpdate();
+            break;
+          }
+        }
+      },
+      filteredJobs: function() {
+        var ret = state.jobs;
+        var tag = state.tag;
         if (tag) {
           ret = ret.filter(function(job) {
             return job.tags.indexOf(tag) >= 0;
@@ -261,28 +518,7 @@ const Jobs = function() {
           });
         }
         return ret;
-      }
-    },
-    methods: {
-      status: function(msg) {
-        state.jobs = msg.jobs;
-        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);
       },
-      job_completed: function(data) {
-        for (var i in state.jobs) {
-          if (state.jobs[i].name === data.name) {
-            state.jobs[i] = data;
-            this.$forceUpdate();
-            break;
-          }
-        }
-      }
     }
   };
 }();
@@ -294,10 +530,13 @@ var Job = function() {
     lastSuccess: null,
     lastFailed: null,
     nQueued: 0,
+    pages: 0,
+    sort: {}
   };
+  var chtBt = null;
   return Vue.extend({
     template: '#job',
-    mixins: [WebsocketHandler, Utils],
+    mixins: [WebsocketHandler, Utils, ProgressUpdater],
     data: function() {
       return state;
     },
@@ -307,32 +546,71 @@ var Job = function() {
         state.jobsRecent = msg.recent;
         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.duration;
-            }).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++;
@@ -353,28 +631,62 @@ var Job = function() {
             break;
           }
         }
+      },
+      page_next: function() {
+        state.sort.page++;
+        this.ws.send(JSON.stringify(state.sort));
+      },
+      page_prev: function() {
+        state.sort.page--;
+        this.ws.send(JSON.stringify(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.ws.send(JSON.stringify(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',
@@ -384,19 +696,25 @@ const Run = function() {
     },
     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;
-        if (!!state.job.etc)
-          state.jobsRunning = [data];
+        state.jobsRunning = [data];
       },
       job_started: function(data) {
         state.latestNum++;
         this.$forceUpdate();
       },
       job_completed: function(data) {
-        state.job = data;
+        state.job = Object.assign(state.job, data);
         state.jobsRunning = [];
         this.$forceUpdate();
       },
@@ -406,35 +724,78 @@ const Run = function() {
     },
     beforeRouteEnter(to, from, next) {
       next(vm => {
-        vm.logws = new WebSocket("ws://" + location.host + 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 = new WebSocket("ws://" + location.host + 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/run.cpp

@@ -1,5 +1,5 @@
 ///
-/// Copyright 2016 Oliver Giles
+/// Copyright 2015-2018 Oliver Giles
 ///
 /// This file is part of Laminar
 ///
@@ -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,227 @@ 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>())
+{
+    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<Node> 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());
+    // per-node before-run script
+    if(fsHome.exists(cfgDir/"nodes"/(nd->name+".before")))
+        addScript(cfgDir/"nodes"/(nd->name+".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);
+    // per-node after-run script
+    if(fsHome.exists(cfgDir/"nodes"/(nd->name+".after")))
+        addScript(cfgDir/"nodes"/(nd->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/"nodes"/(nd->name+".env")))
+        addEnv(cfgDir/"nodes"/(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;
+    node = 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);
+        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", (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
 }

src/run.h

@@ -1,5 +1,5 @@
 ///
-/// Copyright 2016 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,9 @@
 #include <functional>
 #include <ostream>
 #include <unordered_map>
+#include <memory>
+#include <kj/async.h>
+#include <kj/filesystem.h>
 
 enum class RunState {
     UNKNOWN,
@@ -39,31 +42,27 @@ std::string to_string(const RunState& rs);
 
 class Node;
 
-// 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 node
+    bool configure(uint buildNum, std::shared_ptr<Node> node, 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 +70,41 @@ public:
 
     std::string reason() const;
 
-    std::function<void(Run*)> notifyCompletion;
-    Node* node;
+    kj::Promise<void>&& whenStarted() { return kj::mv(started.promise); }
+
+    std::shared_ptr<Node> node;
     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;
 };
 
 
@@ -126,13 +131,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 +150,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 2016 Oliver Giles
+/// Copyright 2015-2019 Oliver Giles
 ///
 /// This file is part of Laminar
 ///
@@ -26,36 +26,20 @@
 #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 <sys/eventfd.h>
+#include <sys/inotify.h>
+#include <sys/signal.h>
+#include <sys/signalfd.h>
+
+#include <rapidjson/document.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
@@ -83,38 +67,47 @@ public:
         laminar.registerWaiter(this);
     }
 
-    ~RpcImpl() {
+    ~RpcImpl() override {
         laminar.deregisterWaiter(this);
     }
 
-    // Start a job, without waiting for it to finish
-    kj::Promise<void> trigger(TriggerContext context) override {
+    // Queue a job, without waiting for it to start
+    kj::Promise<void> queue(QueueContext context) override {
         std::string jobName = context.getParams().getJobName();
-        LLOG(INFO, "RPC trigger", jobName);
-        ParamMap params;
-        for(auto p : context.getParams().getParams()) {
-            params[p.getName().cStr()] = p.getValue().cStr();
-        }
-        LaminarCi::MethodResult result = laminar.queueJob(jobName, params)
+        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 and wait for the result
+    // Start a job, without waiting for it to finish
     kj::Promise<void> start(StartContext context) override {
         std::string jobName = context.getParams().getJobName();
         LLOG(INFO, "RPC start", jobName);
-        ParamMap params;
-        for(auto p : context.getParams().getParams()) {
-            params[p.getName().cStr()] = p.getValue().cStr();
+        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;
         }
-        std::shared_ptr<Run> run = laminar.queueJob(jobName, params);
+    }
+
+    // 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(const Run* r = run.get()) {
             runWaiters[r].emplace_back(kj::newPromiseAndFulfiller<RunState>());
-            return runWaiters[r].back().promise.then([context](RunState state) mutable {
+            return runWaiters[r].back().promise.then([context,run](RunState state) mutable {
                 context.getResults().setResult(fromRunState(state));
+                context.getResults().setBuildNum(run->build);
             });
         } else {
             context.getResults().setResult(LaminarCi::JobResult::UNKNOWN);
@@ -124,8 +117,8 @@ public:
 
     // Set a parameter on a running build
     kj::Promise<void> set(SetContext context) override {
-        std::string jobName = context.getParams().getJobName();
-        int buildNum = context.getParams().getBuildNum();
+        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,
@@ -136,32 +129,62 @@ public:
         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;
+    // 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);
         }
-        lockList.erase(lockList.begin());
-        if(lockList.size() > 0)
-            lockList.front().fulfiller->fulfill();
         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;
+    }
+
     // Implements LaminarWaiter::complete
     void complete(const Run* r) override {
         for(kj::PromiseFulfillerPair<RunState>& w : runWaiters[r])
@@ -170,114 +193,275 @@ private:
     }
 private:
     LaminarInterface& laminar;
-    kj::LowLevelAsyncIoProvider* asyncio;
-    std::unordered_map<std::string, std::list<kj::PromiseFulfillerPair<void>>> locks;
     std::unordered_map<const Run*, std::list<kj::PromiseFulfillerPair<RunState>>> runWaiters;
 };
 
-
-// This is the implementation of the HTTP/Websocket interface. It exposes
+// This is the implementation of the HTTP/Websocket interface. It creates
 // 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 {
+class HttpImpl : public kj::HttpService {
 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;
-            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)) {
-                c->set_status(websocketpp::http::status_code::ok);
-                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;
-    }
+    HttpImpl(LaminarInterface& laminar, kj::HttpHeaderTable&tbl) :
+        laminar(laminar),
+        responseHeaders(tbl)
+    {}
+    virtual ~HttpImpl() {}
 
 private:
-    Resources resources;
+    class HttpChunkedClient : public LaminarClient {
+    public:
+        HttpChunkedClient(LaminarInterface& laminar) :
+            laminar(laminar)
+        {}
+        ~HttpChunkedClient() override {
+            laminar.deregisterClient(this);
+        }
+        void sendMessage(std::string payload) override {
+            chunks.push_back(kj::mv(payload));
+            fulfiller->fulfill();
+        }
+        void notifyJobFinished() override {
+            done = true;
+            fulfiller->fulfill();
+        }
+        LaminarInterface& laminar;
+        std::list<std::string> chunks;
+        // cannot use chunks.empty() because multiple fulfill()s
+        // could be coalesced
+        bool done = false;
+        kj::Own<kj::PromiseFulfiller<void>> fulfiller;
+    };
+
+    // Implements LaminarClient and holds the Websocket connection object.
+    // Automatically destructed when the promise created in request() resolves
+    // or is cancelled
+    class WebsocketClient : public LaminarClient {
+    public:
+        WebsocketClient(LaminarInterface& laminar, kj::Own<kj::WebSocket>&& ws) :
+            laminar(laminar),
+            ws(kj::mv(ws))
+        {}
+        ~WebsocketClient() override {
+            laminar.deregisterClient(this);
+        }
+        virtual void sendMessage(std::string payload) override {
+            messages.emplace_back(kj::mv(payload));
+            // sendMessage might be called several times before the event loop
+            // gets a chance to act on the fulfiller. So store the payload here
+            // where it can be fetched later and don't pass the payload with the
+            // fulfiller because subsequent calls to fulfill() are ignored.
+            fulfiller->fulfill();
+        }
+        LaminarInterface& laminar;
+        kj::Own<kj::WebSocket> ws;
+        std::list<std::string> messages;
+        kj::Own<kj::PromiseFulfiller<void>> fulfiller;
+    };
+
+    kj::Promise<void> websocketRead(WebsocketClient& lc)
+    {
+        return lc.ws->receive().then([&lc,this](kj::WebSocket::Message&& message) {
+            KJ_SWITCH_ONEOF(message) {
+                KJ_CASE_ONEOF(str, kj::String) {
+                    rapidjson::Document d;
+                    d.ParseInsitu(const_cast<char*>(str.cStr()));
+                    if(d.HasMember("page") && d["page"].IsInt() && d.HasMember("field") && d["field"].IsString() && d.HasMember("order") && d["order"].IsString()) {
+                        lc.scope.page = d["page"].GetInt();
+                        lc.scope.field = d["field"].GetString();
+                        lc.scope.order_desc = strcmp(d["order"].GetString(), "dsc") == 0;
+                        laminar.sendStatus(&lc);
+                        return websocketRead(lc);
+                    }
+                }
+                KJ_CASE_ONEOF(close, kj::WebSocket::Close) {
+                    // clean socket shutdown
+                    return lc.ws->close(close.code, close.reason);
+                }
+                KJ_CASE_ONEOF_DEFAULT {}
+            }
+            // unhandled/unknown message
+            return lc.ws->disconnect();
+        }, [](kj::Exception&& e){
+            // server logs suggest early catching here avoids fatal exception later
+            // TODO: reproduce in unit test
+            LLOG(WARNING, e.getDescription());
+            return kj::READY_NOW;
+        });
+    }
+
+    kj::Promise<void> websocketWrite(WebsocketClient& lc)
+    {
+        auto paf = kj::newPromiseAndFulfiller<void>();
+        lc.fulfiller = kj::mv(paf.fulfiller);
+        return paf.promise.then([this,&lc]{
+            kj::Promise<void> p = kj::READY_NOW;
+            std::list<std::string> messages = kj::mv(lc.messages);
+            for(std::string& s : messages) {
+                p = p.then([&s,&lc]{
+                    kj::String str = kj::str(s);
+                    return lc.ws->send(str).attach(kj::mv(str));
+                });
+            }
+            return p.attach(kj::mv(messages)).then([this,&lc]{
+                return websocketWrite(lc);
+            });
+        });
+    }
+
+    kj::Promise<void> websocketUpgraded(WebsocketClient& lc, std::string resource) {
+        // convert the requested URL to a MonitorScope
+        if(resource.substr(0, 5) == "/jobs") {
+            if(resource.length() == 5) {
+                lc.scope.type = MonitorScope::ALL;
+            } else {
+                resource = resource.substr(5);
+                size_t split = resource.find('/',1);
+                std::string job = resource.substr(1,split-1);
+                if(!job.empty()) {
+                    lc.scope.job = job;
+                    lc.scope.type = MonitorScope::JOB;
+                }
+                if(split != std::string::npos) {
+                    size_t split2 = resource.find('/', split+1);
+                    std::string run = resource.substr(split+1, split2-split);
+                    if(!run.empty()) {
+                        lc.scope.num = static_cast<uint>(atoi(run.c_str()));
+                        lc.scope.type = MonitorScope::RUN;
+                    }
+                    if(split2 != std::string::npos && resource.compare(split2, 4, "/log") == 0) {
+                        lc.scope.type = MonitorScope::LOG;
+                    }
+                }
+            }
+        }
+        laminar.registerClient(&lc);
+        kj::Promise<void> connection = websocketRead(lc).exclusiveJoin(websocketWrite(lc));
+        // registerClient can happen after a successful websocket handshake.
+        // However, the connection might not be closed gracefully, so the
+        // corresponding deregister operation happens in the WebsocketClient
+        // destructor rather than the close handler or a then() clause
+        laminar.sendStatus(&lc);
+        return connection;
+    }
+
+    // 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 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> writeLogChunk(HttpChunkedClient* client, kj::AsyncOutputStream* stream) {
+        auto paf = kj::newPromiseAndFulfiller<void>();
+        client->fulfiller = kj::mv(paf.fulfiller);
+        return paf.promise.then([=]{
+            kj::Promise<void> p = kj::READY_NOW;
+            std::list<std::string> chunks = kj::mv(client->chunks);
+            for(std::string& s : chunks) {
+                p = p.then([=,&s]{
+                    return stream->write(s.data(), s.size());
+                });
+            }
+            return p.attach(kj::mv(chunks)).then([=]{
+                return client->done ? kj::Promise<void>(kj::READY_NOW) : writeLogChunk(client, stream);
+            });
+        });
+    }
+
+    virtual kj::Promise<void> request(kj::HttpMethod method, kj::StringPtr url, const kj::HttpHeaders& headers,
+            kj::AsyncInputStream& requestBody, Response& response) override
+    {
+        if(headers.isWebSocket()) {
+            responseHeaders.clear();
+            kj::Own<WebsocketClient> lc = kj::heap<WebsocketClient>(laminar, response.acceptWebSocket(responseHeaders));
+            return websocketUpgraded(*lc, url.cStr()).attach(kj::mv(lc));
+        } else {
+            // handle regular HTTP request
+            const char* start, *end, *content_type;
+            std::string badge;
+            // for log requests
+            std::string name;
+            uint num;
+            responseHeaders.clear();
+            // 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.
+            // Since we currently don't handle any query parameters at all, the easiest way
+            // to achieve this is unconditionally remove all query parameters from the request.
+            // This will need to be redone if we ever accept query parameters, which probably
+            // will happen as part of issue #90.
+            KJ_IF_MAYBE(queryIdx, url.findFirst('?')) {
+                const_cast<char*>(url.begin())[*queryIdx] = '\0';
+                url = url.begin();
+            }
+            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)) {
+                kj::Own<HttpChunkedClient> cc = kj::heap<HttpChunkedClient>(laminar);
+                cc->scope.job = name;
+                cc->scope.num = num;
+                bool complete;
+                std::string output;
+                cc->scope.type = MonitorScope::LOG;
+                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);
+                    laminar.registerClient(cc.get());
+                    return stream->write(output.data(), output.size()).then([=,s=stream.get(),c=cc.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(cc));
+                }
+            } 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);
+        }
+    }
+
     LaminarInterface& laminar;
-    websocket wss;
+    Resources resources;
+    kj::HttpHeaders responseHeaders;
 };
 
 // Context for an RPC connection
@@ -295,172 +479,131 @@ struct RpcConnection {
     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)),
+    laminarInterface(li),
     ioContext(kj::setupAsyncIo()),
-    tasks(*this)
+    headerTable(),
+    httpService(kj::heap<HttpImpl>(li, headerTable)),
+    httpServer(kj::heap<kj::HttpServer>(ioContext.provider->getTimer(), headerTable, *httpService)),
+    listeners(kj::heap<kj::TaskSet>(*this)),
+    childTasks(*this),
+    httpConnections(*this),
+    httpReady(kj::newPromiseAndFulfiller<void>())
 {
     // RPC task
     if(rpcBindAddress.startsWith("unix:"))
         unlink(rpcBindAddress.slice(strlen("unix:")).cStr());
-    tasks.add(ioContext.provider->getNetwork().parseAddress(rpcBindAddress)
+    listeners->add(ioContext.provider->getNetwork().parseAddress(rpcBindAddress)
               .then([this](kj::Own<kj::NetworkAddress>&& addr) {
-        acceptRpcClient(addr->listen());
+        return acceptRpcClient(addr->listen());
     }));
 
     // HTTP task
     if(httpBindAddress.startsWith("unix:"))
         unlink(httpBindAddress.slice(strlen("unix:")).cStr());
-    tasks.add(ioContext.provider->getNetwork().parseAddress(httpBindAddress)
+    listeners->add(ioContext.provider->getNetwork().parseAddress(httpBindAddress)
               .then([this](kj::Own<kj::NetworkAddress>&& addr) {
-        acceptHttpClient(addr->listen());
+        // TODO: a better way? Currently used only for testing
+        httpReady.fulfiller->fulfill();
+        kj::Own<kj::ConnectionReceiver> listener = addr->listen();
+        return httpServer->listenHttp(*listener).attach(kj::mv(listener));
     }));
+
+    // handle watched paths
+    {
+        inotify_fd = inotify_init1(IN_NONBLOCK | IN_CLOEXEC);
+        pathWatch = readDescriptor(inotify_fd, [this](const char*, size_t){
+            laminarInterface.notifyConfigChanged();
+        });
+    }
 }
 
 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...
-    efd_quit = eventfd(0,0);
-    kj::Promise<void> quit = kj::evalLater([this](){
+    // 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::evalLater([this](){
         static uint64_t _;
         auto wakeEvent = ioContext.lowLevelProvider->wrapInputFd(efd_quit);
         return wakeEvent->read(&_, sizeof(uint64_t)).attach(std::move(wakeEvent));
-    });
-    quit.wait(ioContext.waitScope);
+    }).wait(ioContext.waitScope);
+    // Execution arrives here when the eventfd is triggered (in stop())
+
+    // Shutdown sequence:
+    // 1. stop accepting new connections
+    listeners = nullptr;
+    // 2. abort current jobs. Most of the time this isn't necessary since
+    // systemd stop or other kill mechanism will send SIGTERM to the whole
+    // process group.
+    laminarInterface.abortAll();
+    // 3. wait for all children to close
+    childTasks.onEmpty().wait(ioContext.waitScope);
+    // 4. run the loop once more to send any pending output to websocket clients
+    ioContext.waitScope.poll();
+    // 5. return: websockets will be destructed 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(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);
-    tasks.add(handleFdRead(event, cb).attach(std::move(event)));
+    auto buffer = kj::heapArrayBuilder<char>(PROC_IO_BUFSIZE);
+    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));
+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);
+}
+
+void Server::addWatchPath(const char* dpath) {
+    inotify_add_watch(inotify_fd, dpath, IN_ONLYDIR | IN_CLOSE_WRITE | IN_CREATE | IN_DELETE);
+}
+
+kj::Promise<void> Server::acceptRpcClient(kj::Own<kj::ConnectionReceiver>&& listener) {
+    kj::ConnectionReceiver& cr = *listener.get();
+    return cr.accept().then(kj::mvCapture(kj::mv(listener),
+        [this](kj::Own<kj::ConnectionReceiver>&& listener, kj::Own<kj::AsyncIoStream>&& connection) {
             auto server = kj::heap<RpcConnection>(kj::mv(connection), rpcInterface, capnp::ReaderOptions());
-            tasks.add(server->network.onDisconnect().attach(kj::mv(server)));
-        }))
-    );
+            childTasks.add(server->network.onDisconnect().attach(kj::mv(server)));
+            return acceptRpcClient(kj::mv(listener));
+        }));
 }
 
 // returns a promise which will read a chunk of data from the file descriptor
 // wrapped by stream and invoke the provided callback with the read data.
 // Repeats until ::read returns <= 0
-kj::Promise<void> Server::handleFdRead(kj::AsyncInputStream* stream, std::function<void(char*,size_t)> cb) {
-    static char* buffer = new char[PROC_IO_BUFSIZE];
-    return stream->tryRead(buffer, 1, PROC_IO_BUFSIZE).then([this,stream,cb](size_t sz) {
+kj::Promise<void> Server::handleFdRead(kj::AsyncInputStream* stream, char* buffer, std::function<void(const char*,size_t)> cb) {
+    return stream->tryRead(buffer, 1, PROC_IO_BUFSIZE).then([this,stream,buffer,cb](size_t sz) {
         if(sz > 0) {
             cb(buffer, sz);
-            return handleFdRead(stream, cb);
+            return handleFdRead(stream, kj::mv(buffer), cb);
         }
         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

@@ -1,5 +1,5 @@
 ///
-/// Copyright 2016 Oliver Giles
+/// Copyright 2015-2017 Oliver Giles
 ///
 /// This file is part of Laminar
 ///
@@ -16,10 +16,11 @@
 /// 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>
@@ -41,26 +42,41 @@ public:
 
     // 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(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);
+    // add a path to be watched for changes
+    void addWatchPath(const char* dpath);
 
 private:
-    void acceptHttpClient(kj::Own<kj::ConnectionReceiver>&& listener);
-    void acceptRpcClient(kj::Own<kj::ConnectionReceiver>&& listener);
-    kj::Promise<void> handleFdRead(kj::AsyncInputStream* stream, std::function<void(char*,size_t)> cb);
+    kj::Promise<void> acceptRpcClient(kj::Own<kj::ConnectionReceiver>&& listener);
+    kj::Promise<void> handleFdRead(kj::AsyncInputStream* stream, char* buffer, std::function<void(const char*,size_t)> cb);
 
-    void taskFailed(kj::Exception&& exception) override {
-        kj::throwFatalException(kj::mv(exception));
-    }
+    void taskFailed(kj::Exception&& exception) override;
 
 private:
-    struct WebsocketConnection;
-    struct HttpImpl;
-
     int efd_quit;
     capnp::Capability::Client rpcInterface;
-    HttpImpl* httpInterface;
+    LaminarInterface& laminarInterface;
     kj::AsyncIoContext ioContext;
-    kj::TaskSet tasks;
+    kj::HttpHeaderTable headerTable;
+    kj::Own<kj::HttpService> httpService;
+    kj::Own<kj::HttpServer> httpServer;
+    kj::Own<kj::TaskSet> listeners;
+    kj::TaskSet childTasks;
+    kj::TaskSet httpConnections;
+    kj::Maybe<kj::Promise<void>> reapWatch;
+    int inotify_fd;
+    kj::Maybe<kj::Promise<void>> pathWatch;
+
+    // TODO: restructure so this isn't necessary
+    friend class ServerTest;
+    kj::PromiseFulfillerPair<void> httpReady;
 };
 
-#endif // _LAMINAR_SERVER_H_
+#endif // LAMINAR_SERVER_H_

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

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

test/test-database.cpp

@@ -0,0 +1,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/test-laminar.cpp

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

test/test-run.cpp

@@ -0,0 +1,133 @@
+///
+/// Copyright 2018 Oliver Giles
+///
+/// This file is part of Laminar
+///
+/// Laminar is free software: you can redistribute it and/or modify
+/// it under the terms of the GNU General Public License as published by
+/// the Free Software Foundation, either version 3 of the License, or
+/// (at your option) any later version.
+///
+/// Laminar is distributed in the hope that it will be useful,
+/// but WITHOUT ANY WARRANTY; without even the implied warranty of
+/// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+/// GNU General Public License for more details.
+///
+/// You should have received a copy of the GNU General Public License
+/// along with Laminar.  If not, see <http://www.gnu.org/licenses/>
+///
+#include <gtest/gtest.h>
+#include "run.h"
+#include "log.h"
+#include "node.h"
+#include "conf.h"
+#include "tempdir.h"
+
+class RunTest : public testing::Test {
+protected:
+    RunTest() :
+        testing::Test(),
+        node(std::make_shared<Node>()),
+        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<Node> node;
+    TempDir tmp;
+    class Run run;
+
+    void setRunLink(const char* path) {
+        tmp.fs->symlink(kj::Path{"cfg","jobs",run.name+".run"}, path, kj::WriteMode::CREATE|kj::WriteMode::CREATE_PARENT|kj::WriteMode::EXECUTABLE);
+    }
+};
+
+TEST_F(RunTest, WorkingDirectory) {
+    setRunLink("/bin/pwd");
+    run.configure(1, node, *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("/bin/true");
+    run.configure(1, node, *tmp.fs);
+    runAll();
+    EXPECT_EQ(RunState::SUCCESS, run.result);
+}
+
+TEST_F(RunTest, FailedStatus) {
+    setRunLink("/bin/false");
+    run.configure(1, node, *tmp.fs);
+    runAll();
+    EXPECT_EQ(RunState::FAILED, run.result);
+}
+
+TEST_F(RunTest, Environment) {
+    setRunLink("/usr/bin/env");
+    run.configure(1234, node, *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("/usr/bin/env");
+    run.params["foo"] = "bar";
+    run.configure(1, node, *tmp.fs);
+    runAll();
+    StringMap map = parseFromString(readAllOutput());
+    EXPECT_EQ("bar", map["foo"]);
+}
+
+TEST_F(RunTest, Abort) {
+    setRunLink("/usr/bin/yes");
+    run.configure(1, node, *tmp.fs);
+    run.step();
+    usleep(200); // TODO fix
+    run.abort(false);
+    wait();
+    EXPECT_EQ(RunState::ABORTED, run.result);
+}
+

test/test-server.cpp

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