NST JavaScript Unit Testing - Revision history

Paul Blankenbaker: Another typo

2010-09-22T15:14:36Z

Another typo

← Older revision		Revision as of 11:14, 22 September 2010
Line 35:		Line 35:
	* You know how to use a web browser to load HTML pages directly from your file system.		* You know how to use a web browser to load HTML pages directly from your file system.
	* You know how to use a text editor to create and modify JavaScript code.		* You know how to use a text editor to create and modify JavaScript code.
	* You ~~have~~ know how to write JavaScript code and have a basic understanding of JavaScript objects (creating classes) and the JavaScript ''prototype'' keyword.		* You know how to write JavaScript code and have a basic understanding of JavaScript objects (creating classes) and the JavaScript ''prototype'' keyword.

	== Files/Directories ==		== Files/Directories ==

Paul Blankenbaker: Fixed typo

2010-09-22T15:13:54Z

Fixed typo

← Older revision		Revision as of 11:13, 22 September 2010
Line 30:		Line 30:
	== Skills ==		== Skills ==

	Before proceeding with unit testing, it is recommended that~~: you are familiar with~~:		Before proceeding with unit testing, it is recommended that:

	* You have a basic understanding of what unit testing means.		* You have a basic understanding of what unit testing means.

Paul Blankenbaker: /* Running The Unit Tests and Reviewing The Results */

2010-01-26T13:01:25Z

Running The Unit Tests and Reviewing The Results

← Older revision		Revision as of 09:01, 26 January 2010
Line 135:		Line 135:
	When you drill down, you'll notice that the test failed because it expected the ''basename'' of "/var/log/" to be "log" and that the actual implementation produced "".		When you drill down, you'll notice that the test failed because it expected the ''basename'' of "/var/log/" to be "log" and that the actual implementation produced "".

	This error was left in the example to demonstrate the power of using unit tests to help eliminate ambiguity from your code. If you look at the source for this unit test, you notice a comment that indicates that the unit test wasn't really sure what the results should be when passing "/var/log/" to the ''basename'' function. At this point we can proceed to reconcile the discrepency by either updating the ''basename'' function to return "log" in this case, or updating the unit test to expect "" ~~(we will need to decide~~ what is the ~~right decision)~~.		This error was left in the example to demonstrate the power of using unit tests to help eliminate ambiguity from your code. If you look at the source for this unit test, you notice a comment that indicates that the unit test wasn't really sure what the results should be when passing "/var/log/" to the ''basename'' function. At this point we can proceed to reconcile the discrepency by either updating the ''basename'' function to return "log" in this case, or updating the unit test to expect "". We are forced into thinking about what the correct behavior should be in this case.

Paul Blankenbaker: /* Updating The TestSuite.html File */

2010-01-26T12:58:50Z

Updating The TestSuite.html File

@@ Line 98: / Line 98: @@
 You will need to edit the ''TestSuite.html'' file you downloaded in the following manner:
-* Find "STEP 1" in ''TestSuite.html'' and add
+* Find "STEP 1" in ''TestSuite.html'' and update it to include your two new unit test classes. Change:
-* Remove the ''new TestUnitTest()'' entry in the test suite array (unless you want to leave this example unit test in your output).
-* You can also remove the inclusion of ''TestUnitTest.js'' and remove the ''TestUnitTest.js'' file.
+  var unitTests = [
 == Running The Unit Tests and Reviewing The Results ==

Paul Blankenbaker: /* Two JavaScript Source Files To Unit Test */

2010-01-26T12:47:26Z

Two JavaScript Source Files To Unit Test

← Older revision		Revision as of 08:47, 26 January 2010
Line 67:		Line 67:
	Our example ''basename'' implementation can be downloaded from:		Our example ''basename'' implementation can be downloaded from:

	[http://nst.svn.sourceforge.net/viewvc/nst/trunk/include/javascript/test/examples~~/test~~/basename.js ~~test/~~basename.js]		[http://nst.svn.sourceforge.net/viewvc/nst/trunk/include/javascript/test/examples/basename.js basename.js]

	=== dirname.js ===		=== dirname.js ===
Line 73:		Line 73:
	Our example ''dirname'' implementation can be downloaded from:		Our example ''dirname'' implementation can be downloaded from:

	[http://nst.svn.sourceforge.net/viewvc/nst/trunk/include/javascript/test/examples~~/test~~/dirname.js dirname.js]		[http://nst.svn.sourceforge.net/viewvc/nst/trunk/include/javascript/test/examples/dirname.js dirname.js]

	== Downloading and Installing JavaScript Unit Testing Support ==		== Downloading and Installing JavaScript Unit Testing Support ==

Paul Blankenbaker: /* Skills */

2010-01-26T12:44:26Z

Skills

← Older revision		Revision as of 08:44, 26 January 2010
Line 30:		Line 30:
	== Skills ==		== Skills ==

	Before proceeding with unit testing, it is recommended that you are familiar with:		Before proceeding with unit testing, it is recommended that: you are familiar with:

	* ~~Have~~ a basic understanding of what unit testing means.		* You have a basic understanding of what unit testing means.
	* ~~Using~~ a web browser to load HTML pages directly from your file system.		* You know how to use a web browser to load HTML pages directly from your file system.
	* ~~Using~~ a text editor to create and modify JavaScript code.		* You know how to use a text editor to create and modify JavaScript code.
	* ~~Have~~ a basic understanding of JavaScript objects (creating classes) and the JavaScript ''prototype'' keyword.		* You have know how to write JavaScript code and have a basic understanding of JavaScript objects (creating classes) and the JavaScript ''prototype'' keyword.

	== Files/Directories ==		== Files/Directories ==

Paul Blankenbaker: /* Goals of JavaScript Unit Tests */

2010-01-26T12:42:36Z

Goals of JavaScript Unit Tests

← Older revision		Revision as of 08:42, 26 January 2010
Line 18:		Line 18:
	* Verify that expected behaviors are supported by all supported browser environments.		* Verify that expected behaviors are supported by all supported browser environments.
	* Be simple to run (simply loading: [http://nst.svn.sourceforge.net/viewvc/nst/trunk/include/javascript/test/TestSuite.html TestSuite.html] into your browser runs all of the unit tests for the NST project).		* Be simple to run (simply loading: [http://nst.svn.sourceforge.net/viewvc/nst/trunk/include/javascript/test/TestSuite.html TestSuite.html] into your browser runs all of the unit tests for the NST project).
			* Be usable by anyone wanting to unit test JavaScript code.

	== What JavaScript Unit Tests Don't Do ==		== What JavaScript Unit Tests Don't Do ==

Paul Blankenbaker: /* Walk Through */

2010-01-26T12:40:48Z

Walk Through

@@ Line 53: / Line 53: @@
 = Walk Through =
 == Two JavaScript Source Files To Unit Test ==
 === basename.js ===
 === dirname.js ===

Paul Blankenbaker: /* Files/Directories */

2010-01-26T12:14:50Z

Files/Directories

← Older revision		Revision as of 08:14, 26 January 2010
Line 39:		Line 39:

	To add unit testing capabilities to a existing project, create a sub-directory named ''test'' and install the following files into it:		To add unit testing capabilities to a existing project, create a sub-directory named ''test'' and install the following files into it:

			; [http://nst.svn.sourceforge.net/viewvc/nst/trunk/include/javascript/test/UnitTest.js UnitTest.js]
			: This file implements the JavaScript unit testing framework. All test cases you create for your JavaScript code will extend themselves from this class.

			; [http://nst.svn.sourceforge.net/viewvc/nst/trunk/include/javascript/test/UnitTest.css UnitTest.css]
			: This file provides some style information for display the results of running the unit tests within a HTML page.

	; [http://nst.svn.sourceforge.net/viewvc/nst/trunk/include/javascript/test/TestSuiteTemplate.html TestSuiteTemplate.html]		; [http://nst.svn.sourceforge.net/viewvc/nst/trunk/include/javascript/test/TestSuiteTemplate.html TestSuiteTemplate.html]
	: This file can be saved as ''TestSuite.html''. It will become the file you load into your web browser when you want to run your unit tests.		: This file can be saved as ''TestSuite.html''. It will become the file you load into your web browser when you want to run your unit tests.

			; [http://nst.svn.sourceforge.net/viewvc/nst/trunk/include/javascript/test/TestUnitTest.js TestUnitTest.js]
			: This file provides an example set of unit tests (for a function in the UnitTest.js file). You won't need this file in the long run, but it is loaded and run by the default [http://nst.svn.sourceforge.net/viewvc/nst/trunk/include/javascript/test/TestSuiteTemplate.html TestSuiteTemplate.html] template file.

	= Walk Through =		= Walk Through =

Paul Blankenbaker: /* Goals of JavaScript Unit Tests */

2010-01-26T12:07:13Z

Goals of JavaScript Unit Tests

← Older revision		Revision as of 08:07, 26 January 2010
Line 17:		Line 17:
	* Verify expected behaviors of simple JavaScript functions and classes.		* Verify expected behaviors of simple JavaScript functions and classes.
	* Verify that expected behaviors are supported by all supported browser environments.		* Verify that expected behaviors are supported by all supported browser environments.
	* Be simple to run (simply loading: [http://nst.svn.sourceforge.net/viewvc/nst/trunk/include/javascript/test/TestSuite.html TestSuite.html] into your browser runs all of the unit tests for the NST project.		* Be simple to run (simply loading: [http://nst.svn.sourceforge.net/viewvc/nst/trunk/include/javascript/test/TestSuite.html TestSuite.html] into your browser runs all of the unit tests for the NST project).

	== What JavaScript Unit Tests Don't Do ==		== What JavaScript Unit Tests Don't Do ==