如何测试Angular模块中导出的拦截器Provider配置

待验证目标代码 #

需要验证API_INTERCEPTOR_PROVIDER中useExisting指向ApiInterceptor的配置逻辑，对应代码如下：

export const API_INTERCEPTOR_PROVIDER: Provider = {
  provide: HTTP_INTERCEPTORS,
  useExisting: forwardRef(() => ApiInterceptor), // 待覆盖测试的核心行
  multi: true
};

@NgModule({
  // ...其他配置
  providers: [
    API_INTERCEPTOR_PROVIDER,
    // ...其他提供者
  ]
})

现有测试代码 #

当前已有的测试仅覆盖了模块创建逻辑：

// 相关导入...

describe('AppModule', () => {
  beforeEach(async () => {
    TestBed.configureTestingModule({
      imports: [AppModule],
      providers: [{ provide: LOCALE_ID, useValue: 'it-IT' }]
    });
  });

  it('should create', () => {
    const module = TestBed.inject(AppModule);
    expect(module).toBeTruthy();
  });
})

补充测试用例 #

首先补全需要的导入：

import { HTTP_INTERCEPTORS } from '@angular/common/http';
// 替换成你项目中ApiInterceptor的实际路径
import { ApiInterceptor } from './interceptors/api.interceptor';

在describe块中新增如下测试用例即可：

it('should register ApiInterceptor as multi HTTP interceptor via useExisting', () => {
  // 静态校验provider配置本身，直接覆盖目标代码行
  expect(API_INTERCEPTOR_PROVIDER.provide).toBe(HTTP_INTERCEPTORS);
  expect(API_INTERCEPTOR_PROVIDER.multi).toBe(true);
  // 取出forwardRef函数执行，校验返回的类就是ApiInterceptor
  const forwardRefFn = (API_INTERCEPTOR_PROVIDER as any).useExisting;
  expect(forwardRefFn()).toBe(ApiInterceptor);

  // 校验DI容器实际运行结果，确认配置生效
  // 拿到所有注册到HTTP_INTERCEPTORS token的实例数组
  const allInterceptors = TestBed.inject(HTTP_INTERCEPTORS);
  // 单独注入ApiInterceptor实例
  const apiInterceptorInstance = TestBed.inject(ApiInterceptor);
  // 校验拦截器数组中存在同一个ApiInterceptor实例（useExisting不会创建新实例，直接引用已有实例）
  const isInterceptorRegistered = allInterceptors.some(
    interceptor => interceptor === apiInterceptorInstance
  );
  expect(isInterceptorRegistered).toBeTrue();
});

注意点 #

• 不需要构造真实HTTP请求触发拦截器，拦截器本身的业务逻辑单独在拦截器的测试文件中验证即可，这里只需要验证模块的提供者配置正确
• 两层校验既可以精准覆盖到useExisting: forwardRef(() => ApiInterceptor)这行代码，满足覆盖率要求，也能避免静态配置写对了但模块没正确加载provider的问题
• 如果ApiInterceptor本身依赖较重，可以在TestBed的providers中添加对应的mock依赖，不影响配置逻辑的验证

内容的提问来源于stack exchange，提问作者jackmounts