[译] 定制化报告


标准报告通常适用于大多数情况。 但是,为了满足个人需求,它是完全可定制的。 我们将选项分为两个章节,一个用于更简单的自定义,另一个用于更复杂的自定义。 在本章中,你将学习有关自定义的基础知识,主要是如何更改报告的外观,即添加自己的logo和更改模板。

章节预览
有关涉及编码的更复杂的自定义,请参阅 > Ranorex Studio 基础教程 > 报告 > 👉 复杂自定义

本章导视

视频向导
视频“自定义报告简介”将引导您完成本章中的信息。
立即观看

下载示例解决方案

本章中的说明基于下述下载的示例解决方案。

示例解决方案

主题:报告自定义
时间:15min以内
下载:点我下载

安装

  1. 解压项目目录到你的计算机任一文件夹
  2. 使用RanorexStudi打开RxDatabase.rxsln解决方案

贴士

示例解决方案适用于Ranorex版本8.0或更高版本。你需要将解决方案自动升级同意到8.2及更高版本的

从原始数据到报告

下面的图片说明了在报表中以易于阅读的格式显示原始数据的过程。

A9050-0000010
Ranorex报告的概念

  1. 在测试运行期间,报表引擎以XML格式收集数据。
  2. 接着报表引擎将此数据转换为HTML,并根据CSS和XSL规范创建报表文件。
  3. 然后,Ranorex Studio可以使用其内置的HTML查看器显示此基于HTML的报告。

收集的测试数据

收集测试运行的数据并以XML格式存储。此原始数据也可以在Ranorex Studio外部使用任何XML查看器/编辑器进行读取和使用。

A9050-0000020
XML格式的测试数据

原始XML数据总是保存在和对应报告相同的文件夹中,并且具有相同的文件名和添加的后缀.data

A9050-0000030
报告文件和XML数据文件

CSS和XSL格式

然后使用原始XML数据创建基于CSS和XSL规范的HTML文件。

A9050-0000040

用于生成HTML文件的XSL和CSS格式也存储在与XML数据和实际报告相同的文件夹中

A9050-0000050
CSS和XSL文件

章节预览
为了能够更改Ranorex标准报告的布局和内容,建议你对HTML,CSS,XSL和XML有基本的了解。 有关详细信息,请参阅www.w3.org上的万维网联盟(W3C)

HTML报告文件

由XSL和CSS从XML生成的最终报告是基于HTML的格式存储在项目目录的Reports文件夹中。

A9050-0000060
基于html的报告文件和报告显示在Ranorex Studio

提示

  • 报告可以在任一Web浏览器中查看
  • 报告文件可以在任一HTML编辑器里编辑

创建一个自定义报告模板

现在我们已经确定了如何生成报告,现在我们可以开始自定义报告了。在Ranorex Studio中有一种方便的方法可以在不影响标准报告的情况下执行此操作:

  1. 在测试套件视图,右键测试套件
  2. 点击Properties
  3. 点击Report选项卡

F3040-0000010

  1. 点击Create custom template
  2. 将显示一条消息,告诉你新报告模板文件夹的创建位置,单击确定确认。

A9050-0000070

结果

在项目视图中,在项目视图中,你可以看到包含复制的报告文件的新模板文件夹。

A9050-0000080
项目视图中的NewCustomTemplate1文件夹

  1. CSS、XSL和图像文件
    • 这些是你更改的复制文件,用于自定义报告的布局和内容
    • PNG文件包含Ranorexlogo作为报告的默认logo以及标准报告中使用的其他图像,你可以用自己的图像替换它们
  2. 预览文件
    • 这些文件使你能够快速检查在实际报告中其他文件中的定制是什么样子的。打开视图,获得预览
    • 你也可以从Windows打开它,因此你不必启动Ranorex Studio

多个自定义报告模板

你可以根据需要创建任意数量的自定义报告模板。 但是,测试套件一次只能激活一个模板。要创建其他自定义模板:

  1. 在测试套件属性的Report选型卡中,点击重置到默认
  2. 再点击Create custom template并点击OK

A9050-0000090

结果

另一个模板文件夹出现在项目视图中。

A9050-0000091
多个自定义报告模板的示例

重命名自定义报告模板

你可以重命名自定义报告模板

  1. 在项目视图中,选择你要重命名的模板
  2. 按下F2可以重命名模板文件夹
  3. 重命名文件夹

注意
报告引擎不会自动识别名称更改。重命名后,你必须应用模板。

A9050-0000130

重命名一个自定义报告模板

A9050-0000140

如果模板没有应用将会报错

选择/重新应用报告模板

这个功能有三种用途:

  • 在文件夹中添加一个现有的自定义模板
  • 如果你有多个自定义模板,选择一个并应用一个使用
  • 如果你重命名了一个模板并应用了它,Ranorex可以再次找到它

提示

同一时间,一个测试套件,只有一个报告模板是激活的

  1. 在测试报告属性中打开报告选项卡
  2. 如果当前有一个自定义模板处于激活状态,单击Reset重置到默认模板

A9050-0000100

  1. 点击Choose custom template
  2. 在浏览视图中选择一个自定义模板
  3. 点击OK

重置到默认报告模板

如果你想停止使用自定义模板,你可以随时重置到默认的Ranorex模板。

  1. 在测试套件属性中的打开报告选项卡
  2. 点击Reset重置到默认并确认OK

A9050-0000110

提示
此操作不会删除自定义报表模板。你仍然可以按照上面一节描述的那样重新应用它们

A9050-0000120 Ranorex标准报告模板

Ranorex如何处理自定义模板

Ranorex有一个特殊的机制来处理定制的报表模板。它涉及到每个项目都有的输出文件夹和报告文件夹。当你想要在报表模板中包含外部文件时,了解这个过程是很重要的,例如包含你标识的PNG,因为这些文件默认情况下不包含在这个过程中。

输出文件夹\bin\Debug\

执行测试时,Ranorex Studio会将测试运行所需的所有文件复制到指定的输出文件夹中 叫 \bin\Debug\,它位于项目的文件夹中。这包括作为自定义报告模板的一部分创建的标准文件,但不包括外部文件,例如logo。仅当外部文件配置为输出文件夹时,它们才会复制到输出文件夹,因此默认情况下不会显示在报告中。如何执行此操作将在下一节中介绍。

A9050-0000150
Ranorex输出文件夹

  1. 在输出文件夹中复制自定义报告模板文件夹(本例中为FrogConsulting)

  2. 报告输出文件夹中的文件夹

  3. 报告文件(.rxlog)和相应的原始数据文件(.rxlog.data)

  4. CSS和XSL规范文件以及默认logo文件RanorexReport.png

提示

Ranorex在每次后续测试运行时同步输出文件夹的所有文件。

流程摘要

下面的图像和说明说明了该过程。如前所述,外部文件需要特殊配置才能包含在流程中。在这种情况下,我们假设已经完成了。您可以在下面进一步了解如何操作。

A9050-0000170

  1. 自定义报告模板已应用于测试套件。自定义模板的文件夹位于项目的文件夹中,本例中为FrogConsulting。

  2. 在第一次测试运行时,自定义模板文件夹将直接复制到项目的输出文件夹中。

  3. 报表布局文件(CSS,XSL和自定义文件)也从模板文件夹直接复制到项目输出文件夹中的Reports文件夹。

在后续运行中,项目文件夹和输出文件夹中的自定义模板文件夹将同步,即输出文件夹始终包含自定义模板文件夹中的最新文件。

在报告中包含外部文件

默认情况下,Ranorex仅在报告过程中包含内部文件(.rxlog,rxlog.data,.css,.xsl),即仅将这些文件复制到输出文件夹。对于要在自定义报告中显示的外部文件(如logo),你需要手动将它们包含在此过程中。

  1. 将外部文件复制到你希望它们所属的自定义报告模板的文件夹中。
  2. 在Ranorex Studio的项目视图中,单击刷新按钮以在模板的文件夹中查看该文件。

A9050-0000180
项目文件视图工具栏中的“刷新”按钮

  1. 右键外部文件
  2. 点击Include in project
  3. 该文件现在包含在项目中,但我们还没有完成

A9050-0000190

  1. 复制到自定义报表文件夹中的任何文件最初都不是项目的一部分,这意味着它们也不包括在报表过程中

6.选择外部文件并点击F4打开它的属性

7.你可以看到Copy to output folder被设置成Never,因此文件仍然不会包含到报告过程中。将它更改为Always或是Preserve newest

A9050-0000200

  1. Never--是任何新包含的外部文件的默认设置。
  2. Always--表示文件将被复制到每个测试运行的输出文件夹中。
  3. Preserve newest--表示只有在/Reports/文件夹中的版本比输出文件夹中的现有版本更新时才会复制该文件。如果输出文件夹中尚不存在任何文件,则始终会复制该文件

背景颜色和logo自定义

在此示例中,你将更改报告的背景颜色,并将Ranorex logo替换为自定义logo。该示例可在本章开头下载。

  • 你的logo不必是特定尺寸,可以尝试不同的尺寸
  • logo中使用的颜色是十六进制值

我们准备了一个标志样品。绿色背景有十六进制值:#ACDB6B

A9050-0000210

示例logo已位于FrogConsulting自定义报告模板文件夹中

A9050-0000220

要替换logo,你需要更改CSS文件。

  1. 在项目视图中,双击CSS规范文件
  2. 它将在新选项卡中打开

A9050-0000230

  1. 滑到文件的末尾,找到自定义区域
  2. 删除此行以取消注释自定义部分,然后按如下所述替换其内容

A9050-0000240

  1. 背景自定义
    • 背景颜色设置为与logo背景颜色相同的绿色十六进制值
    • 所有其他设置都保持不变
  2. 自定义logo
    • logo的高度和宽度设置为各自的值(请参阅logo大小)
    • 默认logo名称将替换为“frogconsulting.png”
    • 其他设置保持不变
  3. 报告信息框对齐方式
    • 最后,为一般信息框设置了40px的上边距

结果

A9050-0000250

提示

如果报告中缺少logo,请记住在项目和报告过程中包含logo文件,如上所述

用用户名替换计算机/端点

还有各种更改报告内容的选项。我们将通过三个示例介绍基本原理,并根据你自己的想法帮助你自定义报告。在第一个示例中,你将自定义报告,以便“计算机/端点”条目显示“用户名”,而不是计算机名称显示用户名。

A9050-0000260
用用户名替换计算机/端点

  1. XSL文件中定义条目标题的行。
  2. 原始数据文件中的“主机”行。 它包含实际的计算机/端点名称。
  3. XSL文件中的行,它从原始数据文件中的“主机”行获取计算机/端点名称,并将其显示在报告中的“计算机/端点”条目下方。

要用“用户名”替换“计算机/端点”条目并显示用户名:

  1. 在XSL文件中,使用"Frog user"替代"计算机/端点"
  2. 也可以在XSL文件中,使用@user替换@host变量

A9050-0000270
报告用户名自定义

  1. 保存关闭文件

结果

A9050-0000280
自定义用户名的报告

更改报告消息格式

在此示例中,你将更改特定类型的报告消息的格式。

如下图所示,在默认报告中,具有“成功”级别的消息以绿色字体打印。我们将其更改为粗体蓝色字体。

A9050-0000290

1. 默认成功的信息绿色的

  1. 打开CSS文件
  2. 找到成功消息的颜色定义并复制它
  3. 将其粘贴到CSS文件末尾的定制部分,并像在图像中一样修改它
  4. 保存并关闭文件

A9050-0000300

2. 成功消息的默认字体颜色定义
3. 自定义部分中的新颜色定义,覆盖默认定义。

提示

不要更改默认定义(CSS行#197 - #199),这样,你就可以轻松恢复默认值。

结果

A9050-0000310

从报告中删除信息

在本例中,你将从报表中删除信息。当某些内容不相关并且你想在报告中释放空间时,这是非常有用的。

在我们的示例中,我们希望删除报表消息的Time列

A9050-0000320

  1. 打开XSL文件
  2. 找到文件中所有Time的实例

A9050-0000330

1. 这些行定义了XSL文件中的Time列。

  1. 通过如下注释来停用所有这些

A9050-0000340

2. 此代码获取每个操作行的时间值,并将它们显示在正确的位置。

  1. 通过如下注释将其取消激活

A9050-0000350

结果

A9050-0000360
自定义报告没有时间列


👈Ranorex标准报告                             复杂的报告定制👉

© 2018 ranorex.xyz            updated: 2019-12-18

results matching ""

    No results matching ""