Added tests for the effects and the books reducer (#106)

Author: vespertilian

.gitignore

@@ -16,6 +16,7 @@
 .settings/
 
 # IDE - VSCode
+.vscode
 .vscode/*
 !.vscode/settings.json
 !.vscode/tasks.json

src/app/effects/book.spec.ts

@@ -0,0 +1,85 @@
+import { EffectsTestingModule, EffectsRunner } from '@ngrx/effects/testing';
+import { TestBed, fakeAsync, tick } from '@angular/core/testing';
+import { BookEffects } from './book';
+import { GoogleBooksService } from '../services/google-books';
+import { Observable } from 'rxjs/Observable';
+import 'rxjs/add/Observable/of'
+import 'rxjs/add/Observable/throw'
+import { SearchAction, SearchCompleteAction } from '../actions/book';
+import { Book } from '../models/book';
+
+describe('BookEffects', () => {
+  beforeEach(() => TestBed.configureTestingModule({
+    imports: [
+      EffectsTestingModule
+    ],
+    providers: [
+      BookEffects,
+      {
+        provide: GoogleBooksService,
+        useValue: jasmine.createSpyObj('googleBooksService', ['searchBooks'])
+      }
+    ]
+  }));
+
+  function setup(params?: {searchBooksReturnValue: any}) {
+    const googleBooksService = TestBed.get(GoogleBooksService);
+    if (params) googleBooksService.searchBooks.and.returnValue(params.searchBooksReturnValue);
+
+    return {
+      runner: TestBed.get(EffectsRunner),
+      bookEffects: TestBed.get(BookEffects)
+    };
+  }
+
+  describe('search$', () => {
+    it('should return a new book.SearchCompleteAction, with the books, on success, after the de-bounce', fakeAsync(() => {
+      const book1 = {id: '111', volumeInfo: {}} as Book;
+      const book2 = {id: '222', volumeInfo: {}} as Book;
+      const books = [book1, book2];
+
+      const {runner, bookEffects} = setup({searchBooksReturnValue: Observable.of(books)});
+
+      const expectedResult = new SearchCompleteAction(books);
+      runner.queue(new SearchAction('query'));
+
+      let result = null;
+      bookEffects.search$.subscribe(_result => result = _result);
+      tick(299); // test de-bounce
+      expect(result).toBe(null);
+      tick(300);
+      expect(result).toEqual(expectedResult);
+    }));
+
+    it('should return a new book.SearchCompleteAction, with an empty array, if the books service throws', fakeAsync(() => {
+      const {runner, bookEffects} = setup({searchBooksReturnValue: Observable.throw(new Error())});
+
+      const expectedResult = new SearchCompleteAction([]);
+      runner.queue(new SearchAction('query'));
+
+      let result = null;
+      bookEffects.search$.subscribe(_result => result = _result);
+      tick(299); // test de-bounce
+      expect(result).toBe(null);
+      tick(300);
+      expect(result).toEqual(expectedResult);
+    }));
+
+    it(`should not do anything if the query is an empty string`, fakeAsync(() => {
+      const {runner, bookEffects} = setup();
+
+      runner.queue(new SearchAction(''));
+      let result = null;
+      bookEffects.search$.subscribe({
+        next: () => result = false,
+        complete: () => result = false,
+        error: () => result = false
+      });
+
+      tick(300);
+      expect(result).toBe(null);
+    }));
+
+  });
+});
+

src/app/effects/collection.spec.ts

@@ -0,0 +1,143 @@
+import { EffectsTestingModule, EffectsRunner } from '@ngrx/effects/testing';
+import { TestBed } from '@angular/core/testing';
+import { CollectionEffects } from './collection';
+import { Database } from '@ngrx/db';
+import { Book } from '../models/book';
+import * as collection from '../actions/collection';
+import { Observable } from 'rxjs/Observable';
+import 'rxjs/add/Observable/of'
+import 'rxjs/add/Observable/throw'
+
+describe('CollectionEffects', () => {
+  beforeEach(() => TestBed.configureTestingModule({
+    imports: [
+      EffectsTestingModule
+    ],
+    providers: [
+      CollectionEffects,
+      {
+        provide: Database,
+        useValue: jasmine.createSpyObj('database', ['open', 'query', 'insert', 'executeWrite'])
+      }
+    ]
+  }));
+
+  function setup() {
+    return {
+      db: TestBed.get(Database),
+      runner: TestBed.get(EffectsRunner),
+      collectionEffects: TestBed.get(CollectionEffects)
+    };
+  }
+
+  describe('openDB$', () => {
+    it('should call db.open when initially subscribed to', () => {
+      const {db, collectionEffects} = setup();
+      collectionEffects.openDB$.subscribe();
+      expect(db.open).toHaveBeenCalledWith('books_app');
+    });
+  });
+
+  describe('loadCollection$', () => {
+    it('should return a collection.LoadSuccessAction, with the books, on success', () => {
+      const book1 = {id: '111', volumeInfo: {}} as Book;
+      const book2 = {id: '222', volumeInfo: {}} as Book;
+
+      const {db, runner, collectionEffects} = setup();
+
+      const booksObservable = Observable.of(book1, book2);
+      db.query.and.returnValue(booksObservable);
+
+      const expectedResult = new collection.LoadSuccessAction([book1, book2]);
+
+      runner.queue(new collection.LoadAction());
+
+      collectionEffects.loadCollection$.subscribe(result => {
+        expect(result).toEqual(expectedResult);
+      });
+    });
+
+    it('should return a collection.LoadFailAction, if the query throws', () => {
+      const {db, runner, collectionEffects} = setup();
+
+      const error = new Error('msg');
+      db.query.and.returnValue(Observable.throw(error));
+
+      const expectedResult = new collection.LoadFailAction(error);
+
+      runner.queue(new collection.LoadAction());
+
+      collectionEffects.loadCollection$.subscribe(result => {
+        expect(result).toEqual(expectedResult);
+      });
+    });
+  });
+
+  describe('addBookToCollection$', () => {
+    it('should return a collection.AddBookSuccessAction, with the book, on success', () => {
+      const book = {id: '111', volumeInfo: {}} as Book;
+
+      const {db, runner, collectionEffects} = setup();
+      db.insert.and.returnValue(Observable.of({}));
+
+      const expectedResult = new collection.AddBookSuccessAction(book);
+
+      runner.queue(new collection.AddBookAction(book));
+
+      collectionEffects.addBookToCollection$.subscribe(result => {
+        expect(result).toEqual(expectedResult);
+        expect(db.insert).toHaveBeenCalledWith('books', [book]);
+      });
+    });
+
+    it('should return a collection.AddBookFailAction, with the book, when the db insert throws', () => {
+      const book = {id: '111', volumeInfo: {}} as Book;
+
+      const {db, runner, collectionEffects} = setup();
+      db.insert.and.returnValue(Observable.throw(new Error()));
+
+      const expectedResult = new collection.AddBookFailAction(book);
+
+      runner.queue(new collection.AddBookAction(book));
+
+      collectionEffects.addBookToCollection$.subscribe(result => {
+        expect(result).toEqual(expectedResult);
+        expect(db.insert).toHaveBeenCalledWith('books', [book]);
+      });
+    });
+
+    describe('removeBookFromCollection$', () => {
+      it('should return a collection.RemoveBookSuccessAction, with the book, on success', () => {
+        const book = {id: '111', volumeInfo: {}} as Book;
+
+        const {db, runner, collectionEffects} = setup();
+        db.executeWrite.and.returnValue(Observable.of({}));
+
+        const expectedResult = new collection.RemoveBookSuccessAction(book);
+
+        runner.queue(new collection.RemoveBookAction(book));
+
+        collectionEffects.removeBookFromCollection$.subscribe(result => {
+          expect(result).toEqual(expectedResult);
+          expect(db.executeWrite).toHaveBeenCalledWith('books', 'delete', ['111']);
+        });
+      });
+
+      it('should return a collection.RemoveBookFailAction, with the book, when the db insert throws', () => {
+        const book = {id: '111', volumeInfo: {}} as Book;
+
+        const {db, runner, collectionEffects} = setup();
+        db.executeWrite.and.returnValue(Observable.throw(new Error()));
+
+        const expectedResult = new collection.RemoveBookFailAction(book);
+
+        runner.queue(new collection.RemoveBookAction(book));
+
+        collectionEffects.removeBookFromCollection$.subscribe(result => {
+          expect(result).toEqual(expectedResult);
+          expect(db.executeWrite).toHaveBeenCalledWith('books', 'delete', ['111']);
+        });
+      });
+    });
+  });
+});