Новичок в модульном тестировании - как бы вы протестировали этот код с помощью Jest Testing?

Question

Я новичок в модульном тестировании. Я хочу научиться правильно тестировать, используя Jest, и после статей, демонстраций и курса по Udemy я все еще в замешательстве (особенно при использовании Jest mocking). Я должен отметить, что весь наш код реагирует извне, поэтому он, кажется, смущает меня еще больше.

Я написал тест AB для своей компании и уже понял, что его должно быть легко проверить, но я не думаю, чтоЯ делаю это правильно. Кажется, что я просто копирую свой исходный код для тестирования, и хотя я чувствую, что функция проверена, мне кажется, что это неправильно.

Вот мой рассматриваемый код и тест. Как бы вы, ребята, у которых больше опыта, сделали это "правильно"?

Спасибо!

JS:

let ABTestValue = 30;
ABTest();

export function ABTest() {
  const roll = Math.floor(Math.random() * 100);

  if (debugMode) {
    console.log('TimedRefresh - AB Test Issue-831 (90 and above get their refresh time changed) randomized value = ', roll);
  }

  const ABTestMappings = [
    {
      roll: 90,
      ABTestValue: 40
    },
    {
      roll: 91,
      ABTestValue: 40
    },
    {
      roll: 92,
      ABTestValue: 50
    },
    {
      roll: 93,
      ABTestValue: 50
    },
    {
      roll: 94,
      ABTestValue: 60
    },
    {
      roll: 95,
      ABTestValue: 60
    },
    {
      roll: 96,
      ABTestValue: 70
    },
    {
      roll: 97,
      ABTestValue: 70
    },
    {
      roll: 98,
      ABTestValue: 80
    },
    {
      roll: 99,
      ABTestValue: 80
    }
  ];

  if (roll > 89 && roll < 100) {
    ABTestValue = ABTestMappings.filter((a) => a.roll === roll)[0].ABTestValue;
  }

  window.rg_version = `time${ABTestValue}`;

  if (debugMode) {
    console.log('TimedRefresh - ABTestValue - change in refresh time in seconds (30 is default) - ', ABTestValue);
  }
}

test.js:

import { ABTest } from './index';

describe('ABTEST test', () => {
  it('ABTest function', () => {
    expect(ABTest).toBeDefined();
  })

  describe('test different rolls', () => {
    const ABTestMappings = [
      {
        roll: 90,
        ABTestValue: 40
      },
      {
        roll: 91,
        ABTestValue: 40
      },
      {
        roll: 92,
        ABTestValue: 50
      },
      {
        roll: 93,
        ABTestValue: 50
      },
      {
        roll: 94,
        ABTestValue: 60
      },
      {
        roll: 95,
        ABTestValue: 60
      },
      {
        roll: 96,
        ABTestValue: 70
      },
      {
        roll: 97,
        ABTestValue: 70
      },
      {
        roll: 98,
        ABTestValue: 80
      },
      {
        roll: 99,
        ABTestValue: 80
      }
    ];

    const roll = 92;
    const roll2 = 95;
    const roll3 = 99;
    const roll4 = 80;
    let ABTestValue = 30;
    let ABTestValue2 = 30;
    let ABTestValue3 = 30;
    let ABTestValue4 = 30;

    if (roll > 89 && roll < 100) {
      ABTestValue = ABTestMappings.filter((a) => a.roll === roll)[0].ABTestValue;
    }

    if (roll2 > 89 && roll2 < 100) {
      ABTestValue2 = ABTestMappings.filter((a) => a.roll === roll2)[0].ABTestValue;
    }

    if (roll3 > 89 && roll3 < 100) {
      ABTestValue3 = ABTestMappings.filter((a) => a.roll === roll3)[0].ABTestValue;
    }

    if (roll4 > 89 && roll4 < 100) {
      ABTestValue4 = ABTestMappings.filter((a) => a.roll === roll4)[0].ABTestValue;
    }

    it('if roll is 92', () => {
      if (roll) {
        expect(ABTestValue).toEqual(50);
      }
    })

    it('if roll is 95', () => {
      if (roll2) {
        expect(ABTestValue2).toEqual(60);
      }
    })

    it('if roll is 99', () => {
      if (roll3) {
        expect(ABTestValue3).toEqual(80);
      }
    })

    it('if roll is less than 90', () => {
      if (roll4) {
        expect(ABTestValue4).toEqual(30);
      }
    })
  })
})

Answer 1

Рабочий процесс модульного тестирования очень прост.

1. Смоделируйте зависимости и их возвращаемое значение для метода / функции, которую вы хотите проверить. Создайте для этого изолированную среду. Принцип заключается в том, что модульные тесты не должны зависеть от какой-либо внешней службы, например, отправлять реальный HTTP-запрос, запрашивать реальную базу данных, обращаться к реальной файловой системе.

2. Выполнить метод / функциюВы хотите проверить, протестировать каждую ветвь (if...else, switch...case), операторы, функции и строки. Они представляют собой сводку отчета о покрытии.

3. Утвердите (expect) результат и укажите, должны ли вызываться методы / функции, от которых зависит проверяемый метод / функция. Почему? Потому что мы должны убедиться, что код выполняется так, как мы ожидаем

Протестируйте каждый метод / функцию как описанный выше рабочий процесс на каждом слое программной арки.

Уровень программной арки означает, например, уровень доступа к данным, уровень модели, уровень обслуживания, уровень контроллера / маршрутизатора

Вот правильный модульный тест:

index.ts:

(window as any).rg_version = '';

export function ABTest(debugMode = false) {
  const roll = Math.floor(Math.random() * 100);
  let ABTestValue = 30;

  if (debugMode) {
    console.log(
      'TimedRefresh - AB Test Issue-831 (90 and above get their refresh time changed) randomized value = ',
      roll
    );
  }

  const ABTestMappings = [
    {
      roll: 90,
      ABTestValue: 40
    },
    {
      roll: 91,
      ABTestValue: 40
    },
    {
      roll: 92,
      ABTestValue: 50
    },
    {
      roll: 93,
      ABTestValue: 50
    },
    {
      roll: 94,
      ABTestValue: 60
    },
    {
      roll: 95,
      ABTestValue: 60
    },
    {
      roll: 96,
      ABTestValue: 70
    },
    {
      roll: 97,
      ABTestValue: 70
    },
    {
      roll: 98,
      ABTestValue: 80
    },
    {
      roll: 99,
      ABTestValue: 80
    }
  ];

  if (roll > 89 && roll < 100) {
    ABTestValue = ABTestMappings.filter(a => a.roll === roll)[0].ABTestValue;
  }

  (window as any).rg_version = `time${ABTestValue}`;

  if (debugMode) {
    console.log('TimedRefresh - ABTestValue - change in refresh time in seconds (30 is default) - ', ABTestValue);
  }
}

index.spec.ts:

import { ABTest } from './';

describe('ABTest', () => {
  afterEach(() => {
    jest.restoreAllMocks();
    (window as any).rg_version = '';
  });
  it('should filter and get the correct value', () => {
    const floorSpy = jest.spyOn(Math, 'floor').mockReturnValueOnce(90);
    const logSpy = jest.spyOn(console, 'log');
    ABTest();
    expect((window as any).rg_version).toBe('time40');
    expect(floorSpy).toBeCalledTimes(1);
    expect(logSpy).toBeCalledTimes(0);
  });

  it('should get default value', () => {
    const floorSpy = jest.spyOn(Math, 'floor').mockReturnValueOnce(80);
    const logSpy = jest.spyOn(console, 'log');
    ABTest(true);
    expect((window as any).rg_version).toBe('time30');
    expect(floorSpy).toBeCalledTimes(1);
    expect(logSpy.mock.calls[0]).toEqual([
      'TimedRefresh - AB Test Issue-831 (90 and above get their refresh time changed) randomized value = ',
      80
    ]);
    expect(logSpy.mock.calls[1]).toEqual([
      'TimedRefresh - ABTestValue - change in refresh time in seconds (30 is default) - ',
      30
    ]);
  });
});

Результат модульного теста со 100% покрытием:

 PASS  src/stackoverflow/58258206/index.spec.ts
  ABTest
    ✓ should filter and get the correct value (8ms)
    ✓ should get default value (6ms)

  console.log node_modules/jest-mock/build/index.js:860
    TimedRefresh - AB Test Issue-831 (90 and above get their refresh time changed) randomized value =  80

  console.log node_modules/jest-mock/build/index.js:860
    TimedRefresh - ABTestValue - change in refresh time in seconds (30 is default) -  30

----------|----------|----------|----------|----------|-------------------|
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:        2.814s, estimated 6s

Исходный код: https://github.com/mrdulin/jest-codelab/tree/master/src/stackoverflow/58258206