# 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
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)
-
- # 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 invalid Nit code, 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
+ # Markdown processor used to parse markdown comments and extract code.
+ var mdproc = new MarkdownProcessor
- # Add it to the file
- blocks.last.add(text)
+ init do
+ mdproc.emitter.decorator = new NitunitDecorator(self)
end
# The associated documentation object
self.mdoc = mdoc
- work(mdoc)
+ # Populate `blocks` from the markdown decorator
+ mdproc.process(mdoc.content.join("\n"))
toolcontext.check_errors
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
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 </dev/null")
+ var res2 = toolcontext.safe_exec("{file.to_program_name}.bin {i} >'{file}.out1' 2>&1 </dev/null")
- var msg
f = new FileReader.open("{file}.out1")
var n2
n2 = new HTMLTag("system-err")
tc.add n2
- msg = f.read_all
+ var content = f.read_all
+ var msg = content.trunc(8192).filter_nonprintable
+ n2.append(msg)
f.close
n2 = new HTMLTag("system-out")
if res2 != 0 then
var ne = new HTMLTag("error")
- ne.attr("message", msg)
+ ne.attr("message", "Runtime error")
tc.add ne
- toolcontext.warning(du.mdoc.location, "error", "ERROR: {tc.attrs["classname"]}.{tc.attrs["name"]} (in {file}): {msg}")
+ toolcontext.warning(du.mdoc.location, "error", "ERROR: {tc.attrs["classname"]}.{tc.attrs["name"]} (in {file}): Runtime error\n{msg}")
toolcontext.modelbuilder.failed_entities += 1
end
toolcontext.check_errors
var res = compile_unitfile(file)
var res2 = 0
if res == 0 then
- res2 = sys.system("{file.to_program_name}.bin >>'{file}.out1' 2>&1 </dev/null")
+ res2 = toolcontext.safe_exec("{file.to_program_name}.bin >'{file}.out1' 2>&1 </dev/null")
end
- var msg
f = new FileReader.open("{file}.out1")
var n2
n2 = new HTMLTag("system-err")
tc.add n2
- msg = f.read_all
+ var content = f.read_all
+ var msg = content.trunc(8192).filter_nonprintable
+ n2.append(msg)
f.close
n2 = new HTMLTag("system-out")
if res != 0 then
var ne = new HTMLTag("failure")
- ne.attr("message", msg)
+ ne.attr("message", "Compilation Error")
tc.add ne
- toolcontext.warning(du.mdoc.location, "failure", "FAILURE: {tc.attrs["classname"]}.{tc.attrs["name"]} (in {file}): {msg}")
+ toolcontext.warning(du.mdoc.location, "failure", "FAILURE: {tc.attrs["classname"]}.{tc.attrs["name"]} (in {file}):\n{msg}")
toolcontext.modelbuilder.failed_entities += 1
else if res2 != 0 then
var ne = new HTMLTag("error")
- ne.attr("message", msg)
+ ne.attr("message", "Runtime Error")
tc.add ne
- toolcontext.warning(du.mdoc.location, "error", "ERROR: {tc.attrs["classname"]}.{tc.attrs["name"]} (in {file}): {msg}")
+ toolcontext.warning(du.mdoc.location, "error", "ERROR: {tc.attrs["classname"]}.{tc.attrs["name"]} (in {file}):\n{msg}")
toolcontext.modelbuilder.failed_entities += 1
end
toolcontext.check_errors
# Can terminate the program if the compiler is not found
private fun compile_unitfile(file: String): Int
do
- var nit_dir = toolcontext.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 nitc = toolcontext.find_nitc
var opts = new Array[String]
if mmodule != null then
- opts.add "-I {mmodule.location.file.filename.dirname}"
+ opts.add "-I {mmodule.filepath.dirname}"
end
var cmd = "{nitc} --ignore-visibility --no-color '{file}' {opts.join(" ")} >'{file}.out1' 2>&1 </dev/null -o '{file}.bin'"
- var res = sys.system(cmd)
+ var res = toolcontext.safe_exec(cmd)
return res
end
end
+private class NitunitDecorator
+ super HTMLDecorator
+
+ var executor: NitUnitExecutor
+
+ redef fun add_code(v, block) do
+ var code = block.raw_content
+ var meta = block.meta or else "nit"
+ # Do not try to test non-nit code.
+ if meta != "nit" then return
+ # Try to parse code blocks
+ var ast = executor.toolcontext.parse_something(code)
+
+ var mdoc = executor.mdoc
+ assert mdoc != null
+
+ # Skip pure comments
+ if ast isa TComment then return
+
+ # The location is computed according to the starts of the mdoc and the block
+ # Note, the following assumes that all the comments of the mdoc are correctly aligned.
+ var loc = block.block.location
+ var line_offset = loc.line_start + mdoc.location.line_start - 2
+ var column_offset = loc.column_start + mdoc.location.column_start
+ # Hack to handle precise location in blocks
+ # TODO remove when markdown is more reliable
+ if block isa BlockFence then
+ # Skip the starting fence
+ line_offset += 1
+ else
+ # Account a standard 4 space indentation
+ column_offset += 4
+ end
+
+ # We want executable code
+ if not (ast isa AModule or ast isa ABlockExpr or ast isa AExpr) then
+ var message
+ var l = ast.location
+ # Get real location of the node (or error)
+ var location = new Location(mdoc.location.file,
+ l.line_start + line_offset,
+ l.line_end + line_offset,
+ l.column_start + column_offset,
+ l.column_end + column_offset)
+ if ast isa AError then
+ message = ast.message
+ else
+ message = "Error: Invalid Nit code."
+ end
+
+ executor.toolcontext.warning(location, "invalid-block", "{message} To suppress this message, enclose the block with a fence tagged `nitish` or `raw` (see `man nitdoc`).")
+ executor.failures.add("{location}: {message}")
+ return
+ end
+
+ # Create a first block
+ # Or create a new block for modules that are more than a main part
+ if executor.blocks.is_empty or ast isa AModule then
+ executor.blocks.add(new Buffer)
+ end
+
+ # Add it to the file
+ executor.blocks.last.append code
+ end
+end
+
# A unit-test to run
class DocUnit
# The doc that contains self
# 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)
nitlanguage / nit.git / blobdiff