[Shunit-commits] ShUnit README,NONE,1.1 shUnit,1.22,1.23

[lacton <la...@us...>]

Update of /cvsroot/shunit/ShUnit
In directory sc8-pr-cvs8.sourceforge.net:/tmp/cvs-serv14765

Modified Files:
	shUnit 
Added Files:
	README 
Log Message:
[refactor] Moved explanations to a README file, as described in http://en.tldp.org/HOWTO/Software-Release-Practice-HOWTO/distpractice.html


--- NEW FILE: README ---
   ===   ShUnit   ===

ShUnit is a xUnit-family testing framework for Bourne derived shells.

http://shunit.sourceforge.net/

ShUnit is meant to run on all Bourne derived shells, but it has been tested
mainly on bash 3.2, ksh93 and pdksh 5.2.  If you find a portability issue,
please open a bug on sourceforge.

Note that this is a very basic implementation of the Unit Framework: no Suites.

For more information about Unit Testing Frameworks:
see http://www.xprogramming.com.

Questions or request concerning shUnit:
see http://sourceforge.net/projects/shunit


Main Files
----------

shUnit				the ShUnit core
shUnitPlus		an optional extension to the core
shUnitTest		unit test for the ShUnit core, using ShUnit itself (!)


Install
-------

1. Uncompress the distribution somewhere convenient.
       E.g., /usr/local/bin/shunit.
2. Set a variable SHUNIT_HOME that points to the directory where ShUnit's
       files are. E.g., add 'export SHUNIT_HOME=/usr/local/bin/shunit'
       in ~/.bash_profile.
3. To make sure ShUnit works in your environment, you can call the shUnitTest
       script.  It should end with a 'No tests failed' message.
4. In your test script, write the following lines at the end:

. "$SHUNIT_HOME/shUnit"
shuStart


How to use shUnit
-----------------

See the shUnitTest file for a simple straightforward example of how to use the
shUnit Unit Test Framework.

What you need to do to create your own shUnit Tests:

1. Write a script.
2. In the 'main' of the script, the shUnit functions have to be
   sourced in ( . "$SHUNIT_HOME/shUnit")
3. In the 'main', call the shuStart function.
3. For each test function, create a function TestSomething that
      3.1. Executes whatever you wish to test
      3.2. Checks the result of what you've just tested
      3.3. Calls the shuAssert function to assert that the result is as expected
      3.4. You can put as many asserts as you wish in each testfunction.
4. Run your testscript

You can of course repeat step 3 as much as you like (many test functions).

If the test function auto-detection does not work in your environment, or if you
want test functions that do not start with 'Test', you need to add some more
steps.
a. Create an initialization function (e.g., Suite() {  } )
b. Register each test function by adding a line to this initialization function.
       This will look like: shuRegTest TestSomething
c. Call the shuStart function with the name of the initialization function as an
       argument (e.g., shuStart Suite)


News
----

What new in 1.4?

* Added automatic detection of test functions.  You no longer need to call
      shuRegTest for each test function.  Just call shuStart with no argument,
      and ShUnit will automatically register all functions that starts with
      'Test'.
* Fixed failure handling.  If a test function contained both successes and
      failures, it would fail or succeed depending on the assertions' positions
      in the test.  Now, ShUnit honors the xUnit convention that any assertion
      failure should make the whole test fail.


Happy testing!

Index: shUnit
===================================================================
RCS file: /cvsroot/shunit/ShUnit/shUnit,v
retrieving revision 1.22
retrieving revision 1.23
diff -C2 -d -r1.22 -r1.23
*** shUnit	19 Mar 2008 20:53:08 -0000	1.22
--- shUnit	19 Mar 2008 21:30:43 -0000	1.23
***************
*** 6,43 ****
  ################################################################################
  #
! # Note that this is a very basic implementation of the Unit Framework: no Suites
! # For more information about Unit Testing Frameworks: see http://www.xprogramming.com.
! #
! # Questions or request concerning shUnit:
! # see http://sourceforge.net/projects/shunit
! #
! # How to use shUnit
! # -----------------
! #
! # See the shUnitTest file for a simple straightforward example of how to
! # use the shUnit Unit Test Framework.
! #
! # What you need to do to create your own shUnit Tests:
! # 
! # 1. Write a script.
! # 2. In the 'main' of the script, the shUnit functions have to be
! #    sourced in ( . /wherever/the/shUnit/file/is/shUnit)
! # 3. Create a function in your test scripts that prepares the environment
! #    in which your test will be run
! # 4. Again in the 'main', call the shuStart function with the name of the initialization
! #    function as an argument, or no argument at all if all your test functions 
! #    begin with 'Test'.
! # 5. For each testfunction, perform these steps:
! #    5.1. Add a line to the initialization function to register the testfunction. This
! #         will look like: shuRegTest NameOfTestFunction. Skip this step if all 
! #         your test functions begin with 'Test'.
! #    5.2. Create a function NameOfTestFuction that
! #           5.2.1. executes whatever you wish to test
! #           5.2.2. Checks the result of what you've just tested
! #           5.2.3. Calls the shuAssert function to assert that the result is as expected
! #           5.2.4. You can put as many asserts as you wish in each testfunction.
! # 6. Run your testscript
! #
! # You can of course repeat step 5 as much as you like (many testfunctions).
  #
  
--- 6,10 ----
  ################################################################################
  #
! # Refer to the README file for basic explanations.
  #