Efficient JavaScript Unit Testing, March 2013

Efficient JavaScript Unit Testing
Hazem Saleh

09 March 2013

Developers Life without Unit testing.

What is unit testing? and why?

Current Complexities in testing JavaScript code.

Requirements of a good JavaScript unit testing tool.
O
U What is JsTestDriver.
T JsTestDriver Architecture & Configuration
L
I JsTestDriver Eclipse plugin.
N Writing a JavaScript TestCase.
E JsTestDriver common constructs.

Writing asynchronous JavaScript TestCase.

JsTestDriver Compatibility
Generating reports from test cases.

Developers Life without Unit testing

Complex integration between the system components.


Unmanaged number of new/regression defects especially when
the system complexity increases.

Low application quality.

Longer testing cycle.

fix test
test fix

fix test

test fix

fix test

test fix
fix test

What is unit testing and why?

A unit testing is a piece of code (usually a method) that
invokes another piece of code and later checks the correctness of
some assumptions

Unit testing helps in detecting BUGGY components in the early
stages of the project.

A test suite is a set of test cases, and a test case is a set of tests
which verifies the system components.

Good Unit Test Characteristics

Automated

Repeatable Fast

Easy to run. Incremental

Easy to understand

What is unit testing and why?

Integration is much simplified.

Defects are managed. Regression defects should not happen if the defect is
resolved by creating a new test case.

Test cases can be a good reference for system documentation.

Test cases can improve the system design and be the basis of code refactoring.

Application quality increases.

Testing cycle is reduced.

Current Complexities in testing JavaScript code

Slow

Requires a lot of time to test on all the browsers.

JavaScript code that runs on a specific browser does not necessarily
mean that it will work on other browsers.

Inflexible

Supporting a new browser means allocating a new budget for
testing the system again on this new browser and for the
new/regression defects fixes.

Good JavaScript Unit Testing Tool Requirements

JavaScript unit
testing tool

Can execute across all Fast Test case
the browsers over execution.
all the platforms.

Easy setup. Integration with IDEs.

Easy configuration. Integration with build
management tools.

What is JsTestDriver

One of the best Open source JavaScript testing tools.

Meets all of the previous requirements and more:

Supports all the browsers / all platforms. ✓

Easy setup and configuration. ✓

Fast Test case execution. ✓

Integration with IDEs and build management tools. ✓




O
Configuration.
L



JsTestDriver configuration

1 Run the test cases using the following command line


1 2 Download the jsTestDriver latest jars from

http://code.google.com/p/js-test-driver/downloads/list


Create the jsTestDriver.conf file (under the JS folder)
1 2 3 with the following initial content:

server: http://localhost:9876
load:
- js-src/*.js
- js-test/*.js


Start the server using the following command
1 2 3 4 line

java -jar JsTestDriver-1.3.2.jar
 Optional parameters
 [--port 9876]
 [--browser
“{PATH}firefox.exe","{PATH}iexplore.exe","{P
ATH}Safari.exe"]


Run the test cases using the following
1 2 3 4 5 command line

java -jar JsTestDriver-1.3.2.jar --tests all
.........
Total 9 tests (Passed: 9; Fails: 0; Errors: 0) (16.00 ms)
Firefox 9.0.1 Windows: Run 3 tests (Passed: 3; Fails: 0; Errors 0)
(3.00 ms)
Safari 534.52.7 Windows: Run 3 tests (Passed: 3; Fails: 0; Errors
0) (4.00 ms)
Microsoft Internet Explorer 7.0 Windows: Run 3 tests (Passed: 3;
Fails: 0; Errors 0) (16.00 ms)




O
L
JsTestDriver Eclipse plugin.
I



JsTestDriver Eclipse plugin

Instead of using command lines for starting the server and running the test
cases, you can directly use the jsTestDriver Eclipse plugin.

To install the JsTestDriver Eclipse plugin install the plugin from the following
URL : http://js-test-driver.googlecode.com/svn/update/

Writing a JavaScript TestCase

ApplicationUtilTest = TestCase("ApplicationUtilTest");

ApplicationUtilTest.prototype.setUp = function () {
/*:DOC += ...HTML fragment code goes here (single root) ...*/
};

ApplicationUtilTest.prototype.testMethod1 = function () {
… validate using the jsTestDriver constructs …
}

ApplicationUtilTest.prototype.testMethod2 = function () {
… validate using the jsTestDriver constructs …
}

...

JsTestDriver common constructs

fail("msg")

assertTrue("msg", actual)

assertFalse("msg", actual)

assertSame("msg", expected, actual)

assertNotSame("msg", expected, actual)

assertNull("msg", actual)

assertNotNull("msg", actual)

DEMO
Let’s write synchronous JS
Test cases …

Writing asynchronous JavaScript TestCase
AsyncTest = AsyncTestCase("AsynchronousTesting");

AsyncTest.prototype.setUp = function () {
/*:DOC += */
};
AsyncTest.prototype.testOperationOne = function(queue) {
queue.call('Step1', function(callbacks) {
var asyncObject = new AsyncObject ();

var successCallBack = callbacks.add(function(successData) {
// validate (successData) if possible ....
});

var failureCallBack = callbacks.addErrback('Error Message');

// call asynchronous API
asyncObject.operationOne(inputData,
successCallBack,
failureCallBack);
});
};

Writing asynchronous JavaScript TestCase
Every inline function provides a callbacks parameter for
testing the Ajax APIs. There are two types of
callbacks:
• Success callback: Represents the success path. It
MUST be called in order to pass the test.
• Error callback: Represents the error path. If it is
called, then the test fails.

The test runner does not move to the next queue until
the current queue executes all of its success callbacks. If
a specific success callback is not called for a specific
amount of time (30 seconds), the test fails.

DEMO
Let’s write Asynchronous JS
Test cases …




O
L





JsTestDriver is not only a JavaScript unit testing
framework BUT it is a test runner for many other
JavaScript unit testing frameworks.

JsTestDriver is compatibility with the following
JavaScript unit testing frameworks through adapters:
• Jasmine
• YUI Test
• QUnit


In order to run the previous unit testing frameworks
on the top of the JSTD test runner. You need to
configure the framework adapter and source before
the test files as follows:

server: http://localhost:9876

load:
- jasmine/lib/jasmine-1.1.0/jasmine.js
- jasmine/lib/adapter/JasmineAdapter.js
- js-src/Basics.js
- js-test/BasicsSpec.js

DEMO
Running Jasmine Test cases
on the top of JSTD

Generating reports from test cases

JSTD can generate code coverage files.

Code coverage describes how much the source code is tested.

Coverage Criteria:

Function coverage

statement coverage

Branch
coverage

JsTestDriver
can generate code coverage
for your JavaScript code using the
code coverage plugin.


Configuring the plugin:
Download the Add the coverage plugin declaration Specify the --
“coverage.jar”. to the configuration file: testOutput
plugin: <<output_folder>>
flag in the test
- name: "coverage" running command.
jar: "plugins/coverage.jar"
module:
"com.google.jstestdriver.coverage.C
overageModule"


Unfortunately JsTestDriver does not generate HTML reports directly,

JsTestDriver generates the test coverage files in LCOV
and XML formats.

You can generate the HTML test reports using the
LCOV visualizer tool:

http://ltp.sourceforge.net/coverage/lcov.php


The JsTestDriver LCOV file name is usually:

<config filename>-coverage.dat (jsTestDriver.conf-
coverage.dat)

To generate the report from the LCOV file using the
LCOV visualizer tool:

genhtml jsTestDriver.conf-coverage.dat

Conclusion

Testing JavaScript code is important for increasing the
application quality and for speeding up fixing defects and
minimizing the number of regression defects.

Good JavaScript tool should be configurable, easy to use,
and working with all the browsers.

JsTestDriver is one of the most powerful JavaScript unit
testing tools that can be used for testing both synchronous
and asynchronous JavaScript code on all the browsers.

Question of the session (Free book copy)

<script>
(function() {
var x = 10,
y = 20,
z = x+++y;
alert(x); //?
alert(y); //?
alert(z); //?
})();
</script> http://www.amazon.com/dp/1782160620/
JavaScript Unit Testing Book

Efficient JavaScript Unit Testing, March 2013

Contact me

Twitter: http://www.twitter.com/hazems
LinkedIn: http://eg.linkedin.com/in/hazemsaleh
Blog: http://www.technicaladvices.com
Email: hazems@apache.org

Efficient JavaScript Unit Testing, March 2013

More Related Content

What's hot (20)

Viewers also liked (7)

Similar to Efficient JavaScript Unit Testing, March 2013 (20)

More from Hazem Saleh (13)

Recently uploaded (20)

Efficient JavaScript Unit Testing, March 2013