bugfree使用帮助
BugFree 2使用帮助
https://www.wendangku.net/doc/3a5090864.html,/help/
址：https://www.wendangku.net/doc/3a5090864.html,
tp://https://www.wendangku.net/doc/3a5090864.html,/forum
https://www.wendangku.net/doc/3a5090864.html,/help/
帮助文档使用说明 (3)
BugFree简介 (3)
BugFree服务器安装 (3)
全新安装BugFree 2. 3
从BugFree 2.0 RTM或2.0.x升级 (4)
从BugFree 1.1升级 (4)
BugFree 界面 (5)
主界面 (5)
创建界面 (6)
Bug管理 (6)
Bug的3种状态 (6)
Bug 生命周期 (6)
Bug的七种解决方案 (7)
Bug 字段说明 (7)
Test Case管理 (8)
Test Case 状态 (8)
Test Case 字段说明 (9)
Test Result管理 (9)
Test Case的执行结果 (9)
查询结果 (9)
设置查询条件 (10)
快速筛选 (10)
自定义显示字段 (11)
查询结果排序 (11)
统计报表 (11)
BugFree使用技巧 (12)
发送邮件通知 (12)
在Bug和Case中使用UBB代码 (13)
更改上传附件的大小 (14)
使用快捷键 (14)
后台管理 (14)
BugFree管理员角色 (14)
系统管理员 (15)
项目管理员 (15)
用户组管理员 (15)
管理员的具体权限 (15)
用户管理 (16)
禁用和激活用户 (16)
用户组管理 (16)
项目管理 (16)
模块管理 (16)
禁用和激活项目 (17)
用户日志 (17)
BugFree应用程序接口 (17)
本文档已按照最新版本的BugFree 2进行了更新，部分内容可能不适用于老版本的BugFree。建议访问BugFree下载
BugFree基于PHP和MySQL开发，是免费且开发源代码的缺陷管理系统。服务器端在Linux和Windows平台上都可以运行；客户BugFree 2 在BugFree 1.1的基础上，集成了Test Case和Test Result的管理功能。具体使用流程是：首先创建Test Case（测试用例
全新安装BugFree 2
在安装BugFree 2之前，需要首先安装Apache, PHP, Mysql支持软件包，例如XAMPP或EASYPHP等。
下面以XAMPP为例进行说明。请先访问https://www.wendangku.net/doc/3a5090864.html,/zh_cn/xampp.html 下载
1.下载BugFree 2安装包，解压后复制到XAMPP系统的htdocs子目录下。
如果是Linux系统，安装路径一般为/opt/lampp/htdocs/bugfree; Window系统的安装路径一般为C:\xampp\htdocs\bugfree。
2.进入bugfree的安装目录，复制文件Include/Config.inc.Sample.php为新文件Include/Config.inc.php，编辑新创建的文件，修/*
3.
Define
the
username
and
password
of the
BugFree
database.
$_CFG['D
B']['User'
] =
'root';
// 数据
库登录用户
$_CFG['D
B']['Pass
word']
= '';
// 数据
库登录用户
$_CFG['D
B']['Host'
] =
'localhost'
; // 数
据库服务器
地址
$_CFG['D
B']['Data
base']
=
'bugfree2'
; // 指定
BugFree
$_CFG['D
B']['Table
Prefix'] =
'bf_';
// 数据
库表前缀，
默认为bf_
。除非有冲
突，不建议
修改或为空
$_CFG['D
BCharset'
] =
'UTF8';
// 数据
库编码设
置，保留默
3.如果是Linux 系统，修改下列目录和文件的权限；如果是Windows系统，跳过这一步。
a)chmod 777 Data/TplCompile/
b)chmod 777 BugFile/
c)chmod 777 Include/Config.inc.php
4.在浏览器访问http://
5.点击“安装全新的 BugFree2”。
6.安装成功后，显示首次登录的默认管理员帐号和密码，按照提示首先使用默认管理员用户名和密码登陆BugFree。
从BugFree 2.0 RTM或2.0.x升级
升级之前，为防止数据丢失，建议从浏览器退出BugFree，并备份相应的数据库和虚拟目录。
1.下载BugFree 2安装包，解压后复制到原BugFree安装目录下，覆盖原有文件。
2.在浏览器访问http://
3.点击“从现有的BugFree 2 升级”，完成升级。
从BugFree 1.1升级
升级之前，为防止数据丢失，建议在浏览器退出BugFree，并备份相应的数据库和虚拟目录。
1.下载BugFree 2安装包，解压后复制到原BugFree的安装目录下，覆盖原有文件。
2.进入Bugfree的安装目录，复制文件Include/Config.inc.Sample.php 为新文件Include/Config.inc.php，编辑新创建的文件，并
3.点击“从BugFree 1 升级”，完成BugFree 1.1 到BugFree 2的升级。
注意：如果BugFree 1.1升级到BugFree 2之后显示乱码，请修改Include/Config.inc.php的$_CFG['DBCharset']值
$_CFG['D
BCharset'
] =
主界面
访问http://
l项目选择框①：可以快速切换当前项目，项目模块框②和查询结果框⑥显示相应的模块结构和记录。
l项目模块框②：显示当前项目的模块结构。点击某一模块，查询结果框⑥会显示所选模块的所有记录。
l个性显示框③：
a)指派给我：显示最近10条指派给我的记录。
b)由我创建：显示最近10条由我创建的记录。
c)我的查询：保存查询框⑤的查询条件。
l模式切换标签④：切换Bug, Test Case和Test Result模式。默认登陆为Bug模式。
l查询框⑤：设置查询条件。
l查询结果框⑥：显示当前查询的结果。
a)自定义显示：设置查询结果的显示字段。
b)统计报表：显示当前查询结果的统计信息。
c)导出：将查询结果显示的自定义字段导出到XML文件。最多可同时导出5000条记录。
d)导入（仅支持Test Case模式）：可以将导出的XML文件在Excel进行编辑后，再导入到BugFree中，实现Test Case批
e)批量运行（仅支持Test Case 模式）：可以对查询结果的Test Case同时创建Test Result。最多支持100个Test Case。l导航栏⑦：显示当前登录用户名等信息。
创建界面
为了保持用户体验的一致性，新建Bug, Test Case和Test Result的界面布局基本保持一致，只是具体填写字段有所不同。
以新建Bug为例，在主界面模式切换标签选择Bug，点击[新建 Bug]打开新建Bug页面。如下图，黄色标注字段为必填项。
Bug的3种状态
状态说明
Active(活动)Bug的初始状态。任何新建的Bug状态都是Active。可以通过编辑修改Bug的内容，并指派给合适
Resolved(已解决)解决Bug之后的状态
Closed(已关闭)已修复Bug 在验证无误之后关闭，该Bug 处理完毕。如果没有真正解决或者重新复现，可以重新激活，Bug 状态重新
Bug 生命周期
新建的Bug处于Active状态，可以通过编辑指派给合适的解决者。解决Bug之后，Bug状态变为Resolved，并自动指派给创建者
Bug的七种解决方案
类型解决方案详细说明
By Design设计需求
就是这么
设计的
三种无效的Bug Duplicate这个问题
别人已经
发现
Not Repro无法复现
的问题Fixed问题被修
复
四种有效的Bug External外部原因
(比如浏览
器、操作
系统、其
他第三方
软件)造成
Postponed发现的太
晚了，下
一个版本
讨论是否
Won’t Fix是个问
题，但是
不值得修
Bug 字段说明
Bug 标题：为包含关键词的简单问题摘要，要有利于其他人员进行搜索或通过标题快速了解问题。
项目名/模块路径：指定问题出现在哪个项目的哪个模块。Bug处理过程中，需要随时根据需要修改项目或模块，方便跟踪。指派给：Bug的当前处理人。如果不知道Bug的处理人，可以指派给Active，项目或模块负责人再重新分发、指派给具体人员。抄送给：需要通知相关人员时填写，例如测试主管或者开发主管等。可以同时指派多个，人员之间用逗号分隔。如果设定了严重程度：Bug的严重程度。由Bug的创建者视情况来指定，其中1为最严重的问题，4为最小的问题。一般1级为系统崩溃或者优先级：Bug处理的优先级。由Bug的处理人员按照当前业务需求、开发计划和资源状态指定，其中1的优先级最高，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产生的错误结果；[期望]说明正确的结果。可以在
测试用例（Test Case）是在测试执行之前设计的一套详细的测试计划，包括测试环境、测试步骤、测试数据和预期结果。在Test Case 状态
Case状态详细说明
Active标示有效
的测试用
例。所有
新建Case
都默认为
Blocked当前Case
因为其他
原因，无
法正常运
行。通过
编辑Case
Investigati ng 待研究确认的测试用例。通过编辑Case进行
Reviewed通过测试
用例评审
的用例。
通过编辑
Case进行
Test Case 字段说明
Case 标题：测试点的简单描述（30字以内）或测试的目的。
项目名/模块路径：指定测试用例对应的项目名称和模块路径。
指派给：执行Test Case的人员。如果不知道具体的用例执行人员，可以指派给Active 。抄送给：需要通知相关人员时填写。可以同时指派多个，人员之间用逗号分隔。
优先级：Case执行的优先级。1：冒烟测试及每次测试都需执行的用例，严重程度最高；2：覆盖产品所有主要功能；3：次要标记删除：用来标记已失效的用例，再通过查询条件进行排除。
关键词：主要用于自定义标记，方便查询。关键词之间用逗号或者空格分隔。例如，对于跨团队的项目开发，可以约定一个显示顺序：通过输入0~255之间的任一整数实现对TestCase的自定义排序。例如，按照业务执行的流程重新排列Case的显示顺
Test Result只能通过运行已有测试用例来创建。打开一个已有的测试用例，点击页面上方[运行]按钮，进入创建Test Result页面Test Case的执行结果
Case状态详细说明
Passed运行成功
的Test
Failed运行失败
的Test
设置查询条件
BugFree默认显示2个查询组，每组有3个查询字段（总共6个查询字段）。假设要查询项目Project 1, Project 2和Project 3从2008
查询技巧：
1. 点击[保存查询]按钮，可以将当前的查询条件保存到右下角个性查询框“我的查询”标签页。点击已保存的查询，可以对查
2. 日期类型字段支持相对日期的查询。例如，创建日期 = -1将查询所有昨天创建的Bug。
3. 通过“包含”操作，可以指定多个查询值。例如，创建者包含user1,user2，搜索结果将显示两个创建者的Bug。
注意：BugFree默认支持6个查询字段，可以通过修改Include/Config.inc.php下面的值更改查询字段的数量。
$_CFG['Q
ueryField
Number']
= 6;
// The
fields
number
to query
in
快速筛选
在搜索结果列点击某一字段的值，可以快速进行筛选，筛选列高亮显示。例如，要查看所有解决方案为By Design的Bug，如下注意：筛选会忽略当前设置的查询条件。
自定义显示字段
在查询结果框右上角，点击[自定义显示]链接，可以显示或隐藏查询结果的字段和显示顺序。
查询结果排序
点击搜索结果标题某一字段的标题栏，可以按该字段对搜索结果进行排序。再次点击则切换升序或降序。
在查询结果框右上角，点击[统计报表]链接打开新窗口。统计报表可以显示Bug, Test Case或Test Result当前查询结果的统计信在统计报表页面的左侧选择统计项，点击[查看统计]按钮，右侧显示Flash统计图表。如下图：
发送邮件通知
在安装过程或者通过编辑Include/Config.inc.php文件可以启用邮件通知功能。例如，修改如下SMTP服务器信息。
/* 9. SMTP
param
setting. */
$_CFG['Ma
il']['SendPa
ram']['Host
'] =
'localhost';
// The
server to
connect.
Default is
localhost
$_CFG['Ma
il']['SendPa
ram']['SMT
PAuth'] =
false;
//
Whether
or not to
use SMTP
authentica
tion.
$_CFG['Ma
il']['SendPa
ram']['User
name'] = '';
//
The
username
to use for
SMTP
authentica
$_CFG['Ma
il']['SendPa
ram']['Pass
word'] = '';
//
The
password
to use for
SMTP
authentica
BugFree可以实时和定时发送邮件通知。在新建Bug或Test Case并保存后，指派给和抄送给将收到实时邮件通知。可以在“抄送
BugFree还可以发送定期邮件通知。
1.如果需要定期对所有未关闭Bug的当前指派者发送邮件提醒，在Linux环境下定期执行bugfree/Shell/NoticeBug.sh；Window
2.如果需要每周接收各项目/模块的过去7天新增Bug和超过7天未处理的Bug的邮件通知：
a)后台管理页面，编辑指定的项目，在通知邮箱编辑框输入邮件接收的地址。
b)Linux环境下，通过crontab定期执行bugfree/Shell/StatBug.sh；Windows环境下则可以通过定时任务程序定期执行在Bug和Case中使用UBB代码
BugFree2.0 提供了对基本UBB代码的支持，可以在编写复现步骤和注释时添加链接、设置字体、嵌入图像等，也可以直接引用例如，编辑状态下输入文字：
链接
[url]www.
bugfree.or
https://www.wendangku.net/doc/3a5090864.html,[/url]
字体[b]加
粗[/b], [i]
斜体[/i],
[u]下划线
引用
bug#[bug]
100[/bug],
case#[case
]11[/case],
result#[res
ult]6[/resu
嵌入图像
[img]http:/
/www.bug
https://www.wendangku.net/doc/3a5090864.html,
/buglifecyc
le.png[/im
保存后的显示效果：
更改上传附件的大小
BugFree默认附件大小为1000K，可以编辑Include/Config.inc.php文件下列设置更改上传文件大小。
$_CFG['Fi
le']['MaxF
ileSize']
= 1024
* 1000;
// The
max file
size(Byte
使用快捷键
以下快捷键需要浏览器支持。
页面快捷键说明
主页面Ctrl + G 弹出一个对话框。输入ID 后，直接打开相应编号的Bug ，Case Bug, Case
和Result Alt + P
显示查询结果的上一个记录通用快捷键
Alt + N
显示查询结果的下一个记录Alt + E
编辑当前记录Alt + S
保存记录Alt + R
解决Bug Alt + C
关闭Bug Alt + A
激活Bug Alt + C
复制Case Alt + R
运行Case Result 页面Alt + B 创建Bug
BugFree 管理员角色
BugFree 的管理员包括系统管理员、项目管理员和用户组管理员三种角色。可以同时指派任意用户为任意角色。这三种管理员
系统管理员全新安装BugFree 之后，会自动创建一个默认的系统管理员帐号admin 。你可以通过编辑BugFree 目录下的Include/Config.inc.ph
例如，假设要将user1设置为系统管理员。编辑Include/Config.inc.php 文件，将user1添加到下面的行。
/* 2.
Define
admin
user list.
Like this:
array('ad
min','test
1') */$_CFG['A
dminUser'
] =
array('ad
min',’
user1’);注意：如果user1不存在，首先需要默认管理员帐号admin登录之后，创建该用户。
项目管理员
项目管理员只能由系统管理员指派，指定哪些用户组可以访问当前项目。该角色负责维护Bug 和Case 的模块结构。
用户组管理员
用户组管理员可以由系统管理员或者其他用户组管理员指派，负责维护一个用户组。一般情况下，用户组
管理员的具体权限
系统管理员、项目管理员和用户组管理员三种角色的详细权限如下表所列。
系统管理员项目管理员用户组管
理员
可以添加项目不可以添加项目
可以查看和编辑所有项目仅可以查
看和编辑
自己是项
目管理员
Bug 页面Case 页面项目管理无权限
可以修改
项目名称
和显示顺
不可以修改项目名称和显示可以指派
项目用户
可以指派项目用户可以指派
项目管理
不可以指派项目管可以编辑
Bug 或Case
模块
可以编辑Bug 或Case 模块可以查看
所有用户
可以查看所有用户可以查看所有用户可以添加
用户
可以添加用户可以添加用户可以编辑
、禁用或
激活所有
用户
可以编辑、禁用或激活自己创建的用可以编辑、禁用或激活自己创建的用可以查看
所有用户
可以查看所有用户可以查看所有用户可以添加
用户组
可以添加用户组可以添加用户组可以编辑
或删除所
有用户组可以编辑或删除自己添加的
用户组
可以编辑或删除自己添加的用户组或自己是用户组管理用户管理
添加新用户，输入用户名、真实姓名、密码和邮件地址。用户名和密码用于登录BugFree ；真实姓名则显示在指派人列表中用
禁用和激活用户点击[禁用]后，该用户将无法登录BugFree ，并从所在用户组删除。包含该用户的记录将不再显示该用户的真实姓名，而以用
再次点击[激活]，将恢复该用户，但需要重新指派用户组权限。
用户组管理
创建用户之后，需要将用户添加到用户组，项目管理员通过指派用户组来分配权限。新用户只有在所属用
安装BugFree 之后，系统会默认创建一个[All Users] 默认组，该用户组包含所有用户，不需要额外添加用户。
项目管理
点击[添加项目]的链接，创建新的项目。指派需要访问当前项目的用户组之后，改用户组的所有用户才可以访问该。项目默认
模块管理创建了项目之后，通过[Bug 模块]和[Case 模块]链接，可以分别为Bug 和Test Case 创建树形模块结构。一个项目可以包含多个模
如果指定模块负责人，在创建该模块下的Bug 或Test Case 时，会自动指派给该负责人。
如果删除一个模块之后，该模块下面的Bug 或Test Case 将自动移动到父模块中。
禁用和激活项目
点击[禁用]后，可以隐藏某个项目，但并不真正从数据库删除记录，该项目将对所有人员不可见。
再次点击[激活]，将恢复该项目所有的记录。
用户日志
用户日志只有系统管理员可以查看，用于记录用户的登录信息，包括登录的用户名，登录机器的IP 地址和登录时间。
具体使用说明请参考API接口文档：bugfree_api.html
API应用示例下载：api-example.tar.gz
用户组管理用户管理
。建议访问BugFree下载页面，下载并升级至最新版本的BugFree。
Windows平台上都可以运行；客户端无需安装任何软件，通过IE，FireFox等浏览器就可以自由使用。
程是：首先创建Test Case（测试用例），运行Test Case产生Test Result（测试结果），运行结果为Failed的Case，可以直接创建Bug。Test Ca
下载并安装最新的XAMPP版本。
般为C:\xampp\htdocs\bugfree。
ig.inc.php，编辑新创建的文件，修改数据库链接设置：
建数据库，再点击继续安装。
用户名和密码登陆BugFree。
fig.inc.php，编辑新创建的文件，并复制Include/ConfigBug.inc.php的相应设置。
arset']值为空，再恢复原有的BugFree1.1数据库，重新进行升级
块结构和记录。
模块的所有记录。
再导入到BugFree中，实现Test Case批量编辑。最大支持2M大小的XML文件。t Result。最多支持100个Test Case。
只是具体填写字段有所不同。
图，黄色标注字段为必填项。
变为Resolved，并自动指派给创建者。创建者验证Bug。如果未修复，再重新激活，Bug状态重新变为Active；如果已经修复则可以关闭，Bu
据需要修改项目或模块，方便跟踪。如果后台管理指定了模块负责人，选择模块时，会自动指派给负责人。
责人再重新分发、指派给具体人员。如果设定了邮件通知，被指派者会收到邮件通知。状态为Closed的Bug，默认会指派给Closed，表示B 人员之间用逗号分隔。如果设定了邮件通知，当Bug有任何更新时，被指派者都会收到邮件通知。
最小的问题。一般1级为系统崩溃或者数据丢失的问题；2级为主要功能的问题；3级为次要功能的问题；4级为细微的问题。
指定，其中1的优先级最高，4的优先级最低。一般1级为需要立即解决的问题；2级为需要在指定时间内解决的问题；3级为项目开发计划内TF-8/_COMMON.php来自定义。
修复代码已经提交；Can’t Regress表示修复的问题暂无法验证等。
跨团队的项目开发，可以约定一个关键词统一标记项目。
的相关Case注明。
果；[期望]说明正确的结果。可以在[备注]提供一些辅助性的信息，例如，这个bug在上个版本是否也能复现，方便处理人员。
试步骤、测试数据和预期结果。在导航栏点击Test Case，即切换到Test Case模式，点击[新建Case]，创建测试用例。可以通过页面上方的[
：覆盖产品所有主要功能；3：次要功能；4：细节功能（资源有限时，可以不执行）。其余选项字段（Case类型、测试方法、测试计划
跨团队的项目开发，可以约定一个关键词统一标记项目。
务执行的流程重新排列Case的显示顺序。
运行]按钮，进入创建Test Result页面。Case标题、模块路径和步骤等信息自动复制到新的Test Result中。同时，Test Result相关 Case自动指Project 1, Project 2和Project 3从2008年1月1日起所有未关闭的Bug，可以设置如下的查询条件：
签页。点击已保存的查询，可以对查询条件进行编辑和修改。
显示两个创建者的Bug。
询字段的数量。
案为By Design的Bug，如下图，点击任一解决方案为By Design的Bug。
降序。例如，需要查看最近更新的Bug，首先添加“最后修改日期”自定义字段，再在查询结果标题栏点击该字段。或Test Result当前查询结果的统计信息。
如下SMTP服务器信息。