Skip to content

Instantly share code, notes, and snippets.

@wzr1337
Last active October 22, 2023 12:22
Show Gist options
  • Save wzr1337/b3fe4abcc46588aa8fcb to your computer and use it in GitHub Desktop.
Save wzr1337/b3fe4abcc46588aa8fcb to your computer and use it in GitHub Desktop.
Mock localStorage for jasmine tests in TypeScript. This is the testing script. Copy the parts between snip and snap to mock your localStorage
/// <reference path="../../library.test.d.ts"/>
import * as angular from "angular"; angular;
import * as mocks from "angular-mocks/ngMock"; mocks;
describe('feat(localStorage Mock): ', function() {
beforeAll(() => {
angular.module('mock-module',[])
});
// --- snip ---
// Mock localStorage
beforeEach(() => {
var store = {};
spyOn(localStorage, 'getItem').and.callFake( (key:string):String => {
return store[key] || null;
});
spyOn(localStorage, 'removeItem').and.callFake((key:string):void => {
delete store[key];
});
spyOn(localStorage, 'setItem').and.callFake((key:string, value:string):string => {
return store[key] = <string>value;
});
spyOn(localStorage, 'clear').and.callFake(() => {
store = {};
});
});
// --- snap ---
beforeEach(()=> {
angular.mock.module('mock-module');
});
it('should set an Item', () => {
expect(localStorage.setItem('foo', 'bar')).toBe('bar'); // bar
expect(localStorage.getItem('foo')).toBe('bar'); // bar
});
it('should return null for non existing items', () => {
expect(localStorage.getItem('foo')).toBeNull(); // null
});
it('should set and remove Item', () => {
expect(localStorage.setItem('foo', 'bar')).toBe('bar'); // bar
expect(localStorage.removeItem('foo')).toBeUndefined(); // undefined
expect(localStorage.getItem('foo')).toBeNull(); // null
});
it('should clear the storage', () => {
expect(localStorage.setItem('foo', 'bar')).toBe('bar'); // bar
expect(localStorage.setItem('bar', 'foo')).toBe('foo'); // foo
expect(localStorage.clear()).toBeUndefined(); // undefined
expect(localStorage.getItem('foo')).toBeNull(); // null
expect(localStorage.getItem('bar')).toBeNull(); // null
});
});
@ayarushin
Copy link

For sessionStorage

Using spyOn(sessionStorage, 'getItem') not worked for me.
This approach works well with Angular 7

beforeEach(() => {
    ...

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

    spyOn(Storage.prototype, 'getItem').and.callFake(mockSessionStorage.getItem);
    spyOn(Storage.prototype, 'setItem').and.callFake(mockSessionStorage.setItem);
    spyOn(Storage.prototype, 'removeItem').and.callFake(mockSessionStorage.removeItem);
    spyOn(Storage.prototype, 'clear').and.callFake(mockSessionStorage.clear);
});

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment