Changes

Jump to: navigation, search

Unit Testing

1,735 bytes added, 20:49, 13 December 2006
What I have learned
== Project Contributor(s) ==
* [[User:Vpmirand|Vanessa Miranda]] (vanessa)** Helped to layout the test window.
* [[User:David.humphrey|Dave Humphrey]] (dave or humph)
** Connectted me to Mozilla test team and gave me great links.
* Rob Campbell
** Helped me to detail the requirements of unit testing framework
== Project Details ==
* Spent a whole day on trying to debug bookmark services in firefox API... no documentation..., so frustrating.
* ...
* Gave up debuggingbookmark services API, continued working on framework.
=== November 20, 2006 ===
=== December 06, 2006 ===
* Code documentationFinished core code of the framework.* Instruction Documenting code.* Writing instruction on how to write test cases by using this framework
=== December 07, 2006 ===
* Finished documentation of the framework
=== December 10, 2006 ===
* Updated the core code of the framework, cleaned debugging code.
* Optimized some functions.
{{clear}}
 
== Unit Testing Framework for Firefox ==
The files starting with is the core framework files.
* unittesting.js, holds the unit test cases that need to be tested.
* unittestingDisplay.js, is responsible for displaying message to UItesting window.
* unittestingLog.js, is responsible for logging message to the error console or log file.
* unittestingOverlay.js, is responsible for populating the GUI window.
* unittestingWindow.js, holds all the unit testing functions
* unittestingWindow.xul, is responsible for loading the framework and updating UI test window elements.
{{clear}}
==== Step 2. A Write a test suite holding variable called suite that holds all the your test cases. ====
The following is example of bookmarks test suite.
=== Customize Extension Menu Item Name ===
If users want to change the menu item namefor a specific test case, they can open file '''unittesting.dtd ''' under folder '''local'''.
[[image:extension02.png|600px]] <br />
And then they can change the first item to your test case name in the file unittesting.dtd.
[[image:extension03.png|600px]] <br />
=== Run the tests ===
After adding the test cases to the extension, the participant can install the extension by drag and drop the extension into Firefox, and they could then click on install to install the unit testing framework with your test cases.  Running test cases is also easy, user can click on '''Tools''' menu from Firefox, and you will see an extension called '''Unit Testing for [...]'''. [[image:extension01.png|602px]] <br />  Select the '''Unit Testing for [...]''', system will pop up the following screen in Firefoxtesting window. [[image:extension04.png|602px]] <br />  Now click on the run button on test window, the test result will be displayed on test window. [[image:extension07.png|602px]] <br />
[[image:extension01.png|600px]] <br />
Select Further more, user can run test cases as many times as they want, and the Unit Testing, system result will pop up the be populated on test window as followingwell.
[[image:extension04extension08.png|600px602px]] <br />
Users can also open the error console window to watch all testing logs. Here is the console window.{{clear}}
[[image:extension05=== Unit testing log ===Right now, this framework provides a detail log for test running. This will allow users to track the detail testing process and any error that encountered during the testing.png|601px]] <br />
Now click on In order to check the run error console, go to '''Tools''' menu in Firefox, and select '''Error Console'''. [[image:extension05.png|602px]] <br />  After push the '''Run''' button on test window. All logs , the testing process message will be displayed in console. [[image:extension06.png|602px]] <br />
[[image:extension06.png|601px]] <br />
Notice: The framework runs the setUp() first, which we can see the highlighting in the screen shot.
[[image:extension06-1.png|600px602px]] <br /> 
Notice: The framework runs the tearDown() when all the test cases are finished, which we can see the highlighting in the screen shot.
[[image:extension06-2.png|600px602px]] <br />
Unfortunately, the test windows cannot be displayed, because it hasn't been developed. [[image:extension07.png|601px]] <br />{{clear}}
=== What I have done ===
* Core code and structure of the framework as an extension, and make writing test case as easily as possible. It's similar as writing JUint test cases.
* Testing window layout
* Test result on testing window
* Displaying logs in the error console
* Instruction on how to write test cases by using this framework(readme.txt)
{{clear}}
* Better layout of testing window if you have innovative idea
* Write log into file for further analyzing by Mozilla
* Improve the structure of the framework and make it more easier for users if you could
{{clear}}
=== What I have learned ===
Based on my experice in open source developing, I had a lot of fun for doing it. Also I'd like to address some improtant comments when we I was working on the open source.
* It was very time-consuming. Confidence and patience are the key to success. : This project has no prototype or even any example; most of time I couldn't get help because very less people work on this; and different people will do a different way in unit testing. It took me a lot of time to do researching, trying, and debugging. It also needs a lot of patience; if one way doesn't work, you still need to keep working on it until find the solution. You can take a short break and a deep breath, but never give up.* Documentation. : Any code we wrote should be documentated. It's very important for you to check back and for the people who want to contrubute to it.This is really important in open source community. Because I couldn't find the documentation for the Bookmarks services, I cannot make the bookmark unit testing work.* You need to get help from the others, but don't wait. : I had sent email to ask help for my problems, and I never get response. Especially It's kind of wasting time. You need to move on, especially in open source community, we do need help from the others, but don't relay on them.
{{clear}}
1
edit

Navigation menu