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 code comments.
18 private import parser_util
23 # Extractor, Executor and Reporter for the tests in a module
27 # Toolcontext used to parse Nit code blocks.
28 var toolcontext
: ToolContext
30 # The prefix of the generated Nit source-file
33 # The module to import, if any
34 var mmodule
: nullable MModule
36 # The XML node associated to the module
37 var testsuite
: HTMLTag
39 # The name of the suite
42 # Markdown processor used to parse markdown comments and extract code.
43 var mdproc
= new MarkdownProcessor
46 mdproc
.emitter
.decorator
= new NitunitDecorator(self)
49 # The associated documentation object
50 var mdoc
: nullable MDoc = null
52 # used to generate distinct names
55 # The last docunit extracted from a mdoc.
57 # Is used because a new code-block might just be added to it.
58 var last_docunit
: nullable DocUnit = null
60 var xml_classname
: String is noautoinit
62 var xml_name
: String is noautoinit
64 # The entry point for a new `ndoc` node
65 # Fill `docunits` with new discovered unit of tests.
66 fun extract
(mdoc
: MDoc, xml_classname
, xml_name
: String)
69 self.xml_classname
= xml_classname
70 self.xml_name
= xml_name
74 # Populate `blocks` from the markdown decorator
75 mdproc
.process
(mdoc
.content
.join
("\n"))
78 # All extracted docunits
79 var docunits
= new Array[DocUnit]
83 toolcontext
.show_unit_status
(name
, docunits
)
86 fun mark_done
(du
: DocUnit)
89 toolcontext
.clear_progress_bar
90 toolcontext
.show_unit
(du
)
94 # Execute all the docunits
97 if docunits
.is_empty
then
101 # Try to group each nitunit into a single source file to fasten the compilation
102 var simple_du
= new Array[DocUnit]
104 for du
in docunits
do
105 # Skip existing errors
106 if du
.error
!= null then
110 var ast
= toolcontext
.parse_something
(du
.block
)
111 if ast
isa AExpr then
115 test_simple_docunits
(simple_du
)
117 # Now test them in order
118 for du
in docunits
do
119 if du
.error
!= null then
120 # Nothing to execute. Conclude
121 else if du
.test_file
!= null then
122 # Already compiled. Execute it.
123 execute_simple_docunit
(du
)
125 # Need to try to compile it, then execute it
126 test_single_docunit
(du
)
135 for du
in docunits
do
136 testsuite
.add du
.to_xml
140 # Executes multiples doc-units in a shared program.
141 # Used for docunits simple block of code (without modules, classes, functions etc.)
143 # In case of compilation error, the method fallbacks to `test_single_docunit` to
144 # * locate exactly the compilation problem in the problematic docunit.
145 # * permit the execution of the other docunits that may be correct.
146 fun test_simple_docunits
(dus
: Array[DocUnit])
148 if dus
.is_empty
then return
150 var file
= "{prefix}-0.nit"
152 var dir
= file
.dirname
153 if dir
!= "" then dir
.mkdir
155 f
= create_unitfile
(file
)
160 f
.write
("fun run_{i} do\n")
161 f
.write
("# {du.full_name}\n")
165 f
.write
("var a = args.first.to_i\n")
167 f
.write
("if a == {j} then run_{j}\n")
171 if toolcontext
.opt_noact
.value
then return
173 var res
= compile_unitfile
(file
)
177 # They will be executed independently
181 # Compilation was a success.
182 # Store what need to be executed for each one.
191 # Execute a docunit compiled by `test_single_docunit`
192 fun execute_simple_docunit
(du
: DocUnit)
194 var file
= du
.test_file
.as(not null)
195 var i
= du
.test_arg
.as(not null)
196 toolcontext
.info
("Execute doc-unit {du.full_name} in {file} {i}", 1)
197 var res2
= toolcontext
.safe_exec
("{file.to_program_name}.bin {i} >'{file}.out1' 2>&1 </dev/null")
200 var content
= "{file}.out1".to_path
.read_all
201 du
.raw_output
= content
204 du
.error
= "Runtime error in {file} with argument {i}"
205 toolcontext
.modelbuilder
.failed_entities
+= 1
209 # Executes a single doc-unit in its own program.
210 # Used for docunits larger than a single block of code (with modules, classes, functions etc.)
211 fun test_single_docunit
(du
: DocUnit)
214 var file
= "{prefix}-{cpt}.nit"
216 toolcontext
.info
("Execute doc-unit {du.full_name} in {file}", 1)
219 f
= create_unitfile
(file
)
223 if toolcontext
.opt_noact
.value
then return
225 var res
= compile_unitfile
(file
)
228 res2
= toolcontext
.safe_exec
("{file.to_program_name}.bin >'{file}.out1' 2>&1 </dev/null")
232 var content
= "{file}.out1".to_path
.read_all
233 du
.raw_output
= content
236 du
.error
= "Compilation error in {file}"
237 toolcontext
.modelbuilder
.failed_entities
+= 1
238 else if res2
!= 0 then
239 du
.error
= "Runtime error in {file}"
240 toolcontext
.modelbuilder
.failed_entities
+= 1
244 # Create and fill the header of a unit file `file`.
246 # A unit file is a Nit source file generated from one
247 # or more docunits that will be compiled and executed.
249 # The handled on the file is returned and must be completed and closed.
251 # `file` should be a valid filepath for a Nit source file.
252 private fun create_unitfile
(file
: String): Writer
254 var dir
= file
.dirname
255 if dir
!= "" then dir
.mkdir
257 f
= new FileWriter.open
(file
)
258 f
.write
("# GENERATED FILE\n")
259 f
.write
("# Docunits extracted from comments\n")
260 if mmodule
!= null then
261 f
.write
("import {mmodule.name}\n")
267 # Compile an unit file and return the compiler return code
269 # Can terminate the program if the compiler is not found
270 private fun compile_unitfile
(file
: String): Int
272 var nitc
= toolcontext
.find_nitc
273 var opts
= new Array[String]
274 if mmodule
!= null then
275 opts
.add
"-I {mmodule.filepath.dirname}"
277 var cmd
= "{nitc} --ignore-visibility --no-color '{file}' {opts.join(" ")} >'{file}.out1' 2>&1 </dev/null -o '{file}.bin'"
278 var res
= toolcontext
.safe_exec
(cmd
)
283 private class NitunitDecorator
286 var executor
: NitUnitExecutor
288 redef fun add_code
(v
, block
) do
289 var code
= block
.raw_content
290 var meta
= block
.meta
or else "nit"
291 # Do not try to test non-nit code.
292 if meta
!= "nit" then return
293 # Try to parse code blocks
294 var ast
= executor
.toolcontext
.parse_something
(code
)
296 var mdoc
= executor
.mdoc
300 if ast
isa TComment then return
302 # The location is computed according to the starts of the mdoc and the block
303 # Note, the following assumes that all the comments of the mdoc are correctly aligned.
304 var loc
= block
.block
.location
305 var line_offset
= loc
.line_start
+ mdoc
.location
.line_start
- 2
306 var column_offset
= loc
.column_start
+ mdoc
.location
.column_start
307 # Hack to handle precise location in blocks
308 # TODO remove when markdown is more reliable
309 if block
isa BlockFence then
310 # Skip the starting fence
313 # Account a standard 4 space indentation
317 # We want executable code
318 if not (ast
isa AModule or ast
isa ABlockExpr or ast
isa AExpr) then
321 # Get real location of the node (or error)
322 var location
= new Location(mdoc
.location
.file
,
323 l
.line_start
+ line_offset
,
324 l
.line_end
+ line_offset
,
325 l
.column_start
+ column_offset
,
326 l
.column_end
+ column_offset
)
327 if ast
isa AError then
328 message
= ast
.message
330 message
= "Error: Invalid Nit code."
335 du
.error_location
= location
337 executor
.toolcontext
.modelbuilder
.failed_entities
+= 1
341 # Create a first block
342 # Or create a new block for modules that are more than a main part
343 var last_docunit
= executor
.last_docunit
344 if last_docunit
== null or ast
isa AModule then
345 last_docunit
= new_docunit
346 executor
.last_docunit
= last_docunit
350 last_docunit
.block
+= code
352 # In order to retrieve precise positions,
353 # the real position of each line of the raw_content is stored.
354 # See `DocUnit::real_location`
355 line_offset
-= loc
.line_start
- 1
356 for i
in [loc
.line_start
..loc
.line_end
] do
357 last_docunit
.lines
.add i
+ line_offset
358 last_docunit
.columns
.add column_offset
362 # Return and register a new empty docunit
363 fun new_docunit
: DocUnit
365 var mdoc
= executor
.mdoc
369 var name
= executor
.xml_name
370 if executor
.docunits
.not_empty
and executor
.docunits
.last
.mdoc
== mdoc
then
371 next_number
= executor
.docunits
.last
.number
+ 1
372 name
+= "#" + next_number
.to_s
375 var res
= new DocUnit(mdoc
, next_number
, "", executor
.xml_classname
, name
)
376 executor
.docunits
.add res
377 executor
.toolcontext
.modelbuilder
.unit_entities
+= 1
382 # A unit-test extracted from some documentation.
384 # A docunit is extracted from the code-blocks of mdocs.
385 # Each mdoc can contains more than one docunit, and a single docunit can be made of more that a single code-block.
389 # The doc that contains self
392 # The numbering of self in mdoc (starting with 0)
395 # The generated Nit source file that contains the unit-test
397 # Note that a same generated file can be used for multiple tests.
398 # See `test_arg` that is used to distinguish them
399 var test_file
: nullable String = null
401 # The command-line argument to use when executing the test, if any.
402 var test_arg
: nullable Int = null
404 redef fun full_name
do
405 var mentity
= mdoc
.original_mentity
406 if mentity
!= null then
407 var res
= mentity
.full_name
413 return xml_classname
+ "." + xml_name
417 # The text of the code to execute.
419 # This is the verbatim content on one, or more, code-blocks from `mdoc`
422 # For each line in `block`, the associated line in the mdoc
424 # Is used to give precise locations
425 var lines
= new Array[Int]
427 # For each line in `block`, the associated column in the mdoc
429 # Is used to give precise locations
430 var columns
= new Array[Int]
432 # The location of the whole docunit.
434 # If `self` is made of multiple code-blocks, then the location
435 # starts at the first code-books and finish at the last one, thus includes anything between.
436 redef var location
is lazy
do
437 return new Location(mdoc
.location
.file
, lines
.first
, lines
.last
+1, columns
.first
+1, 0)
440 # Compute the real location of a node on the `ast` based on `mdoc.location`
442 # The result is basically: ast_location + markdown location of the piece + mdoc.location
444 # The fun is that a single docunit can be made of various pieces of code blocks.
445 fun real_location
(ast_location
: Location): Location
448 var res
= new Location(mdoc
.location
.file
, lines
[ast_location
.line_start-1
],
449 lines
[ast_location
.line_end-1
],
450 columns
[ast_location
.line_start-1
] + ast_location
.column_start
,
451 columns
[ast_location
.line_end-1
] + ast_location
.column_end
)
458 res
.open
("system-out").append
(block
)
462 redef var xml_classname
466 redef class ModelBuilder
467 # Total number analyzed `MEntity`
468 var total_entities
= 0
470 # The number of `MEntity` that have some documentation
473 # The total number of executed docunits
474 var unit_entities
= 0
476 # The number failed docunits
477 var failed_entities
= 0
479 # Extracts and executes all the docunits in the `mmodule`
480 # Returns a JUnit-compatible `<testsuite>` XML element that contains the results of the executions.
481 fun test_markdown
(mmodule
: MModule): HTMLTag
483 var ts
= new HTMLTag("testsuite")
484 toolcontext
.info
("nitunit: doc-unit {mmodule}", 2)
486 var nmodule
= mmodule2node
(mmodule
)
487 if nmodule
== null then return ts
489 # usualy, only the original module must be imported in the unit test.
492 if g
!= null and g
.mpackage
.name
== "core" then
493 # except for a unit test in a module of `core`
494 # in this case, the whole `core` must be imported
495 o
= get_mmodule_by_name
(nmodule
, g
, g
.mpackage
.name
).as(not null)
498 ts
.attr
("package", mmodule
.full_name
)
500 var prefix
= toolcontext
.test_dir
501 prefix
= prefix
.join_path
(mmodule
.to_s
)
502 var d2m
= new NitUnitExecutor(toolcontext
, prefix
, o
, ts
, "Docunits of module {mmodule.full_name}")
506 var nmoduledecl
= nmodule
.n_moduledecl
507 if nmoduledecl
== null then break label x
508 var ndoc
= nmoduledecl
.n_doc
509 if ndoc
== null then break label x
511 # NOTE: jenkins expects a '.' in the classname attr
512 d2m
.extract
(ndoc
.to_mdoc
, "nitunit." + mmodule
.full_name
+ ".<module>", "<module>")
514 for nclassdef
in nmodule
.n_classdefs
do
515 var mclassdef
= nclassdef
.mclassdef
516 if mclassdef
== null then continue
517 if nclassdef
isa AStdClassdef then
519 var ndoc
= nclassdef
.n_doc
522 d2m
.extract
(ndoc
.to_mdoc
, "nitunit." + mmodule
.full_name
+ "." + mclassdef
.mclass
.full_name
, "<class>")
525 for npropdef
in nclassdef
.n_propdefs
do
526 var mpropdef
= npropdef
.mpropdef
527 if mpropdef
== null then continue
529 var ndoc
= npropdef
.n_doc
532 d2m
.extract
(ndoc
.to_mdoc
, "nitunit." + mmodule
.full_name
+ "." + mclassdef
.mclass
.full_name
, mpropdef
.mproperty
.full_name
)
542 # Extracts and executes all the docunits in the readme of the `mgroup`
543 # Returns a JUnit-compatible `<testsuite>` XML element that contains the results of the executions.
544 fun test_group
(mgroup
: MGroup): HTMLTag
546 var ts
= new HTMLTag("testsuite")
547 toolcontext
.info
("nitunit: doc-unit group {mgroup}", 2)
549 # usually, only the default module must be imported in the unit test.
550 var o
= mgroup
.default_mmodule
552 ts
.attr
("package", mgroup
.full_name
)
554 var prefix
= toolcontext
.test_dir
555 prefix
= prefix
.join_path
(mgroup
.to_s
)
556 var d2m
= new NitUnitExecutor(toolcontext
, prefix
, o
, ts
, "Docunits of group {mgroup.full_name}")
559 var mdoc
= mgroup
.mdoc
560 if mdoc
== null then return ts
563 # NOTE: jenkins expects a '.' in the classname attr
564 d2m
.extract
(mdoc
, "nitunit." + mgroup
.full_name
, "<group>")
571 # Test a document object unrelated to a Nit entity
572 fun test_mdoc
(mdoc
: MDoc): HTMLTag
574 var ts
= new HTMLTag("testsuite")
575 var file
= mdoc
.location
.file
.filename
577 toolcontext
.info
("nitunit: doc-unit file {file}", 2)
579 ts
.attr
("package", file
)
581 var prefix
= toolcontext
.test_dir
/ "file"
582 var d2m
= new NitUnitExecutor(toolcontext
, prefix
, null, ts
, "Docunits of file {file}")
587 # NOTE: jenkins expects a '.' in the classname attr
588 d2m
.extract
(mdoc
, "nitunit.<file>", file
)