Pact测试Token过期？Java动态生成Token帮你解决！

2024-07-10 23:45:05

解决Pact测试中Token过期问题的Java利器：POM.xml 动态导入

在契约测试领域，Pact 凭借其强大的功能和易用性赢得了广泛认可。然而，在处理需要认证的接口时，我们经常会遇到Token过期的问题。虽然Pact提供了requestFilter机制来添加认证信息，但对于需要频繁更新的Token来说，手动修改pom.xml文件显得繁琐且低效。本文将介绍一种更优雅的解决方案：通过在pom.xml中动态导入Java包，实现Token的自动生成和添加，从而彻底告别手动更新的烦恼。

Token过期：Pact测试的拦路虎

试想一下，我们正在使用Pact对一个需要OAuth2认证的API进行测试。为了让测试顺利进行，我们需要在每个请求中添加有效的Bearer Token。Pact允许我们通过requestFilter在发送请求前修改请求内容，例如添加Authorization Header。

<requestFilter>
    // This is a Groovy script that adds an Authorization header to each request
    String authHeader = "Bearer " + "your_token_here"
    request.addHeader('Authorization', authHeader)
</requestFilter>

上面的代码片段展示了如何在pom.xml中配置requestFilter，将固定的Token添加到每个请求头中。然而，现实往往更加骨感。Token通常具有过期时间，一旦过期，测试就会失败。为了保证测试的顺利进行，我们不得不每次都在Token过期前手动生成新的Token，并替换pom.xml文件中的旧Token。

动态生成Token：告别手动更新

为了解决Token过期带来的困扰，我们可以利用Java的强大功能，将Token生成的逻辑封装到一个独立的类中，并在pom.xml中动态导入这个类。

假设我们创建了一个名为OAuthTokenGenerator的Java类，其中包含一个generateToken()方法，用于生成新的Token。

public class OAuthTokenGenerator {

    public String generateToken() {
        // Your logic to generate a new OAuth2 token
        return "new_generated_token"; 
    }
}

接下来，我们需要在pom.xml文件中进行如下配置：

确保Java类位于测试类的classpath下 : OAuthTokenGenerator类需要在运行测试时被加载到classpath中。通常情况下，我们将测试相关的类放置在src/test/java目录下，编译后的class文件会自动添加到测试类的classpath中。
在<requestFilter>中导入Java类 : 使用Groovy的import语句导入OAuthTokenGenerator类。
调用generateToken()方法生成Token : 创建OAuthTokenGenerator类的实例，并调用generateToken()方法获取新的Token。

<requestFilter>
    // 导入Java类
    import com.example.OAuthTokenGenerator
    // 创建实例并调用方法获取Token
    String authHeader = "Bearer " + new OAuthTokenGenerator().generateToken()
    // 添加Authorization Header
    request.addHeader('Authorization', authHeader)
</requestFilter>

通过以上配置，每次运行测试时，requestFilter都会调用OAuthTokenGenerator类的generateToken()方法生成新的Token，并添加到Authorization Header中。

案例分析：让代码说话

为了更直观地展现动态生成Token的过程，我们以一个具体的案例为例。假设我们正在测试一个名为"User Service"的服务，该服务提供了一个获取用户信息的API /users/{userId}。

1. 创建OAuthTokenGenerator类

import io.jsonwebtoken.Jwts;
import io.jsonwebtoken.SignatureAlgorithm;

import java.util.Date;

public class OAuthTokenGenerator {

    public String generateToken() {
        // Token过期时间设置为1小时后
        Date expirationDate = new Date(System.currentTimeMillis() + 3600000); 

        return Jwts.builder()
                .setSubject("test-user") // 设置Token主题
                .setExpiration(expirationDate) // 设置Token过期时间
                .signWith(SignatureAlgorithm.HS512, "your-secret-key") // 使用密钥对Token进行签名
                .compact();
    }
}

代码解读:

我们使用 io.jsonwebtoken 库生成JWT Token。
generateToken() 方法生成一个新的JWT Token，设置过期时间为1小时后，并使用预定义的密钥进行签名。

2. 配置POM.xml

在pom.xml文件中，找到pact-provider-maven插件的配置部分，添加requestFilter：

<plugin>
    <groupId>au.com.dius.pact.provider</groupId>
    <artifactId>maven</artifactId>
    <version>4.6.7</version>
    <configuration>
        <serviceProviders>
            <serviceProvider>
                <name>UserService</name>
                <requestFilter>
                    import com.example.OAuthTokenGenerator
                    String authHeader = "Bearer " + new OAuthTokenGenerator().generateToken()
                    request.addHeader('Authorization', authHeader)
                </requestFilter>
                <protocol>https</protocol>
                <host>localhost</host>
                <port>8080</port>
            </serviceProvider>
        </serviceProviders>
        <pactDirectory>target/pacts</pactDirectory>
    </configuration>
</plugin>

代码解读:

我们在requestFilter中导入了OAuthTokenGenerator类。
每次运行测试时，requestFilter都会调用OAuthTokenGenerator类的generateToken()方法生成新的Token，并将"Bearer " + Token添加到Authorization Header中。