วิธีการจำลอง localStorage ในการทดสอบหน่วย JavaScript

มีห้องสมุดไว้ล้อเลียนlocalStorageบ้างไหม?

ฉันใช้Sinon.JSสำหรับการเยาะเย้ยจาวาสคริปต์อื่น ๆ ส่วนใหญ่และพบว่ามันยอดเยี่ยมจริงๆ

การทดสอบครั้งแรกของฉันแสดงให้เห็นว่า localStorage ปฏิเสธที่จะกำหนดให้ใน firefox (sadface) ดังนั้นฉันอาจต้องการแฮ็คบางอย่างเกี่ยวกับสิ่งนี้: /

ตัวเลือกของฉัน ณ ตอนนี้ (ตามที่ฉันเห็น) มีดังนี้:

1. สร้างฟังก์ชันการตัดที่รหัสทั้งหมดของฉันใช้และล้อเลียน
2. สร้างการจัดการสถานะ (อาจซับซ้อน) บางประเภท (สแน็ปช็อต localStorage ก่อนการทดสอบในการล้างข้อมูลการคืนค่าสแน็ปช็อต) สำหรับ localStorage
3. ??????

คุณคิดอย่างไรกับแนวทางเหล่านี้และคุณคิดว่ามีวิธีอื่นที่ดีกว่าในการดำเนินการนี้หรือไม่? ไม่ว่าจะด้วยวิธีใดฉันจะใส่ "ไลบรารี" ที่เป็นผลลัพธ์ที่ฉันสร้างไว้ใน github เพื่อความดีงามของโอเพ่นซอร์ส

นี่คือวิธีง่ายๆในการล้อเลียนกับจัสมิน:

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บ้างไหม?

ฉันเพิ่งเขียนหนึ่ง:

(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

เฉพาะในบริบทส่วนกลาง ด้วยฟังก์ชั่น Wrapper ตามด้านบนมันก็ใช้ได้ดี

นี่คือตัวอย่างการใช้สายลับ sinon และล้อเลียน:

// 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คุณสมบัติข้อมูลว่าไม่สามารถเขียนได้และไม่สามารถกำหนดค่าได้

อย่างไรก็ตามฉันพบว่าอย่างน้อยด้วยเวอร์ชัน WebKit ของ PhantomJS (เวอร์ชัน 1.9.8) คุณสามารถใช้ 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')
}

โมดูลใหม่ของคุณพร้อมฟังก์ชัน config "wrapper"

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://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 สร้าง localstorage ปลอมและสอดแนมใน localstorage เมื่อมันเป็น caleld

 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(...
  });