feat(testplane): add afterAll/beforeAll docs

Author: rocketraccoon

docs/command-line/index.mdx

@@ -192,6 +192,7 @@ testplane --repl --grep 'my test name' --browser chrome
 -   `--keep-browser-on-fail` - the same as the `--keep-browser` option, but the browser will only remain open if the tests fail.
 
 Example of console output with connection information to the browser:
+
 ```
 [15:44:38 +0700] Testplane run has finished, but the browser won't be closed, because you passed the --keep-browser argument.
 [15:44:38 +0700] You may attach to this browser using the following capabilities:

docs/commands/browser/restoreState.mdx

@@ -5,8 +5,9 @@
 Browser command that restores session state (cookies, local and session storages) from a file or variable.
 
 <Admonition type="warning">
-    If you are using the `webdriver` automation protocol, you have to provide `webSocketUrl: true` in `desiredCapabilities` in config browser settings.
-    For the `devtools` protocol, you don't need additional settings.
+    If you are using the `webdriver` automation protocol, you have to provide `webSocketUrl: true`
+    in `desiredCapabilities` in config browser settings. For the `devtools` protocol, you don't need
+    additional settings.
 </Admonition>
 
 ## Usage {#usage}
@@ -18,7 +19,7 @@ Data for restore state you can get from the [saveState](../saveState) command.
 
 ```typescript
 await browser.restoreState({
-    path: './stateDump.json',
+    path: "./stateDump.json",
     data: stateDump,
     cookies: true,
     localStorage: true,
@@ -40,17 +41,19 @@ await browser.restoreState({
     <tr><td>sessionStorage</td><td>Boolean</td><td>Enable restore sessionStorage (true by default).</td></tr>
 
     </tbody>
+
 </table>
 
 ## Usage Examples {#examples}
 
 Restore state from file.
+
 ```typescript
 it("test", async ({ browser }) => {
     await browser.url("https://github.com/gemini-testing/testplane");
 
     await browser.restoreState({
-        path: './stateDump.json',
+        path: "./stateDump.json",
     });
 
     // Reload page for see auth result.

docs/commands/browser/saveState.mdx

@@ -7,8 +7,9 @@ import Admonition from "@theme/Admonition";
 Browser command that saves session state (cookies, local and session storages).
 
 <Admonition type="warning">
-    If you are using the `webdriver` automation protocol, you have to provide `webSocketUrl: true` in `desiredCapabilities` in config browser settings.
-    For the `devtools` protocol, you don't need additional settings.
+    If you are using the `webdriver` automation protocol, you have to provide `webSocketUrl: true`
+    in `desiredCapabilities` in config browser settings. For the `devtools` protocol, you don't need
+    additional settings.
 </Admonition>
 
 ## Usage {#usage}
@@ -22,7 +23,7 @@ After saving the state, you can use it in the [restoreState](../restoreState) co
 import type { SaveStateData } from "testplane";
 
 const stateDump: SaveStateData = await browser.saveState({
-    path: './stateDump.json',
+    path: "./stateDump.json",
     cookies: true,
     localStorage: true,
     sessionStorage: true,
@@ -42,17 +43,19 @@ const stateDump: SaveStateData = await browser.saveState({
     <tr><td>sessionStorage</td><td>Boolean</td><td>Enable save sessionStorage (true by default).</td></tr>
 
     </tbody>
+
 </table>
 
 ## Usage Examples {#examples}
 
 Save state in file.
+
 ```typescript
 it("test", async ({ browser }) => {
     await browser.url("https://github.com/gemini-testing/testplane");
 
     await browser.saveState({
-        path: './stateDump.json',
+        path: "./stateDump.json",
     });
 });
 ```

docs/config/after-all.mdx

@@ -0,0 +1,54 @@
+# afterAll
+
+## Overview {#overview}
+
+This parameter is a hook. The function specified for this parameter will be automatically called after tests are completed.
+
+The context of the function is the Testplane config. Also function receive config in arguments.
+
+## Usage Example {#example}
+
+Here is an example of suing this hook for logout.
+
+```typescript title="testplane.config.ts"
+import { launchBrowser } from "testplane/unstable";
+
+export default {
+    // ...
+    browsers: {
+        chrome: {
+            headless: true,
+            desiredCapabilities: {
+                webSocketUrl: true,
+                browserName: "chrome",
+            },
+        },
+        firefox: {
+            headless: true,
+            desiredCapabilities: {
+                webSocketUrl: true,
+                browserName: "firefox",
+            },
+        },
+    },
+    afterAll: async () => {
+        // launch a new browser with existing config
+        const browser = await launchBrowser(this.config.browsers.chrome);
+
+        await browser.url("https://example.com");
+
+        // login using saved state
+        await browser.restoreState({
+            path: "./dump.json",
+        });
+
+        // do logout things (press logout button etc.)
+
+        await browser.deleteSession();
+    },
+};
+```
+
+## Related {#related}
+
+-   [beforeAll](../before-all)

docs/config/before-all.mdx

@@ -0,0 +1,54 @@
+# beforeAll
+
+## Overview {#overview}
+
+This parameter is a hook. The function specified for this parameter will be automatically called before tests running.
+
+The context of the function is the Testplane config. Also function receive config in arguments.
+
+## Usage Example {#example}
+
+Here is an example of using this hook for logging in and getting session data for use in tests.
+
+```typescript title="testplane.config.ts"
+import { launchBrowser } from "testplane/unstable";
+
+export default {
+    // ...
+    browsers: {
+        chrome: {
+            headless: true,
+            desiredCapabilities: {
+                webSocketUrl: true,
+                browserName: "chrome",
+            },
+        },
+        firefox: {
+            headless: true,
+            desiredCapabilities: {
+                webSocketUrl: true,
+                browserName: "firefox",
+            },
+        },
+    },
+    beforeAll: async () => {
+        // launch a new browser with existing config
+        const browser = await launchBrowser(this.config.browsers.chrome);
+
+        await browser.url("https://example.com");
+
+        // do login things, type username/password etc.
+
+        // save dump with state (cookies, localStorage) for using in tests
+        await browser.saveState({
+            path: "./dump.json",
+        });
+
+        await browser.deleteSession();
+    },
+};
+```
+
+## Related {#related}
+
+-   [afterAll](../after-all)

docs/reference/testplane-standalone-api.mdx

@@ -18,7 +18,7 @@ import { launchBrowser } from "testplane/unstable";
 // Launch a new browser with the given settings
 const browser = await launchBrowser({
     desiredCapabilities: {
-        browserName: 'chrome',
+        browserName: "chrome",
     },
     headless: false,
 });

i18n/ru/docusaurus-plugin-content-docs/current/command-line/index.mdx

@@ -193,6 +193,7 @@ testplane --repl --grep 'my test name' --browser chrome
 -   `--keep-browser-on-fail` - то же, что и опция `--keep-browser`, только браузер останется только в том случае, если тесты завершатся неуспешно
 
 Пример вывода в консоли c информацией для подключения к браузеру
+
 ```
 [15:44:38 +0700] Testplane run has finished, but the browser won't be closed, because you passed the --keep-browser argument.
 [15:44:38 +0700] You may attach to this browser using the following capabilities:

i18n/ru/docusaurus-plugin-content-docs/current/commands/browser/restoreState.mdx

@@ -5,8 +5,9 @@
 Команда для восстановления данных (cookies, local and session storages) из файла или объекта.
 
 <Admonition type="warning">
-    Если вы используете `webdriver` automation protocol вы должны установить `webSocketUrl: true` в `desiredCapabilities` для браузера в конфиге.
-    Для `devtools` protocol не нужно дополнительных настроек.
+    Если вы используете `webdriver` automation protocol вы должны установить `webSocketUrl: true` в
+    `desiredCapabilities` для браузера в конфиге. Для `devtools` protocol не нужно дополнительных
+    настроек.
 </Admonition>
 
 ## Использование {#usage}
@@ -30,11 +31,12 @@
     <tr><td>sessionStorage</td><td>Boolean</td><td>Включить восстановление sessionStorage (true по умолчанию).</td></tr>
 
     </tbody>
+
 </table>
 
 ```typescript
 await browser.restoreState({
-    path: './stateDump.json',
+    path: "./stateDump.json",
     data: stateDump,
     cookies: true,
     localStorage: true,
@@ -45,12 +47,13 @@ await browser.restoreState({
 ## Примеры использования {#examples}
 
 Восстановление данных из файла.
+
 ```typescript
 it("test", async ({ browser }) => {
     await browser.url("https://github.com/gemini-testing/testplane");
 
     await browser.restoreState({
-        path: './stateDump.json',
+        path: "./stateDump.json",
     });
 
     // Reload page for see auth result.

i18n/ru/docusaurus-plugin-content-docs/current/commands/browser/saveState.mdx

@@ -7,8 +7,9 @@ import Admonition from "@theme/Admonition";
 Команда для сохранения состояния страницы (cookies, local и session storages).
 
 <Admonition type="warning">
-    Если вы используете `webdriver` automation protocol вы должны установить `webSocketUrl: true` в `desiredCapabilities` для браузера в конфиге.
-    Для `devtools` protocol не нужно дополнительных настроек.
+    Если вы используете `webdriver` automation protocol вы должны установить `webSocketUrl: true` в
+    `desiredCapabilities` для браузера в конфиге. Для `devtools` protocol не нужно дополнительных
+    настроек.
 </Admonition>
 
 ## Использование {#usage}
@@ -22,7 +23,7 @@ import Admonition from "@theme/Admonition";
 import type { SaveStateData } from "testplane";
 
 const stateDump: SaveStateData = await browser.saveState({
-    path: './stateDump.json',
+    path: "./stateDump.json",
     cookies: true,
     localStorage: true,
     sessionStorage: true,
@@ -42,18 +43,19 @@ const stateDump: SaveStateData = await browser.saveState({
     <tr><td>sessionStorage</td><td>Boolean</td><td>Включить сохранение sessionStorage (true по умолчанию).</td></tr>
 
     </tbody>
-</table>
 
+</table>
 
 ## Примеры использования {#examples}
 
 Сохранение данных в файл.
+
 ```typescript
 it("test", async ({ browser }) => {
     await browser.url("https://github.com/gemini-testing/testplane");
 
     await browser.saveState({
-        path: './stateDump.json',
+        path: "./stateDump.json",
     });
 });
 ```

i18n/ru/docusaurus-plugin-content-docs/current/config/after-all.mdx

@@ -0,0 +1,54 @@
+# afterAll
+
+## Обзор {#overview}
+
+Данный параметр является хуком. Функция, заданная для данного параметра, будет автоматически вызвана после прохождения тестов.
+
+Контекстом функции является конфиг Testplane. Так же функция принимает конфиг в аргументе.
+
+## Пример использования {#example}
+
+Пример разлогина после выполнения тестов.
+
+```typescript title="testplane.config.ts"
+import { launchBrowser } from "testplane/unstable";
+
+export default {
+    // ...
+    browsers: {
+        chrome: {
+            headless: true,
+            desiredCapabilities: {
+                webSocketUrl: true,
+                browserName: "chrome",
+            },
+        },
+        firefox: {
+            headless: true,
+            desiredCapabilities: {
+                webSocketUrl: true,
+                browserName: "firefox",
+            },
+        },
+    },
+    afterAll: async () => {
+        // launch a new browser with existing config
+        const browser = await launchBrowser(this.config.browsers.chrome);
+
+        await browser.url("https://example.com");
+
+        // login using saved state
+        await browser.restoreState({
+            path: "./dump.json",
+        });
+
+        // do logout things (press logout button etc.)
+
+        await browser.deleteSession();
+    },
+};
+```
+
+## Связанные хуки {#related}
+
+-   [beforeAll](../before-all)