Initial CI setup and a few tests (#21)

* [X] Simple CI setup to build and test smir_pretty
* [x] a directory of small test programs and golden files to compare to
(json to be formatted and normalised using `jq`)
* [x] resolve issues with toolchain setup (from prior runs?) on runners
* [ ] analyse and fix Rust build artefact caching

Related: #20

.github/workflows/test.yml

@@ -0,0 +1,60 @@
+name: 'Test'
+on:
+  pull_request:
+    branches: [ "master" ]
+  push:
+    branches: [ "master" ]
+  workflow_dispatch:
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+
+  integration-tests:
+    name: "Integration tests"
+    runs-on: [self-hosted, linux, normal]
+    steps:
+      - name: 'Check out code'
+        uses: actions/checkout@v4
+        with:
+          # Check out pull request HEAD instead of merge commit.
+          ref: ${{ github.event.pull_request.head.sha }}
+          submodules: recursive
+
+      - name: "Set up nightly Rust" # https://github.com/rust-lang/rustup/issues/3409
+        uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: nightly-2024-08-28
+
+      - name: 'Set up tree for rust dependency'
+        run: make setup
+
+      - name: 'Cache smir_pretty and rustc'
+        uses: Swatinem/rust-cache@v2
+        with:
+          workspaces: |
+            .
+            deps/rust/src
+          cache-directories: |
+            target
+            deps/rust/src/build
+            deps/rust/src/target
+
+      - name: 'Build smir_pretty and its rustc dependency'
+        run: | # rustc bootstrap checks this and refuses stage 1 in "CI"
+          export GITHUB_ACTIONS="in denial" && \
+          echo "GITHUB_ACTIONS = ${GITHUB_ACTIONS}" && \
+          make build_all
+
+      - name: 'Run smir integration tests'
+        run: |
+          make integration-test
+
+      - name: 'Clean up toolchain'
+        if: always()
+        run: |
+          make rustup-clear-toolchain

Makefile

@@ -79,8 +79,42 @@ rust_set_toolchain: ${RUST_LIB_DIR}
 	rustup override set "${TOOLCHAIN_NAME}"
 	echo ${STAGE} > ${STAGE_FILE}
 
+.PHONY: rustup-clear-toolchain
+rustup-clear-toolchain:
+	rustup override unset
+	rustup override unset --nonexistent
+	rustup toolchain uninstall "${TOOLCHAIN_NAME}"
+
 generate_ui_tests:
 	mkdir -p "${RUST_DIR}"/tests
 	cd "${RUST_SRC}"; ./get_runpass.sh tests/ui > "${RUST_DIR}"/tests_ui_sources
 	-cd "${RUST_SRC}"; ./ui_compiletest.sh "${RUST_SRC}" "${RUST_DIR}"/tests/ui/upstream "${RUST_DIR}"/tests_ui_sources --pass check --force-rerun 2>&1 > "${RUST_DIR}"/tests_ui_upstream.log
 	-cd "${RUST_SRC}"; RUST_BIN="${PWD}"/run.sh ./ui_compiletest.sh "${RUST_SRC}" "${RUST_DIR}"/tests/ui/smir "${RUST_DIR}"/tests_ui_sources --pass check --force-rerun 2>&1 > "${RUST_DIR}"/tests_ui_smir.log
+
+TESTDIR=$(CURDIR)/tests/integration/programs
+
+.PHONY: integration-test
+integration-test: TESTS     ?= $(shell find $(TESTDIR) -type f -name "*.rs")
+integration-test: SMIR      ?= $(CURDIR)/run.sh -Z no-codegen
+# override this to tweak how expectations are formatted
+integration-test: NORMALIZE ?= jq -S -e -f $(TESTDIR)/../normalise-filter.jq
+# override this to re-make golden files
+integration-test: DIFF      ?= | diff -
+integration-test: build
+	errors=""; \
+	report() { echo "$$1: $$2"; errors="$$errors\n$$1: $$2"; }; \
+	for rust in ${TESTS}; do \
+		target=$${rust%.rs}.smir.json; \
+		dir=$$(dirname $${rust}); \
+		echo "$$rust"; \
+		${SMIR} --out-dir $${dir} $${rust} || report "$$rust" "Conversion failed"; \
+		[ -f $${target} ] \
+			&& ${NORMALIZE} $${target} ${DIFF} $${target}.expected \
+			&& rm $${target} \
+			|| report "$$rust" "Unexpected json output"; \
+		done; \
+	[ -z "$$errors" ] || (echo "===============\nFAILING TESTS:$$errors"; exit 1)
+
+
+golden:
+	make integration-test DIFF=">"

panic_example.rs

@@ -0,0 +1 @@
+tests/integration/failing/panic_example.rs

panic_example.smir.json

@@ -0,0 +1 @@
+tests/integration/failing/panic_example.smir.json.expected

tests/integration/failing/array.rs

@@ -0,0 +1,5 @@
+fn main() {
+    let a = [1, 2, 3, 4];
+
+    assert!(a == [1, 2, 3, 4]);
+}