如何使用Jest模拟JavaScript窗口对象？

我需要测试一个在浏览器中打开新标签页的功能

openStatementsReport(contactIds) {
  window.open(`a_url_${contactIds}`);
}

我想模拟窗口的open功能，以便验证传递给该open功能的URL是否正确。

使用Jest，我不知道该如何模拟window。我尝试window.open使用模拟功能进行设置，但是这种方式不起作用。下面是测试用例

it('correct url is called', () => {
  window.open = jest.fn();
  statementService.openStatementsReport(111);
  expect(window.open).toBeCalled();
});

但这给了我错误

expect(jest.fn())[.not].toBeCalled()

jest.fn() value must be a mock function or spy.
    Received:
      function: [Function anonymous]

我应该对测试用例怎么办？任何建议或提示表示赞赏。

代替window使用global

it('correct url is called', () => {
  global.open = jest.fn();
  statementService.openStatementsReport(111);
  expect(global.open).toBeCalled();
});

你也可以尝试

const open = jest.fn()
Object.defineProperty(window, 'open', open);

以下是对我有用的方法。这种做法让我来测试一些代码，应在浏览器和节点都工作，因为它让我设置window到undefined。

这就是Jest 24.8（我相信）：

let windowSpy;

beforeEach(() => {
  windowSpy = jest.spyOn(window, "window", "get");
});

afterEach(() => {
  windowSpy.mockRestore();
});

it('should return https://example.com', () => {
  windowSpy.mockImplementation(() => ({
    location: {
      origin: "https://example.com"
    }
  }));

  expect(window.location.origin).toEqual("https://example.com");
});

it('should be undefined.', () => {
  windowSpy.mockImplementation(() => undefined);

  expect(window).toBeUndefined();
});

我们也可以用它定义global在setupTests

// setupTests.js
global.open = jest.fn()

并global在实际测试中使用它来调用它：

// yourtest.test.js
it('correct url is called', () => {
    statementService.openStatementsReport(111);
    expect(global.open).toBeCalled();
});

有两种方法可以在Jest中模拟全局变量：

1. 使用mockImplementation方法（最像玩笑的方式），但是它仅对那些具有的默认实现的变量有效jsdom，window.open是其中之一：

test('it works', () => {
  // setup
  const mockedOpen = jest.fn();
  // without making a copy you will have a circular dependency problem
  const originalWindow = { ...window };
  const windowSpy = jest.spyOn(global, "window", "get");
  windowSpy.mockImplementation(() => ({
    ...originalWindow, // in case you need other window properties to be in place
    open: mockedOpen
  }));

  // tests
  statementService.openStatementsReport(111)
  expect(mockedOpen).toBeCalled();

  // cleanup
  windowSpy.mockRestore();
});

2. 将值直接分配给全局属性，最直接的方法是，但是可能会触发某些window变量的错误消息，例如window.href。

test('it works', () => {
  // setup
  const mockedOpen = jest.fn();
  const originalOpen = window.open;
  window.open = mockedOpen;

  // tests
  statementService.openStatementsReport(111)
  expect(mockedOpen).toBeCalled();

  // cleanup
  window.open = originalOpen;
});

3. 不要直接使用全局变量（需要一些重构）

与其直接使用全局值，不如从另一个文件中导入它更清洁，因此使用Jest进行模拟将变得微不足道。

./test.js

jest.mock('./fileWithGlobalValueExported.js');
import { windowOpen } from './fileWithGlobalValueExported.js';
import { statementService } from './testedFile.js';

// tests
test('it works', () => {
  statementService.openStatementsReport(111)
  expect(windowOpen).toBeCalled();
});

./fileWithGlobalValueExported.js

export const windowOpen = window.open;

./testedFile.js

import { windowOpen } from './fileWithGlobalValueExported.js';
export const statementService = {
  openStatementsReport(contactIds) {
    windowOpen(`a_url_${contactIds}`);
  }
}

您可以尝试以下方法：

import * as _Window from "jsdom/lib/jsdom/browser/Window";

window.open = jest.fn().mockImplementationOnce(() => {
    return new _Window({ parsingMode: "html" });
});

it("correct url is called", () => {
    statementService.openStatementsReport(111);
    expect(window.open).toHaveBeenCalled();
});

如果类似于https://github.com/facebook/jest/issues/890上的窗口位置问题，则可以尝试[已调整]

delete global.window.open;
global.window = Object.create(window);
global.window.open = jest.fn();

我找到了一种简单的方法：删除并替换

describe('Test case', () => {
  const { open } = window;

  beforeAll(() => {
    // Delete the existing
    delete window.open;
    // Replace with the custom value
    window.open = jest.fn();
    // Works for `location` too, eg:
    // window.location = { origin: 'http://localhost:3100' };
  });

  afterAll(() => {
    // Restore original
    window.open = open;
  });

  it('correct url is called', () => {
    statementService.openStatementsReport(111);
    expect(window.open).toBeCalled(); // Happy happy, joy joy
  });
});

在我的组件中，我需要访问window.location.search，这是我在玩笑测试中所做的：

Object.defineProperty(global, "window", {
  value: {
    location: {
      search: "test"
    }
  }
});

如果在不同的测试中窗口属性必须不同，我们可以将窗口模拟放入函数中，并使其可写，以覆盖不同的测试：

function mockWindow(search, pathname) {
  Object.defineProperty(global, "window", {
    value: {
      location: {
        search,
        pathname
      }
    },
    writable: true
  });
}

并在每次测试后重置

afterEach(() => {
  delete global.window.location;
});

我直接分配jest.fn()给window.open。

window.open = jest.fn()
// ...code
expect(window.open).toHaveBeenCalledTimes(1)
expect(window.open).toHaveBeenCalledWith('/new-tab','__blank')

在您的jest配置中，添加setupFilesAfterEnv：[“ ./setupTests.js”]，创建该文件，并在测试之前添加要运行的代码

//setupTests.js
window.crypto = {
   .....
};

参考：https : //jestjs.io/docs/en/configuration#setupfilesafterenv-array