954 - Add tests coverage (#977)

* chore(pkg): add coverage

* e2e(coverage): integreate

* chore(ignore): ignore coverage

* chore(pkg): script for coverage

* chore(webpack): update coverage reporter

* fix(e2e): order of instantiation

* e2e(api): use `dealService` due to changes in #942

Reason: order of code executions

* docs(cypress): add cov part

.gitignore

@@ -44,3 +44,7 @@ node_modules
 # Cypress
 cypress/videos
 cypress/screenshots
+
+# Coverage
+coverage
+.nyc_output

cypress/README.md

@@ -157,3 +157,9 @@ https://docs.cypress.io/guides/references/configuration#cypress-json
 [app_action]: (https://www.cypress.io/blog/2019/01/03/stop-using-page-objects-and-start-using-app-actions/)
 
 *[[Back to top] 🔝](#concepts)*
+
+### Coverage
+Have to run a separate command to instrument the code (instrument = add helper code, that tracks when code was executed)
+`npm run start-dev:cov`
+
+Then can run other e2e commands

cypress/integration/common/deal-api.ts

@@ -26,6 +26,11 @@ export class E2eDealsApi {
     return Cypress.firestoreService;
   }
 
+  private static getDealService() {
+    // @ts-ignore - Hack to access dealService inside Cypress
+    return Cypress.dealService;
+  }
+
   private static getDataSourceDeals(): FirestoreDealsService<
   IDealTokenSwapDocument,
   IDealRegistrationTokenSwap
@@ -179,9 +184,16 @@ export class E2eDealsApi {
        * 2. Interact with Firestore
        */
       return cy.then(async () => {
-        const firestoreService = E2eDealsApi.getFirestoreService();
-
-        const createdDeal = await firestoreService.createDealTokenSwap(registrationData);
+        const dealService = E2eDealsApi.getDealService();
+
+        /**
+         * Have to use `@ts-ignore`, because we cannot import `DealService` in cypress.
+         * Cannot import, because of bundling issues (bundling does not support importing Aurelia code)
+         */
+        // @ts-ignore
+        await dealService.ensureInitialized();
+        // @ts-ignore
+        const createdDeal = await dealService.createDeal(registrationData) as IDealTokenSwapDocument;
 
         E2eDeals.setDeal(createdDeal);
 

cypress/plugins/index.js

@@ -64,4 +64,7 @@ module.exports = (on, config) => {
       ]
     }
   }));
+
+  require('@cypress/code-coverage/task')(on, config)
+  return config
 };

cypress/support/index.js

@@ -16,6 +16,8 @@
 // Import commands.js using ES2015 syntax:
 import './commands';
 
+import '@cypress/code-coverage/support'
+
 // Alternatively you can use CommonJS syntax:
 // require('./commands');