View mode: basic / threaded / horizontal-split · Log in · Help
February 19, 2012
DUnit - class MyTest { mixin TestMixin; void testMethod1() {} void testMethod2() {}}
People of the D world.. I give you DUnit (not to be confused with 
an old
tango DUnit, this one is for >= D2.057, and doesn't really 
require phobos or tango (just you version the few writeln's of 
the runner, and maybe
something else)).

      https://github.com/jmcabo/dunit

I've been developing it for the past few weeks, and since I saw a 
post of another unit testing framework just a few minutes ago, I 
thought I'd rush it to github.

Soooo, here is how you define a test:


import dunit;

class Something {
    mixin TestMixin;

    void testOne() {
        assert(1 == 1, "this works");
    }

    void testTwo() {
        assertEquals(1, 2/2);
        assertEquals("a string", "a"~" string");
    }
}

.. and that's all there is to it. Put the mixin TestMixin, and 
name your tests
starting with 'test'. The results output shows all of them even 
if some fail, and... guess what, it tells you the name of the 
unit tests that failed!! isn't this awesome!! (all thanks to 
mixins, recursive template declarations, __traits, and a little 
bit of CTFE)... isn't D like, so incredibly awesome or what!?!?

There is absolutely no overhead in registering the tests for the 
test runner.. its all at compile time!

Your tests are inherited through derived classes, and can be 
private in the unit test class (they will still run).


I made two test runners:

    * One that shows the results in java style (but WITH COLORS!! 
(fineprint: colors only on unix console, windows console is 
colorless for now)

    * Another one more verbose that shows the tree of tests as it 
runs them.

It is very easy to make your own.


This is all BOOST licenced, so please tweak it away!


FINEPRINT yes shouting fineprint ;-) haha:
THIS IS NOT A unitest{} REPLACEMENT, JUST AN ITCH EVERY OOP 
PEOPLE WANTED TO SCRATCH: named, easy, xUnit style unit tests.. 
AND NOW YOU'VE GOT THEM.
February 19, 2012
Re: DUnit - class MyTest { mixin TestMixin; void testMethod1() {} void testMethod2() {}}
Unit testing framework ('dunit')

Allows to define unittests simply as methods which names start
with 'test'.
The only thing necessary to create a unit test class, is to
declare the mixin TestMixin inside the class. This will register
the class and its test methods for the test runner.

License:   <a href="http://www.boost.org/LICENSE_1_0.txt">Boost 
License 1.0</a>.
Authors:   Juan Manuel Cabo
Version:   0.3
Source:    dunit.d
Last update: 2012-02-19

         Copyright Juan Manuel Cabo 2012.
Distributed under the Boost Software License, Version 1.0.
   (See accompanying file LICENSE_1_0.txt or copy at
         http://www.boost.org/LICENSE_1_0.txt)
---------------------------------------------------------------------------------

module ExampleTests;
import std.stdio, std.string;
import dunit;


//Minimal example:
class ATestClass() {
    mixin TestMixin;

    void testExample() {
        assertEquals("bla", "b"~"la");
    }
}


/**
 * Look!! no test base class needed!!
 */
class AbcTest {
    //This declaration here is the only thing needed to mark a 
class as a unit test class.
    mixin TestMixin;

    //Variable members that start with 'test' are allowed.
    public int testN = 3;
    public int testM = 4;

    //Any method whose name starts with 'test' is run as a unit 
test:
    //(NOTE: this is bound at compile time, there is no overhead).
    public void test1() {
        assert(true);
    }

    public void test2() {
        //You can use D's assert() function:
        assert(1 == 2 / 2);
        //Or dunit convenience asserts (just edit dunit.d to add 
more):
        assertEquals(1, 2/2);
        //The expected and actual values will be shown in the 
output:
        assertEquals("my string looks dazzling", "my dtring looks 
sazzling");
    }

    //Test methods with default arguments work, as long as they 
can
    //be called without arguments, ie: as testDefaultArguments() 
for instance:
    public void testDefaultArguments(int a=4, int b=3) {
    }

    //Even if the method is private to the unit test class, it is 
still run.
    private void test5(int a=4) {
    }

    //This test was disabled just by adding an underscore to the 
name:
    public void _testAnother() {
        assert(false, "fails");
    }

    //Optional inicialization and de-initialization.
    //  setUp() and tearDown() are called around each individual 
test.
    //  setUpClass() and tearDownClass() are called once around 
the whole unit test.
    public void setUp() {
    }
    public void tearDown() {
    }
    public void setUpClass() {
    }
    public void tearDownClass() {
    }
}


class DerivedTest : AbcTest {
    mixin TestMixin;

    //Base class tests will be run!!!!!!
    //You can for instance override setUpClass() and change the 
target implementation
    //of a family of classes that you are testing.
}


version = DUnit;

version(DUnit) {

    //-All you need to run the tests, is to declare
    //
    //      mixin DUnitMain.
    //
    //-You can alternatively call
    //
    //      dunit.runTests_Progress();      for java style 
results output (SHOWS COLORS IF IN UNIX !!!)
    // or   dunit.runTests_Tree();          for a more verbose 
output
    //
    //from your main function.

    //mixin DUnitMain;
    void main() {dunit.runTests_Tree();}

} else {
    int main (string[] args) {
        writeln("production");
    }
}


/*

Run this file with (works in Windows/Linux):


    dmd exampleTests.d dunit.d
    ./exampleTests


The output will be (java style):


    ..F....F..
    There were 2 failures:
    1) 
test2(AbcTest)core.exception.AssertError@exampleTests.d(60): 
Expected: 'my string looks dazzling', but was: 'my dtring looks 
sazzling'
    2) 
test2(DerivedTest)core.exception.AssertError@exampleTests.d(60): 
Expected: 'my string looks dazzling', but was: 'my dtring looks 
sazzling'

    FAILURES!!!
    Tests run: 8,  Failures: 2,  Errors: 0


If you use the more verbose method dunit.runTests_Tree(), then 
the output is:


    Unit tests:
        AbcTest
            OK: test1()
            FAILED: test2(): 
core.exception.AssertError@exampleTests.d(60): Expected: 'my 
string looks dazzling', but was: 'my dtring looks sazzling'
            OK: testDefaultArguments()
            OK: test5()
        DerivedTest
            OK: test1()
            FAILED: test2(): 
core.exception.AssertError@exampleTests.d(60): Expected: 'my 
string looks dazzling', but was: 'my dtring looks sazzling'
            OK: testDefaultArguments()
            OK: test5()

HAVE FUN!

*/
February 19, 2012
Re: DUnit - class MyTest { mixin TestMixin; void testMethod1() {} void testMethod2() {}}
I forgot to mention. All of this works flawlessly with D2.057 and 
D2.058. But with previous versions, you might need to declare the:

       mixin TestMixin;

at the bottom of the class. Otherwise, the test* methods were not 
seen.


And excuse me for all the bad formatting in my post and all the 
excitement!

--jm
February 19, 2012
Re: DUnit - class MyTest { mixin TestMixin; void testMethod1() {} void testMethod2() {}}
On 2/19/12 9:30 AM, Juan Manuel Cabo wrote:
> People of the D world.. I give you DUnit (not to be confused with an old
> tango DUnit, this one is for >= D2.057, and doesn't really require
> phobos or tango (just you version the few writeln's of the runner, and
> maybe
> something else)).
>
> https://github.com/jmcabo/dunit

Interesting, congrats. A common question that will come up is comparing, 
contrasting, and integrating your work with the existing unittest 
language feature. You may want to address these issues directly in the 
documentation.


Thanks,

Andrei
February 19, 2012
Re: DUnit - class MyTest { mixin TestMixin; void testMethod1() {} void testMethod2() {}}
> Interesting, congrats. A common question that will come up is 
> comparing, contrasting, and integrating your work with the 
> existing unittest language feature. You may want to address 
> these issues directly in the documentation.

Thanks!! I'll put it in the doc (and also clean up my crude
documentation formatting). I plan to keep improving dunit too.


To answer quickly:

* The convenience couple of assertEquals() that I defined,
  do work by throwing core.exception.AssertError. This means that 
they
  can be used inside the classic unittest{} blocks, if you
  import dunit.

* The classic assert() statement can be used inside DUnit tests.

* One could run DUnit tests when passing -unittest to dmd.
  Just define once somewhere in your project:

     unittest {
         import dunit;
         dunit.runTests();
     }

   And all the classes in your project that are marked as DUnit 
tests
   with mixin TestMixin; will get run, no matter which module
   they are in.

* DUnit also shows exceptions which are not asserts. Those are
  displayed as 'Errors' instead of 'Failures' (as the java style).

* DUnit will not halt the execution of the program if a test 
fails.
  It will keep going with the next test. This is very useful when
  combined with:
     unittest {
         import dunit;
         dunit.runTests();
     }
  On the other hand, D's classic unittests would halt the 
execution
  at the first failure.

* D's classic unittest{} blocks are more straightforward and
  instantaneous to learn, and support a brief style of writing
  unit tests that DUnit is not meant for.

* DUnit provides a style of unit testing popularized in the OOP 
crowd
  which begun with sUnit by Kent Beck (smalltalk), later jUnit by 
Kent Beck
  and Erich Gamma (java), and then also NUnit for .NET (there 
also exists
  too FlexUnit for Flex, FireUnit for Javascript, CppUnit for C++ 
etc., but
  those deviate a little from the originals).
    So DUnit brings D to the familiy of languages that support 
certain
  testing idioms familiar to many OOP developers. (tests fixtures 
(grouped by
  classes), with common initialization, green bars ;-), decoupled 
test runners,
  convenience assert functions, etc.
  (I'm thinking of writing a quick DWT GUI test runner too

# (OFFTOPIC: I made a patched DWT that works in linux 64bits (by 
fixing
  a few bugs and commenting out some impossible XPCOM code
  and I'll try to sync to Jacob Carlborg's github repo
  when I have more time; and fixed missing 'double vars=0' inits 
instead of
  NaN that produced slowdowns and prevented certain drawing 
functions
  from working in the Graphics Context)).
  --jm



On Sunday, 19 February 2012 at 16:36:53 UTC, Andrei Alexandrescu 
wrote:
> On 2/19/12 9:30 AM, Juan Manuel Cabo wrote:
>> People of the D world.. I give you DUnit (not to be confused 
>> with an old
>> tango DUnit, this one is for >= D2.057, and doesn't really 
>> require
>> phobos or tango (just you version the few writeln's of the 
>> runner, and
>> maybe
>> something else)).
>>
>> https://github.com/jmcabo/dunit
>
> Interesting, congrats. A common question that will come up is 
> comparing, contrasting, and integrating your work with the 
> existing unittest language feature. You may want to address 
> these issues directly in the documentation.
>
>
> Thanks,
>
> Andrei
February 19, 2012
Re: DUnit - class MyTest { mixin TestMixin; void testMethod1() {} void testMethod2() {}}
On 2012-02-19 19:18, Juan Manuel Cabo wrote:
>
>> Interesting, congrats. A common question that will come up is
>> comparing, contrasting, and integrating your work with the existing
>> unittest language feature. You may want to address these issues
>> directly in the documentation.
>
> Thanks!! I'll put it in the doc (and also clean up my crude
> documentation formatting). I plan to keep improving dunit too.

You can can write the README file using markdown, github understands 
that format.

> * DUnit provides a style of unit testing popularized in the OOP crowd
> which begun with sUnit by Kent Beck (smalltalk), later jUnit by Kent Beck
> and Erich Gamma (java), and then also NUnit for .NET (there also exists
> too FlexUnit for Flex, FireUnit for Javascript, CppUnit for C++ etc., but
> those deviate a little from the originals).
> So DUnit brings D to the familiy of languages that support certain
> testing idioms familiar to many OOP developers. (tests fixtures (grouped by
> classes), with common initialization, green bars ;-), decoupled test
> runners,
> convenience assert functions, etc.
> (I'm thinking of writing a quick DWT GUI test runner too

Cool.

> # (OFFTOPIC: I made a patched DWT that works in linux 64bits (by fixing
> a few bugs and commenting out some impossible XPCOM code
> and I'll try to sync to Jacob Carlborg's github repo
> when I have more time; and fixed missing 'double vars=0' inits instead of
> NaN that produced slowdowns and prevented certain drawing functions
> from working in the Graphics Context)).
> --jm

Pull requests are welcome.

-- 
/Jacob Carlborg
February 20, 2012
Re: DUnit - class MyTest { mixin TestMixin; void testMethod1() {} void testMethod2() {}}
I thought I could do a better effort to describe why DUnit is so extraordinary,
for a native language, especially for those unfamiliar with xUnit frameworks
or TDD. So here it goes:


*What is a unit test*

Unit tests, ideally, test a specific functionality in isolation, so that
if the test fails, you can assume that it's because the functionality
under test, and only that functionality, is broken.

Testing a program or system is complex. This is not the only kind of test
that should be done on a system. But it's one kind of test that lets you
split the testing effort into less complex units, especially if your
system is in fact assembled from smaller units.

Unit testing frameworks provide mechanisms to isolate and setup the
program state after one test, so that when the next test begins,
you get a clean slate.
They also give you mechanisms to make it easier for you to reuse the
effort you put into setting the test environment for a test, because
in fact many tests will have the same setup. Those tests are then
made to be part of the same "TestCase".
A "TestCase" contains tests, and contains a setup method common
to all of them.



*What is an xUnit framework?*

It's a framework that allows you to write unit tests in a fashion that
goes well with TestDrivenDevelopment and TestFirstDesign.

It's also a kind of "meme" that got spread to most programming languages.
We owe the existance of this powerful meme to Kent Beck, and his SUnit framework.
Arguably, the most popular incarnation nowadays is JUnit
(https://en.wikipedia.org/wiki/JUnit).

This "meme" consists of at least the following elements:

  * TestCases as classes (with setup() and teardown() methods).

  * Tests as methods of TestCases.

  * Convenience assert functions.

  * A green progress bar that turns to red when one of the Tests fails.

  * Pluggable console or GUI "test runners".

So, the user writes a class... that contains methods... which in turn contain asserts.
The user then compiles the program or library and starts the "test runner", which
then runs all the tests. Some runners display the list of available TestCases, and
allow to pick which ones to run (or re-run):

   NUNIT: http://nunit.org/docs/2.5/img/gui-screenshot.jpg

   NUNIT CONSOLE: http://nunit.org/docs/2.6/img/console-mock.jpg

   JUNIT: http://www.eclipse.org/screenshots/images/JavaPerspective-WinXP.png
   (bottom part of the IDE screenshot)

   CPPUNIT: http://sourceforge.net/apps/mediawiki/cppunit/nfs/project/c/cp/cppunit/8/81/Mfctestrunner.png

   CPPUNIT CONSOLE: http://sourceforge.net/apps/mediawiki/cppunit/index.php?title=File:Cursetr_RunningTests.png

Note the presence of the tipical green progress bar (which turns red when
one test fails, giving fast feedback to the user, and acting as a reinforcement
when green. It only keeps the green when *all* tests pass (no failing asserts).


*But how does the 'test runner' know which methods are tests to run?*

Each programming language has its own best way of marking a class as a TestCase,
and of marking a method in it as a Test to be run.

  With JUnit3, one had to inherit the class from a specific base class.
A test runner would have to use Reflection to get the list of all
classes that were TestCases to present them to the user. And then use
reflection to search for and list the methods whose names start with "test".

  With JUnit4, the user now has to only mark methods with the @Test attribute.
Through reflection, test runners can find all the classes which contain
methods marked with the @Test attribute, and then call those methods.
This still has some overhead, (hopefully not on the order of methods of the program)
and we are talking about late-binding too.

  With C++, since there is absolutely no real reflection capability (like
getting all the names of the methods of a TestCase class). So one has to manually
register the test method using macros. So, each time that you add a
new test method, you have to type its name at least three times. The result
is not beautiful: cppunit.sourceforge.net/doc/lastest/money_example.html
(but it's efficient though).


*How does DUnit do it?*

In DUnit classes are marked as a TestCase by declaring a "mixin TestMixin"
once in any part of their body. You don't need to type the name of a method
more than once, or the name of the class more than once. The mixin gets
it all from the context in which it was instantiated (thanks to "typeof(this)").
It creates a static constructor for the class, with:

   . a compile time generated immutable list of the names of the Test methods
     of the class whose names begin with "test" and can be called without
     arguments.
     (thanks to __traits(allMembers,), __traits(compiles,) and recursive
     template declarations).

   . a compile time generated function with a switch-case statement that takes
     the name of a Test and calls it.
     (thanks to __traits(allMembers) and __traits(compiles,) and recursive
     template declarations).

   . and a compile time generated function that can instantiate an object of
     that class. (thanks to string mixins).

When the program starts, the static constructors of each of the TestCases
registers those constants and function pointers with the dunit module,
for the test runners to see.
You can of course enclose your TestCases with something like
   version(DUnit) {
       ...
   },
so that you can exclude them from compilation for a release version.

The end result is that "test runners" are very easy to write, and it is also
extremely fast to get the list of TestCase classes, and in turn the list
of the Tests methods and setUp, tearDown, setUpClass and teardDownClass methods.
Calling a test function is also a switch statement away, and there is a
switch-case function per TestCase, so the list of switch cases is small.
The Test method is called directly from the switch-case,
there is no late binding at that point, because the switch is statically
generated as a string mixin.


This provides test runners with all the flexibility, since the test runner
knows the tests by name, and may call them by name. This means
that a test runner can let the user select which tests to run.

All of this also means that unit test writers only have to type the bare
minimum, unlike in C++, to define a test:

-------------------------
Minimum example:
-------------------------
import dunit;

class ATestCase {
  mixin TestMixin;

  void testtOne() {
      assert(true);
  }
}

-------------------------
Example:
-------------------------
import dunit;

class ATestCase {
  mixin TestMixin;

  void setUpClass() {
  }
  void tearDownClass() {
  }
  void setUp() {
  }
  void tearDown() {
  }

  void testtOne() {
      assert(true);
  }
  void test2() {
      assertEquals("str", "s"~"t"~"r);
  }
}


--jm
March 17, 2012
Re: DUnit - class MyTest { mixin TestMixin; void testMethod1() {} void testMethod2() {}}
On Monday, 20 February 2012 at 01:49:04 UTC, Juan Manuel Cabo 
wrote:
> I thought I could do a better effort to describe why DUnit is 
> so extraordinary,
> for a native language, especially for those unfamiliar with 
> xUnit frameworks

This is great stuff, thanks !

Anyway, I'm not fond of your examples; so here is a silly one 
from me :

http://lanael.free.fr/summertest.d.html
March 18, 2012
Re: DUnit - class MyTest { mixin TestMixin; void testMethod1() {} void testMethod2() {}}
Oh and also, changing "version(linux)" with "version(Posix)" for 
the color output management would be great. ( I'm on FreeBSD and 
was wondering why I had no colors as advertised :} ).
March 21, 2012
Re: DUnit - class MyTest { mixin TestMixin; void testMethod1() {} void testMethod2() {}}
On Saturday, 17 March 2012 at 12:30:49 UTC, Marc P. Michel wrote:
> On Monday, 20 February 2012 at 01:49:04 UTC, Juan Manuel Cabo 
> wrote:
>> I thought I could do a better effort to describe why DUnit is 
>> so extraordinary,
>> for a native language, especially for those unfamiliar with 
>> xUnit frameworks
>
> This is great stuff, thanks !

You're welcome! I'm glad that you tried it!!

>
> Anyway, I'm not fond of your examples; so here is a silly one 
> from me :
>
> http://lanael.free.fr/summertest.d.html

It's nice and clear indeed. If you put a BOOST licence header
and your name in your 3 example files, I'll add it to github.

Yeah, the example.d is a bit rough because I wanted to show
all that you can do with dunit quickly in single file.

--jm
« First   ‹ Prev
1 2
Top | Discussion index | About this forum | D home