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
22 redef class ToolContext
24 var opt_file
= new OptionString("Specify test suite location", "-t", "--target-file")
26 var opt_pattern
= new OptionString("Only run test case with name that match pattern", "-p", "--pattern")
29 # Used to test nitunit test files.
32 # `ModelBuilder` used to parse test files.
33 var mbuilder
: ModelBuilder
35 # Parse a file and return the contained `MModule`.
36 private fun parse_module_unit
(file
: String): nullable MModule do
37 var mmodule
= mbuilder
.parse
([file
]).first
38 if mbuilder
.get_mmodule_annotation
("test_suite", mmodule
) == null then return null
43 # Compile and execute the test suite for a NitUnit `file`.
44 fun test_module_unit
(file
: String): nullable TestSuite do
45 var toolcontext
= mbuilder
.toolcontext
46 var mmodule
= parse_module_unit
(file
)
47 # is the module a test_suite?
48 if mmodule
== null then return null
49 var suite
= new TestSuite(mmodule
, toolcontext
)
50 # method to execute before all tests in the module
51 var before_module
= mmodule
.before_test
52 if before_module
!= null then
53 toolcontext
.modelbuilder
.total_tests
+= 1
54 suite
.before_module
= new TestCase(suite
, before_module
, toolcontext
)
56 # generate all test cases
57 for mclassdef
in mmodule
.mclassdefs
do
58 if not mclassdef
.is_test
then continue
59 if not suite_match_pattern
(mclassdef
) then continue
60 toolcontext
.modelbuilder
.total_classes
+= 1
61 for mpropdef
in mclassdef
.mpropdefs
do
62 if not mpropdef
isa MMethodDef or not mpropdef
.is_test
then continue
63 if not case_match_pattern
(mpropdef
) then continue
64 toolcontext
.modelbuilder
.total_tests
+= 1
65 var test
= new TestCase(suite
, mpropdef
, toolcontext
)
69 # method to execute after all tests in the module
70 var after_module
= mmodule
.after_test
71 if after_module
!= null then
72 toolcontext
.modelbuilder
.total_tests
+= 1
73 suite
.after_module
= new TestCase(suite
, after_module
, toolcontext
)
79 # Is the test suite name match the pattern option?
80 private fun suite_match_pattern
(suite
: MClassDef): Bool do
81 var pattern
= mbuilder
.toolcontext
.opt_pattern
.value
82 if pattern
== null then return true
83 var ps
= pattern
.split_with
("::")
85 if ps
.length
== 1 and p
.first
.is_lower
then return true
86 if ps
.length
== 2 and p
.first
.is_lower
then return false
87 if p
.has_suffix
("*") then
88 p
= p
.substring
(0, p
.length
- 1)
89 if suite
.name
.has_prefix
(p
) then return true
91 if suite
.name
== p
then return true
96 # Is the test case name match the pattern option?
97 private fun case_match_pattern
(case
: MPropDef): Bool do
98 var pattern
= mbuilder
.toolcontext
.opt_pattern
.value
99 if pattern
== null then return true
100 var ps
= pattern
.split_with
("::")
102 if ps
.length
== 1 and p
.first
.is_upper
then return true
103 if ps
.length
== 2 and p
.first
.is_upper
then return false
104 if p
.has_suffix
("*") then
105 p
= p
.substring
(0, p
.length
- 1)
106 if case
.name
.has_prefix
(p
) then return true
108 if case
.name
== p
then return true
114 # A test suite contains all the test cases for a `MModule`.
117 # `MModule` under test
120 # `ToolContext` to use to display messages.
121 var toolcontext
: ToolContext
123 # List of `TestCase` to be executed in this suite.
124 var test_cases
= new Array[TestCase]
126 # Add a `TestCase` to the suite.
127 fun add_test
(case
: TestCase) do test_cases
.add case
129 # Test to be executed before the whole test suite.
130 var before_module
: nullable TestCase = null
132 # Test to be executed after the whole test suite.
133 var after_module
: nullable TestCase = null
137 toolcontext
.show_unit_status
("Test-suite of module " + mmodule
.full_name
, test_cases
)
140 # Execute the test suite
143 if not toolcontext
.test_dir
.file_exists
then
144 toolcontext
.test_dir
.mkdir
148 toolcontext
.info
("Execute test-suite {mmodule.name}", 1)
149 var before_module
= self.before_module
150 if not before_module
== null then before_module
.run
151 for case
in test_cases
do
153 toolcontext
.clear_progress_bar
154 toolcontext
.show_unit
(case
)
158 var after_module
= self.after_module
159 if not after_module
== null then after_module
.run
165 # Write the test unit for `self` in a nit compilable file.
167 var file
= new Template
168 file
.addn
"intrude import test_suite"
169 file
.addn
"import {mmodule.name}\n"
170 file
.addn
"var name = args.first"
171 for case
in test_cases
do
172 case
.write_to_nit
(file
)
174 file
.write_to_file
("{test_file}.nit")
177 # Return the test suite in XML format compatible with Jenkins.
178 # Contents depends on the `run` execution.
179 fun to_xml
: HTMLTag do
180 var n
= new HTMLTag("testsuite")
181 n
.attr
("package", mmodule
.name
)
182 var failure
= self.failure
183 if failure
!= null then
184 var f
= new HTMLTag("failure")
185 f
.attr
("message", failure
.to_s
)
188 for test
in test_cases
do n
.add test
.to_xml
193 # Generated test file name.
194 fun test_file
: String do
195 return toolcontext
.test_dir
/ "gen_{mmodule.name.escape_to_c}"
198 # Compile all `test_cases` cases in one file.
201 var nitc
= toolcontext
.find_nitc
204 var module_file
= mmodule
.location
.file
205 if module_file
== null then
206 toolcontext
.error
(null, "Error: cannot find module file for {mmodule.name}.")
207 toolcontext
.check_errors
210 var include_dir
= module_file
.filename
.dirname
211 var cmd
= "{nitc} --no-color '{file}.nit' -I {include_dir} -o '{file}.bin' > '{file}.out' 2>&1 </dev/null"
212 var res
= toolcontext
.safe_exec
(cmd
)
213 var f
= new FileReader.open
("{file}.out")
216 # set test case result
217 var loc
= mmodule
.location
220 toolcontext
.warning
(loc
, "failure", "FAILURE: {mmodule.name} (in file {file}.nit): {msg}")
221 toolcontext
.modelbuilder
.failed_tests
+= 1
223 toolcontext
.check_errors
226 # Error occured during test-suite compilation.
227 var failure
: nullable String = null
230 # A test case is a unit test considering only a `MMethodDef`.
234 # Test suite wich `self` belongs to.
235 var test_suite
: TestSuite
237 # Test method to be compiled and tested.
238 var test_method
: MMethodDef
240 redef fun full_name
do return test_method
.full_name
242 redef fun location
do return test_method
.location
244 # `ToolContext` to use to display messages and find `nitc` bin.
245 var toolcontext
: ToolContext
247 # Generate the test unit for `self` in `file`.
248 fun write_to_nit
(file
: Template) do
249 var name
= test_method
.name
250 file
.addn
"if name == \"{name}\
" then"
251 if test_method
.mproperty
.is_toplevel
then
254 file
.addn
"\tvar subject = new {test_method.mclassdef.name}.nitunit"
255 file
.addn
"\tsubject.before_test"
256 file
.addn
"\tsubject.{name}"
257 file
.addn
"\tsubject.after_test"
262 # Execute the test case.
264 toolcontext
.info
("Execute test-case {test_method.name}", 1)
266 if toolcontext
.opt_noact
.value
then return
268 var method_name
= test_method
.name
269 var test_file
= test_suite
.test_file
270 var res_name
= "{test_file}_{method_name.escape_to_c}"
271 var res
= toolcontext
.safe_exec
("{test_file}.bin {method_name} > '{res_name}.out1' 2>&1 </dev/null")
272 self.raw_output
= "{res_name}.out1".to_path
.read_all
273 # set test case result
275 error
= "Runtime Error in file {test_file}.nit"
276 toolcontext
.modelbuilder
.failed_tests
+= 1
278 # no error, check with res file, if any.
279 var mmodule
= test_method
.mclassdef
.mmodule
280 var file
= mmodule
.filepath
282 var sav
= file
.dirname
/ mmodule
.name
+ ".sav" / test_method
.name
+ ".res"
283 if sav
.file_exists
then
284 toolcontext
.info
("Diff output with {sav}", 1)
285 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")
287 self.raw_output
= "Diff\n" + "{res_name}.diff".to_path
.read_all
288 error
= "Difference with expected output: diff -u {sav} {res_name}.out1"
289 toolcontext
.modelbuilder
.failed_tests
+= 1
292 toolcontext
.info
("No diff: {sav} not found", 2)
299 redef fun xml_classname
do
300 var mclassdef
= test_method
.mclassdef
301 return "nitunit." + mclassdef
.mmodule
.full_name
+ "." + mclassdef
.mclass
.full_name
304 redef fun xml_name
do
305 return test_method
.mproperty
.full_name
309 redef class MMethodDef
310 # TODO use annotations?
312 # Is the method a test_method?
313 # i.e. begins with "test_"
314 private fun is_test
: Bool do return name
.has_prefix
("test_")
316 # Is the method a "before_module"?
317 private fun is_before_module
: Bool do return mproperty
.is_toplevel
and name
== "before_module"
319 # Is the method a "after_module"?
320 private fun is_after_module
: Bool do return mproperty
.is_toplevel
and name
== "after_module"
323 redef class MClassDef
324 # Is the class a TestClass?
325 # i.e. begins with "Test"
326 private fun is_test
: Bool do
327 var in_hierarchy
= self.in_hierarchy
328 if in_hierarchy
== null then return false
329 for sup
in in_hierarchy
.greaters
do
330 if sup
.name
== "TestSuite" then return true
337 # "before_module" method for this module.
338 private fun before_test
: nullable MMethodDef do
339 for mclassdef
in mclassdefs
do
340 if not mclassdef
.name
== "Object" then continue
341 for mpropdef
in mclassdef
.mpropdefs
do
342 if mpropdef
isa MMethodDef and mpropdef
.is_before_module
then return mpropdef
348 # "after_module" method for this module.
349 private fun after_test
: nullable MMethodDef do
350 for mclassdef
in mclassdefs
do
351 if not mclassdef
.name
== "Object" then continue
352 for mpropdef
in mclassdef
.mpropdefs
do
353 if mpropdef
isa MMethodDef and mpropdef
.is_after_module
then return mpropdef
360 redef class ModelBuilder
361 # Number of test classes generated.
362 var total_classes
= 0
364 # Number of tests generated.
367 # Number of failed tests.
370 # Run NitUnit test file for mmodule (if exists).
371 fun test_unit
(mmodule
: MModule): HTMLTag do
372 var ts
= new HTMLTag("testsuite")
373 toolcontext
.info
("nitunit: test-suite test_{mmodule}", 2)
374 var f
= toolcontext
.opt_file
.value
375 var test_file
= "test_{mmodule.name}.nit"
378 else if not test_file
.file_exists
then
379 var module_file
= mmodule
.location
.file
380 if module_file
== null then
381 toolcontext
.info
("Skip test for {mmodule}, no file found", 2)
384 var include_dir
= module_file
.filename
.dirname
385 test_file
= "{include_dir}/{test_file}"
387 if not test_file
.file_exists
then
388 toolcontext
.info
("Skip test for {mmodule}, no file {test_file} found", 2)
391 var tester
= new NitUnitTester(self)
392 var res
= tester
.test_module_unit
(test_file
)
394 toolcontext
.info
("Skip test for {mmodule}, no test suite found", 2)