X-Git-Url: http://nitlanguage.org diff --git a/src/testing/testing_doc.nit b/src/testing/testing_doc.nit index 86466bf..46f5a4a 100644 --- a/src/testing/testing_doc.nit +++ b/src/testing/testing_doc.nit @@ -15,202 +15,575 @@ # Testing from code comments. module testing_doc +private import parser_util import testing_base -intrude import docdown +import markdown2 +import html +import realtime # Extractor, Executor and Reporter for the tests in a module class NitUnitExecutor - super Doc2Mdwn + + # Toolcontext used to parse Nit code blocks. + var toolcontext: ToolContext # The prefix of the generated Nit source-file var prefix: String - # The module to import - var mmodule: MModule + # The module to import, if any + var mmodule: nullable MModule # The XML node associated to the module var testsuite: HTMLTag - # All blocks of code from a same `ADoc` - var blocks = new Array[Array[String]] + # The name of the suite + var name: String + + # Markdown parse used to parse markdown comments and extract code + private var md_parser = new MdParser + + # Markdown visitor used to extract markdown code blocks + private var md_visitor = new NitunitMdVisitor(self) is lazy - redef fun process_code(n: HTMLTag, text: String, tag: nullable String) + # The associated documentation object + var mdoc: nullable MDoc = null + + # 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. + fun extract(mdoc: MDoc, xml_classname, xml_name: String) do - # Skip non-blocks - if n.tag != "pre" then return + last_docunit = null + self.xml_classname = xml_classname + self.xml_name = xml_name - # Try to parse it - var ast = toolcontext.parse_something(text) + self.mdoc = mdoc - # We want executable code - if not (ast isa AModule or ast isa ABlockExpr or ast isa AExpr) then - if ndoc != null and n.tag == "pre" and toolcontext.opt_warn.value > 1 then - toolcontext.warning(ndoc.location, "invalid-block", "Warning: There is a block of code that is not valid Nit, thus not considered a nitunit") - if ast isa AError then toolcontext.warning(ast.location, "syntax-error", ast.message) - ndoc = null # To avoid multiple warning in the same node - end + # Populate `blocks` from the markdown decorator + 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 + if docunits.is_empty then return end - # Search `assert` in the AST - var v = new SearchAssertVisitor - v.enter_visit(ast) - if not v.foundit then - if ndoc != null and n.tag == "pre" and toolcontext.opt_warn.value > 1 then - toolcontext.warning(ndoc.location, "invalid-block", "Warning: There is a block of Nit code without `assert`, thus not considered a nitunit") - ndoc = null # To avoid multiple warning in the same node + # 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 - return end - # Create a first block - # Or create a new block for modules that are more than a main part - if blocks.is_empty or ast isa AModule then - blocks.add(new Array[String]) + # 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 - # Add it to the file - blocks.last.add(text) + # Final status + show_status + print "" + + for du in docunits do + testsuite.add du.to_xml + end end - # The associated node to localize warnings - var ndoc: nullable ADoc = null + # Compiles multiples doc-units in a shared program. + # Used for docunits simple block of code (without modules, classes, functions etc.) + # + # 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 compile_simple_docunits(dus: Array[DocUnit]) + do + if dus.is_empty then return - # used to generate distinct names - var cpt = 0 + var file = "{prefix}-0.nit" - # The entry point for a new `ndoc` node - # Fill the prepated `tc` (testcase) XTM node - fun extract(ndoc: ADoc, tc: HTMLTag) - do - blocks.clear + toolcontext.info("Compile {dus.length} simple(s) doc-unit(s) in {file}", 1) - self.ndoc = ndoc + 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.full_name}\n") + f.write(du.block) + f.write("end\n") + end + f.write("var a = args.first.to_i\n") + for j in [1..i] do + f.write("if a == {j} then run_{j}\n") + end + f.close - work(ndoc.to_mdoc) - toolcontext.check_errors + if toolcontext.opt_noact.value then return + + var res = compile_unitfile(file) - if blocks.is_empty then return + if res != 0 then + # Compilation error. + # They should be generated and compiled independently + return + end - for block in blocks do test_block(ndoc, tc, block) + # Compilation was a success. + # Store what need to be executed for each one. + i = 0 + for du in dus do + i += 1 + du.test_file = file + du.test_arg = i + du.is_compiled = true + end end - # Execute a block - fun test_block(ndoc: ADoc, tc: HTMLTag, block: Array[String]) + # Execute a docunit compiled by `test_single_docunit` + fun execute_simple_docunit(du: DocUnit) do - toolcontext.modelbuilder.unit_entities += 1 + var file = du.test_file.as(not null) + var i = du.test_arg or else 0 + toolcontext.info("Execute doc-unit {du.full_name} in {file} {i}", 1) + var clock = new Clock + var res2 = toolcontext.safe_exec("{file.to_program_name}.bin {i} >'{file}.out1' 2>&1 '{file}.out1' 2>&1 >'{file}.out1' 2>&1 '{prefix}.out1' 2>&1 1 then + res += "#{number}" + end + return res else - node.visit_all(self) + return xml_classname + "." + xml_name end end + + # 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 + # Total number analyzed `MEntity` var total_entities = 0 + + # The number of `MEntity` that have some documentation var doc_entities = 0 + + # The total number of executed docunits var unit_entities = 0 + + # The number failed docunits var failed_entities = 0 + # Extracts and executes all the docunits in the `mmodule` + # Returns a JUnit-compatible `` XML element that contains the results of the executions. fun test_markdown(mmodule: MModule): HTMLTag do var ts = new HTMLTag("testsuite") toolcontext.info("nitunit: doc-unit {mmodule}", 2) - if not mmodule2nmodule.has_key(mmodule) then return ts - var nmodule = mmodule2nmodule[mmodule] + var nmodule = mmodule2node(mmodule) + if nmodule == null then return ts # usualy, only the original module must be imported in the unit test. var o = mmodule var g = o.mgroup - if g != null and g.mproject.name == "standard" then - # except for a unit test in a module of standard - # in this case, the whole standard must be imported - o = get_mmodule_by_name(nmodule, g, g.mproject.name).as(not null) + if g != null and g.mpackage.name == "core" then + # except for a unit test in a module of `core` + # in this case, the whole `core` must be imported + o = get_mmodule_by_name(nmodule, g, g.mpackage.name).as(not null) end ts.attr("package", mmodule.full_name) 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 @@ -219,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, tc) + d2m.extract(ndoc.to_mdoc, "nitunit." + mmodule.full_name + ".", "") end label x for nclassdef in nmodule.n_classdefs do var mclassdef = nclassdef.mclassdef @@ -233,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, tc) + d2m.extract(ndoc.to_mdoc, "nitunit." + mclassdef.full_name.replace("$", "."), "") end end for npropdef in nclassdef.n_propdefs do @@ -246,14 +613,66 @@ 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, tc) + var a = mpropdef.full_name.split("$") + d2m.extract(ndoc.to_mdoc, "nitunit." + a[0] + "." + a[1], a[2]) end end end + d2m.run_tests + + return ts + end + + # Extracts and executes all the docunits in the readme of the `mgroup` + # Returns a JUnit-compatible `` XML element that contains the results of the executions. + fun test_group(mgroup: MGroup): HTMLTag + do + var ts = new HTMLTag("testsuite") + toolcontext.info("nitunit: doc-unit group {mgroup}", 2) + + # usually, only the default module must be imported in the unit test. + var o = mgroup.default_mmodule + + ts.attr("package", mgroup.full_name) + + var prefix = toolcontext.test_dir + prefix = prefix.join_path(mgroup.to_s) + 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 + # NOTE: jenkins expects a '.' in the classname attr + d2m.extract(mdoc, "nitunit." + mgroup.mpackage.name + "." + mgroup.name + ".", "") + + d2m.run_tests + + return ts + end + + # Test a document object unrelated to a Nit entity + fun test_mdoc(mdoc: MDoc): HTMLTag + do + var ts = new HTMLTag("testsuite") + 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, "Docunits of file {file}") + + total_entities += 1 + doc_entities += 1 + + # NOTE: jenkins expects a '.' in the classname attr + d2m.extract(mdoc, "nitunit.", file) + d2m.run_tests + return ts end end