Parallel lock free testing, remove potential deadlocks, cache static data, go to descriptor via test

doc/antlr-project-testing.md

@@ -87,6 +87,8 @@ And the result of testing the entire subdirectory:
 
 All test are run in parallel both via maven and via IDE.
 
+In IntelliJ, it's very easy to go to source by right-click on any test and pressing `Jump to source` (F4).
+
 ## Running test subsets
 
 From the `runtime-testsuite` dir

doc/creating-a-language-target.md

@@ -6,19 +6,42 @@ This document describes how to make ANTLR generate parsers in a new language, *X
 
 Creating a new target involves the following key elements:
 
-1. For the tool, create class *X*Target as a subclass of class `Target` in package `org.antlr.v4.codegen.target`. This class describes language specific details about escape characters and strings and so on. There is very little to do here typically.
-1. Create *X*.stg in directory tool/resources/org/antlr/v4/tool/templates/codegen/*X*/*X*.stg. This is a [StringTemplate](http://www.stringtemplate.org/) group file (`.stg`) that tells ANTLR how to express all of the parsing elements needed to generate code.  You will see templates called `ParserFile`, `Parser`, `Lexer`, `CodeBlockForAlt`, `AltBlock`, etc... Each of these must be described how to build the indicated chunk of code. Your best bet is to find the closest existing target, copy that template file, and tweak to suit.
-1. Create a runtime library to support the parsers generated by ANTLR. Under directory runtime/*X*, you are in complete control of the directory structure as dictated by common usage of that target language. For example, Java has: `runtime/Java/lib` and `runtime/Java/src` directories. Under `src`, you will find a directory structure for package `org.antlr.v4.runtime` and below.
-1. Create a template file for runtime tests. All you have to do is provide a few templates that indicate how to print values and declare variables. Our runtime test mechanism in dir `runtime-testsuite` will automatically generate code using these templates for each target and check the test results.  It needs to know how to define various class fields, compare members and so on. You must create a *X*.test.stg file underneath [runtime-testsuite/resources/org/antlr/v4/test/runtime](https://github.com/antlr/antlr4/tree/master/runtime-testsuite/resources/org/antlr/v4/test/runtime). Again, your best bet is to copy the templates from the closest language to your target and tweak it to suit.
-1. Create test files under [/runtime-testsuite/test/org/antlr/v4/test/runtime](https://github.com/antlr/antlr4/tree/master/runtime-testsuite/test/org/antlr/v4/test/runtime). They will load defined test cases in each test descriptor. Also add the `/runtime-testsuite/test/org/antlr/v4/test/runtime/X/BaseXTest.java` which defines how test cases will execute and output.
-1. Create/edit shell scripts in [/.travis](https://github.com/antlr/antlr4/blob/master/.travis) and [/appveyor.yml](https://github.com/antlr/antlr4/blob/master/appveyor.yml) to run tests in CI pipelines.
+1. For the tool, create class *X*Target as a subclass of class `Target` in package `org.antlr.v4.codegen.target`.
+   This class describes language specific details about escape characters and strings and so on.
+   There is very little to do here typically.
+2. Create `*X*.stg` in directory `tool/resources/org/antlr/v4/tool/templates/codegen/*X*/*X*.stg`.
+   This is a [StringTemplate](http://www.stringtemplate.org/) group file (`.stg`) that tells ANTLR how to express
+   all the parsing elements needed to generate code.
+   You will see templates called `ParserFile`, `Parser`, `Lexer`, `CodeBlockForAlt`, `AltBlock`, etc...
+   Each of these must be described how to build the indicated chunk of code.
+   Your best bet is to find the closest existing target, copy that template file, and tweak to suit.
+3. Create a runtime library to support the parsers generated by ANTLR.
+   Under directory `runtime/*X*`, you are in complete control of the directory structure as dictated by common usage of that target language.
+   For example, Java has: `runtime/Java/lib` and `runtime/Java/src` directories.
+   Under `src`, you will find a directory structure for package `org.antlr.v4.runtime` and below.
+4. Create a template file for runtime tests.
+   All you have to do is provide a few templates that indicate how to print values and declare variables.
+   Our runtime test mechanism in dir `runtime-testsuite` will automatically generate code using these templates for each target and check the test results.
+   It needs to know how to define various class fields, compare members and so on.
+   You must create a `*X*.test.stg` file underneath [runtime-testsuite/resources/org/antlr/v4/test/runtime](../runtime-testsuite/resources/org/antlr/v4/test/runtime)
+   and `Test.*x*.stg` underneath [runtime-testsuite/resources/org/antlr/v4/test/runtime/helpers](../runtime-testsuite/resources/org/antlr/v4/test/runtime/helpers).
+   Again, your best bet is to copy the templates from the closest language to your target and tweak it to suit.
+6. Create test files under [/runtime-testsuite/test/org/antlr/v4/test/runtime](../runtime-testsuite/test/org/antlr/v4/test/runtime).
+   They will load defined test cases in each test descriptor.
+   Also add the `/runtime-testsuite/test/org/antlr/v4/test/runtime/X/BaseXTest.java` which defines how test cases will execute and output.
+7. Create/edit shell scripts in [/.github](../.github) and [/.circleci](../.circleci) to run tests in CI pipelines.
 
 ## Getting started
 
-1. Fork the `antlr/antlr4` repository at github to your own user so that you have repository `username/antlr4`.
-2. Clone `username/antlr4`, the forked repository, to your local disk.  Your remote `origin` will be the forked repository on GitHub. Add a remote `upstream` to the original `antlr/antlr4` repository (URL `https://github.com/antlr/antlr4.git`). Changes that you would like to contribute back to the project are done with [pull requests](https://help.github.com/articles/using-pull-requests/).
+1. Fork the `antlr/antlr4` repository at GitHub to your own user so that you have repository `username/antlr4`.
+2. Clone `username/antlr4`, the forked repository, to your local disk.
+   Your remote `origin` will be the forked repository on GitHub.
+   Add a remote `upstream` to the original `antlr/antlr4` repository (URL `https://github.com/antlr/antlr4.git`).
+   Changes that you would like to contribute back to the project are done with [pull requests](https://help.github.com/articles/using-pull-requests/).
 3. Try to build it before doing anything
+
 ```bash
 $ mvn compile
 ```
+
 That should proceed with success. See [Building ANTLR](building-antlr.md) for more details.

runtime-testsuite/pom.xml

@@ -30,7 +30,7 @@
 		<dependency>
 			<groupId>org.antlr</groupId>
 			<artifactId>ST4</artifactId>
-			<version>4.3.1</version>
+			<version>4.3.3</version>
 			<scope>test</scope>
 		</dependency>
 		<dependency>
@@ -72,19 +72,6 @@
 
 	<build>
 		<testSourceDirectory>test</testSourceDirectory>
-		<resources>
-			<resource>
-				<directory>resources</directory>
-			</resource>
-			<resource>
-				<directory>../runtime</directory>
-				<excludes>
-					<exclude>**/.build/**</exclude>
-					<exclude>**/target/**</exclude>
-					<exclude>Swift/*.xcodeproj/**</exclude>
-				</excludes>
-			</resource>
-		</resources>
 		<plugins>
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
@@ -93,18 +80,6 @@
 				<configuration>
 					<!-- SUREFIRE-951: file.encoding cannot be set via systemPropertyVariables -->
 					<argLine>-Dfile.encoding=UTF-8</argLine>
-					<includes>
-                        <include>**/csharp/Test*.java</include>
-                        <include>**/java/Test*.java</include>
-                        <include>**/java/api/Test*.java</include>
-                        <include>**/go/Test*.java</include>
-                        <include>**/javascript/Test*.java</include>
-                        <include>**/python2/Test*.java</include>
-                        <include>**/python3/Test*.java</include>
-                        <include>**/php/Test*.java</include>
-                        <include>**/dart/Test*.java</include>
-                        <include>${antlr.tests.swift}</include>
-                    </includes>
                 </configuration>
 			</plugin>
 			<plugin>

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

@@ -19,8 +19,7 @@
 import java.util.*;
 
 import static org.antlr.v4.test.runtime.FileUtils.*;
-import static org.antlr.v4.test.runtime.RuntimeTestUtils.FileSeparator;
-import static org.antlr.v4.test.runtime.RuntimeTestUtils.TempDirectory;
+import static org.antlr.v4.test.runtime.RuntimeTestUtils.*;
 
 public abstract class RuntimeRunner implements AutoCloseable {
 	public abstract String getLanguage();
@@ -93,7 +92,6 @@ public void close() {
 	private final static Object runtimeInitLockObject = new Object();
 
 	public final static String cacheDirectory;
-	public final static Path targetClassesPath;
 
 	private static class InitializationStatus {
 		public final Object lockObject = new Object();
@@ -104,7 +102,6 @@ private static class InitializationStatus {
 	private final static HashMap<String, InitializationStatus> runtimeInitializationStatuses = new HashMap<>();
 
 	static {
-		targetClassesPath = Paths.get(RuntimeTestUtils.runtimeTestsuitePath.toString(), "target", "classes");
 		cacheDirectory = new File(System.getProperty("java.io.tmpdir"), "ANTLR-runtime-testsuite-cache").getAbsolutePath();
 	}
 
@@ -121,7 +118,7 @@ protected final String getRuntimePath() {
 	}
 
 	public static String getRuntimePath(String language) {
-		return targetClassesPath.toString() + FileSeparator + language;
+		return runtimePath.toString() + FileSeparator + language;
 	}
 
 	public State run(RunOptions runOptions) {

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

@@ -26,6 +26,7 @@ public abstract class RuntimeTestUtils {
 	public static final String FileSeparator = System.getProperty("file.separator");
 	public static final String TempDirectory = System.getProperty("java.io.tmpdir");
 
+	public final static Path runtimePath;
 	public final static Path runtimeTestsuitePath;
 	public final static Path resourcePath;
 
@@ -49,6 +50,7 @@ public abstract class RuntimeTestUtils {
 			runtimeTestsuitePath = Paths.get("..", "runtime-testsuite").normalize();
 		}
 
+		runtimePath = Paths.get(runtimeTestsuitePath.toString(), "..", "runtime").normalize();
 		resourcePath = Paths.get(runtimeTestsuitePath.toString(), "resources");
 	}
 

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

@@ -126,40 +126,8 @@ private static String test(RuntimeTestDescriptor descriptor, RuntimeRunner runne
 
 		FileUtils.mkdir(runner.getTempDirPath());
 
-		STGroup targetTemplates = cachedTargetTemplates.get(targetName);
-		if (targetTemplates == null) {
-			synchronized (cachedTargetTemplates) {
-				targetTemplates = cachedTargetTemplates.get(targetName);
-				if (targetTemplates == null) {
-					ClassLoader classLoader = RuntimeTests.class.getClassLoader();
-					URL templates = classLoader.getResource("org/antlr/v4/test/runtime/templates/" + targetName + ".test.stg");
-					assert templates != null;
-					targetTemplates = new STGroupFile(templates, "UTF-8", '<', '>');
-					targetTemplates.registerRenderer(String.class, rendered);
-					cachedTargetTemplates.put(targetName, targetTemplates);
-				}
-			}
-		}
-
-		// write out any slave grammars
-		List<Pair<String, String>> slaveGrammars = descriptor.slaveGrammars;
-		if ( slaveGrammars!=null ) {
-			for (Pair<String, String> spair : slaveGrammars) {
-				STGroup g = new STGroup('<', '>');
-				g.registerRenderer(String.class, rendered);
-				g.importTemplates(targetTemplates);
-				ST grammarST = new ST(g, spair.b);
-				writeFile(runner.getTempDirPath(), spair.a + ".g4", grammarST.render());
-			}
-		}
-
 		String grammarName = descriptor.grammarName;
-		String grammar =  descriptor.grammar;
-		STGroup g = new STGroup('<', '>');
-		g.importTemplates(targetTemplates);
-		g.registerRenderer(String.class, rendered);
-		ST grammarST = new ST(g, grammar);
-		grammar = grammarST.render();
+		String grammar = prepareGrammars(descriptor, runner);
 
 		String lexerName, parserName;
 		boolean useListenerOrVisitor;
@@ -209,6 +177,42 @@ private static String test(RuntimeTestDescriptor descriptor, RuntimeRunner runne
 		return assertCorrectOutput(descriptor, targetName, result);
 	}
 
+	private static String prepareGrammars(RuntimeTestDescriptor descriptor, RuntimeRunner runner) {
+		String targetName = runner.getLanguage();
+		STGroup targetTemplates = cachedTargetTemplates.get(targetName);
+		if (targetTemplates == null) {
+			synchronized (cachedTargetTemplates) {
+				targetTemplates = cachedTargetTemplates.get(targetName);
+				if (targetTemplates == null) {
+					ClassLoader classLoader = RuntimeTests.class.getClassLoader();
+					URL templates = classLoader.getResource("org/antlr/v4/test/runtime/templates/" + targetName + ".test.stg");
+					assert templates != null;
+					targetTemplates = new STGroupFile(templates, "UTF-8", '<', '>');
+					targetTemplates.registerRenderer(String.class, rendered);
+					cachedTargetTemplates.put(targetName, targetTemplates);
+				}
+			}
+		}
+
+		// write out any slave grammars
+		List<Pair<String, String>> slaveGrammars = descriptor.slaveGrammars;
+		if ( slaveGrammars!=null ) {
+			for (Pair<String, String> spair : slaveGrammars) {
+				STGroup g = new STGroup('<', '>');
+				g.registerRenderer(String.class, rendered);
+				g.importTemplates(targetTemplates);
+				ST grammarST = new ST(g, spair.b);
+				writeFile(runner.getTempDirPath(), spair.a + ".g4", grammarST.render());
+			}
+		}
+
+		STGroup g = new STGroup('<', '>');
+		g.importTemplates(targetTemplates);
+		g.registerRenderer(String.class, rendered);
+		ST grammarST = new ST(g, descriptor.grammar);
+		return grammarST.render();
+	}
+
 	private static String assertCorrectOutput(RuntimeTestDescriptor descriptor, String targetName, State state) {
 		ExecutedState executedState;
 		if (state instanceof ExecutedState) {

runtime-testsuite/test/org/antlr/v4/test/runtime/swift/SwiftRunner.java

@@ -33,7 +33,7 @@ public String getTestFileName() {
 
 	static {
 		String swiftRuntimePath = getRuntimePath("Swift");
-		antlrRuntimePath = Paths.get(swiftRuntimePath, "..", "..", "..", "..").normalize().toString();
+		antlrRuntimePath = Paths.get(swiftRuntimePath, "..", "..").normalize().toString();
 		String dylibPath = antlrRuntimePath + "/.build/release/";
 		initPackageArgs = new String[]{"swift", "package", "init", "--type", "executable"};
 		buildProjectArgs = new String[]{"swift", "build", "-c", "release", "-Xswiftc", "-I" + dylibPath, "-Xlinker", "-L" + dylibPath,