From 2e65c5007f8b4605c5a74b93e620b8a2435249fc Mon Sep 17 00:00:00 2001 From: Chris Koeritz Date: Wed, 23 Sep 2020 15:03:17 -0400 Subject: [PATCH] updated docs with more info re shunit --- testkit/doc/testkit_reference-source.html | 43 +++++++++++++++++------ testkit/doc/testkit_reference.html | 43 +++++++++++++++++------ 2 files changed, 64 insertions(+), 22 deletions(-) diff --git a/testkit/doc/testkit_reference-source.html b/testkit/doc/testkit_reference-source.html index 255738bd..54ef5a48 100644 --- a/testkit/doc/testkit_reference-source.html +++ b/testkit/doc/testkit_reference-source.html @@ -6,7 +6,7 @@

$BRANDING TestKit Reference Manual

Author: Chris Koeritz

Version 1.0 â Updated August 14 2020

Version 1.0 â Updated September 23 2020

The $BRANDING TestKit

The TestKit is a collection of scripts that leverages the ShUnit unit testing environment. The TestKit provides a pattern for creating @@ -14,12 +14,16 @@ reporting on test runs is provided in a convenient tabular format.

Generally, writing a test script using the TestKit is a matter of minutes. A blank test is provided as a template, and that can be - expanded with whatever test steps are needed.

+ expanded with whatever test steps are needed. (See + examples/blank_test.sh)

TestKit (and ShUnit) are implemented in the GNU Bash script language, but a TestKit test script can invoke external applications, written in whatever programming language or scripting tool is desired, using the - standard POSIX interfaces.
-

+ standard POSIX interfaces.

License

The testkit is provided under the Apache License, version 2.0 (the + "License"). The license is available at: http://www.apache.org/licenses/LICENSE-2.0

Getting the TestKit

Follow these steps to download and install a new "vanilla" version of the TestKit:
@@ -36,13 +40,16 @@ margin-left:0in;background:#DDD9C3">

The above steps were used to kick-start the local version of the TestKit.

It is possible to check out the TestKit within one's own code base (by - adding the Feisty MeowÂ® Codebase that was retrieved above). Then one - can retrieve an updated Feisty MeowÂ® TestKit by running "git pull" on the - "feisty_meow" folder. This will get the latest version of TestKit - without disturbing whatever project's revision control repository contains - the TestKit for testing.

The above steps may have been used to kick-start the local version of the + TestKit. It is perfectly valid to download the testkit and then copy + it into one's own source code for use; this is enabled under the Apache + License.

It is also possible to check out the TestKit within one's own code base + (by adding the Feisty MeowÂ® Codebase that was retrieved above). Then + one can retrieve an updated Feisty MeowÂ® TestKit by running "git pull" on + the "feisty_meow" folder. This will get the latest version of + TestKit without disturbing whatever project's revision control repository + contains the TestKit for testing.

Preparing the TestKit on Linux

Linux is the easiest environment for running the TestKit, given that the tests were built using the bash shell within a Linux environment. If @@ -273,6 +280,20 @@ margin-left:0in;background:#DDD9C3">https://github.com/kward/shunit2

Note however that we have made some customizations in reporting in the + version stored with the testkit, so some features may be missed if a newer + version is placed in the testkit's "shunit" folder.

diff --git a/testkit/doc/testkit_reference.html b/testkit/doc/testkit_reference.html index fe752cc4..a59e51d3 100644 --- a/testkit/doc/testkit_reference.html +++ b/testkit/doc/testkit_reference.html @@ -6,7 +6,7 @@

Feisty MeowÂ® TestKit Reference Manual