test(cypress-github-backend): optionally record tests and run using recorded data (#2776)

cypress/plugins/index.js

@@ -11,105 +11,71 @@
 // This function is called when a project is opened or re-opened (e.g. due to
 // the project's config changing)
 require('dotenv').config();
-const fs = require('fs-extra');
-const path = require('path');
-const yaml = require('js-yaml');
-const {
-  prepareTestGitHubRepo,
-  deleteRepositories,
-  getUser,
-  getForkUser,
-  resetRepositories,
-} = require('./github');
-
-const devTestDirectory = path.join(__dirname, '..', '..', 'dev-test');
-const backendsDirectory = path.join(devTestDirectory, 'backends');
-
-async function copyBackendFiles(backend) {
-  for (let file of ['config.yml', 'index.html']) {
-    await fs.copyFile(
-      path.join(backendsDirectory, backend, file),
-      path.join(devTestDirectory, file),
-    );
-  }
-}
-
-async function updateConfig(configModifier) {
-  const configFile = path.join(devTestDirectory, 'config.yml');
-  const configContent = await fs.readFile(configFile);
-  const config = yaml.safeLoad(configContent);
-  await configModifier(config);
-  await fs.writeFileSync(configFile, yaml.safeDump(config));
-  return null;
-}
-
-async function setupGitHub() {
-  const [user, forkUser, repoData] = await Promise.all([
-    getUser(),
-    getForkUser(),
-    prepareTestGitHubRepo(),
-  ]);
-
-  await updateConfig(config => {
-    config.backend.repo = `${repoData.owner}/${repoData.repo}`;
-  });
-
-  return { ...repoData, user, forkUser };
-}
-
-async function teardownGitHub(taskData) {
-  await deleteRepositories(taskData);
-  return null;
-}
-
-async function teardownBackendTest(taskData) {
-  await resetRepositories(taskData);
-  return null;
-}
+const { setupGitHub, teardownGitHub, setupGitHubTest, teardownGitHubTest } = require('./github');
+const { copyBackendFiles } = require('../utils/config');
 
 module.exports = async on => {
   // `on` is used to hook into various events Cypress emits
   on('task', {
-    async setupBackend({ backend }) {
+    async setupBackend({ backend, options }) {
       console.log('Preparing environment for backend', backend);
       await copyBackendFiles(backend);
 
+      let result = null;
       if (backend === 'github') {
-        return await setupGitHub();
+        result = await setupGitHub(options);
       }
 
-      return null;
+      return result;
     },
     async teardownBackend(taskData) {
       const { backend } = taskData;
       console.log('Tearing down backend', backend);
+
       if (backend === 'github') {
-        return await teardownGitHub(taskData);
+        await teardownGitHub(taskData);
       }
 
-      return null;
-    },
-    async teardownBackendTest(taskData) {
-      const { backend } = taskData;
-      console.log('Tearing down single test for backend', backend);
-      if (backend === 'github') {
-        return await teardownBackendTest(taskData);
-      }
-    },
-    async updateBackendOptions({ backend, options }) {
-      console.log('Updating backend', backend, 'with options', options);
-      if (backend === 'github') {
-        return await updateConfig(config => {
-          config.backend = { ...config.backend, ...options };
-        });
-      }
-      return null;
-    },
-    async restoreDefaults() {
       console.log('Restoring defaults');
       await copyBackendFiles('test');
 
       return null;
     },
+    async setupBackendTest(taskData) {
+      const { backend, testName } = taskData;
+      console.log(`Setting up single test '${testName}' for backend`, backend);
+
+      if (backend === 'github') {
+        await setupGitHubTest(taskData);
+      }
+
+      return null;
+    },
+    async teardownBackendTest(taskData) {
+      const { backend, testName } = taskData;
+
+      console.log(`Tearing down single test '${testName}' for backend`, backend);
+
+      if (backend === 'github') {
+        await teardownGitHubTest(taskData);
+      }
+
+      return null;
+    },
+  });
+
+  // to allows usage of a mock proxy
+  on('before:browser:launch', (browser = {}, args) => {
+    if (browser.name === 'chrome') {
+      args.push('--ignore-certificate-errors');
+
+      return args;
+    }
+
+    if (browser.name === 'electron') {
+      args['ignore-certificate-errors'] = true;
+
+      return args;
+    }
   });
 };