bugfree使用手冊(官方)

BugFree2使用幫助BugFree官方網(wǎng)址：

BugFree論壇：/forum目錄幫助文檔使用說明BugFree簡介BugFree服務器安裝全新安裝BugFree2從BugFree2.0RTM或2.0.x升級從BugFree1.1升級BugFree界面主界面創(chuàng)建界面Bug管理Bug的3種狀態(tài)Bug生命周期Bug的七種解決方案Bug字段說明TestCase管理TestCase狀態(tài)TestCase字段說明TestResult管理TestCase的執(zhí)行結果查詢結果設置查詢條件快速篩選自定義顯示字段查詢結果排序統(tǒng)計報表BugFree使用技巧發(fā)送郵件通知在Bug和Case中使用UBB代碼更改上傳附件的大小使用快捷鍵后臺管理BugFree管理員角色系統(tǒng)管理員項目管理員用戶組管理員管理員的具體權限用戶管理禁用和激活用戶用戶組管理項目管理模塊管理禁用和激活項目用戶日志BugFree應用程序接口

幫助文檔使用說明本文檔已按照最新版本的BugFree2進行了更新，部分內(nèi)容可能不適用于老版本的BugFree。建議訪問BugFree下載頁面，下載并升級至最新版本的BugFree。BugFree簡介BugFree基于PHP和MySQL開發(fā)，是免費且開發(fā)源代碼的缺陷管理系統(tǒng)。服務器端在Linux和Windows平臺上都可以運行；客戶端無需安裝任何軟件，通過IE，F(xiàn)ireFox等瀏覽器就可以自由使用。BugFree2在BugFree1.1的基礎上，集成了TestCase和TestResult的管理功能。具體使用流程是：首先創(chuàng)建TestCase（測試用例），運行TestCase產(chǎn)生TestResult（測試結果），運行結果為Failed的Case，可以直接創(chuàng)建Bug。TestCase標題、步驟和TestResult運行環(huán)境等信息直接復制到新建的Bug中。如下圖所示。BugFree服務器安裝全新安裝BugFree2在安裝BugFree2之前，需要首先安裝Apache,PHP,Mysql支持軟件包，例如XAMPP或EASYPHP等。

下面以XAMPP為例進行說明。請先訪問/zh_cn/xampp.html下載并安裝最新的XAMPP版本。1.

下載BugFree2安裝包，解壓后復制到XAMPP系統(tǒng)的htdocs子目錄下。

如果是Linux系統(tǒng)，安裝路徑一般為/opt/lampp/htdocs/bugfree;Window系統(tǒng)的安裝路徑一般為C:\xampp\htdocs\bugfree。2.

進入bugfree的安裝目錄，復制文件Include/Config.inc.Sample.php為新文件Include/Config.inc.php，編輯新創(chuàng)建的文件，修改數(shù)據(jù)庫鏈接設置：/*3.DefinetheusernameandpasswordoftheBugFreedatabase.*/$_CFG['DB']['User']

='root';

//數(shù)據(jù)庫登錄用戶名$_CFG['DB']['Password']

='';

//數(shù)據(jù)庫登錄用戶密碼$_CFG['DB']['Host']

='localhost';

//數(shù)據(jù)庫服務器地址$_CFG['DB']['Database']

='bugfree2';

//指定BugFree數(shù)據(jù)庫名稱$_CFG['DB']['TablePrefix']='bf_';

//數(shù)據(jù)庫表前綴，默認為bf_。除非有沖突，不建議修改或為空$_CFG['DBCharset']

='UTF8';

//數(shù)據(jù)庫編碼設置，保留默認值3.

如果是Linux系統(tǒng)，修改下列目錄和文件的權限；如果是Windows系統(tǒng)，跳過這一步。a)

chmod777Data/TplCompile/b)

chmod777BugFile/c)

chmod777Include/Config.inc.php4.

在瀏覽器訪問http://<servername>/bugfree。如果設置的數(shù)據(jù)庫不存在，按照提示創(chuàng)建數(shù)據(jù)庫，再點擊繼續(xù)安裝。5.

點擊“安裝全新的BugFree2”6.

安裝成功后，顯示首次登錄的默認管理員帳號和密碼，按照提示首先使用默認管理員用戶名和密碼登陸B(tài)ugFree。從BugFree2.0RTM或2.0.x升級升級之前，為防止數(shù)據(jù)丟失，建議從瀏覽器退出BugFree，并備份相應的數(shù)據(jù)庫和虛擬目錄。1.

下載BugFree2安裝包，解壓后復制到原BugFree安裝目錄下，覆蓋原有文件。2.

在瀏覽器訪問http://<servername>/bugfree。3.

點擊“從現(xiàn)有的BugFree2升級”從BugFree1.1升級升級之前，為防止數(shù)據(jù)丟失，建議在瀏覽器退出BugFree，并備份相應的數(shù)據(jù)庫和虛擬目錄。1.

下載BugFree2安裝包，解壓后復制到原BugFree的安裝目錄下，覆蓋原有文件。2.

進入Bugfree的安裝目錄，復制文件Include/Config.inc.Sample.php為新文件Include/Config.inc.php，編輯新創(chuàng)建的文件，并復制Include/ConfigBug.inc.php的相應設置。3.

點擊“從BugFree1升級”，完成BugFree1.1到BugFree2注意：如果BugFree1.1升級到BugFree2之后顯示亂碼，請修改Include/Config.inc.php的$_CFG['DBCharset']值為空，再恢復原有的BugFree1.1數(shù)據(jù)庫，重新進行升級$_CFG['DBCharset']

=''

BugFree界面主界面訪問http://<servername>/bugfree，輸入用戶名和密碼登錄成功后，顯示BugFree主界面：

項目選擇框①：可以快速切換當前項目，項目模塊框②和查詢結果框⑥顯示相應的模塊結構和記錄。

項目模塊框②：顯示當前項目的模塊結構。點擊某一模塊，查詢結果框⑥會顯示所選模塊的所有記錄。

個性顯示框③：a)

指派給我：顯示最近10條指派給我的記錄。b)

由我創(chuàng)建：顯示最近10條由我創(chuàng)建的記錄。c)

我的查詢：保存查詢框⑤的查詢條件。

模式切換標簽④：切換Bug,TestCase和TestResult模式。默認登陸為Bug模式。

查詢框⑤：設置查詢條件。

查詢結果框⑥：顯示當前查詢的結果。a)

自定義顯示：設置查詢結果的顯示字段。b)

統(tǒng)計報表：顯示當前查詢結果的統(tǒng)計信息。c)

導出：將查詢結果顯示的自定義字段導出到XML文件。最多可同時導出5000條記錄。d)

導入（僅支持TestCase模式）：可以將導出的XML文件在Excel進行編輯后，再導入到BugFree中，實現(xiàn)TestCase批量編輯。最大支持2M大小的XML文件。e)

批量運行（僅支持TestCase模式）：可以對查詢結果的TestCase同時創(chuàng)建TestResult。最多支持100個TestCase。

導航欄⑦：顯示當前登錄用戶名等信息。創(chuàng)建界面為了保持用戶體驗的一致性，新建Bug,TestCase和TestResult的界面布局基本保持一致，只是具體填寫字段有所不同。以新建Bug為例，在主界面模式切換標簽選擇Bug，點擊[新建Bug]打開新建Bug頁面。如下圖，黃色標注字段為必填項。

Bug管理Bug的3種狀態(tài)狀態(tài)說明Active(活動)Bug的初始狀態(tài)。任何新建的Bug狀態(tài)都是Active?？梢酝ㄟ^編輯修改Bug的內(nèi)容，并指派給合適的人員解決。Resolved(已解決)解決Bug之后的狀態(tài)。Closed(已關閉)已修復Bug在驗證無誤之后關閉，該Bug處理完畢。如果沒有真正解決或者重新復現(xiàn)，可以重新激活，Bug狀態(tài)重新變?yōu)锳ctive。

Bug生命周期新建的Bug處于Active狀態(tài)，可以通過編輯指派給合適的解決者。解決Bug之后，Bug狀態(tài)變?yōu)镽esolved，并自動指派給創(chuàng)建者。創(chuàng)建者驗證Bug。如果未修復，再重新激活，Bug狀態(tài)重新變?yōu)锳ctive；如果已經(jīng)修復則可以關閉，Bug狀態(tài)變?yōu)镃losed，Bug生命周期結束。已經(jīng)Closed的Bug如果重新復現(xiàn)，也可以直接激活。具體流程如下圖所示。Bug的七種解決方案類型解決方案詳細說明

三種無效的BugByDesign設計需求就是這么設計的Duplicate這個問題別人已經(jīng)發(fā)現(xiàn)NotRepro無法復現(xiàn)的問題

四種有效的BugFixed問題被修復External外部原因(比如瀏覽器、操作系統(tǒng)、其他第三方軟件)造成的問題Postponed發(fā)現(xiàn)的太晚了，下一個版本討論是否解決Won’tFix是個問題，但是不值得修復

Bug字段說明Bug標題：為包含關鍵詞的簡單問題摘要，要有利于其他人員進行搜索或通過標題快速了解問題。

項目名/模塊路徑：指定問題出現(xiàn)在哪個項目的哪個模塊。Bug處理過程中，需要隨時根據(jù)需要修改項目或模塊，方便跟蹤。如果后臺管理指定了模塊負責人，選擇模塊時，會自動指派給負責人。

指派給：Bug的當前處理人。如果不知道Bug的處理人，可以指派給Active，項目或模塊負責人再重新分發(fā)、指派給具體人員。如果設定了郵件通知，被指派者會收到郵件通知。狀態(tài)為Closed的Bug，默認會指派給Closed，表示Bug生命周期的結束。

抄送給：需要通知相關人員時填寫，例如測試主管或者開發(fā)主管等?？梢酝瑫r指派多個，人員之間用逗號分隔。如果設定了郵件通知，當Bug有任何更新時，被指派者都會收到郵件通知。

嚴重程度：Bug的嚴重程度。由Bug的創(chuàng)建者視情況來指定，其中1為最嚴重的問題，4為最小的問題。一般1級為系統(tǒng)崩潰或者數(shù)據(jù)丟失的問題；2級為主要功能的問題；3級為次要功能的問題；4級為細微的問題。

優(yōu)先級：Bug處理的優(yōu)先級。由Bug的處理人員按照當前業(yè)務需求、開發(fā)計劃和資源狀態(tài)指定，其中1的優(yōu)先級最高，4的優(yōu)先級最低。一般1級為需要立即解決的問題；2級為需要在指定時間內(nèi)解決的問題；3級為項目開發(fā)計劃內(nèi)解決的問題；4級為資源充沛時解決的問題。

其余選項字段（Bug類型、如何發(fā)現(xiàn)、操作系統(tǒng)、瀏覽器）：可以通過編輯Lang/ZH_CN_UTF-8/_COMMON.php來自定義。創(chuàng)建Build：Bug是在哪個版本（Build或者Tag）被發(fā)現(xiàn)的。

解決Build：Bug是在哪個版本（Build或者Tag）被解決的。

解決方案：參考Bug的七種解決方案。如果解決方案為Duplicated，需要指定重復Bug的編號。處理狀態(tài)：Bug處理過程的附屬子狀態(tài)，例如LocalFix表示已在本地修復；CheckedIn表示修復代碼已經(jīng)提交；Can’tRegress表示修復的問題暫無法驗證等。

機器配置：測試運行的硬件環(huán)境，例如DellG2802G/200G。

關鍵詞：主要用于自定義標記，方便查詢。關鍵詞之間用逗號或者空格分隔。例如，對于跨團隊的項目開發(fā)，可以約定一個關鍵詞統(tǒng)一標記項目。

相關Bug：與當前Bug相關的Bug。例如，相同代碼產(chǎn)生的不同問題，可以在相關Bug注明。

相關Case：與當前Bug相關的Case。例如，測試遺漏的Bug可以在補充了Case之后，在Bug的相關Case注明。

上傳附件：上傳Bug的屏幕截圖，Log日志或者CallStack等，方便處理人員。復現(xiàn)步驟：[步驟]要描述清晰，簡明扼要，步驟數(shù)盡可能少；[結果]說明Bug產(chǎn)生的錯誤結果；[期望]說明正確的結果?？梢栽赱備注]提供一些輔助性的信息，例如，這個bug在上個版本是否也能復現(xiàn)，方便處理人員。TestCase管理測試用例（TestCase）是在測試執(zhí)行之前設計的一套詳細的測試計劃，包括測試環(huán)境、測試步驟、測試數(shù)據(jù)和預期結果。在導航欄點擊TestCase，即切換到TestCase模式，點擊[新建Case]，創(chuàng)建測試用例?？梢酝ㄟ^頁面上方的[復制]按鈕快速創(chuàng)建類似的測試用例。TestCase狀態(tài)Case狀態(tài)詳細說明Active標示有效的測試用例。所有新建Case都默認為該狀態(tài)Blocked當前Case因為其他原因，無法正常運行。通過編輯Case進行修改Investigating待研究確認的測試用例。通過編輯Case進行修改Reviewed通過測試用例評審的用例。通過編輯Case進行修改TestCase字段說明Case標題：測試點的簡單描述（30字以內(nèi)）或測試的目的。

項目名/模塊路徑：指定測試用例對應的項目名稱和模塊路徑。

指派給：執(zhí)行TestCase的人員。如果不知道具體的用例執(zhí)行人員，可以指派給Active。

抄送給：需要通知相關人員時填寫?？梢酝瑫r指派多個，人員之間用逗號分隔。

優(yōu)先級：Case執(zhí)行的優(yōu)先級。1：冒煙測試及每次測試都需執(zhí)行的用例，嚴重程度最高；2：覆蓋產(chǎn)品所有主要功能；3：次要功能；4：細節(jié)功能（資源有限時，可以不執(zhí)行）。其余選項字段（Case類型、測試方法、測試計劃等）：可以通過編輯Lang/ZH_CN_UTF-8/_COMMON.php來自定義。標記刪除：用來標記已失效的用例，再通過查詢條件進行排除。

關鍵詞：主要用于自定義標記，方便查詢。關鍵詞之間用逗號或者空格分隔。例如，對于跨團隊的項目開發(fā)，可以約定一個關鍵詞統(tǒng)一標記項目。

顯示順序：通過輸入0~255之間的任一整數(shù)實現(xiàn)對TestCase的自定義排序。例如，按照業(yè)務執(zhí)行的流程重新排列Case的顯示順序。TestResult管理TestResult只能通過運行已有測試用例來創(chuàng)建。打開一個已有的測試用例，點擊頁面上方[運行]按鈕，進入創(chuàng)建TestResult頁面。Case標題、模塊路徑和步驟等信息自動復制到新的TestResult中。同時，TestResult相關Case自動指向該測試用例。記錄執(zhí)行結果（Passed或Failed）和運行環(huán)境信息（運行Build、操作系統(tǒng)、瀏覽器等信息），保存測試用例。針對執(zhí)行結果為Fail的TestResult，點擊頁面上方的[新建Bug]按鈕，創(chuàng)建新Bug。Result標題、模塊路徑、運行環(huán)境和步驟等信息自動復制到新的Bug中。同時TestResult相關Bug指向新建Bug。TestCase的執(zhí)行結果Case狀態(tài)詳細說明Passed運行成功的TestCaseFailed運行失敗的TestCase

查詢結果設置查詢條件BugFree默認顯示2個查詢組，每組有3個查詢字段（總共6個查詢字段）。假設要查詢項目Project1,Project2和Project3從2008年1月1日查詢技巧：

1.點擊[保存查詢]按鈕，可以將當前的查詢條件保存到右下角個性查詢框“我的查詢”標簽頁。點擊已保存的查詢，可以對查詢條件進行編輯和修改。

2.日期類型字段支持相對日期的查詢。例如，創(chuàng)建日期=-1將查詢所有昨天創(chuàng)建的Bug。

3.通過“包含”操作，可以指定多個查詢值。例如，創(chuàng)建者包含user1,user2，搜索結果將顯示兩個創(chuàng)建者的Bug。注意：BugFree默認支持6個查詢字段，可以通過修改Include/Config.inc.php下面的值更改查詢字段的數(shù)量。$_CFG['QueryFieldNumber']=6;

//ThefieldsnumbertoqueryinQueryBugForm.php

快速篩選在搜索結果列點擊某一字段的值，可以快速進行篩選，篩選列高亮顯示。例如，要查看所有解決方案為ByDesign的Bug，如下圖，點擊任一解決方案為ByDesign的Bug。

注意：篩選會忽略當前設置的查詢條件。自定義顯示字段在查詢結果框右上角，點擊[自定義顯示]鏈接，可以顯示或隱藏查詢結果的字段和顯示順序。

查詢結果排序點擊搜索結果標題某一字段的標題欄，可以按該字段對搜索結果進行排序。再次點擊則切換升序或降序。例如，需要查看最近更新的Bug，首先添加“最后修改日期”自定義字段，再在查詢結果標題欄點擊該字段。

統(tǒng)計報表在查詢結果框右上角，點擊[統(tǒng)計報表]鏈接打開新窗口。統(tǒng)計報表可以顯示Bug,TestCase或TestResult當前查詢結果的統(tǒng)計信息。在統(tǒng)計報表頁面的左側選擇統(tǒng)計項，點擊[查看統(tǒng)計]按鈕，右側顯示Flash統(tǒng)計圖表。如下圖：BugFree使用技巧發(fā)送郵件通知在安裝過程或者通過編輯Include/Config.inc.php文件可以啟用郵件通知功能。例如，修改如下SMTP服務器信息。/*9.SMTPparamsetting.*/$_CFG['Mail']['SendParam']['Host']

='localhost';

//Theservertoconnect.Defaultislocalhost$_CFG['Mail']['SendParam']['SMTPAuth']=false;

//WhetherornottouseSMTPauthentication.DefaultisFALSE$_CFG['Mail']['SendParam']['Username']='';

//TheusernametouseforSMTPauthentication.$_CFG['Mail']['SendParam']['Password']='';

//ThepasswordtouseforSMTPauthentication.BugFree可以實時和定時發(fā)送郵件通知。在新建Bug或TestCase并保存后，指派給和抄送給將收到實時郵件通知?？梢栽凇俺徒o”編輯框輸入多個用戶帳號或者郵件地址，地址之間用逗號分隔。如下圖，BugFree自動按照輸入的字母對用戶名進行篩選。BugFree還可以發(fā)送定期郵件通知。1.

如果需要定期對所有未關閉Bug的當前指派者發(fā)送郵件提醒，在Linux環(huán)境下定期執(zhí)行bugfree/Shell/NoticeBug.sh；Windows環(huán)境下則定期執(zhí)行bugfree/Shell/NoticeBug.bat。2.

如果需要每周接收各項目/模塊的過去7天新增Bug和超過7天未處理的Bug的郵件通知：a)

后臺管理頁面，編輯指定的項目，在通知郵箱編輯框輸入郵件接收的地址。b)

Linux環(huán)境下，通過crontab定期執(zhí)行bugfree/Shell/StatBug.sh；Windows環(huán)境下則可以通過定時任務程序定期執(zhí)行bugfree/Shell/StatBug.bat。在Bug和Case中使用UBB代碼新增功能新增功能BugFree2.0提供了對基本UBB代碼的支持，可以在編寫復現(xiàn)步驟和注釋時添加鏈接、設置字體、嵌入圖像等，也可以直接引用bug，case和result。例如，編輯狀態(tài)下輸入文字：鏈接[url][/url]字體[b]加粗[/b],[i]斜體[/i],[u]下劃線[/u]引用bug#[bug]100[/bug],case#[case]11[/case],result#[result]6[/result]嵌入圖像[img]/buglifecycle.png[/img]保存后的顯示效果：

更改上傳附件的大小BugFree默認附件大小為1000K，可以編輯Include/Config.inc.php文件下列設置更改上傳文件大小。$_CFG['File']['MaxFileSize']

=1024*1000;

//Themaxfilesize(Byte).

使用快捷鍵以下快捷鍵需要瀏覽器支持。頁面快捷鍵說明主頁面Ctrl+G彈出一個對話框。輸入ID后，直接打開相應編號的Bug，Case或ResultBug,Case和Result通用快捷鍵Alt+P顯示查詢結果的上一個記錄Alt+N顯示查詢結果的下一個記錄Alt+E編輯當前記錄Alt+S保存記錄Bug頁面Alt+R解決BugAlt+C關閉BugAlt+A激活BugCase頁面Alt+C復制CaseAlt+R運行CaseResult頁面Alt+B創(chuàng)建Bug

后臺管理BugFree管理員角色BugFree的管理員包括系統(tǒng)管理員、項目管理員和用戶組管理員三種角色?？梢酝瑫r指派任意用戶為任意角色。這三種管理員登陸B(tài)ugFree之后，主頁面上方導航欄會顯示一個[后臺管理]的鏈接。系統(tǒng)管理員全新安裝BugFree之后，會自動創(chuàng)建一個默認的系統(tǒng)管理員帳號admin。你可以通過編輯BugFree目錄下的Include/Config.inc.php文件，增加其他系統(tǒng)管理員帳號。例如，假設要將user1設置為系統(tǒng)管理員。編輯Include/Config.inc.php文件，將user1添加到下面的行。/*2.Defineadminuserlist.Likethis:array('admin','test1')*/

$_CFG['AdminUser']=array('admin',’user1’);注意：如果user1不存在，首先需要默認管理員帳號admin登錄之后，創(chuàng)建該用戶。項目管理員項目管理員只能由系統(tǒng)管理員指派，指定哪些用戶組可以訪問當前項目。該角色負責維護Bug和Case的模塊結構。用戶組管理員用戶組管理員可以由系統(tǒng)管理員或者其他用戶組管理員指派，負責維護一個用戶組。一般情況下，用戶組管理員和項目管理員可以是同一個用戶。但是在大型的組織，在人員很多的情況下，可以指派專人對用戶組進行維護。技術負責人則擔當項目管理員的角色，負責維護Bug和Case的模塊結構。管理員的具體權限系統(tǒng)管理員、項目管理員和用戶組管理員三種角色的詳細權限如下表所列。

系統(tǒng)管理員項目管理員用戶組管理員項目管理可以添加項目可以查看和編輯所有項目可以修改項目名稱和顯示順序可以指派項目用戶組可以指派項目管理員可以編輯Bug或Case模塊不可以添加項目僅可以查看和編輯自己是項目管理員的項目不可以修改項目名稱和顯示順序可以指派項目用戶組不可以指派項目管理員可以編輯Bug或Case模塊無權限用戶管理可以查看所有用戶可以添加用戶可以編輯、禁用或激活所有用戶可以查看所有用戶可以添加用戶可以編輯、禁用或激活自己創(chuàng)