Bugfree 使用手冊使用手冊 1 Bugfree 簡介簡介 1 1 BugFree 網站網站 1 2 BugFree 的的 Logo 1 3 BugFree 的來源的來源 BugFree 是借鑒微軟的研發流程和 Bug 管理理念 使用 PHP MySQL 獨立寫出的一個 Bug 管理系統 簡單實用 免費并且開放源代碼 遵循 GNU GPL 如何有效地管理軟件產品中的 Bug 是每一家軟件企業必須面臨的問題 遺憾的是很 多軟件企業還是停留在作坊式的研發模式中 其研發流程 研發工具 人員管理不盡人意 無法有效地保證質量 控制進度 并使產品可持續發展 BugFree 就是為了解決上述問題而開發的 1 4 BugFree 名稱的含義名稱的含義 命名 BugFree 有兩層意思 一是希望軟件中的缺陷越來越少直到沒有 二是表示它是 免費且開放源代碼的 大家可以自由使用傳播 1 5 BugFree 的功效的功效 對軟件開發出現的問題進行有效的跟蹤管理 協調開發人員 測試人員和需求三方的關系 規范軟件的研發流程 通過對問題的有效跟蹤管理 可以持續地改進產品的質量 記錄對問題的處理過程 可以作為知識的積累 還可以通過自由的定制以讓 BugFree 更適合貴公司的研發流程 1 6 BugFree 適合誰用適合誰用 BugFree 適用于所有的中小 IT 企業 大規模 IT 企業的各部門 小組 各種技術開發小 組或者團隊 1 7 BugFree 的一些特色的一些特色 理念先進理念先進 BugFree 借鑒了微軟公司成熟的研發流程和 Bug 管理理念 相比于其他的 Bug 管理軟 件來講 BugFree 的處理方式更加科學 簡潔 B S 結構結構 瀏覽器 服務器的結構部署起來非常方便 用戶無需使用客戶端 只要有瀏覽器 如 IE FireFox 等 就可以非常方便的使用 BugFree 對 Bug 進行跟蹤管理 跨平臺跨平臺 BugFree 是采用 PHP 作為開發語言 采用 MySQL 作為數據庫存儲 這兩者都是跨平臺 的 所以 BugFree 可以安裝在所有支持 PHP MySQL 的平臺上面 多項目管理多項目管理 BugFree 可以同時對多個項目進行管理 非常方便 配置靈活配置靈活 BugFree 將大量的配置選項集中到配置文件和語言文件里面 可以非常根據自己的情 況進行修改 非常方便 代碼簡潔 代碼注釋規范代碼簡潔 代碼注釋規范 對 PHP 有一定了解的開發人員可以很快讀懂 BugFree 的代碼 方便進行二次開發 純中文界面純中文界面 純中文的操作界面 符合國內用戶的操作習慣 郵件自動通知郵件自動通知 當郵件發生變化的時候 會自動發信給相關人員 強大 方便的查詢功能強大 方便的查詢功能 可以非常方便的指定各種查詢條件 功能強大 并可將查詢結果方便的導入到 Microsoft Excel 中 利用 Excel 強大的統計能力對 Bug 進行分析 詳細的歷史記錄詳細的歷史記錄 對 Bug 的每一步操作都有非常詳細的記錄 2 Bugfree 在在 Windows 操作系統下的安裝操作系統下的安裝 在安裝 BugFree 之前 需要首先安裝 Apache PHP Mysql 支持軟件包 例如 XAMPP 或 EASYPHP 等 下面以 XAMPP 為例進行說明 請先訪問 http www apachefriends org zh cn xampp html 下載并安裝最新的 XAMPP 版本 這里我們 以壓縮包 xampplite win32 1 7 1 zip 為例進行說明 將壓縮包解壓到指定目錄下 文 件名為 xampplite 方便后面的操作 1 下載BugFree2 0 3 安裝包 解壓后復制到 XAMPP 系統的 htdocs 子目錄下 如 D xampplite htdocs 2 進入 bugfree 的安裝目錄 復制文件 Include Config inc Sample php 為新文件 Include Config inc php 3 在文件夾 xampplite 中找到 setup xampp bat 文件 運行 3 在文件夾 xampplite 中找到 xampp control exe 文件 雙擊打開 XAMPP Control Panel Application 窗口 如圖 2 1 所示 圖 2 1 4 依次點擊 Apache 和 MySql 后面的 Start 按鈕 啟動 Apache 和 MySql 服務 如圖 2 2 所示 圖 2 2 5 打開 IE 瀏覽器 在地址欄中輸入 http localhost 點擊回車鍵出現如圖 2 3 所示 界面 圖 2 3 6 選擇 中文 鏈接 來到友好歡迎界面 提示你成功安裝 XAMPP 如圖 2 4 所 示 圖 2 4 7 此時 在地址欄中輸入 https localhost bugfree 點擊回車鍵 系統提示 數據庫 連接失敗 如圖 2 5 所示 圖 2 5 8 點擊 創建數據庫 鏈接 成功創建數據庫 如圖 2 6 所示 圖 2 6 9 點擊 繼續安裝 提示安裝全新的 Bugfree2 如圖 2 7 所示 圖 2 7 10 點擊 安裝全新的 Bugfree2 鏈接開始安裝 安裝結束后 系統會提供默認管理 員的帳號和密碼 如圖 2 8 所示 圖 2 8 3 Bugfree 界面界面 3 1 登錄界面登錄界面 點擊圖 2 8 中 這里 鏈接到登錄界面 如圖 3 1 所示 圖 3 1 3 2 主界面主界面 輸入系統提供的默認管理員用戶名 admin 密碼 原始 123456 語言選擇默認 簡體中文 點擊 登錄 按鈕 來到 Bugfree 主界面 如圖 3 2 所示 圖 3 2 項目選擇框 可以快速切換當前項目 項目模塊框 和查詢結果框 顯示相應的 模塊結構和記錄 項目模塊框 顯示當前項目的模塊結構 點擊某一模塊 查詢結果框 會顯示所 選模塊的所有記錄 個性顯示框 a 指派給我 顯示最近 10 條指派給我的記錄 b 由我創建 顯示最近 10 條由我創建的記錄 c 我的查詢 保存查詢框 的查詢條件 模式切換標簽 切換 Bug Test Case 和 Test Result 模式 默認登陸為 Bug 模式 查詢框 設置查詢條件 查詢結果框 顯示當前查詢的結果 a 自定義顯示 設置查詢結果的顯示字段 b 全部導出 將當前查詢結果記錄導出到網頁 c 統計報表 顯示當前查詢結果的統計信息 導航欄 顯示當前登錄用戶名等信息 修改個人信息修改個人信息 1 點擊導航欄 編輯我的信息 進行密碼更改 2 根據提示填寫真是信息 Email 密碼等信息 最后點擊 提交 完成密碼修改 圖 3 3 4 后臺管理后臺管理 4 1 BugFree 管理員角色管理員角色 BugFree 的管理員包括系統管理員 項目管理員和用戶組管理員三種角色 可以同時 指派任意用戶為任意角色 這三種管理員登陸 BugFree 之后 主頁面上方導航欄會顯示一 個 后臺管理 的鏈接 4 1 1 系統管理員系統管理員 全新安裝 BugFree 之后 會自動創建一個默認的系統管理員帳號 admin 你可以通過 編輯 BugFree 目錄下的 Include Config inc php 文件 增加其他系統管理員帳號 例如 假設要將 user1 設置為系統管理員 編輯 Include Config inc php 文件 將 user1 添加到下面的行 2 Define admin user list Like this array admin test1 CFG AdminUser array admin user1 注意 如果 user1 不存在 首先需要默認管理員帳號 admin 登錄之后 創建該用戶 4 1 2 項目管理員項目管理員 項目管理員只能由系統管理員指派 指定哪些用戶組可以訪問當前項目 該角色負責 維護 Bug 和 Case 的模塊結構 把系統管理員解放出來 4 1 3 用戶組管理員用戶組管理員 可以由系統管理員或者其他用戶組管理員指派 負責維護一個用戶組 一般情況下 用戶組管理員和項目管理員可以是同一個用戶 但是在大型的組織 在人員很多的情況下 可以指派專人對用戶組進行維護 技術負責人則擔當項目管理員的角色 負責維護 Bug 和 Case 的模塊結構 4 1 4 管理員的具體權限管理員的具體權限 系統管理員 項目管理員和用戶組管理員三種角色的詳細權限如下表所列 系統管理員系統管理員項目管理員項目管理員用戶組管理員用戶組管理員 項目管理項目管理1 可以添加項目 2 可以查看和編輯所有 項目 3 可以修改項 目名稱和顯示順序 4 可以指派項目用戶 組 5 可以指派項目 管理員 6 可以編輯 Bug 或 Case 模塊 1 不可以添加項目 2 僅可以查看和編輯自 己是項目管理員的項 目 3 不可以修改項目 名稱和顯示順序 4 可 以指派項目用戶組 5 不可以指派項目管理 員 6 可以編輯 Bug 或 Case 模塊 無權限 用戶管理用戶管理1 可以查看所有用戶 2 可以添加用戶 3 可以編輯 禁用或激 活所有用戶 1 可以查看所有用戶 2 可以添加用戶 3 可 以編輯 禁用或激活 自己創建的用戶或本 人 1 可以查看所有用戶 2 可以添加用戶 3 可以編 輯 禁用或激活自己創建 的用戶或本人 用戶組管理用戶組管理1 可以查看所有用戶 組 2 可以添加用戶 組 3 可以編輯或刪 除所有用戶組 1 可以查看所有用戶組 2 可以添加用戶組 3 可以編輯或刪除自己 添加的用戶組 1 可以查看所有用戶組 2 可以添加用戶組 3 可 以編輯或刪除自己添加的 用戶組或自己是用戶組管 理員的組 4 2 用戶管理用戶管理 添加新用戶 輸入用戶名 真實姓名 密碼和郵件地址 用戶名和密碼用于登錄 BugFree 真實姓名則顯示在指派人列表中用于選擇 點擊主界面導航欄中 用戶管理 項切換到 用戶列表 界面 如圖 4 1 所示 圖 4 1 點擊 添加用戶 切換到 添加用戶 界面 如圖 4 2 所示 根據提示 填寫相應的 信息即可點擊 保存 完成 圖 4 2 禁用和激活用戶禁用和激活用戶 點擊如圖 4 1 所示 禁用 鏈接后 該用戶將無法登錄 BugFree 并從所在用戶組刪 除 包含該用戶的記錄將不再顯示該用戶的真實姓名 而以用戶名代替 再次點擊 激活 將恢復該用戶 但需要重新指派用戶組權限 4 3 用戶組管理用戶組管理 創建用戶之后 需要將用戶添加到用戶組 項目管理員通過指派用戶組來分配權限 新用戶只有在所屬用戶組指派給一個項目之后才可以登錄 BugFree 系統 安裝 BugFree 之后 系統會默認創建一個 All Users 默認組 該用戶組包含所有用 戶 不需要額外添加用戶 如圖 4 3 所示表示要添加一個叫做 Test4 的用戶組 組內有 郭彥海 李小鵬 裴 軍霞 三個成員 用戶組管理員為 李小鵬 點擊 保存用戶組 即可完成返回用戶組列 表 如圖 4 4 所示 此時 可以看到新添加的新用戶組 Test4 的信息 點擊 編輯 按 鈕就可以對其進行編輯 圖 4 3 圖 4 4 4 4 項目管理項目管理 以管理員的身份登錄后 點擊導航欄 后臺管理 打開 后臺管理 界面 管理員 可以對項目 用戶和用戶組進行相應的管理 默認為項目列表 如圖 4 5 所示 圖 4 5 這里 我們可以通過點擊 添加項目 添加一個新的項目 如圖 4 6 所示 根據實際 需求填寫相應的信息 并為項目分配合適的項目組 如圖所示 只有 T2 T3 的用戶組成員 才能訪問此項目 和項目管理員 最后點擊 保存項目 按鈕返回項目列表 此時 我們 能夠在項目列表中看到剛剛添加到項目信息 圖 4 6 項目默認顯示順序是按照創建的先后次序排列的 如果需要將某個項目排在最前面 編輯該項目 將顯示順序設置為 0 255 之間的數值 通過點擊已存在項目右端的 編輯 按鈕 也可以對此項目信息進行更改 如圖 4 7 所示 圖 4 7 4 4 1 模塊管理模塊管理 創建項目之后 通過 Bug 模塊 和 Case 模塊 鏈接 可以分別為 Bug 和 Test Case 創建樹形模塊結構 一個項目可以包含多個模塊 一個模塊下面可以包含多個子模塊 原 則上 對子模塊的層級沒有限制 如此接連不斷地 添加一個新的子模塊 注意 父模塊 的選取 則各模塊間可以形成類似圖 4 9 左側的樹狀列表 與項目的顯示順序類似 Case 模塊 可以編輯模塊的顯示數據值更改同級模塊的排 列順序 如果指定模塊負責人 在創建該模塊下的 Bug 或 Test Case 時 會自動指派給該負責人 如果刪除一個模塊之后 該模塊下面的 Bug 或 Test Case 將自動移動到其父模塊中 圖 4 8 圖 4 9 4 4 2 禁用和激活項目禁用和激活項目 點擊 禁用 后 可以隱藏某個項目 但并不真正從數據庫刪除記錄 該項目將對所 有人員不可見 再次點擊 激活 將恢復該項目所有的記錄 4 5 用戶日志用戶日志 用戶日志只有系統管理員可以查看 用于記錄用戶的登錄信息 包括登錄的用戶名 登錄機器的 IP 地址和登錄時間 5 Bug 的狀態的狀態 在 BugFree 中 一個 Bug 只有 3 種狀態 Active Resolved Closed 實踐中經常有不 熟悉的用戶通過 編輯 Edit 來改變所有的狀態 那是不合適的 正確的狀態轉換方法 應該是 1 某個狀態自己到自己的改變 使用 編輯 Edit 比如一個 Active 的 Bug 從一個 人指派到另外一個人 2 Active Resolved 只能用 解決 Resolve Resolved Closed 只能用 關閉 Closed 3 Resolved Active 和 Closed Active 只能使用 激活 Activate 6 查詢查詢 Bug 你可以設定不同的查詢條件 尋找你想找的 Bug 目前 BugFree 提供了以下幾種查詢 模式 1 單擊某個模塊 可以顯示該模塊的所有 bug 如圖 6 1 所示 點擊 項目模塊框 下的 角色管理 模塊 就可以在 Bug 列表中顯 示此模塊中所有 Bug 的信息 這樣能夠讓修復人員很快得到某一模塊的全部 Bug 使修復 效率得以提高 圖 6 1 2 設定查詢條件 列出符合條件的 bug 記錄 在 查詢條件 欄中填寫想要查詢的 Bug 信息 例如圖 6 2 中查詢條件為 項目名稱 學生信息管理系統 創建者 G 郭彥海 嚴重程度 1 指派給 L 李曉鵬 三個條件之間的關系都是并且關系 也就是說滿足所有條件的 Bug 會在點擊 提交查詢內 容 按鈕后顯示在下面的 Bug 列表中 查詢條件的組合有很多種 你可以根據不同的需要 查詢 Bug 信息 準確性比較高 圖 6 2 還可以點擊 保存查詢 按鈕 來保存這些查詢條件 在 查詢標題 處給本次查詢 條件起一個容易見文知義的名稱 圖 6 3 點擊 保存查詢 后 在屏幕的左下角會出現如圖 6 4 所示的查詢條 方便以后的查 詢工作 圖 6 4 3 按某字段排序 單擊 bug 列表的任何一個字段 例如 創建者 BugID 修改日期 等 就可以 按該字段將 bug 排序 同時 該字段旁邊有 或 表示當前是升序還是降序排序 再次單擊一下本字段 將會改變排序方式 如圖 6 5 中 將 Bug 按編號降序排序 圖 6 5 7 自定義顯示字段自定義顯示字段 點擊圖 3 18 中 自定義顯示 按鈕 調出如圖 7 1 所示界面 圖 7 1 這樣 我們就可以通過和按鈕來添加 刪除顯示字段 也可以通 過和按鈕設置顯示字段的排列順序 表示程序默認顯示的字段 包 括 Bug ID Sev Pr Bug 標題 創建者 指派給 解決者 解決方案 最后修改日期 9 個字段 8 Bug 管理管理 8 1 新建新建 Bug 當執行以下測試用例時 我們可能會發現 通過操作步驟得到的實際結果與期望結果 不同 密碼列為可視數據 這時 我們就需要提交 Bug 也就是新建一個 Bug 1 點擊 新建 Bug 按鈕 如圖 8 1 中所示 圖 8 1 2 打開新建 Bug 窗口 如圖 8 2 所示 對話框顯示為橘黃色的為必填項 3 根據 Bug 的特征為 Bug 命名 盡量做到見文知意 4 注意必須要指定該 Bug 屬于哪個項目的哪個模塊 指定 bug 的類型 Bug 類型以 及嚴重程度等必填信息 并將本 bug 指派給相應的同事 這里著重說明一點 為了讓 Bug 更容易重現 在書寫 復現步驟 項時應盡量簡潔明 了 這樣會使團隊的工作效率得以提高 也會減少不必要的麻煩 圖 8 2 Bug 字段說明字段說明 Bug 標題標題 為包含關鍵詞的簡單問題摘要 要有利于其他人員進行搜索或通過標題快 速了解問題 項目名稱項目名稱 模塊路徑模塊路徑 指定問題出現在哪個項目的哪個模塊 Bug 處理過程中 需要隨 時根據需要修改項目或模塊 方便跟蹤 如果后臺管理指定了模塊負責人 選擇模塊時 會自動指派給負責人 指派給指派給 Bug 的當前處理人 如果不知道 Bug 的處理人 可以指派給 Active 項目或 模塊負責人再重新分發 指派給具體人員 如果設定了郵件通知 被指派者會收到郵件通 知 狀態為 Closed 的 Bug 默認會指派給 Closed 表示 Bug 生命周期的結束 抄送給抄送給 需要通知相關人員時填寫 例如測試主管或者開發主管等 可以同時指派多 個 人員之間用逗號分隔 如果設定了郵件通知 當 Bug 有任何更新時 被指派者都會收 到郵件通知 嚴重程度嚴重程度 Bug 的嚴重程度 由 Bug 的創建者視情況來指定 其中 1 為最嚴重的問題 4 為最小的問題 一般 1 級為系統崩潰或者數據丟失的問題 2 級為主要功能的問題 3 級 為次要功能的問題 4 級為細微的問題 優先級優先級 Bug 處理的優先級 由 Bug 的處理人員按照當前業務需求 開發計劃和資源 狀態指定 其中 1 的優先級最高 4 的優先級最低 一般 1 級為需要立即解決的問題 2 級 為需要在指定時間內解決的問題 3 級為項目開發計劃內解決的問題 4 級為資源充沛時解 決的問題 其余選項字段 Bug 類型類型 如何發現如何發現 操作系統操作系統 瀏覽器瀏覽器 可以通過編輯 Lang ZH CN UTF 8 COMMON php 來自定義 創建創建 Build Bug 是在哪個版本 Build 或者 Tag 被發現的 解決解決 Build Bug 是在哪個版本 Build 或者 Tag 被解決的 解決方案解決方案 參考 Bug 的七種解決方案 如果解決方案為 Duplicated 需要指定重復重復 Bug 的編號 處理狀態 處理狀態 Bug 處理過程的附屬子狀態 例如 Local Fix 表示已在本地修復 Checked In 表示修復代碼已經提交 Can t Regress 表示修復的問題暫無法驗證等 機器配置機器配置 測試運行的硬件環境 例如 Dell G280 2G 200G 關鍵詞關鍵詞 主要用于自定義標記 方便查詢 關鍵詞之間用逗號或者空格分隔 例如 對于跨團隊的項目開發 可以約定一個關鍵詞統一標記項目 相關相關 Bug 與當前 Bug 相關的 Bug 例如 相同代碼產生的不同問題 可以在相關 Bug 注明 相關相關 Case 與當前 Bug 相關的 Case 例如 測試遺漏的 Bug 可以在補充了 Case 之后 在 Bug 的相關 Case 注明 上傳附件上傳附件 上傳 Bug 的屏幕截圖 Log 日志或者 Call Stack 等 方便處理人員 復現步驟復現步驟 步驟 要描述清晰 簡明扼要 步驟數盡可能少 結果 說明 Bug 產生的錯 誤結果 期望 說明正確的結果 可以在 備注 提供一些輔助性的信息 例如 這個 bug 在 上個版本是否也能復現 方便處理人員 5 當 Bug 的信息填寫完整時 就可以點擊 保存 按鈕完成 Bug 的提交 Bugfree 就會自動為我們生成 Bug 編號 如圖 8 3 中所示 此 Bug 的編號為 Bug 4 此時 我們可以再審查一下有沒有錯誤 是否和自己的最初意愿一致 如果一切 OK 那么 就可以關閉此界面 一個 Bug 就提交完畢了 圖 8 3 8 2 編輯編輯 Bug 在我們提交 Bug 的過程中不免會出現一些失誤 這就需要對 Bug 進行編輯修改 我們 就以剛才的 Bug 4 為例 1 首先 點擊此 Bug 來到如圖 8 3 所示窗口 2 點擊 編輯 按鈕 打開 編輯 Bug 窗口 如圖 8 4 所示 圖 8 4 3 修改相應的信息 點擊 保存 完成編輯 8 3 復制復制 Bug 在一個系統的測試過程中 難免會遇到很多相似的 Bug 如果我們每一個 Bug 都要徹 底描述一遍 無論對個人還是對團隊都是很大的損失 Bugfree 為了防止這種現象的出現 特意增加了 復制 Bug 的功效 例如 我們前面已經提交了一個 文字錯誤 的 Bug 現經過測試 又出現了錯別字 那我們就可以進行 Bug 的復制了 1 找到一個 文字錯誤 Bug 直接點擊此 Bug 行 打開 Bug 如圖 8 5 所示 圖 8 5 圖 8 6 2 點擊 復制 按鈕 進入新建 Bug 窗口 這個與前面直接進行新建的 Bug 相同 如圖 8 7 所示 只需在 Bug 的描述上進行簡單的修改即可保