diff options
author | Pjotr Prins | 2017-08-20 09:22:43 +0000 |
---|---|---|
committer | Pjotr Prins | 2017-08-20 09:22:43 +0000 |
commit | 2e76646998df0ca1b7d160329c0f3ac8cdda2fe0 (patch) | |
tree | 8a1ba0770e2344469c58290d4192db186d9439cb /contrib/shunit2-2.0.3 | |
parent | 7fc4e3c0a0d6e32ca6685647e107473f1d96c3e5 (diff) | |
download | pangemma-2e76646998df0ca1b7d160329c0f3ac8cdda2fe0.tar.gz |
Move shunit2 into ./contrib and add catch-1.8.7
Diffstat (limited to 'contrib/shunit2-2.0.3')
33 files changed, 3399 insertions, 0 deletions
diff --git a/contrib/shunit2-2.0.3/Makefile b/contrib/shunit2-2.0.3/Makefile new file mode 100644 index 0000000..effbcca --- /dev/null +++ b/contrib/shunit2-2.0.3/Makefile @@ -0,0 +1,89 @@ +# $Id$ + +PROG=shunit2 + +BIN_DIR=$(PWD)/bin +BUILD_DIR=$(PWD)/build +DIST_DIR=$(PWD)/dist +LIB_DIR=$(PWD)/lib +SHARE_DIR=$(PWD)/share +SRC_DIR=$(PWD)/src +TEST_DIR=$(PWD)/test +TMP_DIR=$(PWD)/tmp + +DOCBOOK_BUILD_DIR=$(BUILD_DIR)/docbook +DOCBOOK_SHARE_DIR=$(SHARE_DIR)/docbook + +DOCBOOK_SRC_DIR=$(SRC_DIR)/docbook +EXAMPLES_SRC_DIR=$(SRC_DIR)/examples +SHELL_SRC_DIR=$(SRC_DIR)/shell +TEST_SRC_DIR=$(SRC_DIR)/test + +HTML_XSL=$(SHARE_DIR)/docbook/tldp-xsl/21MAR2004/html/tldp-one-page.xsl + +all: build docs + +build: build-prep + cp -p $(SHELL_SRC_DIR)/$(PROG) $(BUILD_DIR) + +build-clean: + rm -fr $(BUILD_DIR) + +build-prep: + @mkdir -p $(BUILD_DIR) + +docs: docs-transform-shelldoc docs-transform-docbook + +docs-prep: + @mkdir -p $(DOCBOOK_BUILD_DIR) + @echo "Preparing documentation for parsing" + @isoDate=`date "+%Y-%m-%d"`; \ + find $(DOCBOOK_SRC_DIR) -name "*.xml" |\ + while read f; do \ + bn=`basename $$f`; \ + sed -e "s/@@ISO_DATE@@/$$isoDate/g" $$f >$(DOCBOOK_BUILD_DIR)/$$bn; \ + done + +docs-extract-shelldoc: docs-prep + @echo "Extracting the ShellDoc" + @$(BIN_DIR)/extractDocs.pl $(SHELL_SRC_DIR)/$(PROG) >$(BUILD_DIR)/$(PROG)_shelldoc.xml + +docs-transform-shelldoc: docs-prep docs-extract-shelldoc + @echo "Parsing the extracted ShellDoc" + @xsltproc $(SHARE_DIR)/resources/shelldoc.xslt $(BUILD_DIR)/$(PROG)_shelldoc.xml >$(DOCBOOK_BUILD_DIR)/functions.xml + +docs-transform-docbook: docs-docbook-prep docs-prep + @echo "Parsing the documentation with DocBook" + @xsltproc $(HTML_XSL) $(DOCBOOK_BUILD_DIR)/$(PROG).xml >$(BUILD_DIR)/$(PROG).html + +docs-docbook-prep: + @if [ ! -d "$(DOCBOOK_SHARE_DIR)/docbook-xml" \ + -o ! -d "$(DOCBOOK_SHARE_DIR)/docbook-xsl" ]; \ + then \ + echo "Preparing DocBook structure"; \ + $(BIN_DIR)/docbookPrep.sh "$(DOCBOOK_SHARE_DIR)"; \ + fi + +test: test-prep + @echo "executing $(PROG) unit tests" + ( cd $(TEST_DIR); $(TEST_SRC_DIR)/run-test-suite ) + +test-clean: + rm -fr $(TEST_DIR) + +test-prep: build test-clean + @mkdir -p $(TEST_DIR) + cp -p $(TEST_SRC_DIR)/test* $(TEST_DIR) + cp -p $(TEST_SRC_DIR)/run-test-suite $(TEST_DIR) + cp -p $(BUILD_DIR)/$(PROG) $(TEST_DIR) + +dist: dist-clean build docs + @mkdir $(DIST_DIR) + cp -p $(BUILD_DIR)/$(PROG) $(DIST_DIR) + cp -p $(BUILD_DIR)/$(PROG).html $(DIST_DIR) + +clean: build-clean test-clean + rm -fr $(TMP_DIR) + +dist-clean: clean + rm -fr $(DIST_DIR) diff --git a/contrib/shunit2-2.0.3/bin/docbookPrep.sh b/contrib/shunit2-2.0.3/bin/docbookPrep.sh new file mode 100755 index 0000000..eb7c270 --- /dev/null +++ b/contrib/shunit2-2.0.3/bin/docbookPrep.sh @@ -0,0 +1,97 @@ +#! /bin/sh +# $Id$ + +XML_VERSION='4.4' +XML_FILE="docbook-xml-${XML_VERSION}" +XML_URL="http://www.docbook.org/xml/${XML_VERSION}/${XML_FILE}.zip" + +XSL_VERSION='1.72.0' +XSL_FILE="docbook-xsl-${XSL_VERSION}" +XSL_URL="http://downloads.sourceforge.net/docbook/${XSL_FILE}.tar.bz2" + +#----------------------------------------------------------------------------- +# do no edit below here +#----------------------------------------------------------------------------- + +PATH="${PATH}:${MY_DIR}" +PWD=${PWD:-`pwd`} + +MY_BASE=`basename "$0"` +MY_DIR=`dirname "$0"` + +# load shlib +. "${MY_DIR}/../lib/sh/shlib" + +BASE_DIR=`shlib_relToAbsPath "${MY_DIR}/.."` +DL_DIR="${BASE_DIR}/tmp" +DOCBOOK_DIR="${BASE_DIR}/share/docbook" + +CURL_OPTS='-C - -Os' +WGET_OPTS='-cq' + +METHOD_NONE=0 +METHOD_WGET=1 +METHOD_CURL=2 + +get_url() +{ + url=$1 + case ${method} in + ${METHOD_CURL}) ${curl} ${CURL_OPTS} "${url}" ;; + ${METHOD_WGET}) ${wget} ${WGET_OPTS} "${url}" ;; + esac +} + +# determine method +method=${METHOD_NONE} +wget=`which wget` +[ $? -eq 0 ] && method=${METHOD_WGET} +curl=`which curl` +[ $? -eq 0 -a ${method} -eq ${METHOD_NONE} ] && method=${METHOD_CURL} +if [ ${method} -eq ${METHOD_NONE} ]; then + echo "unable to locate wget or curl. cannot continue" + exit 1 +fi + +# create download dir +mkdir -p "${DL_DIR}" + +# get the docbook xml files +echo 'Docbook XML' +echo ' downloading' +cd ${DL_DIR} +get_url "${XML_URL}" +if [ -f "${DL_DIR}/${XML_FILE}.zip" ]; then + echo ' extracting' + xml_dir="${DOCBOOK_DIR}/docbook-xml/${XML_VERSION}" + rm -fr "${xml_dir}" + mkdir -p "${xml_dir}" + cd "${xml_dir}" + unzip -oq "${DL_DIR}/${XML_FILE}.zip" + cd .. + rm -f current + ln -s "${XML_VERSION}" current +else + echo "error: unable to extract (${XML_FILE}.zip)" >&2 + exit 1 +fi + +# get the docbook xslt files +echo 'Docbook XSLT' +echo ' downloading' +cd ${DL_DIR} +get_url "${XSL_URL}" +if [ -f "${DL_DIR}/${XSL_FILE}.tar.bz2" ]; then + echo ' extracting' + xsl_dir="${DOCBOOK_DIR}/docbook-xsl" + mkdir -p "${xsl_dir}" + cd "${xsl_dir}" + rm -fr ${XSL_VERSION} + bzip2 -dc "${DL_DIR}/${XSL_FILE}.tar.bz2" |tar xf - + mv ${XSL_FILE} ${XSL_VERSION} + rm -f current + ln -s "${XSL_VERSION}" current +else + echo "error: unable to extract (${XSL_FILE}.tar.bz2)" >&2 + exit 1 +fi diff --git a/contrib/shunit2-2.0.3/bin/extractDocs.pl b/contrib/shunit2-2.0.3/bin/extractDocs.pl new file mode 100755 index 0000000..a803526 --- /dev/null +++ b/contrib/shunit2-2.0.3/bin/extractDocs.pl @@ -0,0 +1,40 @@ +#! /usr/bin/perl +# $Id$ + +if(@ARGV != 1) { + print "usage: $0 sourceFile\n"; + exit; +} + +$sourceFile = $ARGV[0]; + +# +# read in the source file +# +$rslt = open(FILE, $sourceFile) + || die "could not open file ($sourceFile)"; + +$inComment = 0; +while(<FILE>) { + next if /^[^#]/; + s/^# //; + s/^#//; + + if(/^\/\*\*/) { + $inComment = 1; + next; + } + if(/\*\/$/) { + $inComment = 0; + next; + } + + if ($inComment == 1) { print $_ }; + if ($inComment == 0 && /\/\/\*/) { + @line = split /\/\/\*/, $_, 2; + $line[1] =~ s/^ //; + print $line[1]; + } +} + +close(FILE); diff --git a/contrib/shunit2-2.0.3/bin/which b/contrib/shunit2-2.0.3/bin/which new file mode 100755 index 0000000..9d7cc9f --- /dev/null +++ b/contrib/shunit2-2.0.3/bin/which @@ -0,0 +1,36 @@ +#! /bin/sh +# $Id$ +# +# This is a simple implementation of the 'which' command for those OSes that +# don't have one. +# + +true; TRUE=$? +false; FALSE=$? + +showAll=${FALSE} + +# process command line flags +while getopts 'a' opt; do + case ${opt} in + a) showAll=${TRUE} + esac +done +shift `expr ${OPTIND} - 1` + +# exit if no arguments were given +[ $# -eq 0 ] && exit 1 + +command=$1 + +# search for command +out=`echo "${PATH}" |sed "s/:/\n/g" |\ +while read path; do + fullPath="${path}/${command}" + if [ -x "${fullPath}" ]; then + echo "${fullPath}" + [ ${showAll} -eq ${FALSE} ] && break + fi +done` +[ -z "${out}" ] && exit 1 +echo "${out}" diff --git a/contrib/shunit2-2.0.3/doc/CHANGES-2.0.txt b/contrib/shunit2-2.0.3/doc/CHANGES-2.0.txt new file mode 100644 index 0000000..97ea3db --- /dev/null +++ b/contrib/shunit2-2.0.3/doc/CHANGES-2.0.txt @@ -0,0 +1,68 @@ +CHANGES WITH 2.0.4 + +Unset additional variables that were missed. + +Fixed off-by-one in exit value for scripts caught by the trap handler. + +The library did not fail gracefully when the 'od' command was not installed. + + +CHANGES WITH 2.0.3 + +Back ported the Makefile from 2.1.1pre that included changes to the +docs-docbook-prep target. + +Changed the test in assertFalse() so that any non-zero value registers as +false. (Credits to Bryan Larsen) + +Updated the testPartyLikeItIs1999() function in the Quick Start documentation. +The 'expected' and 'actual' values were swapped. (Credits to Richard Jensen) + +It was pointed out that the simple 'failed' message for a failed assert was not +only insufficient, it was nonstandard (when compared to JUnit) and didn't +provide the user with an expected vs actual result. The code was revised +somewhat to bring closer into alignment with JUnit (v4.3.1 specifically) so +that it feels more "normal". (Credits to Richard Jensen) + +As part of the JUnit realignment, it was noticed that fail*() functions in +JUnit don't actually do any comparisons themselves. They only generate a +failure message. Updated the code to match. + +Added self-testing unit tests. Kinda horkey, but they did find bugs during the +JUnit realignment. + +Fixed the code for returning from asserts as the return was being called before +the unsetting of variables occurred. (Credits to Mathias Goldau) + +The assert(True|False)() functions now accept an integer value for a +conditional test. A value of '0' is considered 'true', while any non-zero value +is considered 'false'. + +All public functions now fill use default values to work properly with the '-x' +shell debugging flag. + +Fixed the method of percent calculation for the report to get achieve better +accuracy. + + +CHANGES WITH 2.0.2 + +Fixed problem with fail(). The failure message was not properly printed. + +Reworked the Makefile so that the DocBook XML and XSLT files are properly +downloaded before parsing can continue. + + +CHANGES WITH 2.0.1 + +Fixed some really stupid mistakes with the fail* functions. They were doing the +exact opposite of what they were supposed to be doing. + + +CHANGES WITH 2.0.0 + +Made the first stand-alone release! + + +$Revision$ +vim:spell diff --git a/contrib/shunit2-2.0.3/doc/LGPL-2.1 b/contrib/shunit2-2.0.3/doc/LGPL-2.1 new file mode 100644 index 0000000..b1e3f5a --- /dev/null +++ b/contrib/shunit2-2.0.3/doc/LGPL-2.1 @@ -0,0 +1,504 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + <one line to give the library's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random Hacker. + + <signature of Ty Coon>, 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! + + diff --git a/contrib/shunit2-2.0.3/doc/README.txt b/contrib/shunit2-2.0.3/doc/README.txt new file mode 100644 index 0000000..538f4f4 --- /dev/null +++ b/contrib/shunit2-2.0.3/doc/README.txt @@ -0,0 +1,153 @@ +#------------------------------------------------------------------------------ +# SourceForge +# + +This project is stored on SourceForge as http://sf.net/projects/shunit2. The +source code can be accessed using the following information. + +* Subversion +$ svn co https://shunit2.svn.sourceforge.net/svnroot/shunit2/trunk/source shunit2 + +Subversion may also be browsed via a web browser at +http://svn.sourceforge.net/shunit2 + +#------------------------------------------------------------------------------ +# Making a release +# + +For these steps, it is assumed we are working with release 2.0.0. + +Steps: +* write release notes +* update version +* finish changelog +* check all the code in +* tag the release +* export the release +* create tarball +* md5sum the tarball and sign with gpg +* update website +* post to SourceForge and Freshmeat + +WRITE RELEASE NOTES + +This should be pretty self explainatory. Use one of the release notes from a +previous release as an example. + +To get the versions of the various shells, do the following: +Cygwin + bash: $ bash --version + ksh: actually pdksh + pdksh: look in the downloaded Cygwin directory +Linux + bash: $ bash --version + dash: look at installed version + ksh: $ ksh --version + pdksh: $ strings /bin/pdksh |grep 'PD KSH' + zsh: $ zsh --version +Solaris 10 + sh: not possible + bash: $ bash --version + ksh: $ strings /usr/bin/ksh |grep 'Version' + +UPDATE VERSION + +Edit the shunit2 source code, and change the version number in the comment, as +well as in the __SHUNIT_VERSION variable. Next, edit the +src/docbook/shunit2.xml file, edit the version in the <title> element, and make +sure there is a revision section for this release. + +FINISH DOCUMENTATION + +Make sure that any remaning changes get put into the CHANGES-X.X.txt file. + +Finish writing the RELEASE_NOTES-X.X.X.txt. Once it is finished, run it through +the 'fmt' command to make it pretty. + +$ fmt -w 80 RELEASE_NOTES-2.0.0.txt >RELEASE_NOTES-2.0.0.txt.new +$ mv RELEASE_NOTES-2.0.0.txt.new RELEASE_NOTES-2.0.0.txt + +We want to have an up-to-date version of the documentation in the release, so +we'd better build it. + +$ pwd +.../shunit2/source/2.0 +$ make docs +... +$ cp -p build/shunit2.html doc +$ svn ci -m "" doc/shunit2.html + +CHECK IN ALL THE CODE + +This step is pretty self-explainatory + +TAG THE RELEASE + +$ pwd +.../shunit2/source +$ ls +2.0 2.1 +$ svn cp -m "Release 2.0.0" \ +2.0 https://shunit2.svn.sourceforge.net/svnroot/shunit2/tags/source/2.0.0 + +EXPORT THE RELEASE + +$ pwd +.../shunit2/builds +$ svn export \ +https://shunit2.svn.sourceforge.net/svnroot/shunit2/tags/source/2.0.0 \ +shunit2-2.0.0 + +CREATE TARBALL + +$ tar cfz ../releases/shunit2-2.0.0.tgz shunit2-2.0.0 + +MD5SUM THE TARBALL AND SIGN WITH GPG + +$ cd ../releases +$ md5sum shunit2-2.0.0.tgz >shunit2-2.0.0.tgz.md5 +$ gpg --default-key kate.ward@forestent.com --detach-sign shunit2-2.0.0.tgz + +UPDATE WEBSITE + +Again, pretty self-explainatory. Make sure to copy the MD5 and GPG signature +files. Once that is done, make sure to tag the website so we can go back in +time if needed. + +$ pwd +.../shunit2 +$ ls +source website +$ svn cp -m "Release 2.0.0" \ +website https://shunit2.svn.sourceforge.net/svnroot/shunit2/tags/website/20060916 + +Now, update the website. It too is held in Subversion, so ssh into SourceForge +and use 'svn up' to grab the latest version. + +POST TO SOURCEFORGE AND FRESHMEAT + +http://sourceforge.net/projects/shunit2/ +http://freshmeat.net/ + +#------------------------------------------------------------------------------ +# Related documentation +# + +Docbook XML + docbook-xml-4.4.zip + http://www.docbook.org/xml/4.4/docbook-xml-4.4.zip + http://www.oasis-open.org/docbook/xml/4.4/docbook-xml-4.4.zip + docbook-xml-4.5.zip + http://www.docbook.org/xml/4.5/docbook-xml-4.5.zip + +Docbook XSL + docbook-xsl-1.71.0.tar.bz2 + http://prdownloads.sourceforge.net/docbook/docbook-xsl-1.71.0.tar.bz2?download + docbook-xsl-1.71.1.tar.bz2 + http://downloads.sourceforge.net/docbook/docbook-xsl-1.71.1.tar.bz2?use_mirror=puzzle + +JUnit + http://www.junit.org + + +$Revision$ diff --git a/contrib/shunit2-2.0.3/doc/RELEASE_NOTES-2.0.0.txt b/contrib/shunit2-2.0.3/doc/RELEASE_NOTES-2.0.0.txt new file mode 100644 index 0000000..947eea9 --- /dev/null +++ b/contrib/shunit2-2.0.3/doc/RELEASE_NOTES-2.0.0.txt @@ -0,0 +1,71 @@ +RELEASE NOTES FOR 2.0.0 + +This is the initial release of shunit2. It was originally included in log4sh +1.3.5 [http://log4sh.sourceforge.net/] as a unit testing framework for that +product. It has since grown table enough to warrant being released into the +wild on its own. + + +TESTED PLATFORMS + +This list of platforms comes from the latest version of log4sh as shunit2 is +used in the testing of log4sh on each of these platforms. + +Cygwin ++ bash 3.2.9(10) ++ pdksh 5.2.14 + +Linux ++ bash 3.1.17(1) ++ dash 0.5.3 ++ ksh 1993-12-28 ++ pdksh 5.2.14 ++ zsh 4.3.2 (does not work) + +Mac OS X 1.4.8 (Darwin 8.8) ++ bash 2.05b.0(1) ++ ksh 1993-12-28 + +Solaris 8 U3 (x86) ++ /bin/sh ++ bash 2.03.0(1) ++ ksh M-11/16/88i + +Solaris 10 U2 (sparc) ++ /bin/sh ++ bash 3.00.16(1) ++ ksh M-11/16/88i + +Solaris 10 U2 (x86) ++ /bin/sh ++ bash 3.00.16(1) ++ ksh M-11/16/88i + + +NEW FEATURES + +None. + + +CHANGES AND ENHANCEMENTS + +None. + + +BUG FIXES + +None. + + +DEPRECATED FEATURES + +None. + + +KNOWN BUGS AND ISSUES + +None. + + +$Revision$ +vim:spell diff --git a/contrib/shunit2-2.0.3/doc/RELEASE_NOTES-2.0.1.txt b/contrib/shunit2-2.0.3/doc/RELEASE_NOTES-2.0.1.txt new file mode 100644 index 0000000..110a37a --- /dev/null +++ b/contrib/shunit2-2.0.3/doc/RELEASE_NOTES-2.0.1.txt @@ -0,0 +1,73 @@ +RELEASE NOTES FOR 2.0.1 + +This release is mostly a brown-bag release. Not so nice for the second release +ever of the product, but that's what I get for trying to get something out +there that I hadn't fully looked through one last time. + + +TESTED PLATFORMS + +This list of platforms comes from the latest version of log4sh as shunit2 is +used in the testing of log4sh on each of these platforms. + +Cygwin ++ bash 3.2.9(10) ++ pdksh 5.2.14 + +Linux ++ bash 3.1.17(1) ++ dash 0.5.3 ++ ksh 1993-12-28 ++ pdksh 5.2.14 ++ zsh 4.3.2 (does not work) + +Mac OS X 1.4.8 (Darwin 8.8) ++ bash 2.05b.0(1) ++ ksh 1993-12-28 + +Solaris 8 U3 (x86) ++ /bin/sh ++ bash 2.03.0(1) ++ ksh M-11/16/88i + +Solaris 10 U2 (sparc) ++ /bin/sh ++ bash 3.00.16(1) ++ ksh M-11/16/88i + +Solaris 10 U2 (x86) ++ /bin/sh ++ bash 3.00.16(1) ++ ksh M-11/16/88i + + +NEW FEATURES + +None. + + +CHANGES AND ENHANCEMENTS + +The documentation regarding the assertTrue() and assertFalse() functions was +updated to reflect their proper usage. They are shell test condition evaluators +(e.g. "[1 -eq 2]") rather than simple 0/1 comparators. + + +BUG FIXES + +The fail*() functions were doing the exact opposite of what they were supposed +to be doing. They have been fixed. + + +DEPRECATED FEATURES + +None. + + +KNOWN BUGS AND ISSUES + +None. + + +$Revision$ +vim:spell diff --git a/contrib/shunit2-2.0.3/doc/RELEASE_NOTES-2.0.2.txt b/contrib/shunit2-2.0.3/doc/RELEASE_NOTES-2.0.2.txt new file mode 100644 index 0000000..e7bcad6 --- /dev/null +++ b/contrib/shunit2-2.0.3/doc/RELEASE_NOTES-2.0.2.txt @@ -0,0 +1,71 @@ +RELEASE NOTES FOR 2.0.2 + +This is solely a bug-fix release. + + +TESTED PLATFORMS + +This list of platforms comes from the latest version of log4sh as shUnit2 is +used in the testing of log4sh on each of these platforms. + +Cygwin ++ bash 3.2.9(10) ++ pdksh 5.2.14 + +Linux ++ bash 3.1.17(1) ++ dash 0.5.3 ++ ksh 1993-12-28 ++ pdksh 5.2.14 ++ zsh 4.3.2 (does not work) + +Mac OS X 1.4.8 (Darwin 8.8) ++ bash 2.05b.0(1) ++ ksh 1993-12-28 + +Solaris 8 U3 (x86) ++ /bin/sh ++ bash 2.03.0(1) ++ ksh M-11/16/88i + +Solaris 10 U2 (sparc) ++ /bin/sh ++ bash 3.00.16(1) ++ ksh M-11/16/88i + +Solaris 10 U2 (x86) ++ /bin/sh ++ bash 3.00.16(1) ++ ksh M-11/16/88i + + +NEW FEATURES + +None. + + +CHANGES AND ENHANCEMENTS + +None. + + +BUG FIXES + +The fail() function did not output the optional failure message. + +Fixed the Makefile so that the DocBook XML and XSLT files would be downloaded +before parsing can continue. + + +DEPRECATED FEATURES + +None. + + +KNOWN BUGS AND ISSUES + +None. + + +$Revision$ +vim:spell diff --git a/contrib/shunit2-2.0.3/doc/RELEASE_NOTES-2.0.3.txt b/contrib/shunit2-2.0.3/doc/RELEASE_NOTES-2.0.3.txt new file mode 100644 index 0000000..7e12684 --- /dev/null +++ b/contrib/shunit2-2.0.3/doc/RELEASE_NOTES-2.0.3.txt @@ -0,0 +1,60 @@ +RELEASE NOTES FOR 2.0.3 + +This release incorporates a realignment with the JUnit 4 code. Asserts now +provide better failure messages, and the failure functions no longer perform +tests. + +See the CHANGES-2.0.txt file for a full list of changes. + + +TESTED PLATFORMS + +This list of platforms comes from the latest version of log4sh as shUnit2 is +used in the testing of log4sh on each of these platforms. + +Cygwin -- untested + +Linux +- bash 3.2.13(1) +- dash 0.5.3 +- ksh 1993-12-28 +- pdksh 5.2.14 + +Mac OS X -- untested +Solaris 8 -- untested +Solaris 10 -- untested + + +NEW FEATURES + +None. + + +CHANGES AND ENHANCEMENTS + +The internal test in assertFalse() was changed so that any non-zero value is +considered false, rather than any only values equal to 1. + +The assertTrue() and assertFalse() functions now accept an integer value for a +conditional test. A value of '0' is considered 'true', while any non-zero value +is considered 'false'. + +Self-testing unit tests were added. + + +BUG FIXES + +All asserts now properly unset their variables. + + +DEPRECATED FEATURES + +None. + + +KNOWN BUGS AND ISSUES + +Functions do not properly test for an invalid number of arguments. + + +vim:spell diff --git a/contrib/shunit2-2.0.3/doc/RELEASE_NOTES-2.0.4.txt b/contrib/shunit2-2.0.3/doc/RELEASE_NOTES-2.0.4.txt new file mode 100644 index 0000000..64fb417 --- /dev/null +++ b/contrib/shunit2-2.0.3/doc/RELEASE_NOTES-2.0.4.txt @@ -0,0 +1,51 @@ +RELEASE NOTES FOR 2.0.4 + +This is a minor bugfix release. + +See the CHANGES-2.0.txt file for a full list of changes. + + +TESTED PLATFORMS + +This list of platforms comes from the latest version of log4sh as shUnit2 is +used in the testing of log4sh on each of these platforms. + +Cygwin -- untested + +Linux +- bash 3.2.13(1) +- dash 0.5.3 +- ksh 1993-12-28 +- pdksh 5.2.14 + +Mac OS X -- untested +Solaris 8 -- untested +Solaris 10 -- untested + + +NEW FEATURES + +None. + + +CHANGES AND ENHANCEMENTS + +None. + + +BUG FIXES + +The library no longer fails when the 'od' command is not present. + + +DEPRECATED FEATURES + +None. + + +KNOWN BUGS AND ISSUES + +Functions do not properly test for an invalid number of arguments. + + +vim:spell diff --git a/contrib/shunit2-2.0.3/doc/TODO.txt b/contrib/shunit2-2.0.3/doc/TODO.txt new file mode 100644 index 0000000..7fd6314 --- /dev/null +++ b/contrib/shunit2-2.0.3/doc/TODO.txt @@ -0,0 +1,5 @@ +Make it possible to execute a single test by passing the name of the test on +the command line + + +$Revision$ diff --git a/contrib/shunit2-2.0.3/doc/contributors.txt b/contrib/shunit2-2.0.3/doc/contributors.txt new file mode 100644 index 0000000..69da654 --- /dev/null +++ b/contrib/shunit2-2.0.3/doc/contributors.txt @@ -0,0 +1,10 @@ +The original author of shunit2 is Kate Ward. The following people have +contributed in some way or another to shunit2. + +Bryan Larsen +Kevin Van Horn +Mathias Goldau +Richard Jensen +Rob Holland + +$Revision$ diff --git a/contrib/shunit2-2.0.3/doc/design_doc.txt b/contrib/shunit2-2.0.3/doc/design_doc.txt new file mode 100644 index 0000000..2849e55 --- /dev/null +++ b/contrib/shunit2-2.0.3/doc/design_doc.txt @@ -0,0 +1,54 @@ +Design Doc for shUnit2 +====================== + +shUnit is based upon JUnit. The initial ideas for the script came from the book +"Pragmatic Unit Testing - In Java with JUnit" by Andrew Hunt and David Thomas. + +The script was written to perform unit testing for log4sh. log4sh had grown +enough that it was becoming difficult to easily test and and verify that the +tests passed for the many different operating systems on which it was being +used. + +The functions in shUnit are meant to match those in JUnit as much as possible +where shell allows. In the initial version, there will be no concept of +exceptions (as normal POSIX shell has no concept of them) but attempts to trap +problems will be done. + +Programatic Standards +--------------------- + +* SHUNIT_TRUE - public global constant +* __SHUNIT_SHELL_FLAGS - private global constant +* __shunit_oldShellFlags - private global variable + +* assertEquals - public unit test function +* shunit_publicFunc - public shUnit function; can be called from parent unit + test script +* _shunit_privateFunc - private shUnit function; should not be called from + parent script. meant for internal use by shUnit + +* _su_myVar - variable inside a public function. prefixing with '_su_' to + reduce the chances that a variable outside of shUnit will be overridden. +* _su__myVar - variable inside a private function. prefixing with '_su__' to + reduce the chances that a variable in a shUnit public function, or a variable + outside of shUnit will be overridden. + +List of functions +----------------- + +assertTrue([message,] boolean) +assertFalse([message,] boolean) +fail([message]) +assertEquals([message,] expected, actual) +#isEquals(expected, actual) +#assertArrayEquals([message,] expecteds, actuals) +#isArray(expected) +assertNotNull([message,] object) +assertNull([message,], object) +assertSame([message,], expected, actual) +assertNotSame([message,], unexpected, actual) +failSame(message) +failNotSame([message,] expected, actual) + +.. $Revision$ +.. vim:syntax=rst diff --git a/contrib/shunit2-2.0.3/doc/shunit2.html b/contrib/shunit2-2.0.3/doc/shunit2.html new file mode 100644 index 0000000..b3c1e83 --- /dev/null +++ b/contrib/shunit2-2.0.3/doc/shunit2.html @@ -0,0 +1,218 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>shUnit2</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"><meta name="description" content="shUnit2 is a unit test framework for Bourne based shell scripts, and it is designed to work in a similar manner to JUnit, PyUnit, etc."></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" lang="en-US"><div class="titlepage"><div><div><h1 class="title"><a name="shUnit2"></a>shUnit2 version 2.0.3</h1></div><div><div class="authorgroup"><div class="author"><h3 class="author"><span class="firstname">Kate</span> <span class="surname">Ward</span></h3><div class="affiliation"><div class="address"><p><br> +            <code class="email"><<a href="mailto:kate.ward@forestent.com">kate.ward@forestent.com</a>></code><br> +          </p></div></div></div></div></div><div><p class="pubdate">2007-07-12</p></div><div><div class="revhistory"><table border="1" width="100%" summary="Revision history"><tr><th align="left" valign="top" colspan="3"><b>Revision History</b></th></tr><tr><td align="left">Revision 2.0.3</td><td align="left">2007-07-12</td><td align="left">Kate Ward <kate.ward@forestent.com></td></tr><tr><td align="left">Revision 2.0.2</td><td align="left">2007-04-22</td><td align="left">Kate Ward <kate.ward@forestent.com></td></tr><tr><td align="left">Revision 2.0.1</td><td align="left">2007-02-21</td><td align="left">Kate Ward <kate.ward@forestent.com></td></tr><tr><td align="left">Revision 2.0.0</td><td align="left">2007-02-20</td><td align="left">Kate Ward <kate.ward@forestent.com></td></tr></table></div></div><div><div class="abstract"><p class="title"><b>Abstract</b></p><p><a href="http://sourceforge.net/projects/shunit2" target="_top">shUnit2</a> is a unit test framework for Bourne based shell scripts, and it is designed to work in a similar manner to <a href="http://www.junit.org/" target="_top">JUnit</a>, <a href="http://pyunit.sourceforge.net/" target="_top">PyUnit</a>, etc.</p></div></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#introduction">1. Introduction</a></span></dt><dd><dl><dt><span class="section"><a href="#credits">1. Credits / Contributors</a></span></dt><dt><span class="section"><a href="#feedback">2. Feedback</a></span></dt></dl></dd><dt><span class="chapter"><a href="#quickstart">2. Quickstart</a></span></dt><dt><span class="chapter"><a href="#shelldoc">3. Function Reference</a></span></dt><dd><dl><dt><span class="section"><a href="#shelldoc-section-asserts">1. asserts</a></span></dt><dt><span class="section"><a href="#shelldoc-section-failures">2. failures</a></span></dt><dt><span class="section"><a href="#shelldoc-section-suites">3. suites</a></span></dt></dl></dd></dl></div><div class="list-of-tables"><p><b>List of Tables</b></p><dl><dt>3.1. <a href="#shelldoc-function-asserts">asserts</a></dt><dt>3.2. <a href="#shelldoc-function-failures">failures</a></dt><dt>3.3. <a href="#shelldoc-function-suites">suites</a></dt></dl></div><div class="chapter" lang="en-US"><div class="titlepage"><div><div><h2 class="title"><a name="introduction"></a>Chapter 1. Introduction</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#credits">1. Credits / Contributors</a></span></dt><dt><span class="section"><a href="#feedback">2. Feedback</a></span></dt></dl></div><p>shUnit2 is a unit test framework for Bourne based shell scripts, and it is designed to work in a similar manner to <a href="http://www.junit.org/" target="_top">JUnit</a>, <a href="http://pyunit.sourceforge.net/" target="_top">PyUnit</a>, etc.</p><p>shUnit2 was originally developed to provide a consistent testing solution for <a href="http://log4sh.sourceforge.net/" target="_top">log4sh</a>, a shell based logging framework similar to log4j. During the development of that product, the problem of having things work just fine under one shell (<code class="filename">/bin/bash</code> on Linux to be specific), and then not working under another shell (<code class="filename">/bin/sh</code> on Solaris), kept coming up. Although there were several simple tests ran, they were not adaquate and did not catch very many corner cases. The decision was finally made to write a proper unit test framework after after multiple brown-bag releases were made.</p><div class="blockquote"><blockquote class="blockquote"><div class="blockquote-title"><p><b>Tested Operating Systems</b></p></div><div class="itemizedlist"><ul type="disc"><li><p><a href="http://www.cygwin.com/" target="_top">Cygwin</a></p></li><li><p><a href="http://www.freebsd.org/" target="_top">FreeBSD</a> (user supported)</p></li><li><p>Linux (<a href="http://www.gentoo.org/" target="_top">Gentoo</a>, <a href="http://www.ubuntu.com/" target="_top">Ubuntu</a>)</p></li><li><p><a href="http://www.apple.com/macosx/" target="_top">Mac OS X</a></p></li><li><p><a href="http://www.sun.com/software/solaris/" target="_top">Solaris</a> 8, 9, 10</p></li></ul></div></blockquote></div><div class="blockquote"><blockquote class="blockquote"><div class="blockquote-title"><p><b>Tested Shells</b></p></div><div class="itemizedlist"><ul type="disc"><li><p>Bourne Shell (<span><strong class="command">sh</strong></span>)</p></li><li><p><a href="http://www.gnu.org/software/bash/" target="_top">BASH</a> - GNU Bourne Again SHell (<span><strong class="command">bash</strong></span>)</p></li><li><p><a href="http://gondor.apana.org.au/~herbert/dash/" target="_top">DASH</a> (<span><strong class="command">dash</strong></span>)</p></li><li><p><a href="http://www.kornshell.com/" target="_top">Korn Shell</a> (<span><strong class="command">ksh</strong></span>)</p></li><li><p><a href="http://web.cs.mun.ca/~michael/pdksh/" target="_top">pdksh</a> - Public Domain Korn Shell (<span><strong class="command">pdksh</strong></span>)</p></li></ul></div></blockquote></div><p>See the appropriate Release Notes (<code class="filename">doc/RELEASE_NOTES-X.X.X.txt</code>) for this release for the actual versions tested.</p><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="credits"></a>1. Credits / Contributors</h2></div></div></div><p>A list of contributors to shUnit2 can be found in the source archive as <code class="filename">doc/contributors.txt</code>. I want to personally thank all those who have contributed to make this a better tool.</p></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="feedback"></a>2. Feedback</h2></div></div></div><p>Feedback is most certainly welcome for this document. Send your additions, comments and criticisms to the following email address: <code class="email"><<a href="mailto:kate.ward@forestent.com">kate.ward@forestent.com</a>></code>.</p></div></div><div class="chapter" lang="en-US"><div class="titlepage"><div><div><h2 class="title"><a name="quickstart"></a>Chapter 2. Quickstart</h2></div></div></div><p>This chapter will give a very quick start to running unit tests with shUnit2. More information is located in other chapters.</p><p>Here is a quick sample script to show how easy it is to write a unit test in shell. It expects that you have a copy of <span><strong class="command">shunit2</strong></span> in the same directory as the script.</p><pre class="programlisting"> + +#! /bin/sh + +testEquality() +{ + assertEquals 1 1 +} + +# load shunit2 +. ./shunit2 + + </pre><p>Running the unit test should give results similar to the following.</p><pre class="screen"> + +# +# Performing tests +# +testEquality + +# +# Test report +# +tests passed: 1 +tests failed: 0 +tests total: 1 +success rate: 100% + + </pre><p>Wohoo! You've just run your first successful unit test. So, what just happened? Quite a bit really, and it all happened simply by sourcing the <span><strong class="command">shunit2</strong></span> script. The basic functionality for the script above goes like this.</p><p>When shUnit2 is sourced, it first looks to see if a <code class="function">suite()</code> function has been declared. If it exists, it is called as it is expected to contain a list of tests to be executed. If it doesn't exist (and it doesn't in the above example), shUnit2 will look on its own for any functions that start with the string <code class="literal">test</code>, and adds those to an internal list of tests to execute. Once a list of test functions to be run has been determined, shunit2 will go to work.</p><p>Before any tests are executed, shUnit2 again looks for a function, this time one named <code class="function">oneTimeSetUp()</code>. If it exists, it will be run. This function is normally used to setup the environment for all tests to be run. Things like creating directories for output or setting environment variables are good to place here. Just so you know, you can also declare a corresponding function named <code class="function">oneTimeTearDown()</code> function that does the same thing, but once all the tests have been completed. It is good for removing temporary directories, etc.</p><p>shUnit2 is now ready to run tests. Before doing so though, it again looks for another function that might be declared, one named <code class="function">setUp()</code>. If the function exists, it will be run before each test. It is good for resetting the environment so that each test starts with a clean slate. At this stage, the first test is finally run. The success of the test is recorded for a report that will be generated later. After the test is run, shUnit2 looks for a final function that might be declared, one named <code class="function">tearDown()</code>. If it exists, it will be run after each test. It is a good place for cleaning up after each test, maybe doing things like removing files that were created, or removing directories. This set of steps, setUp() > test() > tearDown(), is repeated for all of the available tests.</p><p>Once all the work is done, shUnit2 will generate the nice report you saw above. A summary of all the successes and failures will be given so that you know how well your code is doing.</p><p>We should now try adding a test that fails. Change your unit test to look like this.</p><pre class="programlisting"> + +#! /bin/sh + +testEquality() +{ + assertEquals 1 1 +} + +testPartyLikeItIs1999() +{ + year=`date '+%Y'` + assertEquals "It's not 1999 :-( This is ${year}." \ + '1999' "${year}" +} + +# load shunit2 +. ./shunit2 + + </pre><p>So, what did you get? I guess it told you that this isn't 1999. Bummer, eh? Hopefully, you noticed a couple of things that were different about the second test. First, we added an optional message that the user will see if the assert fails. Second, we did comparisons of strings instead of integers as in the first test. It doesn't matter whether you are testing for equality of strings or integers. Both work equally well with shUnit2.</p><p>Hopefully, this is enough to get you started with unit testing. If you want a ton more examples, take a look at the tests provided with <a href="http://log4sh.sourceforge.net/" target="_top">log4sh</a>. Examples of much more advanced usage can be seen there. shUnit2 was after all written to help with the unit testing problems that log4sh had.</p></div><div class="chapter" lang="en-US"><div class="titlepage"><div><div><h2 class="title"><a name="shelldoc"></a>Chapter 3. Function Reference</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#shelldoc-section-asserts">1. asserts</a></span></dt><dt><span class="section"><a href="#shelldoc-section-failures">2. failures</a></span></dt><dt><span class="section"><a href="#shelldoc-section-suites">3. suites</a></span></dt></dl></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="shelldoc-section-asserts"></a>1. asserts</h2></div></div></div><div class="table"><a name="shelldoc-function-asserts"></a><p class="title"><b>Table 3.1. asserts</b></p><div class="table-contents"><table summary="asserts" border="1"><colgroup><col><col></colgroup><tbody><tr valign="top"><td align="right" valign="top"> + <span class="emphasis"><em>void</em></span> + </td><td valign="top"> + <div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef"> + <b class="fsfunc">assertEquals</b> + (</code></td><td><var class="pdparam">[message]</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">expected</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">actual</var><code>)</code>;</td><td> </td></tr></table><table border="0" summary="Function argument synopsis" cellspacing="0" cellpadding="0"><tr><td><code>string </code> </td><td><code><var class="pdparam">[message]</var>;</code></td></tr><tr><td><code>string </code> </td><td><code><var class="pdparam">expected</var>;</code></td></tr><tr><td><code>string </code> </td><td><code><var class="pdparam">actual</var>;</code></td></tr></table></div> + <p>Asserts that <span class="emphasis"><em>expected</em></span> and + <span class="emphasis"><em>actual</em></span> are equal to one another. The message is + optional.</p> + </td></tr><tr valign="top"><td align="right" valign="top"> + <span class="emphasis"><em>void</em></span> + </td><td valign="top"> + <div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef"> + <b class="fsfunc">assertNull</b> + (</code></td><td><var class="pdparam">[message]</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">value</var><code>)</code>;</td><td> </td></tr></table><table border="0" summary="Function argument synopsis" cellspacing="0" cellpadding="0"><tr><td><code>string </code> </td><td><code><var class="pdparam">[message]</var>;</code></td></tr><tr><td><code>string </code> </td><td><code><var class="pdparam">value</var>;</code></td></tr></table></div> + <p>Asserts that <span class="emphasis"><em>value</em></span> is <code class="literal">null</code>, + or in shell terms a zero-length string. The message is optional.</p> + </td></tr><tr valign="top"><td align="right" valign="top"> + <span class="emphasis"><em>void</em></span> + </td><td valign="top"> + <div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef"> + <b class="fsfunc">assertNotNull</b> + (</code></td><td><var class="pdparam">[message]</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">value</var><code>)</code>;</td><td> </td></tr></table><table border="0" summary="Function argument synopsis" cellspacing="0" cellpadding="0"><tr><td><code>string </code> </td><td><code><var class="pdparam">[message]</var>;</code></td></tr><tr><td><code>string </code> </td><td><code><var class="pdparam">value</var>;</code></td></tr></table></div> + <p>Asserts that <span class="emphasis"><em>value</em></span> is <span class="strong"><strong>not</strong></span><code class="literal">null</code>, or in shell terms not + a zero-length string. The message is optional.</p> + </td></tr><tr valign="top"><td align="right" valign="top"> + <span class="emphasis"><em>void</em></span> + </td><td valign="top"> + <div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef"> + <b class="fsfunc">assertSame</b> + (</code></td><td><var class="pdparam">[message]</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">expected</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">actual</var><code>)</code>;</td><td> </td></tr></table><table border="0" summary="Function argument synopsis" cellspacing="0" cellpadding="0"><tr><td><code>string </code> </td><td><code><var class="pdparam">[message]</var>;</code></td></tr><tr><td><code>string </code> </td><td><code><var class="pdparam">expected</var>;</code></td></tr><tr><td><code>string </code> </td><td><code><var class="pdparam">actual</var>;</code></td></tr></table></div> + <p>This function is functionally equivalent to + <code class="function">assertEquals</code>.</p> + </td></tr><tr valign="top"><td align="right" valign="top"> + <span class="emphasis"><em>void</em></span> + </td><td valign="top"> + <div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef"> + <b class="fsfunc">assertNotSame</b> + (</code></td><td><var class="pdparam">[message]</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">unexpected</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">actual</var><code>)</code>;</td><td> </td></tr></table><table border="0" summary="Function argument synopsis" cellspacing="0" cellpadding="0"><tr><td><code>string </code> </td><td><code><var class="pdparam">[message]</var>;</code></td></tr><tr><td><code>string </code> </td><td><code><var class="pdparam">unexpected</var>;</code></td></tr><tr><td><code>string </code> </td><td><code><var class="pdparam">actual</var>;</code></td></tr></table></div> + <p>Asserts that <span class="emphasis"><em>unexpected</em></span> and + <span class="emphasis"><em>actual</em></span> are <span class="strong"><strong>not</strong></span> + equal to one another. The message is optional.</p> + </td></tr><tr valign="top"><td align="right" valign="top"> + <span class="emphasis"><em>void</em></span> + </td><td valign="top"> + <div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef"> + <b class="fsfunc">assertTrue</b> + (</code></td><td><var class="pdparam">[message]</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">condition</var><code>)</code>;</td><td> </td></tr></table><table border="0" summary="Function argument synopsis" cellspacing="0" cellpadding="0"><tr><td><code>string </code> </td><td><code><var class="pdparam">[message]</var>;</code></td></tr><tr><td><code>string </code> </td><td><code><var class="pdparam">condition</var>;</code></td></tr></table></div> + <p>Asserts that a given shell test condition is true. The message is + optional.</p> + <p>Testing whether something is true or false is easy enough by using + the assertEquals/assertNotSame functions. Shell supports much more + complicated tests though, and a means to support them was needed. As such, + this function tests that conditions are true or false through evaluation + rather than just looking for a true or false.</p> + <div class="funcsynopsis"> + The following test will succeed: <pre class="funcsynopsisinfo">assertTrue "[ 34 -gt 23 ]"</pre> + The following test will fail with a message: <pre class="funcsynopsisinfo">assertTrue "test failed" "[ -r '/non/existent/file' ]"</pre></div> + </td></tr><tr valign="top"><td align="right" valign="top"> + <span class="emphasis"><em>void</em></span> + </td><td valign="top"> + <div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef"> + <b class="fsfunc">assertFalse</b> + (</code></td><td><var class="pdparam">[message]</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">condition</var><code>)</code>;</td><td> </td></tr></table><table border="0" summary="Function argument synopsis" cellspacing="0" cellpadding="0"><tr><td><code>string </code> </td><td><code><var class="pdparam">[message]</var>;</code></td></tr><tr><td><code>string </code> </td><td><code><var class="pdparam">condition</var>;</code></td></tr></table></div> + <p>Asserts that a given shell test condition is false. The message is + optional.</p> + <p>Testing whether something is true or false is easy enough by using + the assertEquals/assertNotSame functions. Shell supports much more + complicated tests though, and a means to support them was needed. As such, + this function tests that conditions are true or false through evaluation + rather than just looking for a true or false.</p> + <div class="funcsynopsis"> + The following test will succeed: <pre class="funcsynopsisinfo">assertFalse "[ 'apples' = 'oranges' ]"</pre> + The following test will fail with a message: <pre class="funcsynopsisinfo">assertFalse "test failed" "[ 1 -eq 1 -a 2 -eq 2 ]"</pre></div> + </td></tr></tbody></table></div></div><br class="table-break"></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="shelldoc-section-failures"></a>2. failures</h2></div></div></div><div class="table"><a name="shelldoc-function-failures"></a><p class="title"><b>Table 3.2. failures</b></p><div class="table-contents"><table summary="failures" border="1"><colgroup><col><col></colgroup><tbody><tr valign="top"><td align="right" valign="top"> + <span class="emphasis"><em>void</em></span> + </td><td valign="top"> + <div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef"> + <b class="fsfunc">fail</b> + (</code></td><td><var class="pdparam">[message]</var><code>)</code>;</td><td> </td></tr></table><table border="0" summary="Function argument synopsis" cellspacing="0" cellpadding="0"><tr><td><code>string </code> </td><td><code><var class="pdparam">[message]</var>;</code></td></tr></table></div> + <p>Fails the test immediately, with the optional message.</p> + </td></tr><tr valign="top"><td align="right" valign="top"> + <span class="emphasis"><em>void</em></span> + </td><td valign="top"> + <div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef"> + <b class="fsfunc">failNotEquals</b> + (</code></td><td><var class="pdparam">[message]</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">unexpected</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">actual</var><code>)</code>;</td><td> </td></tr></table><table border="0" summary="Function argument synopsis" cellspacing="0" cellpadding="0"><tr><td><code>string </code> </td><td><code><var class="pdparam">[message]</var>;</code></td></tr><tr><td><code>string </code> </td><td><code><var class="pdparam">unexpected</var>;</code></td></tr><tr><td><code>string </code> </td><td><code><var class="pdparam">actual</var>;</code></td></tr></table></div> + <p>Fails the test if <span class="emphasis"><em>unexpected</em></span> and + <span class="emphasis"><em>actual</em></span> are <span class="strong"><strong>not</strong></span> + equal to one another. The message is optional.</p> + </td></tr><tr valign="top"><td align="right" valign="top"> + <span class="emphasis"><em>void</em></span> + </td><td valign="top"> + <div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef"> + <b class="fsfunc">failSame</b> + (</code></td><td><var class="pdparam">[message]</var><code>)</code>;</td><td> </td></tr></table><table border="0" summary="Function argument synopsis" cellspacing="0" cellpadding="0"><tr><td><code>string </code> </td><td><code><var class="pdparam">[message]</var>;</code></td></tr></table></div> + <p>Indicate test failure because arguments were not the same. The + message is optional.</p> + </td></tr><tr valign="top"><td align="right" valign="top"> + <span class="emphasis"><em>void</em></span> + </td><td valign="top"> + <div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef"> + <b class="fsfunc">failNotSame</b> + (</code></td><td><var class="pdparam">[message]</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">expected</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">actual</var><code>)</code>;</td><td> </td></tr></table><table border="0" summary="Function argument synopsis" cellspacing="0" cellpadding="0"><tr><td><code>string </code> </td><td><code><var class="pdparam">[message]</var>;</code></td></tr><tr><td><code>string </code> </td><td><code><var class="pdparam">expected</var>;</code></td></tr><tr><td><code>string </code> </td><td><code><var class="pdparam">actual</var>;</code></td></tr></table></div> + <p>Fails the test if <span class="emphasis"><em>expected</em></span> and + <span class="emphasis"><em>actual</em></span> are equal to one another. The message is + optional.</p> + </td></tr></tbody></table></div></div><br class="table-break"></div><div class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="shelldoc-section-suites"></a>3. suites</h2></div></div></div><div class="table"><a name="shelldoc-function-suites"></a><p class="title"><b>Table 3.3. suites</b></p><div class="table-contents"><table summary="suites" border="1"><colgroup><col><col></colgroup><tbody><tr valign="top"><td align="right" valign="top"> + <span class="emphasis"><em>void</em></span> + </td><td valign="top"> + <div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef"> + <b class="fsfunc">suite</b> + (</code></td><td><code>)</code>;</td><td> </td></tr></table><table border="0" summary="Function argument synopsis" cellspacing="0" cellpadding="0"><tr><td><code></code> </td><td><code>;</code></td></tr></table></div> + <p>This function can be optionally overridden by the user in their test + suite.</p> + <p>If this function exists, it will be called when + <span><strong class="command">shunit2</strong></span> is sourced. If it does not exist, shUnit2 will + search the parent script for all functions beginning with the word + <code class="literal">test</code>, and they will be added dynamically to the test + suite.</p> + </td></tr><tr valign="top"><td align="right" valign="top"> + <span class="emphasis"><em>void</em></span> + </td><td valign="top"> + <div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef"> + <b class="fsfunc">suite_addTest</b> + (</code></td><td><var class="pdparam">function</var><code>)</code>;</td><td> </td></tr></table><table border="0" summary="Function argument synopsis" cellspacing="0" cellpadding="0"><tr><td><code>string </code> </td><td><code><var class="pdparam">function</var>;</code></td></tr></table></div> + <p>This function adds a function name to the list of tests scheduled for + execution as part of this test suite. This function should only be called + from within the <code class="function">suite()</code> function.</p> + </td></tr><tr valign="top"><td align="right" valign="top"> + <span class="emphasis"><em>void</em></span> + </td><td valign="top"> + <div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef"> + <b class="fsfunc">oneTimeSetUp</b> + (</code></td><td><code>)</code>;</td><td> </td></tr></table><table border="0" summary="Function argument synopsis" cellspacing="0" cellpadding="0"><tr><td><code></code> </td><td><code>;</code></td></tr></table></div> + <p>This function can be be optionally overridden by the user in their + test suite.</p> + <p>If this function exists, it will be called once before any tests are + run. It is useful to prepare a common environment for all tests.</p> + </td></tr><tr valign="top"><td align="right" valign="top"> + <span class="emphasis"><em>void</em></span> + </td><td valign="top"> + <div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef"> + <b class="fsfunc">oneTimeTearDown</b> + (</code></td><td><code>)</code>;</td><td> </td></tr></table><table border="0" summary="Function argument synopsis" cellspacing="0" cellpadding="0"><tr><td><code></code> </td><td><code>;</code></td></tr></table></div> + <p>This function can be be optionally overridden by the user in their + test suite.</p> + <p>If this function exists, it will be called once after all tests are + completed. It is useful to clean up the environment after all tests.</p> + </td></tr><tr valign="top"><td align="right" valign="top"> + <span class="emphasis"><em>void</em></span> + </td><td valign="top"> + <div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef"> + <b class="fsfunc">setUp</b> + (</code></td><td><code>)</code>;</td><td> </td></tr></table><table border="0" summary="Function argument synopsis" cellspacing="0" cellpadding="0"><tr><td><code></code> </td><td><code>;</code></td></tr></table></div> + <p>This function can be be optionally overridden by the user in their + test suite.</p> + <p>If this function exists, it will be called before each test is run. + It is useful to reset the environment before each test.</p> + </td></tr><tr valign="top"><td align="right" valign="top"> + <span class="emphasis"><em>void</em></span> + </td><td valign="top"> + <div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef"> + <b class="fsfunc">tearDown</b> + (</code></td><td><code>)</code>;</td><td> </td></tr></table><table border="0" summary="Function argument synopsis" cellspacing="0" cellpadding="0"><tr><td><code></code> </td><td><code>;</code></td></tr></table></div> + <p>This function can be be optionally overridden by the user in their + test suite.</p> + <p>If this function exists, it will be called after each test completes. + It is useful to clean up the environment after each test.</p> + </td></tr></tbody></table></div></div><br class="table-break"></div></div></div></body></html> diff --git a/contrib/shunit2-2.0.3/doc/style.css b/contrib/shunit2-2.0.3/doc/style.css new file mode 100644 index 0000000..c1d2f43 --- /dev/null +++ b/contrib/shunit2-2.0.3/doc/style.css @@ -0,0 +1,33 @@ +/* $Id$ */ +/* + style.css +*/ + + +body { + +/* + Style the HMTL <body> tag with a sans-serif font and 6% margin. + A sans-serif font makes documents easier to read when displayed on + a computer screen. Whitespace surrounding the document should + make it easier to read both on screen and on printed paper. The + value of 6% was chosen because it closely approximates a one-half + inch margin on a US letter (8.5" by 11") paper. Since the margin + is expressed as a percentage it should scale well in a web browser + window. +*/ + + font-family: sans-serif; + margin: 6%; +} + +/* +table { + font-size: 0.9em; +} +*/ + +.toc { + background: #f0f0f0; + padding: 5px; +} diff --git a/contrib/shunit2-2.0.3/lib/sh/shlib b/contrib/shunit2-2.0.3/lib/sh/shlib new file mode 100644 index 0000000..00aadcb --- /dev/null +++ b/contrib/shunit2-2.0.3/lib/sh/shlib @@ -0,0 +1,23 @@ +# $Id$ +# vim:syntax=sh +# +# library of shell functions +# + +shlib_relToAbsPath() +{ + _shlib_path=$1 + + # deal with paths that start with / + echo "${_shlib_path}" |grep '^/' >/dev/null 2>&1 + if [ $? -ne 0 ]; then + _shlib_pwd=`pwd` + _shlib_path="${_shlib_pwd}/${_shlib_path}" + unset _shlib_pwd + fi + + # clean up the path + echo "${_shlib_path}" |sed 's/[^/]*\/*\.\.\/*//g;s/\/\.\//\//' + + unset _shlib_path +} diff --git a/contrib/shunit2-2.0.3/share/docbook/tldp-xsl/21MAR2004/fo/tldp-print.xsl b/contrib/shunit2-2.0.3/share/docbook/tldp-xsl/21MAR2004/fo/tldp-print.xsl new file mode 100644 index 0000000..b7a7d43 --- /dev/null +++ b/contrib/shunit2-2.0.3/share/docbook/tldp-xsl/21MAR2004/fo/tldp-print.xsl @@ -0,0 +1,26 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> + +<xsl:stylesheet version="1.0" +xmlns:xsl="http://www.w3.org/1999/XSL/Transform"> + +<xsl:import href="../../../docbook-xsl/current/fo/docbook.xsl"/> + +<!-- Number all sections in the style of 'CH.S1.S2 Section Title' where + CH is the chapter number, S1 is the section number and S2 is the + sub-section number. The lables are not limited to any particular + depth and can go as far as there are sections. --> +<xsl:param name="section.autolabel" select="1"></xsl:param> +<xsl:param name="section.label.includes.component.label" select="0"></xsl:param> + +<!-- Turn off the default 'full justify' and go with 'left justify' + instead. This avoids the large gaps that can sometimes appear + between words in fully-justified documents. --> +<xsl:param name="alignment">start</xsl:param> + +<!-- Shade Verbatim Sections such as programlisting and screen --> +<xsl:param name="shade.verbatim" select="1"/> + +<!-- Create bookmarks in .PDF files --> +<xsl:param name="fop.extensions" select="1"/> + +</xsl:stylesheet> diff --git a/contrib/shunit2-2.0.3/share/docbook/tldp-xsl/21MAR2004/html/tldp-common.xsl b/contrib/shunit2-2.0.3/share/docbook/tldp-xsl/21MAR2004/html/tldp-common.xsl new file mode 100644 index 0000000..f8cf7b1 --- /dev/null +++ b/contrib/shunit2-2.0.3/share/docbook/tldp-xsl/21MAR2004/html/tldp-common.xsl @@ -0,0 +1,22 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> + +<xsl:stylesheet version="1.0" +xmlns:xsl="http://www.w3.org/1999/XSL/Transform"> + +<!-- This file contains parameters that are applicable to all of the + tldp-*.xsl files in the html directory. --> + +<!-- Create a link to a CSS stylesheet named 'style.css' in all html + output so that pages can be beautified. Browsers not supporting + CSS should safely ignore the link. --> +<xsl:param name="html.stylesheet.type">text/css</xsl:param> +<xsl:param name="html.stylesheet" select="'style.css'"></xsl:param> + +<!-- Number all sections in the style of 'CH.S1.S2 Section Title' where + CH is the chapter number, S1 is the section number and S2 is the + sub-section number. The lables are not limited to any particular + depth and can go as far as there are sections. --> +<xsl:param name="section.autolabel" select="1"></xsl:param> +<xsl:param name="section.label.includes.component.label" select="0"></xsl:param> + +</xsl:stylesheet> diff --git a/contrib/shunit2-2.0.3/share/docbook/tldp-xsl/21MAR2004/html/tldp-one-page.xsl b/contrib/shunit2-2.0.3/share/docbook/tldp-xsl/21MAR2004/html/tldp-one-page.xsl new file mode 100644 index 0000000..16994ad --- /dev/null +++ b/contrib/shunit2-2.0.3/share/docbook/tldp-xsl/21MAR2004/html/tldp-one-page.xsl @@ -0,0 +1,13 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> + +<xsl:stylesheet version="1.0" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform"> + +<xsl:import href="../../../docbook-xsl/current/html/docbook.xsl"/> +<xsl:import href="tldp-common.xsl"/> +<xsl:output method="html" encoding="UTF-8" indent="no"/> + +<!-- This set of customizations is used to generate the entire XML + document on a single HTML page. --> + +</xsl:stylesheet> diff --git a/contrib/shunit2-2.0.3/share/resources/shelldoc.xslt b/contrib/shunit2-2.0.3/share/resources/shelldoc.xslt new file mode 100644 index 0000000..45d5f92 --- /dev/null +++ b/contrib/shunit2-2.0.3/share/resources/shelldoc.xslt @@ -0,0 +1,71 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- $Id$ --> +<!-- +example ways to process this xslt: +$ java -cp xalan-2.6.0.jar \ + org.apache.xalan.xslt.Process -xml -in log4sh.xml -xsl shelldoc.xslt + +$ xsltproc shelldoc.xslt log4sh.xml |xmllint -noblanks - +--> +<xsl:stylesheet version="1.0" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:s="http://www.forestent.com/projects/shelldoc/xsl/2005.0"> + <xsl:output + method="xml" + version="1.0" + encoding="UTF-8" + indent="yes"/> + <xsl:strip-space elements="*" /> + + <xsl:variable name="newline"> +<xsl:text> +</xsl:text> + </xsl:variable> + + <xsl:key name="groups" match="s:function" use="@group" /> + + <xsl:template match="/"> + <chapter id="shelldoc" lang="en-US"><title>Function Reference</title> + <xsl:for-each select="//s:function[generate-id(.)=generate-id(key('groups', @group)[1])]"> + <xsl:sort select="@group" /> + + <section> + <xsl:attribute name="id">shelldoc-section-<xsl:value-of select="@group" /></xsl:attribute> + <title><xsl:value-of select="@group"/></title> + <table> + <xsl:attribute name="id">shelldoc-function-<xsl:value-of select="@group" /></xsl:attribute> + <title><xsl:value-of select="@group"/></title> + <tgroup cols="2"><tbody> + <xsl:for-each select="key('groups', @group)"> + <!--<xsl:sort select="entry/funcsynopsis/funcprototype/funcdef/function" />--> + <xsl:choose> + <xsl:when test="@modifier"> + <xsl:if test="@modifier != 'private'"> + <row valign="top"> + <xsl:copy-of select="entry" /> + <!--<xsl:apply-templates select="entry" />--> + </row> + </xsl:if> + </xsl:when> + <xsl:otherwise> + <row valign="top"> + <xsl:copy-of select="entry" /> + <!--<xsl:apply-templates select="entry" />--> + </row> + </xsl:otherwise> + </xsl:choose> + </xsl:for-each> + </tbody></tgroup> + </table> + </section> + </xsl:for-each> + </chapter> + </xsl:template> + + <xsl:template match="entry"> + <entry> + <xsl:copy-of select="*" /> + </entry> + </xsl:template> + +</xsl:stylesheet> diff --git a/contrib/shunit2-2.0.3/src/docbook/functions.xml b/contrib/shunit2-2.0.3/src/docbook/functions.xml new file mode 100644 index 0000000..c960e55 --- /dev/null +++ b/contrib/shunit2-2.0.3/src/docbook/functions.xml @@ -0,0 +1,14 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- +$Id$ +vim:softtabstop=2 shiftwidth=2 +--> + +<!-- ========================================================================= +Functions +--> + +<chapter id="functions"> + <title>Functions</title> + <para>This XML file is a placeholder. It is meant to be overwritten with the dynamically generated XML document that is extracted from the source code.</para> +</chapter> diff --git a/contrib/shunit2-2.0.3/src/docbook/introduction.xml b/contrib/shunit2-2.0.3/src/docbook/introduction.xml new file mode 100644 index 0000000..d71b091 --- /dev/null +++ b/contrib/shunit2-2.0.3/src/docbook/introduction.xml @@ -0,0 +1,50 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- +$Id$ +vim:softtabstop=2 shiftwidth=2 + --> + +<!-- ========================================================================= +Introduction +--> + +<chapter label="1" id="introduction"> + + <title>Introduction</title> + <para>shUnit2 is a unit test framework for Bourne based shell scripts, and it is designed to work in a similar manner to <ulink url="http://www.junit.org/">JUnit</ulink>, <ulink url="http://pyunit.sourceforge.net/">PyUnit</ulink>, etc.</para> + + <para>shUnit2 was originally developed to provide a consistent testing solution for <ulink url="http://log4sh.sourceforge.net/">log4sh</ulink>, a shell based logging framework similar to log4j. During the development of that product, the problem of having things work just fine under one shell (<filename>/bin/bash</filename> on Linux to be specific), and then not working under another shell (<filename>/bin/sh</filename> on Solaris), kept coming up. Although there were several simple tests ran, they were not adaquate and did not catch very many corner cases. The decision was finally made to write a proper unit test framework after after multiple brown-bag releases were made.</para> + + <para><blockquote><title>Tested Operating Systems</title> + <itemizedlist> + <listitem><para><ulink url="http://www.cygwin.com/">Cygwin</ulink></para></listitem> + <listitem><para><ulink url="http://www.freebsd.org/">FreeBSD</ulink> (user supported)</para></listitem> + <listitem><para>Linux (<ulink url="http://www.gentoo.org/">Gentoo</ulink>, <ulink url="http://www.ubuntu.com/">Ubuntu</ulink>)</para></listitem> + <listitem><para><ulink url="http://www.apple.com/macosx/">Mac OS X</ulink></para></listitem> + <listitem><para><ulink url="http://www.sun.com/software/solaris/">Solaris</ulink> 8, 9, 10</para></listitem> + </itemizedlist> + </blockquote></para> + + <para><blockquote><title>Tested Shells</title> + <itemizedlist> + <listitem><para>Bourne Shell (<command>sh</command>)</para></listitem> + <listitem><para><ulink url="http://www.gnu.org/software/bash/">BASH</ulink> - GNU Bourne Again SHell (<command>bash</command>)</para></listitem> + <listitem><para><ulink url="http://gondor.apana.org.au/~herbert/dash/">DASH</ulink> (<command>dash</command>)</para></listitem> + <listitem><para><ulink url="http://www.kornshell.com/">Korn Shell</ulink> (<command>ksh</command>)</para></listitem> + <listitem><para><ulink url="http://web.cs.mun.ca/~michael/pdksh/">pdksh</ulink> - Public Domain Korn Shell (<command>pdksh</command>)</para></listitem> + </itemizedlist> + </blockquote></para> + + <para>See the appropriate Release Notes (<filename>doc/RELEASE_NOTES-X.X.X.txt</filename>) for this release for the actual versions tested.</para> + + <!-- Give credit where credit is due...very important --> + <section id="credits"><title>Credits / Contributors</title> + <para>A list of contributors to shUnit2 can be found in the source archive as <filename>doc/contributors.txt</filename>. I want to personally thank all those who have contributed to make this a better tool.</para> + </section> + + <!-- Feedback --> + <section id="feedback"><title>Feedback</title> + <para>Feedback is most certainly welcome for this document. Send your additions, comments and criticisms to the following email address: <email>&myEmail;</email>.</para> + </section> + +</chapter> diff --git a/contrib/shunit2-2.0.3/src/docbook/quickstart.xml b/contrib/shunit2-2.0.3/src/docbook/quickstart.xml new file mode 100644 index 0000000..d009cb6 --- /dev/null +++ b/contrib/shunit2-2.0.3/src/docbook/quickstart.xml @@ -0,0 +1,86 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- +$Id: quickstart.xml 230 2006-08-19 22:32:02Z sfsetse $ +vim:softtabstop=2 shiftwidth=2 +--> + +<!-- ========================================================================= +Quickstart +--> +<chapter id="quickstart"> + <title>Quickstart</title> + + <para>This chapter will give a very quick start to running unit tests with shUnit2. More information is located in other chapters.</para> + + <para>Here is a quick sample script to show how easy it is to write a unit test in shell. It expects that you have a copy of &shunit2; in the same directory as the script.</para> + + <programlisting> +<![CDATA[ +#! /bin/sh + +testEquality() +{ + assertEquals 1 1 +} + +# load shunit2 +. ./shunit2 +]]> + </programlisting> + + <para>Running the unit test should give results similar to the following.</para> + + <screen> +<![CDATA[ +# +# Performing tests +# +testEquality + +# +# Test report +# +tests passed: 1 +tests failed: 0 +tests total: 1 +success rate: 100% +]]> + </screen> + + <para>Wohoo! You've just run your first successful unit test. So, what just happened? Quite a bit really, and it all happened simply by sourcing the &shunit2; script. The basic functionality for the script above goes like this.</para> + + <para>When shUnit2 is sourced, it first looks to see if a <function>suite()</function> function has been declared. If it exists, it is called as it is expected to contain a list of tests to be executed. If it doesn't exist (and it doesn't in the above example), shUnit2 will look on its own for any functions that start with the string <literal>test</literal>, and adds those to an internal list of tests to execute. Once a list of test functions to be run has been determined, shunit2 will go to work.</para> + + <para>Before any tests are executed, shUnit2 again looks for a function, this time one named <function>oneTimeSetUp()</function>. If it exists, it will be run. This function is normally used to setup the environment for all tests to be run. Things like creating directories for output or setting environment variables are good to place here. Just so you know, you can also declare a corresponding function named <function>oneTimeTearDown()</function> function that does the same thing, but once all the tests have been completed. It is good for removing temporary directories, etc.</para> + + <para>shUnit2 is now ready to run tests. Before doing so though, it again looks for another function that might be declared, one named <function>setUp()</function>. If the function exists, it will be run before each test. It is good for resetting the environment so that each test starts with a clean slate. At this stage, the first test is finally run. The success of the test is recorded for a report that will be generated later. After the test is run, shUnit2 looks for a final function that might be declared, one named <function>tearDown()</function>. If it exists, it will be run after each test. It is a good place for cleaning up after each test, maybe doing things like removing files that were created, or removing directories. This set of steps, setUp() > test() > tearDown(), is repeated for all of the available tests.</para> + + <para>Once all the work is done, shUnit2 will generate the nice report you saw above. A summary of all the successes and failures will be given so that you know how well your code is doing.</para> + + <para>We should now try adding a test that fails. Change your unit test to look like this.</para> + + <programlisting> +<![CDATA[ +#! /bin/sh + +testEquality() +{ + assertEquals 1 1 +} + +testPartyLikeItIs1999() +{ + year=`date '+%Y'` + assertEquals "It's not 1999 :-( This is ${year}." \ + '1999' "${year}" +} + +# load shunit2 +. ./shunit2 +]]> + </programlisting> + + <para>So, what did you get? I guess it told you that this isn't 1999. Bummer, eh? Hopefully, you noticed a couple of things that were different about the second test. First, we added an optional message that the user will see if the assert fails. Second, we did comparisons of strings instead of integers as in the first test. It doesn't matter whether you are testing for equality of strings or integers. Both work equally well with shUnit2.</para> + + <para>Hopefully, this is enough to get you started with unit testing. If you want a ton more examples, take a look at the tests provided with <ulink url="http://log4sh.sourceforge.net/">log4sh</ulink>. Examples of much more advanced usage can be seen there. shUnit2 was after all written to help with the unit testing problems that log4sh had.</para> +</chapter> diff --git a/contrib/shunit2-2.0.3/src/docbook/shunit2.xml b/contrib/shunit2-2.0.3/src/docbook/shunit2.xml new file mode 100644 index 0000000..25b3fed --- /dev/null +++ b/contrib/shunit2-2.0.3/src/docbook/shunit2.xml @@ -0,0 +1,85 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- +$Id$ +vim: softtabstop=2 shiftwidth=2 +--> +<!-- + +This document can be converted to HTML using the following commands: + +$ java -cp xalan-2.6.0.jar \ + org.apache.xalan.xslt.Process -xml -in log4sh.xml -xsl tldp-one-page.xsl + +$ xsltproc tldp-one-page.xsl log4sh.xml |xmllint -noblanks - + +--> + +<!DOCTYPE book + PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ + + <!ENTITY functions SYSTEM "functions.xml"> + <!ENTITY introduction SYSTEM "introduction.xml"> + <!ENTITY quickstart SYSTEM "quickstart.xml"> + + <!ENTITY myEmail "kate.ward@forestent.com"> + <!ENTITY isoDate "@@ISO_DATE@@"> + + <!ENTITY shunit2 "<command>shunit2</command>"> +]> + +<book id="shUnit2" lang="en-US"><title>shUnit2</title> + <bookinfo> + <title>shUnit2 version 2.0.3</title> + <authorgroup> + <author> + <firstname>Kate</firstname><surname>Ward</surname> + <affiliation> + <address> + <email>&myEmail;</email> + </address> + </affiliation> + </author> + </authorgroup> + + <!-- All dates specified in ISO "YYYY-MM-DD" format --> + <pubdate>&isoDate;</pubdate> + + <!-- TODO flush out like bookinfo in docbook-tdg --> + + <!-- Most recent revision goes at the top; list in descending order --> + <revhistory> + <revision> + <revnumber>2.0.3</revnumber> + <date>2007-07-12</date> + <authorinitials>Kate Ward <&myEmail;></authorinitials> + </revision> + + <revision> + <revnumber>2.0.2</revnumber> + <date>2007-04-22</date> + <authorinitials>Kate Ward <&myEmail;></authorinitials> + </revision> + + <revision> + <revnumber>2.0.1</revnumber> + <date>2007-02-21</date> + <authorinitials>Kate Ward <&myEmail;></authorinitials> + </revision> + + <revision> + <revnumber>2.0.0</revnumber> + <date>2007-02-20</date> + <authorinitials>Kate Ward <&myEmail;></authorinitials> + </revision> + </revhistory> + + <!-- Provide a good abstract; a couple of sentences is sufficient --> + <abstract> + <para><ulink url="http://sourceforge.net/projects/shunit2">shUnit2</ulink> is a unit test framework for Bourne based shell scripts, and it is designed to work in a similar manner to <ulink url="http://www.junit.org/">JUnit</ulink>, <ulink url="http://pyunit.sourceforge.net/">PyUnit</ulink>, etc.</para> + </abstract> + </bookinfo> + + &introduction; + &quickstart; + &functions; +</book> diff --git a/contrib/shunit2-2.0.3/src/shell/shunit2 b/contrib/shunit2-2.0.3/src/shell/shunit2 new file mode 100644 index 0000000..b9d1130 --- /dev/null +++ b/contrib/shunit2-2.0.3/src/shell/shunit2 @@ -0,0 +1,799 @@ +# $Id$ +# vim:syntax=sh:sts=2 +# vim:foldmethod=marker:foldmarker=/**,*/ +# +#/** +# <?xml version="1.0" encoding="UTF-8"?> +# <s:shelldoc xmlns:s="http://www.forestent.com/projects/shelldoc/xsl/2005.0"> +# <s:header> +# shUnit 2.0.4 +# Shell Unit Test Framework +# +# http://code.google.com/p/shunit2/ +# +# written by Kate Ward <kate.ward@forestent.com> +# released under the LGPL +# +# this module implements a xUnit based unit test framework similar to JUnit +# </s:header> +#*/ + +# shell flags for shunit: +# u - treat unset variables as an error when performing parameter expansion +__SHUNIT_SHELL_FLAGS='u' + +# save the current set of shell flags, and then set some for ourselves +__shunit_oldShellFlags="$-" +for _shunit_shellFlag in `echo "${__SHUNIT_SHELL_FLAGS}" |sed 's/\(.\)/\1 /g'` +do + set -${_shunit_shellFlag} +done +unset _shunit_shellFlag + +# constants + +__SHUNIT_VERSION='2.0.4pre' + +__SHUNIT_TRUE=0 +__SHUNIT_FALSE=1 +__SHUNIT_ERROR=2 + +__SHUNIT_ASSERT_MSG_PREFIX='ASSERT:' + +for _su_const in `set |grep "^__SHUNIT_" |cut -d= -f1`; do + readonly ${_su_const} +done +unset _su_const + +# variables +__shunit_suite='' + +__shunit_testsPassed=0 +__shunit_testsFailed=0 +__shunit_testsTotal=0 + +#----------------------------------------------------------------------------- +# assert functions +# + +#/** +# <s:function group="asserts"> +# <entry align="right"> +# <emphasis>void</emphasis> +# </entry> +# <entry> +# <funcsynopsis> +# <funcprototype> +# <funcdef><function>assertEquals</function></funcdef> +# <paramdef>string <parameter>[message]</parameter></paramdef> +# <paramdef>string <parameter>expected</parameter></paramdef> +# <paramdef>string <parameter>actual</parameter></paramdef> +# </funcprototype> +# </funcsynopsis> +# <para>Asserts that <emphasis>expected</emphasis> and +# <emphasis>actual</emphasis> are equal to one another. The message is +# optional.</para> +# </entry> +# </s:function> +#*/ +assertEquals() +{ + _su_message='' + if [ $# -eq 3 ]; then + _su_message=$1 + shift + fi + _su_expected=${1:-} + _su_actual=${2:-} + + shunit_return=${__SHUNIT_TRUE} + if [ "${_su_expected}" = "${_su_actual}" ]; then + _shunit_testPassed + else + failNotEquals "${_su_message}" "${_su_expected}" "${_su_actual}" + shunit_return=${__SHUNIT_FALSE} + fi + + unset _su_message _su_expected _su_actual + return ${shunit_return} +} + +#/** +# <s:function group="asserts"> +# <entry align="right"> +# <emphasis>void</emphasis> +# </entry> +# <entry> +# <funcsynopsis> +# <funcprototype> +# <funcdef><function>assertNull</function></funcdef> +# <paramdef>string <parameter>[message]</parameter></paramdef> +# <paramdef>string <parameter>value</parameter></paramdef> +# </funcprototype> +# </funcsynopsis> +# <para>Asserts that <emphasis>value</emphasis> is <literal>null</literal>, +# or in shell terms a zero-length string. The message is optional.</para> +# </entry> +# </s:function> +#*/ +assertNull() +{ + if [ $# -eq 2 ]; then + assertTrue "$1" "[ -z '$2' ]" + else + assertTrue "[ -z '${1:-}' ]" + fi +} + +#/** +# <s:function group="asserts"> +# <entry align="right"> +# <emphasis>void</emphasis> +# </entry> +# <entry> +# <funcsynopsis> +# <funcprototype> +# <funcdef><function>assertNotNull</function></funcdef> +# <paramdef>string <parameter>[message]</parameter></paramdef> +# <paramdef>string <parameter>value</parameter></paramdef> +# </funcprototype> +# </funcsynopsis> +# <para>Asserts that <emphasis>value</emphasis> is <emphasis +# role="strong">not</emphasis> <literal>null</literal>, or in shell terms not +# a zero-length string. The message is optional.</para> +# </entry> +# </s:function> +#*/ +assertNotNull() +{ + if [ $# -eq 2 ]; then + assertTrue "$1" "[ -n '$2' ]" + else + assertTrue "[ -n '${1:-}' ]" + fi +} + +#/** +# <s:function group="asserts"> +# <entry align="right"> +# <emphasis>void</emphasis> +# </entry> +# <entry> +# <funcsynopsis> +# <funcprototype> +# <funcdef><function>assertSame</function></funcdef> +# <paramdef>string <parameter>[message]</parameter></paramdef> +# <paramdef>string <parameter>expected</parameter></paramdef> +# <paramdef>string <parameter>actual</parameter></paramdef> +# </funcprototype> +# </funcsynopsis> +# <para>This function is functionally equivalent to +# <function>assertEquals</function>.</para> +# </entry> +# </s:function> +#*/ +assertSame() +{ + assertEquals "${@:-}" +} + +#/** +# <s:function group="asserts"> +# <entry align="right"> +# <emphasis>void</emphasis> +# </entry> +# <entry> +# <funcsynopsis> +# <funcprototype> +# <funcdef><function>assertNotSame</function></funcdef> +# <paramdef>string <parameter>[message]</parameter></paramdef> +# <paramdef>string <parameter>unexpected</parameter></paramdef> +# <paramdef>string <parameter>actual</parameter></paramdef> +# </funcprototype> +# </funcsynopsis> +# <para>Asserts that <emphasis>unexpected</emphasis> and +# <emphasis>actual</emphasis> are <emphasis role="strong">not</emphasis> +# equal to one another. The message is optional.</para> +# </entry> +# </s:function> +#*/ +assertNotSame() +{ + _su_message='' + if [ $# -eq 3 ]; then + _su_message=$1 + shift + fi + _su_unexpected=${1:-} + _su_actual=${2:-} + + shunit_return=${__SHUNIT_TRUE} + if [ "${_su_unexpected}" != "${_su_actual}" ]; then + _shunit_testPassed + else + failSame "${_su_message}" + shunit_return=${__SHUNIT_FALSE} + fi + + unset _su_message _su_unexpected _su_actual + return ${shunit_return} +} + +#/** +# <s:function group="asserts"> +# <entry align="right"> +# <emphasis>void</emphasis> +# </entry> +# <entry> +# <funcsynopsis> +# <funcprototype> +# <funcdef><function>assertTrue</function></funcdef> +# <paramdef>string <parameter>[message]</parameter></paramdef> +# <paramdef>string <parameter>condition</parameter></paramdef> +# </funcprototype> +# </funcsynopsis> +# <para>Asserts that a given shell test condition is true. The message is +# optional.</para> +# <para>Testing whether something is true or false is easy enough by using +# the assertEquals/assertNotSame functions. Shell supports much more +# complicated tests though, and a means to support them was needed. As such, +# this function tests that conditions are true or false through evaluation +# rather than just looking for a true or false.</para> +# <funcsynopsis> +# The following test will succeed: <funcsynopsisinfo>assertTrue "[ 34 -gt 23 ]"</funcsynopsisinfo> +# The following test will fail with a message: <funcsynopsisinfo>assertTrue "test failed" "[ -r '/non/existent/file' ]"</funcsynopsisinfo> +# </funcsynopsis> +# </entry> +# </s:function> +#*/ +assertTrue() +{ + _su_message='' + if [ $# -eq 2 ]; then + _su_message=$1 + shift + fi + _su_condition=${1:-} + + shunit_return=${__SHUNIT_TRUE} + + # see if condition is an integer, i.e. a return value + _su_match=`expr "${_su_condition}" : '\([0-9]*\)'` + if [ -z "${_su_condition}" ]; then + # null condition + shunit_return=${__SHUNIT_FALSE} + elif [ "${_su_condition}" = "${_su_match}" ]; then + # possible return value. treating 0 as true, and non-zero as false. + [ ${_su_condition} -ne 0 ] && shunit_return=${__SHUNIT_FALSE} + else + # (hopefully) a condition + ( eval ${_su_condition} ) >/dev/null 2>&1 + [ $? -ne 0 ] && shunit_return=${__SHUNIT_FALSE} + fi + + # record the test + if [ ${shunit_return} -eq ${__SHUNIT_TRUE} ]; then + _shunit_testPassed + else + _shunit_testFailed "${_su_message}" + fi + + unset _su_message _su_condition _su_match + return ${shunit_return} +} + +#/** +# <s:function group="asserts"> +# <entry align="right"> +# <emphasis>void</emphasis> +# </entry> +# <entry> +# <funcsynopsis> +# <funcprototype> +# <funcdef><function>assertFalse</function></funcdef> +# <paramdef>string <parameter>[message]</parameter></paramdef> +# <paramdef>string <parameter>condition</parameter></paramdef> +# </funcprototype> +# </funcsynopsis> +# <para>Asserts that a given shell test condition is false. The message is +# optional.</para> +# <para>Testing whether something is true or false is easy enough by using +# the assertEquals/assertNotSame functions. Shell supports much more +# complicated tests though, and a means to support them was needed. As such, +# this function tests that conditions are true or false through evaluation +# rather than just looking for a true or false.</para> +# <funcsynopsis> +# The following test will succeed: <funcsynopsisinfo>assertFalse "[ 'apples' = 'oranges' ]"</funcsynopsisinfo> +# The following test will fail with a message: <funcsynopsisinfo>assertFalse "test failed" "[ 1 -eq 1 -a 2 -eq 2 ]"</funcsynopsisinfo> +# </funcsynopsis> +# </entry> +# </s:function> +#*/ +assertFalse() +{ + _su_message='' + if [ $# -eq 2 ]; then + _su_message=$1 + shift + fi + _su_condition=${1:-} + + shunit_return=${__SHUNIT_TRUE} + + # see if condition is an integer, i.e. a return value + _su_match=`expr "${_su_condition}" : '\([0-9]*\)'` + if [ -z "${_su_condition}" ]; then + # null condition + shunit_return=${__SHUNIT_FALSE} + elif [ "${_su_condition}" = "${_su_match}" ]; then + # possible return value. treating 0 as true, and non-zero as false. + [ ${_su_condition} -eq 0 ] && shunit_return=${__SHUNIT_FALSE} + else + # (hopefully) a condition + ( eval ${_su_condition} ) >/dev/null 2>&1 + [ $? -eq 0 ] && shunit_return=${__SHUNIT_FALSE} + fi + + # record the test + if [ ${shunit_return} -eq ${__SHUNIT_TRUE} ]; then + _shunit_testPassed + else + _shunit_testFailed "${_su_message}" + fi + + unset _su_message _su_condition _su_match + return ${shunit_return} +} + +#----------------------------------------------------------------------------- +# failure functions +# + +#/** +# <s:function group="failures"> +# <entry align="right"> +# <emphasis>void</emphasis> +# </entry> +# <entry> +# <funcsynopsis> +# <funcprototype> +# <funcdef><function>fail</function></funcdef> +# <paramdef>string <parameter>[message]</parameter></paramdef> +# </funcprototype> +# </funcsynopsis> +# <para>Fails the test immediately, with the optional message.</para> +# </entry> +# </s:function> +#*/ +fail() +{ + _su_message=${1:-} + + _shunit_testFailed "${_su_message}" + + unset _su_message +} + +#/** +# <s:function group="failures"> +# <entry align="right"> +# <emphasis>void</emphasis> +# </entry> +# <entry> +# <funcsynopsis> +# <funcprototype> +# <funcdef><function>failNotEquals</function></funcdef> +# <paramdef>string <parameter>[message]</parameter></paramdef> +# <paramdef>string <parameter>unexpected</parameter></paramdef> +# <paramdef>string <parameter>actual</parameter></paramdef> +# </funcprototype> +# </funcsynopsis> +# <para>Fails the test if <emphasis>unexpected</emphasis> and +# <emphasis>actual</emphasis> are <emphasis role="strong">not</emphasis> +# equal to one another. The message is optional.</para> +# </entry> +# </s:function> +#*/ +failNotEquals() +{ + _su_message='' + if [ $# -eq 3 ]; then + _su_message=$1 + shift + fi + _su_unexpected=${1:-} + _su_actual=${2:-} + + _shunit_testFailed "${_su_message:+${_su_message} }expected:<${_su_unexpected}> but was:<${_su_actual}>" + + unset _su_message _su_unexpected _su_actual +} + +#/** +# <s:function group="failures"> +# <entry align="right"> +# <emphasis>void</emphasis> +# </entry> +# <entry> +# <funcsynopsis> +# <funcprototype> +# <funcdef><function>failSame</function></funcdef> +# <paramdef>string <parameter>[message]</parameter></paramdef> +# </funcprototype> +# </funcsynopsis> +# <para>Indicate test failure because arguments were not the same. The +# message is optional.</para> +# </entry> +# </s:function> +#*/ +failSame() +{ + _su_message=${1:-} + + _shunit_testFailed "${_su_message:+${_su_message} }expected not same" + + unset _su_message +} + +#/** +# <s:function group="failures"> +# <entry align="right"> +# <emphasis>void</emphasis> +# </entry> +# <entry> +# <funcsynopsis> +# <funcprototype> +# <funcdef><function>failNotSame</function></funcdef> +# <paramdef>string <parameter>[message]</parameter></paramdef> +# <paramdef>string <parameter>expected</parameter></paramdef> +# <paramdef>string <parameter>actual</parameter></paramdef> +# </funcprototype> +# </funcsynopsis> +# <para>Fails the test if <emphasis>expected</emphasis> and +# <emphasis>actual</emphasis> are equal to one another. The message is +# optional.</para> +# </entry> +# </s:function> +#*/ +failNotSame() +{ + failNotEquals "${@:-}" +} + +#----------------------------------------------------------------------------- +# suite functions +# + +#/** +# <s:function group="suites"> +# <entry align="right"> +# <emphasis>void</emphasis> +# </entry> +# <entry> +# <funcsynopsis> +# <funcprototype> +# <funcdef><function>suite</function></funcdef> +# <paramdef /> +# </funcprototype> +# </funcsynopsis> +# <para>This function can be optionally overridden by the user in their test +# suite.</para> +# <para>If this function exists, it will be called when +# <command>shunit2</command> is sourced. If it does not exist, shUnit2 will +# search the parent script for all functions beginning with the word +# <literal>test</literal>, and they will be added dynamically to the test +# suite.</para> +# </entry> +# </s:function> +#*/ +# Note: see _shunit_mktempFunc() for actual implementation +# suite() { :; } + +#/** +# <s:function group="suites"> +# <entry align="right"> +# <emphasis>void</emphasis> +# </entry> +# <entry> +# <funcsynopsis> +# <funcprototype> +# <funcdef><function>suite_addTest</function></funcdef> +# <paramdef>string <parameter>function</parameter></paramdef> +# </funcprototype> +# </funcsynopsis> +# <para>This function adds a function name to the list of tests scheduled for +# execution as part of this test suite. This function should only be called +# from within the <function>suite()</function> function.</para> +# </entry> +# </s:function> +#*/ +suite_addTest() +{ + _su_func=${1:-} + + __shunit_suite="${__shunit_suite:+${__shunit_suite} }${_su_func}" + + unset _su_func +} + +#/** +# <s:function group="suites"> +# <entry align="right"> +# <emphasis>void</emphasis> +# </entry> +# <entry> +# <funcsynopsis> +# <funcprototype> +# <funcdef><function>oneTimeSetUp</function></funcdef> +# <paramdef /> +# </funcprototype> +# </funcsynopsis> +# <para>This function can be be optionally overridden by the user in their +# test suite.</para> +# <para>If this function exists, it will be called once before any tests are +# run. It is useful to prepare a common environment for all tests.</para> +# </entry> +# </s:function> +#*/ +# Note: see _shunit_mktempFunc() for actual implementation +# oneTimeSetUp() { :; } + +#/** +# <s:function group="suites"> +# <entry align="right"> +# <emphasis>void</emphasis> +# </entry> +# <entry> +# <funcsynopsis> +# <funcprototype> +# <funcdef><function>oneTimeTearDown</function></funcdef> +# <paramdef /> +# </funcprototype> +# </funcsynopsis> +# <para>This function can be be optionally overridden by the user in their +# test suite.</para> +# <para>If this function exists, it will be called once after all tests are +# completed. It is useful to clean up the environment after all tests.</para> +# </entry> +# </s:function> +#*/ +# Note: see _shunit_mktempFunc() for actual implementation +# oneTimeTearDown() { :; } + +#/** +# <s:function group="suites"> +# <entry align="right"> +# <emphasis>void</emphasis> +# </entry> +# <entry> +# <funcsynopsis> +# <funcprototype> +# <funcdef><function>setUp</function></funcdef> +# <paramdef /> +# </funcprototype> +# </funcsynopsis> +# <para>This function can be be optionally overridden by the user in their +# test suite.</para> +# <para>If this function exists, it will be called before each test is run. +# It is useful to reset the environment before each test.</para> +# </entry> +# </s:function> +#*/ +# Note: see _shunit_mktempFunc() for actual implementation +# setUp() { :; } + +#/** +# <s:function group="suites"> +# <entry align="right"> +# <emphasis>void</emphasis> +# </entry> +# <entry> +# <funcsynopsis> +# <funcprototype> +# <funcdef><function>tearDown</function></funcdef> +# <paramdef /> +# </funcprototype> +# </funcsynopsis> +# <para>This function can be be optionally overridden by the user in their +# test suite.</para> +# <para>If this function exists, it will be called after each test completes. +# It is useful to clean up the environment after each test.</para> +# </entry> +# </s:function> +#*/ +# Note: see _shunit_mktempFunc() for actual implementation +# tearDown() { :; } + +#------------------------------------------------------------------------------ +# internal shUnit2 functions +# + +_shunit_cleanup() +{ + name=$1 + + case ${name} in + EXIT) signal=0 ;; + INT) signal=2 ;; + TERM) signal=15 ;; + esac + + # do our work + rm -fr "${__shunit_tmpDir}" + + # exit for all non-EXIT signals + if [ ${name} != 'EXIT' ]; then + echo "trapped and now handling the ${name} signal" >&2 + _shunit_generateReport + # disable EXIT trap + trap 0 + # add 128 to signal and exit + exit `expr ${signal} + 128` + fi +} + +_shunit_execSuite() +{ + echo '#' + echo '# Performing tests' + echo '#' + for _su_func in ${__shunit_suite}; do + # execute the per-test setup function + setUp + + # execute the test + echo "${_su_func}" + eval ${_su_func} + + # execute the per-test tear-down function + tearDown + done + + unset _su_func +} + +_shunit_functionExists() +{ + _su__func=$1 + type ${_su__func} 2>/dev/null |grep "is a function$" >/dev/null + _su__return=$? + unset _su__func + return ${_su__return} +} + +_shunit_generateReport() +{ + _su__awkPercent='{printf("%0.0f%%", $1*100/$2)}' + if [ ${__shunit_testsTotal} -gt 0 ]; then + _su__success=`echo ${__shunit_testsPassed} ${__shunit_testsTotal} |\ + awk "${_su__awkPercent}"` + else + _su__success=0 + fi + + cat <<EOF + +# +# Test report +# +tests passed: ${__shunit_testsPassed} +tests failed: ${__shunit_testsFailed} +tests total: ${__shunit_testsTotal} +success rate: ${_su__success} +EOF + + unset _su__success +} + +# this function is a cross-platform temporary directory creation tool. not all +# OSes have the mktemp function, so one is included here. +_shunit_mktempDir() +{ + # try the standard mktemp function + ( exec mktemp -dqt shunit.XXXXXX 2>/dev/null ) && return + + # the standard mktemp didn't work. doing our own. + if [ -r '/dev/urandom' -a -x '/usr/bin/od' ]; then + _su__random=`/usr/bin/od -vAn -N4 -tx4 </dev/urandom \ + |sed 's/^[^0-9a-f]*//'` + elif [ -n "${RANDOM:-}" ]; then + # $RANDOM works + _su__random=${RANDOM}${RANDOM}${RANDOM}$$ + else + # $RANDOM doesn't work + _su__date=`date '+%Y%m%d%H%M%S'` + _su__random=`expr ${_su__date} / $$` + fi + + _su__tmpDir="${TMPDIR-/tmp}/shunit.${_su__random}" + ( umask 077 && mkdir "${_su__tmpDir}" ) || { + echo 'shUnit:FATAL could not create temporary directory! exiting' >&2 + return ${__SHUNIT_ERROR} + } + + echo ${_su__tmpDir} + unset _su__date _su__random _su__tmpDir +} + +# this function is here to work around issues in Cygwin +_shunit_mktempFunc() +{ + for _su__func in oneTimeSetUp oneTimeTearDown setUp tearDown suite; do + _su__file="${__shunit_tmpDir}/${_su__func}" + cat <<EOF >"${_su__file}" +#! /bin/sh +exit 0 +EOF + chmod +x "${_su__file}" + done + + unset _su__file +} + +_shunit_testPassed() +{ + __shunit_testsPassed=`expr ${__shunit_testsPassed} + 1` + __shunit_testsTotal=`expr ${__shunit_testsTotal} + 1` +} + +_shunit_testFailed() +{ + _su__msg=$1 + + __shunit_testsFailed=`expr ${__shunit_testsFailed} + 1` + __shunit_testsTotal=`expr ${__shunit_testsTotal} + 1` + echo "${__SHUNIT_ASSERT_MSG_PREFIX}${_su__msg}" >&2 + + unset _su__msg +} + +#------------------------------------------------------------------------------ +# main +# + +# create a temporary storage location +__shunit_tmpDir=`_shunit_mktempDir` || exit ${__SHUNIT_ERROR} + +# setup traps to clean up after ourselves +trap '_shunit_cleanup EXIT' 0 +trap '_shunit_cleanup INT' 2 +trap '_shunit_cleanup TERM' 15 + +# create phantom functions to work around issues with Cygwin +_shunit_mktempFunc +PATH="${__shunit_tmpDir}:${PATH}" + +# execute the oneTimeSetUp function (if it exists) +#_shunit_functionExists oneTimeSetUp && oneTimeSetUp +oneTimeSetUp + +# deprecated: execute the suite function defined in the parent test script +suite + +# if no suite function was defined, dynamically build a list of functions +if [ -z "${__shunit_suite}" ]; then + funcs=`grep "^[ \t]*test[A-Za-z0-9_]* *()" $0 |sed 's/[^A-Za-z0-9_]//g'` + for func in ${funcs}; do + suite_addTest ${func} + done +fi + +# execute the tests +_shunit_execSuite + +# execute the oneTimeTearDown function (if it exists) +oneTimeTearDown + +# generate report +_shunit_generateReport + +# restore the previous set of shell flags +for _shunit_shellFlag in ${__SHUNIT_SHELL_FLAGS}; do + echo ${__shunit_oldShellFlags} |grep ${_shunit_shellFlag} >/dev/null \ + || set +${_shunit_shellFlag} +done +unset _shunit_shellFlag + +#/** +# </s:shelldoc> +#*/ diff --git a/contrib/shunit2-2.0.3/src/test/run-test-suite b/contrib/shunit2-2.0.3/src/test/run-test-suite new file mode 100755 index 0000000..7791fa1 --- /dev/null +++ b/contrib/shunit2-2.0.3/src/test/run-test-suite @@ -0,0 +1,116 @@ +#! /bin/sh +# $Id: run-test-suite 432 2007-01-05 14:58:37Z sfsetse $ + +MY_NAME=`basename $0` +MY_PATH=`dirname $0` + +SHELLS='/bin/sh /bin/bash /bin/dash /bin/ksh /bin/pdksh' +for f in test[A-Z]*; do + [ -x "${f}" ] && TESTS="${TESTS:+${TESTS} }${f}" +done + +# load common unit test functions +. "${MY_PATH}/test-functions.inc" + +usage() +{ + echo "usage: ${MY_NAME} [-e key=val ...] [-s shell(s)] [-t test(s)]" +} + +# process command line flags +while getopts 'e:hs:t:' opt; do + case ${opt} in + e) + key=`expr "${OPTARG}" : '\([^=]*\)='` + val=`expr "${OPTARG}" : '[^=]*=\(.*\)'` + if [ -z "${key}" -o -z "${val}" ]; then + usage + exit 1 + fi + eval "${key}='${val}'" + export ${key} + env="${env:+${env} }${key}" + ;; + h) usage; exit 0 ;; + s) shells=${OPTARG} ;; + t) tests=${OPTARG} ;; + *) usage; exit 1 ;; + esac +done +shift `expr ${OPTIND} - 1` + +# fill shells and/or tests +shells=${shells:-${SHELLS}} +tests=${tests:-${TESTS}} + +# error checking +if [ -z "${tests}" ]; then + tf_error 'no tests found to run; exiting' + exit 1 +fi + +cat <<EOF +#------------------------------------------------------------------------------ +# System data +# + +# test run info +shells="${shells}" +tests="${tests}" +EOF +for key in ${env}; do + eval "echo \"${key}=\$${key}\"" +done +echo + +# output system data +echo "# system info" +echo "$ date" +date + +echo "$ uname -mprsv" +uname -mprsv + +# +# run tests +# + +for shell in ${shells}; do + echo + + # check for existence of shell + if [ ! -x ${shell} ]; then + tf_warn "unable to run tests with the ${shell} shell" + continue + fi + + cat <<EOF + +#------------------------------------------------------------------------------ +# Running the test suite with ${shell} +# +EOF + + case `basename ${shell}` in + bash) echo; ${shell} --version; ;; + dash) ;; + ksh) + version=`${shell} --version exit 2>&1` + exitVal=$? + if [ ${exitVal} -eq 2 ]; then + echo + echo "${version}" + fi + ;; + pdksh) ;; + zsh) ;; + esac + + # execute the tests + for suite in ${tests}; do + suiteName=`expr "${suite}" : 'test\(.*\)'` + echo + echo "--- Executing the '${suiteName}' test suite ---" >&2 + ( exec ${shell} ./${suite}; ) + done +done diff --git a/contrib/shunit2-2.0.3/src/test/test-functions.inc b/contrib/shunit2-2.0.3/src/test/test-functions.inc new file mode 100644 index 0000000..fe7b3e9 --- /dev/null +++ b/contrib/shunit2-2.0.3/src/test/test-functions.inc @@ -0,0 +1,84 @@ +# $Id: test-functions.inc 416 2007-01-04 00:50:14Z sfsetse $ +# vim:syntax=sh:sts=2 + +# +# constants +# + +# configure debugging. set the DEBUG environment variable to any +# non-empty value to enable debug output, or TRACE to enable trace +# output. +TRACE=${TRACE:+'tf_trace '} +[ -n "${TRACE}" ] && DEBUG=1 +[ -z "${TRACE}" ] && TRACE=':' + +DEBUG=${DEBUG:+'tf_debug '} +[ -z "${DEBUG}" ] && DEBUG=':' + +# +# variables +# + +tf_RANDOM=0 + +# +# functions +# + +# message functions +tf_trace() { echo "${MY_NAME}:TRACE $@" >&2; } +tf_debug() { echo "${MY_NAME}:DEBUG $@" >&2; } +tf_info() { echo "${MY_NAME}:INFO $@" >&2; } +tf_warn() { echo "${MY_NAME}:WARN $@" >&2; } +tf_error() { echo "${MY_NAME}:ERROR $@" >&2; } +tf_fatal() { echo "${MY_NAME}:FATAL $@" >&2; } + +# generate a random number +tf_generateRandom() +{ + tfgr_random=${tf_RANDOM} + + while [ "${tfgr_random}" = "${tf_RANDOM}" ]; do + if [ -n "${RANDOM:-}" ]; then + # $RANDOM works + tfgr_random=${RANDOM}${RANDOM}${RANDOM}$$ + elif [ -r '/dev/urandom' ]; then + tfgr_random=`od -vAn -N4 -tu4 </dev/urandom |sed 's/^[^0-9]*//'` + else + tfgr_date=`date '+%H%M%S'` + tfgr_random=`expr ${tfgr_date} \* $$` + unset tfgr_date + fi + [ "${tfgr_random}" = "${tf_RANDOM}" ] && sleep 1 + done + + tf_RANDOM=${tfgr_random} + unset tfgr_random +} + +# this section returns the data section from the specified section of a file. a +# datasection is defined by a [header], one or more lines of data, and then a +# blank line. +tf_getDataSect() +{ + tf_sgrep "\\[$1\\]" "$2" |sed '1d' +} + +# this function greps a section from a file. a section is defined as a group of +# lines preceded and followed by blank lines. +tf_sgrep() +{ + tf_pattern=$1 + shift + + sed -e '/./{H;$!d;}' -e "x;/${tf_pattern}/"'!d;' $@ |sed '1d' + + unset tf_pattern +} + +# +# main +# + +${TRACE} 'trace output enabled' +${DEBUG} 'debug output enabled' diff --git a/contrib/shunit2-2.0.3/src/test/testAsserts b/contrib/shunit2-2.0.3/src/test/testAsserts new file mode 100755 index 0000000..12a3943 --- /dev/null +++ b/contrib/shunit2-2.0.3/src/test/testAsserts @@ -0,0 +1,242 @@ +#! /bin/sh +# $Id$ +# vim: expandtab +# author: Kate Ward <kate.ward@forestent.com> +# +# Self-testing unit tests for shUnit2 asserts +# + +MSG='This is a test message' + +#----------------------------------------------------------------------------- +# suite tests +# + +commonEqualsSame() +{ + fn=$1 + + msg='same, with message' + rslt=`${fn} "${MSG}" 'x' 'x' 2>&1` + rtrn=$? + assertSame "${msg}" '' "${rslt}" + assertTrue "${msg}; failure" ${rtrn} + + msg='same' + rslt=`${fn} 'x' 'x' 2>&1` + rtrn=$? + assertSame "${msg}" '' "${rslt}" + assertTrue "${msg}; failure" ${rtrn} + + msg='not same' + rslt=`${fn} 'x' 'y' 2>&1` + rtrn=$? + assertNotSame "${msg}" '' "${rslt}" + assertFalse "${msg}; failure" ${rtrn} + + msg='null values' + rslt=`${fn} '' '' 2>&1` + rtrn=$? + assertSame "${msg}" '' "${rslt}" + assertTrue "${msg}; failure" ${rtrn} + + msg='too few arguments' + rslt=`${fn} 2>&1` + rtrn=$? + assertNotSame "${msg}" '' "${rslt}" + assertFalse "${msg}; failure" ${rtrn} +} + +testAssertEquals() +{ + commonEqualsSame 'assertEquals' +} + +testAssertSame() +{ + commonEqualsSame 'assertSame' +} + +testAssertNotSame() +{ + msg='not same, with message' + rslt=`assertNotSame "${MSG}" 'x' 'y' 2>&1` + rtrn=$? + assertSame "${msg}" '' "${rslt}" + assertTrue "${msg}; failure" ${rtrn} + + msg='not same' + rslt=`assertNotSame 'x' 'y' 2>&1` + rtrn=$? + assertSame "${msg}" '' "${rslt}" + assertTrue "${msg}; failure" ${rtrn} + + msg='same' + rslt=`assertNotSame 'x' 'x' 2>&1` + rtrn=$? + assertNotSame "${msg}" '' "${rslt}" + assertFalse "${msg}; failure" ${rtrn} + + msg='null values' + rslt=`assertNotSame '' '' 2>&1` + rtrn=$? + assertNotSame "${msg}" '' "${rslt}" + assertFalse "${msg}; failure" ${rtrn} + + msg='too few arguments' + rslt=`assertNotSame 2>&1` + rtrn=$? + assertNotSame "${msg}" '' "${rslt}" + assertFalse "${msg}; failure" ${rtrn} +} + +testAssertNull() +{ + msg='null, with message' + rslt=`assertNull "${MSG}" '' 2>&1` + rtrn=$? + assertSame "${msg}" '' "${rslt}" + assertTrue "${msg}; failure" ${rtrn} + + msg='null' + rslt=`assertNull '' 2>&1` + rtrn=$? + assertSame "${msg}" '' "${rslt}" + assertTrue "${msg}; failure" ${rtrn} + + msg='not null' + rslt=`assertNull 'x' 2>&1` + rtrn=$? + assertNotSame "${msg}" '' "${rslt}" + assertFalse "${msg}; failure" ${rtrn} + + msg='too few arguments' + rslt=`assertNull 2>&1` + rtrn=$? + assertNotSame "${msg}" '' "${rslt}" + assertFalse "${msg}; failure" ${rtrn} +} + +testAssertNotNull() +{ + msg='not null, with message' + rslt=`assertNotNull "${MSG}" 'x' 2>&1` + rtrn=$? + assertSame "${msg}" '' "${rslt}" + assertTrue "${msg}; failure" ${rtrn} + + msg='not null' + rslt=`assertNotNull 'x' 2>&1` + rtrn=$? + assertSame "${msg}" '' "${rslt}" + assertTrue "${msg}; failure" ${rtrn} + + msg='null' + rslt=`assertNotNull '' 2>&1` + rtrn=$? + assertNotSame "${msg}" '' "${rslt}" + assertFalse "${msg}; failure" ${rtrn} + + msg='too few arguments' + rslt=`assertNotNull 2>&1` + rtrn=$? + assertNotSame "${msg}" '' "${rslt}" + assertFalse "${msg}; failure" ${rtrn} +} + +testAssertTrue() +{ + msg='true, with message' + rslt=`assertTrue "${MSG}" 0 2>&1` + rtrn=$? + assertSame "${msg}" '' "${rslt}" + assertTrue "${msg}; failure" ${rtrn} + + msg='true' + rslt=`assertTrue 0 2>&1` + rtrn=$? + assertSame "${msg}" '' "${rslt}" + assertTrue "${msg}; failure" ${rtrn} + + msg='true condition' + rslt=`assertTrue "[ 0 -eq 0 ]" 2>&1` + rtrn=$? + assertSame "${msg}" '' "${rslt}" + assertTrue "${msg}; failure" ${rtrn} + + msg='false' + rslt=`assertTrue 1 2>&1` + rtrn=$? + assertNotSame "${msg}" '' "${rslt}" + assertFalse "${msg}; failure" ${rtrn} + + msg='false condition' + rslt=`assertTrue "[ 0 -eq 1 ]" 2>&1` + rtrn=$? + assertNotSame "${msg}" '' "${rslt}" + assertFalse "${msg}; failure" ${rtrn} + + msg='null value' + rslt=`assertTrue '' 2>&1` + rtrn=$? + assertNotSame "${msg}" '' "${rslt}" + assertFalse "${msg}; failure" ${rtrn} + + msg='too few arguments' + rslt=`assertTrue 2>&1` + rtrn=$? + assertNotSame "${msg}" '' "${rslt}" + assertFalse "${msg}; failure" ${rtrn} +} + +testAssertFalse() +{ + msg='false, with message' + rslt=`assertFalse "${MSG}" 1 2>&1` + rtrn=$? + assertSame "${msg}" '' "${rslt}" + assertTrue "${msg}; failure" ${rtrn} + + msg='false' + rslt=`assertFalse 1 2>&1` + rtrn=$? + assertSame "${msg}" '' "${rslt}" + assertTrue "${msg}; failure" ${rtrn} + + msg='false condition' + rslt=`assertFalse "[ 0 -eq 1 ]" 2>&1` + rtrn=$? + assertSame "${msg}" '' "${rslt}" + assertTrue "${msg}; failure" ${rtrn} + + msg='true' + rslt=`assertFalse 0 2>&1` + rtrn=$? + assertNotSame "${msg}" '' "${rslt}" + assertFalse "${msg}; failure" ${rtrn} + + msg='true condition' + rslt=`assertFalse "[ 0 -eq 0 ]" 2>&1` + rtrn=$? + assertNotSame "${msg}" '' "${rslt}" + assertFalse "${msg}; failure" ${rtrn} + + msg='null value' + rslt=`assertFalse '' 2>&1` + rtrn=$? + assertNotSame "${msg}" '' "${rslt}" + assertFalse "${msg}; failure" ${rtrn} + + msg='too few arguments' + rslt=`assertFalse 2>&1` + rtrn=$? + assertNotSame "${msg}" '' "${rslt}" + assertFalse "${msg}; failure" ${rtrn} +} + +#----------------------------------------------------------------------------- +# suite functions +# + +# load and run shUnit2 +. ./shunit2 diff --git a/contrib/shunit2-2.0.3/src/test/testFailures b/contrib/shunit2-2.0.3/src/test/testFailures new file mode 100755 index 0000000..9410510 --- /dev/null +++ b/contrib/shunit2-2.0.3/src/test/testFailures @@ -0,0 +1,89 @@ +#! /bin/sh +# $Id$ +# vim: expandtab +# author: Kate Ward <kate.ward@forestent.com> +# +# Self-testing unit tests for shUnit2 failures +# + +MSG='This is a test message' + +#----------------------------------------------------------------------------- +# suite tests +# + +commonNotEqualsSame() +{ + fn=$1 + + msg='same, with message' + rslt=`${fn} "${MSG}" 'x' 'x' 2>&1` + assertNotSame "${msg}" '' "${rslt}" + + msg='same' + rslt=`${fn} 'x' 'x' 2>&1` + assertNotSame "${msg}" '' "${rslt}" + + msg='not same' + rslt=`${fn} 'x' 'y' 2>&1` + assertNotSame "${msg}" '' "${rslt}" + + msg='null values' + rslt=`${fn} '' '' 2>&1` + assertNotSame "${msg}" '' "${rslt}" + + msg='too few arguments' + rslt=`${fn} 2>&1` + assertNotSame "${msg}" '' "${rslt}" +} + +testFail() +{ + msg='with message' + rslt=`fail "${MSG}" 2>&1` + assertNotSame "${msg}" '' "${rslt}" + + msg='without message' + rslt=`fail 2>&1` + assertNotSame "${msg}" '' "${rslt}" +} + +testFailNotEquals() +{ + commonNotEqualsSame 'failNotEquals' +} + +testFailSame() +{ + msg='same, with message' + rslt=`failSame "${MSG}" 'x' 'x' 2>&1` + assertNotSame "${msg}" '' "${rslt}" + + msg='same' + rslt=`failSame 'x' 'x' 2>&1` + assertNotSame "${msg}" '' "${rslt}" + + msg='not same' + rslt=`failSame 'x' 'y' 2>&1` + assertNotSame "${msg}" '' "${rslt}" + + msg='null values' + rslt=`failSame '' '' 2>&1` + assertNotSame "${msg}" '' "${rslt}" + + msg='too few arguments' + rslt=`failSame 2>&1` + assertNotSame "${msg}" '' "${rslt}" +} + +testFailNotSame() +{ + commonNotEqualsSame 'failNotSame' +} + +#----------------------------------------------------------------------------- +# suite functions +# + +# load and run shUnit2 +. ./shunit2 diff --git a/contrib/shunit2-2.0.3/src/test/testInternalFx b/contrib/shunit2-2.0.3/src/test/testInternalFx new file mode 100755 index 0000000..9409dc2 --- /dev/null +++ b/contrib/shunit2-2.0.3/src/test/testInternalFx @@ -0,0 +1,23 @@ +#! /bin/sh +# $Id$ +# vim: expandtab +# author: Kate Ward <kate.ward@forestent.com> +# +# Self-testing unit tests for shUnit2 internal functions +# + +#----------------------------------------------------------------------------- +# suite tests +# + +testGenerateReport() +{ + : +} + +#----------------------------------------------------------------------------- +# suite functions +# + +# load and run shUnit2 +. ./shunit2 diff --git a/contrib/shunit2-2.0.3/src/test/testSuiteFx b/contrib/shunit2-2.0.3/src/test/testSuiteFx new file mode 100755 index 0000000..c0e6ab8 --- /dev/null +++ b/contrib/shunit2-2.0.3/src/test/testSuiteFx @@ -0,0 +1,23 @@ +#! /bin/sh +# $Id$ +# vim: expandtab +# author: Kate Ward <kate.ward@forestent.com> +# +# Self-testing unit tests for shUnit2 suite functions +# + +#----------------------------------------------------------------------------- +# suite tests +# + +testAddTest() +{ + : +} + +#----------------------------------------------------------------------------- +# suite functions +# + +# load and run shUnit2 +. ./shunit2 |