waveterm/xterm.js
0
0
Fork 0
mirror of https://github.com/wavetermdev/xterm.js.git synced 2026-08-05 13:43:48 -07:00
Code Issues Packages Projects Releases Wiki Activity

Migrate Parser tests to playwright/test

Browse Source
This commit is contained in:
Daniel Imms
2023-08-27 09:11:47 -07:00
parent cb977ab6b6
commit 5b25c65521
2 changed files with 244 additions and 213 deletions
Download Patch File Download Diff File Expand all files Collapse all files
test/api/Parser.api.ts
-213
View File
@@ -1,213 +0,0 @@
/**
* Copyright (c) 2019 The xterm.js authors. All rights reserved.
* @license MIT
*/
import { assert } from 'chai';
import { writeSync, openTerminal, launchBrowser } from './TestUtils';
import { Browser, Page } from '@playwright/test';
const APP = 'http://127.0.0.1:3001/test';
let browser: Browser;
let page: Page;
const width = 800;
const height = 600;
describe('Parser Integration Tests', function (): void {
before(async function (): Promise<any> {
browser = await launchBrowser();
page = await (await browser.newContext()).newPage();
await page.setViewportSize({ width, height });
await page.goto(APP);
await openTerminal(page);
});
after(async () => browser.close());
describe('registerCsiHandler', () => {
it('should call custom CSI handler with js array params', async () => {
await page.evaluate(`
window.term.reset();
window._customCsiHandlerParams = [];
const _customCsiHandler = window.term.parser.registerCsiHandler({final: 'm'}, (params, collect) => {
window._customCsiHandlerParams.push(params);
return false;
}, '');
`);
await writeSync(page, '\x1b[38;5;123mparams\x1b[38:2::50:100:150msubparams');
assert.deepEqual(await page.evaluate(`window._customCsiHandlerParams`), [
[38, 5, 123],
[38, [2, -1, 50, 100, 150]]
]);
});
it('async', async () => {
await page.evaluate(`
window.term.reset();
window._customCsiHandlerCallStack = [];
const _customCsiHandlerA = window.term.parser.registerCsiHandler({intermediates:'+', final: 'Z'}, params => {
window._customCsiHandlerCallStack.push(['A', params]);
return false;
});
const _customCsiHandlerB = window.term.parser.registerCsiHandler({intermediates:'+', final: 'Z'}, async params => {
await new Promise(res => setTimeout(res, 50));
window._customCsiHandlerCallStack.push(['B', params]);
return false;
});
const _customCsiHandlerC = window.term.parser.registerCsiHandler({intermediates:'+', final: 'Z'}, params => {
window._customCsiHandlerCallStack.push(['C', params]);
return false;
});
`);
await writeSync(page, '\x1b[1;2+Z');
assert.deepEqual(await page.evaluate(`window._customCsiHandlerCallStack`), [
['C', [1, 2]],
['B', [1, 2]],
['A', [1, 2]]
]);
});
});
describe('registerDcsHandler', () => {
it('should respects return value', async () => {
await page.evaluate(`
window.term.reset();
window._customDcsHandlerCallStack = [];
const _customDcsHandlerA = window.term.parser.registerDcsHandler({intermediates:'+', final: 'p'}, (data, params) => {
window._customDcsHandlerCallStack.push(['A', params, data]);
return false;
});
const _customDcsHandlerB = window.term.parser.registerDcsHandler({intermediates:'+', final: 'p'}, (data, params) => {
window._customDcsHandlerCallStack.push(['B', params, data]);
return true;
});
const _customDcsHandlerC = window.term.parser.registerDcsHandler({intermediates:'+', final: 'p'}, (data, params) => {
window._customDcsHandlerCallStack.push(['C', params, data]);
return false;
});
`);
await writeSync(page, '\x1bP1;2+psome data\x1b\\\\');
assert.deepEqual(await page.evaluate(`window._customDcsHandlerCallStack`), [
['C', [1, 2], 'some data'],
['B', [1, 2], 'some data']
]);
});
it('async', async () => {
await page.evaluate(`
window.term.reset();
window._customDcsHandlerCallStack = [];
const _customDcsHandlerA = window.term.parser.registerDcsHandler({intermediates:'+', final: 'q'}, (data, params) => {
window._customDcsHandlerCallStack.push(['A', params, data]);
return false;
});
const _customDcsHandlerB = window.term.parser.registerDcsHandler({intermediates:'+', final: 'q'}, async (data, params) => {
await new Promise(res => setTimeout(res, 50));
window._customDcsHandlerCallStack.push(['B', params, data]);
return false;
});
const _customDcsHandlerC = window.term.parser.registerDcsHandler({intermediates:'+', final: 'q'}, (data, params) => {
window._customDcsHandlerCallStack.push(['C', params, data]);
return false;
});
`);
await writeSync(page, '\x1bP1;2+qsome data\x1b\\\\');
assert.deepEqual(await page.evaluate(`window._customDcsHandlerCallStack`), [
['C', [1, 2], 'some data'],
['B', [1, 2], 'some data'],
['A', [1, 2], 'some data']
]);
});
});
describe('registerEscHandler', () => {
it('should respects return value', async () => {
await page.evaluate(`
window.term.reset();
window._customEscHandlerCallStack = [];
const _customEscHandlerA = window.term.parser.registerEscHandler({intermediates:'(', final: 'B'}, () => {
window._customEscHandlerCallStack.push('A');
return false;
});
const _customEscHandlerB = window.term.parser.registerEscHandler({intermediates:'(', final: 'B'}, () => {
window._customEscHandlerCallStack.push('B');
return true;
});
const _customEscHandlerC = window.term.parser.registerEscHandler({intermediates:'(', final: 'B'}, () => {
window._customEscHandlerCallStack.push('C');
return false;
});
`);
await writeSync(page, '\x1b(B');
assert.deepEqual(await page.evaluate(`window._customEscHandlerCallStack`), ['C', 'B']);
});
it('async', async () => {
await page.evaluate(`
window.term.reset();
window._customEscHandlerCallStack = [];
const _customEscHandlerA = window.term.parser.registerEscHandler({intermediates:'(', final: 'Z'}, () => {
window._customEscHandlerCallStack.push('A');
return false;
});
const _customEscHandlerB = window.term.parser.registerEscHandler({intermediates:'(', final: 'Z'}, async () => {
await new Promise(res => setTimeout(res, 50));
window._customEscHandlerCallStack.push('B');
return false;
});
const _customEscHandlerC = window.term.parser.registerEscHandler({intermediates:'(', final: 'Z'}, () => {
window._customEscHandlerCallStack.push('C');
return false;
});
`);
await writeSync(page, '\x1b(Z');
assert.deepEqual(await page.evaluate(`window._customEscHandlerCallStack`), ['C', 'B', 'A']);
});
});
describe('registerOscHandler', () => {
it('should respects return value', async () => {
await page.evaluate(`
window.term.reset();
window._customOscHandlerCallStack = [];
const _customOscHandlerA = window.term.parser.registerOscHandler(1234, data => {
window._customOscHandlerCallStack.push(['A', data]);
return false;
});
const _customOscHandlerB = window.term.parser.registerOscHandler(1234, data => {
window._customOscHandlerCallStack.push(['B', data]);
return true;
});
const _customOscHandlerC = window.term.parser.registerOscHandler(1234, data => {
window._customOscHandlerCallStack.push(['C', data]);
return false;
});
`);
await writeSync(page, '\x1b]1234;some data\x07');
assert.deepEqual(await page.evaluate(`window._customOscHandlerCallStack`), [
['C', 'some data'],
['B', 'some data']
]);
});
it('async', async () => {
await page.evaluate(`
window.term.reset();
window._customOscHandlerCallStack = [];
const _customOscHandlerA = window.term.parser.registerOscHandler(666, data => {
window._customOscHandlerCallStack.push(['A', data]);
return false;
});
const _customOscHandlerB = window.term.parser.registerOscHandler(666, async data => {
await new Promise(res => setTimeout(res, 50));
window._customOscHandlerCallStack.push(['B', data]);
return false;
});
const _customOscHandlerC = window.term.parser.registerOscHandler(666, data => {
window._customOscHandlerCallStack.push(['C', data]);
return false;
});
`);
await writeSync(page, '\x1b]666;some data\x07');
assert.deepEqual(await page.evaluate(`window._customOscHandlerCallStack`), [
['C', 'some data'],
['B', 'some data'],
['A', 'some data']
]);
});
});
});
test/playwright/Parser.test.ts
+244
View File
@@ -0,0 +1,244 @@
/**
* Copyright (c) 2019 The xterm.js authors. All rights reserved.
* @license MIT
*/
import { test } from '@playwright/test';
import { deepStrictEqual, ok, strictEqual } from 'assert';
import type { IDisposable } from 'xterm';
import { createTestContext, ITestContext, openTerminal, pollFor } from './TestUtils';
let ctx: ITestContext;
test.beforeAll(async ({ browser }) => {
ctx = await createTestContext(browser);
await openTerminal(ctx);
});
test.afterAll(async () => await ctx.page.close());
declare global {
interface Window { // eslint-disable-line @typescript-eslint/naming-convention
customCsiHandlerParams?: (number | number[])[][];
customCsiHandlerCallStack?: string[];
customDcsHandlerCallStack?: [string, (number | number[])[], string][];
customEscHandlerCallStack?: string[];
customOscHandlerCallStack?: string[][];
disposable?: IDisposable;
disposables?: IDisposable[];
}
}
test.describe('Parser Integration Tests', function (): void {
test.beforeEach(async () => await ctx.proxy.reset());
test.afterEach(async () => {
await ctx.page.evaluate(() => {
window.disposable?.dispose();
window.disposable = undefined;
window.disposables?.forEach(e => e.dispose());
window.disposables = undefined;
});
});
test.describe('registerCsiHandler', () => {
test('should call custom CSI handler with js array params', async () => {
await ctx.proxy.evaluate(([term]) => {
window.customCsiHandlerParams = [];
window.disposable = term.parser.registerCsiHandler({final: 'm'}, (params) => {
window.customCsiHandlerParams!.push(params);
return false;
});
});
await ctx.proxy.write('\x1b[38;5;123mparams\x1b[38:2::50:100:150msubparams');
deepStrictEqual(await ctx.page.evaluate(() => window.customCsiHandlerParams), [
[38, 5, 123],
[38, [2, -1, 50, 100, 150]]
]);
});
test('async', async () => {
await ctx.proxy.evaluate(([term]) => {
window.customCsiHandlerCallStack = [];
window.customCsiHandlerParams = [];
window.disposables = [
term.parser.registerCsiHandler({intermediates:'+', final: 'Z'}, params => {
window.customCsiHandlerCallStack!.push('A');
window.customCsiHandlerParams!.push(params);
return false;
}),
term.parser.registerCsiHandler({intermediates:'+', final: 'Z'}, params => {
return new Promise(res => setTimeout(res, 50)).then(() => {
window.customCsiHandlerCallStack!.push('B');
window.customCsiHandlerParams!.push(params);
return false;
});
}),
term.parser.registerCsiHandler({intermediates:'+', final: 'Z'}, params => {
window.customCsiHandlerCallStack!.push('C');
window.customCsiHandlerParams!.push(params);
return false;
})
];
});
await ctx.proxy.write('\x1b[1;2+Z');
deepStrictEqual(await ctx.page.evaluate(() => window.customCsiHandlerCallStack), [
'C',
'B',
'A'
]);
deepStrictEqual(await ctx.page.evaluate(() => window.customCsiHandlerParams), [
[1, 2],
[1, 2],
[1, 2]
]);
});
});
test.describe('registerDcsHandler', () => {
test('should respects return value', async () => {
await ctx.proxy.evaluate(([term]) => {
window.customDcsHandlerCallStack = [];
window.disposables = [
term.parser.registerDcsHandler({intermediates:'+', final: 'p'}, (data, params) => {
window.customDcsHandlerCallStack!.push(['A', params, data]);
return false;
}),
term.parser.registerDcsHandler({intermediates:'+', final: 'p'}, (data, params) => {
window.customDcsHandlerCallStack!.push(['B', params, data]);
return true;
}),
term.parser.registerDcsHandler({intermediates:'+', final: 'p'}, (data, params) => {
window.customDcsHandlerCallStack!.push(['C', params, data]);
return false;
})
];
});
await ctx.proxy.write('\x1bP1;2+psome data\x1b\\');
deepStrictEqual(await ctx.page.evaluate(() => window.customDcsHandlerCallStack), [
['C', [1, 2], 'some data'],
['B', [1, 2], 'some data']
]);
});
test('async', async () => {
await ctx.proxy.evaluate(([term]) => {
window.customDcsHandlerCallStack = [];
window.disposables = [
term.parser.registerDcsHandler({intermediates:'+', final: 'q'}, (data, params) => {
window.customDcsHandlerCallStack!.push(['A', params, data]);
return false;
}),
term.parser.registerDcsHandler({intermediates:'+', final: 'q'}, (data, params) => {
return new Promise(res => setTimeout(res, 50)).then(() => {
window.customDcsHandlerCallStack!.push(['B', params, data]);
return false;
});
}),
term.parser.registerDcsHandler({intermediates:'+', final: 'q'}, (data, params) => {
window.customDcsHandlerCallStack!.push(['C', params, data]);
return false;
})
];
});
await ctx.proxy.write('\x1bP1;2+qsome data\x1b\\');
deepStrictEqual(await ctx.page.evaluate(() => window.customDcsHandlerCallStack), [
['C', [1, 2], 'some data'],
['B', [1, 2], 'some data'],
['A', [1, 2], 'some data']
]);
});
});
test.describe('registerEscHandler', () => {
test('should respects return value', async () => {
await ctx.proxy.evaluate(([term]) => {
window.customEscHandlerCallStack = [];
window.disposables = [
term.parser.registerEscHandler({intermediates:'(', final: 'B'}, () => {
window.customEscHandlerCallStack!.push('A');
return false;
}),
term.parser.registerEscHandler({intermediates:'(', final: 'B'}, () => {
window.customEscHandlerCallStack!.push('B');
return true;
}),
term.parser.registerEscHandler({intermediates:'(', final: 'B'}, () => {
window.customEscHandlerCallStack!.push('C');
return false;
})
];
});
await ctx.proxy.write('\x1b(B');
deepStrictEqual(await ctx.page.evaluate(() => window.customEscHandlerCallStack), ['C', 'B']);
});
test('async', async () => {
await ctx.proxy.evaluate(([term]) => {
window.customEscHandlerCallStack = [];
window.disposables = [
term.parser.registerEscHandler({intermediates:'(', final: 'Z'}, () => {
window.customEscHandlerCallStack!.push('A');
return false;
}),
term.parser.registerEscHandler({intermediates:'(', final: 'Z'}, () => {
return new Promise(res => setTimeout(res, 50)).then(() => {
window.customEscHandlerCallStack!.push('B');
return false;
});
}),
term.parser.registerEscHandler({intermediates:'(', final: 'Z'}, () => {
window.customEscHandlerCallStack!.push('C');
return false;
})
];
});
await ctx.proxy.write('\x1b(Z');
deepStrictEqual(await ctx.page.evaluate(() => window.customEscHandlerCallStack), ['C', 'B', 'A']);
});
});
test.describe('registerOscHandler', () => {
test('should respects return value', async () => {
await ctx.proxy.evaluate(([term]) => {
window.customOscHandlerCallStack = [];
window.disposables = [
term.parser.registerOscHandler(1234, data => {
window.customOscHandlerCallStack!.push(['A', data]);
return false;
}),
term.parser.registerOscHandler(1234, data => {
window.customOscHandlerCallStack!.push(['B', data]);
return true;
}),
term.parser.registerOscHandler(1234, data => {
window.customOscHandlerCallStack!.push(['C', data]);
return false;
})
];
});
await ctx.proxy.write('\x1b]1234;some data\x07');
deepStrictEqual(await ctx.page.evaluate(() => window.customOscHandlerCallStack), [
['C', 'some data'],
['B', 'some data']
]);
});
test('async', async () => {
await ctx.proxy.evaluate(([term]) => {
window.customOscHandlerCallStack = [];
window.disposables = [
term.parser.registerOscHandler(666, data => {
window.customOscHandlerCallStack!.push(['A', data]);
return false;
}),
term.parser.registerOscHandler(666, data => {
return new Promise(res => setTimeout(res, 50)).then(() => {
window.customOscHandlerCallStack!.push(['B', data]);
return false;
});
}),
term.parser.registerOscHandler(666, data => {
window.customOscHandlerCallStack!.push(['C', data]);
return false;
})
];
});
await ctx.proxy.write('\x1b]666;some data\x07');
deepStrictEqual(await ctx.page.evaluate(() => window.customOscHandlerCallStack), [
['C', 'some data'],
['B', 'some data'],
['A', 'some data']
]);
});
});
});