feat: add test and fixture info to the TestController object and fixture hooks(closes #2826)

[Artem-Babich]

Purpose

#2826

Currently, you cannot access any test/fixture information inside test and fixture hooks using public API. Fixture hooks cannot access this info even with private API.

Approach

Add corresponding members fixture: FixtureInfo, test:TestInfo to the TestController instance. Add the fixture info as a second argument to the fixture specific hooks.

References

#2826

API

type Metadata = Record<string, string>;

interface TestInfo {
    name: string;
    meta: Metadata;
}

interface FixtureInfo {
    name: string;
    meta: Metadata;
    path: string;
}

fixture`testFixture`
    .before(async (ctx, info: FixtureInfo) => {})
    .after(async (ctx, info: FixtureInfo) => {})
    .beforeEach(async t => {
        const testInfo: TestInfo = t.test
        const fixtureInfo: FixtureInfo = t.fixture;
    })
    .afterEach(async t => {
        const testInfo: TestInfo = t.test
        const fixtureInfo: FixtureInfo = t.fixture;
    })

test('SomeTest', async t => {})
    .before(async t => {
        const testInfo: TestInfo = t.test
        const fixtureInfo: FixtureInfo = t.fixture;
    })
    .after(async t => {
        const testInfo: TestInfo = t.test
        const fixtureInfo: FixtureInfo = t.fixture;
    })

Pre-Merge TODO

• Write tests for your proposed changes
• Add typings
• Make sure that existing tests do not fail

[github-actions]

Release v3.0.0-rc.1 addresses this.

[Makavelic]

This breaks a lot of my tests because I use arrays, booleans, etc as data types as part of the meta object. For example:

test.meta({
testSkip: ["isBrowserstack", "firefox"]

Now it expects all properties to be string values only. Is this expected?

[Aleksey28]

Hi @Makavelic,

It is intended behavior. The documentation states that meta should have a string type. It was a bug before 3.0.0. Could you describe for what purpose you send an array as a value?

[Makavelic]

My project has a custom testcafe runner that parses this value to determine whether a test should be skipped or not. An array is useful because I can add several conditions. I can refactor my runner code to just parse a string and split on ',' or something to get the desired effect.

[Aleksey28]

Hi @Makavelic,

Thank you for reporting this issue. We fixed it and published 3.0.0-rc.2 with this fix.