test/parallel/test-runner-get-test-context.js

'use strict';
const common = require('../common');
const assert = require('node:assert');
const {
  test,
  getTestContext,
  describe,
  it,
  before,
  after,
  beforeEach,
  afterEach,
} = require('node:test');

// Outside a test — must return undefined
assert.strictEqual(getTestContext(), undefined);

test('getTestContext returns current context inside test', async () => {
  const ctx = getTestContext();
  assert.ok(ctx !== undefined);
  assert.strictEqual(ctx.name, 'getTestContext returns current context inside test');
  assert.strictEqual(typeof ctx.signal, 'object');
  assert.strictEqual(typeof ctx.fullName, 'string');
});

test('getTestContext works in nested test', async (t) => {
  await t.test('child', async () => {
    const ctx = getTestContext();
    assert.ok(ctx !== undefined);
    assert.strictEqual(ctx.name, 'child');
  });
});

describe('getTestContext works in describe/it', () => {
  it('has correct name', () => {
    const ctx = getTestContext();
    assert.ok(ctx !== undefined);
    assert.strictEqual(ctx.name, 'has correct name');
  });
});

describe('getTestContext returns SuiteContext in suite', () => {
  it('suite context is available', () => {
    const ctx = getTestContext();
    assert.ok(ctx !== undefined);
    // Suite name appears as parent in nested test context
    assert.strictEqual(typeof ctx.signal, 'object');
    assert.strictEqual(typeof ctx.fullName, 'string');
  });
});

describe('getTestContext inside hooks', () => {
  const suiteName = 'getTestContext inside hooks';

  before(common.mustCall((t) => {
    const ctx = getTestContext();
    assert.ok(ctx !== undefined);
    assert.strictEqual(ctx.name, suiteName);
    assert.strictEqual(ctx.name, t.name);
  }));

  beforeEach(common.mustCall(() => {
    const ctx = getTestContext();
    assert.ok(ctx !== undefined);
    assert.strictEqual(ctx.name, suiteName);
  }));

  afterEach(common.mustCall(() => {
    const ctx = getTestContext();
    assert.ok(ctx !== undefined);
    assert.strictEqual(ctx.name, suiteName);
  }));

  after(common.mustCall((t) => {
    const ctx = getTestContext();
    assert.ok(ctx !== undefined);
    assert.strictEqual(ctx.name, suiteName);
    assert.strictEqual(ctx.name, t.name);
  }));

  it('runs inside the suite', () => {
    const ctx = getTestContext();
    assert.ok(ctx !== undefined);
    assert.strictEqual(ctx.name, 'runs inside the suite');
  });
});

test('getTestContext inside test-level hooks returns the parent test', async (t) => {
  const parentName = t.name;
  t.beforeEach(common.mustCall(() => {
    const ctx = getTestContext();
    assert.ok(ctx !== undefined);
    assert.strictEqual(ctx.name, parentName);
  }));

  t.afterEach(common.mustCall(() => {
    const ctx = getTestContext();
    assert.ok(ctx !== undefined);
    assert.strictEqual(ctx.name, parentName);
  }));

  await t.test('child', () => {
    const ctx = getTestContext();
    assert.ok(ctx !== undefined);
    assert.strictEqual(ctx.name, 'child');
  });
});

test('getTestContext works in test body during async operations', async (t) => {
  const ctx = getTestContext();
  assert.ok(ctx !== undefined);
  assert.strictEqual(ctx.name, 'getTestContext works in test body during async operations');

  // Also works in nested async context
  const ctxInSetImmediate = await new Promise((resolve) => {
    setImmediate(() => resolve(getTestContext()));
  });
  assert.ok(ctxInSetImmediate !== undefined);
  assert.strictEqual(ctxInSetImmediate.name, 'getTestContext works in test body during async operations');
});