Skip to content

chore: Document e2e test env vars #12303

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 31, 2024
Merged

chore: Document e2e test env vars #12303

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0ead14c
chore: Document e2e test env vars
lforst May 31, 2024
0d13bc1
Update dev-packages/e2e-tests/lib/validate.ts
lforst May 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/canary.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
11 changes: 10 additions & 1 deletion dev-packages/e2e-tests/.env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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=
1 change: 0 additions & 1 deletion dev-packages/e2e-tests/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions dev-packages/e2e-tests/lib/validate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
Expand Down
2 changes: 1 addition & 1 deletion dev-packages/e2e-tests/test-applications/create-next-app/tests/behaviour-client.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 }) => {
Expand Down
2 changes: 1 addition & 1 deletion dev-packages/e2e-tests/test-applications/create-next-app/tests/behaviour-server.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 }) => {
Expand Down
2 changes: 1 addition & 1 deletion ...-tests/test-applications/create-remix-app-express-vite-dev/tests/behaviour-client.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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('/');
Expand Down
2 changes: 1 addition & 1 deletion ...kages/e2e-tests/test-applications/create-remix-app-express/tests/behaviour-client.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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('/');
Expand Down
2 changes: 1 addition & 1 deletion dev-packages/e2e-tests/test-applications/create-remix-app-v2/tests/behaviour-client.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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('/');
Expand Down
2 changes: 1 addition & 1 deletion dev-packages/e2e-tests/test-applications/create-remix-app/tests/behaviour-client.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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('/');
Expand Down
2 changes: 1 addition & 1 deletion dev-packages/e2e-tests/test-applications/create-remix-app/upload-sourcemaps.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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}
2 changes: 1 addition & 1 deletion dev-packages/e2e-tests/test-applications/debug-id-sourcemaps/rollup.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
}),
],
Expand Down
2 changes: 1 addition & 1 deletion dev-packages/e2e-tests/test-applications/debug-id-sourcemaps/tests/server.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
2 changes: 1 addition & 1 deletion dev-packages/e2e-tests/test-applications/nextjs-app-dir/tests/exceptions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 }) => {
Expand Down
2 changes: 1 addition & 1 deletion dev-packages/e2e-tests/test-applications/nextjs-app-dir/tests/server-components.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 }) => {
Expand Down
2 changes: 1 addition & 1 deletion dev-packages/e2e-tests/test-applications/nextjs-app-dir/tests/transactions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 }) => {
Expand Down
2 changes: 1 addition & 1 deletion dev-packages/e2e-tests/test-applications/node-connect/tests/transactions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 }) => {
Expand Down
2 changes: 1 addition & 1 deletion ...ages/e2e-tests/test-applications/node-express-send-to-sentry/tests/send-to-sentry.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`);
Expand Down
2 changes: 1 addition & 1 deletion ...ckages/e2e-tests/test-applications/react-router-6-use-routes/tests/behaviour-test.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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('/');
Expand Down
2 changes: 1 addition & 1 deletion dev-packages/e2e-tests/test-applications/react-send-to-sentry/tests/send-to-sentry.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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('/');
Expand Down
2 changes: 1 addition & 1 deletion ...packages/e2e-tests/test-applications/standard-frontend-react/tests/behaviour-test.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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('/');
Expand Down
2 changes: 1 addition & 1 deletion dev-packages/e2e-tests/test-applications/webpack-4/tests/behaviour-test.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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('/');
Expand Down
2 changes: 1 addition & 1 deletion dev-packages/e2e-tests/test-applications/webpack-5/tests/behaviour-test.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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('/');
Expand Down
Loading