PlaywrightAuthExample/playwright.config.ts at main · WISClub/PlaywrightAuthExample · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
// playwright.config.ts  - this is the configuration file for the playwright tests
import "dotenv/config";
import { defineConfig, devices } from "@playwright/test";

/**
 * See https://playwright.dev/docs/test-configuration.
 */
export default defineConfig({
  testDir: "./tests",
  /* Run tests in files in parallel */
  fullyParallel: true,
  /* Fail the build on CI if you accidentally left test.only in the source code. */
  forbidOnly: !!process.env.CI,
  /* Retry on CI only */
  retries: process.env.CI ? 2 : 0,
  /* Opt out of parallel tests on CI. */
  workers: process.env.CI ? 1 : undefined, //this is how many workers to use, IF THERE ARE ANY ISSUES WITH THE TESTS, TRY CHANGING THIS NUMBER TO 1
  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
  reporter: "html",
  /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
  use: {
    /* Base URL to use in actions like `await page.goto('/')`. */

    baseURL: process.env.AUTH0_BASE_URL, // I would not set this to the hosted url (like *.vercel.app) because it will be different from the code running locally

    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
    trace: "on-first-retry",
  },

  /* Configure projects for major browsers */
  projects: [
    { name: "setup", testMatch: /.*\.setup\.ts/ },
    {
      name: "chromium",
      dependencies: ["setup"],
      testMatch: /.*\.spec\.ts/,
      use: {
        ...devices["Desktop Chrome"],
        /*The storage state is the auth information that the runners use for testing.  This line checks if the tests are run locally or not.*/
        storageState: process.env.STORAGE_STATE_PATH,
      },
    },
    //uncomment the following to run tests on firefox and safari
    /*
    {
      name: 'firefox',
      dependencies: ['setup'],
      use: {...devices['Desktop Firefox'], storageState: 'playwright/.auth/user.json' },
    },

    {
      name: 'webkit',
      dependencies: ['setup'],
      use: {...devices['Desktop Safari'],storageState: 'playwright/.auth/user.json'},
    },
    */

    /* Test against mobile viewports. */
    // {
    //   name: 'Mobile Chrome',
    //   use: { ...devices['Pixel 5'] },
    // },
    // {
    //   name: 'Mobile Safari',
    //   use: { ...devices['iPhone 12'] },
    // },

    /* Test against branded browsers. */
    // {
    //   name: 'Microsoft Edge',
    //   use: { ...devices['Desktop Edge'], channel: 'msedge' },
    // },
    // {
    //   name: 'Google Chrome',
    //   use: { ...devices['Desktop Chrome'], channel: 'chrome' },
    // },
  ],

  /* Run your local dev server before starting the tests */
  webServer: {
    command: "npm run build && npm run start", //the command to start the server, running npm run build && npm run start will start the server as well and may check for errors in building but it will take a lot
    url: process.env.AUTH0_BASE_URL, //the url that playwright will use to access the server
    reuseExistingServer: !process.env.CI,
    env: {
      AUTH0_SECRET: process.env.AUTH0_SECRET_TEST ?? "",
      AUTH0_CLIENT_ID: process.env.AUTH0_CLIENT_ID_TEST ?? "",
      AUTH0_CLIENT_SECRET: process.env.AUTH0_CLIENT_SECRET_TEST ?? "",
      TEST_UNAME: process.env.TEST_UNAME ?? "",
      TEST_PWD: process.env.TEST_PWD ?? "",
    },
  },
});