X-Git-Url: http://nitlanguage.org

diff --git a/src/testing/testing_suite.nit b/src/testing/testing_suite.nit
index 6a10288..43ac8f5 100644
--- a/src/testing/testing_suite.nit
+++ b/src/testing/testing_suite.nit
@@ -17,13 +17,14 @@ module testing_suite
 
 import testing_base
 import html
-private import annotation
+private import parse_annotations
+private import realtime
 
 redef class ToolContext
-	# -- target-file
-	var opt_file = new OptionString("Specify test suite location", "-t", "--target-file")
 	# --pattern
 	var opt_pattern = new OptionString("Only run test case with name that match pattern", "-p", "--pattern")
+	# --autosav
+	var opt_autosav = new OptionBool("Automatically create/update .res files for black box testing", "--autosav")
 end
 
 # Used to test nitunit test files.
@@ -32,45 +33,38 @@ class NitUnitTester
 	# `ModelBuilder` used to parse test files.
 	var mbuilder: ModelBuilder
 
-	# Parse a file and return the contained `MModule`.
-	private fun parse_module_unit(file: String): nullable MModule do
-		var mmodule = mbuilder.parse([file]).first
-		if mbuilder.get_mmodule_annotation("test_suite", mmodule) == null then return null
-		mbuilder.run_phases
-		return mmodule
-	end
-
-	# Compile and execute the test suite for a NitUnit `file`.
-	fun test_module_unit(file: String): nullable TestSuite do
+	# Compile and execute `mmodule` as a test suite.
+	fun test_module_unit(mmodule: MModule): TestSuite do
 		var toolcontext = mbuilder.toolcontext
-		var mmodule = parse_module_unit(file)
-		# is the module a test_suite?
-		if mmodule == null then return null
 		var suite = new TestSuite(mmodule, toolcontext)
 		# method to execute before all tests in the module
-		var before_module = mmodule.before_test
-		if before_module != null then
+		for mmethod in mmodule.before_all do
 			toolcontext.modelbuilder.total_tests += 1
-			suite.before_module = new TestCase(suite, before_module, toolcontext)
+			suite.before_all.add new TestCase(suite, mmethod, toolcontext)
 		end
 		# generate all test cases
 		for mclassdef in mmodule.mclassdefs do
 			if not mclassdef.is_test then continue
 			if not suite_match_pattern(mclassdef) then continue
 			toolcontext.modelbuilder.total_classes += 1
+
+			var before = mclassdef.before
+			var after = mclassdef.after
+
 			for mpropdef in mclassdef.mpropdefs do
 				if not mpropdef isa MMethodDef or not mpropdef.is_test then continue
 				if not case_match_pattern(mpropdef) then continue
 				toolcontext.modelbuilder.total_tests += 1
 				var test = new TestCase(suite, mpropdef, toolcontext)
-				suite.add_test test
+				test.before = before
+				test.after = after
+				suite.test_cases.add test
 			end
 		end
 		# method to execute after all tests in the module
-		var after_module = mmodule.after_test
-		if after_module != null then
+		for mmethod in mmodule.after_all do
 			toolcontext.modelbuilder.total_tests += 1
-			suite.after_module = new TestCase(suite, after_module, toolcontext)
+			suite.after_all.add new TestCase(suite, mmethod, toolcontext)
 		end
 		suite.run
 		return suite
@@ -123,42 +117,96 @@ class TestSuite
 	# List of `TestCase` to be executed in this suite.
 	var test_cases = new Array[TestCase]
 
-	# Add a `TestCase` to the suite.
-	fun add_test(case: TestCase) do test_cases.add case
+	# Tests to be executed before the whole test suite.
+	var before_all = new Array[TestCase]
 
-	# Test to be executed before the whole test suite.
-	var before_module: nullable TestCase = null
+	# Tests to be executed after the whole test suite.
+	var after_all = new Array[TestCase]
 
-	# Test to be executed after the whole test suite.
-	var after_module: nullable TestCase = null
+	# Display test suite status in std-out.
+	fun show_status do
+		var test_cases = self.test_cases.to_a
+		test_cases.add_all before_all
+		test_cases.add_all after_all
+		toolcontext.show_unit_status("Test-suite of module " + mmodule.full_name, test_cases)
+	end
 
 	# Execute the test suite
 	fun run do
+		set_env
+		show_status
 		if not toolcontext.test_dir.file_exists then
 			toolcontext.test_dir.mkdir
 		end
 		write_to_nit
 		compile
+		if failure != null then
+			for case in test_cases do
+				case.fail "Compilation Error"
+				case.raw_output = failure
+				toolcontext.clear_progress_bar
+				toolcontext.show_unit(case)
+			end
+			show_status
+			print ""
+			return
+		end
 		toolcontext.info("Execute test-suite {mmodule.name}", 1)
-		var before_module = self.before_module
-		if not before_module == null then before_module.run
-		for case in test_cases do case.run
-		var after_module = self.after_module
-		if not after_module == null then after_module.run
+
+		for before_module in before_all do
+			before_module.run
+			toolcontext.clear_progress_bar
+			toolcontext.show_unit(before_module)
+			if before_module.error != null then
+				for case in test_cases do
+					case.fail "Nitunit Error: before_module test failed"
+					toolcontext.clear_progress_bar
+					toolcontext.show_unit(case)
+				end
+				for after_module in after_all do
+					after_module.fail "Nitunit Error: before_module test failed"
+					toolcontext.clear_progress_bar
+					toolcontext.show_unit(after_module)
+				end
+				show_status
+				print ""
+				return
+			end
+		end
+
 		for case in test_cases do
-			print case.to_screen
+			case.run
+			toolcontext.clear_progress_bar
+			toolcontext.show_unit(case)
+			show_status
+		end
+
+		for after_module in after_all do
+			after_module.run
+			toolcontext.clear_progress_bar
+			toolcontext.show_unit(after_module)
+			show_status
 		end
+
+		show_status
+		print ""
 	end
 
 	# Write the test unit for `self` in a nit compilable file.
 	fun write_to_nit do
 		var file = new Template
-		file.addn "intrude import test_suite"
+		file.addn "intrude import core"
 		file.addn "import {mmodule.name}\n"
 		file.addn "var name = args.first"
+		for before_module in before_all do
+			before_module.write_to_nit(file)
+		end
 		for case in test_cases do
 			case.write_to_nit(file)
 		end
+		for after_module in after_all do
+			after_module.write_to_nit(file)
+		end
 		file.write_to_file("{test_file}.nit")
 	end
 
@@ -167,14 +215,7 @@ class TestSuite
 	fun to_xml: HTMLTag do
 		var n = new HTMLTag("testsuite")
 		n.attr("package", mmodule.name)
-		var failure = self.failure
-		if failure != null then
-			var f = new HTMLTag("failure")
-			f.attr("message", failure.to_s)
-			n.add f
-		else
-			for test in test_cases do n.add test.to_xml
-		end
+		for test in test_cases do n.add test.to_xml
 		return n
 	end
 
@@ -196,19 +237,21 @@ class TestSuite
 			return
 		end
 		var include_dir = module_file.filename.dirname
-		var cmd = "{nitc} --no-color '{file}.nit' -I {include_dir} -o '{file}.bin' > '{file}.out' 2>&1 </dev/null"
+		var cmd = "{nitc} --no-color -q '{file}.nit' -I {include_dir} -o '{file}.bin' > '{file}.out' 2>&1 </dev/null"
 		var res = toolcontext.safe_exec(cmd)
 		var f = new FileReader.open("{file}.out")
 		var msg = f.read_all
 		f.close
-		# set test case result
-		var loc = mmodule.location
 		if res != 0 then
 			failure = msg
-			toolcontext.warning(loc, "failure", "FAILURE: {mmodule.name} (in file {file}.nit): {msg}")
-			toolcontext.modelbuilder.failed_tests += 1
 		end
-		toolcontext.check_errors
+	end
+
+	# Set environment variables for test suite execution
+	fun set_env do
+		var loc = mmodule.location.file
+		if loc == null then return
+		toolcontext.set_testing_path(loc.filename)
 	end
 
 	# Error occured during test-suite compilation.
@@ -225,6 +268,12 @@ class TestCase
 	# Test method to be compiled and tested.
 	var test_method: MMethodDef
 
+	# Cases to execute before this one
+	var before = new Array[MMethodDef]
+
+	# Cases to execute after this one
+	var after = new Array[MMethodDef]
+
 	redef fun full_name do return test_method.full_name
 
 	redef fun location do return test_method.location
@@ -239,10 +288,14 @@ class TestCase
 		if test_method.mproperty.is_toplevel then
 			file.addn "\t{name}"
 		else
-			file.addn "\tvar subject = new {test_method.mclassdef.name}.nitunit"
-			file.addn "\tsubject.before_test"
+			file.addn "\tvar subject = new {test_method.mclassdef.name}.intern"
+			for mmethod in before do
+				file.addn "\tsubject.{mmethod.name}"
+			end
 			file.addn "\tsubject.{name}"
-			file.addn "\tsubject.after_test"
+			for mmethod in after do
+				file.addn "\tsubject.{mmethod.name}"
+			end
 		end
 		file.addn "end"
 	end
@@ -256,8 +309,12 @@ class TestCase
 		var method_name = test_method.name
 		var test_file = test_suite.test_file
 		var res_name = "{test_file}_{method_name.escape_to_c}"
+		var clock = new Clock
 		var res = toolcontext.safe_exec("{test_file}.bin {method_name} > '{res_name}.out1' 2>&1 </dev/null")
-		self.raw_output = "{res_name}.out1".to_path.read_all
+		if not toolcontext.opt_no_time.value then real_time = clock.total
+
+		var raw_output = "{res_name}.out1".to_path.read_all
+		self.raw_output = raw_output
 		# set test case result
 		if res != 0 then
 			error = "Runtime Error in file {test_file}.nit"
@@ -267,81 +324,143 @@ class TestCase
 			var mmodule = test_method.mclassdef.mmodule
 			var file = mmodule.filepath
 			if file != null then
-				var sav = file.dirname / mmodule.name + ".sav" / test_method.name + ".res"
-				if sav.file_exists then
+				var tries = [ file.dirname / mmodule.name + ".sav" / test_method.name + ".res",
+					file.dirname / "sav" / test_method.name + ".res" ,
+					file.dirname / test_method.name + ".res" ]
+				var savs = [ for t in tries do if t.file_exists then t ]
+				if savs.length == 1 then
+					var sav = savs.first
 					toolcontext.info("Diff output with {sav}", 1)
 					res = toolcontext.safe_exec("diff -u --label 'expected:{sav}' --label 'got:{res_name}.out1' '{sav}' '{res_name}.out1' > '{res_name}.diff' 2>&1 </dev/null")
-					if res != 0 then
+					if res == 0 then
+						# OK
+					else if toolcontext.opt_autosav.value then
+						raw_output.write_to_file(sav)
+						info = "Expected output updated: {sav} (--autoupdate)"
+					else
 						self.raw_output = "Diff\n" + "{res_name}.diff".to_path.read_all
 						error = "Difference with expected output: diff -u {sav} {res_name}.out1"
 						toolcontext.modelbuilder.failed_tests += 1
 					end
-				else
-					toolcontext.info("No diff: {sav} not found", 2)
+				else if savs.length > 1 then
+					toolcontext.info("Conflicting diffs: {savs.join(", ")}", 1)
+					error = "Conflicting expected output: {savs.join(", ", " and ")} all exist"
+					toolcontext.modelbuilder.failed_tests += 1
+				else if not raw_output.is_empty then
+					toolcontext.info("No diff: {tries.join(", ", " or ")} not found", 1)
+					if toolcontext.opt_autosav.value then
+						var sav = tries.first
+						sav.dirname.mkdir
+						raw_output.write_to_file(sav)
+						info = "Expected output saved: {sav} (--autoupdate)"
+					end
 				end
 			end
 		end
 		is_done = true
 	end
 
+	# Make the test case fail without testing it
+	#
+	# Useful when the compilation or the before_test failed.
+	fun fail(message: String) do
+		is_done = true
+		error = message
+		toolcontext.modelbuilder.failed_tests += 1
+	end
+
 	redef fun xml_classname do
-		var mclassdef = test_method.mclassdef
-		return "nitunit." + mclassdef.mmodule.full_name + "." + mclassdef.mclass.full_name
+		var a = test_method.full_name.split("$")
+		return "nitunit.{a[0]}.{a[1]}"
 	end
 
 	redef fun xml_name do
-		return test_method.mproperty.full_name
+		var a = test_method.full_name.split("$")
+		return a[2]
 	end
 end
 
-redef class MMethodDef
-	# TODO use annotations?
-
-	# Is the method a test_method?
-	# i.e. begins with "test_"
-	private fun is_test: Bool do return name.has_prefix("test_")
+redef class MClassDef
+	# Methods tagged with `before` in this class definition
+	private fun before: Array[MMethodDef] do
+		var res = new Array[MMethodDef]
+		for mpropdef in mpropdefs do
+			if mpropdef isa MMethodDef and mpropdef.is_before then
+				res.add mpropdef
+			end
+		end
+		var in_hierarchy = self.in_hierarchy
+		if in_hierarchy == null then return res
+		for mclassdef in in_hierarchy.direct_greaters do
+			res.add_all mclassdef.before
+		end
+		return res
+	end
 
-	# Is the method a "before_module"?
-	private fun is_before_module: Bool do return mproperty.is_toplevel and name == "before_module"
+	# Methods tagged with `before_all` in this class definition
+	private fun before_all: Array[MMethodDef] do
+		var res = new Array[MMethodDef]
+		for mpropdef in mpropdefs do
+			if mpropdef isa MMethodDef and mpropdef.is_before_all then
+				res.add mpropdef
+			end
+		end
+		var in_hierarchy = self.in_hierarchy
+		if in_hierarchy == null then return res
+		for mclassdef in in_hierarchy.direct_greaters do
+			res.add_all mclassdef.before_all
+		end
+		return res
+	end
 
-	# Is the method a "after_module"?
-	private fun is_after_module: Bool do return mproperty.is_toplevel and name == "after_module"
-end
+	# Methods tagged with `after` in this class definition
+	private fun after: Array[MMethodDef] do
+		var res = new Array[MMethodDef]
+		for mpropdef in mpropdefs do
+			if mpropdef isa MMethodDef and mpropdef.is_after then
+				res.add mpropdef
+			end
+		end
+		var in_hierarchy = self.in_hierarchy
+		if in_hierarchy == null then return res
+		for mclassdef in in_hierarchy.direct_greaters do
+			res.add_all mclassdef.after
+		end
+		return res
+	end
 
-redef class MClassDef
-	# Is the class a TestClass?
-	# i.e. begins with "Test"
-	private fun is_test: Bool do
+	# Methods tagged with `after_all` in this class definition
+	private fun after_all: Array[MMethodDef] do
+		var res = new Array[MMethodDef]
+		for mpropdef in mpropdefs do
+			if mpropdef isa MMethodDef and mpropdef.is_after_all then
+				res.add mpropdef
+			end
+		end
 		var in_hierarchy = self.in_hierarchy
-		if in_hierarchy == null then return false
-		for sup in in_hierarchy.greaters do
-			if sup.name == "TestSuite" then return true
+		if in_hierarchy == null then return res
+		for mclassdef in in_hierarchy.direct_greaters do
+			res.add_all mclassdef.after_all
 		end
-		return false
+		return res
 	end
 end
 
 redef class MModule
-	# "before_module" method for this module.
-	private fun before_test: nullable MMethodDef do
+	# Methods tagged with `before_all` at the module level (in `Sys`)
+	private fun before_all: Array[MMethodDef] do
 		for mclassdef in mclassdefs do
-			if not mclassdef.name == "Object" then continue
-			for mpropdef in mclassdef.mpropdefs do
-				if mpropdef isa MMethodDef and mpropdef.is_before_module then return mpropdef
-			end
+			if mclassdef.name == "Sys" then return mclassdef.before_all
 		end
-		return null
+		return new Array[MMethodDef]
 	end
 
-	# "after_module" method for this module.
-	private fun after_test: nullable MMethodDef do
+	# Methods tagged with `after_all` at the module level (in `Sys`)
+	private fun after_all: Array[MMethodDef] do
 		for mclassdef in mclassdefs do
-			if not mclassdef.name == "Object" then continue
-			for mpropdef in mclassdef.mpropdefs do
-				if mpropdef isa MMethodDef and mpropdef.is_after_module then return mpropdef
-			end
+			if mclassdef.name == "Sys" then return mclassdef.after_all
 		end
-		return null
+		return new Array[MMethodDef]
 	end
 end
 
@@ -355,33 +474,14 @@ redef class ModelBuilder
 	# Number of failed tests.
 	var failed_tests = 0
 
-	# Run NitUnit test file for mmodule (if exists).
-	fun test_unit(mmodule: MModule): HTMLTag do
-		var ts = new HTMLTag("testsuite")
-		toolcontext.info("nitunit: test-suite test_{mmodule}", 2)
-		var f = toolcontext.opt_file.value
-		var test_file = "test_{mmodule.name}.nit"
-		if f != null then
-			test_file = f
-		else if not test_file.file_exists then
-			var module_file = mmodule.location.file
-			if module_file == null then
-				toolcontext.info("Skip test for {mmodule}, no file found", 2)
-				return ts
-			end
-			var include_dir = module_file.filename.dirname
-			test_file = "{include_dir}/{test_file}"
-		end
-		if not test_file.file_exists then
-			toolcontext.info("Skip test for {mmodule}, no file {test_file} found", 2)
-			return ts
-		end
+	# Run NitUnit test suite for `mmodule` (if it is one).
+	fun test_unit(mmodule: MModule): nullable HTMLTag do
+		# is the module a test_suite?
+		if not mmodule.is_test then return null
+		toolcontext.info("nitunit: test-suite {mmodule}", 2)
+
 		var tester = new NitUnitTester(self)
-		var res = tester.test_module_unit(test_file)
-		if res == null then
-			toolcontext.info("Skip test for {mmodule}, no test suite found", 2)
-			return ts
-		end
+		var res = tester.test_module_unit(mmodule)
 		return res.to_xml
 	end
 end