asunit-users

[Asunit-users] Great tool, but where's the documentation?

[Kristopher S. <ksc...@re...>]

I've downloaded and installed ASUnit, but it seems that the
documentation available at the link below is inadequate for anyone who
hasn't used one of the other xUnit frameworks before. Is the expectation
that users should turn to the documentation of the *other* frameworks to
try and figure out how *this* implementation can be used? Or is there
some documentation out there that I'm missing? What I'm particularly
interested in are API docs that answer questions like, "what kind of
asserts are available?", "what does setup() do?", and "what does
tearDown() do?"

Thanks in advance for any resources you can point me to.

http://sourceforge.net/docman/?group_id=3D108947


Kris
=20
--=20
=20
Kristopher Schultz
Developer
=20
Resource Interactive
p: 614.410.2123
www.resource.com

Re: [Asunit-users] Great tool, but where's the documentation?

[Luke B. <lb...@gm...>]

Hey Kristopher,

Thanks very much for your feedback, we really appreciate getting
questions from the community so that we can better prioritize our
time!

The truth is that until this very week, most of the people
participating in AsUnit did seem to have experience with other xUnit
frameworks. So documentation has not been as high a priority as adding
features and bug fixing...

It seems you're the third or fourth person in the past week or two
that has been begging for more thorough documentation (or any at all
for that matter).

I agree wholeheartedly that it's high time for someone to get the
documentation together for this product. Unfortunately, (or
fortunately - depending on how you look at it) I am pretty swamped
with other paying work for the next couple of months...

I can't express how grateful we would be if someone out there would
contribute some time to documenting this product. This is an
open-source project and is provided to the community with the hope
that the community will help us by contributing. If you are one of the
people using AsUnit, and find it to be a useful tool, please
contribute by spending a few hours putting together some simple
documentation... Feel freel to let us know if you are considering
doing it, we will be happy to talk on the phone or email back and
forth with any answers or suggestions.

Kristopher, I appreciate that your questions are very specific, so
here are the answers to those question - if you have any more specific
questions, please let us know:

 - What does setUp and tearDown do?
The TestCase class (the superclass of all Test Cases) will iterate
over every method found in your subclass that begins with the string
"test". For each item found, it will execute setUp(), then the method,
and then tearDown(). This allows you to build (and then destroy) a
clean environment for each and every test method within setUp and
tearDown, then to operate on that environment in the test method. An
example of this functionality can be found in the default TestCase
template that is generated by the Create Class command.

 - What kind of asserts are available?
You can check the com.asunit.framework.Assert.as file and you will
find every assertion that is available, along with it's method
signature. Assertions should all have an optional string message
parameter as their first argument.

if you use PrimalScript, and the project builder that I published a
long time ago on my blog, you can actually get code hinting for all of
these methods as well as hinting for your own custom classes.
(http://lukebayes.blogspot.com/2004/09/i-had-this-problem.html)

I'm going to go out on a limb and assume that the ASDT in Eclipse
should provide this sort of functionality natively - but I'm not
positive about that.

Thanks,


Luke Bayes
www.asunit.com