chore: switch to Jest for unit tests (ngrx#2422)

Author: brandonroberts

.circleci/config.yml

@@ -10,7 +10,7 @@ version: 2
 # See https://blog.daemonl.com/2016/02/yaml.html
 # To validate changes, use an online parser, eg.
 # https://yaml-online-parser.appspot.com/
-var_1: &cache_key yarn-cache-{{ checksum "yarn.lock" }}-0.12.3
+var_1: &cache_key yarn-cache-{{ checksum "yarn.lock" }}-0.12.4
 var_2: &run_in_node
   docker:
     - image: circleci/node:12.9.1
@@ -75,7 +75,7 @@ jobs:
           key: *cache_key
 
       # Build and Test
-      - run: yarn test
+      - run: yarn test --maxWorkers=1 --ci
 
   build:
     <<: *run_in_node
@@ -109,14 +109,6 @@ jobs:
       - run: yarn copy:schematics
       - run: git diff --name-only --exit-code ./modules
 
-  example-tests:
-    <<: *run_in_browser
-    steps:
-      - checkout
-      - restore_cache:
-          key: *cache_key
-      - run: yarn run example:test --watch=false --runInBand
-
   example-e2e-tests:
     <<: *run_in_browser
     steps:
@@ -278,9 +270,6 @@ workflows:
       - build:
           requires:
             - test
-      - example-tests:
-          requires:
-            - install
       - example-e2e-tests:
           requires:
             - install
@@ -299,7 +288,6 @@ workflows:
       - deploy:
           requires:
             - docs
-            - example-tests
             - example-e2e-tests
             - docs-tests
             - build

angular.json

@@ -72,21 +72,6 @@
             "browserTarget": "example-app:build"
           }
         },
-        "test": {
-          "builder": "@angular-devkit/build-angular:karma",
-          "options": {
-            "main": "projects/example-app/src/test.ts",
-            "polyfills": "projects/example-app/src/polyfills.ts",
-            "tsConfig": "projects/example-app/tsconfig.spec.json",
-            "karmaConfig": "projects/example-app/karma.conf.js",
-            "styles": ["projects/example-app/src/styles.css"],
-            "scripts": [],
-            "assets": [
-              "projects/example-app/src/favicon.ico",
-              "projects/example-app/src/assets"
-            ]
-          }
-        },
         "lint": {
           "builder": "@angular-devkit/build-angular:tslint",
           "options": {

jest.config.js

@@ -0,0 +1,37 @@
+module.exports = {
+  rootDir: '.',
+  setupFilesAfterEnv: ['<rootDir>/setup-jest.ts'],
+  globals: {
+    'ts-jest': {
+      tsConfig: 'tsconfig.json',
+      stringifyContentPathRegex: '\\.html?$',
+      astTransformers: [
+        require.resolve('jest-preset-angular/build/StripStylesTransformer'),
+      ],
+    },
+  },
+  transform: {
+    '^.+\\.(ts|js|html)$': 'ts-jest',
+  },
+  testMatch: [
+    '<rootDir>/modules/**/*.spec.ts',
+    '<rootDir>/projects/example-app/**/*.spec.ts'
+  ],
+  testEnvironment: 'jsdom',
+  moduleFileExtensions: ['html', 'js', 'json', 'ts'],
+  coveragePathIgnorePatterns: ['/node_modules/', '/modules/*.*/'],
+  moduleNameMapper: {
+    '^@ngrx/(.*)': '<rootDir>/modules/$1',
+    '^@example-app/(.*)': '<rootDir>/projects/example-app/src/app/$1',
+  },
+  transformIgnorePatterns: ['node_modules/(?!@ngrx)'],
+  modulePathIgnorePatterns: ['dist'],
+  snapshotSerializers: [
+    'jest-preset-angular/build/AngularSnapshotSerializer.js',
+    'jest-preset-angular/build/HTMLCommentSerializer.js',
+  ],
+  testPathIgnorePatterns: [
+    '<rootDir>/node_modules/',
+    '<rootDir>/projects/example-app-cypress'
+  ]
+};

modules/data/spec/actions/entity-action-factory.spec.ts

@@ -23,7 +23,7 @@ describe('EntityActionFactory', () => {
     const { entityName, entityOp, data } = action.payload;
     expect(entityName).toBe('Hero');
     expect(entityOp).toBe(EntityOp.QUERY_ALL);
-    expect(data).toBeUndefined('no data property');
+    expect(data).toBeUndefined();
   });
 
   it('#create should create an EntityAction with the given data', () => {

modules/data/spec/dataservices/default-data.service.spec.ts

@@ -115,7 +115,7 @@ describe('DefaultDataService', () => {
       const req = httpTestingController.expectOne(heroesUrl);
       expect(req.request.method).toEqual('GET');
 
-      expect(req.request.body).toBeNull('should not send data');
+      expect(req.request.body).toBeNull();
 
       // Respond with the mock heroes
       req.flush(expectedHeroes);
@@ -163,7 +163,7 @@ describe('DefaultDataService', () => {
       service.getAll().subscribe(
         heroes => fail('getAll succeeded when expected it to fail with a 404'),
         err => {
-          expect(err).toBeDefined('request should have failed');
+          expect(err).toBeDefined();
           expect(err instanceof DataServiceError).toBe(
             true,
             'is DataServiceError'
@@ -207,7 +207,7 @@ describe('DefaultDataService', () => {
       // One request to GET hero from expected URL
       const req = httpTestingController.expectOne(heroUrlId1);
 
-      expect(req.request.body).toBeNull('should not send data');
+      expect(req.request.body).toBeNull();
 
       // Respond with the expected hero
       req.flush(expectedHero);
@@ -260,7 +260,7 @@ describe('DefaultDataService', () => {
       const req = httpTestingController.expectOne(heroesUrl + '?name=B');
       expect(req.request.method).toEqual('GET');
 
-      expect(req.request.body).toBeNull('should not send data');
+      expect(req.request.body).toBeNull();
 
       // Respond with the mock heroes
       req.flush(expectedHeroes);
@@ -307,7 +307,7 @@ describe('DefaultDataService', () => {
         heroes =>
           fail('getWithQuery succeeded when expected it to fail with a 404'),
         err => {
-          expect(err).toBeDefined('request should have failed');
+          expect(err).toBeDefined();
           expect(err instanceof DataServiceError).toBe(
             true,
             'is DataServiceError'
@@ -378,7 +378,7 @@ describe('DefaultDataService', () => {
         r => r.method === 'DELETE' && r.url === heroUrlId1
       );
 
-      expect(req.request.body).toBeNull('should not send data');
+      expect(req.request.body).toBeNull();
 
       // Respond with empty nonsense object
       req.flush({});
@@ -541,7 +541,12 @@ describe('DefaultDataServiceFactory', () => {
         collectionResourceUrl: heroesUrl,
       },
     });
-    http = jasmine.createSpyObj('HttpClient', ['get', 'delete', 'post', 'put']);
+    http = {
+      get: jasmine.createSpy('get'),
+      delete: jasmine.createSpy('delete'),
+      post: jasmine.createSpy('post'),
+      put: jasmine.createSpy('put'),
+    };
     http.get.and.returnValue(of([]));
   });
 

modules/data/spec/dispatchers/entity-dispatcher.spec.ts

@@ -188,7 +188,7 @@ export function commandDispatchTest(
       } = dispatchedAction().payload;
       expect(entityOp).toBe(EntityOp.QUERY_ALL);
       expect(entityName).toBe('Hero');
-      expect(mergeStrategy).toBeUndefined('no MergeStrategy');
+      expect(mergeStrategy).toBeUndefined();
     });
 
     it('#getAll({mergeStrategy}) dispatches QUERY_ALL with a MergeStrategy', () => {
@@ -210,7 +210,7 @@ export function commandDispatchTest(
       const { entityOp, data, mergeStrategy } = dispatchedAction().payload;
       expect(entityOp).toBe(EntityOp.QUERY_BY_KEY);
       expect(data).toBe(42);
-      expect(mergeStrategy).toBeUndefined('no MergeStrategy');
+      expect(mergeStrategy).toBeUndefined();
     });
 
     it('#getByKey(42, {mergeStrategy}) dispatches QUERY_BY_KEY with a MergeStrategy', () => {
@@ -236,7 +236,7 @@ export function commandDispatchTest(
       expect(entityOp).toBe(EntityOp.QUERY_MANY);
       expect(entityName).toBe('Hero');
       expect(data).toEqual({ name: 'B' }, 'params');
-      expect(mergeStrategy).toBeUndefined('no MergeStrategy');
+      expect(mergeStrategy).toBeUndefined();
     });
 
     it('#getWithQuery(string) dispatches QUERY_MANY', () => {
@@ -251,7 +251,7 @@ export function commandDispatchTest(
       expect(entityOp).toBe(EntityOp.QUERY_MANY);
       expect(entityName).toBe('Hero');
       expect(data).toEqual('name=B', 'params');
-      expect(mergeStrategy).toBeUndefined('no MergeStrategy');
+      expect(mergeStrategy).toBeUndefined();
     });
 
     it('#getWithQuery(string) dispatches QUERY_MANY with a MergeStrategy', () => {
@@ -281,7 +281,7 @@ export function commandDispatchTest(
       } = dispatchedAction().payload;
       expect(entityOp).toBe(EntityOp.QUERY_LOAD);
       expect(entityName).toBe('Hero');
-      expect(mergeStrategy).toBeUndefined('no MergeStrategy');
+      expect(mergeStrategy).toBeUndefined();
     });
   });
 
@@ -304,7 +304,7 @@ export function commandDispatchTest(
       const { entityOp, data, mergeStrategy } = dispatchedAction().payload;
       expect(entityOp).toBe(EntityOp.ADD_ONE);
       expect(data).toBe(hero);
-      expect(mergeStrategy).toBeUndefined('no MergeStrategy');
+      expect(mergeStrategy).toBeUndefined();
     });
 
     it('#addOneToCache can dispatch ADD_ONE and MergeStrategy.IgnoreChanges', () => {

modules/data/spec/effects/entity-cache-effects.spec.ts

@@ -35,7 +35,7 @@ describe('EntityCacheEffects (normal testing)', () => {
     mergeStrategy: typeof mergeStrategy;
   };
 
-  function expectCompletion(completion: any, done: DoneFn) {
+  function expectCompletion(completion: any, done: any) {
     effects.saveEntities$.subscribe(result => {
       expect(result).toEqual(completion);
       done();
@@ -45,7 +45,11 @@ describe('EntityCacheEffects (normal testing)', () => {
   beforeEach(() => {
     actions$ = new ReplaySubject<Action>(1);
     correlationId = 'CORID42';
-    logger = jasmine.createSpyObj('Logger', ['error', 'log', 'warn']);
+    logger = {
+      error: jasmine.createSpy('error'),
+      log: jasmine.createSpy('log'),
+      warn: jasmine.createSpy('warn'),
+    };
     mergeStrategy = undefined;
     options = { correlationId, mergeStrategy };
 
@@ -70,7 +74,7 @@ describe('EntityCacheEffects (normal testing)', () => {
     dataService = TestBed.get(EntityCacheDataService);
   });
 
-  it('should return a SAVE_ENTITIES_SUCCESS with the expected ChangeSet on success', (done: DoneFn) => {
+  it('should return a SAVE_ENTITIES_SUCCESS with the expected ChangeSet on success', (done: any) => {
     const cs = createChangeSet();
     const action = new SaveEntities(cs, 'test/save', options);
     const completion = new SaveEntitiesSuccess(cs, 'test/save', options);
@@ -81,7 +85,7 @@ describe('EntityCacheEffects (normal testing)', () => {
     dataService.setResponse(cs);
   });
 
-  it('should not emit SAVE_ENTITIES_SUCCESS if cancel arrives in time', (done: DoneFn) => {
+  it('should not emit SAVE_ENTITIES_SUCCESS if cancel arrives in time', (done: any) => {
     const cs = createChangeSet();
     const action = new SaveEntities(cs, 'test/save', options);
     const cancel = new SaveEntitiesCancel(correlationId, 'Test Cancel');
@@ -97,7 +101,7 @@ describe('EntityCacheEffects (normal testing)', () => {
     dataService.setResponse(cs);
   });
 
-  it('should emit SAVE_ENTITIES_SUCCESS if cancel arrives too late', (done: DoneFn) => {
+  it('should emit SAVE_ENTITIES_SUCCESS if cancel arrives too late', (done: any) => {
     const cs = createChangeSet();
     const action = new SaveEntities(cs, 'test/save', options);
     const cancel = new SaveEntitiesCancel(correlationId, 'Test Cancel');
@@ -112,7 +116,7 @@ describe('EntityCacheEffects (normal testing)', () => {
     setTimeout(() => actions$.next(cancel), 1);
   });
 
-  it('should emit SAVE_ENTITIES_SUCCESS immediately if no changes to save', (done: DoneFn) => {
+  it('should emit SAVE_ENTITIES_SUCCESS immediately if no changes to save', (done: any) => {
     const action = new SaveEntities({ changes: [] }, 'test/save', options);
     effects.saveEntities$.subscribe(result => {
       expect(result instanceof SaveEntitiesSuccess).toBe(true);
@@ -122,7 +126,7 @@ describe('EntityCacheEffects (normal testing)', () => {
     actions$.next(action);
   });
 
-  xit('should return a SAVE_ENTITIES_ERROR when data service fails', (done: DoneFn) => {
+  xit('should return a SAVE_ENTITIES_ERROR when data service fails', (done: any) => {
     const cs = createChangeSet();
     const action = new SaveEntities(cs, 'test/save', options);
     const httpError = { error: new Error('Test Failure'), status: 501 };

modules/data/spec/effects/entity-effects.marbles.spec.ts

@@ -32,7 +32,11 @@ describe('EntityEffects (marble testing)', () => {
   let logger: Logger;
 
   beforeEach(() => {
-    logger = jasmine.createSpyObj('Logger', ['error', 'log', 'warn']);
+    logger = {
+      error: jasmine.createSpy('error'),
+      log: jasmine.createSpy('log'),
+      warn: jasmine.createSpy('warn'),
+    };
 
     TestBed.configureTestingModule({
       providers: [