v0.0.8 (#4)

* feat(core): add support for `test/ui` fallback folder
* feat(docs): add note about fallback folders for config (`test/e2e` and `test/ui`)

Author: prescottprue

README.md

@@ -8,11 +8,10 @@
 > Utilities and cli to help testing Firebase projects with Cypress
 
 ## What?
-* Test environment config generation (including custom auth token) with [`createTestEnvFile`](#createTestEnvFile):
-    
-    `cypress-firebase createTestEnvFile`
+
+* Test environment config generation (including custom auth token) with [`createTestEnvFile`](#createTestEnvFile)
 * [Custom cypress commands](https://docs.cypress.io/api/cypress-api/custom-commands.html#Syntax) for auth and database interactions:
-  * [`cy.login`][1]
+  * [cy.login][1]
   * [cy.logout][4]
   * [cy.callRtdb][6]
   * [cy.callFirestore][9]
@@ -33,6 +32,8 @@ If you are intereted in what drove the need for this checkout [the why section](
 
 ### Setup
 
+**Note:** These instructions assume your tests are in the `cypress` folder (cypress' default). See the [folders section below](#folders) for more info about other supported folders.
+
 1. Make sure you have `firebase-tools` installed (globally or within project). It is used to call to database when using `cy.callRtdb` and `cy.callFirestore`.
 1. Install using `npm i cypress-firebase --save-dev`
 1. Add the following to the `scripts` section of your `package.json`:
@@ -53,6 +54,7 @@ If you are intereted in what drove the need for this checkout [the why section](
       "FIREBASE_PROJECT_ID": "<- projectId of your project ->"
     }
     ```
+
 1. Add the following your custom commands file (`cypress/support/commands.js`):
 
     ```js
@@ -91,11 +93,6 @@ If you are intereted in what drove the need for this checkout [the why section](
 1. Start your local dev server (usually `npm start`) - for faster alternative checkout the [test built version section](#test-built-version)
 1. Open cypress test running by running `npm run test:open` in another terminal window
 
-### CI
-
-1. Run `firebase login:ci` to generate a CI token for `firebase-tools` (this will give your `cy.callRtdb` and `cy.callFirestore` commands admin access to the DB)
-1. Set `FIREBASE_TOKEN` within CI environment variables
-
 #### Test Built Version
 
 Tests will run faster locally if you tests against the build version of your app instead of your dev version (with hot module reloading and other dev tools). You can do that by:
@@ -108,11 +105,26 @@ Tests will run faster locally if you tests against the build version of your app
 1. Run `npm run start:dist` to build your app and serve it with firebase
 1. In another terminal window, run a test command such as `npm run test:open`
 
+### CI
+
+1. Run `firebase login:ci` to generate a CI token for `firebase-tools` (this will give your `cy.callRtdb` and `cy.callFirestore` commands admin access to the DB)
+1. Set `FIREBASE_TOKEN` within CI environment variables
+
+### Folders
+
+`cypress` is the default folder where config is loaded from, but these other common folders are supported:
+
+  ```
+  test/ui
+  test/e2e
+  ```
+
 ## Docs
 
 ### CLI Commands
 
 #### createTestEnvFile {#createTestEnvFile}
+
 Create test environment file (`cypress.env.json`) which contains custom auth token generated using `firebase-admin` SDK and `serviceAccount.json`.
 
 ##### Examples
@@ -244,6 +256,8 @@ cy.callFirestore('delete', 'project/test-project', opts)
 
 It isn't currenlty possible to use Firebase's `firebase-admin` SDK directly within Cypress due to dependencies not being able to be loaded into the Browser environment. Since `firebase-admin` is nessesary to generate custom token needed to login to Firebase, the usage of it happens outside of Cypress (through `cypress-firebase createTestEnvFile`) before booting up.
 
+Instead of a cli tool, the plugin that is include could maybe use `firebase-admin` (since cypress plugins is a node environment) - when investigating this, I found it frustrating to get the values back into the test. That said, always open to better ways of solving this, so please reach out with your ideas!
+
 ## Projects Using It
 
 [fireadmin.io][fireadmin-url] - A Firebase project management tool ([here is the source][fireadmin-source])

package.json

@@ -1,6 +1,6 @@
 {
   "name": "cypress-firebase",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "description": "Utilities to help testing firebase projects with cypress.",
   "main": "lib/index.js",
   "module": "lib/index.js",

src/constants.js

@@ -1,10 +1,11 @@
-export const DEFAULT_TEST_FOLDER_PATH = 'test/e2e';
-export const FALLBACK_TEST_FOLDER_PATH = 'cypress';
+export const DEFAULT_TEST_FOLDER_PATH = 'cypress';
+export const FALLBACK_TEST_FOLDER_PATH = 'test/ui';
+export const SECOND_FALLBACK_TEST_FOLDER_PATH = 'test/e2e';
 export const DEFAULT_SERVICE_ACCOUNT_PATH = 'serviceAccount.json';
 export const DEFAULT_TEST_ENV_FILE_NAME = 'cypress.env.json';
 export const DEFAULT_CONFIG_FILE_NAME = 'config.json';
 export const FIREBASE_TOOLS_BASE_COMMAND = 'npx firebase';
-// Path to Firebase Extra Command Line tool (wrapper for firebase-tools)
+// Path to firebase-tools-extra Command Line tool (wrapper for firebase-tools)
 export const FIREBASE_EXTRA_PATH = '$(npm bin)/firebase-extra';
 export const FIREBASE_TOOLS_YES_ARGUMENT = '-y';
 export const DEFAULT_BASE_PATH = process.cwd();

src/utils.js

@@ -5,7 +5,8 @@ import {
   DEFAULT_BASE_PATH,
   DEFAULT_TEST_FOLDER_PATH,
   FIREBASE_TOOLS_YES_ARGUMENT,
-  FALLBACK_TEST_FOLDER_PATH
+  FALLBACK_TEST_FOLDER_PATH,
+  SECOND_FALLBACK_TEST_FOLDER_PATH
 } from './constants';
 
 /**
@@ -74,27 +75,45 @@ export function envVarBasedOnCIEnv(varNameRoot) {
   const prefix = getEnvPrefix();
   const combined = `${prefix}${varNameRoot}`;
 
-  // Config file used for environment (local, containers)
+  // Config file used for environment (local, containers) from main test path (cypress/config.json)
   const localTestConfigPath = path.join(
-    process.cwd(),
+    DEFAULT_BASE_PATH,
     DEFAULT_TEST_FOLDER_PATH,
     'config.json'
   );
+
+  // Load test config from main test path (cypress/config.json)
   if (fs.existsSync(localTestConfigPath)) {
     const configObj = require(localTestConfigPath); // eslint-disable-line global-require, import/no-dynamic-require
     return configObj[combined] || configObj[varNameRoot];
   }
+
+  // Fallback Attempt for Config file (test/ui)
   const fallbackConfigPath = path.join(
-    process.cwd(),
+    DEFAULT_BASE_PATH,
     FALLBACK_TEST_FOLDER_PATH,
     'config.json'
   );
 
+  // Load config from the fallback path if it exists (test/ui)
   if (fs.existsSync(fallbackConfigPath)) {
     const configObj = require(fallbackConfigPath); // eslint-disable-line global-require, import/no-dynamic-require
     return configObj[combined] || configObj[varNameRoot];
   }
 
+  // Second Fallback Attempt for Config file (test/e2e)
+  const fallback2ConfigPath = path.join(
+    DEFAULT_BASE_PATH,
+    SECOND_FALLBACK_TEST_FOLDER_PATH,
+    'config.json'
+  );
+
+  // Load config from the fallback path if it exists (test/e2e)
+  if (fs.existsSync(fallback2ConfigPath)) {
+    const configObj = require(fallback2ConfigPath); // eslint-disable-line global-require, import/no-dynamic-require
+    return configObj[combined] || configObj[varNameRoot];
+  }
+
   // CI Environment (environment variables loaded directly)
   return process.env[combined] || process.env[varNameRoot];
 }
@@ -217,7 +236,9 @@ export function addDefaultArgs(Cypress, args, opts = {}) {
   // TODO: Load this in a way that understands environment. Currently this will
   // go to the first project id that is defined, not which one should be used
   // for the specified environment
-  const projectId = Cypress.env('firebaseProjectId') || Cypress.env('FIREBASE_PROJECT_ID') || Cypress.env('STAGE_FIREBASE_PROJECT_ID');
+  const projectId = Cypress.env('firebaseProjectId')
+    || Cypress.env('FIREBASE_PROJECT_ID')
+    || Cypress.env('STAGE_FIREBASE_PROJECT_ID');
   // Include project id command so command runs on the current project
   if (!newArgs.includes('-P') || !newArgs.includes(projectId)) {
     newArgs.push('-P');