Node.js Express：单元测试中Mock请求对象验证查询参数检查方法

首先提个小细节：你写的checkMandatoryQueryParams方法返回类型标注为void，但最后却返回了result，这会触发TypeScript编译错误，建议把返回类型改成boolean，我顺便用更简洁的逻辑帮你优化一下：

checkMandatoryQueryParams(mandatoryQueryParams: string[], req: Request): boolean { 
  // 用every方法替代forEach，更简洁且能提前终止检查
  return mandatoryQueryParams.every(param => req.query.hasOwnProperty(param));
}

接下来回到你的核心问题：Mock Request对象完成单元测试。其实在单元测试中，我们不需要完整的Request实例，只需要模拟它的query属性即可，下面给你几种实用的Mock方式：

方法一：手动Mock（最简单直接） #

这种方式适配大多数简单场景，直接创建一个包含query属性的普通对象，用TypeScript的类型断言告诉编译器这是一个Request实例：

import { describe, it, expect } from '@jest/globals';
import { Request } from 'express'; // 假设你用的是Express的Request类型

describe('Utils', () => { 
  it('returns false when a mandatory query parameter is missing', () => { 
    // 手动构造Mock请求，只保留我们需要的query属性
    const mockReq = {
      query: {
        foo: 'bar'
      }
    } as Request;

    const result = checkMandatoryQueryParams(['foo', 'baz'], mockReq);
    expect(result).toBe(false);
  });

  it('returns true when all mandatory query parameters exist', () => { 
    const mockReq = {
      query: {
        foo: 'bar',
        baz: 'qux'
      }
    } as Request;

    const result = checkMandatoryQueryParams(['foo', 'baz'], mockReq);
    expect(result).toBe(true);
  });
});

方法二：用Jest Mock整个Request类（适合复杂场景） #

如果你需要模拟Request的其他方法或属性，可以用Jest来Mock整个Request类，这样能更灵活地控制Mock行为：

import { describe, it, expect, jest } from '@jest/globals';
import { Request } from 'express';

// 先Mock Express的Request类
jest.mock('express', () => ({
  Request: jest.fn().mockImplementation(() => ({
    query: {} // 预设默认的空query
  }))
}));

describe('Utils', () => { 
  it('handles missing mandatory parameters correctly', () => { 
    const mockReq = new Request();
    // 动态设置query属性
    mockReq.query = { foo: 'bar' };

    expect(checkMandatoryQueryParams(['foo', 'baz'], mockReq)).toBe(false);
  });
});

方法三：用Partial避免类型断言（更严谨的TS写法） #

如果你不想用类型断言，可以用TypeScript的Partial类型创建一个部分符合Request结构的对象，再转换为Request类型传入：

it('validates all required parameters are present', () => { 
  // Partial<Request>表示这是一个Request的部分实现
  const mockReq: Partial<Request> = {
    query: {
      userId: '123',
      token: 'abc123'
    }
  };

  // 转换为Request类型传入方法
  const result = checkMandatoryQueryParams(['userId', 'token'], mockReq as Request);
  expect(result).toBe(true);
});

这些方法都能很好地帮你完成单元测试，根据你的测试场景选择最适合的方式就行~

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