Adds e2e readme and new endpoint env var (#314)

.env.example

@@ -1,7 +1,10 @@
-# These options are only needed when if running end to end tests locally
 PORTAL_RUNNER_USERNAME=
 PORTAL_RUNNER_PASSWORD=
 PORTAL_RUNNER_SUBSCRIPTION=
 PORTAL_RUNNER_RESOURCE_GROUP=
 PORTAL_RUNNER_DATABASE_ACCOUNT=
 PORTAL_RUNNER_CONNECTION_STRING=
+CASSANDRA_CONNECTION_STRING=
+MONGO_CONNECTION_STRING=
+TABLES_CONNECTION_STRING=
+DATA_EXPLORER_ENDPOINT=https://localhost:1234/hostedExplorer.html

.github/workflows/ci.yml

@@ -151,6 +151,7 @@ jobs:
           MONGO_CONNECTION_STRING: ${{ secrets.CONNECTION_STRING_MONGO }}
           CASSANDRA_CONNECTION_STRING: ${{ secrets.CONNECTION_STRING_CASSANDRA }}
           TABLES_CONNECTION_STRING: ${{ secrets.CONNECTION_STRING_TABLE }}
+          DATA_EXPLORER_ENDPOINT: "https://localhost:1234/hostedExplorer.html"
       - uses: actions/upload-artifact@v2
         with:
           name: screenshots

README.md

@@ -33,7 +33,7 @@ To run pure hosted mode, in `webpack.config.js` change index HtmlWebpackPlugin t
 
 ### Emulator Development
 
-In a window environment, running `npm run build` will automatically copy the built files from `/dist` over to the default emulator install paths. In a non-windows enironment you can specify an alternate endpoint using `EMULATOR_ENDPOINT` and webpack dev server will proxy requests for you.
+In a window environment, running `npm run build` will automatically copy the built files from `/dist` over to the default emulator install paths. In a non-windows environment you can specify an alternate endpoint using `EMULATOR_ENDPOINT` and webpack dev server will proxy requests for you.
 
 `PLATFORM=Emulator EMULATOR_ENDPOINT=https://my-vm.azure.com:8081 npm run watch`
 
@@ -60,7 +60,7 @@ The Cosmos Portal that consumes this repo is not currently open source. If you h
 You can however load a local running instance of data explorer in the production portal.
 
 1. Turn off browser SSL validation for localhost: chrome://flags/#allow-insecure-localhost OR Install valid SSL certs for localhost (on IE, follow these [instructions](https://www.technipages.com/ie-bypass-problem-with-this-websites-security-certificate) to install the localhost certificate in the right place)
-2. Whitelist `https://localhost:1234` domain for CORS in the Azure Cosmos DB portal
+2. Allowlist `https://localhost:1234` domain for CORS in the Azure Cosmos DB portal
 3. Start the project in portal mode: `PLATFORM=Portal npm run watch`
 4. Load the portal using the following link: https://ms.portal.azure.com/?dataExplorerSource=https%3A%2F%2Flocalhost%3A1234%2Fexplorer.html
 
@@ -84,16 +84,19 @@ Unit tests are located adjacent to the code under test and run with [Jest](https
 4. Install dependencies: `npm install`
 5. Run cypress headless(`npm run test`) or in interactive mode(`npm run test:debug`)
 
-#### End to End Production Runners
+#### End to End Production Tests
 
 Jest and Puppeteer are used for end to end production runners and are contained in `test/`. To run these tests locally:
 
-1. Copy .env.example to .env and fill in all variables
-2. Run `npm run test:e2e`
+1. Copy .env.example to .env
+2. Update the values in .env including your local data explorer endpoint (ask a teammate/codeowner for help with .env values)
+3. Make sure all packages are installed `npm install`
+4. Run the server `npm run start` and wait for it to start
+5. Run `npm run test:e2e`
 
 ### Releasing
 
-We generally adhear to the release strategy [documented by the Azure SDK Guidelines](https://azure.github.io/azure-sdk/policies_repobranching.html#release-branches). Most releases should happen from the master branch. If master contains commits that cannot be released, you may create a release from a `release/` or `hotfix/` branch. See linked documentation for more details.
+We generally adhere to the release strategy [documented by the Azure SDK Guidelines](https://azure.github.io/azure-sdk/policies_repobranching.html#release-branches). Most releases should happen from the master branch. If master contains commits that cannot be released, you may create a release from a `release/` or `hotfix/` branch. See linked documentation for more details.
 
 # Contributing
 

test/utils/shared.ts

@@ -2,7 +2,7 @@ import crypto from "crypto";
 import { Frame } from "puppeteer";
 
 export async function login(connectionString: string): Promise<Frame> {
-  const prodUrl = "https://localhost:1234/hostedExplorer.html";
+  const prodUrl = process.env.DATA_EXPLORER_ENDPOINT;
   page.goto(prodUrl, { waitUntil: "networkidle2" });
 
   // log in with connection string