shUnit2--shell脚本单元测试框架

本文主要翻译自shUnit2的README文档。

摘要

shUnit2是一个为bash shell脚本设计的xUnit类型的单元测试框架，使用方式和JUnit、PyUnit......类似。如果你曾经使用过类似的单元测试框架，上手将会容易很多。

介绍

据说在log4sh(一种类似log4j基于shell的日志框架)做自动化测试时，发现了各种兼容性问题，开发者最后决定开发出一款shell单元测试框架，于是有了shUnit2。
之前的代码仓库在code.google.com/p/shunit2，google code关闭以后开发者将其镜像到github，最新的2.1版本最后一次修改提交是2017年1月。

支持的操作系统

• Cygwin
• FreeBSD (user supported)
• Linux (Gentoo, Ubuntu)
• Mac OS X
• Solaris 8, 9, 10 (inc. OpenSolaris)

支持的shell

• 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

详见代码仓库的 (doc/RELEASE_NOTES-X.X.X.txt)

新手入门

代码仓库的example包含了几个参考范例，我们可以试着执行一下，我是在CentOS 7环境下运行的。

#! /bin/sh
# file: examples/equality_test.sh
testEquality()
{
  assertEquals 1 1
}
# load shunit2
. ../src/shunit2

执行测试脚本，你将看到如下结果：

testEquality
 
Ran 1 test.
 
OK 

以上范例没有实际的被测试脚本，但是依然输出的测试结果，所有内容都是shUnit2生成的。shUnit2具体的测试步骤如下：

1. source shunit2以后，单元测试将会开始执行，一开始会扫描代码中所有test开头的函数，并将其加入单元测试列表。
2. 一个测试集合开始测试前会执行oneTimeSetUp函数，oneTimeSetUp函数内部可以编写一些全局的初始条件，该函数在本次测试过程中仅执行一次。对应的是所有测试用例结束后，将会执行oneTimeTearDown函数，在这里可以执行一些状态恢复的操作。
3. 每个test用例函数被执行前，都会执行setUp函数，测试结束会执行tearDown函数，完整的单元测试用例执行过程即：setUp() > test() > tearDown()。
4. 测试完成后，shUnit2将会输出测试报告。

现在我们来看一个失败的测试：

#! /bin/sh
# file: examples/party_test.sh
 
testEquality()
{
  assertEquals 1 1
}
 
testPartyLikeItIs1999()
{
  year=`date '+%Y'`
  assertEquals "It's not 1999 :-(" \
      '1999' "${year}"
}
 
# load shunit2
. ../src/shunit2

这个测试的结果一定是失败的，因为年份错了。

testEquality
testPartyLikeItIs1999
ASSERT:It's not 1999 :-( expected:<1999> but was:<2017>
Ran 2 tests.
FAILED (failures=1)

但是你会发现我们可以在测试框架提供的assertEquals函数中插入一些文本信息，另外无论是字符串还是数字的比较，assertEquals函数都能很好的兼容。

函数说明

通常字符串我们需要使用单引号'或者双引号"来引用。

Asserts[断言]

所有函数如下，从字面意思都很好理解：

assertEquals [message] expected actual
assertNotEquals [message] expected actual
assertSame [message] expected actual                   等价于assertEquals
assertNotSame [message] unexpected actual          等价于assertNotEquals
assertNull [message] value
assertNotNull [message] value
assertTrue [message] condition
   assertTrue "[ 34 -gt 23 ]"
   assertTrue 'test failed' "[ -r /some/non-existant/file ]"
   assertTrue 'test failed' '[ 1 -eq 1 -a 2 -eq 2 ]'
assertFalse [message] condition

Failures[失败]

和断言不同，Failures函数不会对期望值和实际值进行比较，纯粹就是报告测试失败。通常用于复杂的逻辑测试，Assert的函数无法满足测试需求，我们想用自己的代码自行测试，而对该单元测试做一个简单的标记。

fail [message]
failNotEquals [message] unexpected actual
failSame [message] expected actual
failNotSame [message] expected actual

Setup/Teardown

oneTimeSetUp
oneTimeTearDown
setUp
tearDown

这4个函数在上面介绍过了。

Skipping

startSkipping 强制跳过剩余测试
endSkipping 
isSkipping

Suites

标准的测试集合中，测试用例需要以test开头，如果想测试一些非标准命名的函数，就需要用到以下函数。记住，通常我们不希望这样使用。

suite
suite_addTest name

高级用法

一些常用的宏

预定义

Constant	Value
SHUNIT_VERSION	The version of shUnit2 you are running.
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.

用户自定义

Constant	Value
SHUNIT_PARENT	The filename of the shell script containing the tests. This is needed specifically for Zsh support.

特殊

${ASSERT_EQUALS}: 包含行数信息的宏，可替换assert函数。

#! /bin/sh
# file: examples/lineno_test.sh
 
testLineNo()
{
  # this assert will have line numbers included (e.g. "ASSERT:[123] ...") if
  # they are supported.
  echo "_ASSERT_EQUALS_ macro value: ${_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
. ../src/shunit2

输出

testLineNo
_ASSERT_EQUALS_ macro value: eval assertEquals --lineno "${LINENO:-}"
ASSERT:[9] not equal expected:<1> but was:<2>
ASSERT:not equal expected:<1> but was:<2>
Ran 1 test.
FAILED (failures=2)

测试Skipping

脚本

# available as 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))
}

单元测试用例

#! /bin/sh
# available as 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
. ../src/shell/shunit2 

在Bash shell的执行结果：

testAdding
 
Ran 1 test.
 
OK

在Unix shell执行结果却是：

testAdding
 
Ran 1 test.
 
OK (skipped=1)

Skipping可以使用startSkipping()、endSkipping()和isSkipping()这三个函数进行控制。

我是咕咕鸡，一个还在不停学习的全栈工程师。
热爱生活，喜欢跑步，家庭是我不断向前进步的动力。