BugFree使用基础手册.docx

BugFree使用手册整顿一、Bugfree简介1.1 BugFree网站 1.2 BugFreeLogo1.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每一步操作均有非常详细记录。二、BugFree登录2.1先启动xampp服务再在浏览器地址栏中输入:8888/bugfree/Login.php ，进入BugFree登录页面。2.2登录主页面2.3主页面输入系统提供默认管理员顾客名：admin，密码（原始）：123456；语言选取默认“简体中文”。点击“登录”按钮，来到Bugfree主界面 项目选取框：可以迅速切换当前项目，项目模块框和查询成果框显示相应模块构造和记录。 项目模块框：显示当前项目模块构造。点击某一模块，查询成果框会显示所选模块所有记录。 个性显示框：a)指派给我：显示近来10条指派给我记录。b)由我创立：显示近来10条由我创立记录。c)我查询：保存查询框查询条件。 模式切换标签：切换Bug，Test Case和Test Result模式。默认登陆为Bug模式。 查询框：设立查询条件。 查询成果框：显示当前查询成果。a)自定义显示：设立查询成果显示字段。b)所有导出：将当前查询成果记录导出到网页。c) 记录报表：显示当前查询成果记录信息。导航栏：显示当前登录顾客名等信息。三、编辑我信息3.1修改顾客信息A：点击导航栏-“编辑我信息”进行密码更改。B：依照提示填写真是信息、Email、密码等信息，最后点击“提交”完毕密码修改只是修改信息，并没有修改登录顾客名和密码。四、后台管理4.1BugFree管理员角色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.2.1禁用和激活顾客点击如图4.2所示“禁用”链接后，该顾客将无法登录BugFree，并从所在顾客组删除。包括该顾客记录将不再显示该顾客真实姓名，而以顾客名代替。再次点击“激活”，将恢复该顾客，但需要重新指派顾客组权限。图4.24.3顾客组管理创立顾客之后，需要将顾客添加到顾客组，项目管理员通过指派顾客组来分派权限。新顾客只有在所属顾客组指派给一种项目之后才可以登录BugFree系统。安装BugFree之后，系统会默认创立一种“All Users” 默认组，该顾客组包括所有顾客，不需要额外添加顾客。点击添加顾客组管理，进入到顾客组添加页面，如图4.3所示表达要添加一种叫做“Test4”顾客组，组内有“郭彦海、李小鹏、裴军霞”三个成员，顾客组管理员为：李小鹏，点击“保存顾客组”即可完毕返回顾客组列表，如图4.4所示。此时，可以看到新添加新顾客组“Test4”信息。点击“编辑”按钮就可以对其进行编辑。图4.3图4.44.4项目管理以管理员身份登录后，点击导航栏-“后台管理”打开“后台管理”界面，管理员可以对项目、顾客和顾客组进行相应管理，默以为项目列表，如图4.5所示。 这里，咱们可以通过点击“添加项目”添加一种新项目，如图4.6所示。依照实际需求填写相应信息，并为项目分派适当项目组（如图所示，只有T2、T3顾客构成员才干访问此项目）和项目管理员，最后点击“保存项目”按钮返回项目列表。此时，咱们可以在项目列表中看到刚刚添加到项目信息。图4.6项目默认显示顺序是按照创立先后顺序排列。如果需要将某个项目排在最前面，编辑该项目，将显示顺序设立为0-255之间数值。通过点击已存在项目右端“编辑”按钮，也可以对此项目信息进行更改，如图4.7所示。图4.74.4.1模块管理创立项目之后，通过“Bug模块”和“Case模块”链接，可以分别为Bug和Test Case创立树形模块构造。一种项目可以包括各种模块，一种模块下面可以包括各种子模块。原则上，对子模块层级没有限制。如此接连不断地“添加一种新子模块”（注意“父模块”选用），则各模块间可以形成类似图4.9左侧树状列表。与项目显示顺序类似，“Case模块”可以编辑模块显示数据值更改同级模块排列顺序。如果指定模块负责人，在创立该模块下Bug或Test Case时，会自动指派给该负责人。如果删除一种模块之后，该模块下面Bug或Test Case将自动移动到其父模块中。图4.8图4.94.4.2禁用和激活项目点击“禁用”后，可以隐藏某个项目，但并不真正从数据库删除记录，该项目将对所有人员不可见。再次点击“激活”，将恢复该项目所有记录。4.5顾客日记顾客日记只有系统管理员可以查看，用于记录顾客登录信息，涉及登录顾客名，登录机器IP地址和登录时间。 五、Bug状态5.1 Bug3种状态状态阐明Active(活动)Bug初始状态。任何新建Bug状态都是Active。可以通过编辑修改Bug内容，并指派给适当人员解决。Resolved(已解决)解决Bug之后状态。Closed(已关闭)已修复Bug在验证无误之后关闭，该Bug解决完毕。如果没有真正解决或者重新复现，可以重新激活，Bug状态重新变为Active。5.2 Bug 生命周期新建Bug处在Active状态，可以通过编辑指派给适当解决者。解决Bug之后，Bug状态变为Resolved，并自动指派给创立者。创立者验证Bug。如果未修复，再重新激活，Bug状态重新变为Active；如果已经修复则可以关闭，Bug状态变为Closed，Bug生命周期结束。已经ClosedBug如果重新复现，也可以直接激活。详细流程如下图所示。5.3 Bug七种解决方案类型解决方案详细阐明三种无效BugBy Design设计需求就是这样设计Duplicate这个问题别人已经发现Not Repro无法复现问题四种有效BugFixed问题被修复External外部因素(例如浏览器、操作系统、其她第三方软件)导致问题Postponed发现太晚了，下一种版本讨论与否解决Wont Fix是个问题，但是不值得修复5.4 Bug 字段阐明Bug 标题：为包括核心词简朴问题摘要，要有助于其她人员进行搜索或通过标题迅速理解问题。项目名/模块途径：指定问题出当前哪个项目哪个模块。Bug解决过程中，需要随时依照需要修改项目或模块，以便跟踪。如果后台管理指定了模块负责人，选取模块时，会自动指派给负责人。指派给：Bug当前解决人。如果不懂得Bug解决人，可以指派给Active，项目或模块负责人再重新分发、指派给详细人员。如果设定了邮件告知，被指派者会收到邮件告知。状态为ClosedBug，默认会指派给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在上个版本与否也能复现，以便解决人员。六、查询Bug你可以设定不同查询条件，寻找你想找Bug。当前，BugFree提供了如下几种查询模式：6.1单击某个模块，可以显示该模块所有bug如图6.1所示，点击“项目模块框”下“角色管理”模块，就可以在Bug列表中显示此模块中所有Bug信息。这样可以让修复人员不久得到某一模块所有Bug，使修复效率得以提高。图6.16.2设定查询条件，列出符合条件bug记录在“查询条件”栏中填写想要查询Bug信息，例如图6.2中查询条件为项目名称：学生信息管理系统，创立者：G郭彦海，严重限度：1，指派给：L李晓鹏。三个条件之间关系都是并且关系，也就是说满足所有条件Bug会在点击“提交查询内容”按钮后显示在下面Bug列表中。查询条件组合有诸各种，你可以依照不同需要查询Bug信息，精确性比较高。图6.2还可以点击“保存查询”按钮，来保存这些查询条件，在“查询标题”处给本次查询条件起一种容易见文知义名称。图6.3点击“保存查询”后，在屏幕左下角会浮现如图6.4所示查询条，以便后来查询工作。图6.4另参照：6.3按某字段排序单击bug列表任何一种字段（例如“创立者”、“BugID”、“修改日期”等），就可以按该字段将bug排序，同步，该字段旁边有 “”或“”表达当前是升序还是降序排序。再次单击一下本字段，将会变化排序方式。如图6.5中，将Bug按编号降序排序。图6.56.4自定义显示字段这样，咱们就可以通过和按钮来添加/删除显示字段，也可以通过和按钮设立显示字段排列顺序。表达程序默认显示字段，涉及“Bug ID”，“Sev”，“Pr”，“Bug标题”，“创立者”，“指派给”，“解决者”，“解决方案”，“最后修改日期”9个字段。 6.5查询成果排序点击搜索成果标题某一字段标题栏，可以按该字段对搜索成果进行排序。再次点击则切换升序或降序。例如，需要查看近来更新Bug，一方面添加“最后修改日期”自定义字段，再在查询成果标题栏点击该字段。 七、Bug管理7.1新建bug当执行如下测试用例时，咱们也许会发现，通过操作环节得到实际成果与盼望成果不同：密码列为可视数据。这时，咱们就需要提交Bug，也就是新建一种Bug。1. 点击“新建Bug”按钮，如图7.1中所示图7.12. 当Bug信息填写完整时，就可以点击“保存”按钮完毕Bug提交 Bugfree就会自动为咱们生成Bug编号，如图7.2中所示，此Bug编号为：Bug2。此时，咱们可以再审查一下有无错误，与否和自己最初意愿一致。如果一切OK，那么就可以关闭此界面，一种Bug就提交完毕了。图7.27.2编辑Bug在咱们提交Bug过程中不免会浮现某些失误，这就需要对Bug进行编辑修改。咱们就以刚才Bug2为例。1. 一方面，点击此Bug来到如图7.2所示窗口2. 点击“编辑”按钮，打开“编辑Bug”窗口，如图7.3所示图7.33. 修改相应信息，点击“保存”完毕编辑。7.3复制Bug在一种系统测试过程中，难免会遇到诸多相似Bug。如果咱们每一种Bug都要彻底描述一遍，无论对个人还是对团队都是很大损失。Bugfree为了防止这种现象浮现，特意增长了“复制”Bug功能。例如，咱们前面已经提交了一种“文字错误”Bug。现通过测试，又浮现了错别字。那咱们就可以进行Bug复制了。 1. 找到一种“文字错误”Bug，直接点击此Bug行，打开Bug，如图7.4所示图7.42. 在打开Bug页面点击复制操作图7.53. 点击“复制”按钮，进入新建Bug窗口。这个与前面直接进行新建Bug相似，如图7.6所示，只需在Bug描述上进行简朴修改即可保存完毕了。图7.67.4记录报表前面咱们提到过Bug查询，在输入一定查询条件后，点击“提交查询内容”会在下方显示符合条件Bug信息。可是在一种项目中一定会存在符合某一条件bug数量诸多，如果想要进一步，更加清晰地查看一下Bug分布状况就可以点击“记录报表”按钮，如图7.7所示。图7.7在打开“Bug记录报表”窗口，如图7.8所示。窗口左侧为查看记录方式，勾选相应查看方式，点击“查看记录”按钮就会在右侧空白处浮现对前面Bug列表中Bug分布状况。图7.8咱们以一种“bug模块分布”查询方式为例阐明。勾选“bug严重级别”选项，点击“查看记录”按钮，记录成果如图7.9所示。图7.9不同颜色代表不同模块中Bug，这样不同模块中Bug数以及各个模块所占比例一览无遗。7.5 Bug导出在BugFree页面，点击导出操作，成功连接到下载工具，将其成功下载图7.10在BugFree页面，将Bug导出，运用导出功能，在通过下载工具导出后，打开该导出Bug文献，成果里面是乱码形式。解决导出Bug文献乱码办法是： 八、TestCase 管理8.1新建Test Case测试用例（Test Case）是在测试执行之前设计一套详细测试筹划，涉及测试环境、测试环节、测试数据和预期成果。测试用例录入与Bug新建过程相似，在主界面导航栏点击“Test Case”按钮，即切换到“Test Case”模式，点击“新建Case”，切换到“新建Case”界面，按照事先编写测试用例录入有关内容，创立测试用例。也可以通过页面上方“复制”按钮迅速创立类似测试用例。没有各模块罗列，是由于在后台管理处，只是增长了Bug模块，没有增长Case模块。图8.1图8.2九、Test Result管理9.1新建Test ResultTest Result只能通过运营已有测试用例来创立。打开一种已有测试用例，点击页面上方“运营”按钮，如图9.1所示。图9.1单击运营按钮后，浮现新建Result页面，如图9.2图9.2Case标题、模块途径和环节等信息自动复制到新Test Result中。同步，Test Result有关 Case自动指向该测试用例。记录执行成果（Pass或Fail）和运营环境信息（运营Build、操作系统、浏览器等信息），保存测试用例，如图9.3。图9.3针对执行成果为FailTest Result，点击页面上方“新建 Bug”按钮，创立新Bug。Result标题、模块途径、运营环境和环节等信息自动复制到新Bug中。同步Test Result有关Bug指向新建Bug。 十、BugFree使用技巧10.1发送邮件告知BugFree可以实时和定期发送邮件告知。在新建Bug或Test Case并保存后，指派给和抄送给将收到实时邮件告知。可以在“抄送给”编辑框输入各种顾客帐号或者邮件地址，地址之间用逗号分隔。如下图，BugFree自动按照输入字母对顾客名进行筛选。10.2使用快捷键如下快捷键需要浏览器支持。页面快捷键阐明主页面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创立Bug十一、有关资料11.1有关资料列表序号编号文档名称123