moved unittests to utest library (#679)

* moved unittests to utest library

.github/workflows/formatter.yml

@@ -14,7 +14,7 @@ jobs:
   build:
     strategy:
       matrix:
-        haxe-version: ['4.3.3', 'nightly']
+        haxe-version: ['4.3.4', 'nightly']
         platform: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.platform }}
     steps:
@@ -50,11 +50,12 @@ jobs:
       run: npx haxe buildJava.hxml
     - name: Build JSON schema
       run: npx haxe buildSchema.hxml
-    - name: Run eval tests
-      if: (matrix.haxe-version == '4.3.3')
-      run: npx haxe -D codecov_json test.hxml
+    - name: Run eval tests (without coverage)
+      run: npx haxe test.hxml
+    - name: Run eval tests (with coverage)
+      run: npx haxe testCoverage.hxml
     - name: Run Java tests
-      run: npx haxe -D codecov_json testJava.hxml
+      run: npx haxe testJava.hxml
     - name: Run Node version with --check
       run: node run.js -s . --check
     - name: Run Java version with --check
@@ -73,5 +74,5 @@ jobs:
     #       name: formatter.js
     #       path: bin/formatter.js
     - name: Upload results to codecov
-      if: success() && matrix.platform == 'ubuntu-latest' && (matrix.haxe-version == '4.3.3')
+      if: success() && matrix.platform == 'ubuntu-latest' && (matrix.haxe-version == '4.3.4')
       run: bash <(curl -s https://codecov.io/bash) || echo "Codecov did not collect coverage reports"

.haxerc

@@ -1,4 +1,4 @@
 {
-  "version": "4.3.3",
+  "version": "4.3.4",
   "resolveLibs": "scoped"
 }

.vscode/settings.json

@@ -11,8 +11,5 @@
 		"schema",
 		"test"
 	],
-	"haxe.importsSortOrder": "stdlib -> libs -> project",
-	"coverage-gutters.showLineCoverage": false,
-	"coverage-gutters.showRulerCoverage": false,
-	"coverage-gutters.partialHighlightDark": "rgba(120, 120, 120, 0.75)"
+	"haxe.importsSortOrder": "stdlib -> libs -> project"
 }

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## dev branch / next version (1.x.x)
 
+- Refactored unittests to work with utest library ([#679](https://github.com/HaxeCheckstyle/haxe-formatter/issues/679))
+- Removed munit library ([#679](https://github.com/HaxeCheckstyle/haxe-formatter/issues/679))
+
 ## version 1.16.0 (2024-02-10)
 
 - Added `wrapping.mapWrap`, fixes [#675](https://github.com/HaxeCheckstyle/haxe-formatter/issues/675) ([#677](https://github.com/HaxeCheckstyle/haxe-formatter/issues/677))

buildCommon.hxml

@@ -7,6 +7,7 @@
 
 -dce full
 -D analyzer-optimize
+-D haxe-next
 
 -cp src
 

display.hxml

@@ -7,8 +7,7 @@
 -lib hxparse
 -lib json2object
 -lib hxargs
--lib mcover
--lib munit
 -lib safety
--lib test-adapter
 -lib instrument
+-lib utest
+-lib test-adapter

haxe_libraries/test-adapter.hxml

@@ -1,5 +1,5 @@
-# @install: lix --silent download "haxelib:/test-adapter#2.0.6" into test-adapter/2.0.6/haxelib
+# @install: lix --silent download "haxelib:/test-adapter#2.0.7" into test-adapter/2.0.7/haxelib
 -lib json2object
--cp ${HAXE_LIBCACHE}/test-adapter/2.0.6/haxelib/
--D test-adapter=2.0.6
+-cp ${HAXE_LIBCACHE}/test-adapter/2.0.7/haxelib/
+-D test-adapter=2.0.7
 --macro _testadapter.Macro.init()

haxe_libraries/utest.hxml

@@ -0,0 +1,4 @@
+# @install: lix --silent download "gh://github.com/haxe-utest/utest#bdb5fec4b8e77d9a3c079d9cfb108f29f153721a" into utest/2.0.0-alpha/github/bdb5fec4b8e77d9a3c079d9cfb108f29f153721a
+-cp ${HAXE_LIBCACHE}/utest/2.0.0-alpha/github/bdb5fec4b8e77d9a3c079d9cfb108f29f153721a/src
+-D utest=2.0.0-alpha
+--macro utest.utils.Macro.importEnvSettings()

test.hxml

@@ -6,16 +6,17 @@
 -lib hxparse
 -lib json2object
 -lib hxargs
--lib mcover
--lib munit
-# -lib safety
+-lib utest
 -lib test-adapter
 
 # -D debugLog
 # -D debugIndent
 # -D detailed_coverage
 # -D debugWrapping
 -D unittest
+-D haxe-next
 -x TestMain
 
---macro mcover.MCover.coverage(['formatter'], ['src'], ['formatter.Cli'])
+-D UTEST_PRINT_TESTS
+
+# -D dump=pretty

test/GoldBaseTest.hx

@@ -3,12 +3,13 @@ import haxe.Template;
 import sys.io.File;
 import formatter.Formatter;
 import formatter.config.Config;
-import massive.munit.Assert;
 import tokentree.TokenTreeBuilder.TokenTreeEntryPoint;
 
 class GoldBaseTest {
 	var entryPoint:TokenTreeEntryPoint = null;
 
+	public function new() {}
+
 	function goldCheck(fileName:String, unformatted:String, goldCode:String, lineSeparator:String, ?configString:String, ?pos:PosInfos) {
 		var config = new Config();
 		config.readConfigFromString(configString, "goldhxformat.json");
@@ -41,14 +42,16 @@ class GoldBaseTest {
 				if (goldCode != formattedCode) {
 					File.saveContent("test/formatter-result.txt", '$goldCode\n---\n$formattedCode');
 				}
-				Assert.areEqual(goldCode, formattedCode, pos);
+				Assert.equals(goldCode, formattedCode, pos);
 			case Failure(errorMessage):
 				if (isFailing) {
+					Assert.isTrue(isFailing, "testcase is expected to fail");
 					return;
 				}
 				Assert.fail(errorMessage, pos);
 			case Disabled:
 				if (isDisabled) {
+					Assert.isTrue(isDisabled, "testcase is disabled");
 					return;
 				}
 				Assert.fail("Formatting is disabled", pos);

test/SelfTest.hx

@@ -1,30 +1,26 @@
 import haxe.PosInfos;
-import haxe.io.Bytes;
 import haxe.io.Path;
-import massive.munit.Assert;
-import formatter.Formatter;
-import formatter.codedata.ParseFile;
-import sys.io.File;
 import sys.FileSystem;
+import sys.io.File;
+import formatter.Formatter;
+
+class SelfTest implements ITest {
+	public function new() {}
 
-class SelfTest {
-	@Test
 	public function testSelfSrc() {
 		var files:Array<String> = collectAllFileNames("src");
 		for (file in files) {
 			checkFile(file);
 		}
 	}
 
-	@Test
 	public function testSelfTest() {
 		var files:Array<String> = collectAllFileNames("test");
 		for (file in files) {
 			checkFile(file);
 		}
 	}
 
-	@Test
 	public function testSelfSchema() {
 		var files:Array<String> = collectAllFileNames("schema");
 		for (file in files) {
@@ -40,7 +36,7 @@ class SelfTest {
 				if (code != formattedCode) {
 					File.saveContent("test/formatter-result.txt", '$code\n---\n$formattedCode');
 				}
-				Assert.areEqual(code, formattedCode, 'Format failed for $fileName', pos);
+				Assert.equals(code, formattedCode, 'Format failed for $fileName', pos);
 			case Failure(errorMessage):
 				Assert.fail(errorMessage);
 			case Disabled:

test/TestCaseMacro.hx

@@ -1,19 +1,35 @@
 import haxe.io.Path;
 import haxe.macro.Context;
 import haxe.macro.Expr;
+import haxe.macro.PositionTools;
 import haxe.macro.Type.ClassType;
 import sys.FileSystem;
 import sys.io.File;
 
+using haxe.macro.ExprTools;
+
 class TestCaseMacro {
 	#if macro
 	public macro static function build(folder:String):Array<Field> {
 		var fields:Array<Field> = Context.getBuildFields();
 		var cls:ClassType = Context.getLocalClass().get();
-
 		if (!shouldApply(cls, ":testcases")) {
 			return fields;
 		}
+		cls.meta.add(":testcases", [], cls.pos);
+
+		// revert the effects of implementing ITest interface
+		//
+		// unfortunately utest initialises before this macro runs, making our testcases invisible to utest.
+		// additionally test-adapter needs ITest interface to be able to collect position info of testcases
+		// which means we have to implement utests ITest interface to keep test explorer working.
+		//
+		// solution:
+		// we remove the field and meta info added by @:autoBuild (through ITest), add our testcases and
+		// then re-apply utest's test builder macro a second time
+		fields = fields.filter(f -> f.name != "__initializeUtest__");
+		cls.meta.remove(":utestProcessed");
+
 		var testCases:Array<String> = collectAllFileNames(folder);
 		var singleRun:TestSingleRun = new TestSingleRun();
 		for (testCase in testCases) {
@@ -52,14 +68,29 @@ class TestCaseMacro {
 		var unformatted:String = segments[1];
 		var gold:String = segments[2];
 		var fieldName:String = new haxe.io.Path(fileName).file;
+		fieldName = 'test_$fieldName';
 		var lineSeparator:String = detectLineSeparator(content);
 
-		return (macro class {
-			@Test
+		var field = (macro class {
 			public function $fieldName() {
 				goldCheck($v{fileName}, $v{unformatted}, $v{gold}, $v{lineSeparator}, $v{config});
 			};
 		}).fields[0];
+
+		// make assertion failures show up in testfile
+		field.pos = PositionTools.make({file: fileName, min: content.length, max: content.length});
+		switch (field.kind) {
+			case FFun(f):
+				relocateExpr(f.expr, field.pos);
+			default:
+		}
+
+		return field;
+	}
+
+	static function relocateExpr(expr:Expr, pos:Position):Expr {
+		expr.pos = pos;
+		return expr.map((e) -> relocateExpr(e, pos));
 	}
 
 	static function collectAllFileNames(path:String):Array<String> {

test/TestMain.hx

@@ -1,42 +1,67 @@
-import haxe.EntryPoint;
 import sys.io.File;
-import massive.munit.TestRunner;
-import mcover.coverage.MCoverage;
-import mcover.coverage.munit.client.MCoverPrintClient;
-#if codecov_json
-import mcover.coverage.client.CodecovJsonPrintClient;
-#else
-import mcover.coverage.client.LcovPrintClient;
-#end
+import formatter.EmptyLinesTest;
+import formatter.FormatStatsTest;
+import formatter.codedata.TokenListTest;
+import testcases.EmptyLinesTestCases;
+import testcases.ExpressionLevelTestCases;
+import testcases.FormatRangeTestCases;
+import testcases.IndentationTestCases;
+import testcases.LineEndsTestCases;
+import testcases.MissingTestCases;
+import testcases.Other;
+import testcases.SameLineTestCases;
+import testcases.WhitespaceTestCases;
+import testcases.WrappingTestCases;
+import utest.Runner;
+import utest.ui.text.DiagnosticsReport;
 
 class TestMain {
 	public function new() {
-		var suites:Array<Class<massive.munit.TestSuite>> = [TestSuite];
-		var client:MCoverPrintClient = new MCoverPrintClient();
-		#if codecov_json
-		MCoverage.getLogger().addClient(new CodecovJsonPrintClient());
-		#else
-		MCoverage.getLogger().addClient(new LcovPrintClient("Formatter Unittests"));
-		#end
+		var tests:Array<() -> ITest> = [];
 
-		#if detailed_coverage
-		client.includeClassAndPackageBreakdowns = true;
-		client.includeMissingBlocks = true;
-		#end
-		var runner = new TestRunner(client);
-		runner.completionHandler = completionHandler;
-		#if (neko || cpp || hl || java)
-		EntryPoint.addThread(function() {
-			while (true) {
-				Sys.sleep(1.0);
+		var singleRun:TestSingleRun = new TestSingleRun();
+		if (!singleRun.isSingleRun()) {
+			tests.push(SelfTest.new);
+			tests.push(FormatStatsTest.new);
+			tests.push(TokenListTest.new);
+			tests.push(EmptyLinesTest.new);
+		}
+
+		tests.push(cast EmptyLinesTestCases.new);
+		tests.push(cast ExpressionLevelTestCases.new);
+		tests.push(cast FormatRangeTestCases.new);
+		tests.push(cast IndentationTestCases.new);
+		tests.push(cast LineEndsTestCases.new);
+		tests.push(cast MissingTestCases.new);
+		tests.push(cast Other.new);
+		tests.push(cast SameLineTestCases.new);
+		tests.push(cast WhitespaceTestCases.new);
+		tests.push(cast WrappingTestCases.new);
+
+		var runner:Runner = new Runner();
+
+		var failed = false;
+		runner.onProgress.add(r -> {
+			if (!r.result.allOk()) {
+				failed = true;
 			}
 		});
-		#end
-		runner.run(suites);
-		EntryPoint.run();
+		runner.onComplete.add(_ -> {
+			completionHandler(!failed);
+		});
+
+		new DiagnosticsReport(runner);
+		for (test in tests) {
+			runner.addCase(test());
+		}
+		runner.run();
 	}
 
 	function completionHandler(success:Bool) {
+		#if instrument
+		instrument.coverage.Coverage.endCoverage();
+		#end
+
 		if (success) {
 			File.saveContent("test/formatter-result.txt", "\n---\n");
 		}