Mengejek dengan Jest dan skrip taip - helaian curang

Jess hebat dalam mengejek import dalam javascript/typescript, tetapi saya sangat sukar untuk mengingati spesifik pelaksanaan.

Fungsi dan objek perlu diejek dengan cara yang berbeza, eksport lalai diejek secara halus berbeza dengan eksport bernama dan Jest tidak berfungsi dengan baik dengan skrip taip. Gabungkan semua perkara ini dan mungkin sukar untuk bersenam, atau mencari, pendekatan yang betul untuk senario mengejek anda.

Saya telah mencipta panduan ini untuk menjawab soalan "Bagaimanakah saya boleh mengejek import saya?" tidak kira apa pun import itu. Lalai atau dinamakan, fungsi atau objek.

Persekitaran Saya

Saya telah menguji semua pendekatan ini menggunakan versi perisian berikut:

• nod v22.11.0
• lawak v29.7.0
• ts-jest v29.2.5
• @types/jest v29.5.14

Dan dengan fail lalai, jest.config.js minimum:

export default {
  testEnvironment: 'node',
  transform: {
    '^.+.tsx?$': ['ts-jest', {}],
  },
  testMatch: ['**/*.test.ts'],
};

Mengejek Import

Import lazim secara amnya terbahagi kepada dua kategori yang mungkin kita ingin permainkan:

• fungsi
• objek

Kami akan menangani kedua-duanya secara bergilir-gilir, bermula dengan fungsi.

Mengimport fungsi

Fungsi yang dieksport daripada modul boleh dinamakan atau lalai. Kami akan melihat kedua-duanya. Pertama:

Mengejek fungsi yang dieksport bernama daripada modul

Ini harus digunakan untuk mengejek fungsi yang dieksport bernama daripada modul, seperti ini:

// ./path/to/module.ts

export function doSomething(...) {
  ...
}

Ia boleh diejek seperti itu:

import { doSomething } from './path/to/module';

// note: This should be the path to the module from the test file,
// NOT from the module that contains the doSomething function itself.
jest.mock('./path/to/module', () => ({
  doSomething: jest.fn(),
}));

...

it('should do something', () => {
  // We need to assert that the function is a jest.Mock
  // so that typescript will allow us to call mock methods.
  (doSomething as jest.Mock).mockReturnValue(mockValue);

  // run your test here

  expect(doSomething).toHaveBeenCalledTimes(1); // etc.
});

Mengejek fungsi lalai yang dikembalikan daripada modul

Ini harus digunakan untuk mengejek fungsi yang merupakan eksport lalai daripada modul, seperti ini:

// ./path/to/module.ts

export default function doSomething(...) {
  ...
}

Ia diejek sama seperti eksport bernama:

import doSomething from './path/to/module'

jest.mock('./path/to/module', () => ({
  __esModule: true,
  default: jest.fn()
}))

...

it('should do something', () => {
  (doSomething as jest.Mock).mockResolvedValue(mockData);

  // Run your test here

  expect(doSomething).toHaveBeenCalledTimes(5);
});

Mengimport objek

Terdapat beberapa variasi untuk dipertimbangkan apabila mengejek objek yang dieksport (sama ada kelas, objek json atau sebaliknya).

• Adakah ia eksport bernama atau lalai?
• Adakah ia mempunyai kaedah yang kami juga ingin mempermainkan, atau hanya sifat?

Mengejek objek lalai tanpa kaedah

Jika anda hanya perlu mengejek sifat (contoh fail konfigurasi), bukan kaedah, maka beginilah cara melakukannya:

import config from '../config';

jest.mock('../config', () => ({
  __esModule: true,
  default: {
    apiKey: '123MockKey',
    ...
  },
}));

...

it('Should do something', () => {
  ...
});

Dan jika sifat yang dipermainkan perlu berbeza-beza setiap ujian:

import config from '../config';

const mockConfig = {
  apiKey: '123MockKey',
  ...
};

jest.mock('../config', () => ({
  __esModule: true,
  default: mockConfig,
}));

...

beforeEach(() => {
  // restore defaults before each test
  mockConfig.apiKey = '123MockKey';
  ...
});

it('Should do something', () => {
  mockConfig.apiKey = 'new value';

  // rest of the test
});

// more tests

Mengejek objek eksport bernama tanpa kaedah

Sangat serupa dengan mengejek objek eksport lalai:

import { config } from '../config';

const mockConfig = {
  apiKey: '123MockKey',
  ...
};

jest.mock('../config', () => ({
  config: mockConfig,
}));

// the rest is exactly the same as when mocking a default export object.

Mengejek objek dengan kaedah

Apabila objek dengan kaedah dieksport (dinamakan atau lalai) daripada modul dan kita perlu mengejek output kaedah tersebut, pendekatannya berbeza sedikit.

Diberikan kelas:

// ./path/to/module.ts

class ComplicatedThing {
  // properties, fields, constructor etc. go here

  getData() {
    ...
  }

  ...
}

// note: I don't necessarily recommend exporting an instance
// of a class like this - purely illustrative for testing purposes.
// https://medium.com/@lazlojuly/are-node-js-modules-singletons-764ae97519af
export const complicatedThing = new ComplicatedThing(...);

Dan untuk mengejek objek eksport kami:

export default {
  testEnvironment: 'node',
  transform: {
    '^.+.tsx?$': ['ts-jest', {}],
  },
  testMatch: ['**/*.test.ts'],
};

Mengejek objek eksport lalai adalah sama kecuali apabila kita mentakrifkan olok-olok:

// ./path/to/module.ts

export function doSomething(...) {
  ...
}

Bonus: Kaedah mengejek pada objek yang dihantar terus ke fungsi/kelas ujian sebagai parameter

Ini adalah untuk mengejek objek yang tidak diimport terus ke dalam modul yang anda uji, tetapi sebaliknya dihantar sebagai parameter kepada kelas/fungsi.

Nota: Jika anda mengejek kelas, sebaliknya anda mungkin ingin mencipta antara muka dan mencipta pelaksanaan olok-olok itu untuk dimasukkan ke dalam fungsi/kelas anda. Ini akan menjimatkan anda daripada melakukan penipuan penegasan jenis tidak elegan seperti di bawah.

import { doSomething } from './path/to/module';

// note: This should be the path to the module from the test file,
// NOT from the module that contains the doSomething function itself.
jest.mock('./path/to/module', () => ({
  doSomething: jest.fn(),
}));

...

it('should do something', () => {
  // We need to assert that the function is a jest.Mock
  // so that typescript will allow us to call mock methods.
  (doSomething as jest.Mock).mockReturnValue(mockValue);

  // run your test here

  expect(doSomething).toHaveBeenCalledTimes(1); // etc.
});

// ./path/to/module.ts

export default function doSomething(...) {
  ...
}

import doSomething from './path/to/module'

jest.mock('./path/to/module', () => ({
  __esModule: true,
  default: jest.fn()
}))

...

it('should do something', () => {
  (doSomething as jest.Mock).mockResolvedValue(mockData);

  // Run your test here

  expect(doSomething).toHaveBeenCalledTimes(5);
});

Kesimpulan

Saya harap ini berguna kepada anda dan diri saya pada masa hadapan apabila saya bergelut untuk mengingati butiran tentang cara mengejek import dalam skrip taip.

Saya berharap ia dapat menampung semua keperluan mengejek anda yang mudah dan memberi anda tempat untuk bermula apabila mengejek import yang lebih kompleks.

Terima kasih kerana membaca.

Atas ialah kandungan terperinci Mengejek dengan Jest dan skrip taip - helaian curang. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!