Monday, September 21, 2009

Unit Testing with jQuery using FireUnit & QUnit

Today’s screencast is the 5th in a series of developer Firefox Extensions. You can view my previous 3 short Screenr screencasts here…

    In addition to this post being part in a series of Firefox Extension screencasts, it is actually also the 3rd part of an old series looking through various JavaScript Unit Testing frameworks…
    The following short screencast will give a quick review of the FireUnit Firefox Firebug Add-on and also the QUnit Unit Testing framework for jQuery. In case you don’t want to watch the 4 minute screencast I thought I would go ahead and flush out the rest of this blog post with code, screenshots, and commentary.
      As a review, to exercise our Unit Testing frameworks we have been using a simple Pig Latin function as our testing subject.

    This code is not optimal and it will be refactored in a future post. So, please focus on the Unit Testing and not the actual Pig Latin function :)

    So, here is the Pig Latin converter function we will be using for our tests…

    function EnglishToPigLatin() {
        this.CONSONANTS = 'bcdfghjklmnpqrstvwxyz';
        this.VOWELS = 'aeiou';
        this.Translate = function(english, splitType) {
            var translated = '';    
            var words = english.split(/\s+/);
            for (var i = 0; i < words.length; ++i) {
                translated += this.TranslateWord(words[i]);
                if (i+1 < words.length) translated += ' ';
            return translated;
        this.TranslateWord = function(english) {
           /*const*/ var SYLLABLE = 'ay';
           var pigLatin = '';
           if (english != null && english.length > 0 && 
              (this.VOWELS.indexOf(english[0].toLowerCase()) > -1 || this.CONSONANTS.indexOf(english[0].toLowerCase()) > -1 )) {
              if (this.VOWELS.indexOf(english[0].toLowerCase()) > -1) {
                 pigLatin = english + SYLLABLE;
              } else {      
                 var preConsonants = '';
                 for (var i = 0; i < english.length; ++i) {
                    if (this.CONSONANTS.indexOf(english[i].toLowerCase()) > -1) {
                       preConsonants += english[i];
                       if (preConsonants.toLowerCase() == 'q' && i+1 < english.length && english[i+1].toLowerCase() == 'u') {
                          preConsonants += 'u';
                          i += 2;
                    } else {
                 pigLatin = english.substring(i) + preConsonants + SYLLABLE;
           return pigLatin;    

    First we are going to write a simple set of 20 FireUnit tests that can be ran inside Firefox’s Firebug using the FireUnit Add-on.

    <html xmlns="">
        <script type="text/javascript" src="PigLatinBad.js"></script>
        <script type="text/javascript">
            var englishToPigLatin = new EnglishToPigLatin();
            //Invalid Arguments
  , '', 'Passing Null Should Return Blank');
  ''), '', 'Passing Blank Should Return Blank');
  '1234567890'), '', 'Passing 1234567890 Should Return Blank');
  '~!@#$%^&*()_+'), '', 'Passing ~!@#$%^&*()_+ Should Return Blank');
            //Consonant Words
  'beast'), 'eastbay', 'Passing Beast Should Return Eastbay');
  'dough'), 'oughday', 'Passing Dough Should Return Oughday');
  'happy'), 'appyhay', 'Passing happy Should Return appyhay');
  'question'), 'estionquay', 'Passing question Should Return estionquay');
  'star'), 'arstay', 'Passing star Should Return arstay');
  'three'), 'eethray', 'Passing three Should Return eethray');
            //Vowel Words
  'apple'), 'appleay', 'apple Should Return appleay');
  'elijah'), 'elijahay', 'elijah Should Return elijahay');
  'igloo'), 'iglooay', 'igloo Should Return iglooay');
  'octopus'), 'octopusay', 'octopus Should Return octopusay');
  'umbrella'), 'umbrellaay', 'umbrella Should Return umbrellaay');
  'hello'), 'ellohay', "Passing 'hello' Should Return 'elloh'");
  'hello world'), 'ellohay orldway', "Passing 'hello world' Should Return 'elloh orldw'");
  'hello world!'), 'ellohay orld!way', "Passing 'hello world!' Should Return 'ellow orld!w'");
  'Hello World'), 'elloHay orldWay', "Passing 'Hello World' Should Return 'elloH orldW'");
  'Hello World!'), 'elloHay orld!Way', "Passing 'Hello World!' Should Return 'elloH orld!W'");
            // Wait for asynchronous operation.
            setTimeout(function() {
                // Finish test
            }, 1000);
    <body />

    If we run the webpage inside of Firefox, we don’t see anything from the browser window, but if we open Firebug and click the “Tests” tab, then we can see the output of the 20 tests.


    One of the other nice features of FireUnit is that its compare assertion will actually show the difference of the two values instead of just saying they are the same or not. Here is an example of the output from a failing compare…


    The output is pretty impressive, but what if you already have a lot of existing QUnit Unit Tests or what if you would also like to have some sort of User Interface to your test page. Well, the nice thing about FireUnit is that you can integrate it into QUnit! By adding several lines of code we can have the output of our QUnit tests render to the FireUnit Add-on as well!

    The following is a set of QUnit Unit Tests with 4 lines of code near the end that registers the output with FireUnit as well.

    <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "">
    <html xmlns="" xml:lang="ko">
        <meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
        <title>English To Pig Latin QUnit Tests</title>
        <link rel="stylesheet" href="" type="text/css" media="screen" />
        <script type="text/javascript" src=""></script>
        <script type="text/javascript" src=""></script>
        <script type="text/javascript" src="PigLatinBad.js"></script>
        <script type="text/javascript">
            $(document).ready(function() {
                module("Pig Latin");
                var englishToPigLatin = new EnglishToPigLatin();
                test('Invalid Arguments', function() {
                    equals(englishToPigLatin.TranslateWord(null), '', 'Passing Null Should Return Blank');
                    equals(englishToPigLatin.TranslateWord(''), '', 'Passing Blank Should Return Blank');
                    equals(englishToPigLatin.TranslateWord('1234567890'), '', 'Passing 1234567890 Should Return Blank');
                    equals(englishToPigLatin.TranslateWord('~!@#$%^&*()_+'), '', 'Passing ~!@#$%^&*()_+ Should Return Blank');
                test('Consonant Words', function() {
                    equals(englishToPigLatin.TranslateWord('beast'), 'eastbay', 'Passing Beast Should Return Eastbay');
                    equals(englishToPigLatin.TranslateWord('dough'), 'oughday', 'Passing Dough Should Return Oughday');
                    equals(englishToPigLatin.TranslateWord('happy'), 'appyhay', 'Passing happy Should Return appyhay');
                    equals(englishToPigLatin.TranslateWord('question'), 'estionquay', 'Passing question Should Return estionquay');
                    equals(englishToPigLatin.TranslateWord('star'), 'arstay', 'Passing star Should Return arstay');
                    equals(englishToPigLatin.TranslateWord('three'), 'eethray', 'Passing three Should Return eethray');
                test('Vowel Words', function() {
                    equals(englishToPigLatin.TranslateWord('apple'), 'appleay', 'apple Should Return appleay');
                    equals(englishToPigLatin.TranslateWord('elijah'), 'elijahay', 'elijah Should Return elijahay');
                    equals(englishToPigLatin.TranslateWord('igloo'), 'iglooay', 'igloo Should Return iglooay');
                    equals(englishToPigLatin.TranslateWord('octopus'), 'octopusay', 'octopus Should Return octopusay');
                    equals(englishToPigLatin.TranslateWord('umbrella'), 'umbrellaay', 'umbrella Should Return umbrellaay');
                test('Sentences', function() {
                    equals(englishToPigLatin.Translate('hello'), 'ellohay', "Passing 'hello' Should Return 'elloh'");
                    equals(englishToPigLatin.Translate('hello world'), 'ellohay orldway', "Passing 'hello world' Should Return 'elloh orldw'");
                    equals(englishToPigLatin.Translate('hello world!'), 'ellohay orld!way', "Passing 'hello world!' Should Return 'ellow orld!w'");
                    equals(englishToPigLatin.Translate('Hello World'), 'elloHay orldWay', "Passing 'Hello World' Should Return 'elloH orldW'");
                    equals(englishToPigLatin.Translate('Hello World!'), 'elloHay orld!Way', "Passing 'Hello World!' Should Return 'elloH orld!W'");
                if (typeof fireunit === "object") {
                    QUnit.log = fireunit.ok;
                    QUnit.done = fireunit.testDone;
        <h1>English To Pig Latin QUnit Tests</h1>
        <h2 id="banner"></h2>
        <h2 id="userAgent"></h2>
        <ol id="tests"></ol>
        <div id="main"></div>

    Now, not only do we have a User Interface on the webpage, but we also have the tests running in Firebug.

    For more information about FireUnit you can check out a post by Jonn Resig and it’s Wiki on GitHub. And if you are interested in QUnit, there is a nice overview on the jQuery webiste.

    No comments:

    Post a Comment