Bugfree使用手册.doc

Bugfree使用手册1. Bugfree简介1.1 BugFree网站/ 1.2 BugFree的Logo1.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为例进行说明。请先访问/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.14依次点击Apache和MySql后面的“Start”按钮，启动Apache和MySql服务，如图2.2所示。图2.25打开IE浏览器，在地址栏中输入：http:/localhost，点击回车键出现如图2.3所示界面。图2.36选择“中文”链接，来到友好欢迎界面，提示你成功安装“XAMPP”，如图2.4所示。图2.47此时，在地址栏中输入https:/localhost/bugfree，点击回车键。系统提示：数据库连接失败！如图2.5所示图2.58点击“创建数据库”链接，成功创建数据库，如图2.6所示。图2.69点击“继续安装”，提示安装全新的Bugfree2，如图2.7所示。图2.710点击“安装全新的Bugfree2”链接开始安装。安装结束后，系统会提供默认管理员的帐号和密码，如图2.8所示。图2.83. Bugfree界面3.1 登录界面点击图2.8中“这里”链接到登录界面，如图3.1所示。图3.13.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.34.后台管理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) */$_CFGAdminUser = 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.44.4项目管理以管理员的身份登录后，点击导航栏-“后台管理”打开“后台管理”界面，管理员可以对项目、用户和用户组进行相应的管理，默认为项目列表，如图4.5所示。图4.5这里，我们可以通过点击“添加项目”添加一个新的项目，如图4.6所示。根据实际需求填写相应的信息，并为项目分配合适的项目组（如图所示，只有T2、T3的用户组成员才能访问此项目）和项目管理员，最后点击“保存项目”按钮返回项目列表。此时，我们能够在项目列表中看到刚刚添加到项目信息。图4.6项目默认显示顺序是按照创建的先后次序排列的。如果需要将某个项目排在最前面，编辑该项目，将显示顺序设置为0-255之间的数值。通过点击已存在项目右端的“编辑”按钮，也可以对此项目信息进行更改，如图4.7所示。图模块管理创建项目之后，通过“Bug模块”和“Case模块”链接，可以分别为Bug和Test Case创建树形模块结构。一个项目可以包含多个模块，一个模块下面可以包含多个子模块。原则上，对子模块的层级没有限制。如此接连不断地“添加一个新的子模块”（注意“父模块”的选取），则各模块间可以形成类似图4.9左侧的树状列表。与项目的显示顺序类似，“Case模块”可以编辑模块的显示数据值更改同级模块的排列顺序。如果指定模块负责人，在创建该模块下的Bug或Test Case时，会自动指派给该负责人。如果删除一个模块之后，该模块下面的Bug或Test Case将自动移动到其父模块中。图4.8图禁用和激活项目点击“禁用”后，可以隐藏某个项目，但并不真正从数据库删除记录，该项目将对所有人员不可见。再次点击“激活”，将恢复该项目所有的记录。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.12. 设定查询条件，列出符合条件的bug记录。在“查询条件”栏中填写想要查询的Bug信息，例如图6.2中查询条件为项目名称：学生信息管理系统，创建者：G郭彦海，严重程度：1，指派给：L李晓鹏。三个条件之间的关系都是并且关系，也就是说满足所有条件的Bug会在点击“提交查询内容”按钮后显示在下面的Bug列表中。查询条件的组合有很多种，你可以根据不同的需要查询Bug信息，准确性比较高。图6.2还可以点击“保存查询”按钮，来保存这些查询条件，在“查询标题”处给本次查询条件起一个容易见文知义的名称。图6.3点击“保存查询”后，在屏幕的左下角会出现如图6.4所示的查询条，方便以后的查询工作。图6.43. 按某字段排序单击bug列表的任何一个字段（例如“创建者”、“BugID”、“修改日期”等），就可以按该字段将bug排序，同时，该字段旁边有 “”或“”表示当前是升序还是降序排序。再次单击一下本字段，将会改变排序方式。如图6.5中，将Bug按编号降序排序。图6.57. 自定义显示字段点击图3.18中 “自定义显示”按钮，调出如图7.1所示界面。图7.1这样，我们就可以通过和按钮来添加/删除显示字段，也可以通过和按钮设置显示字段的排列顺序。表示程序默认显示的字段，包括“Bug ID”，“Sev”，“Pr”，“Bug标题”，“创建者”，“指派给”，“解决者”，“解决方案”，“最后修改日期”9个字段。8. Bug管理8.1 新建Bug当执行以下测试用例时，我们可能会发现，通过操作步骤得到的实际结果与期望结果不同：密码列为可视数据。这时，我们就需要提交Bug，也就是新建一个Bug。1. 点击“新建Bug”按钮，如图8.1中所示。图8.12. 打开新建Bug窗口，如图8.2所示。对话框显示为橘黄色的为必填项。3. 根据Bug的特征为Bug命名，尽量做到见文知意。4. 注意必须要指定该Bug属于哪个项目的哪个模块，指定bug的类型、Bug类型以及严重程度等必填信息，并将本bug指派给相应的同事。这里着重说明一点：为了让Bug更容易重现，在书写“复现步骤”项时应尽量简洁明了。这样会使团队的工作效率得以提高，也会减少不必要的麻烦。图8.2Bug 字段说明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表示修复代码已经提交；Cant 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.38.2 编辑Bug在我们提交Bug的过程中不免会出现一些失误，这就需要对Bug进行编辑修改。我们就以刚才的Bug#4为例。1. 首先，点击此Bug来到如图8.3所示窗口。2. 点击“编辑”按钮，打开“编辑Bug”窗口，如图8.4所示。图8.43. 修改相应的信息，点击“保存”完成编辑。8.3 复制Bug在一个系统的测试过程中，难免会遇到很多相似的Bug。如果我们每一个Bug都要彻底描述一遍，无论对个人还是对团队都是很大的损失。Bugfree为了防止这种现象的出现，特意增加了“复制”Bug的功效。例如，我们前面已经提交了一个“文字错误”的Bug。现经过测试，又出现了错别字。那我们就可以进行Bug的复制了。1. 找到一个“文字错误”Bug，直接点击此Bug行，打开Bug，如图8.5所示。图8.5图8.62. 点击“复制”按钮，进入新建Bug窗口。这个与前面直接进行新建的Bug相同，如图8.7所示，只需在Bug的描述上进行简单的修改即可保存完成了。图8.78