創建腳本
功能測試是軟件開發的一個關鍵部分 -- 而已經裝入 Linux 的 Bash 可以幫您輕而易舉地完成功能測試。在本文中,Angel Rivera 將說明如何運用 Bash shell 腳本通過行命令來執行 Linux 應用程序的功能測試。由于此腳本依賴于命令行的返回碼,因而您不能將這種方法運用于 GUI 應用程序。
功能測試是開發周期的一個階段,在這個階段中將測試軟件應用程序以確保軟件的函數如預期的那樣,同時能正確處理代碼中錯誤。此項工作通常在單個模塊的單元測試結束之后,在負載/重壓條件下整個產品的系統測試之前進行的。 小蟲網絡技術
市場上有許多測試工具提供了有助于功能測試的功能。然而,首先要獲取它們,然后再安裝、配置,這將占用您寶貴的時間和精力。Bash 可以幫您免去這些煩瑣的事從而可以加快測試的進程。
使用 Bash shell 腳本進行功能測試的優點在于:
Bash shell 腳本已經在 Linux 系統中安裝和配置好了。不必再花時間準備它。可以使用由 Linux 提供的文本編輯器如 vi 創建和修改 Bash shell 腳本。不需要再為創建測試程序而獲取專門的工具。
如果已經知道了如何開發 Bourne 或 Korn shell 腳本,那對于如何運用 Bash shell 腳本已經足夠了。對您來說,學習曲線已不存在了。
Bash shell 提供了大量的編程構造用于開發從非常簡單到中等復雜的腳本。
將腳本從 Korn 移植到 Bash 時的建議
如果已有現成的 Korn shell 腳本,而想要將它們移植到 Bash,就需要考慮下列情況:
Korn 的 "print" 命令在 Bash 中不能使用;而是改為使用 "echo" 命令。
需要將腳本的第一行:
修改成:
創建 Bash shell 腳本進行功能測試,這些基本的步驟和建議適用于許多在 Linux 上運行的客戶機/服務器應用程序。
記錄運行腳本的先決條件和主要步驟:
將操作分成若干個邏輯組。
基于一般方案制定執行步驟:
在每個 shell 腳本中提供注釋和說明;
做一個初始備份以創建基準線;
檢查輸入參數和環境變量;
嘗試提供 "usuage" 反饋;
嘗試提供一個"安靜"的運行模式;
當出現錯誤時,提供一個函數終止腳本;
如可能,提供可以執行單個任務的函數;
當顯示正在生成的輸出時,捕獲每個腳本的輸出;
在每個腳本內,捕獲每個行命令的返回碼;
計算失敗事務的次數;
在輸出文件中,突出顯示錯誤消息,以便于標識;
如有可能,"實時"生成文件;
在執行腳本的過程中提供反饋;
提供腳本執行的摘要;
提供一個容易解釋的輸出文件;
如有可能,提供清除腳本及返回基準線的方法。
下面詳細講述了每一條建議以及用于說明問題的腳本。若要下載此腳本,請參閱本文后面的參考資料部分。
1. 記錄運行腳本的先決條件和主要步驟
記錄,尤其是以有自述標題的單個文件(例如 "README-testing.txt")記錄功能測試的主要想法是很重要的,包括,如先決條件、服務器和客戶機的設置、腳本遵循的整個(或詳細的)步驟、如何檢查腳本的成功/失敗、如何執行清除和重新啟動測試。
2. 將操作分成若干個邏輯組
如果僅僅執行數量非常少的操作,可以將它們全部放在一個簡單的 shell 腳本中。
但是,如果需要執行一些數量很多的操作,那最好是將它們分成若干個邏輯集合,例如將一些服務器操作放在一個文件而將客戶機操作放在在另一個文件中。通過這種方法,劃分適當的顆粒度來執行測試和維護測試。
3. 基于一般方案制定執行步驟
一旦決定對操作進行分組,需要根據一般方案考慮執行操作的步驟。此想法是模擬實際生活中最終用戶的情形。作為一個總體原則,只需集中測試 80% 最常調用函數的 20% 用法即可。
例如,假設應用程序要求 3 個測試組以某個特定的順序排列。每個測試組可以放在一個帶有自我描述文件名(如果可能)的文件中,并用號碼來幫助識別每個文件的順序,例如:
1. fvt-setup-1: To perform initial setup.
2. fvt-server-2: To perform server commands.
3. fvt-client-3: To perform client commands.
4. fvt-cleanup: To cleanup the temporary files,
in order to prepare for the repetition
of the above test cases. |
4. 在每個 shell 腳本中提供注釋和說明
在每個 shell 腳本的頭文件中提供相關的注釋和說明是一個良好的編碼習慣。這樣的話,當另一個測試者運行該腳本時,測試者就能清楚地了解每個腳本中測試的范圍、所有先決條件和警告。
下面是一個 Bash 腳本 "test-bucket-1" 的示例 。
#!/bin/bash
#
# Name: test-bucket-1
#
# Purpose:
# Performs the test-bucket number 1 for Product X.
# (Actually, this is a sample shell script,
# which invokes some system commands
# to illustrate how to construct a Bash script)
#
# Notes:
# 1) The environment variable TEST_VAR must be set
# (as an example).
# 2) To invoke this shell script and redirect standard
# output and standard error to a file (such as
# test-bucket-1.out) do the following (the -s flag
# is "silent mode" to avoid prompts to the user):
#
# ./test-bucket-1 -s 2>&1 | tee test-bucket-1.out
#
# Return codes:
# 0 = All commands were successful
# 1 = At least one command failed, see the output file
# and search for the keyword "ERROR".
# |
5. 做一個初始備份以創建基準線
您可能需要多次執行功能測試。第一次運行它時,也許會找到腳本或進程中的一些錯誤。因而,為了避免因從頭重新創建服務器環境而浪費大量時間 -- 特別是如果涉及到數據庫 -- 您在測試之前或許想做個備份。
在運行完功能測試之后,就可以從備份中恢復服務器了,同時也為下一輪測試做好了準備。
6. 檢查輸入參數和環境變量
最好校驗一下輸入參數,并檢查環境變量是否設置正確。如果有問題,顯示問題的原因及其修復方法,然后終止腳本。
當測試者準備運行腳本,而此時如果沒有正確設置腳本所調用的環境變量,但由于發現及時,終止了腳本,那測試者會相當感謝。沒有人喜歡等待腳本執行了很久卻發現沒有正確設置變量。
源碼:
# --------------------------------------------
# Main routine for performing the test bucket
# --------------------------------------------
CALLER=`basename $0` # The Caller name
SILENT="no" # User wants prompts
let "errorCounter = 0"
# ----------------------------------
# Handle keyword parameters (flags).
# ----------------------------------
# For more sophisticated usage of getopt in Linux,
# see the samples file: /usr/lib/getopt/parse.bash
TEMP=`getopt hs $*`
if [ $? != 0 ]
then
echo "$CALLER: Unknown flag(s)"
usage
fi
# Note quotes around `$TEMP': they are essential!
eval set -- "$TEMP"
while true
do
case "$1" in
-h) usage "HELP"; shift;; # Help requested
-s) SILENT="yes"; shift;; # Prompt not needed
--) shift ; break ;;
*) echo "Internal error!" ; exit 1 ;;
esac
done
# ------------------------------------------------
# The following environment variables must be set
# ------------------------------------------------
if [ -z "$TEST_VAR" ]
then
echo "Environment variable TEST_VAR is not set."
usage
fi |
關于此腳本的說明如下:
使用語句 CALLER=`basename $0` 可以得到正在運行的腳本名稱。這樣的話,無須在腳本中硬編碼腳本名稱。因此當復制腳本時,采用新派生的腳本可以減少工作量。
調用腳本時,語句 TEMP=`getopt hs $*` 用于得到輸入變量(例如 -h 代表幫助,-s 代表安靜模式)。
語句 [ -z "$X" ] 和 echo "The environment variable X is not set." 以及 usage 都是用于檢測字符串是否為空 (-z),如果為空,隨后就執行 echo 語句以顯示未設置字符串并調用下面要討論的 "usage" 函數。
若腳本未使用標志,可以使用變量 "$#",它可以返回正在傳遞到腳本的變量數量。
7. 嘗試提供"usage"反饋
腳本中使用 "usage" 語句是個好主意,它用來說明如何使用腳本。
# ----------------------------
# Subroutine to echo the usage
# ----------------------------
usage()
{
echo "USAGE: $CALLER [-h] [-s]"
echo "WHERE: -h = help "
echo " -s = silent (no prompts)"
echo "PREREQUISITES:"
echo "* The environment variable TEST_VAR must be set,"
echo "* such as: "
echo " export TEST_VAR=1"
echo "$CALLER: exiting now with rc=1."
exit 1
} |
調用腳本時,使用"-h"標志可以調用 "usage" 語句,如下所示:
8. 嘗試使用"安靜"的運行模式
您或許想讓腳本有兩種運行模式:
在 "verbose" 模式(您也許想將此作為缺省值)中提示用戶輸入值,或者只需按下 Enter 繼續運行。
在 "silent" 模式中將不提示用戶輸入數據。
下列摘錄說明了在安靜模式下運用所調用標志 "-s" 來運行腳本:
# -------------------------------------------------
# Everything seems OK, prompt for confirmation
# -------------------------------------------------
if [ "$SILENT" = "yes" ]
then
RESPONSE="y"
else
echo "The $CALLER will be performed."
echo "Do you wish to proceed [y or n]? "
read RESPONSE # Wait for response
[ -z "$RESPONSE" ] && RESPONSE="n"
fi
case "$RESPONSE" in
[yY]|[yY][eE]|[yY][eE][sS])
;;
*)
echo "$CALLER terminated with rc=1."
exit 1
;;
esac |
9. 當出現錯誤時,提供一個函數終止腳本
遇到嚴重錯誤時,提供一個中心函數以終止運行的腳本不失為一個好主意。此函數還可提供附加的說明,用于指導在此情況下應做些什么:
# ----------------------------------
# Subroutine to terminate abnormally
# ----------------------------------
terminate()
{
echo "The execution of $CALLER was not successful."
echo "$CALLER terminated, exiting now with rc=1."
dateTest=`date`
echo "End of testing at: $dateTest"
echo ""
exit 1
} |
10. 如有可能,提供可以執行簡單任務的函數
例如,不使用許多很長的行命令,如:
# --------------------------------------------------
echo ""
echo "Creating Access lists..."
# --------------------------------------------------
Access -create -component Development -login ted -authority plead -verbose
if [ $? -ne 0 ]
then
echo "ERROR found in Access -create -component Development -login ted
-authority plead"
let "errorCounter = errorCounter + 1"
fi
Access -create -component Development -login pat -authority general -verbose
if [ $? -ne 0 ]
then
echo "ERROR found in Access -create -component Development -login pat
-authority general"
let "errorCounter = errorCounter + 1"
fi
Access -create -component Development -login jim -authority general -verbose
if [ $? -ne 0 ]
then
echo "ERROR found in Access -create -component Development -login jim
-authority general"
let "errorCounter = errorCounter + 1" |
而是創建一個如下所示的函數,此函數也可以處理返回碼,如果有必要,還可以增加錯誤計數器:
CreateAccess()
{
Access -create -component $1 -login $2 -authority $3 -verbose
if [ $? -ne 0 ]
then
echo "ERROR found in Access -create -component $1 -login $2 -authority $3"
let "errorCounter = errorCounter + 1"
fi
} |
然后,以易讀和易擴展的方式調用此函數:
# -------------------------------------------
echo ""
echo "Creating Access lists..."
# -------------------------------------------
CreateAccess Development ted projectlead
CreateAccess Development pat general
CreateAccess Development jim general |
11. 當顯示正在生成的輸出時,捕獲每個腳本的輸出
如果腳本不能自動地將輸出發送到文件的話,可以利用 Bash shell 的一些函數來捕獲所執行腳本的輸出,如:
./test-bucket-1 -s 2>&1 | tee test-bucket-1.out |
讓我們來分析上面的命令:
"2>&1" 命令:
使用 "2>&1" 將標準錯誤重定向到標準輸出。字符串 "2>&1" 表明任何錯誤都應送到標準輸出,即 UNIX/Linux 下 2 的文件標識代表標準錯誤,而 1 的文件標識代表標準輸出。如果不用此字符串,那么所捕捉到的僅僅是正確的信息,錯誤信息會被忽略。
管道 "|" 和 "tee" 命令:
UNIX/Linux 進程和簡單的管道概念很相似。既然這樣,可以做一個管道將期望腳本的輸出作為管道的輸入。下一個要決定的是如何處理管道所輸出的內容。在這種情況下,我們會將它捕獲到輸出文件中,在此示例中將之稱為 "test-bucket-1.out"。
但是,除了要捕獲到輸出結果外,我們還想監視腳本運行時產生的輸出。為達到此目的,我們連接允許兩件事同時進行的 "tee" (T- 形管道):將輸出結果放在文件中同時將輸出結果顯示在屏幕上。 其管道類似于:
process --> T ---> output file
|
V
screen |
如果只想捕獲輸出結果而不想在屏幕上看到輸出結果,那可以忽略多余的管道:
./test-bucket-1 -s 2>&1 > test-bucket-1.out |
假若這樣,相類似的管道如下:
12. 在每個腳本內,捕獲每個行命令所返回碼
決定功能測試成功還是失敗的一種方法是計算已失敗行命令的數量,即返回碼不是 0。變量 "$?" 提供最近所調用命令的返回碼;在下面的示例中,它提供了執行 "ls" 命令的返回碼。
# -------------------------------------------
# The commands are called in a subroutine
# so that return code can be
# checked for possible errors.
# -------------------------------------------
ListFile()
{
echo "ls -al $1"
ls -al $1
if [ $? -ne 0 ]
then
echo "ERROR found in: ls -al $1"
let "errorCounter = errorCounter + 1"
fi
} |
13. 記錄失敗事務的次數
在功能測試中決定其成功或失敗的一個方法是計算返回值不是 0 的行命令數量。但是,從我個人的經驗而言,我習慣于在我的 Bash shell 腳本中僅使用字符串而不是整數。在我所參考的手冊中沒有清楚地說明如何使用整數,這就是我為什么想在此就關于如何使用整數和計算錯誤(行命令失敗)數量的方面多展開講的原因:
首先,需要按如下方式對計數器變量進行初始化:
然后,發出行命令并使用 $? 變量捕獲返回碼。如果返回碼不是 0,那么計數器增加 1(見藍色粗體語句):
ListFile()
{
echo "ls -al $1"
ls -al $1
if [ $? -ne 0 ]
then
echo "ERROR found in: ls -al $1"
let "errorCounter = errorCounter + 1"
fi
} |
順便說一下,與其它變量一樣,可以使用 "echo" 顯示整數變量。
14. 在輸出文件中,為了容易標識,突出顯示錯誤消息
當遇到錯誤(或失敗的事務)時,除了錯誤計數器的數量會增加外,最好標識出此處有錯。較理想的做法是,字符串有一個如 ERROR 或與之相似的子串(見藍色粗體的語句),這個子串允許測試者很快地在輸出文件中查找到錯誤。此輸出文件可能很大,而且它對于迅速找到錯誤非常重要。
ListFile()
{
echo "ls -al $1"
ls -al $1
if [ $? -ne 0 ]
then
echo "ERROR found in: ls -al $1"
let "errorCounter = errorCounter + 1"
fi
} |
15. 如有可能,"實時"生成文件
在某些情況下,有必要處理應用程序使用的文件。可以使用現有文件,也可以在腳本中添加語句來創建文件。如果要使用的文件很長,那最好將其作為獨立的實體。如果文件很小而且內容簡單或不相關(重要的一點是文本文件而不考慮它的內容),那就可以決定"實時"創建這些臨時文件。
下面幾行代碼顯示如何"實時"創建臨時文件:
cd $HOME/fvt
echo "Creating file softtar.c"
echo "Subject: This is softtar.c" > softtar.c
echo "This is line 2 of the file" >> softtar.c |
第一個 echo 語句使用單個的 > 強行創建新文件。第二個 echo 語句使用兩個 >> 將數據附加到現有文件的后面。順便說一下,如果該文件不存在,那么會創建一個文件。
16. 在執行腳本的過程中提供反饋
最好在腳本中包含 echo 語句以表明它執行的邏輯進展狀況。可以添加一些能迅速表明輸出目的的語句。
如果腳本要花費一些時間執行,那或許應在執行腳本的開始和結束的地方打印時間。這樣可以計算出所花費的時間。
在腳本樣本中,一些提供進展說明的 echo 語句如下所示:
# --------------------------------------------
echo "Subject: Product X, FVT testing"
dateTest=`date`
echo "Begin testing at: $dateTest"
echo ""
echo "Testcase: $CALLER"
echo ""
# --------------------------------------------
# --------------------------------------------
echo ""
echo "Listing files..."
# --------------------------------------------
# The following file should be listed:
ListFile $HOME/.profile
...
# --------------------------------------------
echo ""
echo "Creating file 1"
# -------------------------------------------- |
17. 提供腳本執行的摘要
如果正在計算錯誤或失敗事務的次數,那最好表明是否有錯誤。此方法使得測試者在看到輸出文件的最后能迅速地辨認出是否存在錯誤。
在下面的腳本示例中,代碼語句提供了上述腳本的執行摘要:
# --------------
# Exit
# --------------
if [ $errorCounter -ne 0 ]
then
echo ""
echo "*** $errorCounter ERRORS found during ***"
echo "*** the execution of this test case. ***"
terminate
else
echo ""
echo "*** Yeah! No errors were found during ***"
echo "*** the execution of this test case. Yeah! ***"
fi
echo ""
echo "$CALLER complete."
echo ""
dateTest=`date`
echo "End of testing at: $dateTest"
echo ""
exit 0
# end of file |
18. 提供一個容易解釋的輸出文件
在腳本生成的實際輸出中提供一些關鍵信息是非常有用的。那樣,測試者就可以很容易地確定正在查看的文件是否與自己所做的相關以及它是否是當前產生的。附加的時間戳記對于是否是當前狀態是很重要的。摘要報告對于確定是否有錯誤也是很有幫助的;如果有錯誤,那么測試者就必須搜索指定的關鍵字,例如 ERROR,并確認出個別失敗的事務。
以下是一段輸出文件樣本的片段:
Subject: CMVC 2.3.1, FVT testing, Common, Part 1
Begin testing at: Tue Apr 18 12:50:55 EDT 2000
Database: DB2
Family: cmpc3db2
Testcase: fvt-common-1
Creating Users...
User pat was created successfully.
...
Well done! No errors were found during the
execution of this test case
fvt-common-1 complete.
End of testing at: Tue Apr 18 12:56:33 EDT 2000 |
當遇到錯誤時輸出文件最后部分的示例如下所示:
ERROR found in Report -view DefectView
*** 1 ERRORS found during the execution of this test case. ***
The populate action for the CMVC family was not successful.
Recreating the family may be necessary before
running fvt-client-3 again, that is, you must use 'rmdb',
'rmfamily', 'mkfamily' and 'mkdb -d',
then issue: fvt-common-1 and optionally, fvt-server-2.
fvt-client-3 terminated, exiting now with rc=1.
End of testing at: Wed Jan 24 17:06:06 EST 2001 |
19. 如有可能,提供清除腳本及返回基準線的方法
測試腳本可以生成臨時文件;假若這樣,最好能讓腳本刪除所有臨時文件。這就會避免由于測試者也許沒有刪除所有臨時文件而引起的錯誤,更糟糕的是將所需要的文件當作臨時文件而刪除了。
運行功能測試的 Bash shell 腳本
本節描述如何運用 Bash shell 腳本進行功能測試。假設您已經執行了在前面部分中所述步驟。
設置必要的環境變量
根據需要在 .profile 中或手工指定下列環境變量。該變量用于說明在腳本中如何處理,所需環境變量的驗證必須在腳本執行前定義。export TEST_VAR=1.將 Bash shell 腳本復制到正確的目錄下Bash shell 腳本和相關文件需要復制到要進行功能測試的用戶標識的目錄結構下。
登錄進某個帳戶。您應該在主目錄下。假設它是 /home/tester。為測試案例創建目錄:mkdir fvt
復制 Bash shell 腳本和相關文件。獲取壓縮文件(請參閱參考資料)并將其放在 $HOME 下。然后將其按下列方式解壓:unzip trfvtbash.zip
為了執行這個文件,更改文件的許可權:chmod u+x *
更改名稱以除去文件的后綴:mv test-bucket-1.bash test-bucket-1
運行腳本
執行下列步驟以運行腳本:
以測試者的用戶標識登錄;
更改目錄至所復制腳本的位置:cd $HOME/fvt;
從 $HOME/fvt 運行腳本:./test-bucket-1 -s 2>&1 | tee test-bucket-1.out;
看一下輸出文件 "test-bucket-1.out" 的尾部并查看摘要報告的結論。