尝试在 Allure 报告中添加新标签

Question

我正在尝试为 Allure 创建一个插件，它将添加一个名为浏览器的新选项卡，它将在所有浏览器中显示 TC 状态，但我停留在它的第一步 - 添加浏览器选项卡到报告本身。我正在使用 allure-report-plugin-api 和来自这个问题的说明 - 以及来自 allure-report-plugin-api 的 git repo 的示例。但是我没有运气，尽管代码非常简单，但没有添加选项卡。能否请您指出我在哪里做错了，并告诉我正确的方法是什么？非常感谢！

这是我尝试添加新标签的示例

这是项目结构

src
--->main
--->--->java
--->--->--->allure
--->--->--->--->(Class) BrowserInfo
--->--->resourses
--->--->--->(directory)allure
--->--->--->--->(directory)BrowserInfo
--->--->--->--->--->en.json
--->--->--->--->--->script.js
--->test
--->--->allure
--->--->--->(Class) GoogleSearchTest
--->--->testcases
--->--->--->SearchTest.xml
pom.xml

这是 BrowserInfo class

package allure;

import ru.yandex.qatools.allure.Allure;
import ru.yandex.qatools.allure.data.AllureAttachment;
import ru.yandex.qatools.allure.data.AllureStep;
import ru.yandex.qatools.allure.data.AllureTestCase;
import ru.yandex.qatools.allure.data.plugins.DefaultTabPlugin;
import ru.yandex.qatools.allure.data.plugins.Plugin;
import ru.yandex.qatools.allure.model.Label;

import java.util.ArrayList;
import java.util.List;

@Plugin.Name("browserList")
public class BrowserInfo extends DefaultTabPlugin {

    @Override
    public void process(AllureTestCase data) {

    }

}

这里是en.json

{
  "browserList": {
    "TITLE": "Browsers",
    "TITLE_FULL": "List of browsers"
  }
}

这里是script.js

/*global angular*/
(function() {
    "use strict";
    var module = angular.module('allure.browserList', []);
    module.config(function($stateProvider, allureTabsProvider) {
        allureTabsProvider.addTab('browserList', {title: 'browserList.TITLE'});
    });

})();

这里只是一个小测试

package allure;

import junit.framework.Assert;
import org.openqa.selenium.By;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.firefox.FirefoxDriver;
import org.testng.annotations.Test;

public class GoogleSearchTest {

    @Test
    public void searchBananasTest() {

        WebDriver driver = new FirefoxDriver();
        driver.get("https://www.google.com/");
        driver.findElement(By.id("lst-ib")).sendKeys("BANANAS");
        driver.findElement(By.cssSelector("[type = 'submit']")).click();
        Assert.assertTrue(driver.findElement(
                By.cssSelector("[data-async-context='query:BANANAS'] h3")
        ).getText().toLowerCase().contains("banana"));
        driver.quit();

    }

}

这里是 TestNG 测试 xml 进行测试

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd" >
<suite name="searching bananas">

    <test name="searching bananas" preserve-order="true">
        <classes>
            <class name="allure.GoogleSearchTest">
                <methods>
                    <include name = "searchBananasTest"/>
                </methods>
            </class>
        </classes>
    </test>

</suite>

这是pom.xml文件

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>AllurePluginTest</groupId>
  <artifactId>AllurePluginTest</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>jar</packaging>

  <name>allure</name>
  <url>http://maven.apache.org</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <aspectj.version>1.8.5</aspectj.version>
    <allure.version>1.4.16</allure.version>
  </properties>
  <build>
    <plugins>
      <plugin>
        <artifactId>maven-surefire-plugin</artifactId>
        <version>2.16</version>
        <configuration>
          <suiteXmlFiles>
            <suiteXmlFile>${suitexml}</suiteXmlFile>
          </suiteXmlFiles>
          <testFailureIgnore>false</testFailureIgnore>
          <argLine>
            -javaagent:"${settings.localRepository}/org/aspectj/aspectjweaver/${aspectj.version}/aspectjweaver-${aspectj.version}.jar"
          </argLine>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>aspectjweaver</artifactId>
            <version>${aspectj.version}</version>
          </dependency>
        </dependencies>
      </plugin>
      <plugin>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>2.3.2</version>
        <configuration>
          <source>1.8</source>
          <target>1.8</target>
        </configuration>
      </plugin>
    </plugins>
  </build>

  <dependencies>

    <dependency>
      <groupId>ru.yandex.qatools.allure</groupId>
      <artifactId>allure-testng-adaptor</artifactId>
      <version>${allure.version}</version>
      <exclusions>
        <exclusion>
          <groupId>junit</groupId>
          <artifactId>junit</artifactId>
        </exclusion>
      </exclusions>
    </dependency>

    <dependency>
      <groupId>org.seleniumhq.selenium</groupId>
      <artifactId>selenium-java</artifactId>
      <version>2.46.0</version>
    </dependency>

    <dependency>
      <groupId>org.testng</groupId>
      <artifactId>testng</artifactId>
      <version>6.8.7</version>
    </dependency>

    <dependency>
      <groupId>ru.yandex.qatools.allure</groupId>
      <artifactId>allure-report-plugin-api</artifactId>
      <version>1.4.16</version>
    </dependency>

  </dependencies>

  <reporting>
    <excludeDefaults>true</excludeDefaults>
    <plugins>
      <plugin>
        <groupId>ru.yandex.qatools.allure</groupId>
        <artifactId>allure-maven-plugin</artifactId>
        <version>2.2</version>
      </plugin>
    </plugins>
  </reporting>

</project>

Answer 1

主要问题是 Allure 通过 Java SPI 加载插件。所以你需要创建文件 ru.yandex.qatools.allure.data.plugins.Plugin in META-INF/services/ 在您的资源文件夹中，内容如下：

allure.BrowserInfo

然后你需要配置allure-maven-plugin来使用你的插件：

<reporting>
    <excludeDefaults>true</excludeDefaults>
    <plugins>
        <plugin>
            <groupId>ru.yandex.qatools.allure</groupId>
            <artifactId>allure-maven-plugin</artifactId>
            <version>2.2</version>
            <configuration>
                <plugins>
                    <plugin>
                        <groupId>${project.groupId}</groupId>
                        <artifactId>${project.artifactId}</artifactId>
                        <version>${project.version}</version>
                    </plugin>
                </plugins>
            </configuration>
        </plugin>
    </plugins>
</reporting>

注意：插件需要安装到本地仓库。

我建议为您的插件使用单独的项目并使用 maven-invoker-plugin 生成预览报告。在这种情况下，您不需要运行测试（您可以将测试结果放在您需要的文件夹中）并且不需要 install/deploy 插件。

还有一些给你的评论：

浏览器信息

默认情况下，Allure 期望每个插件在文件 ${pluginName}.json 中提供一些数据。所以你需要添加一些虚拟数据。您可以像这样简单地添加字段的示例：

@Plugin.Data
private List<String> strings = new ArrayList<>();

在 script.js（空解析部分）中配置此行为的另一种方式：

allureTabsProvider.addTab('browserList', {title: 'browserList.TITLE', resolve: {}});

翻译

要将翻译添加到报告中，请使用以下命令：

allureTabsProvider.addTranslation('cats');

看看：Allure JavaScript API

插件模板

Allure 为每个选项卡插件查找 tab.tpl.html。所以你需要把它添加到你的插件资源中。

希望对您有所帮助。

Answer 2

添加依赖项 ALLure Report Builder 然后添加以下代码

// It will generate the Allure Report folder.
new AllureReportBuilder("1.5.4", new File("target/allure-report")).unpackFace(); 
new AllureReportBuilder("1.5.4", new File("target/allure-report")).processResults(new File("target/allure-results"));

尝试在 Allure 报告中添加新标签

Trying to add a new Tab in Allure report

allure

浏览器信息

翻译

插件模板