2021-10-27 07:28:53 -08:00
|
|
|
/**
|
|
|
|
|
* Copyright (c) Microsoft Corporation.
|
|
|
|
|
*
|
|
|
|
|
* 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.
|
|
|
|
|
*/
|
|
|
|
|
|
2022-01-06 09:29:05 -08:00
|
|
|
import type { Fixtures } from '@playwright/test';
|
2021-10-27 07:28:53 -08:00
|
|
|
import path from 'path';
|
|
|
|
|
import socks from 'socksv5';
|
2023-05-25 15:11:16 -07:00
|
|
|
import { TestServer } from './testserver';
|
2021-10-27 07:28:53 -08:00
|
|
|
import { TestProxy } from './proxy';
|
|
|
|
|
|
|
|
|
|
export type ServerWorkerOptions = {
|
|
|
|
|
loopback?: string;
|
2022-01-06 09:29:05 -08:00
|
|
|
__servers: ServerFixtures & { socksServer: socks.SocksServer };
|
2021-10-27 07:28:53 -08:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
export type ServerFixtures = {
|
|
|
|
|
server: TestServer;
|
|
|
|
|
httpsServer: TestServer;
|
|
|
|
|
socksPort: number;
|
|
|
|
|
proxyServer: TestProxy;
|
|
|
|
|
asset: (p: string) => string;
|
|
|
|
|
};
|
|
|
|
|
|
2022-01-06 09:29:05 -08:00
|
|
|
export const serverFixtures: Fixtures<ServerFixtures, ServerWorkerOptions> = {
|
2022-08-18 20:12:33 +02:00
|
|
|
loopback: [undefined, { scope: 'worker', option: true }],
|
|
|
|
|
__servers: [async ({ loopback }, run, workerInfo) => {
|
2021-10-27 07:28:53 -08:00
|
|
|
const assetsPath = path.join(__dirname, '..', 'assets');
|
|
|
|
|
const cachedPath = path.join(__dirname, '..', 'assets', 'cached');
|
|
|
|
|
|
|
|
|
|
const port = 8907 + workerInfo.workerIndex * 4;
|
|
|
|
|
const server = await TestServer.create(assetsPath, port, loopback);
|
|
|
|
|
server.enableHTTPCache(cachedPath);
|
|
|
|
|
|
|
|
|
|
const httpsPort = port + 1;
|
|
|
|
|
const httpsServer = await TestServer.createHTTPS(assetsPath, httpsPort, loopback);
|
|
|
|
|
httpsServer.enableHTTPCache(cachedPath);
|
|
|
|
|
|
|
|
|
|
const socksServer = socks.createServer((info, accept, deny) => {
|
|
|
|
|
const socket = accept(true);
|
2022-11-23 13:03:38 -10:00
|
|
|
if (!socket)
|
|
|
|
|
return;
|
|
|
|
|
socket.on('data', data => {
|
|
|
|
|
if (!data.toString().includes('\r\n\r\n'))
|
|
|
|
|
return;
|
2021-10-27 07:28:53 -08:00
|
|
|
const body = '<html><title>Served by the SOCKS proxy</title></html>';
|
|
|
|
|
socket.end([
|
|
|
|
|
'HTTP/1.1 200 OK',
|
|
|
|
|
'Connection: close',
|
|
|
|
|
'Content-Type: text/html',
|
|
|
|
|
'Content-Length: ' + Buffer.byteLength(body),
|
|
|
|
|
'',
|
|
|
|
|
body
|
|
|
|
|
].join('\r\n'));
|
2022-11-23 13:03:38 -10:00
|
|
|
});
|
|
|
|
|
// Catch and ignore ECONNRESET errors.
|
|
|
|
|
socket.on('error', () => {});
|
|
|
|
|
setTimeout(() => socket.end(), 1000);
|
2021-10-27 07:28:53 -08:00
|
|
|
});
|
|
|
|
|
const socksPort = port + 2;
|
|
|
|
|
socksServer.listen(socksPort, 'localhost');
|
|
|
|
|
socksServer.useAuth(socks.auth.None());
|
|
|
|
|
|
|
|
|
|
const proxyPort = port + 3;
|
|
|
|
|
const proxyServer = await TestProxy.create(proxyPort);
|
|
|
|
|
|
|
|
|
|
await run({
|
|
|
|
|
asset: (p: string) => path.join(__dirname, '..', 'assets', ...p.split('/')),
|
|
|
|
|
server,
|
|
|
|
|
httpsServer,
|
|
|
|
|
socksPort,
|
|
|
|
|
proxyServer,
|
|
|
|
|
socksServer,
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
await Promise.all([
|
|
|
|
|
server.stop(),
|
|
|
|
|
httpsServer.stop(),
|
|
|
|
|
socksServer.close(),
|
|
|
|
|
proxyServer.stop(),
|
|
|
|
|
]);
|
2022-08-18 20:12:33 +02:00
|
|
|
}, { scope: 'worker' }],
|
2021-10-27 07:28:53 -08:00
|
|
|
|
|
|
|
|
server: async ({ __servers }, run) => {
|
|
|
|
|
__servers.server.reset();
|
|
|
|
|
await run(__servers.server);
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
httpsServer: async ({ __servers }, run) => {
|
|
|
|
|
__servers.httpsServer.reset();
|
|
|
|
|
await run(__servers.httpsServer);
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
socksPort: async ({ __servers }, run) => {
|
|
|
|
|
await run(__servers.socksPort);
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
proxyServer: async ({ __servers }, run) => {
|
|
|
|
|
__servers.proxyServer.reset();
|
|
|
|
|
await run(__servers.proxyServer);
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
asset: async ({ __servers }, run) => {
|
|
|
|
|
await run(__servers.asset);
|
|
|
|
|
},
|
|
|
|
|
};
|
feat(test runner): replace declare/define with "options" (#10293)
1. Fixtures defined in test.extend() can now have `{ option: true }` configuration that makes them overridable in the config. Options support all other properties of fixtures - value/function, scope, auto.
```
const test = base.extend<MyOptions>({
foo: ['default', { option: true }],
});
```
2. test.declare() and project.define are removed.
3. project.use applies overrides to default option values and nothing else. Any test.extend() and test.use() calls take priority over config options.
Required user changes: if someone used to define fixture options with test.extend(), overriding them in config will stop working. The solution is to add `{ option: true }`.
```
// Old code
export const test = base.extend<{ myOption: number, myFixture: number }>({
myOption: 123,
myFixture: ({ myOption }, use) => use(2 * myOption),
});
// New code
export const test = base.extend<{ myOption: number, myFixture: number }>({
myOption: [123, { option: true }],
myFixture: ({ myOption }, use) => use(2 * myOption),
});
```
2021-11-18 15:45:52 -08:00
|
|
|
|