chore: Document e2e test env vars (#12303)

Co-authored-by: Andrei <168741329+andreiborza@users.noreply.github.com>

Author: 2 people

.github/workflows/build.yml

@@ -983,7 +983,7 @@ jobs:
       PUBLIC_E2E_TEST_DSN: ${{ secrets.E2E_TEST_DSN }}
       REACT_APP_E2E_TEST_DSN: ${{ secrets.E2E_TEST_DSN }}
       E2E_TEST_SENTRY_ORG_SLUG: 'sentry-javascript-sdks'
-      E2E_TEST_SENTRY_TEST_PROJECT: 'sentry-javascript-e2e-tests'
+      E2E_TEST_SENTRY_PROJECT: 'sentry-javascript-e2e-tests'
     strategy:
       fail-fast: false
       matrix:
@@ -1132,7 +1132,7 @@ jobs:
       PUBLIC_E2E_TEST_DSN: ${{ secrets.E2E_TEST_DSN }}
       REACT_APP_E2E_TEST_DSN: ${{ secrets.E2E_TEST_DSN }}
       E2E_TEST_SENTRY_ORG_SLUG: 'sentry-javascript-sdks'
-      E2E_TEST_SENTRY_TEST_PROJECT: 'sentry-javascript-e2e-tests'
+      E2E_TEST_SENTRY_PROJECT: 'sentry-javascript-e2e-tests'
     strategy:
       fail-fast: false
       matrix:
@@ -1219,7 +1219,7 @@ jobs:
       E2E_TEST_AUTH_TOKEN: ${{ secrets.E2E_TEST_AUTH_TOKEN }}
       E2E_TEST_DSN: ${{ secrets.E2E_TEST_DSN }}
       E2E_TEST_SENTRY_ORG_SLUG: 'sentry-javascript-sdks'
-      E2E_TEST_SENTRY_TEST_PROJECT: 'sentry-javascript-e2e-tests'
+      E2E_TEST_SENTRY_PROJECT: 'sentry-javascript-e2e-tests'
     strategy:
       fail-fast: false
       matrix:

.github/workflows/canary.yml

@@ -63,7 +63,7 @@ jobs:
       PUBLIC_E2E_TEST_DSN: ${{ secrets.E2E_TEST_DSN }}
       REACT_APP_E2E_TEST_DSN: ${{ secrets.E2E_TEST_DSN }}
       E2E_TEST_SENTRY_ORG_SLUG: 'sentry-javascript-sdks'
-      E2E_TEST_SENTRY_TEST_PROJECT: 'sentry-javascript-e2e-tests'
+      E2E_TEST_SENTRY_PROJECT: 'sentry-javascript-e2e-tests'
     strategy:
       fail-fast: false
       matrix:

dev-packages/e2e-tests/.env.example

@@ -1,4 +1,13 @@
+# A Sentry auth token with the scopes, project:read, project:releases, event:read, org:read
+# In the Sentry interface this equates to: Project read, Release admin, Issue & Event read, Organization read
+# The auth token should be able to access the orgs and projecs provided in the environment variables below.
 E2E_TEST_AUTH_TOKEN=
+
+# A DSN to send events to. Should be sending events to the project provided below.
 E2E_TEST_DSN=
+
+# A Sentry organization slug
 E2E_TEST_SENTRY_ORG_SLUG=
-E2E_TEST_SENTRY_TEST_PROJECT=
+
+# A Sentry project slug
+E2E_TEST_SENTRY_PROJECT=

dev-packages/e2e-tests/README.md

@@ -9,7 +9,6 @@ Prerequisites: Docker
 
 - Copy `.env.example` to `.env`
 - Fill in auth information in `.env` for an example Sentry project
-  - The `E2E_TEST_AUTH_TOKEN` must have all the default permissions
 - Run `yarn build:tarball` in the root of the repository
 
 To finally run all of the tests:

dev-packages/e2e-tests/lib/validate.ts

@@ -22,9 +22,9 @@ export function validate(): boolean {
     missingEnvVar = true;
   }
 
-  if (!process.env.E2E_TEST_SENTRY_TEST_PROJECT) {
+  if (!process.env.E2E_TEST_SENTRY_PROJECT) {
     console.log(
-      'No Sentry project configured! Please configure the E2E_TEST_SENTRY_TEST_PROJECT environment variable with a Sentry project slug!',
+      'No Sentry project configured! Please configure the `E2E_TEST_SENTRY_PROJECT` environment variable with a Sentry project slug!',
     );
     missingEnvVar = true;
   }

dev-packages/e2e-tests/test-applications/create-next-app/tests/behaviour-client.test.ts

@@ -2,7 +2,7 @@ import { expect, test } from '@playwright/test';
 
 const authToken = process.env.E2E_TEST_AUTH_TOKEN;
 const sentryTestOrgSlug = process.env.E2E_TEST_SENTRY_ORG_SLUG;
-const sentryTestProject = process.env.E2E_TEST_SENTRY_TEST_PROJECT;
+const sentryTestProject = process.env.E2E_TEST_SENTRY_PROJECT;
 const EVENT_POLLING_TIMEOUT = 90_000;
 
 test('Sends a client-side exception to Sentry', async ({ page }) => {

dev-packages/e2e-tests/test-applications/create-next-app/tests/behaviour-server.test.ts

@@ -2,7 +2,7 @@ import { expect, test } from '@playwright/test';
 
 const authToken = process.env.E2E_TEST_AUTH_TOKEN;
 const sentryTestOrgSlug = process.env.E2E_TEST_SENTRY_ORG_SLUG;
-const sentryTestProject = process.env.E2E_TEST_SENTRY_TEST_PROJECT;
+const sentryTestProject = process.env.E2E_TEST_SENTRY_PROJECT;
 const EVENT_POLLING_TIMEOUT = 90_000;
 
 test('Sends a server-side exception to Sentry', async ({ baseURL }) => {

dev-packages/e2e-tests/test-applications/create-remix-app-express-vite-dev/tests/behaviour-client.test.ts

@@ -4,7 +4,7 @@ const EVENT_POLLING_TIMEOUT = 90_000;
 
 const authToken = process.env.E2E_TEST_AUTH_TOKEN;
 const sentryTestOrgSlug = process.env.E2E_TEST_SENTRY_ORG_SLUG;
-const sentryTestProject = process.env.E2E_TEST_SENTRY_TEST_PROJECT;
+const sentryTestProject = process.env.E2E_TEST_SENTRY_PROJECT;
 
 test('Sends a client-side exception to Sentry', async ({ page }) => {
   await page.goto('/');

dev-packages/e2e-tests/test-applications/create-remix-app-express/tests/behaviour-client.test.ts

@@ -4,7 +4,7 @@ const EVENT_POLLING_TIMEOUT = 90_000;
 
 const authToken = process.env.E2E_TEST_AUTH_TOKEN;
 const sentryTestOrgSlug = process.env.E2E_TEST_SENTRY_ORG_SLUG;
-const sentryTestProject = process.env.E2E_TEST_SENTRY_TEST_PROJECT;
+const sentryTestProject = process.env.E2E_TEST_SENTRY_PROJECT;
 
 test('Sends a client-side exception to Sentry', async ({ page }) => {
   await page.goto('/');

dev-packages/e2e-tests/test-applications/create-remix-app-v2/tests/behaviour-client.test.ts

@@ -4,7 +4,7 @@ const EVENT_POLLING_TIMEOUT = 90_000;
 
 const authToken = process.env.E2E_TEST_AUTH_TOKEN;
 const sentryTestOrgSlug = process.env.E2E_TEST_SENTRY_ORG_SLUG;
-const sentryTestProject = process.env.E2E_TEST_SENTRY_TEST_PROJECT;
+const sentryTestProject = process.env.E2E_TEST_SENTRY_PROJECT;
 
 test('Sends a client-side exception to Sentry', async ({ page }) => {
   await page.goto('/');

dev-packages/e2e-tests/test-applications/create-remix-app/tests/behaviour-client.test.ts

@@ -4,7 +4,7 @@ const EVENT_POLLING_TIMEOUT = 90_000;
 
 const authToken = process.env.E2E_TEST_AUTH_TOKEN;
 const sentryTestOrgSlug = process.env.E2E_TEST_SENTRY_ORG_SLUG;
-const sentryTestProject = process.env.E2E_TEST_SENTRY_TEST_PROJECT;
+const sentryTestProject = process.env.E2E_TEST_SENTRY_PROJECT;
 
 test('Sends a client-side exception to Sentry', async ({ page }) => {
   await page.goto('/');

dev-packages/e2e-tests/test-applications/create-remix-app/upload-sourcemaps.sh

@@ -1,3 +1,3 @@
 export SENTRY_AUTH_TOKEN=${E2E_TEST_AUTH_TOKEN}
 
-sentry-upload-sourcemaps --org ${E2E_TEST_SENTRY_ORG_SLUG} --project ${E2E_TEST_SENTRY_TEST_PROJECT}
+sentry-upload-sourcemaps --org ${E2E_TEST_SENTRY_ORG_SLUG} --project ${E2E_TEST_SENTRY_PROJECT}

dev-packages/e2e-tests/test-applications/debug-id-sourcemaps/rollup.config.mjs

@@ -7,7 +7,7 @@ export default defineConfig({
   plugins: [
     sentryRollupPlugin({
       org: process.env.E2E_TEST_SENTRY_ORG_SLUG,
-      project: process.env.E2E_TEST_SENTRY_TEST_PROJECT,
+      project: process.env.E2E_TEST_SENTRY_PROJECT,
       authToken: process.env.E2E_TEST_AUTH_TOKEN,
     }),
   ],

dev-packages/e2e-tests/test-applications/debug-id-sourcemaps/tests/server.test.ts

@@ -4,7 +4,7 @@ import { test } from 'vitest';
 
 const authToken = process.env.E2E_TEST_AUTH_TOKEN;
 const sentryTestOrgSlug = process.env.E2E_TEST_SENTRY_ORG_SLUG;
-const sentryTestProject = process.env.E2E_TEST_SENTRY_TEST_PROJECT;
+const sentryTestProject = process.env.E2E_TEST_SENTRY_PROJECT;
 const EVENT_POLLING_TIMEOUT = 90_000;
 
 test(

dev-packages/e2e-tests/test-applications/nextjs-app-dir/tests/exceptions.test.ts

@@ -3,7 +3,7 @@ import { waitForError } from '@sentry-internal/event-proxy-server';
 
 const authToken = process.env.E2E_TEST_AUTH_TOKEN;
 const sentryTestOrgSlug = process.env.E2E_TEST_SENTRY_ORG_SLUG;
-const sentryTestProject = process.env.E2E_TEST_SENTRY_TEST_PROJECT;
+const sentryTestProject = process.env.E2E_TEST_SENTRY_PROJECT;
 const EVENT_POLLING_TIMEOUT = 90_000;
 
 test('Sends a client-side exception to Sentry', async ({ page }) => {

dev-packages/e2e-tests/test-applications/nextjs-app-dir/tests/server-components.test.ts

@@ -3,7 +3,7 @@ import { waitForError, waitForTransaction } from '@sentry-internal/event-proxy-s
 
 const authToken = process.env.E2E_TEST_AUTH_TOKEN;
 const sentryTestOrgSlug = process.env.E2E_TEST_SENTRY_ORG_SLUG;
-const sentryTestProject = process.env.E2E_TEST_SENTRY_TEST_PROJECT;
+const sentryTestProject = process.env.E2E_TEST_SENTRY_PROJECT;
 const EVENT_POLLING_TIMEOUT = 90_000;
 
 test('Sends a transaction for a server component', async ({ page }) => {

dev-packages/e2e-tests/test-applications/nextjs-app-dir/tests/transactions.test.ts

@@ -5,7 +5,7 @@ const packageJson = require('../package.json');
 
 const authToken = process.env.E2E_TEST_AUTH_TOKEN;
 const sentryTestOrgSlug = process.env.E2E_TEST_SENTRY_ORG_SLUG;
-const sentryTestProject = process.env.E2E_TEST_SENTRY_TEST_PROJECT;
+const sentryTestProject = process.env.E2E_TEST_SENTRY_PROJECT;
 const EVENT_POLLING_TIMEOUT = 90_000;
 
 test('Sends a pageload transaction', async ({ page }) => {

dev-packages/e2e-tests/test-applications/node-connect/tests/transactions.test.ts

@@ -3,7 +3,7 @@ import { waitForTransaction } from '@sentry-internal/event-proxy-server';
 
 const authToken = process.env.E2E_TEST_AUTH_TOKEN;
 const sentryTestOrgSlug = process.env.E2E_TEST_SENTRY_ORG_SLUG;
-const sentryTestProject = process.env.E2E_TEST_SENTRY_TEST_PROJECT;
+const sentryTestProject = process.env.E2E_TEST_SENTRY_PROJECT;
 const EVENT_POLLING_TIMEOUT = 90_000;
 
 test('Sends an API route transaction', async ({ baseURL }) => {

dev-packages/e2e-tests/test-applications/node-express-send-to-sentry/tests/send-to-sentry.test.ts

@@ -4,7 +4,7 @@ const EVENT_POLLING_TIMEOUT = 90_000;
 
 const authToken = process.env.E2E_TEST_AUTH_TOKEN;
 const sentryTestOrgSlug = process.env.E2E_TEST_SENTRY_ORG_SLUG;
-const sentryTestProject = process.env.E2E_TEST_SENTRY_TEST_PROJECT;
+const sentryTestProject = process.env.E2E_TEST_SENTRY_PROJECT;
 
 test('Sends exception to Sentry', async ({ baseURL }) => {
   const response = await fetch(`${baseURL}/test-error`);

dev-packages/e2e-tests/test-applications/react-router-6-use-routes/tests/behaviour-test.test.ts

@@ -5,7 +5,7 @@ const EVENT_POLLING_TIMEOUT = 90_000;
 
 const authToken = process.env.E2E_TEST_AUTH_TOKEN;
 const sentryTestOrgSlug = process.env.E2E_TEST_SENTRY_ORG_SLUG;
-const sentryTestProject = process.env.E2E_TEST_SENTRY_TEST_PROJECT;
+const sentryTestProject = process.env.E2E_TEST_SENTRY_PROJECT;
 
 test('Sends an exception to Sentry', async ({ page }) => {
   await page.goto('/');

dev-packages/e2e-tests/test-applications/react-send-to-sentry/tests/send-to-sentry.test.ts

@@ -5,7 +5,7 @@ const EVENT_POLLING_TIMEOUT = 90_000;
 
 const authToken = process.env.E2E_TEST_AUTH_TOKEN;
 const sentryTestOrgSlug = process.env.E2E_TEST_SENTRY_ORG_SLUG;
-const sentryTestProject = process.env.E2E_TEST_SENTRY_TEST_PROJECT;
+const sentryTestProject = process.env.E2E_TEST_SENTRY_PROJECT;
 
 test('Sends an exception to Sentry', async ({ page }) => {
   await page.goto('/');

dev-packages/e2e-tests/test-applications/standard-frontend-react/tests/behaviour-test.spec.ts

@@ -5,7 +5,7 @@ const EVENT_POLLING_TIMEOUT = 90_000;
 
 const authToken = process.env.E2E_TEST_AUTH_TOKEN;
 const sentryTestOrgSlug = process.env.E2E_TEST_SENTRY_ORG_SLUG;
-const sentryTestProject = process.env.E2E_TEST_SENTRY_TEST_PROJECT;
+const sentryTestProject = process.env.E2E_TEST_SENTRY_PROJECT;
 
 test('Sends an exception to Sentry', async ({ page }) => {
   await page.goto('/');

dev-packages/e2e-tests/test-applications/webpack-4/tests/behaviour-test.spec.ts

@@ -4,7 +4,7 @@ const EVENT_POLLING_TIMEOUT = 90_000;
 
 const authToken = process.env.E2E_TEST_AUTH_TOKEN;
 const sentryTestOrgSlug = process.env.E2E_TEST_SENTRY_ORG_SLUG;
-const sentryTestProject = process.env.E2E_TEST_SENTRY_TEST_PROJECT;
+const sentryTestProject = process.env.E2E_TEST_SENTRY_PROJECT;
 
 test('Sends an exception to Sentry', async ({ page }) => {
   await page.goto('/');

dev-packages/e2e-tests/test-applications/webpack-5/tests/behaviour-test.spec.ts

@@ -4,7 +4,7 @@ const EVENT_POLLING_TIMEOUT = 90_000;
 
 const authToken = process.env.E2E_TEST_AUTH_TOKEN;
 const sentryTestOrgSlug = process.env.E2E_TEST_SENTRY_ORG_SLUG;
-const sentryTestProject = process.env.E2E_TEST_SENTRY_TEST_PROJECT;
+const sentryTestProject = process.env.E2E_TEST_SENTRY_PROJECT;
 
 test('Sends an exception to Sentry', async ({ page }) => {
   await page.goto('/');