feat: add support for fixtures in cypress

* Bump Cypress to 7.1.0
* Bump MongoDB to 3.6.6
* Split helpers for unit testing to import only database helpers for Cypress

Author: amille44420

.env.test

@@ -2,6 +2,9 @@
 APP_DB_URI="mongodb://root:password@127.0.0.1:27017"
 APP_DB_NAME="test"
 
+# smtp settings
+APP_SMTP_PORT=1025
+
 # session settings
 APP_SESSION_SECRET=localSecret
 
@@ -11,4 +14,4 @@ APP_STORAGE_PORT=9000
 APP_STORAGE_SSL=false
 APP_STORAGE_ACCESS_KEY="AKIAIOSFODNN7EXAMPLE"
 APP_STORAGE_SECRET_KEY="wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
-APP_STORAGE_BUKCET_TEST=app-test
+APP_STORAGE_BUCKET=app-test

cypress/plugins/index.ts

@@ -1,12 +1,42 @@
 /// <reference types="cypress" />
+import fs from 'fs';
 import path from 'path';
 import loadEnvConfig from '../../devtools/env';
+import { cleanDatabase, setupDatabase, loadFixtures } from '../../src/__tests__/helpers/database';
+import PluginEvents = Cypress.PluginEvents;
+import PluginConfigOptions = Cypress.PluginConfigOptions;
+
+const cypressDir = path.resolve(__dirname, '..');
+const fixtureDir = path.resolve(cypressDir, 'fixtures');
+const rootDir = path.resolve(cypressDir, '..');
 
 /**
  * @type {Cypress.PluginConfig}
  */
-module.exports = (on, config) => {
-    const dir = path.resolve(__dirname, '../..');
+module.exports = (on: PluginEvents, config: PluginConfigOptions) => {
+    // setup the environment
+    loadEnvConfig(rootDir, true, true);
+
+    on('task', {
+        async setupDatabase(fixtures = []) {
+            await cleanDatabase();
+            await setupDatabase();
+
+            if (fixtures.length) {
+                const data = fixtures.map(name => {
+                    const fixturePath = path.resolve(fixtureDir, `${name}.json`);
+
+                    if (!fs.existsSync(fixturePath)) {
+                        throw new Error(`Fixture "${name}" not found`);
+                    }
+
+                    const raw = fs.readFileSync(fixturePath, 'utf8');
+
+                    return JSON.parse(raw);
+                });
 
-    loadEnvConfig(dir, true, true);
+                await loadFixtures(data);
+            }
+        },
+    });
 };

jest.config.js

@@ -6,7 +6,7 @@ module.exports = {
 
     testMatch: ['<rootDir>/src/**/__tests__/**/*.{js,ts,tsx}'],
     testEnvironment: 'node',
-    testPathIgnorePatterns: ['<rootDir>/node_modules/', '<rootDir>/src/__tests__/helpers.ts'],
+    testPathIgnorePatterns: ['<rootDir>/node_modules/', '<rootDir>/src/__tests__/helpers/'],
 
     setupFilesAfterEnv: ['<rootDir>/jest.setup.ts'],
 

package.json

@@ -68,7 +68,7 @@
         "@types/minio": "^7.0.7",
         "@types/mjml": "^4.7.0",
         "@types/mjml-react": "^1.0.6",
-        "@types/mongodb": "^3.6.11",
+        "@types/mongodb": "^3.6.12",
         "@types/node": "^14.14.34",
         "@types/node-fetch": "^2.5.8",
         "@types/nodemailer": "^6.4.1",
@@ -89,7 +89,7 @@
         "babel-plugin-transform-react-remove-prop-types": "^0.4.24",
         "copy-webpack-plugin": "^8.0.0",
         "css-loader": "^5.2.0",
-        "cypress": "^6.6.0",
+        "cypress": "^7.1.0",
         "dotenv": "^8.2.0",
         "dotenv-expand": "^5.1.0",
         "enquirer": "^2.3.6",
@@ -172,7 +172,7 @@
         "minio": "^7.0.18",
         "mjml": "^4.8.1",
         "mjml-react": "^1.2.0",
-        "mongodb": "^3.6.4",
+        "mongodb": "^3.6.6",
         "node-fetch": "^2.6.1",
         "nodemailer": "^6.5.0",
         "rate-limiter-flexible": "^2.2.1",

src/__tests__/helpers.ts

@@ -0,0 +1,69 @@
+import { createReadStream } from 'fs';
+import { ApolloClient, ApolloLink, from, InMemoryCache, NormalizedCacheObject } from '@apollo/client';
+import { createUploadLink } from 'apollo-upload-client';
+import Blob from 'fetch-blob';
+import FormData from 'form-data';
+import NodeFormData from 'formdata-node';
+import nodeFetch from 'node-fetch';
+
+export type ApolloClientOptions = { authorizationToken?: string; language?: string };
+
+export const getApolloClient = (uri: string, options?: ApolloClientOptions): ApolloClient<NormalizedCacheObject> => {
+    const authLink = new ApolloLink((operation, forward) => {
+        operation.setContext(({ headers }) => {
+            const customHeaders = { ...headers };
+
+            if (options?.language) {
+                customHeaders['Accept-Language'] = options?.language;
+            }
+
+            if (options?.authorizationToken) {
+                customHeaders.Authorization = `Bearer ${options?.authorizationToken}`;
+            }
+
+            return {
+                headers: customHeaders,
+            };
+        });
+
+        return forward(operation);
+    });
+
+    const httpLink = createUploadLink({
+        uri: `${uri}/graphql`,
+        FormData: NodeFormData,
+        fetch: async (url, options) => {
+            const nextOptions = { ...options };
+
+            if (options?.body instanceof NodeFormData) {
+                // formdata-node is not fully supported by node-fetch
+                // at least on the v2.6.x (maybe on v3)
+                // therefore we are going to copy the entries to form-data instead
+                // we cannot directly use form-data for graphql-upload because it doesn't support node streams
+                const formData = options?.body as NodeFormData;
+                const nextFormData = new FormData();
+
+                // @ts-ignore
+                for (const [field, value] of formData.entries()) {
+                    const blob = value?.__content;
+
+                    if (blob instanceof Blob) {
+                        // @ts-ignore
+                        nextFormData.append(field, createReadStream(blob.__filePath));
+                    } else {
+                        nextFormData.append(field, value);
+                    }
+
+                    nextOptions.body = nextFormData;
+                }
+            }
+
+            return nodeFetch(url, nextOptions);
+        },
+    });
+
+    return new ApolloClient({
+        link: from([authLink, httpLink]),
+        cache: new InMemoryCache(),
+    });
+};