Class: PlaywrightOnRails::Init

Inherits:

Object

• Object
• PlaywrightOnRails::Init

Defined in:

lib/playwright-on-rails/init.rb

Constant Summary

DEFAULT_CONFIG =

<<~JS
  import { defineConfig, devices } from '@playwright/test';

  /**
   * Read environment variables from file.
   * https://github.com/motdotla/dotenv
   */
  // require('dotenv').config();

  /**
   * 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,
    /* 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.PLAYWRIGHT_BASE_URL || 'http://127.0.0.1:3000',

      /* 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: 'chromium',
        use: { ...devices['Desktop Chrome'] },
      },

      {
        name: 'firefox',
        use: { ...devices['Desktop Firefox'] },
      },

      {
        name: 'webkit',
        use: { ...devices['Desktop Safari'] },
      },

      /* 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 start',
    //   url: 'http://127.0.0.1:3000',
    //   reuseExistingServer: !process.env.CI,
    // },
  });
JS

Instance Method Summary

• #call(playwright_dir = Config.new.playwright_dir) ⇒ Object

Instance Method Details

#call(playwright_dir = Config.new.playwright_dir) ⇒ Object

# File 'lib/playwright-on-rails/init.rb', line 83

def call(playwright_dir = Config.new.playwright_dir)
  config_path = File.join(playwright_dir, "playwright.config.js")
  if !File.exist?(config_path)
    File.write(config_path, DEFAULT_CONFIG)
    puts "Playwright config initialized in `#{config_path}'"
  else
    warn "Playwright config already exists in `#{config_path}'. Skipping."
  end
end