Cleanup and reorganize tooling

  + refactor Makefile to stay in synch with AuDoscore
  + bring back the PTC (public test cleaner) - but as preliminary shell script
  + replace Unicode "✓" / "✗" with ASCII "\u2713" / "\u2717" in PointsMerger to satisfy "-encoding ASCII"
  + add initial "tests/compare_interface_top/" - methods work ok, but functions have heavy type erasure in class file

Author: ntoster

Makefile

@@ -57,6 +57,7 @@ compile-stage1: miniclean compile-stage0
 		cat forbidden.out 1>&2 ; \
 		exit 1 ; \
 	fi
+	cd $(cleanroomDirName); scalac $(COMPILER_ARGS) -cp ../$(interfacesDirName) *.scala
 	make run-comparer
 
 compile-stage2: miniclean compile-stage1
@@ -71,7 +72,6 @@ compile-stage2: miniclean compile-stage1
 	echo "echo \"]\" 1>&2" >> loop.sh
 
 compile-stage2-secret:
-	cd $(cleanroomDirName); scalac $(COMPILER_ARGS) -cp ../$(interfacesDirName) *.scala
 	scalac $(COMPILER_ARGS) -cp $(LIBALL):$(junitDirName):$(interfacesDirName):$(sutDirName) -d $(junitDirName) $(junitDirName)/$(SECRETTESTSOURCE)
 	java -cp $(LIBALL):$(junitDirName):$(interfacesDirName):$(sutDirName) -Dpub=$(PUBLICTEST) tester.tools.CheckAnnotation $(SECRETTEST)
 	java -cp $(LIBALL) tester.tools.ReplaceManager $(SECRETTEST) > compile2.sh
@@ -106,26 +106,26 @@ run: run-stage$(STAGE)
 
 
 help:
-	@echo '==========================================================='
-	@echo 'Welcome to AuDoscore - The Grading System for Java Homework'
-	@echo '-----------------------------------------------------------'
+	@echo '=========================================================================='
+	@echo 'Welcome to AuDoscore/ScExFuSS - The Grading System for Java/Scala Homework'
+	@echo '--------------------------------------------------------------------------'
 	@echo 'This Makefile serves different purposes, but it is NOT used directly for the grading itself.'
 	@echo 'Running test cases for grading is done through the test.sh shell script (see README for details).'
-	@echo '-----------------------------------------------------------'
+	@echo '--------------------------------------------------------------------------'
 	@echo 'Developers/Users use this Makefile from the project root folder to make:'
 	@echo '- build:  freshly build the main library'
 	@echo '- verify: run all provided tests from the tests folder'
 	@echo '- clean:  remove all generated artifacts (including the main library!)'
-	@echo '-----------------------------------------------------------'
+	@echo '--------------------------------------------------------------------------'
 	@echo 'Testers use this Makefile from one of the provided test folders to make:'
 	@echo '- test_run:     run the test in the current folder (keeping temporary execution folder)'
 	@echo '- test_verify:  run and compare results of current test against its historical execution'
 	@echo '- test_REBUILD: run and update historical execution of current test to its new results'
 	@echo '- test_clean:   remove temporary execution folder (i.e. generated artifacts)'
-	@echo '-----------------------------------------------------------'
+	@echo '--------------------------------------------------------------------------'
 	@echo 'All other make targets are used by the test.sh shell script and should not be called directly.'
 	@echo 'Enjoy!'
-	@echo '==========================================================='
+	@echo '=========================================================================='
 
 
 test_run:

tester/tools/PointsMerger.java

@@ -170,7 +170,7 @@ private static void merge(ArrayList<JSONObject> replacedExercises, JSONObject va
 			}
 			double localScore = getLocalPoint((Boolean) usedResult.get("success"), (String) usedResult.get("id"), (Boolean) usedResult.get("fromSecret"));
 			localPoints += localScore;
-			localSummary += ((Boolean) usedResult.get("success")) ? "✓" : "✗";
+			localSummary += ((Boolean) usedResult.get("success")) ? "\u2713" : "\u2717";
 			localSummary += String.format(" %1$6.2f", localScore) + " | ";
 			localSummary += (String) usedResult.get("desc");
 			Object error = usedResult.get("error");

tests/compare_interface_top/Makefile

@@ -0,0 +1 @@
+include ../../Makefile

tests/compare_interface_top/cleanroom/ToTest.scala

@@ -0,0 +1,41 @@
+val topValFun: Int => Int = x => x + 1
+def topDefFun: Int => Int = x => x + 1
+def topDefMeth(x: Int): Int = x + 1
+
+trait ToTestTrait {
+	val traitValFun: Int => Int = x => x + 1
+	def traitDefFun: Int => Int = x => x + 1
+	def traitDefMeth(x: Int): Int = x + 1
+	def companionCommon: Int => Int = x => x + 1
+}
+
+object ToTest extends ToTestTrait {
+	val objectValFun: Int => Int = x => x + 1
+	def objectDefFun: Int => Int = x => x + 1
+	def objectDefMeth(x: Int): Int = x + 1
+	override def companionCommon: Int => Int = x => x + 1
+
+	@main
+	def objectDefMethMainAnnotated(): Unit = {
+		println(topValFun(42))
+	}
+}
+
+class ToTest extends ToTestTrait {
+	val classValFun: Int => Int = x => x + 1
+	def classDefFun: Int => Int = x => x + 1
+	def classDefMeth(x: Int): Int = x + 1
+	override def companionCommon: Int => Int = x => x + 1
+}
+
+object TestObjectWithMain {
+	def main(args: Array[String]): Unit = {
+		println(42)
+		println(topValFun(666))
+	}
+}
+
+@main
+def main(): Unit = {
+	println(topValFun(4711))
+}

tests/compare_interface_top/expected/comp0

@@ -0,0 +1,4 @@
+make[1]: Verzeichnis „/ScExFuSS/tests/compare_interface_top/test.402801“ wird betreten
+if [ -d "interfaces" ]; then cd interfaces; scalac  *.scala; fi
+cd student; scalac  -cp ../interfaces *.scala
+make[1]: Verzeichnis „/ScExFuSS/tests/compare_interface_top/test.402801“ wird verlassen

tests/compare_interface_top/expected/comp1.err

@@ -0,0 +1,5 @@
+ERROR - Method public static int ToTest$package.topDefMeth(int)[ToTest$package] does not match or does not exist in student code
+Exception in thread "main" java.lang.Error
+	at tester.tools.InterfaceComparator.main(InterfaceComparator.java:334)
+make[2]: *** [Makefile:85: run-comparer] Fehler 1
+make[1]: *** [Makefile:58: compile-stage1] Fehler 2

tests/compare_interface_top/junit/PublicTest.scala

@@ -0,0 +1,13 @@
+import org.junit.Test
+import org.junit.Assert.*
+import tester.annotations.*
+
+@Exercises(Array(new Ex(exID = "SimpleTest", points = 42)))
+@CompareInterface(Array("ToTest$package"))
+class PublicTest extends JUnitWithPoints {
+	@Points(exID = "SimpleTest", bonus = 1)
+	@Test(timeout = 666)
+	def publicTest(): Unit = {
+		fail("Should never be executed.")
+	}
+}

tests/compare_interface_top/junit/SecretTest.scala

@@ -0,0 +1,12 @@
+import org.junit.Test
+import org.junit.Assert.*
+import tester.annotations.*
+
+@SecretClass
+class SecretTest extends JUnitWithPoints {
+	@Points(exID = "SimpleTest", bonus = 1)
+	@Test(timeout = 666)
+	def secretTest(): Unit = {
+		fail("Should never be executed.")
+	}
+}

tests/compare_interface_top/student/ToTest.scala

@@ -0,0 +1,41 @@
+val topValFun: Int => Long = x => x - 1 // wrong types are intentional - BUT NOT DETECTED due to type erasure of "scala.Function1<java.lang.Object, java.lang.Object>" in .class!
+def topDefFun: Long => Long = x => x - 1 // wrong types are intentional - BUT NOT DETECTED due to type erasure of "scala.Function1<java.lang.Object, java.lang.Object>" in .class!
+def topDefMeth(x: Long): Long = x - 1 // wrong types are intentional - only this is found as scala generates "public static int topDefMeth(int);"
+
+trait ToTestTrait {
+	val traitValFun: Int => Int = x => x - 1
+	def traitDefFun: Int => Int = x => x - 1
+	def traitDefMeth(x: Int): Int = x - 1
+	def companionCommon: Int => Int = x => x - 1
+}
+
+object ToTest extends ToTestTrait {
+	val objectValFun: Int => Int = x => x - 1
+	def objectDefFun: Int => Int = x => x - 1
+	def objectDefMeth(x: Int): Int = x - 1
+	override def companionCommon: Int => Int = x => x - 1
+
+	@main
+	def objectDefMethMainAnnotated(): Unit = {
+		println(topValFun(42))
+	}
+}
+
+class ToTest extends ToTestTrait {
+	val classValFun: Int => Int = x => x - 1
+	def classDefFun: Int => Int = x => x - 1
+	def classDefMeth(x: Int): Int = x - 1
+	override def companionCommon: Int => Int = x => x - 1
+}
+
+object TestObjectWithMain {
+	def main(args: Array[String]): Unit = {
+		println(42)
+		println(topValFun(666))
+	}
+}
+
+@main
+def main(): Unit = {
+	println(topValFun(4711))
+}

tools/pubtest_cleaner.sh

@@ -0,0 +1,73 @@
+#!/bin/bash
+
+declare -a wholeLinePatterns=(
+	"@.*CompareInterface(.*"
+	"@.*Exercises(.*" # includes @Ex
+	"@.*Forbidden(.*"
+	"@.*InitializeOnce(.*"
+	"@.*NotForbidden(.*"
+	"@.*Points(.*"
+	"@.*Replace(.*"
+	"@.*SecretClass\$"
+	"import tester\..*"
+	"import org\.junit\.Rule" "import org\.junit\.ClassRule"
+	"@Rule" "@org\.junit\.Rule" "@ClassRule" "@org\.junit\.ClassRule"
+	"public final PointsLogger" "public final static PointsSummary" "public static final PointsSummary"
+)
+
+declare -a substringPatterns=(
+	"extends JUnitWithPoints"
+)
+
+function clean_file {
+	file=$1
+	if [[ $file == *.java || $file == *.scala ]];then
+		for i in "${wholeLinePatterns[@]}"; do
+			sed -i "/${i}/d" $file
+		done
+		for i in "${substringPatterns[@]}"; do
+			sed -i "s/${i}//g" $file
+		done
+	fi
+}
+
+function recursive_clean {
+	start_dir=$1
+	for file in "$start_dir"/*; do
+		if [ ! -d "$file" ]; then
+			clean_file $file
+		else
+			recursive_clean $file
+		fi
+	done
+}
+
+
+recursive=0
+arg=$1
+
+if [ "x$arg" == "x-r" ]; then
+	recursive=1
+	shift
+	arg=$1
+fi
+
+## check input file? or directory?
+if [ -d $arg ]; then
+	if [ $recursive -eq 1 ]; then
+		echo "-r not supported yet!"
+		exit 1
+		#recursive_clean $arg
+	else
+		for file in "$arg"; do
+			if [ -f $file ]; then
+				clean_file $arg
+			fi
+		done
+	fi
+elif [ -f $arg ]; then
+	clean_file $arg
+else
+	echo "$arg is not valid"
+	exit 1
+fi