Configure build+test matrix for GitLab CI:

* Disable parallel tests for address sanitizer
* Improve caching
* Prefer Ninja builds because they are faster

.gitlab-ci.yml

@@ -0,0 +1,169 @@
+# I don't know what the minimum size is, but we cannot build on t3.micro.
+
+# TODO: Factor common builds between different tests.
+
+# The parameters for our job matrix:
+#
+# 1. Generator (Make, Ninja, MSBuild)
+# 2. Compiler (GCC, Clang, MSVC)
+# 3. Build type (Debug, Release)
+# 4. Definitions (-Dunity=OFF, -Dassert=ON, ...)
+
+
+.job_linux_build_test:
+  only:
+    variables:
+      - $CI_PROJECT_URL =~ /^https?:\/\/gitlab.com\//
+  stage: build
+  tags:
+    - linux
+    - c5.2xlarge
+  image: thejohnfreeman/rippled-build-ubuntu:1bc7230e5b97
+  script:
+    - bin/ci/build.sh
+    - bin/ci/test.sh
+  cache:
+    # Use a different key for each unique combination of (generator, compiler,
+    # build type). Caches are stored as `.zip` files; they are not merged.
+    # Generate a new key whenever you want to bust the cache, e.g. when the
+    # dependency versions have been bumped.
+    # By default, jobs pull the cache. Only a few specially chosen jobs update
+    # the cache (with policy `pull-push`); one for each unique combination of
+    # (generator, compiler, build type).
+    policy: pull
+    paths:
+      - .nih_c/
+
+'build+test Make GCC Debug':
+  extends: .job_linux_build_test
+  variables:
+    GENERATOR: Unix Makefiles
+    COMPILER: gcc
+    BUILD_TYPE: Debug
+  cache:
+    key: ae412fb0-5fc8-4fd5-8e48-e3a60e91ed46
+    policy: pull-push
+
+'build+test Ninja GCC Debug':
+  extends: .job_linux_build_test
+  variables:
+    GENERATOR: Ninja
+    COMPILER: gcc
+    BUILD_TYPE: Debug
+  cache:
+    key: 3a314872-4faa-4712-b8ab-a8d54ac83342
+    policy: pull-push
+
+'build+test Ninja GCC Debug -Dstatic=OFF':
+  extends: .job_linux_build_test
+  variables:
+    GENERATOR: Ninja
+    COMPILER: gcc
+    BUILD_TYPE: Debug
+    CMAKE_ARGS: '-Dstatic=OFF'
+  cache:
+    key: 3a314872-4faa-4712-b8ab-a8d54ac83342
+
+'build+test Ninja GCC Debug -Dstatic=OFF -DBUILD_SHARED_LIBS=ON':
+  extends: .job_linux_build_test
+  variables:
+    GENERATOR: Ninja
+    COMPILER: gcc
+    BUILD_TYPE: Debug
+    CMAKE_ARGS: '-Dstatic=OFF -DBUILD_SHARED_LIBS=ON'
+  cache:
+    key: 3a314872-4faa-4712-b8ab-a8d54ac83342
+
+'build+test Ninja GCC Debug -Dunity=OFF':
+  extends: .job_linux_build_test
+  variables:
+    GENERATOR: Ninja
+    COMPILER: gcc
+    BUILD_TYPE: Debug
+    CMAKE_ARGS: '-Dunity=OFF'
+  cache:
+    key: 3a314872-4faa-4712-b8ab-a8d54ac83342
+
+'build+test Ninja GCC Release -Dassert=ON':
+  extends: .job_linux_build_test
+  variables:
+    GENERATOR: Ninja
+    COMPILER: gcc
+    BUILD_TYPE: Release
+    CMAKE_ARGS: '-Dassert=ON'
+  cache:
+    key: ac5e7a8a-bfcb-4480-a3cc-07d0336f4408
+    policy: pull-push
+
+'build+test(manual) Ninja GCC Release -Dassert=ON':
+  extends: .job_linux_build_test
+  variables:
+    GENERATOR: Ninja
+    COMPILER: gcc
+    BUILD_TYPE: Release
+    CMAKE_ARGS: '-Dassert=ON'
+    MANUAL_TEST: 'true'
+  cache:
+    key: ac5e7a8a-bfcb-4480-a3cc-07d0336f4408
+
+'build+test Make clang Debug':
+  extends: .job_linux_build_test
+  variables:
+    GENERATOR: Unix Makefiles
+    COMPILER: clang
+    BUILD_TYPE: Debug
+  cache:
+    key: 09cec2ce-83f5-4ce9-8a3b-23737edefd4f
+    policy: pull-push
+
+'build+test Ninja clang Debug':
+  extends: .job_linux_build_test
+  variables:
+    GENERATOR: Ninja
+    COMPILER: clang
+    BUILD_TYPE: Debug
+  cache:
+    key: c6e29541-e539-4d57-86c5-57d923521f35
+    policy: pull-push
+
+'build+test Ninja clang Debug -Dunity=OFF':
+  extends: .job_linux_build_test
+  variables:
+    GENERATOR: Ninja
+    COMPILER: clang
+    BUILD_TYPE: Debug
+    CMAKE_ARGS: '-Dunity=OFF'
+  cache:
+    key: c6e29541-e539-4d57-86c5-57d923521f35
+
+'build+test Ninja clang Debug -Dunity=OFF -Dsan=address':
+  extends: .job_linux_build_test
+  variables:
+    GENERATOR: Ninja
+    COMPILER: clang
+    BUILD_TYPE: Debug
+    CMAKE_ARGS: '-Dunity=OFF -Dsan=address'
+    CONCURRENT_TESTS: 1
+  cache:
+    key: c6e29541-e539-4d57-86c5-57d923521f35
+
+'build+test Ninja clang Debug -Dunity=OFF -Dsan=undefined':
+  extends: .job_linux_build_test
+  variables:
+    GENERATOR: Ninja
+    COMPILER: clang
+    BUILD_TYPE: Debug
+    CMAKE_ARGS: '-Dunity=OFF -Dsan=undefined'
+  cache:
+    key: c6e29541-e539-4d57-86c5-57d923521f35
+
+'build+test Ninja clang Release -Dassert=ON':
+  extends: .job_linux_build_test
+  variables:
+    GENERATOR: Ninja
+    COMPILER: clang
+    BUILD_TYPE: Release
+    CMAKE_ARGS: '-Dassert=ON'
+  cache:
+    key: 2e48f4d8-e0d7-4aa9-b646-499cef6c1a87
+    policy: pull-push

bin/ci/README.md

@@ -0,0 +1,24 @@
+In this directory are two scripts, `build.sh` and `test.sh` used for building
+and testing rippled.
+
+(For now, they assume Bash and Linux. Once I get Windows containers for
+testing, I'll try them there, but if Bash is not available, then they will
+soon be joined by PowerShell scripts `build.ps` and `test.ps`.)
+
+We don't want these scripts to require arcane invocations that can only be
+pieced together from within a CI configuration. We want something that humans
+can easily invoke, read, and understand, for when we eventually have to test
+and debug them interactively. That means:
+
+(1) They should work with no arguments.
+(2) They should document their arguments.
+(3) They should expand short arguments into long arguments.
+
+While we want to provide options for common use cases, we don't need to offer
+the kitchen sink. We can rightfully expect users with esoteric, complicated
+needs to write their own scripts.
+
+To make argument-handling easy for us, the implementers, we can just take all
+arguments from environment variables. They have the nice advantage that every
+command-line uses named arguments. For the benefit of us and our users, we
+document those variables at the top of each script.

bin/ci/build.sh

@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+
+set -o xtrace
+set -o errexit
+
+# The build system. Either 'Unix Makefiles' or 'Ninja'.
+GENERATOR=${GENERATOR:-Unix Makefiles}
+# The compiler. Either 'gcc' or 'clang'.
+COMPILER=${COMPILER:-gcc}
+# The build type. Either 'Debug' or 'Release'.
+BUILD_TYPE=${BUILD_TYPE:-Debug}
+# Additional arguments to CMake.
+# We use the `-` substitution here instead of `:-` so that callers can erase
+# the default by setting `$CMAKE_ARGS` to the empty string.
+CMAKE_ARGS=${CMAKE_ARGS-'-Dwerr=ON'}
+
+if [[ ${COMPILER} == 'gcc' ]]; then
+  export CC='gcc'
+  export CXX='g++'
+elif [[ ${COMPILER} == 'clang' ]]; then
+  export CC='clang'
+  export CXX='clang++'
+fi
+
+mkdir build
+cd build
+cmake -G "${GENERATOR}" -DCMAKE_BUILD_TYPE=${BUILD_TYPE} ${CMAKE_ARGS} ..
+cmake --build . -- -j $(nproc)

bin/ci/test.sh

@@ -0,0 +1,42 @@
+#!/usr/bin/env bash
+
+set -o xtrace
+set -o errexit
+
+# Set to 'true' to run the known "manual" tests in rippled.
+MANUAL_TESTS=${MANUAL_TESTS:-false}
+# The maximum number of concurrent tests.
+CONCURRENT_TESTS=${CONCURRENT_TESTS:-$(nproc)}
+# The path to rippled.
+RIPPLED=${RIPPLED:-build/rippled}
+# Additional arguments to rippled.
+RIPPLED_ARGS=${RIPPLED_ARGS:-}
+
+function join_by { local IFS="$1"; shift; echo "$*"; }
+
+declare -a manual_tests=(
+  'beast.chrono.abstract_clock'
+  'beast.unit_test.print'
+  'ripple.NodeStore.Timing'
+  'ripple.app.Flow_manual'
+  'ripple.app.NoRippleCheckLimits'
+  'ripple.app.PayStrandAllPairs'
+  'ripple.consensus.ByzantineFailureSim'
+  'ripple.consensus.DistributedValidators'
+  'ripple.consensus.ScaleFreeSim'
+  'ripple.ripple_data.digest'
+  'ripple.tx.CrossingLimits'
+  'ripple.tx.FindOversizeCross'
+  'ripple.tx.Offer_manual'
+  'ripple.tx.OversizeMeta'
+  'ripple.tx.PlumpBook'
+)
+
+if [[ ${MANUAL_TESTS} == 'true' ]]; then
+  RIPPLED_ARGS+=" --unittest=$(join_by , "${manual_tests[@]}")"
+else
+  RIPPLED_ARGS+=" --unittest --quiet --unittest-log"
+fi
+RIPPLED_ARGS+=" --unittest-jobs ${CONCURRENT_TESTS}"
+
+${RIPPLED} ${RIPPLED_ARGS}