Introduce module `test_doc` that implements "doc-units".
Signed-off-by: Alexandre Terrasa <alexandre@moz-code.org>
# Program to extract and execute unit tests from nit source files
module nitunit
-import modelize_property
-intrude import markdown
-import parser_util
-
-# Extractor, Executor an Reporter for the tests in a module
-class NitUnitExecutor
- super Doc2Mdwn
-
- # The module to import
- var mmodule: MModule
-
- # The prefix of the generated Nit source-file
- var prefix: String
-
- # The XML node associated to the module
- var testsuite: HTMLTag
-
- # Initialize a new e
- init(toolcontext: ToolContext, prefix: String, mmodule: MModule, testsuite: HTMLTag)
- do
- super(toolcontext)
- self.prefix = prefix
- self.mmodule = mmodule
- self.testsuite = testsuite
- end
-
- # All blocks of code from a same `ADoc`
- var blocks = new Array[Array[String]]
-
- redef fun process_code(n: HTMLTag, text: String)
- do
- # Try to parse it
- var ast = toolcontext.parse_something(text)
-
- # 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, "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, ast.message)
- ndoc = null # To avoid multiple warning in the same node
- end
- 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, "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
- 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])
- end
-
- # Add it to the file
- blocks.last.add(text)
- end
-
- # The associated node to localize warnings
- var ndoc: nullable ADoc
-
- # used to generate distinct names
- var cpt = 0
-
- # The entry point for a new `ndoc` node
- # Fill the prepated `tc` (testcase) XTM node
- fun extract(ndoc: ADoc, tc: HTMLTag)
- do
- blocks.clear
-
- self.ndoc = ndoc
-
- work(ndoc.to_mdoc)
- toolcontext.check_errors
-
- if blocks.is_empty then return
-
- for block in blocks do test_block(ndoc, tc, block)
- end
-
- # Execute a block
- fun test_block(ndoc: ADoc, tc: HTMLTag, block: Array[String])
- do
- toolcontext.modelbuilder.unit_entities += 1
-
- cpt += 1
- var file = "{prefix}{cpt}.nit"
-
- toolcontext.info("Execute {tc.attrs["name"]} in {file}", 1)
-
- var dir = file.dirname
- if dir != "" then dir.mkdir
- var f
- f = new OFStream.open(file)
- f.write("# GENERATED FILE\n")
- f.write("# Example extracted from a documentation\n")
- f.write("import {mmodule.name}\n")
- f.write("\n")
- for text in block do
- f.write(text)
- end
- f.close
-
- if toolcontext.opt_noact.value then return
-
- var nit_dir = toolcontext.nit_dir
- var nitg = "{nit_dir or else ""}/bin/nitg"
- if nit_dir == null or not nitg.file_exists then
- toolcontext.error(null, "Cannot find nitg. Set envvar NIT_DIR.")
- toolcontext.check_errors
- end
- var cmd = "{nitg} --ignore-visibility --no-color '{file}' -I {mmodule.location.file.filename.dirname} >'{file}.out1' 2>&1 </dev/null -o '{file}.bin'"
- var res = sys.system(cmd)
- var res2 = 0
- if res == 0 then
- res2 = sys.system("./{file}.bin >>'{file}.out1' 2>&1 </dev/null")
- end
-
- var msg
- f = new IFStream.open("{file}.out1")
- var n2
- n2 = new HTMLTag("system-err")
- tc.add n2
- msg = f.read_all
- f.close
-
- n2 = new HTMLTag("system-out")
- tc.add n2
- for text in block do n2.append(text)
-
-
- if res != 0 then
- var ne = new HTMLTag("failure")
- ne.attr("message", msg)
- tc.add ne
- toolcontext.warning(ndoc.location, "FAILURE: {tc.attrs["classname"]}.{tc.attrs["name"]} (in {file}): {msg}")
- toolcontext.modelbuilder.failed_entities += 1
- else if res2 != 0 then
- var ne = new HTMLTag("error")
- ne.attr("message", msg)
- tc.add ne
- toolcontext.warning(ndoc.location, "ERROR: {tc.attrs["classname"]}.{tc.attrs["name"]} (in {file}): {msg}")
- toolcontext.modelbuilder.failed_entities += 1
- end
- toolcontext.check_errors
-
- testsuite.add(tc)
- end
-end
-
-class SearchAssertVisitor
- super Visitor
- var foundit = false
- redef fun visit(node)
- do
- if foundit then
- return
- else if node isa AAssertExpr then
- foundit = true
- return
- else
- node.visit_all(self)
- end
- end
-end
-
-redef class ModelBuilder
- var total_entities = 0
- var doc_entities = 0
- var unit_entities = 0
- var failed_entities = 0
-
- fun test_markdown(mmodule: MModule): HTMLTag
- do
- var ts = new HTMLTag("testsuite")
- toolcontext.info("nitunit: {mmodule}", 2)
- if not mmodule2nmodule.has_key(mmodule) then return ts
-
- var nmodule = mmodule2nmodule[mmodule]
- assert nmodule != null
-
- # 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)
- end
-
- ts.attr("package", mmodule.full_name)
-
- var prefix = toolcontext.opt_dir.value
- if prefix == null then prefix = ".nitunit"
- prefix = prefix.join_path(mmodule.to_s)
- var d2m = new NitUnitExecutor(toolcontext, prefix, o, ts)
-
- var tc
-
- do
- total_entities += 1
- var nmoduledecl = nmodule.n_moduledecl
- if nmoduledecl == null then break label x
- 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", mmodule.full_name + ".<module>")
- tc.attr("name", "<module>")
- d2m.extract(ndoc, tc)
- end label x
- for nclassdef in nmodule.n_classdefs do
- var mclassdef = nclassdef.mclassdef.as(not null)
- if nclassdef isa AStdClassdef then
- total_entities += 1
- var ndoc = nclassdef.n_doc
- if ndoc != null then
- doc_entities += 1
- tc = new HTMLTag("testcase")
- tc.attr("classname", mmodule.full_name + "." + mclassdef.mclass.full_name)
- tc.attr("name", "<class>")
- d2m.extract(ndoc, tc)
- end
- end
- for npropdef in nclassdef.n_propdefs do
- var mpropdef = npropdef.mpropdef.as(not null)
- total_entities += 1
- var ndoc = npropdef.n_doc
- if ndoc != null then
- doc_entities += 1
- tc = new HTMLTag("testcase")
- tc.attr("classname", mmodule.full_name + "." + mclassdef.mclass.full_name)
- tc.attr("name", mpropdef.mproperty.full_name)
- d2m.extract(ndoc, tc)
- end
- end
- end
-
- return ts
- end
-end
-
-redef class ToolContext
- var opt_full = new OptionBool("Process also imported modules", "--full")
- var opt_output = new OptionString("Output name (default is 'nitunit.xml')", "-o", "--output")
- var opt_dir = new OptionString("Working directory (default is '.nitunit')", "--dir")
- var opt_noact = new OptionBool("Does not compile and run tests", "--no-act")
-end
+import testing
var toolcontext = new ToolContext
--- /dev/null
+# This file is part of NIT ( http://www.nitlanguage.org ).
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Test unit generation and execution for Nit.
+module testing
+
+import testing_doc
--- /dev/null
+# This file is part of NIT ( http://www.nitlanguage.org ).
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Base options for testing tools.
+module testing_base
+
+import modelize_property
+import parser_util
+
+redef class ToolContext
+ # opt --full
+ var opt_full = new OptionBool("Process also imported modules", "--full")
+ # opt --output
+ var opt_output = new OptionString("Output name (default is 'nitunit.xml')", "-o", "--output")
+ # opt --dirr
+ var opt_dir = new OptionString("Working directory (default is '.nitunit')", "--dir")
+ # opt --no-act
+ var opt_noact = new OptionBool("Does not compile and run tests", "--no-act")
+end
--- /dev/null
+# This file is part of NIT ( http://www.nitlanguage.org ).
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Testing from code comments.
+module testing_doc
+
+import testing_base
+intrude import markdown
+
+# Extractor, Executor and Reporter for the tests in a module
+class NitUnitExecutor
+ super Doc2Mdwn
+
+ # The module to import
+ var mmodule: MModule
+
+ # The prefix of the generated Nit source-file
+ var prefix: String
+
+ # The XML node associated to the module
+ var testsuite: HTMLTag
+
+ # Initialize a new e
+ init(toolcontext: ToolContext, prefix: String, mmodule: MModule, testsuite: HTMLTag)
+ do
+ super(toolcontext)
+ self.prefix = prefix
+ self.mmodule = mmodule
+ self.testsuite = testsuite
+ end
+
+ # All blocks of code from a same `ADoc`
+ var blocks = new Array[Array[String]]
+
+ redef fun process_code(n: HTMLTag, text: String)
+ do
+ # Try to parse it
+ var ast = toolcontext.parse_something(text)
+
+ # 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, "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, ast.message)
+ ndoc = null # To avoid multiple warning in the same node
+ end
+ 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, "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
+ 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])
+ end
+
+ # Add it to the file
+ blocks.last.add(text)
+ end
+
+ # The associated node to localize warnings
+ var ndoc: nullable ADoc
+
+ # used to generate distinct names
+ var cpt = 0
+
+ # The entry point for a new `ndoc` node
+ # Fill the prepated `tc` (testcase) XTM node
+ fun extract(ndoc: ADoc, tc: HTMLTag)
+ do
+ blocks.clear
+
+ self.ndoc = ndoc
+
+ work(ndoc.to_mdoc)
+ toolcontext.check_errors
+
+ if blocks.is_empty then return
+
+ for block in blocks do test_block(ndoc, tc, block)
+ end
+
+ # Execute a block
+ fun test_block(ndoc: ADoc, tc: HTMLTag, block: Array[String])
+ do
+ toolcontext.modelbuilder.unit_entities += 1
+
+ cpt += 1
+ var file = "{prefix}{cpt}.nit"
+
+ toolcontext.info("Execute doc-unit {tc.attrs["name"]} in {file}", 1)
+
+ var dir = file.dirname
+ if dir != "" then dir.mkdir
+ var f
+ f = new OFStream.open(file)
+ f.write("# GENERATED FILE\n")
+ f.write("# Example extracted from a documentation\n")
+ f.write("import {mmodule.name}\n")
+ f.write("\n")
+ for text in block do
+ f.write(text)
+ end
+ f.close
+
+ if toolcontext.opt_noact.value then return
+
+ var nit_dir = toolcontext.nit_dir
+ var nitg = "{nit_dir or else ""}/bin/nitg"
+ if nit_dir == null or not nitg.file_exists then
+ toolcontext.error(null, "Cannot find nitg. Set envvar NIT_DIR.")
+ toolcontext.check_errors
+ end
+ var cmd = "{nitg} --ignore-visibility --no-color '{file}' -I {mmodule.location.file.filename.dirname} >'{file}.out1' 2>&1 </dev/null -o '{file}.bin'"
+ var res = sys.system(cmd)
+ var res2 = 0
+ if res == 0 then
+ res2 = sys.system("./{file}.bin >>'{file}.out1' 2>&1 </dev/null")
+ end
+
+ var msg
+ f = new IFStream.open("{file}.out1")
+ var n2
+ n2 = new HTMLTag("system-err")
+ tc.add n2
+ msg = f.read_all
+ f.close
+
+ n2 = new HTMLTag("system-out")
+ tc.add n2
+ for text in block do n2.append(text)
+
+
+ if res != 0 then
+ var ne = new HTMLTag("failure")
+ ne.attr("message", msg)
+ tc.add ne
+ toolcontext.warning(ndoc.location, "FAILURE: {tc.attrs["classname"]}.{tc.attrs["name"]} (in {file}): {msg}")
+ toolcontext.modelbuilder.failed_entities += 1
+ else if res2 != 0 then
+ var ne = new HTMLTag("error")
+ ne.attr("message", msg)
+ tc.add ne
+ toolcontext.warning(ndoc.location, "ERROR: {tc.attrs["classname"]}.{tc.attrs["name"]} (in {file}): {msg}")
+ toolcontext.modelbuilder.failed_entities += 1
+ end
+ toolcontext.check_errors
+
+ testsuite.add(tc)
+ end
+end
+
+class SearchAssertVisitor
+ super Visitor
+ var foundit = false
+ redef fun visit(node)
+ do
+ if foundit then
+ return
+ else if node isa AAssertExpr then
+ foundit = true
+ return
+ else
+ node.visit_all(self)
+ end
+ end
+end
+
+redef class ModelBuilder
+ var total_entities = 0
+ var doc_entities = 0
+ var unit_entities = 0
+ var failed_entities = 0
+
+ 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]
+ assert nmodule != null
+
+ # 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)
+ end
+
+ ts.attr("package", mmodule.full_name)
+
+ var prefix = toolcontext.opt_dir.value
+ if prefix == null then prefix = ".nitunit"
+ prefix = prefix.join_path(mmodule.to_s)
+ var d2m = new NitUnitExecutor(toolcontext, prefix, o, ts)
+
+ var tc
+
+ do
+ total_entities += 1
+ var nmoduledecl = nmodule.n_moduledecl
+ if nmoduledecl == null then break label x
+ 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", mmodule.full_name + ".<module>")
+ tc.attr("name", "<module>")
+ d2m.extract(ndoc, tc)
+ end label x
+ for nclassdef in nmodule.n_classdefs do
+ var mclassdef = nclassdef.mclassdef
+ if mclassdef == null then continue
+ if nclassdef isa AStdClassdef then
+ total_entities += 1
+ var ndoc = nclassdef.n_doc
+ if ndoc != null then
+ doc_entities += 1
+ tc = new HTMLTag("testcase")
+ tc.attr("classname", mmodule.full_name + "." + mclassdef.mclass.full_name)
+ tc.attr("name", "<class>")
+ d2m.extract(ndoc, tc)
+ end
+ end
+ for npropdef in nclassdef.n_propdefs do
+ var mpropdef = npropdef.mpropdef
+ if mpropdef == null then continue
+ total_entities += 1
+ var ndoc = npropdef.n_doc
+ if ndoc != null then
+ doc_entities += 1
+ tc = new HTMLTag("testcase")
+ tc.attr("classname", mmodule.full_name + "." + mclassdef.mclass.full_name)
+ tc.attr("name", mpropdef.mproperty.full_name)
+ d2m.extract(ndoc, tc)
+ end
+ end
+ end
+
+ return ts
+ end
+end
nitlanguage / nit.git / commitdiff