5 nitunit - executes the unit tests from Nit source files.
9 nitunit [*options*] FILE...
13 Unit testing in Nit can be achieved in two ways:
15 * using `DocUnits` in code comments
16 * using `TestSuites` with test unit files
18 `DocUnits` are executable pieces of code found in the documentation of modules,
19 classes and properties.
20 They are used for documentation purpose, they should be kept simple and illustrative.
21 More advanced unit testing can be done using TestSuites.
23 `TestSuites` are test files coupled to a tested module.
24 They contain a list of test methods called TestCase.
26 ## Working with `DocUnits`
28 DocUnits are blocks of executable code placed in comments of modules, classes and properties.
29 The execution can be verified using `assert`.
35 # assert foo.bar == 10
40 Everything used in the test must be declared.
41 To test a method you have to instantiate its class:
45 # assert foo.bar == 10
48 # assert foo.baz(1, 2) == 3
49 fun baz(a, b: Int) do return a + b
52 In a single piece of documentation, each docunit is considered a part of a single module, thus regrouped when
54 Therefore, it is possible (and recommended) to split docunits in small parts if it make the explanation easier.
57 # Some example of grouped docunits
59 # Declare and initialize a variable `a`.
63 # So the value of `a` can be used
67 # even in complex operations
73 Sometime, some blocks of code has to be included in documentation but not considered by `nitunit`.
74 Those blocks are distinguished by their tagged fences (untagged fences or fences tagged `nit` are considered to be docunits).
86 The special fence-tag `nitish` could also be used to indicate pseudo-nit that will be ignored by nitunit but highlighted by nitdoc.
87 Such `nitish` piece of code can be used to enclose examples that cannot compile or that one do not want to be automatically executed.
93 # var a: Int = someting
95 # if a == 1 then something else something-else
98 # Some code to not try to execute automatically
105 The `nitunit` command is used to test Nit files:
109 ## Working with `TestSuites`
111 TestSuites are Nit files that define a set of TestCases for a particular module.
113 The test suite must be called `test_` followed by the name of the module to test.
114 So for the module `foo.nit` the test suite will be called `test_foo.nit`.
116 The structure of a test suite is the following:
118 # test suite for module `foo`
120 import foo # can be intrude to test private things
122 # test case for `foo::Foo::baz`
124 var subject = new Foo
125 assert subject.baz(1, 2) == 3
129 Test suite can be executed using the same `nitunit` command:
133 `nitunit` will execute a test for each method named `test_*` in a class named `Test*`
134 so multiple tests can be executed for a single method:
138 var subject = new Foo
139 assert subject.baz(1, 2) == 3
142 var subject = new Foo
143 assert subject.baz(1, -2) == -1
147 `TestSuites` also provide methods to configure the test run:
149 `before_test` and `after_test`: methods called before/after each test case.
150 They can be used to factorize repetitive tasks:
154 # Mandatory empty init
156 # Method executed before each test
161 assert subject.baz(1, 2) == 3
164 assert subject.baz(1, -2) == -1
168 When using custom test attributes, an empty `init` must be declared to allow automatic test running.
170 `before_module` and `after_module`: methods called before/after each test suite.
171 They have to be declared at top level:
173 module test_bdd_connector
175 # Testing the bdd_connector
177 # test cases using a server
179 # Method executed before testing the module
181 # start server before all test cases
183 # Method executed after testing the module
185 # stop server after all test cases
188 ## Generating test suites
190 Write test suites for big modules can be a repetitive and boring task...
191 To make it easier, `nitunit` can generate test skeletons for Nit modules:
193 $ nitunit --gen-suite foo.nit
195 This will generate the test suite `test_foo` containing test case stubs for all public
196 methods found in `foo.nit`.
202 : Process also imported modules.
204 By default, only the modules indicated on the command line are tested.
206 With the `--full` option, all imported modules (even those in standard) are also precessed.
209 : Output name (default is 'nitunit.xml')
211 `nitunit` produces a XML file comatible with JUnit.
214 : Working directory (default is '.nitunit')
216 In order to execute the tests, nit files are generated then compiled and executed in the giver working directory.
219 : Does not compile and run tests.
222 : Only run test case with name that match pattern. Examples: `TestFoo`, `TestFoo*`, `TestFoo::test_foo`, `TestFoo::test_foo*`, `test_foo`, `test_foo*`
224 `-t`, `--target-file`
225 : Specify test suite location.
230 : Generate test suite skeleton for a module
233 : Force test generation even if file exists.
235 Any existing test suite will be overwritten.
238 : Also generate test case for private methods.
241 : Only display the skeleton, do not write any file.
245 The Nit language documentation and the source code of its tools and libraries may be downloaded from <http://nitlanguage.org>