Experiment self hosted GitHub CI

.github/scripts/mac-action-runner-readme.txt

@@ -0,0 +1,23 @@
+Sharing the trouble of getting github action runners to work on a mac coming straight out of the factory, running Big Sur
+
+XCode (you need XCode to build the Swift runtime):
+ - install XCode from the Mac App Store
+ - Launch it, this will force installation of components
+ - Go to Preferences -> Locations and select XCode as Command Line Tools
+
+Brew (you need Brew to install maven):
+  - get the script from https://brew.sh
+  - once installed, run the following:
+    echo 'eval $(/opt/homebrew/bin/brew shellenv)' >> /Users/{user-account}/.zprofile
+    eval $(/opt/homebrew/bin/brew shellenv)
+    (you need to repeat these last steps for each user account)
+
+Maven (supposedly installed by the github workflow, but it's convenient to have a global install for troubleshooting):
+ - brew install maven
+
+JDK (we need a specific JDK):
+ - download openjdk8 from Oracle (later versions break the build due to some packages having disappeared)
+ - install it -> this will mess up your JAVA_HOME completely, pointing to /Library/Internet...
+ - fix the JAVA_HOME mess as follows:
+    sudo rm -fr /Library/Internet\ Plug-Ins/JavaAppletPlugin.plugin
+    sudo rm -fr /Library/PreferencePanes/JavaControlPanel.prefpane

.github/scripts/run-tests-java.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+
+set -euo pipefail
+
+if [ -z "${JAVA_HOME-}" ]
+then
+  export JAVA_HOME="$(java -XshowSettings:properties -version 2>&1 |
+                          grep 'java\.home' | awk '{ print $3 }')"
+  echo "export JAVA_HOME=$JAVA_HOME"
+fi
+
+# run java tests
+cd runtime-testsuite/
+if [ $GROUP == "LEXER" ]; then
+    mvn -X -e -q -Dgroups="org.antlr.v4.test.runtime.category.LexerTests" -Dtest="swift.*" test
+elif [ $GROUP == "PARSER" ]; then
+    mvn -q -Dgroups="org.antlr.v4.test.runtime.category.ParserTests" -Dtest="swift.*" test
+elif [ $GROUP == "RECURSION" ]; then
+    mvn -q -Dgroups="org.antlr.v4.test.runtime.category.LeftRecursionTests" -Dtest="swift.*" test
+else
+    mvn -q -Dtest="java.*" test
+fi
+rc=$?
+cat target/surefire-reports/*.dumpstream || true
+exit $rc

.github/scripts/run-tests-swift.sh

@@ -0,0 +1,50 @@
+#!/bin/bash
+
+set -euo pipefail
+
+# linux specific setup, those setup have to be
+# here since environment variables doesn't pass
+# across scripts
+if [ $RUNNER_OS == "Linux" ]; then
+  export SWIFT_VERSION=swift-5.0.1
+  export SWIFT_HOME=$(pwd)/swift/$SWIFT_VERSION-RELEASE-ubuntu16.04/usr/bin/
+  export PATH=$SWIFT_HOME:$PATH
+
+  # download swift
+  mkdir swift
+  curl https://swift.org/builds/$SWIFT_VERSION-release/ubuntu1604/$SWIFT_VERSION-RELEASE/$SWIFT_VERSION-RELEASE-ubuntu16.04.tar.gz -s | tar xz -C swift &> /dev/null
+fi
+
+if [ -z "${JAVA_HOME}" ]
+then
+  export JAVA_HOME="$(java -XshowSettings:properties -version 2>&1 |
+                          grep 'java\.home' | awk '{ print $3 }')"
+fi
+echo "export JAVA_HOME=$JAVA_HOME"
+
+# check swift
+swift --version
+swift build --version
+
+# run swift tests
+pushd runtime/Swift
+./boot.py --test
+rc=$?
+popd
+
+if [ $rc == 0 ]; then
+  # run java tests
+  cd runtime-testsuite/
+  if [ $GROUP == "LEXER" ]; then
+      mvn -e -q -Dgroups="org.antlr.v4.test.runtime.category.LexerTests" -Dtest="swift.*" test
+  elif [ $GROUP == "PARSER" ]; then
+      mvn -e -q -Dgroups="org.antlr.v4.test.runtime.category.ParserTests" -Dtest="swift.*" test
+  elif [ $GROUP == "RECURSION" ]; then
+      mvn -e -q -Dgroups="org.antlr.v4.test.runtime.category.LeftRecursionTests" -Dtest="swift.*" test
+  else
+      mvn -e -q -Dtest=swift.* test
+  fi
+  rc=$?
+  cat target/surefire-reports/*.dumpstream || true
+fi
+exit $rc

.github/workflows/java-all.yml

@@ -0,0 +1,28 @@
+name: Java/MacOSX
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: [self-hosted, macOS, x64]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up JDK 1.8
+      uses: actions/setup-java@v1
+      with:
+        java-version: 1.8
+    - name: Set up Maven
+      uses: stCarolas/setup-maven@v4
+      with:
+        maven-version: 3.5.4    
+    - name: Build tool with Maven
+      run: mvn install -DskipTests=true -Dmaven.javadoc.skip=true -B -V
+    - name: Test with Maven
+      run: .github/scripts/run-tests-java.sh
+      env: 
+        TARGET: swift
+        GROUP: ALL

.github/workflows/swift-macosx.yml

@@ -0,0 +1,35 @@
+name: Swift/MacOSX
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: [self-hosted, macOS, x64]
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - GROUP: LEXER
+          - GROUP: PARSER
+          - GROUP: RECURSION
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up JDK 1.8
+      uses: actions/setup-java@v1
+      with:
+        java-version: 1.8
+    - name: Set up Maven
+      uses: stCarolas/setup-maven@v4
+      with:
+        maven-version: 3.5.4    
+    - name: Build tool with Maven
+      run: mvn install -DskipTests=true -Dmaven.javadoc.skip=true -B -V
+    - name: Test with Maven
+      run: arch -x86_64 .github/scripts/run-tests-swift.sh
+      env: 
+        TARGET: swift
+        GROUP: ${{ matrix.GROUP }}

runtime-testsuite/test/org/antlr/v4/test/runtime/BaseRuntimeTest.java

@@ -11,9 +11,7 @@
 import org.antlr.v4.runtime.misc.Utils;
 import org.antlr.v4.tool.ANTLRMessage;
 import org.antlr.v4.tool.DefaultToolListener;
-import org.junit.Before;
-import org.junit.Rule;
-import org.junit.Test;
+import org.junit.*;
 import org.junit.rules.TestRule;
 import org.junit.rules.TestWatcher;
 import org.junit.runner.Description;
@@ -44,6 +42,7 @@
  *  @since 4.6.
  */
 public abstract class BaseRuntimeTest {
+
 	public final static String[] Targets = {
 		"Cpp",
 		"CSharp",
@@ -56,18 +55,43 @@ public abstract class BaseRuntimeTest {
 		"Swift"
 	};
 
-	static {
-		// Add heartbeat thread to gen minimal output for travis, appveyor to
-		// avoid timeout.
+	@BeforeClass
+	public static void startHeartbeatToAvoidTimeout() {
+		if (isTravisCI() || isAppVeyorCI())
+			startHeartbeat();
+	}
+
+	@AfterClass
+	public static void stopHeartbeat() {
+		heartbeat = false;
+	}
+
+	private static boolean isAppVeyorCI() {
+		// see https://www.appveyor.com/docs/environment-variables/
+		String s = System.getenv("APPVEYOR");
+		return s!=null && "true".equals(s.toLowerCase());
+	}
+
+	private static boolean isTravisCI() {
+		// see https://docs.travis-ci.com/user/environment-variables/#default-environment-variables
+		String s = System.getenv("TRAVIS");
+		return s!=null && "true".equals(s.toLowerCase());
+	}
+
+	static boolean heartbeat = false;
+
+	private static void startHeartbeat() {
+		// Add heartbeat thread to gen minimal output for travis, appveyor to avoid timeout.
 		Thread t = new Thread("heartbeat") {
 			@Override
 			public void run() {
-				while (true) {
+				heartbeat = true;
+				while (heartbeat) {
 					System.out.print('.');
 					try {
+						//noinspection BusyWait
 						Thread.sleep(5000);
-					}
-					catch (Exception e) {
+					} catch (Exception e) {
 						e.printStackTrace();
 					}
 				}
@@ -118,18 +142,20 @@ protected void succeeded(Description description) {
 
 	@Test
 	public void testOne() throws Exception {
+		// System.out.println(descriptor.getTestName());
 		// System.out.println(delegate.getTmpDir());
 		if (descriptor.ignore(descriptor.getTarget()) ) {
 			System.out.println("Ignore " + descriptor);
 			return;
 		}
-
+		delegate.beforeTest(descriptor);
 		if (descriptor.getTestType().contains("Parser") ) {
 			testParser(descriptor);
 		}
 		else {
 			testLexer(descriptor);
 		}
+		delegate.afterTest(descriptor);
 	}
 
 	public void testParser(RuntimeTestDescriptor descriptor) throws Exception {

runtime-testsuite/test/org/antlr/v4/test/runtime/RuntimeTestSupport.java

@@ -39,4 +39,7 @@ String execParser(String grammarFileName,
 	                  String startRuleName,
 	                  String input,
 	                  boolean showDiagnosticErrors);
+
+    void beforeTest(RuntimeTestDescriptor descriptor);
+	void afterTest(RuntimeTestDescriptor descriptor);
 }

runtime-testsuite/test/org/antlr/v4/test/runtime/cpp/BaseCppTest.java

@@ -35,6 +35,7 @@
 import org.antlr.v4.runtime.tree.ParseTree;
 import org.antlr.v4.semantics.SemanticPipeline;
 import org.antlr.v4.test.runtime.ErrorQueue;
+import org.antlr.v4.test.runtime.RuntimeTestDescriptor;
 import org.antlr.v4.test.runtime.RuntimeTestSupport;
 import org.antlr.v4.test.runtime.StreamVacuum;
 import org.antlr.v4.tool.ANTLRMessage;
@@ -111,6 +112,14 @@ public void testSetUp() throws Exception {
 	public void testTearDown() throws Exception {
 	}
 
+	@Override
+	public void beforeTest(RuntimeTestDescriptor descriptor) {
+	}
+
+	@Override
+	public void afterTest(RuntimeTestDescriptor descriptor) {
+	}
+
 	@Override
 	public String getTmpDir() {
 		return tmpdir;

runtime-testsuite/test/org/antlr/v4/test/runtime/csharp/BaseCSharpTest.java

@@ -11,10 +11,7 @@
 import org.antlr.v4.runtime.TokenSource;
 import org.antlr.v4.runtime.WritableToken;
 import org.antlr.v4.runtime.misc.Utils;
-import org.antlr.v4.test.runtime.ErrorQueue;
-import org.antlr.v4.test.runtime.RuntimeTestSupport;
-import org.antlr.v4.test.runtime.StreamVacuum;
-import org.antlr.v4.test.runtime.TestOutputReading;
+import org.antlr.v4.test.runtime.*;
 import org.antlr.v4.tool.ANTLRMessage;
 import org.antlr.v4.tool.GrammarSemanticsMessage;
 import org.junit.rules.TestRule;
@@ -143,6 +140,14 @@ public void testSetUp() throws Exception {
 	public void testTearDown() throws Exception {
 	}
 
+	@Override
+	public void beforeTest(RuntimeTestDescriptor descriptor) {
+	}
+
+	@Override
+	public void afterTest(RuntimeTestDescriptor descriptor) {
+	}
+
 	@Override
 	public String getTmpDir() {
 		return tmpdir;

runtime-testsuite/test/org/antlr/v4/test/runtime/dart/BaseDartTest.java

@@ -22,10 +22,7 @@
 import org.antlr.v4.runtime.misc.Pair;
 import org.antlr.v4.runtime.tree.ParseTree;
 import org.antlr.v4.semantics.SemanticPipeline;
-import org.antlr.v4.test.runtime.BaseRuntimeTest;
-import org.antlr.v4.test.runtime.ErrorQueue;
-import org.antlr.v4.test.runtime.RuntimeTestSupport;
-import org.antlr.v4.test.runtime.StreamVacuum;
+import org.antlr.v4.test.runtime.*;
 import org.antlr.v4.test.runtime.descriptors.LexerExecDescriptors;
 import org.antlr.v4.test.runtime.descriptors.PerformanceDescriptors;
 import org.antlr.v4.tool.*;
@@ -153,6 +150,14 @@ public void testSetUp() throws Exception {
 	public void testTearDown() throws Exception {
 	}
 
+	@Override
+	public void beforeTest(RuntimeTestDescriptor descriptor) {
+	}
+
+	@Override
+	public void afterTest(RuntimeTestDescriptor descriptor) {
+	}
+
 	@Override
 	public String getTmpDir() {
 		return tmpdir;

runtime-testsuite/test/org/antlr/v4/test/runtime/go/BaseGoTest.java

@@ -32,6 +32,7 @@
 import org.antlr.v4.runtime.misc.Interval;
 import org.antlr.v4.semantics.SemanticPipeline;
 import org.antlr.v4.test.runtime.ErrorQueue;
+import org.antlr.v4.test.runtime.RuntimeTestDescriptor;
 import org.antlr.v4.test.runtime.RuntimeTestSupport;
 import org.antlr.v4.test.runtime.StreamVacuum;
 import org.antlr.v4.tool.ANTLRMessage;
@@ -120,6 +121,14 @@ public static void groupSetUp() throws Exception {
 	public void testTearDown() throws Exception {
 	}
 
+	@Override
+	public void beforeTest(RuntimeTestDescriptor descriptor) {
+	}
+
+	@Override
+	public void afterTest(RuntimeTestDescriptor descriptor) {
+	}
+
 	@Override
 	public String getTmpDir() {
 		return tmpdir.getPath();

runtime-testsuite/test/org/antlr/v4/test/runtime/java/BaseJavaTest.java

@@ -36,10 +36,7 @@
 import org.antlr.v4.runtime.misc.Pair;
 import org.antlr.v4.runtime.tree.ParseTree;
 import org.antlr.v4.semantics.SemanticPipeline;
-import org.antlr.v4.test.runtime.BaseRuntimeTest;
-import org.antlr.v4.test.runtime.ErrorQueue;
-import org.antlr.v4.test.runtime.RuntimeTestSupport;
-import org.antlr.v4.test.runtime.StreamVacuum;
+import org.antlr.v4.test.runtime.*;
 import org.antlr.v4.tool.ANTLRMessage;
 import org.antlr.v4.tool.Grammar;
 import org.antlr.v4.tool.GrammarSemanticsMessage;
@@ -196,6 +193,14 @@ public void testSetUp() throws Exception {
 	public void testTearDown() throws Exception {
 	}
 
+	@Override
+	public void beforeTest(RuntimeTestDescriptor descriptor) {
+	}
+
+	@Override
+	public void afterTest(RuntimeTestDescriptor descriptor) {
+	}
+
 	@Override
 	public String getTmpDir() {
 		return tmpdir;