X-Git-Url: http://nitlanguage.org diff --git a/src/testing/testing_doc.nit b/src/testing/testing_doc.nit index d38401a..82518da 100644 --- a/src/testing/testing_doc.nit +++ b/src/testing/testing_doc.nit @@ -15,12 +15,17 @@ # Testing from code comments. module testing_doc +private import parser_util import testing_base -intrude import docdown +import markdown +import html # Extractor, Executor and Reporter for the tests in a module class NitUnitExecutor - super Doc2Mdwn + super HTMLDecorator + + # Toolcontext used to parse Nit code blocks. + var toolcontext: ToolContext # The prefix of the generated Nit source-file var prefix: String @@ -32,44 +37,16 @@ class NitUnitExecutor var testsuite: HTMLTag # All blocks of code from a same `ADoc` - var blocks = new Array[Array[String]] + var blocks = new Array[Buffer] # All failures from a same `ADoc` var failures = new Array[String] - redef fun process_code(n: HTMLTag, text: String, tag: nullable String) - do - # Skip non-blocks - if n.tag != "pre" then return - - # Skip strict non-nit - if tag != null and tag != "nit" and tag != "" then - return - end - - # Try to parse it - var ast = toolcontext.parse_something(text) + # Markdown processor used to parse markdown comments and extract code. + var mdproc = new MarkdownProcessor - # Skip pure comments - if ast isa TComment then return - - # We want executable code - if not (ast isa AModule or ast isa ABlockExpr or ast isa AExpr) then - var message = "" - if ast isa AError then message = " At {ast.location}: {ast.message}." - toolcontext.warning(mdoc.location, "invalid-block", "Error: There is a block of code that is not valid Nit, thus not considered a nitunit. To suppress this warning, enclose the block with a fence tagged `nitish` or `raw` (see `man nitdoc`).{message}") - failures.add("{mdoc.location}: Invalid block of code.{message}") - 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]) - end - - # Add it to the file - blocks.last.add(text) + init do + mdproc.emitter.decorator = new NitunitDecorator(self) end # The associated documentation object @@ -89,7 +66,8 @@ class NitUnitExecutor self.mdoc = mdoc - work(mdoc) + # Populate `blocks` from the markdown decorator + mdproc.process(mdoc.content.join("\n")) toolcontext.check_errors @@ -98,15 +76,15 @@ class NitUnitExecutor 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.join("")) + docunits.add new DocUnit(mdoc, tc, block.write_to_string) end end @@ -291,21 +269,80 @@ class NitUnitExecutor private fun compile_unitfile(file: String): Int do var nit_dir = toolcontext.nit_dir - var nitg = nit_dir/"bin/nitg" - if not nitg.file_exists then - toolcontext.error(null, "Cannot find nitg. Set envvar NIT_DIR.") + var nitc = nit_dir/"bin/nitc" + if not nitc.file_exists then + toolcontext.error(null, "Error: cannot find nitc. Set envvar NIT_DIR.") toolcontext.check_errors end var opts = new Array[String] if mmodule != null then opts.add "-I {mmodule.location.file.filename.dirname}" end - var cmd = "{nitg} --ignore-visibility --no-color '{file}' {opts.join(" ")} >'{file}.out1' 2>&1 '{file}.out1' 2>&1 ` 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) + + var tc + + 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.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.to_s + + 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 + + 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.run_tests + + return ts + end end