一种通用测试文档的生成方法.pdf

本发明涉及一种通用测试文档的生成方法，包含两个步骤：步骤一：定制文档模板；定制文档模板可以分为三个步骤：第一步，文档模板结构定义；第二步，文档模板内容样式定义；第三步，生成XML描述文件保存入库；步骤二：文档生成：首先，标准的XML解析器能够从测试数据库中获得相应文档模板的XML描述文档，该XML解析器的DOM技术根据其描述生成一个友好的用户界面——文档生成器；随后，用户可以在文档生成器给出的编辑区域中输入需要人工添加的文档内容；当用户确定文档生成器中所显示的内容都准确无误后，则可以执行生成文档操作；这时，文档生成器将调用相应的文档编辑软件提供的接口，生成满足用户要求的测试文档。

1、  一种通用测试文档的生成方法，其特征在于：该方法包含两个步骤：
步骤一：定制文档模板
定制文档模板可以分为三个步骤：
第一步，文档模板结构定义：定义文档模板的树状结构图，即定义文档的各级标题的名称及格式，其中标题的格式主要包括标题的字体、字号、颜色以及是否需要斜体、是否需要加粗等信息；
第二步，文档模板内容样式定义：根据用户定义的文档模板的树状结构图，定义相应节点下需要的填充数据的来源以及数据在测试文档中的组织形式，主要包括图、表格、文本等样式；
第三步，生成XML描述文件保存入库：当用户定义好测试文档模板的树状结构以及对应内容的来源和组织方式后，就需要利用标准的XML生成器来生成该文档模板的XML描述文档并保存到模板库中；XML生成器定义了一组元语，用来描述用户定制的文档模板的相关信息，包括结构、内容来源及组织方式，以及数据筛选规则；
步骤二：文档生成
首先，标准的XML解析器能够从测试数据库中获得相应文档模板的XML描述文档，该XML解析器的DOM技术根据其描述生成一个友好的用户界面——文档生成器；
随后，用户可以在文档生成器给出的编辑区域中输入需要人工添加的文档内容；当用户确定文档生成器中所显示的内容都准确无误后，则可以执行生成文档操作；这时，文档生成器将调用相应的文档编辑软件提供的接口，生成满足用户要求的测试文档。

一种通用测试文档的生成方法
技术领域
本发明涉及一种通用测试文档的生成方法。尤其是指一种保证软件测试各个阶段中测试文档一致性的自动文档生成的方法。
背景技术
软件测试是保证软件质量的主要方法之一，而在软件测试过程中一项重要的工作是编制符合相关文档规范及标准的各种软件测试文档。完整、规范的软件测试文档可以规范测试工作的整个流程，可以减少测试人员之间的沟通成本，并使得测试工作易于检查，进而保证软件测试工作的顺利进行。软件测试文档是测试人员之间交流和沟通的工具，也是软件测试的依据和测试重要的输出产品形态。如果软件测试人员之间不能很好地交流计划测试的对象、需要的资源、测试工作的安排等等信息，将造成测试过程各个部分和各个阶段的工作不能有效地协调，这势必对整个软件测试工作产生严重的影响。
当前，国际通用的软件测试过程通常包括测试策划、测试设计、测试实施及测试总结等四个阶段。相关的测试文档之间对应关系如图1所示；从图中可以看出，测试的各个阶段得到了功能需求不同的测试文档。这些测试文档一般是靠手工撰写，费时、费力不能保证其准确性，而且，这些人工编制的软件测试文档的存放方式主要是纸张或者孤立的电子文档，这样做很难保证不同测试文档之间和同一测试文档内部的完整性、一致性。因此，辅助用户编写或者自动生成相关测试文档的方法及工具具有非常现实的意义，不但可以大大降低人工花费，而且可以改进生成测试文档的质量。
目前主流的测试过程管理工具对测试文档自动生成技术的支持很少。使用较多的Mercury Interactive TestDirector和BugZilla这两个测试过程管理工具只能提供基于Microsoft Word格式的文档自动生成，其不足有：
第一，不能提供覆盖整个测试过程所有阶段的测试文档，即它们输出的文档只包含了测试用例、软件问题、执行结果等数据，而对测试计划、测试总结等信息无能为力；同时，它们生成的文档不能满足相应的文档编制规范或标准。
第二，不具备通用性，即它们不支持文档模板的定制，只是提供相关内容的“要/不要”这样简单的选择功能，而不能针对用户的需求进行文档模板的定制。
发明内容
本发明的目的在于，提出一种通用测试文档的生成方法，利用测试过程中的测试数据、支持用户定制文档模板，以期达到功能完善、方便实用的目的。
本发明是基于XML格式的文档自动生成方法。XML文档的任何一个节点都不是孤立存在的，其中所有的元素排列都遵行严谨的树状结构。对于文档，如果按照文档的各级标题展开的话，其结构图也是树状结构，所以在生成通用测试文档过程中采用XML来描述测试文档的模板是非常合适的。
本发明的主要内容包含两个步骤：定制文档模板和文档的生成。测试文档模板与测试文档的关系就如类与对象的关系，测试文档是测试文档模板的实例化。整体流程图如图2所示。
通用测试文档生成过程中所用到的存储介质：模板库、测试数据库和文档管理库的内容介绍见附件1。
步骤一：定制文档模板
不同的软件组织所规定的用于编写测试文档的文档规范或标准可能是不同的。因此提供基于软件组织要求的文档模板是至关重要的。虽然，IEEE制订了软件测试文档标准，我们国家也制定了相应的国标及国军标文档编制标准，即便如此，各软件组织对测试文档编制往往有不同的要求，即使采用相应标准及规范，不同的软件组织在文档内容组织上也有不同的要求。要满足文档生成的通用性，就需要根据用户的具体要求定义文档模板。下面详细介绍一下定制文档模板方法。
文档模板不仅要定义文档格式，而且还要描述文档内容的来源及组织形式。因此，定制文档模板可以分为三个步骤：
第一步，文档模板结构定义。定义文档模板的树状结构图，即定义文档的各级标题的名称及格式，其中标题的格式主要包括标题的字体、字号、颜色以及是否需要斜体、是否需要加粗等信息。
第二步，文档模板内容样式定义。根据用户定义的文档模板的树状结构图，定义相应节点下需要的填充数据的来源以及数据在测试文档中的组织形式，主要包括图、表格、文本等样式。
用户在定义文档模板内容样式时，可以定义在生成应用该模板的文档时，对应文档结构某个节点的数据是从测试数据库中提取，还是人工添加。如果用户选择了在测试数据库中提取，就要用到标准的数据筛选规则定义器。利用数据筛选规则定义器，用户可以定义在测试数据库中提取数据的规则，在生成文档时将应用这些规则，把符合相应规则的数据生成到文档(文档模板实例)的相应位置。
第三步，生成XML描述文件保存入库。当用户定义好测试文档模板的树状结构以及对应内容的来源和组织方式后，就需要利用标准的XML生成器来生成该文档模板的XML描述文档并保存到模板库中。XML生成器定义了一组元语，用来描述用户定制的文档模板的相关信息，包括结构、内容来源及组织方式，以及数据筛选规则。下面给出部分文档模板描述元语：
<文档模板>:＝<结构，内容>
<结构>:＝<章节标题，章节级别，格式>
<章节标题>:＝正文
<格式>:＝<字体，字号，粗体，斜体，颜色>
<内容>:＝<数据来源，数据>
<数据来源>:＝<数据库，筛选规则>|手工输入
<数据>:＝<图>|<表>|正文
步骤二：文档生成
用户为某个项目定制的一个文档模板看作一个“类”，那么，应用该文档模板生成的对应的测试文档就是类的实例化——“对象”。文档生成的顺序图如图3所示。
首先，标准的XML解析器能够从测试数据库中获得相应文档模板的XML描述文档，该XML解析器的DOM技术可见附件2，并根据其描述生成一个友好的用户界面——文档生成器。
文档生成器是文档生成的核心部分，它负责和用户、相应数据库通信，生成最终的测试文档。根据用户在测试文档模板中定义的树状文档结构以及数据来源和存入形式，文档生成器为每个节点提供友好的用户界面，例如：针对需要人工输入的文本形式数据，嵌入文档编辑软件(如：Microsoft Word)的编辑区域，以便用户填写内容；针对需要人工输入的表格形式数据，嵌入表格编辑控件供用户编辑自定义表格数据；针对需要从测试数据库中读取的数据，根据定制文档模板时用户定义的数据筛选规则及数据组织方式从测试数据库中提取符合条件的数据，以文本及图表形式显示在界面上供用户查看及编辑。
随后，用户可以在文档生成器给出的编辑区域中输入需要人工添加的文档内容。当用户确定文档生成器中所显示的内容都准确无误后，则可以执行生成文档操作。这时，文档生成器将调用相应的文档编辑软件提供的接口，生成满足用户要求的测试文档。
附件1：数据存储介质
模板库：以XML文件的方式存放用户定制的各类测试文档的文档模板；
测试数据库：软件组织在测试过程中需要对产生的测试数据进行管理，这些数据包括测试进度及安排、测试人员、测试需求和测试项，测试用例及其执行信息、软件问题报告等。通常软件组织使用测试过程管理工具对这些测试数据进行管理，并将它们存储在测试数据库中。测试文档的主要内容可以来自于测试数据库，不需要客户编写重复内容，以保证文档与测试过程的一致；
文档管理库：统一存放测试过程中产生的各种文档，便于测试过程管理工具对所有的测试文档进行统一的文档管理。
附件2：XML解析器的DOM技术
DOM(Document Object Model)解析器将XML文档一次性解析，生成一个位于内存中的对象树用以描述该文档。
DOM是一种与平台和语言无关的接口，提供的API与编程语言无关。它允许程序和脚本动态地创建XML文档、遍历文档，允许程序和脚本动态访问和修改XML文档的内容、结构和类型。它定义了一系列的对象和方法对DOM树的节点进行各种随机操作：
Document对象——作为树的最高节点，Document对象是对整个文档进行操作的入口；
Element和Attr对象——这些节点对象都是文档某一部分的映射，节点的定级层次恰好反映了文档的结构；
Text对象——作为Element和Attr对象的子节点，Text对象表达了元素或属性的文本内容，Text节点不再包含任何子节点；
集合索引——DOM提供了几种集合索引方式，可以对节点按指定方式进行遍历。索引参数都是从0开始记数的。
DOM树中的所有节点都是从Node对象继承而来的。Node对象定义了一些基本的属性和方法，利用这些方法可以实现对树的遍历，同时，根据属性还可以得知节点的名称、取值并判断其类型。事实上，DOM执行了更进一步的操作，它将文档中的每个项目看作节点——元素，属性，注释，处理命令，甚至构成属性的文本。
附图说明
图1所示为测试文档与测试阶段对应关系
图2所示为通用测试文档生成过程
图3所示为文档生成顺序图
具体实施方式
基于本发明的方法，设计并实现了某一测试平台的文档生成功能。该功能的实现包括两个部分：一为模板定义，二为文档生成。
步骤一：模板定义，平台是以Microsoft Word格式定义软件测试各阶段的模板。一共有三种定义的方式，第一是使用宏方式定义，即添入相应的控件来定义软件测试数据的各个字段，比如测试用例名称、详细说明和软件问题信息这三个字段，能够在在宏中找到。用户只需要点击需要的字段即可在模板中加入这些字段。第二是标题字段，这是一种所见即所得的添加方式，主要是使用了Word文档自带的一些控件，比如字体，字号这些编辑所用的信息。第三是为了生成通用的测试文档，提供了一种自定义字段的方式，用户可以根据需要添加自己认为在测试阶段重要的信息字段。各阶段的测试文档模板定义有很大的自主性。当各字段被定义后，将以XML格式进行存储。这时转入步骤二。
步骤二：文档生成，这一步骤中主要使用XML解析器把在步骤一存储的模板XML格式解析出文档。生成的文档即为此次操作获得的通用测试文档，为了体现文档管理库的作用，针对步骤一自定义模板中的字段，可以在步骤二中对这些字段的内容进行修改(添加，删除等操作)，并且使这些自定义字段成为宏定义方式，方便后续利用这些自定义字段。