OkHttp Interceptor 请求头修改的单元测试指南

package de.scrum_master.stackoverflow.q74575745;

import okhttp3.Interceptor;
import okhttp3.Request;
import okhttp3.Response;

import java.io.IOException;

/**
 * 一个简单的 OkHttp 拦截器，用于向请求中添加 Authorization 头。
 */
class AuthRequestInterceptor implements Interceptor {
  @Override
  public Response intercept(Interceptor.Chain chain) throws IOException {
    Request original = chain.request();

    // 构建一个新的请求，添加 Authorization 头
    Request.Builder requestBuilder = original.newBuilder()
      .header("Authorization", "auth-value");

    Request request = requestBuilder.build();
    // 继续处理请求链
    return chain.proceed(request);
  }
}

// 初始的（不推荐的）测试尝试
class AuthRequestInterceptorTest extends Specification {
    AuthRequestInterceptor authRequestInterceptor = new AuthRequestInterceptor();
    OkHttpClient okHttpClient;

    void setup() {
        // 初始化 OkHttpClient 并添加拦截器
        okHttpClient = new OkHttpClient().newBuilder()
            .addInterceptor(authRequestInterceptor)
            .build();
    }

    def "Get Authorization in to header"() {
        given: "一个空的请求头"
        HashMap<String, String> headers = new HashMap<>()

        when: "执行一个模拟请求"
        Request mockRequest = new Request.Builder()
            .url("http://1.1.1.1/heath-check") // 注意：这是一个模拟URL，实际不会发送请求
            .headers(Headers.of(headers))
            .build()

        Response res = okHttpClient.newCall(mockRequest).execute()

        then: "尝试从响应中获取 Authorization 头"
        // 这里的断言会失败，因为我们无法从 Response 中直接获取到 Request 的头
        res.headers("Authorization")
    }
}

package de.scrum_master.stackoverflow.q74575745

import okhttp3.Interceptor
import okhttp3.Request
import spock.lang.Specification

/**
 * AuthRequestInterceptor 的单元测试。
 * 核心思想是模拟 Interceptor.Chain，并验证 proceed 方法被调用时传入的 Request 参数。
 */
class AuthRequestInterceptorTest extends Specification {

  def "request contains authorization header"() {
    given: "一个模拟的拦截器链，它返回一个不带任何头的原始请求"
    // Mock Interceptor.Chain 接口
    def chain = Mock(Interceptor.Chain) {
      // 当 chain.request() 被调用时，返回一个预设的原始请求
      request() >> new Request.Builder()
        .url("http://1.1.1.1/heath-check")
        .build()
    }

    when: "运行待测试的拦截器"
    // 创建 AuthRequestInterceptor 实例并调用其 intercept 方法
    new AuthRequestInterceptor().intercept(chain)

    then: "验证预期的 Authorization 头已被添加到请求中，并传递给 chain.proceed()"
    // 使用 Spock 的参数约束来验证 chain.proceed() 被调用了一次，
    // 并且传入的 Request 对象的 Authorization 头包含期望的值。
    1 * chain.proceed({ Request request ->
      // 这里的闭包会接收到传递给 chain.proceed 的 Request 对象
      // 我们可以对这个 Request 对象进行断言
      request.headers("Authorization") == ["auth-value"]
    })
  }
}

// Helper class (如果需要，可包含在项目中)
package de.scrum_master.stackoverflow.q74575745;

class WebClientException extends RuntimeException {
  public WebClientException(Throwable cause) {
    super(cause);
  }
}