mirror of https://github.com/deajan/osync
Updated shunit test framework
deajan
6 years ago
parent
82e60bdffe
commit
cf609998aa
@ -0,0 +1,46 @@
|
||||
# Contributor Covenant Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to creating a positive environment include:
|
||||
|
||||
* Using welcoming and inclusive language
|
||||
* Being respectful of differing viewpoints and experiences
|
||||
* Gracefully accepting constructive criticism
|
||||
* Focusing on what is best for the community
|
||||
* Showing empathy towards other community members
|
||||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
|
||||
* The use of sexualized language or imagery and unwelcome sexual attention or advances
|
||||
* Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or electronic address, without explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a professional setting
|
||||
|
||||
## Our Responsibilities
|
||||
|
||||
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
|
||||
|
||||
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at kate.ward@forestent.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
|
||||
|
||||
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
|
||||
|
||||
[homepage]: http://contributor-covenant.org
|
||||
[version]: http://contributor-covenant.org/version/1/4/
|
||||
@ -0,0 +1,201 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "{}"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright {yyyy} {name of copyright owner}
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
@ -0,0 +1,434 @@
|
||||
# shUnit2
|
||||
|
||||
shUnit2 is a [xUnit](http://en.wikipedia.org/wiki/XUnit) unit test framework for Bourne based shell scripts, and it is designed to work in a similar manner to [JUnit](http://www.junit.org), [PyUnit](http://pyunit.sourceforge.net), etc.. If you have ever had the desire to write a unit test for a shell script, shUnit2 can do the job.
|
||||
|
||||
[](https://travis-ci.org/kward/shunit2)
|
||||
|
||||
## Table of Contents
|
||||
* [Introduction](#introduction)
|
||||
* [Credits / Contributors](#credits-contributors)
|
||||
* [Feedback](#feedback)
|
||||
* [Quickstart](#quickstart)
|
||||
* [Function Reference](#function-reference)
|
||||
* [General Info](#general-info)
|
||||
* [Asserts](#asserts)
|
||||
* [Failures](#failures)
|
||||
* [Setup/Teardown](#setup-teardown)
|
||||
* [Skipping](#skipping)
|
||||
* [Suites](#suites)
|
||||
* [Advanced Usage](#advanced-usage)
|
||||
* [Some constants you can use](#some-constants-you-can-use)
|
||||
* [Error Handling](#error-handling)
|
||||
* [Including Line Numbers in Asserts (Macros)](#including-line-numbers-in-asserts-macros)
|
||||
* [Test Skipping](#test-skipping)
|
||||
* [Appendix](#appendix)
|
||||
* [Getting help](#getting-help)
|
||||
* [Zsh](#zsh)
|
||||
|
||||
---
|
||||
## <a name="introduction"></a> Introduction
|
||||
shUnit2 was originally developed to provide a consistent testing solution for [log4sh][log4sh], a shell based logging framework similar to [log4j](http://logging.apache.org). During the development of that product, a repeated problem of having things work just fine under one shell (`/bin/bash` on Linux to be specific), and then not working under another shell (`/bin/sh` on Solaris) kept coming up. Although several simple tests were run, they were not adequate and did not catch some corner cases. The decision was finally made to write a proper unit test framework after multiple brown-bag releases were made. _Research was done to look for an existing product that met the testing requirements, but no adequate product was found._
|
||||
|
||||
Tested Operating Systems (varies over time)
|
||||
|
||||
* Cygwin
|
||||
* FreeBSD (user supported)
|
||||
* Linux (Gentoo, Ubuntu)
|
||||
* Mac OS X
|
||||
* Solaris 8, 9, 10 (inc. OpenSolaris)
|
||||
|
||||
Tested Shells
|
||||
|
||||
* Bourne Shell (__sh__)
|
||||
* BASH - GNU Bourne Again SHell (__bash__)
|
||||
* DASH (__dash__)
|
||||
* Korn Shell (__ksh__)
|
||||
* pdksh - Public Domain Korn Shell (__pdksh__)
|
||||
* zsh - Zsh (__zsh__) (since 2.1.2) _please see the Zsh shell errata for more information_
|
||||
|
||||
See the appropriate Release Notes for this release (`doc/RELEASE_NOTES-X.X.X.txt`) for the list of actual versions tested.
|
||||
|
||||
### <a name="credits-contributors"></a> Credits / Contributors
|
||||
A list of contributors to shUnit2 can be found in `doc/contributors.md`. Many thanks go out to all those who have contributed to make this a better tool.
|
||||
|
||||
shUnit2 is the original product of many hours of work by Kate Ward, the primary author of the code. For related software, check out https://github.com/kward.
|
||||
|
||||
### <a name="feedback"></a> Feedback
|
||||
Feedback is most certainly welcome for this document. Send your additions, comments and criticisms to the shunit2-users@google.com mailing list.
|
||||
|
||||
---
|
||||
|
||||
## <a name="quickstart"></a> Quickstart
|
||||
This section will give a very quick start to running unit tests with shUnit2. More information is located in later sections.
|
||||
|
||||
Here is a quick sample script to show how easy it is to write a unit test in shell. _Note: the script as it stands expects that you are running it from the "examples" directory._
|
||||
|
||||
```sh
|
||||
#! /bin/sh
|
||||
# file: examples/equality_test.sh
|
||||
|
||||
testEquality() {
|
||||
assertEquals 1 1
|
||||
}
|
||||
|
||||
# Load shUnit2.
|
||||
. ./shunit2
|
||||
```
|
||||
|
||||
Running the unit test should give results similar to the following.
|
||||
|
||||
```console
|
||||
$ cd examples
|
||||
$ ./equality_test.sh
|
||||
testEquality
|
||||
|
||||
Ran 1 test.
|
||||
|
||||
OK
|
||||
```
|
||||
|
||||
W00t! 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` library. The basic functionality for the script above goes like this:
|
||||
|
||||
* When shUnit2 is sourced, it will walk through any functions defined whose name starts with the string `test`, and add 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.
|
||||
* Before any tests are executed, shUnit2 again looks for a function, this time one named `oneTimeSetUp()`. 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 `oneTimeTearDown()` function that does the same thing, but once all the tests have been completed. It is good for removing temporary directories, etc.
|
||||
* shUnit2 is now ready to run tests. Before doing so though, it again looks for another function that might be declared, one named `setUp()`. 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 `tearDown()`. 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.
|
||||
* 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.
|
||||
|
||||
We should now try adding a test that fails. Change your unit test to look like this.
|
||||
|
||||
```sh
|
||||
#! /bin/sh
|
||||
# file: examples/party_test.sh
|
||||
|
||||
testEquality() {
|
||||
assertEquals 1 1
|
||||
}
|
||||
|
||||
testPartyLikeItIs1999() {
|
||||
year=`date '+%Y'`
|
||||
assertEquals "It's not 1999 :-(" '1999' "${year}"
|
||||
}
|
||||
|
||||
# Load shUnit2.
|
||||
. ./shunit2
|
||||
```
|
||||
|
||||
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.
|
||||
|
||||
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 [log4sh][log4sh] or [shFlags][shflags]. Both provide excellent examples of more advanced usage. shUnit2 was after all written to meet the unit testing need that [log4sh][log4sh] had.
|
||||
|
||||
---
|
||||
|
||||
## <a name="function-reference"></a> Function Reference
|
||||
|
||||
### <a name="general-info"></a> General Info
|
||||
|
||||
Any string values passed should be properly quoted -- they should must be surrounded by single-quote (`'`) or double-quote (`"`) characters -- so that the shell will properly parse them.
|
||||
|
||||
### <a name="asserts"></a> Asserts
|
||||
|
||||
`assertEquals [message] expected actual`
|
||||
|
||||
Asserts that _expected_ and _actual_ are equal to one another. The _expected_ and _actual_ values can be either strings or integer values as both will be treated as strings. The _message_ is optional, and must be quoted.
|
||||
|
||||
`assertNotEquals [message] unexpected actual`
|
||||
|
||||
Asserts that _unexpected_ and _actual_ are not equal to one another. The _unexpected_ and _actual_ values can be either strings or integer values as both will be treaded as strings. The _message_ is optional, and must be quoted.
|
||||
|
||||
`assertSame [message] expected actual`
|
||||
|
||||
This function is functionally equivalent to `assertEquals`.
|
||||
|
||||
`assertNotSame [message] unexpected actual`
|
||||
|
||||
This function is functionally equivalent to `assertNotEquals`.
|
||||
|
||||
`assertNull [message] value`
|
||||
|
||||
Asserts that _value_ is _null_, or in shell terms, a zero-length string. The _value_ must be a string as an integer value does not translate into a zero-length string. The _message_ is optional, and must be quoted.
|
||||
|
||||
`assertNotNull [message] value`
|
||||
|
||||
Asserts that _value_ is _not null_, or in shell terms, a non-empty string. The _value_ may be a string or an integer as the later will be parsed as a non-empty string value. The _message_ is optional, and must be quoted.
|
||||
|
||||
`assertTrue [message] condition`
|
||||
|
||||
Asserts that a given shell test _condition_ is _true_. The condition can be as simple as a shell _true_ value (the value `0` -- equivalent to `${SHUNIT_TRUE}`), or a more sophisticated shell conditional expression. The _message_ is optional, and must be quoted.
|
||||
|
||||
A sophisticated shell conditional expression is equivalent to what the __if__ or __while__ shell built-ins would use (more specifically, what the __test__ command would use). Testing for example whether some value is greater than another value can be done this way.
|
||||
|
||||
`assertTrue "[ 34 -gt 23 ]"`
|
||||
|
||||
Testing for the ability to read a file can also be done. This particular test will fail.
|
||||
|
||||
`assertTrue 'test failed' "[ -r /some/non-existant/file' ]"`
|
||||
|
||||
As the expressions are standard shell __test__ expressions, it is possible to string multiple expressions together with `-a` and `-o` in the standard fashion. This test will succeed as the entire expression evaluates to _true_.
|
||||
|
||||
`assertTrue 'test failed' '[ 1 -eq 1 -a 2 -eq 2 ]'`
|
||||
|
||||
_One word of warning: be very careful with your quoting as shell is not the most forgiving of bad quoting, and things will fail in strange ways._
|
||||
|
||||
`assertFalse [message] condition`
|
||||
|
||||
Asserts that a given shell test _condition_ is _false_. The condition can be as simple as a shell _false_ value (the value `1` -- equivalent to `${SHUNIT_FALSE}`), or a more sophisticated shell conditional expression. The _message_ is optional, and must be quoted.
|
||||
|
||||
_For examples of more sophisticated expressions, see `assertTrue`._
|
||||
|
||||
### <a name="failures"></a> Failures
|
||||
|
||||
Just to clarify, failures __do not__ test the various arguments against one another. Failures simply fail, optionally with a message, and that is all they do. If you need to test arguments against one another, use asserts.
|
||||
|
||||
If all failures do is fail, why might one use them? There are times when you may have some very complicated logic that you need to test, and the simple asserts provided are simply not adequate. You can do your own validation of the code, use an `assertTrue ${SHUNIT_TRUE}` if your own tests succeeded, and use a failure to record a failure.
|
||||
|
||||
`fail [message]`
|
||||
|
||||
Fails the test immediately. The _message_ is optional, and must be quoted.
|
||||
|
||||
`failNotEquals [message] unexpected actual`
|
||||
|
||||
Fails the test immediately, reporting that the _unexpected_ and _actual_ values are not equal to one another. The _message_ is optional, and must be quoted.
|
||||
|
||||
_Note: no actual comparison of unexpected and actual is done._
|
||||
|
||||
`failSame [message] expected actual`
|
||||
|
||||
Fails the test immediately, reporting that the _expected_ and _actual_ values are the same. The _message_ is optional, and must be quoted.
|
||||
|
||||
_Note: no actual comparison of expected and actual is done._
|
||||
|
||||
`failNotSame [message] expected actual`
|
||||
|
||||
Fails the test immediately, reporting that the _expected_ and _actual_ values are not the same. The _message_ is optional, and must be quoted.
|
||||
|
||||
_Note: no actual comparison of expected and actual is done._
|
||||
|
||||
### <a name="setup-teardown"></a> Setup/Teardown
|
||||
|
||||
`oneTimeSetUp`
|
||||
|
||||
This function can be be optionally overridden by the user in their test suite.
|
||||
|
||||
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.
|
||||
|
||||
`oneTimeTearDown`
|
||||
|
||||
This function can be be optionally overridden by the user in their test suite.
|
||||
|
||||
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.
|
||||
|
||||
`setUp`
|
||||
|
||||
This function can be be optionally overridden by the user in their test suite.
|
||||
|
||||
If this function exists, it will be called before each test is run. It is useful to reset the environment before each test.
|
||||
|
||||
`tearDown`
|
||||
|
||||
This function can be be optionally overridden by the user in their test suite.
|
||||
|
||||
If this function exists, it will be called after each test completes. It is useful to clean up the environment after each test.
|
||||
|
||||
### <a name="skipping"></a> Skipping
|
||||
|
||||
`startSkipping`
|
||||
|
||||
This function forces the remaining _assert_ and _fail_ functions to be "skipped", i.e. they will have no effect. Each function skipped will be recorded so that the total of asserts and fails will not be altered.
|
||||
|
||||
`endSkipping`
|
||||
|
||||
This function returns calls to the _assert_ and _fail_ functions to their default behavior, i.e. they will be called.
|
||||
|
||||
`isSkipping`
|
||||
|
||||
This function returns the current state of skipping. It can be compared against `${SHUNIT_TRUE}` or `${SHUNIT_FALSE}` if desired.
|
||||
|
||||
### <a name="suites"></a> Suites
|
||||
|
||||
The default behavior of shUnit2 is that all tests will be found dynamically. If you have a specific set of tests you want to run, or you don't want to use the standard naming scheme of prefixing your tests with `test`, these functions are for you. Most users will never use them though.
|
||||
|
||||
`suite`
|
||||
|
||||
This function can be optionally overridden by the user in their test suite.
|
||||
|
||||
If this function exists, it will be called when `shunit2` is sourced. If it does not exist, shUnit2 will search the parent script for all functions beginning with the word `test`, and they will be added dynamically to the test suite.
|
||||
|
||||
`suite_addTest name`
|
||||
|
||||
This function adds a function named _name_ to the list of tests scheduled for execution as part of this test suite. This function should only be called from within the `suite()` function.
|
||||
|
||||
---
|
||||
|
||||
## <a name="advanced-usage"></a> Advanced Usage
|
||||
|
||||
### <a name="some-constants-you-can-use"></a> Some constants you can use
|
||||
|
||||
There are several constants provided by shUnit2 as variables that might be of use to you.
|
||||
|
||||
*Predefined*
|
||||
|
||||
| Constant | Value |
|
||||
| --------------- | ----- |
|
||||
| SHUNIT\_TRUE | Standard shell `true` value (the integer value 0). |
|
||||
| SHUNIT\_FALSE | Standard shell `false` value (the integer value 1). |
|
||||
| SHUNIT\_ERROR | The integer value 2. |
|
||||
| SHUNIT\_TMPDIR | Path to temporary directory that will be automatically cleaned up upon exit of shUnit2. |
|
||||
| SHUNIT\_VERSION | The version of shUnit2 you are running. |
|
||||
|
||||
*User defined*
|
||||
|
||||
| Constant | Value |
|
||||
| ----------------- | ----- |
|
||||
| SHUNIT\_CMD\_EXPR | Override which `expr` command is used. By default `expr` is used, except on BSD systems where `gexpr` is used. |
|
||||
| SHUNIT\_COLOR | Enable colorized output. Options are 'auto', 'always', or 'never', with 'auto' being the default. |
|
||||
| SHUNIT\_PARENT | The filename of the shell script containing the tests. This is needed specifically for Zsh support. |
|
||||
| SHUNIT\_TEST\_PREFIX | Define this variable to add a prefix in front of each test name that is output in the test report. |
|
||||
|
||||
### <a name="error-handling"></a> Error handling
|
||||
|
||||
The constants values `SHUNIT_TRUE`, `SHUNIT_FALSE`, and `SHUNIT_ERROR` are returned from nearly every function to indicate the success or failure of the function. Additionally the variable `flags_error` is filled with a detailed error message if any function returns with a `SHUNIT_ERROR` value.
|
||||
|
||||
### <a name="including-line-numbers-in-asserts-macros"></a> Including Line Numbers in Asserts (Macros)
|
||||
|
||||
If you include lots of assert statements in an individual test function, it can become difficult to determine exactly which assert was thrown unless your messages are unique. To help somewhat, line numbers can be included in the assert messages. To enable this, a special shell "macro" must be used rather than the standard assert calls. _Shell doesn't actually have macros; the name is used here as the operation is similar to a standard macro._
|
||||
|
||||
For example, to include line numbers for a `assertEquals()` function call, replace the `assertEquals()` with `${_ASSERT_EQUALS_}`.
|
||||
|
||||
_**Example** -- Asserts with and without line numbers_
|
||||
```sh
|
||||
#! /bin/sh
|
||||
# file: examples/lineno_test.sh
|
||||
|
||||
testLineNo() {
|
||||
# This assert will have line numbers included (e.g. "ASSERT:[123] ...").
|
||||
echo "ae: ${_ASSERT_EQUALS_}"
|
||||
${_ASSERT_EQUALS_} 'not equal' 1 2
|
||||
|
||||
# This assert will not have line numbers included (e.g. "ASSERT: ...").
|
||||
assertEquals 'not equal' 1 2
|
||||
}
|
||||
|
||||
# Load shUnit2.
|
||||
. ./shunit2
|
||||
```
|
||||
|
||||
Notes:
|
||||
|
||||
1. Due to how shell parses command-line arguments, all strings used with macros should be quoted twice. Namely, single-quotes must be converted to single-double-quotes, and vice-versa. If the string being passed is absolutely for sure not empty, the extra quoting is not necessary.<br/><br/>Normal `assertEquals` call.<br/>`assertEquals 'some message' 'x' ''`<br/><br/>Macro `_ASSERT_EQUALS_` call. Note the extra quoting around the _message_ and the _null_ value.<br/>`_ASSERT_EQUALS_ '"some message"' 'x' '""'`
|
||||
|
||||
1. Line numbers are not supported in all shells. If a shell does not support them, no errors will be thrown. Supported shells include: __bash__ (>=3.0), __ksh__, __pdksh__, and __zsh__.
|
||||
|
||||
### <a name="test-skipping"></a> Test Skipping
|
||||
|
||||
There are times where the test code you have written is just not applicable to the system you are running on. This section describes how to skip these tests but maintain the total test count.
|
||||
|
||||
Probably the easiest example would be shell code that is meant to run under the __bash__ shell, but the unit test is running under the Bourne shell. There are things that just won't work. The following test code demonstrates two sample functions, one that will be run under any shell, and the another that will run only under the __bash__ shell.
|
||||
|
||||
_**Example** -- math include_
|
||||
```sh
|
||||
# file: examples/math.inc.
|
||||
|
||||
add_generic() {
|
||||
num_a=$1
|
||||
num_b=$2
|
||||
|
||||
expr $1 + $2
|
||||
}
|
||||
|
||||
add_bash() {
|
||||
num_a=$1
|
||||
num_b=$2
|
||||
|
||||
echo $(($1 + $2))
|
||||
}
|
||||
```
|
||||
|
||||
And here is a corresponding unit test that correctly skips the `add_bash()` function when the unit test is not running under the __bash__ shell.
|
||||
|
||||
_**Example** -- math unit test_
|
||||
```sh
|
||||
#! /bin/sh
|
||||
# file: examples/math_test.sh
|
||||
|
||||
testAdding() {
|
||||
result=`add_generic 1 2`
|
||||
assertEquals \
|
||||
"the result of '${result}' was wrong" \
|
||||
3 "${result}"
|
||||
|
||||
# Disable non-generic tests.
|
||||
[ -z "${BASH_VERSION:-}" ] && startSkipping
|
||||
|
||||
result=`add_bash 1 2`
|
||||
assertEquals \
|
||||
"the result of '${result}' was wrong" \
|
||||
3 "${result}"
|
||||
}
|
||||
|
||||
oneTimeSetUp() {
|
||||
# Load include to test.
|
||||
. ./math.inc
|
||||
}
|
||||
|
||||
# Load and run shUnit2.
|
||||
. ./shunit2
|
||||
```
|
||||
|
||||
Running the above test under the __bash__ shell will result in the following output.
|
||||
|
||||
```console
|
||||
$ /bin/bash math_test.sh
|
||||
testAdding
|
||||
|
||||
Ran 1 test.
|
||||
|
||||
OK
|
||||
```
|
||||
|
||||
But, running the test under any other Unix shell will result in the following output.
|
||||
|
||||
```console
|
||||
$ /bin/ksh math_test.sh
|
||||
testAdding
|
||||
|
||||
Ran 1 test.
|
||||
|
||||
OK (skipped=1)
|
||||
```
|
||||
|
||||
As you can see, the total number of tests has not changed, but the report indicates that some tests were skipped.
|
||||
|
||||
Skipping can be controlled with the following functions: `startSkipping()`, `endSkipping()`, and `isSkipping()`. Once skipping is enabled, it will remain enabled until the end of the current test function call, after which skipping is disabled.
|
||||
|
||||
---
|
||||
|
||||
## <a name="appendix"></a> Appendix
|
||||
|
||||
### <a name="getting-help"></a> Getting Help
|
||||
|
||||
For help, please send requests to either the shunit2-users@googlegroups.com mailing list (archives available on the web at http://groups.google.com/group/shunit2-users) or directly to Kate Ward <kate dot ward at forestent dot com>.
|
||||
|
||||
### <a name="zsh"></a> Zsh
|
||||
|
||||
For compatibility with Zsh, there is one requirement that must be met -- the `shwordsplit` option must be set. There are three ways to accomplish this.
|
||||
|
||||
1. In the unit-test script, add the following shell code snippet before sourcing the `shunit2` library.
|
||||
|
||||
```sh
|
||||
setopt shwordsplit
|
||||
```
|
||||
|
||||
1. When invoking __zsh__ from either the command-line or as a script with `#!`, add the `-y` parameter.
|
||||
|
||||
```sh
|
||||
#! /bin/zsh -y
|
||||
```
|
||||
|
||||
1. When invoking __zsh__ from the command-line, add `-o shwordsplit --` as parameters before the script name.
|
||||
|
||||
```console
|
||||
$ zsh -o shwordsplit -- some_script
|
||||
```
|
||||
|
||||
[log4sh]: https://github.com/kward/log4sh
|
||||
[shflags]: https://github.com/kward/shflags
|
||||
@ -0,0 +1,88 @@
|
||||
#! /bin/sh
|
||||
# vim:et:ft=sh:sts=2:sw=2
|
||||
#
|
||||
# This script runs the provided unit tests and sends the output to the
|
||||
# appropriate file.
|
||||
#
|
||||
# Copyright 2008-2017 Kate Ward. All Rights Reserved.
|
||||
# Released under the Apache 2.0 license.
|
||||
#
|
||||
# Author: kate.ward@forestent.com (Kate Ward)
|
||||
# https://github.com/kward/shunit2
|
||||
#
|
||||
# Source following.
|
||||
# shellcheck disable=SC1090,SC1091
|
||||
# FLAGS variables are dynamically created.
|
||||
# shellcheck disable=SC2154
|
||||
# Disagree with [ p ] && [ q ] vs [ p -a -q ] recommendation.
|
||||
# shellcheck disable=SC2166
|
||||
|
||||
# Treat unset variables as an error.
|
||||
set -u
|
||||
|
||||
die() {
|
||||
[ $# -gt 0 ] && echo "error: $*" >&2
|
||||
exit 1
|
||||
}
|
||||
|
||||
BASE_DIR=$(dirname "$0")
|
||||
LIB_DIR="${BASE_DIR}/lib"
|
||||
|
||||
### Load libraries.
|
||||
. "${LIB_DIR}/shflags" || die 'unable to load shflags library'
|
||||
. "${LIB_DIR}/shlib" || die 'unable to load shlib library'
|
||||
. "${LIB_DIR}/versions" || die 'unable to load versions library'
|
||||
|
||||
# Redefining BASE_DIR now that we have the shlib functions. We need BASE_DIR so
|
||||
# that we can properly load things, even in the event that this script is called
|
||||
# from a different directory.
|
||||
BASE_DIR=$(shlib_relToAbsPath "${BASE_DIR}")
|
||||
|
||||
# Define flags.
|
||||
os_name=$(versions_osName |sed 's/ /_/g')
|
||||
os_version=$(versions_osVersion)
|
||||
|
||||
DEFINE_boolean force false 'force overwrite' f
|
||||
DEFINE_string output_dir "${TMPDIR}" 'output dir' d
|
||||
DEFINE_string output_file "${os_name}-${os_version}.txt" 'output file' o
|
||||
DEFINE_string runner 'test_runner' 'unit test runner' r
|
||||
DEFINE_boolean dry_run false "suppress logging to a file" n
|
||||
|
||||
main() {
|
||||
# Determine output filename.
|
||||
# shellcheck disable=SC2154
|
||||
output="${FLAGS_output_dir:+${FLAGS_output_dir}/}${FLAGS_output_file}"
|
||||
output=$(shlib_relToAbsPath "${output}")
|
||||
|
||||
# Checks.
|
||||
if [ "${FLAGS_dry_run}" -eq "${FLAGS_FALSE}" -a -f "${output}" ]; then
|
||||
if [ "${FLAGS_force}" -eq "${FLAGS_TRUE}" ]; then
|
||||
rm -f "${output}"
|
||||
else
|
||||
echo "not overwriting '${output}'" >&2
|
||||
exit "${FLAGS_ERROR}"
|
||||
fi
|
||||
fi
|
||||
if [ "${FLAGS_dry_run}" -eq "${FLAGS_FALSE}" ]; then
|
||||
touch "${output}" 2>/dev/null || die "unable to write to '${output}'"
|
||||
fi
|
||||
|
||||
# Run tests.
|
||||
(
|
||||
if [ "${FLAGS_dry_run}" -eq "${FLAGS_FALSE}" ]; then
|
||||
"./${FLAGS_runner}" |tee "${output}"
|
||||
else
|
||||
"./${FLAGS_runner}"
|
||||
fi
|
||||
)
|
||||
|
||||
if [ "${FLAGS_dry_run}" -eq "${FLAGS_FALSE}" ]; then
|
||||
echo >&2
|
||||
echo "Output written to '${output}'." >&2
|
||||
fi
|
||||
}
|
||||
|
||||
FLAGS "$@" || exit $?
|
||||
[ "${FLAGS_help}" -eq "${FLAGS_FALSE}" ] || exit
|
||||
eval set -- "${FLAGS_ARGV}"
|
||||
main "${@:-}"
|
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,39 @@
|
||||
# vim:et:ft=sh:sts=2:sw=2
|
||||
#
|
||||
# Copyright 2008 Kate Ward. All Rights Reserved.
|
||||
# Released under the LGPL (GNU Lesser General Public License).
|
||||
#
|
||||
# Author: kate.ward@forestent.com (Kate Ward)
|
||||
#
|
||||
# Library of shell functions.
|
||||
|
||||
# Convert a relative path into it's absolute equivalent.
|
||||
#
|
||||
# This function will automatically prepend the current working directory if the
|
||||
# path is not already absolute. It then removes all parent references (../) to
|
||||
# reconstruct the proper absolute path.
|
||||
#
|
||||
# Args:
|
||||
# shlib_path_: string: relative path
|
||||
# Outputs:
|
||||
# string: absolute path
|
||||
shlib_relToAbsPath()
|
||||
{
|
||||
shlib_path_=$1
|
||||
|
||||
# prepend current directory to relative paths
|
||||
echo "${shlib_path_}" |grep '^/' >/dev/null 2>&1 \
|
||||
|| shlib_path_="${PWD}/${shlib_path_}"
|
||||
|
||||
# clean up the path. if all seds supported true regular expressions, then
|
||||
# this is what it would be:
|
||||
shlib_old_=${shlib_path_}
|
||||
while true; do
|
||||
shlib_new_=`echo "${shlib_old_}" |sed 's/[^/]*\/\.\.\/*//;s/\/\.\//\//'`
|
||||
[ "${shlib_old_}" = "${shlib_new_}" ] && break
|
||||
shlib_old_=${shlib_new_}
|
||||
done
|
||||
echo "${shlib_new_}"
|
||||
|
||||
unset shlib_path_ shlib_old_ shlib_new_
|
||||
}
|
||||
@ -0,0 +1,272 @@
|
||||
#! /bin/sh
|
||||
# vim:et:ft=sh:sts=2:sw=2
|
||||
#
|
||||
# Versions determines the versions of all installed shells.
|
||||
#
|
||||
# Copyright 2008-2018 Kate Ward. All Rights Reserved.
|
||||
# Released under the Apache 2.0 License.
|
||||
#
|
||||
# Author: kate.ward@forestent.com (Kate Ward)
|
||||
# https://github.com/kward/shlib
|
||||
#
|
||||
# This library provides reusable functions that determine actual names and
|
||||
# versions of installed shells and the OS. The library can also be run as a
|
||||
# script if set executable.
|
||||
#
|
||||
# Disable checks that aren't fully portable (POSIX != portable).
|
||||
# shellcheck disable=SC2006
|
||||
|
||||
ARGV0=`basename "$0"`
|
||||
LSB_RELEASE='/etc/lsb-release'
|
||||
VERSIONS_SHELLS='ash /bin/bash /bin/dash /bin/ksh /bin/pdksh /bin/zsh /bin/sh /usr/xpg4/bin/sh /sbin/sh'
|
||||
|
||||
true; TRUE=$?
|
||||
false; FALSE=$?
|
||||
ERROR=2
|
||||
|
||||
UNAME_R=`uname -r`
|
||||
UNAME_S=`uname -s`
|
||||
|
||||
__versions_haveStrings=${ERROR}
|
||||
|
||||
versions_osName() {
|
||||
os_name_='unrecognized'
|
||||
os_system_=${UNAME_S}
|
||||
os_release_=${UNAME_R}
|
||||
case ${os_system_} in
|
||||
CYGWIN_NT-*) os_name_='Cygwin' ;;
|
||||
Darwin)
|
||||
os_name_=`/usr/bin/sw_vers -productName`
|
||||
os_version_=`versions_osVersion`
|
||||
case ${os_version_} in
|
||||
10.4|10.4.[0-9]*) os_name_='Mac OS X Tiger' ;;
|
||||
10.5|10.5.[0-9]*) os_name_='Mac OS X Leopard' ;;
|
||||
10.6|10.6.[0-9]*) os_name_='Mac OS X Snow Leopard' ;;
|
||||
10.7|10.7.[0-9]*) os_name_='Mac OS X Lion' ;;
|
||||
10.8|10.8.[0-9]*) os_name_='Mac OS X Mountain Lion' ;;
|
||||
10.9|10.9.[0-9]*) os_name_='Mac OS X Mavericks' ;;
|
||||
10.10|10.10.[0-9]*) os_name_='Mac OS X Yosemite' ;;
|
||||
10.11|10.11.[0-9]*) os_name_='Mac OS X El Capitan' ;;
|
||||
10.12|10.12.[0-9]*) os_name_='macOS Sierra' ;;
|
||||
10.13|10.13.[0-9]*) os_name_='macOS High Sierra' ;;
|
||||
*) os_name_='macOS' ;;
|
||||
esac
|
||||
;;
|
||||
FreeBSD) os_name_='FreeBSD' ;;
|
||||
Linux) os_name_='Linux' ;;
|
||||
SunOS)
|
||||
os_name_='SunOS'
|
||||
if [ -r '/etc/release' ]; then
|
||||
if grep 'OpenSolaris' /etc/release >/dev/null; then
|
||||
os_name_='OpenSolaris'
|
||||
else
|
||||
os_name_='Solaris'
|
||||
fi
|
||||
fi
|
||||
;;
|
||||
esac
|
||||
|
||||
echo ${os_name_}
|
||||
unset os_name_ os_system_ os_release_ os_version_
|
||||
}
|
||||
|
||||
versions_osVersion() {
|
||||
os_version_='unrecognized'
|
||||
os_system_=${UNAME_S}
|
||||
os_release_=${UNAME_R}
|
||||
case ${os_system_} in
|
||||
CYGWIN_NT-*)
|
||||
os_version_=`expr "${os_release_}" : '\([0-9]*\.[0-9]\.[0-9]*\).*'`
|
||||
;;
|
||||
Darwin)
|
||||
os_version_=`/usr/bin/sw_vers -productVersion`
|
||||
;;
|
||||
FreeBSD)
|
||||
os_version_=`expr "${os_release_}" : '\([0-9]*\.[0-9]*\)-.*'`
|
||||
;;
|
||||
Linux)
|
||||
if [ -r '/etc/os-release' ]; then
|
||||
os_version_=`awk -F= '$1~/PRETTY_NAME/{print $2}' /etc/os-release \
|
||||
|sed 's/"//g'`
|
||||
elif [ -r '/etc/redhat-release' ]; then
|
||||
os_version_=`cat /etc/redhat-release`
|
||||
elif [ -r '/etc/SuSE-release' ]; then
|
||||
os_version_=`head -n 1 /etc/SuSE-release`
|
||||
elif [ -r "${LSB_RELEASE}" ]; then
|
||||
if grep -q 'DISTRIB_ID=Ubuntu' "${LSB_RELEASE}"; then
|
||||
# shellcheck disable=SC2002
|
||||
os_version_=`cat "${LSB_RELEASE}" \
|
||||
|awk -F= '$1~/DISTRIB_DESCRIPTION/{print $2}' \
|
||||
|sed 's/"//g;s/ /-/g'`
|
||||
fi
|
||||
fi
|
||||
;;
|
||||
SunOS)
|
||||
if [ -r '/etc/release' ]; then
|
||||
if grep 'OpenSolaris' /etc/release >/dev/null; then # OpenSolaris
|
||||
os_version_=`grep 'OpenSolaris' /etc/release |awk '{print $2"("$3")"}'`
|
||||
else # Solaris
|
||||
major_=`echo "${os_release_}" |sed 's/[0-9]*\.\([0-9]*\)/\1/'`
|
||||
minor_=`grep Solaris /etc/release |sed 's/[^u]*\(u[0-9]*\).*/\1/'`
|
||||
os_version_="${major_}${minor_}"
|
||||
fi
|
||||
fi
|
||||
;;
|
||||
esac
|
||||
|
||||
echo "${os_version_}"
|
||||
unset os_release_ os_system_ os_version_ major_ minor_
|
||||
}
|
||||
|
||||
versions_shellVersion() {
|
||||
shell_=$1
|
||||
|
||||
shell_present_=${FALSE}
|
||||
case "${shell_}" in
|
||||
ash) [ -x '/bin/busybox' ] && shell_present_=${TRUE} ;;
|
||||
*) [ -x "${shell_}" ] && shell_present_=${TRUE} ;;
|
||||
esac
|
||||
if [ ${shell_present_} -eq ${FALSE} ]; then
|
||||
echo 'not installed'
|
||||
return ${FALSE}
|
||||
fi
|
||||
|
||||
version_=''
|
||||
case ${shell_} in
|
||||
/sbin/sh) ;; # SunOS
|
||||
/usr/xpg4/bin/sh)
|
||||
version_=`versions_shell_xpg4 "${shell_}"`
|
||||
;; # SunOS
|
||||
*/sh)
|
||||
# This could be one of any number of shells. Try until one fits.
|
||||
version_=''
|
||||
[ -z "${version_}" ] && version_=`versions_shell_bash "${shell_}"`
|
||||
# dash cannot be self determined yet
|
||||
[ -z "${version_}" ] && version_=`versions_shell_ksh "${shell_}"`
|
||||
# pdksh is covered in versions_shell_ksh()
|
||||
[ -z "${version_}" ] && version_=`versions_shell_xpg4 "${shell_}"`
|
||||
[ -z "${version_}" ] && version_=`versions_shell_zsh "${shell_}"`
|
||||
;;
|
||||
ash) version_=`versions_shell_ash "${shell_}"` ;;
|
||||
*/bash) version_=`versions_shell_bash "${shell_}"` ;;
|
||||
*/dash)
|
||||
# Assuming Ubuntu Linux until somebody comes up with a better test. The
|
||||
# following test will return an empty string if dash is not installed.
|
||||
version_=`versions_shell_dash`
|
||||
;;
|
||||
*/ksh) version_=`versions_shell_ksh "${shell_}"` ;;
|
||||
*/pdksh) version_=`versions_shell_pdksh "${shell_}"` ;;
|
||||
*/zsh) version_=`versions_shell_zsh "${shell_}"` ;;
|
||||
*) version_='invalid'
|
||||
esac
|
||||
|
||||
echo "${version_:-unknown}"
|
||||
unset shell_ version_
|
||||
}
|
||||
|
||||
# The ash shell is included in BusyBox.
|
||||
versions_shell_ash() {
|
||||
busybox --help |head -1 |sed 's/BusyBox v\([0-9.]*\) .*/\1/'
|
||||
}
|
||||
|
||||
versions_shell_bash() {
|
||||
$1 --version : 2>&1 |grep 'GNU bash' |sed 's/.*version \([^ ]*\).*/\1/'
|
||||
}
|
||||
|
||||
versions_shell_dash() {
|
||||
eval dpkg >/dev/null 2>&1
|
||||
[ $? -eq 127 ] && return # Return if dpkg not found.
|
||||
|
||||
dpkg -l |grep ' dash ' |awk '{print $3}'
|
||||
}
|
||||
|
||||
versions_shell_ksh() {
|
||||
versions_shell_=$1
|
||||
versions_version_=''
|
||||
|
||||
# Try a few different ways to figure out the version.
|
||||
versions_version_=`${versions_shell_} --version : 2>&1`
|
||||
# shellcheck disable=SC2181
|
||||
if [ $? -eq 0 ]; then
|
||||
versions_version_=`echo "${versions_version_}" \
|
||||
|sed 's/.*\([0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9]\).*/\1/'`
|
||||
else
|
||||
versions_version_=''
|
||||
fi
|
||||
if [ -z "${versions_version_}" ]; then
|
||||
_versions_have_strings
|
||||
versions_version_=`strings "${versions_shell_}" 2>&1 \
|
||||
|grep Version \
|
||||
|sed 's/^.*Version \(.*\)$/\1/;s/ s+ \$$//;s/ /-/g'`
|
||||
fi
|
||||
if [ -z "${versions_version_}" ]; then
|
||||
versions_version_=`versions_shell_pdksh "${versions_shell_}"`
|
||||
fi
|
||||
|
||||
echo "${versions_version_}"
|
||||
unset versions_shell_ versions_version_
|
||||
}
|
||||
|
||||
versions_shell_pdksh() {
|
||||
_versions_have_strings
|
||||
strings "$1" 2>&1 \
|
||||
|grep 'PD KSH' \
|
||||
|sed -e 's/.*PD KSH \(.*\)/\1/;s/ /-/g'
|
||||
}
|
||||
|
||||
versions_shell_xpg4() {
|
||||
_versions_have_strings
|
||||
strings "$1" 2>&1 \
|
||||
|grep 'Version' \
|
||||
|sed -e 's/^@(#)Version //'
|
||||
}
|
||||
|
||||
versions_shell_zsh() {
|
||||
versions_shell_=$1
|
||||
|
||||
# Try a few different ways to figure out the version.
|
||||
# shellcheck disable=SC2016
|
||||
versions_version_=`echo 'echo ${ZSH_VERSION}' |${versions_shell_}`
|
||||
if [ -z "${versions_version_}" ]; then
|
||||
versions_version_=`${versions_shell_} --version : 2>&1`
|
||||
# shellcheck disable=SC2181
|
||||
if [ $? -eq 0 ]; then
|
||||
versions_version_=`echo "${versions_version_}" |awk '{print $2}'`
|
||||
else
|
||||
versions_version_=''
|
||||
fi
|
||||
fi
|
||||
|
||||
echo "${versions_version_}"
|
||||
unset versions_shell_ versions_version_
|
||||
}
|
||||
|
||||
# Determine if the 'strings' binary installed.
|
||||
_versions_have_strings() {
|
||||
[ ${__versions_haveStrings} -ne ${ERROR} ] && return
|
||||
if eval strings /dev/null >/dev/null 2>&1; then
|
||||
__versions_haveStrings=${TRUE}
|
||||
return
|
||||
fi
|
||||
|
||||
echo 'WARN: strings not installed. try installing binutils?' >&2
|
||||
__versions_haveStrings=${FALSE}
|
||||
}
|
||||
|
||||
versions_main() {
|
||||
# Treat unset variables as an error.
|
||||
set -u
|
||||
|
||||
os_name=`versions_osName`
|
||||
os_version=`versions_osVersion`
|
||||
echo "os: ${os_name} version: ${os_version}"
|
||||
|
||||
for shell in ${VERSIONS_SHELLS}; do
|
||||
shell_version=`versions_shellVersion "${shell}"`
|
||||
echo "shell: ${shell} version: ${shell_version}"
|
||||
done
|
||||
}
|
||||
|
||||
if [ "${ARGV0}" = 'versions' ]; then
|
||||
versions_main "$@"
|
||||
fi
|
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,262 @@
|
||||
#! /bin/sh
|
||||
# vim:et:ft=sh:sts=2:sw=2
|
||||
#
|
||||
# shUnit2 unit tests of miscellaneous things
|
||||
#
|
||||
# Copyright 2008-2018 Kate Ward. All Rights Reserved.
|
||||
# Released under the Apache 2.0 license.
|
||||
#
|
||||
# Author: kate.ward@forestent.com (Kate Ward)
|
||||
# https://github.com/kward/shunit2
|
||||
#
|
||||
### ShellCheck http://www.shellcheck.net/
|
||||
# $() are not fully portable (POSIX != portable).
|
||||
# shellcheck disable=SC2006
|
||||
# Disable source following.
|
||||
# shellcheck disable=SC1090,SC1091
|
||||
# Not wanting to escape single quotes.
|
||||
# shellcheck disable=SC1003
|
||||
|
||||
# These variables will be overridden by the test helpers.
|
||||
stdoutF="${TMPDIR:-/tmp}/STDOUT"
|
||||
stderrF="${TMPDIR:-/tmp}/STDERR"
|
||||
|
||||
# Load test helpers.
|
||||
. ./shunit2_test_helpers
|
||||
|
||||
# Note: the test script is prefixed with '#' chars so that shUnit2 does not
|
||||
# incorrectly interpret the embedded functions as real functions.
|
||||
testUnboundVariable() {
|
||||
unittestF="${SHUNIT_TMPDIR}/unittest"
|
||||
sed 's/^#//' >"${unittestF}" <<EOF
|
||||
## Treat unset variables as an error when performing parameter expansion.
|
||||
#set -u
|
||||
#
|
||||
#boom() { x=\$1; } # This function goes boom if no parameters are passed!
|
||||
#test_boom() {
|
||||
# assertEquals 1 1
|
||||
# boom # No parameter given
|
||||
# assertEquals 0 \$?
|
||||
#}
|
||||
#SHUNIT_COLOR='none'
|
||||
#. ${TH_SHUNIT}
|
||||
EOF
|
||||
( exec "${SHUNIT_SHELL:-sh}" "${unittestF}" >"${stdoutF}" 2>"${stderrF}" )
|
||||
assertFalse 'expected a non-zero exit value' $?
|
||||
grep '^ASSERT:Unknown failure' "${stdoutF}" >/dev/null
|
||||
assertTrue 'assert message was not generated' $?
|
||||
grep '^Ran [0-9]* test' "${stdoutF}" >/dev/null
|
||||
assertTrue 'test count message was not generated' $?
|
||||
grep '^FAILED' "${stdoutF}" >/dev/null
|
||||
assertTrue 'failure message was not generated' $?
|
||||
}
|
||||
|
||||
# assertEquals repeats message argument.
|
||||
# https://github.com/kward/shunit2/issues/7
|
||||
testIssue7() {
|
||||
# Disable coloring so 'ASSERT:' lines can be matched correctly.
|
||||
_shunit_configureColor 'none'
|
||||
|
||||
( assertEquals 'Some message.' 1 2 >"${stdoutF}" 2>"${stderrF}" )
|
||||
diff "${stdoutF}" - >/dev/null <<EOF
|
||||
ASSERT:Some message. expected:<1> but was:<2>
|
||||
EOF
|
||||
rtrn=$?
|
||||
assertEquals "${SHUNIT_TRUE}" "${rtrn}"
|
||||
[ "${rtrn}" -eq "${SHUNIT_TRUE}" ] || cat "${stderrF}" >&2
|
||||
}
|
||||
|
||||
# Support prefixes on test output.
|
||||
# https://github.com/kward/shunit2/issues/29
|
||||
testIssue29() {
|
||||
unittestF="${SHUNIT_TMPDIR}/unittest"
|
||||
sed 's/^#//' >"${unittestF}" <<EOF
|
||||
## Support test prefixes.
|
||||
#test_assert() { assertTrue ${SHUNIT_TRUE}; }
|
||||
#SHUNIT_COLOR='none'
|
||||
#SHUNIT_TEST_PREFIX='--- '
|
||||
#. ${TH_SHUNIT}
|
||||
EOF
|
||||
( exec "${SHUNIT_SHELL:-sh}" "${unittestF}" >"${stdoutF}" 2>"${stderrF}" )
|
||||
grep '^--- test_assert' "${stdoutF}" >/dev/null
|
||||
rtrn=$?
|
||||
assertEquals "${SHUNIT_TRUE}" "${rtrn}"
|
||||
[ "${rtrn}" -eq "${SHUNIT_TRUE}" ] || cat "${stdoutF}" >&2
|
||||
}
|
||||
|
||||
# shUnit2 should not exit with 0 when it has syntax errors.
|
||||
# https://github.com/kward/shunit2/issues/69
|
||||
testIssue69() {
|
||||
unittestF="${SHUNIT_TMPDIR}/unittest"
|
||||
|
||||
for t in Equals NotEquals Null NotNull Same NotSame True False; do
|
||||
assert="assert${t}"
|
||||
sed 's/^#//' >"${unittestF}" <<EOF
|
||||
## Asserts with invalid argument counts should be counted as failures.
|
||||
#test_assert() { ${assert}; }
|
||||
#SHUNIT_COLOR='none'
|
||||
#. ${TH_SHUNIT}
|
||||
EOF
|
||||
( exec "${SHUNIT_SHELL:-sh}" "${unittestF}" >"${stdoutF}" 2>"${stderrF}" )
|
||||
grep '^FAILED' "${stdoutF}" >/dev/null
|
||||
assertTrue "failure message for ${assert} was not generated" $?
|
||||
done
|
||||
}
|
||||
|
||||
# Ensure that test fails if setup/teardown functions fail.
|
||||
testIssue77() {
|
||||
unittestF="${SHUNIT_TMPDIR}/unittest"
|
||||
for func in oneTimeSetUp setUp tearDown oneTimeTearDown; do
|
||||
sed 's/^#//' >"${unittestF}" <<EOF
|
||||
## Environment failure should end test.
|
||||
#${func}() { return ${SHUNIT_FALSE}; }
|
||||
#test_true() { assertTrue ${SHUNIT_TRUE}; }
|
||||
#SHUNIT_COLOR='none'
|
||||
#. ${TH_SHUNIT}
|
||||
EOF
|
||||
( exec "${SHUNIT_SHELL:-sh}" "${unittestF}" >"${stdoutF}" 2>"${stderrF}" )
|
||||
grep '^FAILED' "${stdoutF}" >/dev/null
|
||||
assertTrue "failure of ${func}() did not end test" $?
|
||||
done
|
||||
}
|
||||
|
||||
# Ensure a test failure is recorded for code containing syntax errors.
|
||||
# https://github.com/kward/shunit2/issues/84
|
||||
testIssue84() {
|
||||
unittestF="${SHUNIT_TMPDIR}/unittest"
|
||||
sed 's/^#//' >"${unittestF}" <<\EOF
|
||||
## Function with syntax error.
|
||||
#syntax_error() { ${!#3442} -334 a$@2[1]; }
|
||||
#test_syntax_error() {
|
||||
# syntax_error
|
||||
# assertTrue ${SHUNIT_TRUE}
|
||||
#}
|
||||
#SHUNIT_COLOR='none'
|
||||
#SHUNIT_TEST_PREFIX='--- '
|
||||
#. ${TH_SHUNIT}
|
||||
EOF
|
||||
( exec "${SHUNIT_SHELL:-sh}" "${unittestF}" >"${stdoutF}" 2>"${stderrF}" )
|
||||
grep '^FAILED' "${stdoutF}" >/dev/null
|
||||
assertTrue "failure message for ${assert} was not generated" $?
|
||||
}
|
||||
|
||||
testPrepForSourcing() {
|
||||
assertEquals '/abc' "`_shunit_prepForSourcing '/abc'`"
|
||||
assertEquals './abc' "`_shunit_prepForSourcing './abc'`"
|
||||
assertEquals './abc' "`_shunit_prepForSourcing 'abc'`"
|
||||
}
|
||||
|
||||
testEscapeCharInStr() {
|
||||
while read -r desc char str want; do
|
||||
got=`_shunit_escapeCharInStr "${char}" "${str}"`
|
||||
assertEquals "${desc}" "${want}" "${got}"
|
||||
done <<'EOF'
|
||||
backslash \ '' ''
|
||||
backslash_pre \ \def \\def
|
||||
backslash_mid \ abc\def abc\\def
|
||||
backslash_post \ abc\ abc\\
|
||||
quote " '' ''
|
||||
quote_pre " "def \"def
|
||||
quote_mid " abc"def abc\"def
|
||||
quote_post " abc" abc\"
|
||||
string $ '' ''
|
||||
string_pre $ $def \$def
|
||||
string_mid $ abc$def abc\$def
|
||||
string_post $ abc$ abc\$
|
||||
EOF
|
||||
|
||||
# TODO(20170924:kward) fix or remove.
|
||||
# actual=`_shunit_escapeCharInStr "'" ''`
|
||||
# assertEquals '' "${actual}"
|
||||
# assertEquals "abc\\'" `_shunit_escapeCharInStr "'" "abc'"`
|
||||
# assertEquals "abc\\'def" `_shunit_escapeCharInStr "'" "abc'def"`
|
||||
# assertEquals "\\'def" `_shunit_escapeCharInStr "'" "'def"`
|
||||
|
||||
# # Must put the backtick in a variable so the shell doesn't misinterpret it
|
||||
# # while inside a backticked sequence (e.g. `echo '`'` would fail).
|
||||
# backtick='`'
|
||||
# actual=`_shunit_escapeCharInStr ${backtick} ''`
|
||||
# assertEquals '' "${actual}"
|
||||
# assertEquals '\`abc' \
|
||||
# `_shunit_escapeCharInStr "${backtick}" ${backtick}'abc'`
|
||||
# assertEquals 'abc\`' \
|
||||
# `_shunit_escapeCharInStr "${backtick}" 'abc'${backtick}`
|
||||
# assertEquals 'abc\`def' \
|
||||
# `_shunit_escapeCharInStr "${backtick}" 'abc'${backtick}'def'`
|
||||
}
|
||||
|
||||
testEscapeCharInStr_specialChars() {
|
||||
# Make sure our forward slash doesn't upset sed.
|
||||
assertEquals '/' "`_shunit_escapeCharInStr '\' '/'`"
|
||||
|
||||
# Some shells escape these differently.
|
||||
# TODO(20170924:kward) fix or remove.
|
||||
#assertEquals '\\a' `_shunit_escapeCharInStr '\' '\a'`
|
||||
#assertEquals '\\b' `_shunit_escapeCharInStr '\' '\b'`
|
||||
}
|
||||
|
||||
# Test the various ways of declaring functions.
|
||||
#
|
||||
# Prefixing (then stripping) with comment symbol so these functions aren't
|
||||
# treated as real functions by shUnit2.
|
||||
testExtractTestFunctions() {
|
||||
f="${SHUNIT_TMPDIR}/extract_test_functions"
|
||||
sed 's/^#//' <<EOF >"${f}"
|
||||
## Function on a single line.
|
||||
#testABC() { echo 'ABC'; }
|
||||
## Multi-line function with '{' on next line.
|
||||
#test_def()
|
||||
# {
|
||||
# echo 'def'
|
||||
#}
|
||||
## Multi-line function with '{' on first line.
|
||||
#testG3 () {
|
||||
# echo 'G3'
|
||||
#}
|
||||
## Function with numerical values in name.
|
||||
#function test4() { echo '4'; }
|
||||
## Leading space in front of function.
|
||||
# test5() { echo '5'; }
|
||||
## Function with '_' chars in name.
|
||||
#some_test_function() { echo 'some func'; }
|
||||
## Function that sets variables.
|
||||
#func_with_test_vars() {
|
||||
# testVariable=1234
|
||||
#}
|
||||
EOF
|
||||
|
||||
actual=`_shunit_extractTestFunctions "${f}"`
|
||||
assertEquals 'testABC test_def testG3 test4 test5' "${actual}"
|
||||
}
|
||||
|
||||
# Test that certain external commands sometimes "stubbed" by users
|
||||
# are escaped. See Issue #54.
|
||||
testProtectedCommands() {
|
||||
for c in mkdir rm cat chmod; do
|
||||
grep "^[^#]*${c} " "${TH_SHUNIT}" | grep -qv "command ${c}"
|
||||
assertFalse "external call to ${c} not protected somewhere" $?
|
||||
done
|
||||
grep '^[^#]*[^ ] *\[' "${TH_SHUNIT}" | grep -qv 'command \['
|
||||
assertFalse "call to [ ... ] not protected somewhere" $?
|
||||
grep '^[^#]* *\.' "${TH_SHUNIT}" | grep -qv 'command \.'
|
||||
assertFalse "call to . not protected somewhere" $?
|
||||
}
|
||||
|
||||
setUp() {
|
||||
for f in "${stdoutF}" "${stderrF}"; do
|
||||
cp /dev/null "${f}"
|
||||
done
|
||||
|
||||
# Reconfigure coloring as some tests override default behavior.
|
||||
_shunit_configureColor "${SHUNIT_COLOR_DEFAULT}"
|
||||
}
|
||||
|
||||
oneTimeSetUp() {
|
||||
SHUNIT_COLOR_DEFAULT="${SHUNIT_COLOR}"
|
||||
th_oneTimeSetUp
|
||||
}
|
||||
|
||||
# Load and run shUnit2.
|
||||
# shellcheck disable=SC2034
|
||||
[ -n "${ZSH_VERSION:-}" ] && SHUNIT_PARENT=$0
|
||||
. "${TH_SHUNIT}"
|
||||
@ -1,41 +1,38 @@
|
||||
#! /bin/sh
|
||||
# $Id$
|
||||
# vim:et:ft=sh:sts=2:sw=2
|
||||
#
|
||||
# Copyright 2010 Kate Ward. All Rights Reserved.
|
||||
# Released under the LGPL (GNU Lesser General Public License)
|
||||
# Author: kate.ward@forestent.com (Kate Ward)
|
||||
#
|
||||
# shUnit2 unit test for standalone operation.
|
||||
#
|
||||
# Copyright 2010-2017 Kate Ward. All Rights Reserved.
|
||||
# Released under the Apache 2.0 license.
|
||||
#
|
||||
# Author: kate.ward@forestent.com (Kate Ward)
|
||||
# https://github.com/kward/shunit2
|
||||
#
|
||||
# This unit test is purely to test that calling shunit2 directly, while passing
|
||||
# the name of a unit test script, works. When run, this script determines if it
|
||||
# is running as a standalone program, and calls main() if it is.
|
||||
#
|
||||
### ShellCheck http://www.shellcheck.net/
|
||||
# $() are not fully portable (POSIX != portable).
|
||||
# shellcheck disable=SC2006
|
||||
# Disable source following.
|
||||
# shellcheck disable=SC1090,SC1091
|
||||
|
||||
ARGV0=`basename "$0"`
|
||||
ARGV0="`basename "$0"`"
|
||||
|
||||
# load test helpers
|
||||
# Load test helpers.
|
||||
. ./shunit2_test_helpers
|
||||
|
||||
#------------------------------------------------------------------------------
|
||||
# suite tests
|
||||
#
|
||||
|
||||
testStandalone()
|
||||
{
|
||||
assertTrue ${SHUNIT_TRUE}
|
||||
testStandalone() {
|
||||
assertTrue "${SHUNIT_TRUE}"
|
||||
}
|
||||
|
||||
#------------------------------------------------------------------------------
|
||||
# main
|
||||
#
|
||||
|
||||
main()
|
||||
{
|
||||
main() {
|
||||
${TH_SHUNIT} "${ARGV0}"
|
||||
}
|
||||
|
||||
# are we running as a standalone?
|
||||
# Are we running as a standalone?
|
||||
if [ "${ARGV0}" = 'shunit2_test_standalone.sh' ]; then
|
||||
if [ $# -gt 0 ]; then main "$@"; else main; fi
|
||||
fi
|
||||
@ -1,124 +0,0 @@
|
||||
#! /bin/sh
|
||||
# $Id$
|
||||
# vim:et:ft=sh:sts=2:sw=2
|
||||
#
|
||||
# Copyright 2008 Kate Ward. All Rights Reserved.
|
||||
# Released under the LGPL (GNU Lesser General Public License)
|
||||
# Author: kate.ward@forestent.com (Kate Ward)
|
||||
#
|
||||
# shUnit2 unit test suite runner.
|
||||
#
|
||||
# This script runs all the unit tests that can be found, and generates a nice
|
||||
# report of the tests.
|
||||
|
||||
MY_NAME=`basename $0`
|
||||
MY_PATH=`dirname $0`
|
||||
|
||||
PREFIX='shunit2_test_'
|
||||
SHELLS='/bin/sh /bin/bash /bin/dash /bin/ksh /bin/pdksh /bin/zsh'
|
||||
TESTS=''
|
||||
for test in ${PREFIX}[a-z]*.sh; do
|
||||
TESTS="${TESTS} ${test}"
|
||||
done
|
||||
|
||||
# load common unit test functions
|
||||
. ../lib/versions
|
||||
. ./shunit2_test_helpers
|
||||
|
||||
usage()
|
||||
{
|
||||
echo "usage: ${MY_NAME} [-e key=val ...] [-s shell(s)] [-t test(s)]"
|
||||
}
|
||||
|
||||
env=''
|
||||
|
||||
# process command line flags
|
||||
while getopts 'e:hs:t:' opt; do
|
||||
case ${opt} in
|
||||
e) # set an environment variable
|
||||
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 ;; # output help
|
||||
s) shells=${OPTARG} ;; # list of shells to run
|
||||
t) tests=${OPTARG} ;; # list of tests to run
|
||||
*) 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
|
||||
th_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
|
||||
|
||||
echo "$ uname -mprsv"
|
||||
uname -mprsv
|
||||
|
||||
#
|
||||
# run tests
|
||||
#
|
||||
|
||||
for shell in ${shells}; do
|
||||
echo
|
||||
|
||||
# check for existance of shell
|
||||
if [ ! -x ${shell} ]; then
|
||||
th_warn "unable to run tests with the ${shell} shell"
|
||||
continue
|
||||
fi
|
||||
|
||||
cat <<EOF
|
||||
|
||||
#------------------------------------------------------------------------------
|
||||
# Running the test suite with ${shell}
|
||||
#
|
||||
EOF
|
||||
|
||||
SHUNIT_SHELL=${shell} # pass shell onto tests
|
||||
shell_name=`basename ${shell}`
|
||||
shell_version=`versions_shellVersion "${shell}"`
|
||||
|
||||
echo "shell name: ${shell_name}"
|
||||
echo "shell version: ${shell_version}"
|
||||
|
||||
# execute the tests
|
||||
for suite in ${tests}; do
|
||||
suiteName=`expr "${suite}" : "${PREFIX}\(.*\).sh"`
|
||||
echo
|
||||
echo "--- Executing the '${suiteName}' test suite ---"
|
||||
( exec ${shell} ./${suite} 2>&1; )
|
||||
done
|
||||
done
|
||||
@ -1,160 +0,0 @@
|
||||
#! /bin/sh
|
||||
# $Id$
|
||||
# vim:et:ft=sh:sts=2:sw=2
|
||||
#
|
||||
# Copyright 2008 Kate Ward. All Rights Reserved.
|
||||
# Released under the LGPL (GNU Lesser General Public License)
|
||||
#
|
||||
# Author: kate.ward@forestent.com (Kate Ward)
|
||||
#
|
||||
# shUnit2 unit tests of miscellaneous things
|
||||
|
||||
# load test helpers
|
||||
. ./shunit2_test_helpers
|
||||
|
||||
#------------------------------------------------------------------------------
|
||||
# suite tests
|
||||
#
|
||||
|
||||
# Note: the test script is prefixed with '#' chars so that shUnit2 does not
|
||||
# incorrectly interpret the embedded functions as real functions.
|
||||
testUnboundVariable()
|
||||
{
|
||||
unittestF="${SHUNIT_TMPDIR}/unittest"
|
||||
sed 's/^#//' >"${unittestF}" <<EOF
|
||||
## treat unset variables as an error when performing parameter expansion
|
||||
#set -u
|
||||
#
|
||||
#boom() { x=\$1; } # this function goes boom if no parameters are passed!
|
||||
#test_boom()
|
||||
#{
|
||||
# assertEquals 1 1
|
||||
# boom # No parameter given
|
||||
# assertEquals 0 \$?
|
||||
#}
|
||||
#. ${TH_SHUNIT}
|
||||
EOF
|
||||
( exec ${SHUNIT_SHELL:-sh} "${unittestF}" >"${stdoutF}" 2>"${stderrF}" )
|
||||
assertFalse 'expected a non-zero exit value' $?
|
||||
grep '^ASSERT:Unknown failure' "${stdoutF}" >/dev/null
|
||||
assertTrue 'assert message was not generated' $?
|
||||
grep '^Ran [0-9]* test' "${stdoutF}" >/dev/null
|
||||
assertTrue 'test count message was not generated' $?
|
||||
grep '^FAILED' "${stdoutF}" >/dev/null
|
||||
assertTrue 'failure message was not generated' $?
|
||||
}
|
||||
|
||||
testIssue7()
|
||||
{
|
||||
( assertEquals 'Some message.' 1 2 >"${stdoutF}" 2>"${stderrF}" )
|
||||
diff "${stdoutF}" - >/dev/null <<EOF
|
||||
ASSERT:Some message. expected:<1> but was:<2>
|
||||
EOF
|
||||
rtrn=$?
|
||||
assertEquals ${SHUNIT_TRUE} ${rtrn}
|
||||
[ ${rtrn} -ne ${SHUNIT_TRUE} ] && cat "${stderrF}" >&2
|
||||
}
|
||||
|
||||
testPrepForSourcing()
|
||||
{
|
||||
assertEquals '/abc' `_shunit_prepForSourcing '/abc'`
|
||||
assertEquals './abc' `_shunit_prepForSourcing './abc'`
|
||||
assertEquals './abc' `_shunit_prepForSourcing 'abc'`
|
||||
}
|
||||
|
||||
testEscapeCharInStr()
|
||||
{
|
||||
actual=`_shunit_escapeCharInStr '\' ''`
|
||||
assertEquals '' "${actual}"
|
||||
assertEquals 'abc\\' `_shunit_escapeCharInStr '\' 'abc\'`
|
||||
assertEquals 'abc\\def' `_shunit_escapeCharInStr '\' 'abc\def'`
|
||||
assertEquals '\\def' `_shunit_escapeCharInStr '\' '\def'`
|
||||
|
||||
actual=`_shunit_escapeCharInStr '"' ''`
|
||||
assertEquals '' "${actual}"
|
||||
assertEquals 'abc\"' `_shunit_escapeCharInStr '"' 'abc"'`
|
||||
assertEquals 'abc\"def' `_shunit_escapeCharInStr '"' 'abc"def'`
|
||||
assertEquals '\"def' `_shunit_escapeCharInStr '"' '"def'`
|
||||
|
||||
actual=`_shunit_escapeCharInStr '$' ''`
|
||||
assertEquals '' "${actual}"
|
||||
assertEquals 'abc\$' `_shunit_escapeCharInStr '$' 'abc$'`
|
||||
assertEquals 'abc\$def' `_shunit_escapeCharInStr '$' 'abc$def'`
|
||||
assertEquals '\$def' `_shunit_escapeCharInStr '$' '$def'`
|
||||
|
||||
# actual=`_shunit_escapeCharInStr "'" ''`
|
||||
# assertEquals '' "${actual}"
|
||||
# assertEquals "abc\\'" `_shunit_escapeCharInStr "'" "abc'"`
|
||||
# assertEquals "abc\\'def" `_shunit_escapeCharInStr "'" "abc'def"`
|
||||
# assertEquals "\\'def" `_shunit_escapeCharInStr "'" "'def"`
|
||||
|
||||
# # must put the backtick in a variable so the shell doesn't misinterpret it
|
||||
# # while inside a backticked sequence (e.g. `echo '`'` would fail).
|
||||
# backtick='`'
|
||||
# actual=`_shunit_escapeCharInStr ${backtick} ''`
|
||||
# assertEquals '' "${actual}"
|
||||
# assertEquals '\`abc' \
|
||||
# `_shunit_escapeCharInStr "${backtick}" ${backtick}'abc'`
|
||||
# assertEquals 'abc\`' \
|
||||
# `_shunit_escapeCharInStr "${backtick}" 'abc'${backtick}`
|
||||
# assertEquals 'abc\`def' \
|
||||
# `_shunit_escapeCharInStr "${backtick}" 'abc'${backtick}'def'`
|
||||
}
|
||||
|
||||
testEscapeCharInStr_specialChars()
|
||||
{
|
||||
# make sure our forward slash doesn't upset sed
|
||||
assertEquals '/' `_shunit_escapeCharInStr '\' '/'`
|
||||
|
||||
# some shells escape these differently
|
||||
#assertEquals '\\a' `_shunit_escapeCharInStr '\' '\a'`
|
||||
#assertEquals '\\b' `_shunit_escapeCharInStr '\' '\b'`
|
||||
}
|
||||
|
||||
# Test the various ways of declaring functions.
|
||||
#
|
||||
# Prefixing (then stripping) with comment symbol so these functions aren't
|
||||
# treated as real functions by shUnit2.
|
||||
testExtractTestFunctions()
|
||||
{
|
||||
f="${SHUNIT_TMPDIR}/extract_test_functions"
|
||||
sed 's/^#//' <<EOF >"${f}"
|
||||
#testABC() { echo 'ABC'; }
|
||||
#test_def() {
|
||||
# echo 'def'
|
||||
#}
|
||||
#testG3 ()
|
||||
#{
|
||||
# echo 'G3'
|
||||
#}
|
||||
#function test4() { echo '4'; }
|
||||
# test5() { echo '5'; }
|
||||
#some_test_function() { echo 'some func'; }
|
||||
#func_with_test_vars() {
|
||||
# testVariable=1234
|
||||
#}
|
||||
EOF
|
||||
|
||||
actual=`_shunit_extractTestFunctions "${f}"`
|
||||
assertEquals 'testABC test_def testG3 test4 test5' "${actual}"
|
||||
}
|
||||
|
||||
#------------------------------------------------------------------------------
|
||||
# suite functions
|
||||
#
|
||||
|
||||
setUp()
|
||||
{
|
||||
for f in ${expectedF} ${stdoutF} ${stderrF}; do
|
||||
cp /dev/null ${f}
|
||||
done
|
||||
}
|
||||
|
||||
oneTimeSetUp()
|
||||
{
|
||||
th_oneTimeSetUp
|
||||
}
|
||||
|
||||
# load and run shUnit2
|
||||
[ -n "${ZSH_VERSION:-}" ] && SHUNIT_PARENT=$0
|
||||
. ${TH_SHUNIT}
|
||||
@ -0,0 +1,165 @@
|
||||
#! /bin/sh
|
||||
# vim:et:ft=sh:sts=2:sw=2
|
||||
#
|
||||
# Unit test suite runner.
|
||||
#
|
||||
# Copyright 2008-2017 Kate Ward. All Rights Reserved.
|
||||
# Released under the Apache 2.0 license.
|
||||
#
|
||||
# Author: kate.ward@forestent.com (Kate Ward)
|
||||
# https://github.com/kward/shlib
|
||||
#
|
||||
# This script runs all the unit tests that can be found, and generates a nice
|
||||
# report of the tests.
|
||||
#
|
||||
### ShellCheck (http://www.shellcheck.net/)
|
||||
# Disable source following.
|
||||
# shellcheck disable=SC1090,SC1091
|
||||
# expr may be antiquated, but it is the only solution in some cases.
|
||||
# shellcheck disable=SC2003
|
||||
# $() are not fully portable (POSIX != portable).
|
||||
# shellcheck disable=SC2006
|
||||
|
||||
# Return if test_runner already loaded.
|
||||
[ -z "${RUNNER_LOADED:-}" ] || return 0
|
||||
RUNNER_LOADED=0
|
||||
|
||||
RUNNER_ARGV0=`basename "$0"`
|
||||
RUNNER_SHELLS='/bin/sh ash /bin/bash /bin/dash /bin/ksh /bin/pdksh /bin/zsh'
|
||||
RUNNER_TEST_SUFFIX='_test.sh'
|
||||
|
||||
runner_warn() { echo "runner:WARN $*" >&2; }
|
||||
runner_error() { echo "runner:ERROR $*" >&2; }
|
||||
runner_fatal() { echo "runner:FATAL $*" >&2; exit 1; }
|
||||
|
||||
runner_usage() {
|
||||
echo "usage: ${RUNNER_ARGV0} [-e key=val ...] [-s shell(s)] [-t test(s)]"
|
||||
}
|
||||
|
||||
_runner_tests() { echo ./*${RUNNER_TEST_SUFFIX} |sed 's#./##g'; }
|
||||
_runner_testName() {
|
||||
# shellcheck disable=SC1117
|
||||
_runner_testName_=`expr "${1:-}" : "\(.*\)${RUNNER_TEST_SUFFIX}"`
|
||||
if [ -n "${_runner_testName_}" ]; then
|
||||
echo "${_runner_testName_}"
|
||||
else
|
||||
echo 'unknown'
|
||||
fi
|
||||
unset _runner_testName_
|
||||
}
|
||||
|
||||
main() {
|
||||
# Find and load versions library.
|
||||
for _runner_dir_ in . ${LIB_DIR:-lib}; do
|
||||
if [ -r "${_runner_dir_}/versions" ]; then
|
||||
_runner_lib_dir_="${_runner_dir_}"
|
||||
break
|
||||
fi
|
||||
done
|
||||
[ -n "${_runner_lib_dir_}" ] || runner_fatal 'Unable to find versions library.'
|
||||
. "${_runner_lib_dir_}/versions" || runner_fatal 'Unable to load versions library.'
|
||||
unset _runner_dir_ _runner_lib_dir_
|
||||
|
||||
# Process command line flags.
|
||||
env=''
|
||||
while getopts 'e:hs:t:' opt; do
|
||||
case ${opt} in
|
||||
e) # set an environment variable
|
||||
key=`expr "${OPTARG}" : '\([^=]*\)='`
|
||||
val=`expr "${OPTARG}" : '[^=]*=\(.*\)'`
|
||||
# shellcheck disable=SC2166
|
||||
if [ -z "${key}" -o -z "${val}" ]; then
|
||||
runner_usage
|
||||
exit 1
|
||||
fi
|
||||
eval "${key}='${val}'"
|
||||
eval "export ${key}"
|
||||
env="${env:+${env} }${key}"
|
||||
;;
|
||||
h) runner_usage; exit 0 ;; # help output
|
||||
s) shells=${OPTARG} ;; # list of shells to run
|
||||
t) tests=${OPTARG} ;; # list of tests to run
|
||||
*) runner_usage; exit 1 ;;
|
||||
esac
|
||||
done
|
||||
shift "`expr ${OPTIND} - 1`"
|
||||
|
||||
# Fill shells and/or tests.
|
||||
shells=${shells:-${RUNNER_SHELLS}}
|
||||
[ -z "${tests}" ] && tests=`_runner_tests`
|
||||
|
||||
# Error checking.
|
||||
if [ -z "${tests}" ]; then
|
||||
runner_error 'no tests found to run; exiting'
|
||||
exit 1
|
||||
fi
|
||||
|
||||
cat <<EOF
|
||||
#------------------------------------------------------------------------------
|
||||
# System data.
|
||||
#
|
||||
|
||||
$ uname -mprsv
|
||||
`uname -mprsv`
|
||||
|
||||
OS Name: `versions_osName`
|
||||
OS Version: `versions_osVersion`
|
||||
|
||||
### Test run info.
|
||||
shells: ${shells}
|
||||
tests: ${tests}
|
||||
EOF
|
||||
for key in ${env}; do
|
||||
eval "echo \"${key}=\$${key}\""
|
||||
done
|
||||
|
||||
# Run tests.
|
||||
for shell in ${shells}; do
|
||||
echo
|
||||
|
||||
cat <<EOF
|
||||
|
||||
#------------------------------------------------------------------------------
|
||||
# Running the test suite with ${shell}.
|
||||
#
|
||||
EOF
|
||||
|
||||
# Check for existence of shell.
|
||||
shell_bin=${shell}
|
||||
shell_name=''
|
||||
shell_present=${FALSE}
|
||||
case ${shell} in
|
||||
ash)
|
||||
shell_bin=`which busybox |grep -v '^no busybox'`
|
||||
[ $? -eq "${TRUE}" -a -n "${shell_bin}" ] && shell_present="${TRUE}"
|
||||
shell_bin="${shell_bin} ash"
|
||||
shell_name=${shell}
|
||||
;;
|
||||
*)
|
||||
[ -x "${shell_bin}" ] && shell_present="${TRUE}"
|
||||
shell_name=`basename "${shell}"`
|
||||
;;
|
||||
esac
|
||||
if [ "${shell_present}" -eq "${FALSE}" ]; then
|
||||
runner_warn "unable to run tests with the ${shell_name} shell"
|
||||
continue
|
||||
fi
|
||||
|
||||
shell_version=`versions_shellVersion "${shell}"`
|
||||
|
||||
echo "shell name: ${shell_name}"
|
||||
echo "shell version: ${shell_version}"
|
||||
|
||||
# Execute the tests.
|
||||
for t in ${tests}; do
|
||||
echo
|
||||
echo "--- Executing the '`_runner_testName "${t}"`' test suite. ---"
|
||||
# ${shell_bin} needs word splitting.
|
||||
# shellcheck disable=SC2086
|
||||
( exec ${shell_bin} "./${t}" 2>&1; )
|
||||
done
|
||||
done
|
||||
}
|
||||
|
||||
# Execute main() if this is run in standalone mode (i.e. not from a unit test).
|
||||
[ -z "${SHUNIT_VERSION}" ] && main "$@"
|
||||
Loading…
Reference in New Issue