Changelog

0.16.0

Minor Changes

#58 2962b6e Thanks @SebastianSedzik! - Add @retries decorator

Set the maximum number of retry attempts given to failed @tests in the @suite

import { suite, test, retries } from "playwright-decorators";

@retries(3) // <-- Decorate suite with @retries()
@suite()
class MyTestSuite {
  @test()
  async test() {
    // <- This test may be retried up to 3 times if it fails
    // ...
  }
}

0.15.0

Minor Changes

#56 3a44870 Thanks @SebastianSedzik! - Add support for fixtures

This release introduce a new method extend<T>(customFixture) that allows to create decorators (afterAll, afterEach, test, beforeAll, beforeEach) with access to custom fixtures.

import { test as base } from 'playwright';
import { suite, test, extend } from 'playwright-decorators';

// #1 Create fixture type
type UserFixture = {

      firstName: string;
      lastName: string;
    }
}

// #2 Create user fixture
const withUser = base.extend<UserFixture>({
 ({}, use) => {
        await use({
            firstName: 'John',
            lastName: 'Doe'
        })
    }
})

// #3 Generate afterAll, afterEach, test, beforeAll, beforeEach decorators with access to the user fixture
const {
    afterAll,
    afterEach,
    test,
    beforeAll,
    beforeEach,
} = extend<UserFixture>(withUser);

// #4 Use decorators
@suite()
class MyTestSuite {
    @beforeAll()
    async beforeAll({ user }: TestArgs<UserFixture>) { // have access to user fixture
        // ...
    }

    @test()
    async test({ user }: TestArgs<UserFixture>) { // have access to user fixture
        // ...
    }
}

0.14.3

Patch Changes

#51 a83fc39 Thanks @SebastianSedzik! - @test and @suite decorators do no longer keep logic related to fail, only, skip, slow. Code was moved to dedicated decorators.

0.14.2

Patch Changes

#49 f76265e Thanks @dependabot! - Bump development dependencies

0.14.1

Patch Changes

#44 e8997d2 Thanks @SebastianSedzik! - Redact error messages thrown by custom decorators: createSuiteDecorator, createTestDecorator, createSuiteAndTestDecorator

0.14.0

Minor Changes

#40 a50e25b Thanks @SebastianSedzik! - Add @debug decorator

Runs a @test(s) or @suite(s) in debug mode. Tests or suites without the @debug decorator will not be excluded. Learn more about debug mode: https://playwright.dev/docs/debug

import { suite, test, debug, TestArgs } from "playwright-decorators";

// Debug selected test suite(s)
@debug() // <-- Decorate suite with @debug()
@suite()
class DebugTestSuite {}

// Or debug selected test(s)
@suite()
class TestSuite {
  @debug() // <-- Decorate test with @debug()
  @test()
  async test({ page }: TestArgs) {
    // ...
  }
}

#42 a2e7892 Thanks @SebastianSedzik! - Add @preview decorator

Runs a @test(s) or @suite(s) in preview (headed browser) mode, simulating user interaction (slowing down each operation by 1000ms). Tests or suites without the @preview decorator will not be excluded.

import { suite, test, preview, TestArgs } from "playwright-decorators";

// Preview selected test suite(s)
@preview() // <-- Decorate suite with @preview()
@suite()
class PreviewTestSuite {}

// Or preview selected test(s)
@suite()
class TestSuite {
  @preview() // <-- Decorate test with @preview()
  @test()
  async test({ page }: TestArgs) {
    // ...
  }
}

Patch Changes

#43 ccc39fc Thanks @SebastianSedzik! - Restructure readme file

0.13.0

Minor Changes

#38 dbea0b6 Thanks @SebastianSedzik! - Added support for creating custom test and suite decorator

import { createSuiteAndTestDecorator } from "playwright-decorators";
import playwright from "@playwright/test";

const mySuiteAndTestDecorator = createSuiteAndTestDecorator(
  "mySuiteAndTestDecorator",
  ({ suite }) => {
    suite.initialized(() => {
      /** run custom code when suite is initialized **/
    });
  },
  ({ test }) => {
    test.beforeTest(() => {
      /** run custom code before test execution **/
    });
    test.afterTest(() => {
      /** run custom code after test execution **/
    });

    playwright.beforeEach(() => {
      /** run custom code before each test execution **/
    });
  },
);

Patch Changes

#38 dbea0b6 Thanks @SebastianSedzik! - Export TestInfo type

import { suite, test, TestArgs, TestInfo } from "@playwright/test";

@suite()
class TestSuite {
  @test()
  myTest({ page }: TestArgs, testInfo: TestInfo) {
    // ...
  }
}

0.12.0

Minor Changes

#35 8ba55c6 Thanks @SebastianSedzik! - Enhanced TypeScript support:
- constrained the @suite decorator to class contexts only.
- constrained the @test decorator to class method context only. Type check of test method arguments.
- exported the TestArgs type to provide validity within test methods.
```
import { suite, test, TestArgs } from "playwright-decorators";

@suite()
class ExampleSuite {
  @test()
  async exampleTest({ page }: TestArgs) {
    // <- TestArgs ensures correct types of arguments
    // ...
  }
}
```

Patch Changes

#29 7398cc2 Thanks @SebastianSedzik! - Fixes of @skip and @annotate decorators:
- Pass reason from @skip decorator to the reporter.
- Added support for annotations on skipped tests.