@commercetools-frontend/cypress-environments 0.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) commercetools GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,97 @@
+# @commercetools-frontend/cypress-environments
+
+> This package allows to load environment variables into a Cypress environment from [dotenv](https://github.com/motdotla/dotenv) files.
+
+## Installation
+
+```bash
+$ npm install --save @commercetools-frontend/cypress-environments
+```
+
+## Usage
+
+Inside of your `cypress.config.js` import the package as follows:
+
+```js
+const {
+  getConfigurationForEnvironment,
+} = require('@commercetools-frontend/cypress-environments');
+```
+
+Then inside your `e2e.setupNodeEvents` in Cypress v10.x load the configuration by calling `await getConfigurationForEnvironment(environment)`.
+
+This will return an object with the merged configuration based on the requested environment.
+
+## Adding a configuration file
+
+This module uses [cosmiconfig](https://github.com/davidtheclark/cosmiconfig) to load a configuration file named `cypress-environments`. As a result it supports many formats such as `cypress-environments.config.cjs` or `cypress-environments.rc.json` depending on your preference.
+
+Within the configuration file an array `environments` property should be defined containing a set of environments with `name`, `secrets` and `config` globs.
+
+The contents of the configuration file could look like:
+
+```js
+const projectKeys = {
+  gcpEu: 'ctp-gcp-production-eu',
+};
+
+module.exports = {
+  environments: [
+    {
+      name: projectKeys.gcpEu,
+      secrets: `cypress/config/${projectKeys.gcpEu}/.env.secrets*`,
+      config: `cypress/config/${projectKeys.gcpEu}/.env.config*`,
+    },
+  ],
+};
+```
+
+From here the documentation assumes the above format and naming for further examples.
+
+## Adding environment configurations
+
+The package expects configurations for environments to be stored in `cypress/config/<environment_name>`. For example this structure:
+
+```txt
+cypress/config
+├── ctp-gcp-production-eu
+|──── .env.config
+|──── .env.secrets.ci (Decrypred from `*.enc`)
+|──── .env.config.local.template
+|──── .env.secrets.local.template
+├── ctp-aws-production-fra
+└── ctp-vw-production-eu
+```
+
+Would load the values from `.env.config` anytime the environment is `ctp-gcp-production-eu`. Additionally on CI (when `CI=true`) it would load the `.env.secrets.ci` file, otherwise it would attempt to load values from `.env.config.local` and `.env.secrets.local` (assuming they have been properly configured - see `*.template` files for reference).
+
+Given multiple files can be loaded some values can be overwritten by a subsequently loaded file. First the `.env.config` file will be loaded. After the secrets from `.env.secrets` and then `.env.secrets.ci` or `.env.secrets.local` respectively. Any file loaded later can overwrite values of a file loaded before.
+
+## Provided configuration values
+
+The module provides default values for `ctp-aws-production-fra`, `ctp-gcp-production-eu`, `ctp-gcp-production-us` and `ctp-gcp-production-au`. These values will be loaded first before any custom configuration. These default configurations contain the `API_URL`, `MC_API_URL`, `MC_URL` and `AUTH_URL` for the given environment.
+
+## Troubleshooting
+
+### Configuration does not load as expected
+
+Inspect the logs of the module to inspect which files match the globs. This output could be:
+
+```bash
+ℹ️  'CI' environment variables are defined. Assuming operating from a CI system.
+ℹ️  Found 1 secret file(s) and 1 config file(s) matching the defined globs.
+✅ Found and loading environment variables from: 'cypress/config/ctp-gcp-production-eu/.env.config'
+ℹ️  No environment variables at: 'cypress/config/ctp-gcp-production-eu/.env.config.ci'. If needed create it or duplicate the template file.
+✅ Found and loading environment variables from: 'cypress/config/ctp-gcp-production-eu/.env.secrets.ci'
+✅ Found and loading environment variables from: '/Users/<username>/merchant-center-frontend/packages-cypress/environments/src/config/.env.ctp-gcp-production-eu.config'
+```
+
+Verify that the files are loaded as expected and make sure they exist.
+
+### Secrets are not loaded
+
+Make sure the secrets are decrypted on CI from the `*.enc` or locally a `*.template` file for the secrets has been duplicated and filled.
+
+### Local configuration and secrets are loaded on CI
+
+Ensure that the `CI` environment variable is set. Most CI providers set it by default but you can also pass it to the command when running Cypress.

package/dist/commercetools-frontend-cypress-environments.cjs.dev.js

@@ -0,0 +1,108 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var path = require('path');
+var fs = require('fs');
+var url = require('url');
+var util = require('util');
+var glob = require('glob');
+var dotenv = require('dotenv');
+var cosmiconfig = require('cosmiconfig');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
+
+var path__default = /*#__PURE__*/_interopDefault(path);
+var fs__default = /*#__PURE__*/_interopDefault(fs);
+var url__default = /*#__PURE__*/_interopDefault(url);
+var glob__default = /*#__PURE__*/_interopDefault(glob);
+var dotenv__default = /*#__PURE__*/_interopDefault(dotenv);
+
+const cypressEnvironmentsConfigExplorer = cosmiconfig.cosmiconfig('cypress-environments');
+const isCI = process.env.CI === true || process.env.CI === 'true';
+const promisifiedGlob = util.promisify(glob__default["default"]);
+
+const __dirname$1 = path__default["default"].dirname(url__default["default"].fileURLToPath((typeof document === 'undefined' ? new (require('u' + 'rl').URL)('file:' + __filename).href : (document.currentScript && document.currentScript.src || new URL('dist/commercetools-frontend-cypress-environments.cjs.dev.js', document.baseURI).href))));
+
+function getParsedEnvFileContents(envPath) {
+  if (fs__default["default"].existsSync(envPath)) {
+    console.log(`✅ Found and loading environment variables from: '${envPath}'`);
+    const envFileContents = fs__default["default"].readFileSync(envPath, {
+      encoding: 'utf8'
+    });
+    const configuration = dotenv__default["default"].parse(envFileContents);
+    return configuration;
+  } else {
+    console.log(`ℹ️  No environment variables at: '${envPath}'. If needed create it or duplicate the template file.`);
+    return null;
+  }
+}
+
+async function loadConfig() {
+  try {
+    return await cypressEnvironmentsConfigExplorer.search();
+  } catch (e) {
+    throw new Error(`Failed loading a Cypress environments configuration. Create a cosmiconfig for 'cypress-environments' for example 'cypress-environments.config.cjs'.`);
+  }
+}
+
+async function getConfigurationForEnvironment(environmentName) {
+  if (isCI) {
+    console.log(`ℹ️  'CI' environment variables are defined. Assuming operating from a CI system.`);
+  } else {
+    console.log(`ℹ️  'CI' environment variables are not defined. Assuming you are running locally.`);
+  } // NOTE: On CI the *.ci secrests are not excluded. Locally the are in case
+  // decrypted files are available on a developer's machine.
+
+
+  const ignoredGlobs = ['**/*.enc', '**/*.template', !isCI && '**/*.ci'].filter(Boolean);
+  const {
+    config: allEnvironmentConfigs
+  } = await loadConfig();
+  const configForEnvironment = allEnvironmentConfigs.environments.find(environment => environment.name === environmentName);
+
+  if (!configForEnvironment) {
+    throw new Error(`No configuration for ${environmentName} defined in cosmiconfig for 'cypress-environments'. Please make sure it exists.`);
+  }
+
+  const secretsFiles = await promisifiedGlob(configForEnvironment.secrets.glob, {
+    ignore: ignoredGlobs
+  });
+  const configFiles = await promisifiedGlob(configForEnvironment.config.glob, {
+    ignore: ignoredGlobs
+  });
+  console.log(`ℹ️  Found ${secretsFiles.length} secret file(s) and ${configFiles.length} config file(s) matching the defined globs.`);
+
+  if (secretsFiles.length === 0 || configFiles.length === 0) {
+    console.log(`ℹ️  Secrets files glob is: ${configForEnvironment.secrets.glob}`);
+    console.log(`ℹ️  Config files glob is: ${configForEnvironment.config.glob}`);
+  }
+
+  const mergedConfigurationAndSecrests = [...configFiles, ...secretsFiles].reduce((previousParsedEnvFileContents, nextEnvFilePath) => {
+    const parsedEnvFileContents = getParsedEnvFileContents(nextEnvFilePath);
+    let matchingParsedEnvFileContentsForCIOrLocal = {};
+
+    if (!nextEnvFilePath.endsWith('.local') && !nextEnvFilePath.endsWith('.ci')) {
+      matchingParsedEnvFileContentsForCIOrLocal = isCI ? getParsedEnvFileContents(`${nextEnvFilePath}.ci`) : getParsedEnvFileContents(`${nextEnvFilePath}.local`);
+    }
+
+    return { ...previousParsedEnvFileContents,
+      ...parsedEnvFileContents,
+      ...matchingParsedEnvFileContentsForCIOrLocal
+    };
+  }, {});
+  const pathToSharedEnvironmentConfiguration = path__default["default"].join(__dirname$1, 'config', `.env.${environmentName}.config`);
+  let sharedEnvironmentConfiguration = null;
+
+  if (fs__default["default"].existsSync(pathToSharedEnvironmentConfiguration)) {
+    sharedEnvironmentConfiguration = getParsedEnvFileContents(pathToSharedEnvironmentConfiguration);
+  } else {
+    console.log(`ℹ️  Not shared configuration for ${environmentName} defined.`);
+  }
+
+  return { ...sharedEnvironmentConfiguration,
+    ...mergedConfigurationAndSecrests
+  };
+}
+
+exports.getConfigurationForEnvironment = getConfigurationForEnvironment;

package/dist/commercetools-frontend-cypress-environments.cjs.js

@@ -0,0 +1,7 @@
+'use strict';
+
+if (process.env.NODE_ENV === "production") {
+  module.exports = require("./commercetools-frontend-cypress-environments.cjs.prod.js");
+} else {
+  module.exports = require("./commercetools-frontend-cypress-environments.cjs.dev.js");
+}

package/dist/commercetools-frontend-cypress-environments.cjs.prod.js

@@ -0,0 +1,108 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var path = require('path');
+var fs = require('fs');
+var url = require('url');
+var util = require('util');
+var glob = require('glob');
+var dotenv = require('dotenv');
+var cosmiconfig = require('cosmiconfig');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
+
+var path__default = /*#__PURE__*/_interopDefault(path);
+var fs__default = /*#__PURE__*/_interopDefault(fs);
+var url__default = /*#__PURE__*/_interopDefault(url);
+var glob__default = /*#__PURE__*/_interopDefault(glob);
+var dotenv__default = /*#__PURE__*/_interopDefault(dotenv);
+
+const cypressEnvironmentsConfigExplorer = cosmiconfig.cosmiconfig('cypress-environments');
+const isCI = process.env.CI === true || process.env.CI === 'true';
+const promisifiedGlob = util.promisify(glob__default["default"]);
+
+const __dirname$1 = path__default["default"].dirname(url__default["default"].fileURLToPath((typeof document === 'undefined' ? new (require('u' + 'rl').URL)('file:' + __filename).href : (document.currentScript && document.currentScript.src || new URL('dist/commercetools-frontend-cypress-environments.cjs.prod.js', document.baseURI).href))));
+
+function getParsedEnvFileContents(envPath) {
+  if (fs__default["default"].existsSync(envPath)) {
+    console.log(`✅ Found and loading environment variables from: '${envPath}'`);
+    const envFileContents = fs__default["default"].readFileSync(envPath, {
+      encoding: 'utf8'
+    });
+    const configuration = dotenv__default["default"].parse(envFileContents);
+    return configuration;
+  } else {
+    console.log(`ℹ️  No environment variables at: '${envPath}'. If needed create it or duplicate the template file.`);
+    return null;
+  }
+}
+
+async function loadConfig() {
+  try {
+    return await cypressEnvironmentsConfigExplorer.search();
+  } catch (e) {
+    throw new Error(`Failed loading a Cypress environments configuration. Create a cosmiconfig for 'cypress-environments' for example 'cypress-environments.config.cjs'.`);
+  }
+}
+
+async function getConfigurationForEnvironment(environmentName) {
+  if (isCI) {
+    console.log(`ℹ️  'CI' environment variables are defined. Assuming operating from a CI system.`);
+  } else {
+    console.log(`ℹ️  'CI' environment variables are not defined. Assuming you are running locally.`);
+  } // NOTE: On CI the *.ci secrests are not excluded. Locally the are in case
+  // decrypted files are available on a developer's machine.
+
+
+  const ignoredGlobs = ['**/*.enc', '**/*.template', !isCI && '**/*.ci'].filter(Boolean);
+  const {
+    config: allEnvironmentConfigs
+  } = await loadConfig();
+  const configForEnvironment = allEnvironmentConfigs.environments.find(environment => environment.name === environmentName);
+
+  if (!configForEnvironment) {
+    throw new Error(`No configuration for ${environmentName} defined in cosmiconfig for 'cypress-environments'. Please make sure it exists.`);
+  }
+
+  const secretsFiles = await promisifiedGlob(configForEnvironment.secrets.glob, {
+    ignore: ignoredGlobs
+  });
+  const configFiles = await promisifiedGlob(configForEnvironment.config.glob, {
+    ignore: ignoredGlobs
+  });
+  console.log(`ℹ️  Found ${secretsFiles.length} secret file(s) and ${configFiles.length} config file(s) matching the defined globs.`);
+
+  if (secretsFiles.length === 0 || configFiles.length === 0) {
+    console.log(`ℹ️  Secrets files glob is: ${configForEnvironment.secrets.glob}`);
+    console.log(`ℹ️  Config files glob is: ${configForEnvironment.config.glob}`);
+  }
+
+  const mergedConfigurationAndSecrests = [...configFiles, ...secretsFiles].reduce((previousParsedEnvFileContents, nextEnvFilePath) => {
+    const parsedEnvFileContents = getParsedEnvFileContents(nextEnvFilePath);
+    let matchingParsedEnvFileContentsForCIOrLocal = {};
+
+    if (!nextEnvFilePath.endsWith('.local') && !nextEnvFilePath.endsWith('.ci')) {
+      matchingParsedEnvFileContentsForCIOrLocal = isCI ? getParsedEnvFileContents(`${nextEnvFilePath}.ci`) : getParsedEnvFileContents(`${nextEnvFilePath}.local`);
+    }
+
+    return { ...previousParsedEnvFileContents,
+      ...parsedEnvFileContents,
+      ...matchingParsedEnvFileContentsForCIOrLocal
+    };
+  }, {});
+  const pathToSharedEnvironmentConfiguration = path__default["default"].join(__dirname$1, 'config', `.env.${environmentName}.config`);
+  let sharedEnvironmentConfiguration = null;
+
+  if (fs__default["default"].existsSync(pathToSharedEnvironmentConfiguration)) {
+    sharedEnvironmentConfiguration = getParsedEnvFileContents(pathToSharedEnvironmentConfiguration);
+  } else {
+    console.log(`ℹ️  Not shared configuration for ${environmentName} defined.`);
+  }
+
+  return { ...sharedEnvironmentConfiguration,
+    ...mergedConfigurationAndSecrests
+  };
+}
+
+exports.getConfigurationForEnvironment = getConfigurationForEnvironment;

package/dist/commercetools-frontend-cypress-environments.esm.js

@@ -0,0 +1,96 @@
+import path from 'path';
+import fs from 'fs';
+import url from 'url';
+import { promisify } from 'util';
+import glob from 'glob';
+import dotenv from 'dotenv';
+import { cosmiconfig } from 'cosmiconfig';
+
+const cypressEnvironmentsConfigExplorer = cosmiconfig('cypress-environments');
+const isCI = process.env.CI === true || process.env.CI === 'true';
+const promisifiedGlob = promisify(glob);
+
+const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
+
+function getParsedEnvFileContents(envPath) {
+  if (fs.existsSync(envPath)) {
+    console.log(`✅ Found and loading environment variables from: '${envPath}'`);
+    const envFileContents = fs.readFileSync(envPath, {
+      encoding: 'utf8'
+    });
+    const configuration = dotenv.parse(envFileContents);
+    return configuration;
+  } else {
+    console.log(`ℹ️  No environment variables at: '${envPath}'. If needed create it or duplicate the template file.`);
+    return null;
+  }
+}
+
+async function loadConfig() {
+  try {
+    return await cypressEnvironmentsConfigExplorer.search();
+  } catch (e) {
+    throw new Error(`Failed loading a Cypress environments configuration. Create a cosmiconfig for 'cypress-environments' for example 'cypress-environments.config.cjs'.`);
+  }
+}
+
+async function getConfigurationForEnvironment(environmentName) {
+  if (isCI) {
+    console.log(`ℹ️  'CI' environment variables are defined. Assuming operating from a CI system.`);
+  } else {
+    console.log(`ℹ️  'CI' environment variables are not defined. Assuming you are running locally.`);
+  } // NOTE: On CI the *.ci secrests are not excluded. Locally the are in case
+  // decrypted files are available on a developer's machine.
+
+
+  const ignoredGlobs = ['**/*.enc', '**/*.template', !isCI && '**/*.ci'].filter(Boolean);
+  const {
+    config: allEnvironmentConfigs
+  } = await loadConfig();
+  const configForEnvironment = allEnvironmentConfigs.environments.find(environment => environment.name === environmentName);
+
+  if (!configForEnvironment) {
+    throw new Error(`No configuration for ${environmentName} defined in cosmiconfig for 'cypress-environments'. Please make sure it exists.`);
+  }
+
+  const secretsFiles = await promisifiedGlob(configForEnvironment.secrets.glob, {
+    ignore: ignoredGlobs
+  });
+  const configFiles = await promisifiedGlob(configForEnvironment.config.glob, {
+    ignore: ignoredGlobs
+  });
+  console.log(`ℹ️  Found ${secretsFiles.length} secret file(s) and ${configFiles.length} config file(s) matching the defined globs.`);
+
+  if (secretsFiles.length === 0 || configFiles.length === 0) {
+    console.log(`ℹ️  Secrets files glob is: ${configForEnvironment.secrets.glob}`);
+    console.log(`ℹ️  Config files glob is: ${configForEnvironment.config.glob}`);
+  }
+
+  const mergedConfigurationAndSecrests = [...configFiles, ...secretsFiles].reduce((previousParsedEnvFileContents, nextEnvFilePath) => {
+    const parsedEnvFileContents = getParsedEnvFileContents(nextEnvFilePath);
+    let matchingParsedEnvFileContentsForCIOrLocal = {};
+
+    if (!nextEnvFilePath.endsWith('.local') && !nextEnvFilePath.endsWith('.ci')) {
+      matchingParsedEnvFileContentsForCIOrLocal = isCI ? getParsedEnvFileContents(`${nextEnvFilePath}.ci`) : getParsedEnvFileContents(`${nextEnvFilePath}.local`);
+    }
+
+    return { ...previousParsedEnvFileContents,
+      ...parsedEnvFileContents,
+      ...matchingParsedEnvFileContentsForCIOrLocal
+    };
+  }, {});
+  const pathToSharedEnvironmentConfiguration = path.join(__dirname, 'config', `.env.${environmentName}.config`);
+  let sharedEnvironmentConfiguration = null;
+
+  if (fs.existsSync(pathToSharedEnvironmentConfiguration)) {
+    sharedEnvironmentConfiguration = getParsedEnvFileContents(pathToSharedEnvironmentConfiguration);
+  } else {
+    console.log(`ℹ️  Not shared configuration for ${environmentName} defined.`);
+  }
+
+  return { ...sharedEnvironmentConfiguration,
+    ...mergedConfigurationAndSecrests
+  };
+}
+
+export { getConfigurationForEnvironment };

package/dist/config/.env.ctp-aws-production-fra.config

@@ -0,0 +1,4 @@
+API_URL=https://api.eu-central-1.aws.commercetools.com
+MC_API_URL=https://mc-api.eu-central-1.aws.commercetools.com
+MC_URL=https://mc-api.eu-central-1.aws.commercetools.com
+AUTH_URL=https://auth.eu-central-1.aws.commercetools.com

package/dist/config/.env.ctp-gcp-production-au.config

@@ -0,0 +1,5 @@
+API_URL=https://api.australia-southeast1.gcp.commercetools.com
+MC_API_URL=https://mc-api.australia-southeast1.gcp.escemo.com
+MC_URL=https://mc.australia-southeast1.gcp.escemo.com
+AUTH_URL=https://auth.australia-southeast1.gcp.commercetools.com
+

package/dist/config/.env.ctp-gcp-production-eu.config

@@ -0,0 +1,5 @@
+API_URL=https://api.europe-west1.gcp.commercetools.com
+MC_API_URL=https://mc-api.europe-west1.gcp.escemo.com
+MC_URL=https://mc.europe-west1.gcp.escemo.com
+AUTH_URL=https://auth.europe-west1.gcp.commercetools.com
+

package/dist/config/.env.ctp-gcp-production-us.config

@@ -0,0 +1,5 @@
+API_URL=https://api.us-central1.gcp.commercetools.com
+MC_API_URL=https://mc-api.us-central1.gcp.escemo.com
+MC_URL=https://mc.us-central1.gcp.escemo.com
+AUTH_URL=https://auth.us-central1.gcp.commercetools.com
+

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@commercetools-frontend/cypress-environments",
+  "version": "0.0.0",
+  "description": "Cypress package to setup environment configuration using dotenv files",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "prepublish": "cp -R src/config dist/config"
+  },
+  "main": "dist/commercetools-frontend-cypress-environments.cjs.js",
+  "module": "dist/commercetools-frontend-cypress-environments.esm.js",
+  "preconstruct": {
+    "entrypoints": [
+      "./index.js"
+    ]
+  },
+  "files": [
+    "dist",
+    "package.json",
+    "LICENSE",
+    "README.md"
+  ],
+  "dependencies": {
+    "cosmiconfig": "7.0.1",
+    "dotenv": "16.0.2",
+    "glob": "8.0.3"
+  },
+  "engines": {
+    "node": ">=14",
+    "npm": ">=5"
+  }
+}