- Notifications
You must be signed in to change notification settings - Fork13
A Testing Framework for LFE (successor to lfeunit)
License
lfex/ltest
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
A Unit, Integration, and System Tests Framework for LFE
Introduction↟
The macros in this library are, in large part, inspired by Clojure's excellentunit test framework. In addition to provding such a testing DSL for LFE, thislibrary also includes a visually pleasing test running with coloured outputand obvious errors/test failures. It also provides the ability to skip tests.
Dependencies↟
Version 0.11.0 is the first version to support and work with LFE 2.0.
As of version 0.7.0, this project assumes that you haverebar3 installed somwhere in your$PATH.It no longer uses the old version of rebar. If you do not wish to use rebar3,you may use the most recent rebar2-compatible release of ltest: 0.6.3.
EUnit Compatibility↟
The tests created with ltest are compatible with EUnit and can be run fromeither Erlang or LFE, using the standard EUnit listener or the ltestlistener (test runner).
Features↟
(deftest ...)for standard unit tests(deftestgen ...)for writing tests with generators, including thestandard EUnit test fixtures (see naming caveat below)(deftestskip ...)for skipping unit tests; note that for a test to show upas skipped in the test runner, it has to beexported in the module(list ...)-wrapped tests (of arbitrary depth) for use as test sets(tuple ...)-wrapped tests for naming/describing tests (first elementof tuple)(behaviour ltest-unit)- annotating a test module to be run as a unittest(behaviour ltest-integration)- annotating a test module to be run as anintegration test(behaviour ltest-system)- annotating a test module to be run as asystem test- A custom test runner that over-rides EUnit behaviour and aesthetics
Usingltest↟
Adding ltest to Your Project↟
In order to use ltest in your project, all you need to do is add a rebar dep.Generally, you only needltest when running tests, so it's best to add it asa dependency in thetest profile. You'll also need to tell EUnit where totake your tests from (eunit_compile_otps). In yourrebar.config:
{profiles, [ {test, [ {deps, [ {ltest,"0.13.7"} ]} {src_dirs, ["src","test"]} ]}]}.Once you write some tests (see below for how to do that), you can then do this:
$ rebar3 astest lfe ltestStructuring Your Tests↟
ltest doesn not support putting your unit tests directly in your modules. Ifyou do this, things may break or not work properly, even though Erlang's EUnitdoes support it.
Instead, you should create a top-level directory in your project calledtest. Intest, create a test cases module for every module your projecthas, e.g.,test/myproj-base-tests.lfe andtest/myproj-util-tests.lfe.Obviously, if it makes sense to break things up in a more fine-grained manner,feel free to do so :-)
Furthermore, ltest supports separating unit, integration, and system tests.This is done using custom OTP behaviours. For each test cases module you havecreated in./test, be sure to set the behaviour in the(defmodule ...)form. For instance:
(defmodule my-unit-tests (behaviour ltest-unit) (export ...))And two more as well:
(defmodule my-integration-tests (behaviour ltest-integration) (export ...))or
(defmodule my-system-tests (behaviour ltest-system) (export ...))For a working example of such a structure, see the layout of theltestproject itself: it uses just such a setup.
To read more about the distinction between unit, integration, and systemtests, check out the Wikipediaarticle on testing.
Naming Rules↟
Keep in mind that your tests will be compiled to.beam and then run withErlang's eunit module. As such, your tests need to following the sameconventions that eunit establishes:
Test module filenames should end in
-tests, e.g.,some-module-tests.lfe.Test module and filename need to be the same, minus the extension. Forexample,
test/unit-my-module-tests.lfeneeds to be declared as(defmodule unit-my-module-tests ...) in the test case module.If you chosenot to use the
deftestmacro to build each unit testfunction, you will need to name your unit test functions with_testappended to them. For example,(defun unit-my-function-negagive-check_test () ...). We recommend,however, that you usedeftestinstead, and obviate the need for_test ()boilerplate.
Creating Unit Tests↟
ltest is entirely macro-based. ltest uses LFE to parse the Erlang macros inthe eunit header file. It also provides its own header file which defines macroswhose main purpose is to wrap the eunit macros in a more Lispy form.
ltest also provides a syntactic sugar macro for defining tests:deftest.Instead of writing something like this for your unit tests:
(defununit-my-function-test () ...)
You can usedeftest to write this:
(deftest unit-my-function ...)
Note that the-test is no longer needed, nor is the empty argument list.
If you would like to use EUnit's fixtures feature, you must use another macro:
(deftestgen unit-my-function ...)
See the unit tests in thetest directory for example usage.
If you would like tests to be skipped, you can use this macro:
(deftestskip unit-my-function ...)
This will simply make the test invisible to EUnit. EUnit doesn't actuallytrack user-skipped tests; it only tracks tests that are skipped do to issuesas perceived by EUnit.
However, ltest's test runnerdoes track skipped tests and will reportthese in its output.
Here is a more complete example:
(defmodule unit-mymodule-tests (behaviour ltest-unit) (export all)) (include-lib"ltest/include/ltest-macros.lfe") (deftest is (is'true) (is (not'false)) (is (not (not'true)))) (deftest is-not (is-not`'false)) (deftest is-equal (is-equal2 (+11)))
ltest is working towards full test coverage; while not there yet, the unittests for ltest itself provide the best examples of usage.
Running Your Tests↟
The recommended way to run unit tests is to use the LFE plugin gotrebar3.Running tests is now as easy as doing the following:
$ rebar3 astest lfe ltestThat will run any unit tests you have defined. To run integration or system testsin your project:
$ rebar3 astest lfe ltest -tintegration $ rebar3 astest lfe ltest -tsystem
To run all tests for your project:
$ rebar3 astest lfe ltest -tallThe LFE Test Runner↟
ltest now includes a test runner which overrides the EUnit handlers with itsown. Here's what the output looks like with failing and skipped tests:
End:
And here's what passing tests looks like:
End:
The rest of themake targets still use lfetool, and will continue to doso, since lfetool will be updating to use ltest's new runner. If you'd liketo track the progress on these, here are the related tickets:
Dogfood↟
ltest writes its unit tests inltest :-) You can run them from theproject directory:
$ make check-runner-ltest
Which will give you output similar to the following:
================================ ltest =================================------------------------------ Unit Tests ------------------------------module: ltest-basic-tests is ................................................................ [ok] are* .............................................................. [ok] is_with_one_phrase_deftest ........................................ [ok] is_with_two_phrase_deftest ........................................ [ok] is_with_many_phrase_deftest ....................................... [ok] is_fail ........................................................... [ok] is_not ............................................................ [ok] is_not_fail ....................................................... [ok] is_equal .......................................................... [ok] is_equal_fail ..................................................... [ok] is_not_equal ...................................................... [ok] is_not_equal_fail ................................................. [ok] is_exception ...................................................... [ok] is_exception_wrong_class .......................................... [ok] is_exception_wrong_term ........................................... [ok] is_exception_unexpected_success ................................... [ok] is_not_exception .................................................. [ok] is_not_exception_exit ............................................. [ok] is_not_exception_throw ............................................ [ok] is_error .......................................................... [ok] is_error_wrong_term ............................................... [ok] is_error_unexpected_success ....................................... [ok] is_throw .......................................................... [ok] is_throw_wrong_term ............................................... [ok] is_throw_unexpected_success ....................................... [ok] is_exit ........................................................... [ok] is_exit_wrong_term ................................................ [ok] is_exit_unexpected_success ........................................ [ok] is_match .......................................................... [ok] is_match_fail ..................................................... [ok] time: 94msmodule: ltest-cancelled-tests setup_test_case ................................................... [ok] Another unused test ............................................... [ok] time: 17msmodule: ltest-fixture-tests setup_test_case ................................................... [ok] setup_test_case ................................................... [ok] Named setup test .................................................. [ok] setup_test_case ................................................... [ok] setup_test_case ................................................... [ok] Named setup test .................................................. [ok] setup_test_case ................................................... [ok] setup_test_case ................................................... [ok] Named setup test .................................................. [ok] foreach_test_case ................................................. [ok] foreach_test_case ................................................. [ok] setup_test_case ................................................... [ok] setup_test_case ................................................... [ok] Named setup test .................................................. [ok] foreach_test_case ................................................. [ok] foreach_test_case ................................................. [ok] time: 49msmodule: ltest-fixturecase-tests setup_tc_test_case ................................................ [ok] setup_tc_test_case ................................................ [ok] Named test in setup-tc ............................................ [ok] setup_tc_test_case ................................................ [ok] setup_tc_test_case ................................................ [ok] Named test in setup-tc ............................................ [ok] setup_tc_test_case ................................................ [ok] setup_tc_test_case ................................................ [ok] Named test in setup-tc ............................................ [ok] foreach_tc_test_case .............................................. [ok] foreach_tc_test_case .............................................. [ok] Named foreach-tc test ............................................. [ok] setup_tc_test_case ................................................ [ok] setup_tc_test_case ................................................ [ok] Named test in setup-tc ............................................ [ok] foreach_tc_test_case .............................................. [ok] foreach_tc_test_case .............................................. [ok] Named foreach-tc test ............................................. [ok] time: 56msmodule: ltest-generated-tests is* ............................................................... [ok] is_not*_in_list ................................................... [ok] many_generators_in_list ........................................... [ok] many_generators_in_list ........................................... [ok] many_generators_in_list ........................................... [ok] nested_test_set ................................................... [ok] nested_test_set ................................................... [ok] nested_test_set ................................................... [ok] nested_test_set ................................................... [ok] nested_test_set ................................................... [ok] nested_test_set ................................................... [ok] time: 34msmodule: ltest-named-tests named_is .......................................................... [ok] named_is_not_fail ................................................. [ok] named_testset_with_one ............................................ [ok] named_testset_with_two ............................................ [ok] named_testset_with_three .......................................... [ok] named_testset_nested .............................................. [ok] named_testset_deeply_nested ....................................... [ok] time: 22msmodule: ltest-skipped-tests bogus_test_will_be_skipped ...................................... [skip] time: 1msmodule: ltest-testset-tests testset_with_one .................................................. [ok] testset_with_two .................................................. [ok] testset_with_three ................................................ [ok] testset_nested .................................................... [ok] testset_deeply_nested ............................................. [ok] time: 16mssummary: Tests: 90 Passed: 89 Skipped: 1 Failed: 0 Erred: 0 Total time: 289ms----------------------------- System Tests -----------------------------There were no system tests found.-------------------------- Integration Tests ---------------------------There were no integration tests found.========================================================================License↟
BSD 3-Clause License
Copyright © 2013-2021, Duncan McGreggor <oubiwann@gmail.com>Copyright © 2014, Døkkarr Hirðisson <dokkarr@lfe.io>, Joshua Schairbaum <joshua.schairbaum@gmail.com>Copyright © 2016, Eric Bailey <eric@ericb.me>, jsc <jonas.skovsgaard.christensen@gmail.com>About
A Testing Framework for LFE (successor to lfeunit)