Merge: doc: fixed some typos and other misc. corrections
[nit.git] / src / testing / testing_suite.nit
index 0271224..13cf20f 100644 (file)
@@ -18,7 +18,6 @@ module testing_suite
 import testing_base
 import html
 private import parse_annotations
-private import annotation
 private import realtime
 
 redef class ToolContext
@@ -48,13 +47,35 @@ class NitUnitTester
                        if not mclassdef.is_test then continue
                        if not suite_match_pattern(mclassdef) then continue
                        toolcontext.modelbuilder.total_classes += 1
+
+                       var test_class = new TestClass
+
+                       # method to execute before all tests in the class
+                       for mmethod in mclassdef.before_all do
+                               toolcontext.modelbuilder.total_tests += 1
+                               test_class.before_all.add new TestCase(suite, mmethod, toolcontext)
+                       end
+
+                       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.test_cases.add test
+                               test.before = before
+                               test.after = after
+                               test_class.test_cases.add test
                        end
+
+                       # method to execute after all tests in the class
+                       for mmethod in mclassdef.after_all do
+                               toolcontext.modelbuilder.total_tests += 1
+                               test_class.after_all.add new TestCase(suite, mmethod, toolcontext)
+                       end
+
+                       suite.test_classes.add test_class
                end
                # method to execute after all tests in the module
                for mmethod in mmodule.after_all do
@@ -110,7 +131,7 @@ class TestSuite
        var toolcontext: ToolContext
 
        # List of `TestCase` to be executed in this suite.
-       var test_cases = new Array[TestCase]
+       var test_classes = new Array[TestClass]
 
        # Tests to be executed before the whole test suite.
        var before_all = new Array[TestCase]
@@ -120,7 +141,12 @@ class TestSuite
 
        # Display test suite status in std-out.
        fun show_status do
-               var test_cases = self.test_cases.to_a
+               var test_cases = new Array[TestCase]
+               for test_class in test_classes do
+                       test_cases.add_all test_class.before_all
+                       test_cases.add_all test_class.test_cases
+                       test_cases.add_all test_class.after_all
+               end
                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)
@@ -136,11 +162,13 @@ class TestSuite
                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)
+                       for test_class in test_classes do
+                               for case in test_class.test_cases do
+                                       case.fail "Compilation Error"
+                                       case.raw_output = failure
+                                       toolcontext.clear_progress_bar
+                                       toolcontext.show_unit(case)
+                               end
                        end
                        show_status
                        print ""
@@ -153,13 +181,25 @@ class TestSuite
                        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)
+                               for test_class in test_classes do
+                                       for case in test_class.before_all do
+                                               case.fail "Nitunit Error: before module test failed"
+                                               toolcontext.clear_progress_bar
+                                               toolcontext.show_unit(case)
+                                       end
+                                       for case in test_class.test_cases do
+                                               case.fail "Nitunit Error: before module test failed"
+                                               toolcontext.clear_progress_bar
+                                               toolcontext.show_unit(case)
+                                       end
+                                       for case in test_class.after_all do
+                                               case.fail "Nitunit Error: before module test failed"
+                                               toolcontext.clear_progress_bar
+                                               toolcontext.show_unit(case)
+                                       end
                                end
                                for after_module in after_all do
-                                       after_module.fail "Nitunit Error: before_module test failed"
+                                       after_module.fail "Nitunit Error: before module test failed"
                                        toolcontext.clear_progress_bar
                                        toolcontext.show_unit(after_module)
                                end
@@ -169,11 +209,39 @@ class TestSuite
                        end
                end
 
-               for case in test_cases do
-                       case.run
-                       toolcontext.clear_progress_bar
-                       toolcontext.show_unit(case)
-                       show_status
+               for test_class in test_classes do
+                       for case in test_class.before_all do
+                               case.run
+                               toolcontext.clear_progress_bar
+                               toolcontext.show_unit(case)
+                               if case.error != null then
+                                       for scase in test_class.test_cases do
+                                               scase.fail "Nitunit Error: before class test failed"
+                                               toolcontext.clear_progress_bar
+                                               toolcontext.show_unit(scase)
+                                       end
+                                       for scase in test_class.after_all do
+                                               scase.fail "Nitunit Error: before class test failed"
+                                               toolcontext.clear_progress_bar
+                                               toolcontext.show_unit(scase)
+                                       end
+                                       show_status
+                                       print ""
+                                       return
+                               end
+                       end
+                       for case in test_class.test_cases do
+                               case.run
+                               toolcontext.clear_progress_bar
+                               toolcontext.show_unit(case)
+                               show_status
+                       end
+                       for after_class in test_class.after_all do
+                               after_class.run
+                               toolcontext.clear_progress_bar
+                               toolcontext.show_unit(after_class)
+                               show_status
+                       end
                end
 
                for after_module in after_all do
@@ -196,8 +264,16 @@ class TestSuite
                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)
+               for test_class in test_classes do
+                       for case in test_class.before_all do
+                               case.write_to_nit(file)
+                       end
+                       for case in test_class.test_cases do
+                               case.write_to_nit(file)
+                       end
+                       for case in test_class.after_all do
+                               case.write_to_nit(file)
+                       end
                end
                for after_module in after_all do
                        after_module.write_to_nit(file)
@@ -210,7 +286,9 @@ class TestSuite
        fun to_xml: HTMLTag do
                var n = new HTMLTag("testsuite")
                n.attr("package", mmodule.name)
-               for test in test_cases do n.add test.to_xml
+               for test_class in test_classes do
+                       for test in test_class.test_cases do n.add test.to_xml
+               end
                return n
        end
 
@@ -253,6 +331,20 @@ class TestSuite
        var failure: nullable String = null
 end
 
+# A test class contains multiple test cases
+#
+# For each test class, methods can be executed before and after all cases.
+class TestClass
+       # List of `TestCase` to be executed in this suite.
+       var test_cases = new Array[TestCase]
+
+       # Tests to be executed before the whole test suite.
+       var before_all = new Array[TestCase]
+
+       # Tests to be executed after the whole test suite.
+       var after_all = new Array[TestCase]
+end
+
 # A test case is a unit test considering only a `MMethodDef`.
 class TestCase
        super UnitTest
@@ -263,6 +355,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
@@ -277,10 +375,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
@@ -366,54 +468,112 @@ class TestCase
 end
 
 redef class MClassDef
+       # Methods tagged with `before` in this class definition
+       private fun before: Array[MMethodDef] do
+               var res = new ArraySet[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.to_a
+               for mclassdef in in_hierarchy.direct_greaters do
+                       res.add_all mclassdef.before
+               end
+               var lin = res.to_a
+               mmodule.linearize_mpropdefs(lin)
+               return lin
+       end
+
        # Methods tagged with `before_all` in this class definition
        private fun before_all: Array[MMethodDef] do
-               var res = new Array[MMethodDef]
+               var res = new ArraySet[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
+               if in_hierarchy == null then return res.to_a
                for mclassdef in in_hierarchy.direct_greaters do
                        res.add_all mclassdef.before_all
                end
-               return res
+               var lin = res.to_a
+               mmodule.linearize_mpropdefs(lin)
+               return lin
+       end
+
+       # Methods tagged with `after` in this class definition
+       private fun after: Array[MMethodDef] do
+               var res = new ArraySet[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.to_a
+               for mclassdef in in_hierarchy.direct_greaters do
+                       res.add_all mclassdef.after
+               end
+               var lin = res.to_a
+               mmodule.linearize_mpropdefs(lin)
+               return lin.reversed
        end
 
        # Methods tagged with `after_all` in this class definition
        private fun after_all: Array[MMethodDef] do
-               var res = new Array[MMethodDef]
+               var res = new ArraySet[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 res
+               if in_hierarchy == null then return res.to_a
                for mclassdef in in_hierarchy.direct_greaters do
                        res.add_all mclassdef.after_all
                end
-               return res
+               var lin = res.to_a
+               mmodule.linearize_mpropdefs(lin)
+               return lin.reversed
        end
 end
 
 redef class MModule
        # Methods tagged with `before_all` at the module level (in `Sys`)
        private fun before_all: Array[MMethodDef] do
-               for mclassdef in mclassdefs do
-                       if mclassdef.name == "Sys" then return mclassdef.before_all
+               var res = new Array[MMethodDef]
+               for mmodule in in_importation.greaters do
+                       for mclassdef in mmodule.mclassdefs do
+                               if mclassdef.name != "Sys" then continue
+                               for mpropdef in mclassdef.mpropdefs do
+                                       if not mpropdef isa MMethodDef or not mpropdef.is_before_all then continue
+                                       res.add mpropdef
+                               end
+                       end
                end
-               return new Array[MMethodDef]
+               var lin = res.to_a
+               linearize_mpropdefs(lin)
+               return lin
        end
 
        # Methods tagged with `after_all` at the module level (in `Sys`)
        private fun after_all: Array[MMethodDef] do
-               for mclassdef in mclassdefs do
-                       if mclassdef.name == "Sys" then return mclassdef.after_all
+               var res = new Array[MMethodDef]
+               for mmodule in in_importation.greaters do
+                       for mclassdef in mmodule.mclassdefs do
+                               if mclassdef.name != "Sys" then continue
+                               for mpropdef in mclassdef.mpropdefs do
+                                       if not mpropdef isa MMethodDef or not mpropdef.is_after_all then continue
+                                       res.add mpropdef
+                               end
+                       end
                end
-               return new Array[MMethodDef]
+               var lin = res.to_a
+               linearize_mpropdefs(lin)
+               return lin.reversed
        end
 end