Selenium修改HTTP请求头三种方式

测试自动化挑战之一修改Selenium WebDriver中的请求请求头。我将分享如何使用Selenium WebDriver修改HTTP请求请求头。

什么是HTTP请求头

HTTP请求头是HTTP 协议的重要组成部分。它们定义了 HTTP 消息(请求或响应)并允许客户端和服务器与消息交换可选的元数据。它们由不区分大小写的头字段名称后跟一个冒号,然后是头字段值组成。标题字段可以扩展到多行,方法是在每一额外行前至少有一个空格或水平制表符。

标题可以根据其上下文进行分组:

  • 请求头:HTTP 请求请求头用于提供有关正在获取的资源和发出请求的客户端的附加信息。
  • 响应头:HTTP 响应头提供有关响应的信息。

以下是 HTTP 请求请求头中包含的主要信息:

  • IP 地址(来源)和端口号。
  • 请求的网页的 URL。
  • Web 服务器或目标网站(主机)。
  • 浏览器将接受的数据类型(文本、html、xml 等)。
  • 发送兼容数据的浏览器类型(Mozilla、Chrome、IE)。
  • 作为响应,包含请求数据的 HTTP 响应请求头由 发回。

需要更改HTTP请求请求头

以下是测试工作中可能需要更改 HTTP 请求请求头的一些场景:

  • 通过建立适当的 HTTP 请求头来测试控制、测试不同的版本。
  • 需要对 Web 应用程序的不同方面甚至服务器逻辑进行彻底测试的情况。
  • 由于 HTTP 请求请求头用于启用 Web 应用程序逻辑的某些特定部分,通常在正常模式下会禁用这些部分,因此根据测试场景,可能需要不时修改 HTTP 请求请求头。

在被测 Web 应用程序上测试访客模式是测试人员可能需要修改HTTP请求请求头的情况。但是Selenium RC曾经支持的修改HTTP请求头的功能,现在Selenium Webdriver不处理了。

Selenium修改请求头

Selenium Java中修改请求头请求的多种方法。大体上,有几种可能,接下来可以修改 Java-Selenium 项目中的头请求。

  • 使用Java HTTP请求框架。
  • 使用反向代理。
  • 使用 Firefox 浏览器扩展。

Java HTTP请求框架

与 Selenium 一起,我们可以使用 REST Assured,它是一种以简单方式使用 REST服务的绝佳工具。为项目配置 REST Assured教程非常简单,这里就不介绍了。

让我们考虑以下场景:

  • 我们有一个名为 RequestHeaderChangeDemo 的 Java 类,我们在其中维护基本配置
  • 我们有一个名为 TestSteps 的测试步骤文件,我们将在其中调用 RequestHeaderChangeDemo Java 类中的方法,通过这些方法我们将执行我们的测试。

观察下面名为 RequestHeaderChangeDemo 的 Java 类。

BASE_URL是应用了以下四种方法的网站:

  • 认证用户
  • 获取产品
  • 添加产品
  • 移除产品
    public class RequestHeaderChangeDemo {

        private static final String BASE_URL = "https://****";

        public static IRestResponse<Token> authenticateUser(AuthorizationRequest authRequest) {

            RestAssured.baseURI = BASE_URL;
            RequestSpecification request = RestAssured.given();
            request.header("Content-Type", "application/json");

            Response response = request.body(authRequest).post(Route.generateToken());
            return new RestResponse(Token.class, response);
        }

        此处省略部分重复代码

    }

在上面的Java类文件中,我们在每个连续的方法中重复发送了BASE_URL和headers。示例如下所示:

RestAssured.baseURI = BASE_URL;
RequestSpecification request = RestAssured.given(); 
request.header("Content-Type", "application/json");
Response response = request.body(authRequest).post(Route.generateToken());

request.header方法请求 JSON 格式的请求头。有大量的代码重复,这降低了代码的可维护性。如果我们在构造函数中初始化RequestSpecification对象并使这些方法非静态(即创建实例方法),则可以避免这种情况。由于 Java 中的实例方法属于类的 Object 而不是类本身,因此即使在创建类的 Object之后也可以调用该方法。与此同时,我们还将重写实例方法。

将方法转换为实例方法有以下优点:

  • 身份验证仅在一个 RequestSpecification 对象中进行一次。不再需要为其他请求创建相同的请求。
  • 灵活修改项目中的请求头。

因此,让我们看看当我们使用实例方法时 Java 类 RequestHeaderChangeDemo 和测试步骤文件 TestSteps 。

带有实例方法的RequestHeaderChangeDemo 类的 Java 类

    public class RequestHeaderChangeDemo {

        private final RequestSpecification request;

        public RequestHeaderChangeDemo(String baseUrl) {
            RestAssured.baseURI = baseUrl;
            request = RestAssured.given();
            request.header("Content-Type", "application/json");
        }

        public void authenticateUser(AuthorizationRequest authRequest) {
            Response response = request.body(authRequest).post(Route.generateToken());
            if (response.statusCode() != HttpStatus.SC_OK)
                throw new RuntimeException("Authentication Failed. Content of failed Response: " + response.toString() + " , Status Code : " + response.statusCode());

            Token tokenResponse = response.body().jsonPath().getObject("$", Token.class);
            request.header("Authorization", "Bearer " + tokenResponse.token);
        }

        public IRestResponse<Products> getProducts() {
            Response response = request.get(Route.products());
            return new RestResponse(Products.class, response);
        }
        此处省略部分代码
    }

代码实战

  • 我们创建了一个构造函数来初始化包含 BaseURL 和请求请求头的 RequestSpecification 对象。
  • 早些时候,我们必须在每个请求请求头中传递令牌。现在,一旦我们在方法authenticateUser() 中收到令牌响应,我们就将它放入请求的同一个实例中。这使测试步骤的执行能够向前推进,而无需像之前那样为每个请求添加令牌。这使得请求头可用于对服务器的后续调用。
  • 现在将在 TestSteps 文件中初始化这个 RequestHeaderChangeDemo Java 类。

我们根据 RequestHeaderChangeDemo Java 类中的更改更改 TestSteps 文件。

public class TestSteps
{
    private final String USER_ID = "";    
    private Response response;
    private IRestResponse<UserAccount> userAccountResponse;
    private Product product;
    private final String BaseUrl = "https://******";
    private RequestHeaderChangeDemo endPoints;
    
    @Given("^User is authorized$")
    public void authorizedUser()
    {
        endPoints = new RequestHeaderChangeDemo (BaseUrl);
        AuthorizationRequest authRequest = new AuthorizationRequest("(Username)", "(Password)");
        endPoints.authenticateUser(authRequest);
    }
 
    @Given("^Available Product List$")
    public void availableProductLists() 
    {       
        IRestResponse<Products> productsResponse = endPoints.getProducts();
        Product = productsResponse.getBody().products.get(0);
    }
 
    @When("^Adding the Product in Wishlist$")

    {
        ADDPROD code = new ADDPROD(product.code);
        AddProductsRequest addProductsRequest = new AddProductsRequest(USER_ID, code);
        userAccountResponse = endPoints.addProduct(addProductsRequest);
    }
 

}

这是我们在修改后的实现中所做的:

  • 初始化 RequestHeaderChangeDemo 类对象作为端点。
  • BaseURL 是在第一个方法(即authorizedUser)中传递的。
  • 在方法authorizedUser 中,我们调用了RequestHeaderChangeDemo 类的构造函数authenticateUser。
  • 因此,后续步骤定义使用相同的端点对象。

使用反向代理

顾名思义,在 Java-Selenium 自动化测试套件中处理请求请求头更改时,我们可以选择使用代理。由于 Selenium 禁止在浏览器和服务器中注入信息,因此可以使用代理进行处理。如果测试是在公司防火墙后面执行的,则这种方法不是首选。

作为 Web 基础架构组件,代理通过将自身定位在客户端和服务器之间来使 Web 流量通过它。代理的工作方式类似,使流量通过它,允许安全的流量通过并阻止潜在威胁。代理具有部分或完全修改请求和响应的能力。

核心思想是发送授权请求头,绕过包含凭证对话的阶段,也称为基本认证对话。然而,结果证明这是一个累人的过程,尤其是在测试用例需要频繁重新配置的情况下。

这就是浏览器 mob-proxy 库的用武之地。让我们看看如何将浏览器 mob-proxy 与使用基本身份验证保护的示例网站一起使用。为了解决这个问题,我们可能会缩小两种可能的方法:

  • 向所有请求添加授权请求头,没有条件或例外。
  • 仅向满足特定条件的请求添加请求头。

尽管我们不会解决请求头管理问题,但我们仍将演示如何在浏览器 mob-proxy 授权工具集的帮助下解决授权问题。在 Selenium Java 教程的这一部分中,我们将只展示了第一种方法(即向所有请求添加授权请求头)。

首先我们在pom.xml中添加browsermob-proxy的依赖

    <dependencies>
        <dependency>
            <groupId>net.lightbody.bmp</groupId>
            <artifactId>browsermob-core</artifactId>
            <version>2.1.5</version>
            <scope>test</scope>
        </dependency>
    </dependencies>

然后需要在代码做一些改造:

public class caseFirstTest
{
    WebDriver driver;
    BrowserMobProxy proxy;
 
    @BeforeAll
    public static void globalSetup()
    {
        System.setProperty("webdriver.gecko.driver", "(path of the driver)");
    }
 
    @BeforeEach
    public void setUp()
    {
        setUpProxy();
        FirefoxOptions Options = new FirefoxOptions();
        Options.setProxy(ClientUtil.createSeleniumProxy(proxy));
        driver = new FirefoxDriver(Options);
    }
 
    @Test
    public void testBasicAuth()
    {
        driver.get("https://webelement.click/stand/basic?lang=en");
        Wait<WebDriver> waiter = new FluentWait(driver).withTimeout(Duration.ofSeconds(50)).ignoring(NoSuchElementException.class);
        String greetings = waiter.until(ExpectedConditions.visibilityOfElementLocated(By.xpath("(Mention the xpath)"))).getText();
        Assertions.assertEquals("(message");
    }
 
    @AfterEach
    public void tearDown()
    {
        if(driver != null)
        {
            driver.quit();
        }
        if(proxy != null)
        {
            proxy.stop();
        }
    }
    private void setUpProxy(
    {
    }
}

如果要将此方法传递给所有请求头请求,即特定代理,在这种情况下,应调用 forAllProxy 方法,如下所示:

public void forAllProxy()
{
    proxy = new BrowserMobProxyServer();
    try {
        String authHeader = "Basic " + Base64.getEncoder().encodeToString("webelement:click".getBytes("utf-8"));
        proxy.addHeader("checkauth", authfirstHeader);
    }
    catch (UnsupportedEncodingException e)
    {
        System.err.println("the Authorization can not be passed");
        e.printStackTrace();
    }
    proxy.start(0);
}

在上面的代码中,以 authHeader 开头的行表示我们正在创建请求头,这将被添加到请求中。之后,这些请求会通过我们在 proxy.addHeader(“checkauth”, authfirstHeader) 中创建的代理传递。

try {
        String authHeader = "Basic " + Base64.getEncoder().encodeToString("webelement:click".getBytes("utf-8"));
        proxy.addHeader("checkauth", authfirstHeader);
    }
    catch (UnsupportedEncodingException e)
    {
        ……………………
    }
    proxy.start(0);
}

最后,我们启动代理设置0来标记start参数,代理在端口上启动。

使用 Firefox 扩展

下面分享如何使用适当的 Firefox 浏览器扩展来修改请求头请求。此选项的主要缺点是它仅适用于 Firefox(而不适用于 Chrome、Edge 等其他浏览器),现在很少用Firefox做测试了,简单学习一下。

执行以下步骤以使用 Firefox 扩展修改 HTTP 请求请求头:

  • 下载 Firefox 浏览器扩展
  • 加载扩展。
  • 设置扩展首选项。
  • 设置所需的功能。
  • 准备测试自动化脚本。

让我们一步一步来:

下载火狐浏览器扩展

自行解决。

加载火狐扩展

参考以下代码添加 Firefox 配置文件:

FirefoxProfile profile = new FirefoxProfile();
File modifyHeaders = new File(System.getProperty("user.dir") + "/resources/modify_headers.xpi");
profile.setEnableNativeEvents(false); 
 
try {
    profile.addExtension(modifyHeaders); 
}
catch (IOException e)
{
    e.printStackTrace();
}

设置扩展首选项

一旦我们将 Firefox 扩展加载到项目中,我们设置首选项(即在触发扩展之前需要设置的各种输入)。这是使用 profile.setPreference 方法完成的。

此方法通过键集参数机制设置任何给定配置文件的首选项。这里的第一个参数是设置值的键,第二个参数设置相应的整数值。

这是参考实现:

profile.setPreference("modifyheaders.headers.count", 1);
profile.setPreference("modifyheaders.headers.action0", "Add");
profile.setPreference("modifyheaders.headers.name0", "Value");
profile.setPreference("modifyheaders.headers.value0", "numeric value");
profile.setPreference("modifyheaders.headers.enabled0", true);
profile.setPreference("modifyheaders.config.active", true);
profile.setPreference("modifyheaders.config.alwaysOn", true);

在上面的代码中,我们列出了我们想要设置 header 实例的次数。

profile.setPreference("modifyheaders.headers.count", 1);

接下来,我们指定操作,请求头名称和请求头值包含从 API 调用动态接收的值。

profile.setPreference("modifyheaders.headers.action0", "Add");

对于实现的其余部分,我们启用 all 以便它允许在 WebDriver 实例化 Firefox 浏览器时加载扩展,并使用 HTTP 请求头将扩展设置为活动模式。

设置所需的功能

Selenium 中的 Desired Capabilities 用于设置需要执行自动化测试的浏览器、浏览器版本和平台类型。

在这里,我们如何设置所需的功能:

DesiredCapabilities capabilities = new DesiredCapabilities();
capabilities.setBrowserName("firefox");
capabilities.setPlatform(org.openqa.selenium.Platform.ANY);
capabilities.setCapability(FirefoxDriver.PROFILE, profile);
 
WebDriver driver = new FirefoxDriver(capabilities);
driver.get("url");

完整自动化用例

完成上述所有步骤后,我们将继续设计整个测试自动化脚本:

public void startwebsite()
{
    FirefoxProfile profile = new FirefoxProfile();
    File modifyHeaders = new File(System.getProperty("user.dir") + "/resources/modify_headers.xpi");
    profile.setEnableNativeEvents(false); 
    try
    {
        profile.addExtension(modifyHeaders); 
    }
    catch (IOException e)
    {
        e.printStackTrace(); 
    }
 
    profile.setPreference("modifyheaders.headers.count", 1);
    profile.setPreference("modifyheaders.headers.action0", "Add");
    profile.setPreference("modifyheaders.headers.name0", "Value");
    profile.setPreference("modifyheaders.headers.value0", "Numeric Value");
    profile.setPreference("modifyheaders.headers.enabled0", true);
    profile.setPreference("modifyheaders.config.active", true);
    profile.setPreference("modifyheaders.config.alwaysOn", true);
 
    DesiredCapabilities capabilities = new DesiredCapabilities();
    capabilities.setBrowserName("firefox");
    capabilities.setPlatform(org.openqa.selenium.Platform.ANY);
    capabilities.setCapability(FirefoxDriver.PROFILE, profile);
 
    WebDriver driver = new FirefoxDriver(capabilities);
    driver.get("url");
}

欢迎关注FunTester,Have Fun ~ Tester !