WIP: Add CI capabilities with integration testing

.gitlab-ci.yml

@@ -3,21 +3,54 @@
 #       by the CI docker runners.
 image: "binaryanalysisplatform/bap:latest"
 
-# JOB: run the tests for WP.
-run_wp_tests:
+# Order of job-executions (prevents jobs from running in parallel):
+stages:
+  - build_bildb
+  - run_unit_tests
+  - run_integration_tests
+
+# JOB: build BilDB.
+build_bildb:
+  stage: build_bildb
+
+  tags:
+    - docker
+
+  script:
+    - make -C bildb
+
+# JOB: run unit tests for WP.
+run_unit_tests:
+  stage: run_unit_tests
 
   tags:
     - docker
 
   script:
     - make test -C wp
-
-# JOB: build BilDB.
-build_bildb:
+    - bash -x bin/unit-tests/run-tests.bash --report-results
+
+# JOB: run integration tests for WP.
+run_integration_tests:
+  stage: run_integration_tests
 
   tags:
     - docker
 
   script:
-    - make -C bildb
+  # Install APT dependencies.
+    - >-
+      sudo -E apt install -y
+      qemu gcc-arm-linux-gnueabi binutils-arm-linux-gnueabi cmake
+
+
+  # Install other dependencies (non-sudo).
+    - bash -x bin/setup/install-dependencies.bash --report-results
+
+  # Source environment variables and install cbat tools.
+    - . bin/common-lib/env.bash
+    - make -C wp
+
+    - make test -C wp
+    - bash -x bin/integration-tests/run-tests.bash --report-results
 

bin/common-lib/env.bash

@@ -0,0 +1,18 @@
+# --------------------------------------------------------------
+# 
+# This script provides some environment variables
+# used for running some of the tools.
+#
+# --------------------------------------------------------------
+
+# Minizinc variables
+MINIZINC_URL=https://github.com/MiniZinc/MiniZincIDE/releases/download/2.5.3/MiniZincIDE-2.5.3-bundle-linux-x86_64.tgz
+MINIZINC_BUNDLE=MiniZincIDE-2.5.3-bundle-linux-x86_64
+MINIZINC_DIR="${HOME}/${MINIZINC_BUNDLE}"
+export PATH="${MINIZINC_DIR}/bin":"${PATH}"
+export LD_LIBRARY_PATH="${MINIZINC_DIR}/lib":"${LD_LIBRARY_PATH}"
+
+# Boolector variables
+BOOLECTOR_URL=https://github.com/boolector/boolector
+BOOLECTOR_DIR="${HOME}/boolector"
+export PATH="${BOOLECTOR_DIR}/build/bin":"${PATH}"

bin/common-lib/slack.bash

@@ -0,0 +1,96 @@
+# -------------------------------
+#
+# Utilities for slack integration
+#
+# -------------------------------
+
+# DESC: Checks if SLACK_USERNAME is defined
+# OUTPUT: 0 if SLACK_USERNAME is defined, 1 otherwise
+there_is_a_SLACK_USERNAME () {
+    if [ -z "${SLACK_USERNAME+x}" ];
+    then return 1;
+    else return 0;
+    fi
+}
+
+# DESC: Checks if SLACK_URL is defined
+# OUTPUT: 0 if SLACK_URL is defined, 1 otherwise
+there_is_a_SLACK_URL () {
+    if [ -z "${SLACK_URL}" ];
+    then return 1;
+    else return 0;
+    fi
+}
+
+# DESC: Creates a payload JSON file.
+# ARGS: Takes in ${1} argument that must be "true" in order
+  # to print full report.
+# OUTPUT: The exit code of the attempt to write the file.
+build_slack_payload () {
+    local MESSAGE
+    local BAP
+    local BRANCH
+    local COMMIT
+    local DATA
+    local TEXT
+    local VERBOSE
+    VERBOSE="${1}"
+    MESSAGE="$(cat "${MSG_FILE}")"
+    BAP="$(cat "${BAP_VERSION_FILE}")"
+    BRANCH="$(cat "${GIT_BRANCH_FILE}")"
+    COMMIT="$(sed -z -e 's/\n/\\n/g' -e 's/\"/\\"/g' "${GIT_COMMIT_FILE}")"
+    DATA="$(sed -z \
+        -e 's/\n/\\n/g' \
+        -e 's/\"/\\"/g' \
+        -e 's/'\''/\'\''/g' \
+        -e 's/'\`'/'\`'/g' \
+        "${REPORT_FILE}")"
+    TEXT="STATUS: ${MESSAGE}"
+    TEXT="${TEXT}\nBAP: ${BAP}"
+    TEXT="${TEXT}\nBRANCH: ${BRANCH}"
+    TEXT="${TEXT}\nCOMMIT:\n\`\`\`\n${COMMIT}\n\`\`\`"
+    if [[ "${VERBOSE}" == "true" ]]; then
+	TEXT="${TEXT}\nOUTPUT:\n\`\`\`\n${DATA}\n\`\`\`"
+    fi 
+    echo "{
+        \"username\":\"${SLACK_USERNAME}\",
+        \"text\":\"${TEXT}\"
+    }" > "${SLACK_FILE}"
+}
+
+#DESC: Prints the payload created in build_slack_payload
+print_payload () {
+    echo "printing payload:"
+    echo "MESSAGE: $(cat "${MSG_FILE}")"
+    echo "BAP: $(cat "${BAP_VERSION_FILE}")"
+    echo "BRANCH: $(cat "${GIT_BRANCH_FILE}")"
+    echo "COMMIT: $(cat "${GIT_COMMIT_FILE}")"
+    echo "DATA: $(cat "${REPORT_FILE}")"
+}
+
+# DESC: Posts a message to slack
+# OUTPUT: The exit code of the curl/POST command
+post_to_slack () {
+    local OUTPUT
+    local RESULT
+    OUTPUT="$(curl \
+	--http1.1 \
+        -X POST \
+        -H "Content-Type: application/json" \
+        -d @"${SLACK_FILE}" \
+	"${SLACK_URL}")"
+    RESULT=${?}
+    echo "${OUTPUT}"
+    return ${RESULT}
+}
+
+# DESC: Reports the current status to slack
+# ARGS: Takes in ${1} argument that must be "true" in order
+      # to print full report. 
+# OUTPUT: Exit code of the attempt to send status to slack
+report_to_slack () { 
+    build_slack_payload "${1}"
+    print_payload
+    post_to_slack
+}
+

bin/common-lib/utils.bash

@@ -0,0 +1,126 @@
+# --------------------------------------------------------------
+#
+# This script provides some basic utilities
+# (used when running system tests).
+#
+# --------------------------------------------------------------# DESC
+#   Check if this script is running with bash
+# RETURNS
+#   - 0 if this script is running with bash
+#   - 1 if not
+is_bash () {
+    if [ -z "${BASH_VERSION}" ];
+    then return 1;
+    else return 0;
+    fi
+}
+# DESC
+#   Returns the filename of this script
+get_me () {
+    echo "$(basename "${0}")"
+}
+# DESC
+#   Prints a help hint
+help_hint () {
+    local ME
+    ME="$(get_me)"
+    echo "See ${ME} --help for usage."
+}
+# DESC
+#   Constructs a tmp dir for use by this script
+# RETURNS
+#   The tmp dir name
+create_tmp_dir () {
+    local DIR_NAME
+    local ME
+    ME="$(get_me)"
+    DIR_NAME="$(mktemp -d "${TMPDIR:-/tmp/}${ME}.XXXXXXXXXXXX")"
+    echo "${DIR_NAME}"
+}
+# Setup tmp dir/files
+TMP_SCRATCH_DIR="$(create_tmp_dir)"
+MSG_FILE="${TMP_SCRATCH_DIR}/message.txt"
+REPORT_FILE="${TMP_SCRATCH_DIR}/report.txt"
+SLACK_FILE="${TMP_SCRATCH_DIR}/data.json"
+BAP_VERSION_FILE="${TMP_SCRATCH_DIR}/bap-version.txt"
+GIT_BRANCH_FILE="${TMP_SCRATCH_DIR}/git-branch.txt"
+GIT_COMMIT_FILE="${TMP_SCRATCH_DIR}/git-commit.txt"
+echo "Initializing message...no message yet" > "${MSG_FILE}"
+echo "Initializing report...nothing to report yet" > "${REPORT_FILE}"
+echo '{"username":"None yet","text":"Nothing yet"}' > "${SLACK_FILE}"
+echo "No BAP version to report yet" > "${BAP_VERSION_FILE}"
+echo "No branch to report yet" > "${GIT_BRANCH_FILE}"
+echo "No commit to report yet" > "${GIT_COMMIT_FILE}"
+
+# DESC
+#     Get filepath to the REPORT_FILE.
+# ARGS
+# - 1 : If "true" then return REPORT_FILE.
+#       Otherwise, return /dev/null.
+report_file () {
+    if [[ "${1}" == "true" ]]; then
+        echo "${REPORT_FILE}"
+    else
+        echo "/dev/null"
+    fi
+}
+# DESC
+#   Record the BAP version
+bap_version () {
+    bap --version > "${BAP_VERSION_FILE}"
+    echo "BAP_VERSION: $(cat "${BAP_VERSION_FILE}")"
+}
+
+# DESC
+#   Record the current GIT branch
+git_branch () {
+    git branch > "${GIT_BRANCH_FILE}"
+    echo "GIT_BRANCH: $(cat "${GIT_BRANCH_FILE}")"
+    }
+
+# DESC
+#   Record the current GIT commit
+git_commit () {
+    git log -1 > "${GIT_COMMIT_FILE}"
+    if [[ -z "$(cat "${GIT_COMMIT_FILE}")" ]]; then
+        echo "${CI_COMMIT_MESSAGE}" > "${GIT_COMMIT_FILE}"
+        if [[ -z "$(cat "${GIT_COMMIT_FILE}")" ]]; then
+            echo "No commit message could be obtained" > "${GIT_COMMIT_FILE}"
+        fi
+    fi
+    echo -e "GIT_COMMIT:\n$(cat "${GIT_COMMIT_FILE}")"
+}
+
+# DESC
+#   Cleans up files we've written
+clean_up () {
+    rm -rf "${TMP_SCRATCH_DIR}"
+}
+# DESC
+#   Print that we're halting, along with the contents of ${MSG_FILE}.
+fail () {
+    echo "Halting"
+    echo "$(cat "${MSG_FILE}")"
+}
+# Ensure we're using Bash.
+is_bash
+if [ ${?} -ne 0 ]; then
+    echo "Halting."
+    echo "This script must be executed with Bash."
+    return 1
+fi
+# Where are we?
+THIS_SCRIPT="${BASH_SOURCE[0]}"
+COMMON_LIB_DIR="$(cd "$(dirname "${THIS_SCRIPT}")" && pwd)"
+# Ensure we can find the root of the repo.
+REPO_ROOT="$(cd "${COMMON_LIB_DIR}"/../../ && pwd)"
+if [ ! -f "${REPO_ROOT}"/.gitlab-ci.yml ]; then
+    echo "Halting."
+    echo "Cannot find the repo root."
+    echo "Looked in REPO ROOT: '${REPO_ROOT}'"
+    echo "But could not find a .gitlab-ci.yml file."
+    exit 1
+fi
+# Where these scripts are all kept.
+BIN_DIR="${REPO_ROOT}/bin"
+