playwright/tests/playwright-test/stdio.spec.ts
Dmitry Gozman 911d8effb9
feat(test runner): do not mock tty in the worker process (#30107)
This was historically done to make `console.log()` have colors. However,
this makes any other code that checks `process.stdout.isTTY` incorrectly
assume real TTY support.

Node18 and Node20 now respect `FORCE_COLOR=1` in console, so our default
behavior of forcing colors in the worker process just works out of the
box. See https://github.com/nodejs/node/pull/48034.
2024-03-25 15:31:58 -07:00

120 lines
4.1 KiB
TypeScript

/**
* Copyright Microsoft Corporation. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { test, expect } from './playwright-test-fixtures';
test('should get top level stdio', async ({ runInlineTest }) => {
const result = await runInlineTest({
'a.spec.js': `
import { test, expect } from '@playwright/test';
console.log('\\n%% top level stdout');
console.error('\\n%% top level stderr');
test('is a test', () => {
console.log('\\n%% stdout in a test');
console.error('\\n%% stderr in a test');
});
`
});
// top level logs appear twice, because the file is required twice
expect(result.outputLines.sort()).toEqual([
'stderr in a test',
'stdout in a test',
'top level stderr',
'top level stderr',
'top level stdout',
'top level stdout',
]);
});
test('should get stdio from worker fixture teardown', async ({ runInlineTest }) => {
const result = await runInlineTest({
'helper.ts': `
import { test as base, expect } from '@playwright/test';
export const test = base.extend({
fixture: [ async ({}, run) => {
console.log('\\n%% worker setup');
await run();
console.log('\\n%% worker teardown');
}, { scope: 'worker' } ]
});
`,
'a.spec.js': `
const { test } = require('./helper');
test('is a test', async ({fixture}) => {});
`
});
expect(result.outputLines).toEqual([
'worker setup',
'worker teardown'
]);
});
test('should ignore stdio when quiet', async ({ runInlineTest }) => {
const result = await runInlineTest({
'playwright.config.ts': `
module.exports = { quiet: true };
`,
'a.spec.js': `
import { test, expect } from '@playwright/test';
test('is a test', () => {
console.log('\\n%% stdout in a test');
console.error('\\n%% stderr in a test');
});
`
}, { reporter: 'list' });
expect(result.output).not.toContain('%%');
});
test('should support console colors but not tty', {
annotation: [
{ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/15366' },
{ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/29839' },
],
}, async ({ runInlineTest, nodeVersion }) => {
test.skip(nodeVersion.major < 18, 'Node16 does not respect FORCE_COLOR in onsole');
const result = await runInlineTest({
'a.spec.js': `
import { test, expect } from '@playwright/test';
test('console log', () => {
console.log('process.stdout.isTTY = ' + process.stdout.isTTY);
console.log('process.stderr.isTTY = ' + process.stderr.isTTY);
console.log({ b: true, n: 123, s: 'abc' });
console.error({ b: false, n: 123, s: 'abc' });
});
`
});
expect(result.output).toContain(`process.stdout.isTTY = undefined`);
expect(result.output).toContain(`process.stderr.isTTY = undefined`);
// The output should have colors.
expect(result.rawOutput).toContain(`{ b: \x1b[33mtrue\x1b[39m, n: \x1b[33m123\x1b[39m, s: \x1b[32m'abc'\x1b[39m }`);
expect(result.rawOutput).toContain(`{ b: \x1b[33mfalse\x1b[39m, n: \x1b[33m123\x1b[39m, s: \x1b[32m'abc'\x1b[39m }`);
});
test('should not throw type error when using assert', async ({ runInlineTest }) => {
const result = await runInlineTest({
'a.spec.js': `
import { test, expect } from '@playwright/test';
const assert = require('assert');
test('assert no type error', () => {
assert.strictEqual(1, 2);
});
`
});
expect(result.output).not.toContain(`TypeError: process.stderr.hasColors is not a function`);
expect(result.output).toContain(`AssertionError`);
});