1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
15 # Testing from external files.
20 private import annotation
21 private import realtime
23 redef class ToolContext
25 var opt_pattern
= new OptionString("Only run test case with name that match pattern", "-p", "--pattern")
27 var opt_autosav
= new OptionBool("Automatically create/update .res files for black box testing", "--autosav")
30 # Used to test nitunit test files.
33 # `ModelBuilder` used to parse test files.
34 var mbuilder
: ModelBuilder
36 # Compile and execute `mmodule` as a test suite.
37 fun test_module_unit
(mmodule
: MModule): TestSuite do
38 var toolcontext
= mbuilder
.toolcontext
39 var suite
= new TestSuite(mmodule
, toolcontext
)
40 # method to execute before all tests in the module
41 var before_module
= mmodule
.before_test
42 if before_module
!= null then
43 toolcontext
.modelbuilder
.total_tests
+= 1
44 suite
.before_module
= new TestCase(suite
, before_module
, toolcontext
)
46 # generate all test cases
47 for mclassdef
in mmodule
.mclassdefs
do
48 if not mclassdef
.is_test
then continue
49 if not suite_match_pattern
(mclassdef
) then continue
50 toolcontext
.modelbuilder
.total_classes
+= 1
51 for mpropdef
in mclassdef
.mpropdefs
do
52 if not mpropdef
isa MMethodDef or not mpropdef
.is_test
then continue
53 if not case_match_pattern
(mpropdef
) then continue
54 toolcontext
.modelbuilder
.total_tests
+= 1
55 var test
= new TestCase(suite
, mpropdef
, toolcontext
)
59 # method to execute after all tests in the module
60 var after_module
= mmodule
.after_test
61 if after_module
!= null then
62 toolcontext
.modelbuilder
.total_tests
+= 1
63 suite
.after_module
= new TestCase(suite
, after_module
, toolcontext
)
69 # Is the test suite name match the pattern option?
70 private fun suite_match_pattern
(suite
: MClassDef): Bool do
71 var pattern
= mbuilder
.toolcontext
.opt_pattern
.value
72 if pattern
== null then return true
73 var ps
= pattern
.split_with
("::")
75 if ps
.length
== 1 and p
.first
.is_lower
then return true
76 if ps
.length
== 2 and p
.first
.is_lower
then return false
77 if p
.has_suffix
("*") then
78 p
= p
.substring
(0, p
.length
- 1)
79 if suite
.name
.has_prefix
(p
) then return true
81 if suite
.name
== p
then return true
86 # Is the test case name match the pattern option?
87 private fun case_match_pattern
(case
: MPropDef): Bool do
88 var pattern
= mbuilder
.toolcontext
.opt_pattern
.value
89 if pattern
== null then return true
90 var ps
= pattern
.split_with
("::")
92 if ps
.length
== 1 and p
.first
.is_upper
then return true
93 if ps
.length
== 2 and p
.first
.is_upper
then return false
94 if p
.has_suffix
("*") then
95 p
= p
.substring
(0, p
.length
- 1)
96 if case
.name
.has_prefix
(p
) then return true
98 if case
.name
== p
then return true
104 # A test suite contains all the test cases for a `MModule`.
107 # `MModule` under test
110 # `ToolContext` to use to display messages.
111 var toolcontext
: ToolContext
113 # List of `TestCase` to be executed in this suite.
114 var test_cases
= new Array[TestCase]
116 # Add a `TestCase` to the suite.
117 fun add_test
(case
: TestCase) do test_cases
.add case
119 # Test to be executed before the whole test suite.
120 var before_module
: nullable TestCase = null
122 # Test to be executed after the whole test suite.
123 var after_module
: nullable TestCase = null
125 # Display test suite status in std-out.
127 toolcontext
.show_unit_status
("Test-suite of module " + mmodule
.full_name
, test_cases
)
130 # Execute the test suite
134 if not toolcontext
.test_dir
.file_exists
then
135 toolcontext
.test_dir
.mkdir
139 if failure
!= null then
140 for case
in test_cases
do
142 case
.error
= "Compilation Error"
143 case
.raw_output
= failure
144 toolcontext
.modelbuilder
.failed_tests
+= 1
145 toolcontext
.clear_progress_bar
146 toolcontext
.show_unit
(case
)
152 toolcontext
.info
("Execute test-suite {mmodule.name}", 1)
153 var before_module
= self.before_module
154 if not before_module
== null then before_module
.run
155 for case
in test_cases
do
157 toolcontext
.clear_progress_bar
158 toolcontext
.show_unit
(case
)
162 var after_module
= self.after_module
163 if not after_module
== null then after_module
.run
169 # Write the test unit for `self` in a nit compilable file.
171 var file
= new Template
172 file
.addn
"intrude import test_suite"
173 file
.addn
"import {mmodule.name}\n"
174 file
.addn
"var name = args.first"
175 for case
in test_cases
do
176 case
.write_to_nit
(file
)
178 file
.write_to_file
("{test_file}.nit")
181 # Return the test suite in XML format compatible with Jenkins.
182 # Contents depends on the `run` execution.
183 fun to_xml
: HTMLTag do
184 var n
= new HTMLTag("testsuite")
185 n
.attr
("package", mmodule
.name
)
186 for test
in test_cases
do n
.add test
.to_xml
190 # Generated test file name.
191 fun test_file
: String do
192 return toolcontext
.test_dir
/ "gen_{mmodule.name.escape_to_c}"
195 # Compile all `test_cases` cases in one file.
198 var nitc
= toolcontext
.find_nitc
201 var module_file
= mmodule
.location
.file
202 if module_file
== null then
203 toolcontext
.error
(null, "Error: cannot find module file for {mmodule.name}.")
204 toolcontext
.check_errors
207 var include_dir
= module_file
.filename
.dirname
208 var cmd
= "{nitc} --no-color -q '{file}.nit' -I {include_dir} -o '{file}.bin' > '{file}.out' 2>&1 </dev/null"
209 var res
= toolcontext
.safe_exec
(cmd
)
210 var f
= new FileReader.open
("{file}.out")
218 # Set environment variables for test suite execution
220 var loc
= mmodule
.location
.file
221 if loc
== null then return
222 toolcontext
.set_testing_path
(loc
.filename
)
225 # Error occured during test-suite compilation.
226 var failure
: nullable String = null
229 # A test case is a unit test considering only a `MMethodDef`.
233 # Test suite wich `self` belongs to.
234 var test_suite
: TestSuite
236 # Test method to be compiled and tested.
237 var test_method
: MMethodDef
239 redef fun full_name
do return test_method
.full_name
241 redef fun location
do return test_method
.location
243 # `ToolContext` to use to display messages and find `nitc` bin.
244 var toolcontext
: ToolContext
246 # Generate the test unit for `self` in `file`.
247 fun write_to_nit
(file
: Template) do
248 var name
= test_method
.name
249 file
.addn
"if name == \"{name}\
" then"
250 if test_method
.mproperty
.is_toplevel
then
253 file
.addn
"\tvar subject = new {test_method.mclassdef.name}.nitunit"
254 file
.addn
"\tsubject.before_test"
255 file
.addn
"\tsubject.{name}"
256 file
.addn
"\tsubject.after_test"
261 # Execute the test case.
263 toolcontext
.info
("Execute test-case {test_method.name}", 1)
265 if toolcontext
.opt_noact
.value
then return
267 var method_name
= test_method
.name
268 var test_file
= test_suite
.test_file
269 var res_name
= "{test_file}_{method_name.escape_to_c}"
270 var clock
= new Clock
271 var res
= toolcontext
.safe_exec
("{test_file}.bin {method_name} > '{res_name}.out1' 2>&1 </dev/null")
272 if not toolcontext
.opt_no_time
.value
then real_time
= clock
.total
274 var raw_output
= "{res_name}.out1".to_path
.read_all
275 self.raw_output
= raw_output
276 # set test case result
278 error
= "Runtime Error in file {test_file}.nit"
279 toolcontext
.modelbuilder
.failed_tests
+= 1
281 # no error, check with res file, if any.
282 var mmodule
= test_method
.mclassdef
.mmodule
283 var file
= mmodule
.filepath
285 var tries
= [ file
.dirname
/ mmodule
.name
+ ".sav" / test_method
.name
+ ".res",
286 file
.dirname
/ "sav" / test_method
.name
+ ".res" ,
287 file
.dirname
/ test_method
.name
+ ".res" ]
288 var savs
= [ for t
in tries
do if t
.file_exists
then t
]
289 if savs
.length
== 1 then
291 toolcontext
.info
("Diff output with {sav}", 1)
292 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")
295 else if toolcontext
.opt_autosav
.value
then
296 raw_output
.write_to_file
(sav
)
297 info
= "Expected output updated: {sav} (--autoupdate)"
299 self.raw_output
= "Diff\n" + "{res_name}.diff".to_path
.read_all
300 error
= "Difference with expected output: diff -u {sav} {res_name}.out1"
301 toolcontext
.modelbuilder
.failed_tests
+= 1
303 else if savs
.length
> 1 then
304 toolcontext
.info
("Conflicting diffs: {savs.join(", ")}", 1)
305 error
= "Conflicting expected output: {savs.join(", ", " and ")} all exist"
306 toolcontext
.modelbuilder
.failed_tests
+= 1
307 else if not raw_output
.is_empty
then
308 toolcontext
.info
("No diff: {tries.join(", ", " or ")} not found", 1)
309 if toolcontext
.opt_autosav
.value
then
310 var sav
= tries
.first
312 raw_output
.write_to_file
(sav
)
313 info
= "Expected output saved: {sav} (--autoupdate)"
321 redef fun xml_classname
do
322 var a
= test_method
.full_name
.split
("$")
323 return "nitunit.{a[0]}.{a[1]}"
326 redef fun xml_name
do
327 var a
= test_method
.full_name
.split
("$")
332 redef class MMethodDef
333 # TODO use annotations?
335 # Is the method a test_method?
336 # i.e. begins with "test_"
337 private fun is_test
: Bool do return name
.has_prefix
("test_")
339 # Is the method a "before_module"?
340 private fun is_before_module
: Bool do return mproperty
.is_toplevel
and name
== "before_module"
342 # Is the method a "after_module"?
343 private fun is_after_module
: Bool do return mproperty
.is_toplevel
and name
== "after_module"
346 redef class MClassDef
347 # Is the class a TestClass?
348 # i.e. is a subclass of `TestSuite`
349 private fun is_test
: Bool do
350 var in_hierarchy
= self.in_hierarchy
351 if in_hierarchy
== null then return false
352 for sup
in in_hierarchy
.greaters
do
353 if sup
.name
== "TestSuite" then return true
360 # "before_module" method for this module.
361 private fun before_test
: nullable MMethodDef do
362 for mclassdef
in mclassdefs
do
363 if not mclassdef
.name
== "Object" then continue
364 for mpropdef
in mclassdef
.mpropdefs
do
365 if mpropdef
isa MMethodDef and mpropdef
.is_before_module
then return mpropdef
371 # "after_module" method for this module.
372 private fun after_test
: nullable MMethodDef do
373 for mclassdef
in mclassdefs
do
374 if not mclassdef
.name
== "Object" then continue
375 for mpropdef
in mclassdef
.mpropdefs
do
376 if mpropdef
isa MMethodDef and mpropdef
.is_after_module
then return mpropdef
383 redef class ModelBuilder
384 # Number of test classes generated.
385 var total_classes
= 0
387 # Number of tests generated.
390 # Number of failed tests.
393 # Run NitUnit test suite for `mmodule` (if it is one).
394 fun test_unit
(mmodule
: MModule): nullable HTMLTag do
395 # is the module a test_suite?
396 if get_mmodule_annotation
("test_suite", mmodule
) == null then return null
397 toolcontext
.info
("nitunit: test-suite {mmodule}", 2)
399 var tester
= new NitUnitTester(self)
400 var res
= tester
.test_module_unit
(mmodule
)