是否可以为Node.js fs.readFile()编写Jest单元测试?

我是Jest单元测试的新手,我想知道Jest是否可以用于测试Node.js文件系统模块。

我目前有一个包含一首短诗的文本文件,并且viewText功能控制台将这首诗记录在我的终端上。

使用Jest,我的目标是编写一个测试来检查viewText函数是否确实有效。

const viewText = () => {
  fs.readFile('poem.txt','utf8',(err,data) => {
    if (err) throw err;
    console.log(data);
  });
};

我开玩笑说:

jest.spyOn(global.console,'log');

const mockPoem = 'Some say the world will end in fire,Some say in ice. From what I’ve tasted of desire I hold with those who favor fire ... And would suffice.';

describe('viewText',() => {
  const mockReadFile = jest.fn();
  mockReadFile.mockReturnValue(mockPoem);

  it('prints poem to console',() => {
    viewText();
    expect(global.console.log).toHaveBeenCalledWith(mockPoem);
  });
});

有了测试,我要做的就是检查我的viewText函数是否通过了测试-能够查看mockPoem。我对于如何使用文件系统模块为功能编写单元测试感到非常困惑。

heyongkun 回答:是否可以为Node.js fs.readFile()编写Jest单元测试?

这是UT解决方案:

index.ts

import fs from 'fs';

export const viewText = () => {
  fs.readFile('poem.txt','utf8',(err,data) => {
    if (err) throw err;
    console.log(data);
  });
};

index.spec.ts

import { viewText } from './';
import fs from 'fs';

const mockPoem =
  'Some say the world will end in fire,Some say in ice. From what I’ve tasted of desire I hold with those who favor fire ... And would suffice.';

describe('viewText',() => {
  afterEach(() => {
    jest.restoreAllMocks();
  });
  test('prints poem to console',done => {
    const logSpy = jest.spyOn(console,'log');
    let readFileCallback;
    // @ts-ignore
    jest.spyOn(fs,'readFile').mockImplementation((path,options,callback) => {
      readFileCallback = callback;
    });

    viewText();
    readFileCallback(null,mockPoem);
    expect(logSpy).toBeCalledWith(mockPoem);
    expect(fs.readFile).toBeCalledWith('poem.txt',readFileCallback);
    done();
  });

  test('should throw error when read file failed',done => {
    let readFileCallback;
    // @ts-ignore
    jest.spyOn(fs,callback) => {
      readFileCallback = callback;
    });

    viewText();
    const mError = new Error('read file failed');
    expect(() => readFileCallback(mError,null)).toThrowError(mError);
    expect(fs.readFile).toBeCalledWith('poem.txt',readFileCallback);
    done();
  });
});

覆盖率100%的单元测试结果:

 PASS  src/stackoverflow/58810079/index.spec.ts (11.118s)
  viewText
    ✓ prints poem to console (23ms)
    ✓ should throw error when read file failed (3ms)

  console.log node_modules/jest-mock/build/index.js:860
    Some say the world will end in fire,Some say in ice. From what I’ve tasted of desire I hold with those who favor fire ... And would suffice.

----------|----------|----------|----------|----------|-------------------|
File      |  % Stmts | % Branch |  % Funcs |  % Lines | Uncovered Line #s |
----------|----------|----------|----------|----------|-------------------|
All files |      100 |      100 |      100 |      100 |                   |
 index.ts |      100 |      100 |      100 |      100 |                   |
----------|----------|----------|----------|----------|-------------------|
Test Suites: 1 passed,1 total
Tests:       2 passed,2 total
Snapshots:   0 total
Time:        13.129s

源代码:https://github.com/mrdulin/jest-codelab/tree/master/src/stackoverflow/58810079

本文链接:https://www.f2er.com/3120750.html

大家都在问