探索Serenity与Cucumber的自动化测试新世界

2024-06-03 14:33:27作者：段琳惟

Serenity BDD是一款强大的工具，旨在使编写高质量的自动化验收测试变得更加简单，并提供令人印象深刻的报告和实时文档功能。它无缝集成Selenium用于Web测试，以及RestAssured进行API测试。

Serenity鼓励良好的测试自动化设计，支持多种设计模式，包括经典的Page Objects、新的Lean Page Objects/Action Classes方法，以及更灵活的Screenplay模式。

最新版本的Serenity已经全面兼容Cucumber 6.x。

起步：Serenity与Cucumber入门

要在Serenity和Cucumber上开始你的旅程，最理想的方式是从Github克隆或下载官方提供的**Serenity Cucumber Starter项目。这个项目提供了基本的项目结构，附带一些示例测试和辅助类。你可以选择两种分支，master分支使用传统方式，而screenplay**分支则展示了如何使用Screenplay模式实现相同的示例测试。

项目目录结构

项目遵循了大多数Serenity项目标准的目录布局：

src
  + main
  + test
    + java                        测试运行器和辅助代码
    + resources
      + features                  功能文件
      + search                  功能文件子目录
             search_by_keyword.feature

自Serenity 2.2.13起，已整合WebdriverManager，自动下载WebDriver二进制文件。

示例场景

两个变体的示例项目都使用同一个Cucumber场景：假设有个喜欢搜索东西的角色Sergey在互联网上查找信息：

Feature: 搜索关键词

  Scenario: 查找一个术语
    给定 Sergey 在互联网上做研究
    当他查寻"Cucumber"时
    那么他应该看到关于"Cucumber"的信息

Screenplay实现

在master分支中，采用的是Screenplay模式。这种模式将测试描述为演员执行的任务，而不是直接调用方法。这使得它们更加灵活且可组合，但编码相对繁琐些。例如：

    @Given("{actor} 是在互联网上做研究")
    public void 做研究(Actor actor) {
        actor能够(NavigateTo.theWikipediaHomePage());
    }

    @When("{actor} 查找 {string}")
    public void 查找(Actor actor, String term) {
        actor试图(
                LookForInformation.关于(term)
        );
    }

    @Then("{actor} 应该看到关于 {string} 的信息")
    public void 应该看到关于(Actor actor, String term) {
        actor试图(
                Ensure.that(WikipediaArticle.HEADING).有文本(term)
        );
    }

Screenplay类强调可复用组件和易读的声明式风格，而Lean Page Objects和Action Classes（如下面所见）则倾向于使用更具命令式的风格。

NavigateTo类负责打开首页：

public class NavigateTo {
    public static Performable 打开首页() {
        return Task.where("{0} 打开首页",
                Open.browserOn().the(WikipediaHomePage.class));
    }
}

LookForInformation类处理实际的搜索：

public class LookForInformation {
    public static Performable 关于(String searchTerm) {
        return Task.where("{0} 查找 '" + searchTerm + "'",
                Enter.theValue(searchTerm)
                        .into(SearchForm.SEARCH_FIELD)
                        .然后按(Keys.ENTER)
        );
    }
}

在Screenplay中，我们以轻量级页面或组件对象存储元素选择器，就像这样：

class SearchForm {
    static Target SEARCH_FIELD = Target.the("搜索框")
                                       .locatedBy("#searchInput");

}

Screenplay DSL丰富且灵活，适合大型测试自动化项目团队，成员对Java和设计模式有一定了解。

Action Classes 实现

在action-classes分支中，你将找到使用Action Classes模式的实现。这里的粘合代码看起来像这样：

    @Given("^(?:.*) 是在互联网上做研究")
    public void 我正在主页() {
        导航到.首页();
    }

    @When("她/他查找 {string}")
    public void 我搜索({String term}) {
        查找.术语(term);
    }

    @Then("她/他应该看到关于 {string} 的信息")
    public void 所有结果标题应该包含单词({String term}) {
        断言.认为(searchResult.显示()).包含(term);
    }

这些类通过Serenity的@Steps注解声明，如下所示：

    @Steps
    NavigateTo 导航到;

    @Steps
    SearchFor 查找;

    @Steps
    SearchResult searchResult;

@Steps注解告诉Serenity创建此类的新实例，并注入任何其他步骤或页面对象。

每个动作类模型特定的用户行为方面：导航到特定页面，执行搜索，或者检索搜索结果。这些类设计得小巧且自包含，这使其更稳定，更容易维护。

NavigateTo类是一个非常简单的动作类的例子。在更大的应用中，它可能还有其他与高级导航相关的其他方法，但在我们的样本项目中，它只需要打开首页：

public class NavigateTo {

    WikipediaHomePage 主页;

    @Step("打开首页")
    public void 首页() {
        主页.open();
    }
}

它通过一个标准的Serenity Page Object做到这一点，通常只存储页面本身的URL：

@DefaultUrl("https://example.org")
public class WikipediaHomePage extends PageObject {}

第二个类，SearchFor，是一个交互类。它需要与网页交互，为此，我们让这个类继承Serenity的UIInteractionSteps。这赋予类完整的Selenium WebDriver API访问权限，包括$()方法，它使用By选择器或XPath或CSS表达式来定位web元素：

public class SearchFor extends UIInteractionSteps {

    @Step("搜索术语 {0}")
    public void 术语(String term) {
        $(SearchForm.SEARCH_FIELD).clear();
        $(SearchForm.SEARCH_FIELD).sendKeys(term, Keys.ENTER);
    }
}

SearchForm类是典型的轻型Page Object，仅负责唯一地定位页面上的元素，有时还动态解析web元素：

class SearchForm {
    static By SEARCH_FIELD = By.cssSelector("#searchInput");
}

最后的步骤库类在步骤定义代码中使用是SearchResult类。它的任务是查询网页，获取可以用于AssertJ断言的搜索结果列表：

public class SearchResult extends UIInteractionSteps {
    public String 显示() {
        return find(WikipediaArticle.HEADING).getText();
    }
}

WikipediaArticle类是一个精简的Page Object，负责定位结果页面上的文章标题：

public class WikipediaArticle {
    public static final By HEADING =  By.id("firstHeading");
}

Action Classes方法的主要优点不在于编写的行数，尽管Serenity确实减少了在Web测试中通常需要编写的大量样板代码。真正的优势在于使用许多小型、稳定的类，每种类专注于单一任务。这种对《单一职责原则》的应用有助于使测试代码更加稳定，易于理解，更易于维护。

运行测试

要运行样本项目，只需运行CucumberTestSuite测试运行器类，或从命令行运行mvn verify或gradle test。

默认情况下，测试将在Chrome浏览器中运行。你可以通过覆盖driver系统属性运行在Firefox上，例如：

$ mvn clean verify -Ddriver=firefox

或

$ gradle clean test -Pdriver=firefox

测试结果会记录在target/site/serenity目录下。

生成报告

由于Serenity报告包含了所有测试的汇总信息，因此不会在每次单个测试后立即生成（这将极其低效）。相反，完整版的Serenity报告由serenity-maven-plugin生成。你可以通过命令行运行mvn serenity:aggregate触发这个过程，或者从IDE中运行。

报告也已集成到Maven构建流程中：以下pom.xml中的代码会在所有测试完成后自动触发报告生成：

            <plugin>
                <groupId>net.serenity-bdd.maven.plugins</groupId>
                <artifactId>serenity-maven-plugin</artifactId>
                <version>${serenity.maven.version}</version>
                <configuration>
                    <tags>${tags}</tags>
                </configuration>
                <executions>