FlexUnit v.85 Documentation Glitches, and a Fix
March 7th, 2007
The current version of FlexUnit (.85) has some glitches in its documentation. There’s very little to start with – only two classes have significant ASDoc comments, with code examples, etc: TestCase and TestSuite.
Unfortunately, even this documentation doesn’t appear in the ASDocs because the ASDoc comments have been implemented incorrectly.
While there are a couple of articles explaining how to use FlexUnit they are pretty basic and nothing I’ve found explains how to use FlexUnit’s new asynchronous testing functionality, for example. The TestCase docs touch on this so, if you’re trying to figure this out, they’re important.
The solution? You can download my corrected version of the ASDocs here. I’ve included the entire docs set, but have only modified the formatting of the ASDoc comments in TestCase.as and TestSuite.as.
FlexUnit_0-85_ASDocs_Fixed.zip
Enjoy.
March 7th, 2007 at 5:58 pm
Good stuff. There is way to little documentation on this framework, and also some oddities in it’s architecture (which seem to originate in JUnit, of which FlexUnit is not only an implementation but a straight port). You can find my thoughts at http://blog.iconara.net/2007/02/06/flexunit/
Also, post this on the FlexUnit Google group: http://groups.google.com/group/as3flexunitlib I’m sure it will be appreciated.
April 10th, 2007 at 3:57 am
Hi Douglas,
I couldn’t agree more. I wrote the Adobe article you’ve linked to, and did so after encountering the same frustrations.
As a self-taught developer from a Flash background it’s perhaps of little surprise that I was completely new to Unit Testing, and I was expecting to find some help to get me started, but the only info I could find was that short post by Darron Schall. Since the article went live a few months ago, I’ve received emails expressing an interest in a follow up, but given my current knowledge I am unable to provide this.
You may also be interested in this post:
http://groups.google.com/group/as3flexunitlib/browse_thread/thread/917c2fc9847e2a1c/771230693ea09ef4#771230693ea09ef4
I personally found the Class names used in FlexUnit a little confusing. I even found that the article editors at Adobe couldn’t agree on some areas.
It seems that there are some unnecessary barriers-to-entry for Flash Platform developers wishing to unit test – mainly a lack of documentation, and I would like to help remedy this further if I can. I am more than willing to collaborate with anyone feeling the same way.
Thanks for the docs!! Much appreciated
June 20th, 2007 at 8:56 am
Thanks a lot for the documentation. Just starting with FlexUnit, so every documentation is very welcome!