Skip to content

Commit

Permalink
Merge pull request #46 from gemini-testing/sp.fixTypos
Browse files Browse the repository at this point in the history 
fix: fix typos
  • Loading branch information
@sipayRT
sipayRT authored Dec 2, 2024
2 parents 84c0d79 + 1672473 commit 03ff156
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 46 deletions.
41 changes: 26 additions & 15 deletions docs/reference/testplane-events.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -272,14 +272,27 @@ Or as follows: see the [example](#new_worker_process_usage) from the description
The test runner has a `registerWorkers` method which registers the plugin code for parallel execution in the Testplane workers. The method takes the following parameters:

<table>
<thead>
<tr><td>**Parameter**</td><td>**Type**</td><td>**Description**</td></tr>
</thead>
<tbody>
<tr><td>workerFilepath</td><td>String</td><td>Absolute path to the worker.</td></tr>
<tr><td>exportedMethods</td><td>String[]</td><td>List of exported methods.</td></tr>

</tbody>
<thead>
<tr>
<td>**Parameter**</td>
<td>**Type**</td>
<td>**Description**</td>
</tr>
</thead>
<tbody>
<tr>
<td>workerFilepath</td>
<td>String</td>
<td>Absolute path to the worker.</td>
</tr>
<tr>
<td>exportedMethods</td>
<td>String[]</td>
<td>List of exported methods.</td>
</tr>

</tbody>

</table>

It returns an object which contains asynchronous functions with names from exported methods.
Expand Down Expand Up @@ -421,13 +434,13 @@ Click to see the code
</summary>

```javascript
const http = require('http');
const parseConfig = require('./config');
const http = require("http");
const parseConfig = require("./config");

module.exports = (testplane, opts) => {
const pluginConfig = parseConfig(opts);

if (!pluginConfig.enabled</td></tr> testplane.isWorker()) {
if (!pluginConfig.enabled || testplane.isWorker()) {
// either the plugin is disabled, or we are in the worker context – exit
return;
}
Expand All @@ -436,12 +449,10 @@ module.exports = (testplane, opts) => {

testplane.on(testplane.events.INIT, () => {
// content served by the dev-server
const content = '<h1>Hello, World!</h1>';
const content = "<h1>Hello, World!</h1>";

// create a server and start listening on port 3000
http
.createServer((req, res) => res.end(content))
.listen(3000);
http.createServer((req, res) => res.end(content)).listen(3000);

// at http://localhost:3000/index.html it will serve: <h1>Hello, World!</h1>
});
Expand Down
69 changes: 38 additions & 31 deletions i18n/ru/docusaurus-plugin-content-docs/current/reference/testplane-events.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -273,14 +273,25 @@ module.exports = (testplane, opts) => {
У раннера тестов есть метод `registerWorkers`, который регистрирует код плагина для параллельного выполнения в воркерах testplane. Метод принимает следующие параметры:

<table>
<thead>
<tr><td>**Параметр**</td><td>**Тип**</td><td>**Описание**</td></tr>
</thead>
<tbody>
<tr><td>workerFilepath</td><td>String</td><td>Абсолютный путь к воркеру.</td></tr>
<tr><td>exportedMethods</td><td>String[]</td><td>Список экспортируемых методов.</td></tr>

</tbody>
<thead>
<tr>
<td>>**Параметр**</td>
<td>**Тип**</td>
<td>**Описание**</td>
</tr>
</thead>
<tbody>
<tr>
<td>>workerFilepath</td>
<td>String</td>
<td>Абсолютный путь к воркеру.</td>
</tr>
<tr>
<td>>exportedMethods</td>
<td>String[]</td>
<td>Список экспортируемых методов.</td>
</tr>
</tbody>
</table>

При этом возвращает объект, который содержит асинхронные функции с именами из экспортированных методов.
Expand Down Expand Up @@ -360,22 +371,22 @@ testplane.on(testplane.events.CLI, cli => {
</summary>

```javascript
const parseConfig = require('./config');
const parseConfig = require("./config");

module.exports = (testplane, opts) => {
const pluginConfig = parseConfig(opts);

if (!pluginConfig.enabled <tr><td>testplane.isWorker()) {
if (!pluginConfig.enabled || testplane.isWorker()) {
// или плагин отключен, или мы находимся в контексте воркера – уходим
return;
}

testplane.on(testplane.events.CLI, (cli) => {
testplane.on(testplane.events.CLI, cli => {
// добавляем опцию --repeat
cli.option(
'--repeat <number>',
'how many times tests should be repeated regardless of the result',
(value) => parseNonNegativeInteger(value, 'repeat')
"--repeat <number>",
"how many times tests should be repeated regardless of the result",
value => parseNonNegativeInteger(value, "repeat"),
);
});

Expand Down Expand Up @@ -422,13 +433,13 @@ testplane.on(testplane.events.INIT, async () => {
</summary>

```javascript
const http = require('http');
const parseConfig = require('./config');
const http = require("http");
const parseConfig = require("./config");

module.exports = (testplane, opts) => {
const pluginConfig = parseConfig(opts);

if (!pluginConfig.enabled</td></tr> testplane.isWorker()) {
if (!pluginConfig.enabled || testplane.isWorker()) {
// или плагин отключен, или мы находимся в контексте воркера – уходим
return;
}
Expand All @@ -437,12 +448,10 @@ module.exports = (testplane, opts) => {

testplane.on(testplane.events.INIT, () => {
// контент, который отдает dev-сервер
const content = '<h1>Hello, World!</h1>';
const content = "<h1>Hello, World!</h1>";

// создаем сервер и начинаем слушать порт 3000
http
.createServer((req, res) => res.end(content))
.listen(3000);
http.createServer((req, res) => res.end(content)).listen(3000);

// по адресу http://localhost:3000/index.html будет отдаваться: <h1>Hello, World!</h1>
});
Expand Down Expand Up @@ -1495,45 +1504,43 @@ module.exports = (testplane, opts) => {
**Код плагина**

```javascript
const http = require('http');
const parseConfig = require('./config');
const http = require("http");
const parseConfig = require("./config");

module.exports = (testplane, opts) => {
const pluginConfig = parseConfig(opts);

if (!pluginConfig.enabled <tr><td>testplane.isWorker()) {
if (!pluginConfig.enabled || testplane.isWorker()) {
// или плагин отключен, или мы находимся в контексте воркера – уходим
return;
}

let program;

testplane.on(testplane.events.CLI, (cli) => {
testplane.on(testplane.events.CLI, cli => {
// нужно сохранить ссылку на инстанс commander'а (https://github.com/tj/commander.js),
// чтобы потом проверить наличие опции
program = cli;
// добавляем к testplane опцию --dev-server,
// чтобы пользователь мог явно указывать, когда надо запустить dev-сервер
cli.option('--dev-server', 'run dev-server');
cli.option("--dev-server", "run dev-server");
});

testplane.on(testplane.events.INIT, () => {
// dev-сервер может быть запущен как через указание опции --dev-server
// при запуске testplane, так и в настройках плагина
const devServer = program && program.devServer</td></tr> pluginConfig.devServer;
const devServer = (program && program.devServer) || pluginConfig.devServer;

if (!devServer) {
// если dev-сервер запускать не нужно – уходим
return;
}

// контент, который отдает dev-сервер
const content = '<h1>Hello, World!</h1>';
const content = "<h1>Hello, World!</h1>";

// создаем сервер и начинаем слушать порт 3000
http
.createServer((req, res) => res.end(content))
.listen(3000);
http.createServer((req, res) => res.end(content)).listen(3000);

// по адресу http://localhost:3000/index.html будет отдаваться: <h1>Hello, World!</h1>
});
Expand Down

0 comments on commit 03ff156

Please sign in to comment.