Initial version.release/1

20 files changed, 349 insertions, 0 deletions

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..a01d365
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,8 @@
+/debian/.debhelper/
+/debian/debhelper-build-stamp
+/debian/files
+/debian/olamic.postrm.debhelper
+/debian/olamic.substvars
+/debian/olamic/
+/man/olamic-enqueue.1
+/man/olamic-worker.1
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..fc29c78
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,8 @@
+MANPAGES := $(basename $(wildcard man/*.md))
+
+build: ${MANPAGES}
+
+.PHONY: build
+
+%: %.md
+        pandoc -s -t man -o $@ $<
diff --git a/debian/changelog b/debian/changelog
new file mode 100644
index 0000000..695c208
--- /dev/null
+++ b/debian/changelog
@@ -0,0 +1,5 @@
+olamic (1) unstable; urgency=medium
+
+  * Initial version.
+
+ -- Julian Blake Kongslie <jblake@jblake.org>  Fri, 30 Oct 2020 16:18:52 -0700
diff --git a/debian/compat b/debian/compat
new file mode 100644
index 0000000..b4de394
--- /dev/null
+++ b/debian/compat
@@ -0,0 +1 @@
+11
diff --git a/debian/control b/debian/control
new file mode 100644
index 0000000..37a7e6b
--- /dev/null
+++ b/debian/control
@@ -0,0 +1,15 @@
+Source: olamic
+Section: devel
+Priority: optional
+Maintainer: Julian Blake Kongslie <jblake@jblake.org>
+Build-Depends: debhelper (>= 11), pandoc
+Standards-Version: 4.1.3
+
+Package: olamic
+Architecture: all
+Depends: ${misc:Depends}, ${shlibs:Depends}, git, default-mta | mail-transport-agent
+Description: Very simple continuous integration for git
+ Olamic is a continuous integration system written in bash designed to support
+ the needs of basic projects without involving a web server or anything like
+ that. It supports multiple worker nodes, but does not support dependencies or
+ ordering between tasks.
diff --git a/debian/copyright b/debian/copyright
new file mode 100644
index 0000000..c2d763c
--- /dev/null
+++ b/debian/copyright
@@ -0,0 +1,7 @@
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Upstream-Name: olamic
+
+Files: *
+Copyright: 2020 Julian Blake Kongslie
+License: GPL-2
+ See /usr/share/common-licenses/GPL-2
diff --git a/debian/gbp.conf b/debian/gbp.conf
new file mode 100644
index 0000000..1b36eba
--- /dev/null
+++ b/debian/gbp.conf
@@ -0,0 +1,3 @@
+[dch]
+debian-branch = main
+debian-tag = release/%(version)s
diff --git a/debian/manpages b/debian/manpages
new file mode 100644
index 0000000..d87b5e9
--- /dev/null
+++ b/debian/manpages
@@ -0,0 +1,2 @@
+man/olamic-enqueue.1
+man/olamic-worker.1
diff --git a/debian/olamic.install b/debian/olamic.install
new file mode 100644
index 0000000..6becfd7
--- /dev/null
+++ b/debian/olamic.install
@@ -0,0 +1,4 @@
+examples /usr/share/doc/olamic
+olamic-enqueue /usr/bin
+olamic-worker /usr/bin
+pick-task /usr/share/olamic
diff --git a/debian/olamic.service b/debian/olamic.service
new file mode 100644
index 0000000..0c36feb
--- /dev/null
+++ b/debian/olamic.service
@@ -0,0 +1,11 @@
+[Unit]
+Description=Olamic worker
+
+[Service]
+Type=simple
+User=olamic
+WorkingDirectory=/srv/olamic
+ExecStart=/usr/bin/olamic-worker
+
+[Install]
+WantedBy=multi-user.target
diff --git a/debian/rules b/debian/rules
new file mode 100755
index 0000000..2d33f6a
--- /dev/null
+++ b/debian/rules
@@ -0,0 +1,4 @@
+#!/usr/bin/make -f
+
+%:
+        dh $@
diff --git a/debian/source/format b/debian/source/format
new file mode 100644
index 0000000..89ae9db
--- /dev/null
+++ b/debian/source/format
@@ -0,0 +1 @@
+3.0 (native)
diff --git a/examples/olamic-githook-post-receive b/examples/olamic-githook-post-receive
new file mode 100755
index 0000000..3135d0d
--- /dev/null
+++ b/examples/olamic-githook-post-receive
@@ -0,0 +1,23 @@
+#!/bin/bash
+
+set -eu
+
+OLAMIC_QUEUE_HOST="${OLAMIC_QUEUE_HOST:-}"
+OLAMIC_QUEUE_DIR="${OLAMIC_QUEUE_DIR:-/srv/olamic/queue}"
+OLAMIC_GIT_REPO="${OLAMIC_GIT_REPO:-"$(git rev-parse --absolute-git-dir)"}"
+
+while read OLD NEW REF; do
+    if git rev-parse --quiet --verify "$NEW":olamic-run > /dev/null; then
+        OLAMIC_EMAIL="$(git show --no-patch --format=%ae "$NEW")"
+        echo -n "Enqueuing olamic run for $REF: "
+        if [[ "$OLAMIC_QUEUE_HOST" == "" ]]; then
+            olamic-enqueue "$OLAMIC_QUEUE_DIR" "$OLAMIC_GIT_REPO" "$NEW" GIT_REF="$REF" OLAMIC_EMAIL="$OLAMIC_EMAIL" <<END
+. ./olamic-run
+END
+        else
+            ssh "$OLAMIC_QUEUE_HOST" olamic-enqueue "$OLAMIC_QUEUE_DIR" "$OLAMIC_GIT_REPO" "$NEW" GIT_REF="$REF" OLAMIC_EMAIL="$OLAMIC_EMAIL" <<END
+. ./olamic-run
+END
+        fi
+    fi
+done
diff --git a/examples/olamic-run b/examples/olamic-run
new file mode 100644
index 0000000..eebcfb5
--- /dev/null
+++ b/examples/olamic-run
@@ -0,0 +1,25 @@
+# vim: set ft=bash :
+
+# This is an example olamic-run script for a "typical" app
+# Olamic scripts are run under /bin/bash with "set -eux -o pipefail" in effect
+
+# Variables provided by olamic
+#   GIT_OBJECT  The git commit that was cloned
+#   GIT_REF     The ref that triggered this run (post-receive hook)
+#   GIT_REPO    The path to the git repo
+#   TASK_ID     UUID for this olamic run
+
+make
+make test
+
+if [[ $GIT_REF =~ ^refs/tags/(.+)$ ]]; then
+    INSTALL_DIR=/srv/app/tag/"${BASH_REMATCH[1]}"
+elif [[ $GIT_REF =~ ^refs/heads/(.+)$ ]]; then
+    INSTALL_DIR=/srv/app/branch/"${BASH_REMATCH[1]}"
+fi
+
+if [[ "${INSTALL_DIR:-}" != "" ]]; then
+    rm -rf "$INSTALL_DIR"
+    mkdir -p "$INSTALL_DIR"
+    make install PREFIX="$INSTALL_DIR"
+fi
diff --git a/man/olamic-enqueue.1.md b/man/olamic-enqueue.1.md
new file mode 100644
index 0000000..15434cc
--- /dev/null
+++ b/man/olamic-enqueue.1.md
@@ -0,0 +1,24 @@
+% OLAMIC-ENQUEUE(1)
+% Julian B Kongslie
+% October 2020
+
+# NAME
+
+olamic-enqueue - create a new task for olamic
+
+# SYNOPSIS
+
+**olamic-enqueue** **/path/to/queue** **/url/for/git/repo** **git-commit-hash** [**VAR**=**VALUE** ...]
+
+# DESCRIPTION
+
+**olamic-enqueue** creates a new task within the specified queue which will
+clone the given repository at the given commit. It reads from stdin a script to
+run within the checkout. Any additional variables passed on the command line
+will be available to the script when it runs.
+
+When **olamic-enqueue** completes, it prints the UUID of the created task.
+
+# SEE ALSO
+
+olamic-worker(1)
diff --git a/man/olamic-worker.1.md b/man/olamic-worker.1.md
new file mode 100644
index 0000000..d558f47
--- /dev/null
+++ b/man/olamic-worker.1.md
@@ -0,0 +1,36 @@
+% OLAMIC-WORKER(1)
+% Julian B Kongslie
+% October 2020
+
+# NAME
+
+olamic-worker - run olamic tasks
+
+# SYNOPSIS
+
+**olamic-worker**
+
+# DESCRIPTION
+
+**olamic-worker** will continuously try to pull a new task from the olamic
+queue, and run it. It uses its current working directory as a scratch space.
+
+# ENVIRONMENT VARIABLES
+
+**OLAMIC_EMAIL**
+:   The default email to complain to if a task fails. This can (and typically
+    will) be overridden on a per-task basis.
+
+**OLAMIC_QUEUE_HOST**
+:   The host where the olamic queue lives. Defaults to the local machine.
+
+**OLAMIC_QUEUE_DIR**
+:   The directory where the olamic queue lives. Defaults to /srv/olamic/queue.
+
+**OLAMIC_WORKER_PERIOD**
+:   How long the worker sleeps for when it can't find a task. Defaults to one
+    minute.
+
+# SEE ALSO
+
+olamic-enqueue(1)
diff --git a/olamic-enqueue b/olamic-enqueue
new file mode 100755
index 0000000..1fe7b78
--- /dev/null
+++ b/olamic-enqueue
@@ -0,0 +1,50 @@
+#!/bin/bash
+
+set -eu
+
+QUEUE_DIR="$1"; shift
+GIT_REPO="$1"; shift
+GIT_OBJECT="$1"; shift
+
+VARS=()
+VALS=()
+while [[ $# != 0 ]]; do
+    VARSET="$1"; shift
+    if [[ $VARSET =~ ^([^=]+)=(.*)$ ]]; then
+        VARS+=("${BASH_REMATCH[1]}")
+        VALS+=("${BASH_REMATCH[2]}")
+    else
+        echo "Usage: $0 queue-dir repo-path git-object [VAR=value ...]" >&2
+        exit 1
+    fi
+done
+
+TASK_SCRIPT="$(cat)"
+
+mkdir -p "$QUEUE_DIR"
+
+cd "$QUEUE_DIR"
+
+mkdir -p candidates tmp
+
+TEMP_TASK="$(mktemp tmp/XXXXXXXX)"
+
+chmod 644 "$TEMP_TASK"
+
+for i in $(seq 0 $((${#VARS[@]}-1))); do
+    VAR="${VARS[$i]}"
+    VAL="${VALS[$i]}"
+    printf "export %q=%q\n" "$VAR" "$VAL" >> "$TEMP_TASK"
+done
+
+printf "export GIT_REPO=%q\n" "$GIT_REPO" >> "$TEMP_TASK"
+printf "export GIT_OBJECT=%q\n" "$GIT_OBJECT" >> "$TEMP_TASK"
+printf "export TASK_SCRIPT=%q\n" "$TASK_SCRIPT" >> "$TEMP_TASK"
+
+UUID="$(uuidgen -r)"
+
+until mv -n "$TEMP_TASK" candidates/"$UUID"; do
+    UUID="$(uuidgen -r)"
+done
+
+echo "$UUID"
diff --git a/olamic-run b/olamic-run
new file mode 100644
index 0000000..46fdabc
--- /dev/null
+++ b/olamic-run
@@ -0,0 +1,14 @@
+# vim: set ft=bash :
+
+dpkg-buildpackage
+lintian --fail-on error,warning
+
+if [[ $GIT_REF =~ ^refs/tags/(.+)$ ]]; then
+    INSTALL_DIR=/srv/olamic/artifacts/olamic/"${BASH_REMATCH[1]}"
+fi
+
+if [[ "${INSTALL_DIR:-}" != "" ]]; then
+    rm -rf "$INSTALL_DIR"
+    mkdir -p "$INSTALL_DIR"
+    cp -t "$INSTALL_DIR" ../olamic_*
+fi
diff --git a/olamic-worker b/olamic-worker
new file mode 100755
index 0000000..942151a
--- /dev/null
+++ b/olamic-worker
@@ -0,0 +1,83 @@
+#!/bin/bash
+
+set -eu -o pipefail
+
+OLAMIC_EMAIL="${OLAMIC_EMAIL:-}"
+OLAMIC_QUEUE_HOST="${OLAMIC_QUEUE_HOST:-}"
+OLAMIC_QUEUE_DIR="${OLAMIC_QUEUE_DIR:-/srv/olamic/queue}"
+OLAMIC_WORKER_PERIOD="${OLAMIC_WORKER_PERIOD:-1m}"
+
+OLAMIC_WORKER_DIR="$(pwd -P)"
+
+while true; do
+    if [[ "$OLAMIC_QUEUE_HOST" == "" ]]; then
+        TASK_INFO="$(/usr/share/olamic/pick-task "$OLAMIC_QUEUE_DIR")"
+    else
+        TASK_INFO="$(ssh "$OLAMIC_QUEUE_HOST" /usr/share/olamic/pick-task "$OLAMIC_QUEUE_DIR")"
+    fi
+
+    if [[ "$TASK_INFO" == "" ]]; then
+        sleep "$OLAMIC_WORKER_PERIOD"
+        continue
+    fi
+
+    (
+        eval "$TASK_INFO"
+        printf "Running task %q\n" "$TASK_ID"
+
+        if [[ ! -e cache.git ]]; then
+            git init --bare cache.git
+        fi
+
+        set +e
+        (
+            set -ex
+
+            GIT_DIR=cache.git git fetch "$GIT_REPO" "$GIT_OBJECT"
+
+            rm -rf work
+            mkdir work
+            cd work
+
+            git clone --shared "$OLAMIC_WORKER_DIR"/cache.git checkout
+            cd checkout
+            git config advice.detachedHead false
+            git checkout -f "$GIT_OBJECT"
+
+            (
+                eval "$TASK_SCRIPT"
+            )
+        ) 2>&1 | tee log
+        STATUS="$?"
+
+        set -e
+
+        if [[ "$STATUS" != "0" ]]; then
+            echo "Task failed with exit code $STATUS"
+            if [[ "$OLAMIC_EMAIL" != "" ]]; then
+                echo "Sending email to $OLAMIC_EMAIL"
+                sendmail -t <<END
+To: $OLAMIC_EMAIL
+Subject: olamic failure $GIT_REPO $TASK_ID
+Content-type: text/plain
+
+Olamic task $TASK_ID failed with exit code $STATUS.
+
+Environment for the build:
+$(env | sort)
+
+Log from the build:
+$(cat log)
+END
+            fi
+        else
+            echo "Task completed successfully"
+        fi
+
+        if [[ "$OLAMIC_QUEUE_HOST" == "" ]]; then
+            rm -f "$OLAMIC_QUEUE_DIR"/in-progress/"$TASK_ID"
+        else
+            ssh "$OLAMIC_QUEUE_HOST" rm -f "$OLAMIC_QUEUE_DIR"/in-progress/"$TASK_ID"
+        fi
+    )
+done
diff --git a/pick-task b/pick-task
new file mode 100755
index 0000000..0e12bbd
--- /dev/null
+++ b/pick-task
@@ -0,0 +1,25 @@
+#!/bin/bash
+
+set -eu
+
+QUEUE_DIR="$1"
+shift
+
+mkdir -p "$QUEUE_DIR"
+cd "$QUEUE_DIR"
+
+mkdir -p candidates in-progress
+
+while true; do
+    CANDIDATE="$(ls -1 candidates | rl -c 1 2>/dev/null)"
+
+    if [[ "$CANDIDATE" == "" ]]; then
+        break
+    fi
+
+    if mv -n candidates/"$CANDIDATE" in-progress/"$CANDIDATE" 2>/dev/null; then
+        cat in-progress/"$CANDIDATE"
+        printf "export TASK_ID=%q\n" "$CANDIDATE"
+        break
+    fi
+done