JavaScript単体テストでlocalStorageをモックする方法は？

モックするライブラリはありますlocalStorageか？

私は他のほとんどのJavaScript モックにSinon.JSを使用してきましたが、それが本当に素晴らしいことを発見しました。

私の最初のテストでは、localStorageがFirefox（悲しい顔）で割り当て可能であることを拒否しているため、おそらくこれを回避するための何らかのハックが必要になります。

今のところ（私の見るとおり）、私のオプションは次のとおりです。

1. すべてのコードが使用するラッピング関数を作成し、それらをモックします
2. localStorageのある種の（複雑になる可能性がある）状態管理（テスト前のスナップショットlocalStorage、クリーンアップリストアスナップショット）を作成します。
3. ??????

あなたはこれらのアプローチについてどう思いますか、そしてあなたはこれについて取り組む他のより良い方法があると思いますか？どちらの方法でも、結果として得られる「ライブラリ」を配置して、最終的にはオープンソースの良さのためにgithubに作成します。

Jasmineでそれを模擬する簡単な方法を次に示します。

beforeEach(function () {
  var store = {};

  spyOn(localStorage, 'getItem').andCallFake(function (key) {
    return store[key];
  });
  spyOn(localStorage, 'setItem').andCallFake(function (key, value) {
    return store[key] = value + '';
  });
  spyOn(localStorage, 'clear').andCallFake(function () {
      store = {};
  });
});

すべてのテストでローカルストレージをモックしたい場合beforeEach()は、テストのグローバルスコープで上記の関数を宣言します（通常、場所はspecHelper.jsスクリプトです）。

必要に応じて、グローバルlocalStorage / sessionStorage（同じAPIを持つ）をモックするだけです。
例えば：

 // Storage Mock
  function storageMock() {
    let storage = {};

    return {
      setItem: function(key, value) {
        storage[key] = value || '';
      },
      getItem: function(key) {
        return key in storage ? storage[key] : null;
      },
      removeItem: function(key) {
        delete storage[key];
      },
      get length() {
        return Object.keys(storage).length;
      },
      key: function(i) {
        const keys = Object.keys(storage);
        return keys[i] || null;
      }
    };
  }

そして、あなたが実際に行うことは、そのようなものです：

// mock the localStorage
window.localStorage = storageMock();
// mock the sessionStorage
window.sessionStorage = storageMock();

また、オブジェクトのコンストラクター関数に依存関係を注入するオプションも検討してください。

var SomeObject(storage) {
  this.storge = storage || window.localStorage;
  // ...
}

SomeObject.prototype.doSomeStorageRelatedStuff = function() {
  var myValue = this.storage.getItem('myKey');
  // ...
}

// In src
var myObj = new SomeObject();

// In test
var myObj = new SomeObject(mockStorage)

モッキングと単体テストに沿って、私はストレージ実装のテストを避けたいと思います。たとえば、アイテムを設定した後にストレージの長さが増加したかどうかを確認しても意味がありません。

実際のlocalStorageオブジェクトのメソッドを置き換えることは明らかに信頼性が低いため、「ダム」のmockStorageを使用し、以下のように、必要に応じて個々のメソッドをスタブします。

var mockStorage = {
  setItem: function() {},
  removeItem: function() {},
  key: function() {},
  getItem: function() {},
  removeItem: function() {},
  length: 0
};

// Then in test that needs to know if and how setItem was called
sinon.stub(mockStorage, 'setItem');
var myObj = new SomeObject(mockStorage);

myObj.doSomeStorageRelatedStuff();
expect(mockStorage.setItem).toHaveBeenCalledWith('myKey');

これが私がすることです...

var mock = (function() {
  var store = {};
  return {
    getItem: function(key) {
      return store[key];
    },
    setItem: function(key, value) {
      store[key] = value.toString();
    },
    clear: function() {
      store = {};
    }
  };
})();

Object.defineProperty(window, 'localStorage', { 
  value: mock,
});

現在のソリューションはFirefoxでは機能しません。これは、localStorageがhtml仕様で変更不可として定義されているためです。ただし、localStorageのプロトタイプに直接アクセスすることで、これを回避できます。

クロスブラウザソリューションは、Storage.prototypeたとえば、オブジェクトをモックすることです

spyOn（localStorage、 'setItem'）の代わりに使用

spyOn(Storage.prototype, 'setItem')
spyOn(Storage.prototype, 'getItem')

bzbarskyと teogeosの返信からここに取られましたhttps://github.com/jasmine/jasmine/issues/299

モックするライブラリはありますlocalStorageか？

私は1つ書いた：

(function () {
    var localStorage = {};
    localStorage.setItem = function (key, val) {
         this[key] = val + '';
    }
    localStorage.getItem = function (key) {
        return this[key];
    }
    Object.defineProperty(localStorage, 'length', {
        get: function () { return Object.keys(this).length - 2; }
    });

    // Your tests here

})();

私の最初のテストは、localStorageがFirefoxで割り当て可能であることを拒否していることを示しています

グローバルコンテキストでのみ。上記のラッパー関数を使用すると、問題なく動作します。

以下は、sinon spyとmockを使用した例です。

// window.localStorage.setItem
var spy = sinon.spy(window.localStorage, "setItem");

// You can use this in your assertions
spy.calledWith(aKey, aValue)

// Reset localStorage.setItem method    
spy.reset();



// window.localStorage.getItem
var stub = sinon.stub(window.localStorage, "getItem");
stub.returns(aValue);

// You can use this in your assertions
stub.calledWith(aKey)

// Reset localStorage.getItem method
stub.reset();

一部の回答で提案されているようにlocalStorageグローバルwindowオブジェクトのプロパティを上書きしても、ほとんどのJSエンジンではlocalStorage機能しません。これは、データプロパティが書き込み可能ではなく、構成不可能であると宣言されているためです。

ただし、少なくともPhantomJS（バージョン1.9.8）のWebKitバージョンでは、レガシーAPI __defineGetter__を使用して、localStorageアクセスされた場合の動作を制御できることがわかりました。それでも、これが他のブラウザでも機能する場合は興味深いでしょう。

var tmpStorage = window.localStorage;

// replace local storage
window.__defineGetter__('localStorage', function () {
    throw new Error("localStorage not available");
    // you could also return some other object here as a mock
});

// do your tests here    

// restore old getter to actual local storage
window.__defineGetter__('localStorage',
                        function () { return tmpStorage });

このアプローチの利点は、テストするコードを変更する必要がないことです。

ストレージオブジェクトを使用する各メソッドに渡す必要はありません。代わりに、ストレージアダプターに接続するすべてのモジュールの構成パラメーターを使用できます。

古いモジュール

// hard to test !
export const someFunction (x) {
  window.localStorage.setItem('foo', x)
}

// hard to test !
export const anotherFunction () {
  return window.localStorage.getItem('foo')
}

「ラッパー」機能を設定した新しいモジュール

export default function (storage) {
  return {
    someFunction (x) {
      storage.setItem('foo', x)
    }
    anotherFunction () {
      storage.getItem('foo')
    }
  }
}

モジュールをテストコードで使用する場合

// import mock storage adapater
const MockStorage = require('./mock-storage')

// create a new mock storage instance
const mock = new MockStorage()

// pass mock storage instance as configuration argument to your module
const myModule = require('./my-module')(mock)

// reset before each test
beforeEach(function() {
  mock.clear()
})

// your tests
it('should set foo', function() {
  myModule.someFunction('bar')
  assert.equal(mock.getItem('foo'), 'bar')
})

it('should get foo', function() {
  mock.setItem('foo', 'bar')
  assert.equal(myModule.anotherFunction(), 'bar')
})

MockStorageクラスは次のようになります。

export default class MockStorage {
  constructor () {
    this.storage = new Map()
  }
  setItem (key, value) {
    this.storage.set(key, value)
  }
  getItem (key) {
    return this.storage.get(key)
  }
  removeItem (key) {
    this.storage.delete(key)
  }
  clear () {
    this.constructor()
  }
}

モジュールを本番コードで使用する場合は、実際のlocalStorageアダプターを渡します

const myModule = require('./my-module')(window.localStorage)

私は、Pumbaa80の回答に対するコメントを別の回答として繰り返して、ライブラリとして再利用しやすくすることにしました。

私はPumbaa80のコードを取得し、少し改良して、テストを追加し、npmモジュールとしてここに公開しました：https ://www.npmjs.com/package/mock-local-storage 。

これがソースコードです：https : //github.com/letsrock-today/mock-local-storage/blob/master/src/mock-localstorage.js

一部のテスト：https : //github.com/letsrock-today/mock-local-storage/blob/master/test/mock-localstorage.js

モジュールは、グローバルオブジェクト（ウィンドウまたはグローバル、どちらが定義されているか）にモックlocalStorageおよびsessionStorageを作成します。

他のプロジェクトのテストmocha -r mock-local-storageでは、テスト対象のすべてのコードでグローバル定義を使用できるようにするために、モカを次のように必要としました。

基本的に、コードは次のようになります。

(function (glob) {

    function createStorage() {
        let s = {},
            noopCallback = () => {},
            _itemInsertionCallback = noopCallback;

        Object.defineProperty(s, 'setItem', {
            get: () => {
                return (k, v) => {
                    k = k + '';
                    _itemInsertionCallback(s.length);
                    s[k] = v + '';
                };
            }
        });
        Object.defineProperty(s, 'getItem', {
            // ...
        });
        Object.defineProperty(s, 'removeItem', {
            // ...
        });
        Object.defineProperty(s, 'clear', {
            // ...
        });
        Object.defineProperty(s, 'length', {
            get: () => {
                return Object.keys(s).length;
            }
        });
        Object.defineProperty(s, "key", {
            // ...
        });
        Object.defineProperty(s, 'itemInsertionCallback', {
            get: () => {
                return _itemInsertionCallback;
            },
            set: v => {
                if (!v || typeof v != 'function') {
                    v = noopCallback;
                }
                _itemInsertionCallback = v;
            }
        });
        return s;
    }

    glob.localStorage = createStorage();
    glob.sessionStorage = createStorage();
}(typeof window !== 'undefined' ? window : global));

経由で追加されたすべてのメソッドはObject.defineProperty、通常のアイテムとして繰り返されたり、アクセスされたり、削除されたり、長さを数えたりしないようになっています。また、アイテムがオブジェクトに配置されようとしているときに呼び出されるコールバックを登録する方法を追加しました。このコールバックは、テストで割り当て超過エラーをエミュレートするために使用できます。

私はそれをあざける必要がないことに気づきました。実際のローカルストレージを必要な状態にsetItem変更してから、値をクエリして、によって変更されたかどうかを確認できgetItemます。それは、何かが変更された回数を確認できないほどモックほど強力ではありませんが、私の目的には役立ちました。

残念ながら、テストシナリオでlocalStorageオブジェクトをモックできる唯一の方法は、テストするコードを変更することです。匿名関数（とにかく行う必要があります）でコードをラップし、「依存性注入」を使用してウィンドウオブジェクトへの参照を渡す必要があります。何かのようなもの：

(function (window) {
   // Your code
}(window.mockWindow || window));

次に、テスト内で、以下を指定できます。

window.mockWindow = { localStorage: { ... } };

これが私のやり方です。シンプルに保つ。

  let localStoreMock: any = {};

  beforeEach(() => {

    angular.mock.module('yourApp');

    angular.mock.module(function ($provide: any) {

      $provide.service('localStorageService', function () {
        this.get = (key: any) => localStoreMock[key];
        this.set = (key: any, value: any) => localStoreMock[key] = value;
      });

    });
  });

クレジット https://medium.com/@armno/til-mocking-localstorage-and-sessionstorage-in-angular-unit-tests-a765abdc9d87は それがcaleldあるとき、偽ののlocalStorageを作成し、localStorageををスパイ

 beforeAll( () => {
    let store = {};
    const mockLocalStorage = {
      getItem: (key: string): string => {
        return key in store ? store[key] : null;
      },
      setItem: (key: string, value: string) => {
        store[key] = `${value}`;
      },
      removeItem: (key: string) => {
        delete store[key];
      },
      clear: () => {
        store = {};
      }
    };

    spyOn(localStorage, 'getItem')
      .and.callFake(mockLocalStorage.getItem);
    spyOn(localStorage, 'setItem')
      .and.callFake(mockLocalStorage.setItem);
    spyOn(localStorage, 'removeItem')
      .and.callFake(mockLocalStorage.removeItem);
    spyOn(localStorage, 'clear')
      .and.callFake(mockLocalStorage.clear);
  })

そして、ここでそれを使用します

it('providing search value should return matched item', () => {
    localStorage.setItem('defaultLanguage', 'en-US');

    expect(...
  });