X-Git-Url: http://nitlanguage.org diff --git a/src/testing/testing_doc.nit b/src/testing/testing_doc.nit index 6bd8f0b..46f5a4a 100644 --- a/src/testing/testing_doc.nit +++ b/src/testing/testing_doc.nit @@ -17,12 +17,12 @@ module testing_doc private import parser_util import testing_base -import markdown +import markdown2 import html +import realtime # Extractor, Executor and Reporter for the tests in a module class NitUnitExecutor - super HTMLDecorator # Toolcontext used to parse Nit code blocks. var toolcontext: ToolContext @@ -36,18 +36,14 @@ class NitUnitExecutor # The XML node associated to the module var testsuite: HTMLTag - # All blocks of code from a same `ADoc` - var blocks = new Array[Buffer] + # The name of the suite + var name: String - # All failures from a same `ADoc` - var failures = new Array[String] + # Markdown parse used to parse markdown comments and extract code + private var md_parser = new MdParser - # Markdown processor used to parse markdown comments and extract code. - var mdproc = new MarkdownProcessor - - init do - mdproc.emitter.decorator = new NitunitDecorator(self) - end + # Markdown visitor used to extract markdown code blocks + private var md_visitor = new NitunitMdVisitor(self) is lazy # The associated documentation object var mdoc: nullable MDoc = null @@ -55,80 +51,128 @@ class NitUnitExecutor # used to generate distinct names var cpt = 0 + # The last docunit extracted from a mdoc. + # + # Is used because a new code-block might just be added to it. + var last_docunit: nullable DocUnit = null + + # Unit class name in XML output + var xml_classname: String is noautoinit + + # Unit name in xml output + var xml_name: String is noautoinit + # The entry point for a new `ndoc` node # Fill `docunits` with new discovered unit of tests. - # - # `tc` (testcase) is the pre-filled XML node - fun extract(mdoc: MDoc, tc: HTMLTag) + fun extract(mdoc: MDoc, xml_classname, xml_name: String) do - blocks.clear - failures.clear + last_docunit = null + self.xml_classname = xml_classname + self.xml_name = xml_name self.mdoc = mdoc # Populate `blocks` from the markdown decorator - mdproc.process(mdoc.content.join("\n")) - - toolcontext.check_errors - - if not failures.is_empty then - for msg in failures do - var ne = new HTMLTag("failure") - ne.attr("message", msg) - tc.add ne - toolcontext.modelbuilder.unit_entities += 1 - toolcontext.modelbuilder.failed_entities += 1 - end - if blocks.is_empty then testsuite.add(tc) - end - - if blocks.is_empty then return - for block in blocks do - docunits.add new DocUnit(mdoc, tc, block.write_to_string) - end + var md_node = md_parser.parse(mdoc.content.join("\n")) + md_visitor.enter_visit(md_node) end # All extracted docunits var docunits = new Array[DocUnit] + # Display current testing status + fun show_status do toolcontext.show_unit_status(name, docunits) + + # Update display when a test case is done + fun mark_done(du: DocUnit) + do + du.is_done = true + toolcontext.clear_progress_bar + toolcontext.show_unit(du) + show_status + end + # Execute all the docunits fun run_tests do - var simple_du = new Array[DocUnit] + if docunits.is_empty then + return + end + + # Try to group each nitunit into a single source file to fasten the compilation + var simple_du = new Array[DocUnit] # du that are simple statements + var single_du = new Array[DocUnit] # du that are modules or include classes + show_status for du in docunits do + # Skip existing errors + if du.error != null then + continue + end + var ast = toolcontext.parse_something(du.block) if ast isa AExpr then simple_du.add du else + single_du.add du + end + end + + # Try to mass compile all the simple du as a single nit module + compile_simple_docunits(simple_du) + # Try to mass compile all the single du in a single nitc invocation with many modules + compile_single_docunits(single_du) + # If the mass compilation fail, then each one will be compiled individually + + # Now test them in order + for du in docunits do + if du.error != null then + # Nothing to execute. Conclude + else if du.is_compiled then + # Already compiled. Execute it. + execute_simple_docunit(du) + else + # A mass compilation failed + # Need to try to recompile it, then execute it test_single_docunit(du) end + mark_done(du) end - test_simple_docunits(simple_du) + # Final status + show_status + print "" + + for du in docunits do + testsuite.add du.to_xml + end end - # Executes multiples doc-units in a shared program. + # Compiles multiples doc-units in a shared program. # Used for docunits simple block of code (without modules, classes, functions etc.) # - # In case of compilation error, the method fallbacks to `test_single_docunit` to + # In case of success, the docunits are compiled and the caller can call `execute_simple_docunit`. + # + # In case of compilation error, the docunits are let uncompiled. + # The caller should fallbacks to `test_single_docunit` to # * locate exactly the compilation problem in the problematic docunit. # * permit the execution of the other docunits that may be correct. - fun test_simple_docunits(dus: Array[DocUnit]) + fun compile_simple_docunits(dus: Array[DocUnit]) do if dus.is_empty then return var file = "{prefix}-0.nit" + toolcontext.info("Compile {dus.length} simple(s) doc-unit(s) in {file}", 1) + var dir = file.dirname if dir != "" then dir.mkdir var f f = create_unitfile(file) var i = 0 for du in dus do - i += 1 f.write("fun run_{i} do\n") - f.write("# {du.testcase.attrs["name"]}\n") + f.write("# {du.full_name}\n") f.write(du.block) f.write("end\n") end @@ -144,100 +188,80 @@ class NitUnitExecutor if res != 0 then # Compilation error. - # Fall-back to individual modes: - for du in dus do - test_single_docunit(du) - end + # They should be generated and compiled independently return end + # Compilation was a success. + # Store what need to be executed for each one. i = 0 for du in dus do - var tc = du.testcase - toolcontext.modelbuilder.unit_entities += 1 i += 1 - toolcontext.info("Execute doc-unit {du.testcase.attrs["name"]} in {file} {i}", 1) - var res2 = sys.system("{file.to_program_name}.bin {i} >>'{file}.out1' 2>&1 '{file}.out1' 2>&1 >'{file}.out1' 2>&1 '{file}.out1' 2>&1 '{prefix}.out1' 2>&1 '{file}.out1' 2>&1 1 then + res += "#{number}" + end + return res + else + return xml_classname + "." + xml_name + end + end - # The text of the code to execute + # The text of the code to execute. + # + # This is the verbatim content on one, or more, code-blocks from `mdoc` var block: String + + # For each line in `block`, the associated line in the mdoc + # + # Is used to give precise locations + var lines = new Array[Int] + + # For each line in `block`, the associated column in the mdoc + # + # Is used to give precise locations + var columns = new Array[Int] + + # The location of the whole docunit. + # + # If `self` is made of multiple code-blocks, then the location + # starts at the first code-books and finish at the last one, thus includes anything between. + redef var location is lazy do + return new Location(mdoc.location.file, lines.first, lines.last+1, columns.first+1, 0) + end + + # Compute the real location of a node on the `ast` based on `mdoc.location` + # + # The result is basically: ast_location + markdown location of the piece + mdoc.location + # + # The fun is that a single docunit can be made of various pieces of code blocks. + fun real_location(ast_location: Location): Location + do + var mdoc = self.mdoc + + var res = new Location(mdoc.location.file, + lines[ast_location.line_start-1], + lines[ast_location.line_end-1], + columns[ast_location.line_start-1] + ast_location.column_start, + columns[ast_location.line_end-1] + ast_location.column_end) + + return res + end + + redef fun to_xml + do + var res = super + res.open("system-out").append(block) + return res + end + + redef var xml_classname + redef var xml_name end redef class ModelBuilder @@ -368,9 +583,7 @@ redef class ModelBuilder var prefix = toolcontext.test_dir prefix = prefix.join_path(mmodule.to_s) - var d2m = new NitUnitExecutor(toolcontext, prefix, o, ts) - - var tc + var d2m = new NitUnitExecutor(toolcontext, prefix, o, ts, "Docunits of module {mmodule.full_name}") do total_entities += 1 @@ -379,11 +592,8 @@ redef class ModelBuilder var ndoc = nmoduledecl.n_doc if ndoc == null then break label x doc_entities += 1 - tc = new HTMLTag("testcase") # NOTE: jenkins expects a '.' in the classname attr - tc.attr("classname", "nitunit." + mmodule.full_name + ".") - tc.attr("name", "") - d2m.extract(ndoc.to_mdoc, tc) + d2m.extract(ndoc.to_mdoc, "nitunit." + mmodule.full_name + ".", "") end label x for nclassdef in nmodule.n_classdefs do var mclassdef = nclassdef.mclassdef @@ -393,10 +603,7 @@ redef class ModelBuilder var ndoc = nclassdef.n_doc if ndoc != null then doc_entities += 1 - tc = new HTMLTag("testcase") - tc.attr("classname", "nitunit." + mmodule.full_name + "." + mclassdef.mclass.full_name) - tc.attr("name", "") - d2m.extract(ndoc.to_mdoc, tc) + d2m.extract(ndoc.to_mdoc, "nitunit." + mclassdef.full_name.replace("$", "."), "") end end for npropdef in nclassdef.n_propdefs do @@ -406,10 +613,8 @@ redef class ModelBuilder var ndoc = npropdef.n_doc if ndoc != null then doc_entities += 1 - tc = new HTMLTag("testcase") - tc.attr("classname", "nitunit." + mmodule.full_name + "." + mclassdef.mclass.full_name) - tc.attr("name", mpropdef.mproperty.full_name) - d2m.extract(ndoc.to_mdoc, tc) + var a = mpropdef.full_name.split("$") + d2m.extract(ndoc.to_mdoc, "nitunit." + a[0] + "." + a[1], a[2]) end end end @@ -433,20 +638,15 @@ redef class ModelBuilder var prefix = toolcontext.test_dir prefix = prefix.join_path(mgroup.to_s) - var d2m = new NitUnitExecutor(toolcontext, prefix, o, ts) - - var tc + var d2m = new NitUnitExecutor(toolcontext, prefix, o, ts, "Docunits of group {mgroup.full_name}") total_entities += 1 var mdoc = mgroup.mdoc if mdoc == null then return ts doc_entities += 1 - tc = new HTMLTag("testcase") # NOTE: jenkins expects a '.' in the classname attr - tc.attr("classname", "nitunit." + mgroup.full_name) - tc.attr("name", "") - d2m.extract(mdoc, tc) + d2m.extract(mdoc, "nitunit." + mgroup.mpackage.name + "." + mgroup.name + ".", "") d2m.run_tests @@ -457,26 +657,20 @@ redef class ModelBuilder fun test_mdoc(mdoc: MDoc): HTMLTag do var ts = new HTMLTag("testsuite") - var file = mdoc.location.to_s + var file = mdoc.location.file.as(not null).filename toolcontext.info("nitunit: doc-unit file {file}", 2) ts.attr("package", file) var prefix = toolcontext.test_dir / "file" - var d2m = new NitUnitExecutor(toolcontext, prefix, null, ts) - - var tc + var d2m = new NitUnitExecutor(toolcontext, prefix, null, ts, "Docunits of file {file}") total_entities += 1 doc_entities += 1 - tc = new HTMLTag("testcase") # NOTE: jenkins expects a '.' in the classname attr - tc.attr("classname", "nitunit.") - tc.attr("name", file) - - d2m.extract(mdoc, tc) + d2m.extract(mdoc, "nitunit.", file) d2m.run_tests return ts