Add initial CI

Downloads ANTLR, builds the parser and uses it to test. Also runs
shellcheck on the three scripts I wrote for this, cause why not.

Still to do is definitely some expect-fail tests. Maybe also more
languages? Probably at least Python.

Author: Infernio

.github/workflows/ci.yaml

@@ -0,0 +1,22 @@
+name: CI
+
+on: push
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout commit
+        uses: actions/checkout@v2
+      - name: Run ShellCheck
+        uses: ludeeus/[email protected]
+      - name: Setup Java
+        uses: actions/[email protected]
+        with:
+          java-version: 8 # ANTLR needs Java 8
+      - name: Download ANTLR v4
+        run: ./scripts/prereq.sh
+      - name: Build wizparse
+        run: ./scripts/build.sh
+      - name: Run tests
+        run: ./scripts/test.sh

.gitignore

@@ -1,3 +1,8 @@
+# Generated noise
+*.class
+*.jar
+*.java
+
 # Python virtualenv
 .venv/
 

Readme.md

@@ -16,6 +16,17 @@ Not yet implemented
 ## Interpreter
 Not yet implemented
 
+## Building & Testing
+Still a bit rough because it was designed for CI, but see the [scripts](scripts) folder.
+In short:
+ 1. Make sure you're on Linux. You're on your own on Windows.
+ 1. Make sure you have Java 8 and that it's the one you're currently using.
+    For example, on Arch Linux, check with `archlinux-java status` and switch with `archlinux-java set`.
+ 1. Run `./scripts/prereq.sh`. This will download a copy of ANTLR.
+ 1. Run `./scripts/build.sh`. This will generate a Java parser and compile it.
+ 1. Run `./scripts/test.sh`. This will run all tests in the tests folder.
+ 1. If it worked, yo
+
 ## License
 wizparse is licensed under the MIT license. See [LICENSE](LICENSE) for the full text.
 

scripts/build.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+# This script generates and builds wizparse using ANTLR.
+
+# Add antlr.jar to the classpath
+CLASSPATH=".:$(realpath scripts/antlr.jar):$CLASSPATH"
+export CLASSPATH
+
+# Generate the parser and compile it
+java org.antlr.v4.Tool -o tmp wizards/wizard.g4
+# We rely on none of the .java files having spaces, so ignore this
+# shellcheck disable=SC2046
+javac $(find tmp -type f -iname "*.java" -printf '%p ') # separates with spaces

scripts/prereq.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+# This script downloads all build prerequisites for wizparse.
+
+# Currently only the latest ANTLR release.
+curl https://www.antlr.org/download/antlr-4.8-complete.jar --output scripts/antlr.jar

scripts/test.sh

@@ -0,0 +1,46 @@
+#!/bin/bash
+# This script runs a test parse on each test file, failing the CI if any files fail to parse.
+
+# Check if stdout is a tty and supports color
+# If not, they will be undefined and hence resolve to empty strings
+if test -t 1
+then
+    ncolors=$(tput colors)
+    if test -n "$ncolors" && test "$ncolors" -ge 8
+    then
+        C_RED='\033[1;31m'
+        C_GREEN='\033[1;32m'
+        C_BLUE='\033[1;34m'
+        C_YELLOW='\033[1;33m'
+        C_NC='\033[0m'
+    fi
+fi
+
+# Add antlr.jar to the classpath
+CLASSPATH=".:$(realpath scripts/antlr.jar):$CLASSPATH"
+export CLASSPATH
+
+# ANTLR can only handle local class files
+cd tmp/wizards || exit
+
+num_tests=$(find ../../tests -type f -name '*.txt' -printf x | wc -c)
+echo -e "${C_BLUE}==>${C_NC} Testing $num_tests wizards"
+
+for rel_test in ../../tests/*.txt
+do
+    # Get rid of the .., looks better in logs
+    real_test=$(realpath "$rel_test")
+    echo -e "   ${C_BLUE}::${C_NC} ${C_YELLOW}Current test wizard:${C_NC} $real_test"
+    # TestRig doesn't set an abnormal return code, so analyze its stderr output
+    java org.antlr.v4.gui.TestRig wizard parseWizard "$real_test" 2> parseErrors.txt
+    if [ -s parseErrors.txt ] # exists and is not empty
+    then
+        # Since we swallowed the stderr output, print it back out
+        echo -e "${C_BLUE}==>${C_NC} ${C_RED}Test failed, error message follows${C_NC}"
+        echo "$(<parseErrors.txt)"
+        exit 1 # fail the CI
+    fi
+    echo -e "   ${C_BLUE}::${C_NC} ${C_GREEN}Test passed${C_NC}"
+done
+
+echo -e "${C_BLUE}==>${C_NC} ${C_GREEN}All test passed${C_NC}"