【テストダブル】スタブ・スパイ・モック・フェイク・ダミーの特徴と違い

// テスト対象の関数
// テスト対象は外部メソッド()に依存している
function テスト対象() {
    ...
    外部メソッド();
    ...
    return hoge;
}

// テストコード
it('テスト対象()の戻り値が規定値であることを確認する', function () {
    assert.strictEqual(テスト対象(), 期待値);
});

// テスト対象の関数
// テスト対象は外部メソッド()に依存している
function テスト対象() {
    ...
    indirectInput = 外部メソッド();
    ...
    return hoge;
}

// テストコード
it('テスト対象()の戻り値が規定値であることを確認する', function () {
    assert.strictEqual(テスト対象(), 期待値);
});

// テスト対象の関数
// テスト対象は外部メソッド()に依存している
function テスト対象() {
    ...
    外部メソッド(indirectOutput);
    ...
    return hoge;
}

// テストコード
it('テスト対象()の戻り値が規定値であることを確認する', function () {
    assert.strictEqual(テスト対象(), 期待値);
});

// ★テスト対象が依存しているgetCurrentHour関数
// getCurrentHour関数では現在の時刻を取得している。
function getCurrentHour() {
    return new Date().getHours();
}

// ★テスト対象のgreet関数
// 現在の時刻に応じて異なる挨拶を返している
function greet() {
    const currentHour = getCurrentHour();
    if (currentHour < 12) {
        return 'おはよう';
    }
    else if (currentHour < 18) {
        return 'こんにちは';
    }
    else {
        return 'こんばんは';
    }
}

// ★テストコード
const sinon = require('sinon');
const assert = require('assert');

describe('Stubのテスト', function () {
    it('時刻によって挨拶が変わることを確認する', function () {
        // greet関数が依存しているgetCurrentHour関数をスタブ化
        // 間接入力(テスト対象への入力)をテストコード上で事前設定(常に10を返す)
        getCurrentHour = sinon.stub().returns(10);
        // greetが「おはよう」を返すことを検証
        assert.strictEqual(greet(), 'おはよう');

        // greet関数が依存しているgetCurrentHour関数をスタブ化
        // 間接入力(テスト対象への入力)をテストコード上で事前設定(常に15を返す)
        getCurrentHour = sinon.stub().returns(15);
        // greetが「こんにちは」を返すことを検証
        assert.strictEqual(greet(), 'こんにちは');

        // greet関数が依存しているgetCurrentHour関数をスタブ化
        // 間接入力(テスト対象への入力)をテストコード上で事前設定(常に20を返す)
        getCurrentHour = sinon.stub().returns(20);
        // greetが「こんばんは」を返すことを検証
        assert.strictEqual(greet(), 'こんばんは');
    });
});

// ★テスト対象が依存しているdatabaseのgetNameメソッド
const database = {
    getName: function (id) {
        // このメソッドでは、データベースからデータを取得するが、このメソッドが未完成と仮定。
        // そのため、このメソッドでは何もしていない
    }
};

// ★テスト対象のgetUserNameById関数
function getUserNameById(id) {
    return database.getName(id);
}

// ★テストコード
const sinon = require('sinon');
const assert = require('assert');

describe('Spyのテスト', function () {
    it('正しいIDでdatabase.getNameを1度だけ呼び出しているか', function () {

        // Sinon.JSを使ってdatabaseのgetNameメソッドをスパイする
        // 間接出力(databaseのgetNameメソッドが何回呼び出されたか、どのような引数で呼び出されたか)を記録する
        let spy = sinon.spy(database, 'getName');

        // テスト対象の関数を呼び出す
        getUserNameById('123');

        // ★依存コンポーネント(databaseのgetNameメソッド)の呼び出し方(間接出力)の検証はテストコード上で後から行う
        // databaseのgetNameメソッドが一度だけ呼び出されたか
        assert(spy.calledOnce);
        // databaseのgetNameメソッドが引数('123')で呼び出されたか
        assert(spy.calledWith('123'));

        // スパイの復元
        spy.restore();
    });
});

// ★テスト対象が依存しているdatabaseのgetNameメソッド
const database = {
    getName: function (id) {
        // このメソッドでは、データベースからデータを取得するが、このメソッドが未完成と仮定。
        // そのため、このメソッドでは何もしていない
    }
};

// ★テスト対象のgetUserNameById関数
function getUserNameById(id) {
    return database.getName(id);
}


// ★テストコード
const sinon = require('sinon');
const assert = require('assert');

describe('Mockのテスト', function () {
    it('正しいIDでdatabase.getNameを1度だけ呼び出しているか', function () {

        // 間接出力の期待結果をセット
        let expectedId = '123';

        // Sinon.JSを使ってdatabaseオブジェクトをモック化
        let mock = sinon.mock(database);

        // モックのdatabase.getメソッドが引数expectedId('123')で1度だけ呼び出されることを期待。
        // また、特定の値('Yamada Taro')を返すように設定。
        mock.expects('getName').once().withArgs(expectedId).returns('Yamada Taro');

        // テスト対象の関数を呼び出す
        getUserNameById('123');

        // モックの期待された挙動が満たされたかどうかを検証
        mock.verify();

        // モックの復元
        mock.restore();
    });
});

// ★テスト対象が依存しているdatabaseのgetNameメソッド
const database = {
    getName: function (id) {
        // このメソッドでは、データベースからデータを取得するが、このメソッドが未完成と仮定。
        // そのため、このメソッドでは何もしていない
    }
};

// ★テスト対象のgetUserNameById関数
function getUserNameById(id) {
    return database.getName(id);
}


// ★テストコード
const sinon = require('sinon');
const assert = require('assert');

describe('Fakeのテスト', function () {
    it('getUserNameByIdが正しい名前を返す', function () {

        let expectedId = '123';

        // Sinon.JSを使ってdatabase.getNameメソッドをフェイク化
        // このフェイク化されたメソッドは、どんな引数で呼び出されても'Yamada Taro'を返す。
        let fake = sinon.fake.returns('Yamada Taro');

        // 実際のdatabase.getNameメソッドはフェイクに置き換えられる。
        // そのため、テスト対象のgetUserNameById関数が呼び出されると、database.getNameメソッドの代わりにフェイクが使用される。
        sinon.replace(database, 'getName', fake);

        // テスト対象の関数を呼び出して、返り値をresultNameに保存
        let resultName = getUserNameById(expectedId);

        // 返された名前が期待した名前と同じであるかを検証
        assert.deepStrictEqual(resultName, 'Yamada Taro');

        // フェイクの復元
        sinon.restore();
    });
});

// ★テスト対象のgetFullNameメソッド
class User {
    constructor(firstName, lastName, address) {
        this.firstName = firstName;
        this.lastName = lastName;
        this.address = address;
    }
    getFullName() {
        return `${this.lastName} ${this.firstName}`;
    }
}

// ★テストコード
const assert = require('assert');
const sinon = require('sinon');

describe('Dummyのテスト', function () {
    it('名前がTaro、苗字がYamadaの時にYamada Taroを返す', function () {
        // ダミーデータを設定。インスタンス化する際に必要となるため。
        const dummyAddress = 'Address';
        // Userクラスをインスタンス化。
        const user = new User('Taro', 'Yamada', dummyAddress);
        // getFullNameメソッドの返り値をfullNameに代入
        const fullName = user.getFullName();
        // getFullNameメソッドの結果が正しいことを検証します（ダミーデータが結果に影響を与えないことが分かります）。
        assert.strictEqual(fullName, 'Yamada Taro');
    });
});