使用 Bash shell 指令碼進行功能測試

建立指令碼
功能測試是軟體開發的一個關鍵區段 -- 而已經裝入 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" 命令。
需要將指令碼的第一行：
#!/usr/bin/ksh
修改成：
#!/bin/bash

建立 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 nameSILENT="no"                  # User wants promptslet "errorCounter = 0"# ----------------------------------# Handle keyword parameters (flags).# ----------------------------------# For more sophisticated usage of getopt in Linux, # see the samples file: /usr/lib/getopt/parse.bashTEMP=`getopt hs $*`if [ $? != 0 ]then echo "$CALLER: Unknown flag(s)"  usagefi # 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."  usagefi
關於此指令碼的說明如下：

使用語句 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" 語句，如下所示：
./test-bucket-1 -h

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"  fi
……而是建立一個如下所示的函數，此函數也可以處理返回碼，如果有必要，還可以增加錯誤計數器：
代碼: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    projectleadCreateAccess Development pat    generalCreateAccess 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

假若這樣，相類似的管道如下：

process --> output file

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 指令碼中僅使用字串而不是整數。在我所參考的手冊中沒有清楚地說明如何使用整數，這就是我為什麼想在此就關於如何使用整數和計算錯誤（行命令失敗）數量的方面多展開講的原因：
首先，需要按如下方式對計數器變數進行初始化：

let "errorCounter = 0"

然後，發出行命令並使用 $? 變數捕獲返回碼。如果返回碼不是 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/fvtecho "Creating file softtar.c"echo "Subject: This is softtar.c" >  softtar.cecho "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.  ***" terminateelse 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" 的尾部並查看摘要報告的結論。