diff --git a/astro.config.mjs b/astro.config.mjs index 41b47b5b..eb34f4b0 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -294,15 +294,12 @@ export default defineConfig({ label: 'Browser Extension', collapsed: true, items: [ - { label: 'Install and Update', link: '/advanced/browser-extension/install' }, - { label: 'Connect', link: '/advanced/browser-extension/connect' }, - { label: 'Run a Manual Run', link: '/advanced/browser-extension/run-tests' }, - { label: 'Attach a Screenshot', link: '/advanced/browser-extension/screenshots' }, - { label: 'Attach a Screen Recording', link: '/advanced/browser-extension/screen-recording' }, - { label: 'Console & Network Log', link: '/advanced/browser-extension/console-network-log' }, + { label: 'Overview', link: '/advanced/browser-extension' }, + { label: 'Install and Connect', link: '/advanced/browser-extension/install' }, + { label: 'Run Manual Tests', link: '/advanced/browser-extension/run-tests' }, + { label: 'Attach Screenshots, Recordings, and Logs', link: '/advanced/browser-extension/attachments' }, { label: 'Create Tests', link: '/advanced/browser-extension/create-tests' }, - { label: 'Step Recorder', link: '/advanced/browser-extension/step-recorder' }, - { label: 'Settings and Shortcuts', link: '/advanced/browser-extension/settings' }, + { label: 'Settings', link: '/advanced/browser-extension/settings' }, ], }, { diff --git a/redirects.js b/redirects.js index 1b506aae..3973b29f 100644 --- a/redirects.js +++ b/redirects.js @@ -109,6 +109,11 @@ const redirects = { "/project/tests/other-features-for-test-case-design": "/project/tests/sharing-tests-and-suites", "/project/test_design_features": "/project/tests/sharing-tests-and-suites", "/project/copy_move_tests": "/project/tests/copying-tests-and-suites", + "/advanced/browser-extension/connect": "/advanced/browser-extension/install", + "/advanced/browser-extension/screenshots": "/advanced/browser-extension/attachments", + "/advanced/browser-extension/screen-recording": "/advanced/browser-extension/attachments", + "/advanced/browser-extension/console-network-log": "/advanced/browser-extension/attachments", + "/advanced/browser-extension/step-recorder": "/advanced/browser-extension/create-tests", } export default redirects \ No newline at end of file diff --git a/src/content/docs/advanced/browser-extension/attachments.md b/src/content/docs/advanced/browser-extension/attachments.md new file mode 100644 index 00000000..3f0ad8ad --- /dev/null +++ b/src/content/docs/advanced/browser-extension/attachments.md @@ -0,0 +1,102 @@ +--- +title: Attach Screenshots, Recordings, and Logs +description: Capture and annotate screenshots, record and trim screen videos, and collect console and network logs from the tested tab, then attach them to a test result in the Testomat.io browser extension. +type: article +url: https://docs.testomat.io/advanced/browser-extension/attachments/ +head: + - tag: meta + attrs: + name: keywords + content: Testomat.io browser extension, screenshot, annotate, blur, full page screenshot, screen recording, trim video, console log, network log, attachments +--- + +Show what went wrong without leaving the page you're testing. Everything you capture is attached to the result of the test that's open in the panel. + +**Before you start** + +Open a test in a run and expand **Attachments**. If the buttons are greyed out, the reason is shown right below them: the test has no result yet, the run is finished, or the panel is in basic mode. + +## Take a Screenshot + +1. Click **Attach screenshot**. The panel captures the tab and opens the annotation editor on top of the page. +2. Mark up the picture with the tools below. +3. Click **Save** or press `Cmd/Ctrl+Enter`. The screenshot is attached to the result. + +![The annotation editor over the tested page: a box around a field, a blurred address, then Save](./img/attachments/1-attach-screenshot.png) + +Click **Keep original** to attach the screenshot without annotations, or **Discard** (`Esc`) to attach nothing. If you've already added annotations, the panel asks you to confirm. + +| Tool | Key | What It Does | +|---|---|---| +| Select | `V` | Move an annotation, double-click a label to edit it, `Delete` removes it | +| Pen | `P` | Draw freehand | +| Arrow | `A` | Point at something | +| Line | `L` | Draw a straight line | +| Box | `R` | Frame an area | +| Ellipse | `O` | Circle an area | +| Highlight | `H` | Mark with translucent ink | +| Blur | `B` | Hide sensitive data | +| Text | `T` | Click, type, press `Enter` | +| Number | `N` | Add numbered markers 1, 2, 3; `S` / `M` / `L` set the size | +| Crop | `C` | Keep only the selected area | + +You can edit any annotation until you click **Save**. + +:::note + +Blur can't be undone after you save. The blurred pixels are removed from the uploaded file, so it's safe to use on tokens and personal data. + +::: + +### Capture the Full Page + +Turn on **Full page** in **Attachments** before you click **Attach screenshot**. The screenshot then covers the whole page, including the part below the scroll. + +Full-page screenshots use Chrome's debugger, so Chrome shows a "…is debugging this browser" bar during the capture. That's expected — the bar closes by itself. On pages that block the debugger, such as `chrome://` pages, the panel takes a screenshot of the visible area and lets you know. + +## Record Your Screen + +You can start recording in three ways: + +- click **Attach screen recording** in **Attachments**; +- press `Alt+Shift+R` on the page; +- right-click the page and choose **Testomat.io** → start recording. + +While recording, the controls stay on the page: a timer, **Pause / Resume**, and **Stop**. Recordings are without sound. A recording stops on its own after 5 minutes or 50 MB. + +![Recording the tab, stopping, cutting a range, and attaching the video](./img/attachments/2-attach-video.png) + +:::note + +When you start recording from the panel button, Chrome shows a "…is debugging this browser" bar until you stop. To avoid it, start from the page with `Alt+Shift+R` or the right-click menu. + +::: + +### Review and Trim the Recording + +When you click **Stop**, a review window opens over the page with a player and a timeline. + +1. Click **Play** to watch the recording. +2. To cut a part out, drag over it on the timeline. To undo a cut, click ✕ on its chip under the timeline. +3. Click **Attach to the result**. Only the parts you kept are uploaded. + +![The review window over the page: player, timeline, and one cut range](./img/attachments/3-video-review.png) + +Nothing uploads until you decide. If you close the review, the recording waits in the panel, and the button reads **Review recording…**. To delete the recording, click **Discard**. + +## Collect Console and Network Logs + +The panel can record console errors, warnings, and network requests from the tested tab. It keeps the last 60 seconds, so turn recording on **before** you reproduce the bug. + +![Rec is on: the Rec button counts a 401 error, and the Console & network log lists it](./img/attachments/4-rec-log.png) + +1. Open the test and click **Rec** in the panel header. +2. Reproduce the problem on the page. The **Rec** button counts errors as they happen. To see them, open **Console & network log** in the test. Each failed request shows its method, URL, and status. +3. Mark the test **Failed**. The log is attached to the result as a `.txt` file with Console and Network sections. + +For failed requests, the log also saves the first 16 KB of the response body. URLs are saved without query parameters by default, so tokens in links stay out of the file. To change any of this, or the 60-second window, go to [Settings → Failure Log](/advanced/browser-extension/settings/#failure-log). + +## Next Steps + +- [Run Manual Tests](/advanced/browser-extension/run-tests/) +- [Settings](/advanced/browser-extension/settings/) diff --git a/src/content/docs/advanced/browser-extension/connect.md b/src/content/docs/advanced/browser-extension/connect.md deleted file mode 100644 index 5f67e810..00000000 --- a/src/content/docs/advanced/browser-extension/connect.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: "Connect to your project" -type: article ---- - -One authorization connects the panel to your account. It then reads each -project's own API key by itself — there is nothing else to find or paste. - -## Authorize - -1. Click the extension icon. On first run the panel opens its **Connect to - Testomat.io** screen. - - ![The first-run connect screen](img/connect-screen.png) - -2. Press **Open Testomat.io & authorize**. Testomat.io opens in a new tab — - sign in there if you are not — and shows you a token. -3. Copy the token, paste it into **Access token**, press **Connect**. -4. The **Choose a project** screen lists your projects: search, click one, - done. You can switch projects any time from the panel header. - - ![Choosing a project](img/connect-project-pick.png) - -A **General token** (Testomat.io → Account → Access Tokens) works in the same -field. - -## Self-hosted instance - -Using your own Testomat.io server? Before authorizing, open **Advanced** and -put its `https://` URL into **Instance** — the authorize button follows that -field. HTTP URLs are refused. - -## Check or end the connection - -**Settings → Connection** shows the card: which host, the **Connected** -badge, and the current project. **Disconnect** forgets the instance and -returns the panel to the connect screen. - -![The Connection card in Settings](img/connect-connected.png) - -## Basic mode - -Normally you never see this. But when the panel loses its session — an old -token, for example — it does not break, it switches to *basic mode*: runs, -statuses and comments keep working, while finish run, priority, custom -statuses and assignee switch off, and ticked steps stay only in the panel. -A banner says it happened: sign in to Testomat.io in this browser, press -**Refresh** on the banner, and the full panel is back. - -## If it didn't work - -- **"Token rejected by …"** — the token is stale; press **Open Testomat.io & - authorize** again and save the new one. -- **"Instance URL must be https://"** — the panel only connects over HTTPS. -- **"Your access to this project is read-only"** — your role in the project - can't write results (or the project is archived); pick another project or - ask a project owner. -- **A "Basic mode" pill in the run view** — see [Basic mode](#basic-mode) - above. diff --git a/src/content/docs/advanced/browser-extension/console-network-log.md b/src/content/docs/advanced/browser-extension/console-network-log.md deleted file mode 100644 index c37353dd..00000000 --- a/src/content/docs/advanced/browser-extension/console-network-log.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "Console & network log (Rec)" -type: article ---- - -The panel records what the tab under test is doing — console messages and -network calls — into a rolling window, and attaches it to a failed result -as a readable text file. - -## Record - -1. Open the test and press the **Rec** chip in the panel header. Start it - **before** reproducing the bug, not after: the recorder keeps only the - last **60 seconds** (the window size is a Settings → Failure log field). -2. Reproduce the problem on the page. -3. The chip counts errors as they happen, and the **Console & network - log** fold on the test's result tab reads them inline — a failed - request shows its method, URL and status. - - ![Rec is on: the chip counts the 401, the fold lists it](img/console-network-log-fold.png) - -The whole pass, live: - -![Rec on → a 401 on the page → the fold lists it → Failed](img/console-network-log-rec.gif) - -## Attach - -Mark the test **Failed** — the recorded window uploads by itself as a -`.txt` with Console and Network sections, and is linked on the result. -That auto-attach is on by default; **Settings → Failure log** holds the -switches: - -- **Attach log to failures** — the auto-attach itself. -- **Include response bodies** — bodies are kept for failed requests. -- **Record environment info** — browser and system context rides along. -- **Include the query string** — off by default: URLs are logged without - their query part, so tokens in parameters stay out of the file. -- **Auto-start … when you open a test in a run** — arms Rec for you. -- **Log window** — the seconds the recorder keeps. - -## If it didn't work - -- **The log is empty** — recording started after the bug happened, and - the window had already rolled past it. Start Rec first, then reproduce. -- **A request you need isn't there** — the recorder binds to the tab it - was started on; a bug reproduced in another tab was never seen. -- **No log on the result after failing** — check **Attach log to - failures** in Settings → Failure log; in basic mode uploads need the - full session too. diff --git a/src/content/docs/advanced/browser-extension/create-tests.md b/src/content/docs/advanced/browser-extension/create-tests.md index 434f0a16..75adfb5a 100644 --- a/src/content/docs/advanced/browser-extension/create-tests.md +++ b/src/content/docs/advanced/browser-extension/create-tests.md @@ -1,63 +1,89 @@ --- -title: "Create tests" +title: Create Tests +description: Add tests by title, write test cases in Markdown, record test steps from your actions on a website, and add parameters in the Testomat.io browser extension. type: article +url: https://docs.testomat.io/advanced/browser-extension/create-tests/ +head: + - tag: meta + attrs: + name: keywords + content: Testomat.io browser extension, create test, bulk add, Markdown editor, step recorder, record steps, parameters, Polish with AI --- -The **Tests** tab browses the project's suites and lets you add test cases -without leaving the panel — by title alone, or written out in the editor. +Write new test cases while you explore the website. The **Tests** tab shows the project's suite tree with test counts. -## Browse +![The Tests tab with the suite tree](./img/create-tests/1-test-tree.png) -The tab shows the suite tree with test counts. Folders group suites; -clicking a suite opens its test list; clicking a test opens it — an -existing case renders read-only until you choose to edit. +## Add Tests by Title -![The suite tree](img/create-tests-tree.png) +1. Open a suite. +2. Type a title in **Add new test** at the bottom and click **Create** or press `Enter`. -## Add by title +![Adding one test by title, then several with Bulk](./img/create-tests/2-quick-add-tests.png) -Open a suite. The bar at the bottom adds a test **right here**: +The test is added to the suite, and you can fill it in later. -1. Type the title into **Add new test**, press **Create** (or Enter) — - the case appears in the list, empty for now. -2. Flip **Bulk** and the field becomes a list — one title per line, one - press, the whole list is created in order. +To add several tests at once, turn on **Bulk** and enter one title per line. The tests are created in the same order. -![One title, then a bulk list](img/create-tests-quick-add.gif) +## Write a Test in the Editor -Bulk add needs the full (not basic) mode. +1. Click **New test**. The editor opens. +2. Enter the title. If you started from the top of the tree, choose a suite. +3. Write the description and steps in Markdown. +4. Save the test. -## Write it out in the editor +![The test editor with Markdown steps and the Record steps, Polish with AI, and Parameters controls](./img/create-tests/3-extension-test-editor.png) -**New test** opens the editor: the title, a Markdown body with live -preview, and a suite picker if you started from the tree root. Steps are -plain Markdown lists; the toolbar records steps for you (see -[Step recorder](step-recorder.md)) and can hand the draft to your -Testomat.io AI to be rewritten — with an Undo. +To create a suite or folder, use the **+** buttons in the tree. -![The editor: Markdown, Record steps, Polish with AI, Parameters](img/create-tests-editor.png) +## Record Steps -New suites and folders are made from the tree's own + buttons. +Instead of typing steps, go through the flow on the website once. The extension turns your clicks, text entry, selections, and page navigation into readable steps. -## Parameters +1. Open the website you want to test, then start a new test in the editor. +2. Click **Record steps**. A recording bar appears in the bottom-right corner of the page. +3. Go through the flow. Each action appears in the test's steps a second after you do it. +4. Click **Stop** in the bar or in the editor. -A test that should run once per data row gets **parameters** — edited in -the same editor: +![Recording steps: actions on the page appear as steps in the editor](./img/create-tests/3-extension-test-editor.png) -1. Name the columns (say `role`, `email`). -2. Fill one example row per variant. -3. Write `${role}` and `${email}` in the title or steps. +Recorded steps read like this: *Click the "Add to cart" button*, *Type "pliers" into the Search field*. When a page opens, the extension adds an `Expected:` line under the step that opened it, for example *The "Cart" page opens*. -In a run, such a test shows one row per example, each marked on its own. +![Recorded steps in the editor, one with an Expected line](./img/create-tests/4-record-steps.png) -![A parametrized test rendered: the table under the steps](img/create-tests-params.png) +While recording: -## If it didn't work +- **+ Expected** adds your own expected result to the last step. Type it and press `Enter`. +- **Pause** stops recording for a moment, for example to do something that isn't part of the test. Click **Resume** to continue. +- After 50 steps, recording pauses and asks **Still recording?**. Click **Continue** to add 50 more. -- **Create is greyed out** — the title is empty, or the panel is in basic - mode (bulk add and the editor's server features need the session). -- **`${name}` shows literally in a run** — the test has no example rows - yet; add at least one in the editor's Parameters. -- **A new test is not in the web app yet** — give the panel a moment or - press Refresh there; the panel writes through the same API the web - reads. +![Test steps being recorded](./img/create-tests/5-steps-being-recorded.png) + +### Sensitive Values + +The extension recognizes passwords, card numbers, one-time codes, and similar fields, and doesn't save their values. The step names the field but not what you typed: *Type the password into the Password field*. + +This works on a best-effort basis. If the website handles real payment or personal data, turn on **Never record entered values** in [Settings](/advanced/browser-extension/settings/#step-recorder) — then no typed value is saved. + +### Polish with AI + +If Testomat.io AI is enabled for your company, turn on **Polish with AI** next to **Record steps**. When you stop recording, the AI rewrites the steps in clearer language. To get the original wording back, click **Undo polish**. + +If AI isn't available for your company, the switch stays off and tells you why when you click it, and nothing is sent. On a Testomat.io server without AI, the switch isn't shown. + +## Add Parameters + +Use parameters to run the same test with different data, such as different user roles. + +1. In the editor, open **Parameters** and name the columns, for example `role` and `email`. +2. Add one row per data set. +3. Use `${role}` and `${email}` in the title or steps. + +![A test with parameters: the steps and the example table under them](./img/create-tests/6-test-params.png) + +In a run, the test shows one row per data set, and you mark each one separately. + +## Next Steps + +- [Run Manual Tests](/advanced/browser-extension/run-tests/) +- [Settings](/advanced/browser-extension/settings/) diff --git a/src/content/docs/advanced/browser-extension/img/2-extension-on-page.png b/src/content/docs/advanced/browser-extension/img/2-extension-on-page.png new file mode 100644 index 00000000..ae7379f0 Binary files /dev/null and b/src/content/docs/advanced/browser-extension/img/2-extension-on-page.png differ diff --git a/src/content/docs/advanced/browser-extension/img/attachments/1-attach-screenshot.png b/src/content/docs/advanced/browser-extension/img/attachments/1-attach-screenshot.png new file mode 100644 index 00000000..84bfa5cc Binary files /dev/null and b/src/content/docs/advanced/browser-extension/img/attachments/1-attach-screenshot.png differ diff --git a/src/content/docs/advanced/browser-extension/img/attachments/2-attach-video.png b/src/content/docs/advanced/browser-extension/img/attachments/2-attach-video.png new file mode 100644 index 00000000..6b904167 Binary files /dev/null and b/src/content/docs/advanced/browser-extension/img/attachments/2-attach-video.png differ diff --git a/src/content/docs/advanced/browser-extension/img/attachments/3-video-review.png b/src/content/docs/advanced/browser-extension/img/attachments/3-video-review.png new file mode 100644 index 00000000..e91efa3d Binary files /dev/null and b/src/content/docs/advanced/browser-extension/img/attachments/3-video-review.png differ diff --git a/src/content/docs/advanced/browser-extension/img/attachments/4-rec-log.png b/src/content/docs/advanced/browser-extension/img/attachments/4-rec-log.png new file mode 100644 index 00000000..eb2a7a7a Binary files /dev/null and b/src/content/docs/advanced/browser-extension/img/attachments/4-rec-log.png differ diff --git a/src/content/docs/advanced/browser-extension/img/browser-extension-features.png b/src/content/docs/advanced/browser-extension/img/browser-extension-features.png new file mode 100644 index 00000000..401e401c Binary files /dev/null and b/src/content/docs/advanced/browser-extension/img/browser-extension-features.png differ diff --git a/src/content/docs/advanced/browser-extension/img/console-network-log-rec.gif b/src/content/docs/advanced/browser-extension/img/console-network-log-rec.gif deleted file mode 100644 index 4d307464..00000000 Binary files a/src/content/docs/advanced/browser-extension/img/console-network-log-rec.gif and /dev/null differ diff --git a/src/content/docs/advanced/browser-extension/img/create-tests/1-test-tree.png b/src/content/docs/advanced/browser-extension/img/create-tests/1-test-tree.png new file mode 100644 index 00000000..d1b47636 Binary files /dev/null and b/src/content/docs/advanced/browser-extension/img/create-tests/1-test-tree.png differ diff --git a/src/content/docs/advanced/browser-extension/img/create-tests/2-quick-add-tests.png b/src/content/docs/advanced/browser-extension/img/create-tests/2-quick-add-tests.png new file mode 100644 index 00000000..02bf5332 Binary files /dev/null and b/src/content/docs/advanced/browser-extension/img/create-tests/2-quick-add-tests.png differ diff --git a/src/content/docs/advanced/browser-extension/img/create-tests/3-extension-test-editor.png b/src/content/docs/advanced/browser-extension/img/create-tests/3-extension-test-editor.png new file mode 100644 index 00000000..1cae6bfe Binary files /dev/null and b/src/content/docs/advanced/browser-extension/img/create-tests/3-extension-test-editor.png differ diff --git a/src/content/docs/advanced/browser-extension/img/create-tests/4-record-steps.png b/src/content/docs/advanced/browser-extension/img/create-tests/4-record-steps.png new file mode 100644 index 00000000..aa53b891 Binary files /dev/null and b/src/content/docs/advanced/browser-extension/img/create-tests/4-record-steps.png differ diff --git a/src/content/docs/advanced/browser-extension/img/create-tests/5-steps-being-recorded.png b/src/content/docs/advanced/browser-extension/img/create-tests/5-steps-being-recorded.png new file mode 100644 index 00000000..d768d077 Binary files /dev/null and b/src/content/docs/advanced/browser-extension/img/create-tests/5-steps-being-recorded.png differ diff --git a/src/content/docs/advanced/browser-extension/img/create-tests/6-test-params.png b/src/content/docs/advanced/browser-extension/img/create-tests/6-test-params.png new file mode 100644 index 00000000..fc42742f Binary files /dev/null and b/src/content/docs/advanced/browser-extension/img/create-tests/6-test-params.png differ diff --git a/src/content/docs/advanced/browser-extension/img/install-card-reload.png b/src/content/docs/advanced/browser-extension/img/install-card-reload.png deleted file mode 100644 index 29fbd639..00000000 Binary files a/src/content/docs/advanced/browser-extension/img/install-card-reload.png and /dev/null differ diff --git a/src/content/docs/advanced/browser-extension/img/install-load-unpacked.png b/src/content/docs/advanced/browser-extension/img/install-load-unpacked.png deleted file mode 100644 index 62396729..00000000 Binary files a/src/content/docs/advanced/browser-extension/img/install-load-unpacked.png and /dev/null differ diff --git a/src/content/docs/advanced/browser-extension/img/install-release-zip.png b/src/content/docs/advanced/browser-extension/img/install-release-zip.png deleted file mode 100644 index 106372a0..00000000 Binary files a/src/content/docs/advanced/browser-extension/img/install-release-zip.png and /dev/null differ diff --git a/src/content/docs/advanced/browser-extension/img/install/1-authorize-via-testomat.png b/src/content/docs/advanced/browser-extension/img/install/1-authorize-via-testomat.png new file mode 100644 index 00000000..56396d8c Binary files /dev/null and b/src/content/docs/advanced/browser-extension/img/install/1-authorize-via-testomat.png differ diff --git a/src/content/docs/advanced/browser-extension/img/install/2-check-connection.png b/src/content/docs/advanced/browser-extension/img/install/2-check-connection.png new file mode 100644 index 00000000..daebfcd1 Binary files /dev/null and b/src/content/docs/advanced/browser-extension/img/install/2-check-connection.png differ diff --git a/src/content/docs/advanced/browser-extension/img/install/3-advanced-connection.png b/src/content/docs/advanced/browser-extension/img/install/3-advanced-connection.png new file mode 100644 index 00000000..a1e66da4 Binary files /dev/null and b/src/content/docs/advanced/browser-extension/img/install/3-advanced-connection.png differ diff --git a/src/content/docs/advanced/browser-extension/img/install/4-install-from-github.png b/src/content/docs/advanced/browser-extension/img/install/4-install-from-github.png new file mode 100644 index 00000000..cd3b0747 Binary files /dev/null and b/src/content/docs/advanced/browser-extension/img/install/4-install-from-github.png differ diff --git a/src/content/docs/advanced/browser-extension/img/run-tests-test-view.png b/src/content/docs/advanced/browser-extension/img/run-tests-test-view.png deleted file mode 100644 index 3eceed3f..00000000 Binary files a/src/content/docs/advanced/browser-extension/img/run-tests-test-view.png and /dev/null differ diff --git a/src/content/docs/advanced/browser-extension/img/run-tests/1-run-search.png b/src/content/docs/advanced/browser-extension/img/run-tests/1-run-search.png new file mode 100644 index 00000000..8275e7f0 Binary files /dev/null and b/src/content/docs/advanced/browser-extension/img/run-tests/1-run-search.png differ diff --git a/src/content/docs/advanced/browser-extension/img/run-tests/2-run-view.png b/src/content/docs/advanced/browser-extension/img/run-tests/2-run-view.png new file mode 100644 index 00000000..0e712dac Binary files /dev/null and b/src/content/docs/advanced/browser-extension/img/run-tests/2-run-view.png differ diff --git a/src/content/docs/advanced/browser-extension/img/run-tests/3-steps-requirements.png b/src/content/docs/advanced/browser-extension/img/run-tests/3-steps-requirements.png new file mode 100644 index 00000000..99e52486 Binary files /dev/null and b/src/content/docs/advanced/browser-extension/img/run-tests/3-steps-requirements.png differ diff --git a/src/content/docs/advanced/browser-extension/img/settings/1-settings-pt1.png b/src/content/docs/advanced/browser-extension/img/settings/1-settings-pt1.png new file mode 100644 index 00000000..c5fc2524 Binary files /dev/null and b/src/content/docs/advanced/browser-extension/img/settings/1-settings-pt1.png differ diff --git a/src/content/docs/advanced/browser-extension/img/settings/2-settings-pt2.png b/src/content/docs/advanced/browser-extension/img/settings/2-settings-pt2.png new file mode 100644 index 00000000..b5e3473a Binary files /dev/null and b/src/content/docs/advanced/browser-extension/img/settings/2-settings-pt2.png differ diff --git a/src/content/docs/advanced/browser-extension/img/settings/3-settings-diagnostics.png b/src/content/docs/advanced/browser-extension/img/settings/3-settings-diagnostics.png new file mode 100644 index 00000000..bacb4d93 Binary files /dev/null and b/src/content/docs/advanced/browser-extension/img/settings/3-settings-diagnostics.png differ diff --git a/src/content/docs/advanced/browser-extension/index.md b/src/content/docs/advanced/browser-extension/index.md new file mode 100644 index 00000000..8ba478b3 --- /dev/null +++ b/src/content/docs/advanced/browser-extension/index.md @@ -0,0 +1,61 @@ +--- +title: Testomat.io Browser Extension +description: Run manual tests, capture screenshots, screen recordings, and browser logs, and create test cases in a Chrome side panel next to the website you're testing. +type: article +url: https://docs.testomat.io/advanced/browser-extension/ +head: + - tag: meta + attrs: + name: keywords + content: Testomat.io browser extension, Chrome extension, manual testing, side panel, screenshots, screen recording, console log, network log, step recorder +--- + +The Testomat.io Browser Extension opens your tests in a Chrome side panel, right next to the website you're testing. Run tests, collect evidence, and write new test cases without switching tabs. + + +![The Testomat.io extension and what it does: run manual tests, capture screenshots, record your screen, collect browser logs, record test steps, and create tests](./img/browser-extension-features.png) + +## What You Can Do + +| Task | What It Does | +|---|---| +| [Run manual tests](/advanced/browser-extension/run-tests/) | Follow test steps, mark each test as Passed, Failed, or Skipped, and add comments | +| [Capture screenshots](/advanced/browser-extension/attachments/) | Take a screenshot of the visible tab or the full page, then annotate, crop, or blur it | +| [Record your screen](/advanced/browser-extension/attachments/) | Record the tab you're testing and trim the video before attaching it | +| [Collect browser logs](/advanced/browser-extension/attachments/) | Capture console errors, warnings, and network requests, and attach them to a failed test | +| [Create tests](/advanced/browser-extension/create-tests/) | Add a test by title or write it in Markdown, with parameters | +| [Record test steps](/advanced/browser-extension/create-tests/#record-steps) | Go through a flow on the website — the extension writes the steps for you | + +## Requirements + +- A Testomat.io account on app.testomat.io or a self-hosted Testomat.io instance. +- Google Chrome 123 or newer. + +## Privacy + +- The extension has no server of its own. Everything you upload goes directly to the Testomat.io instance you connect it to. +- Your access token is stored in your browser. The extension also reads project members' names, email addresses, avatars, and time zones so you can see and assign tests. +- Screenshots, recordings, logs, and recorded steps can contain anything visible on the tested website, including personal or payment details. Password and card fields are masked in recorded steps on a best-effort basis. +- If you use app.testomat.io and turn on **Polish with AI**, the selected content is sent to Testomat.io's AI provider, Groq. +- The extension has no analytics, telemetry, or ads. + +To see exactly what is stored and sent, why the extension needs each Chrome permission, and how to turn each feature off, read [PRIVACY.md on GitHub](https://github.com/testomatio/browser-extension/blob/main/PRIVACY.md). For Testomat.io as a whole, see the [Testomat.io Privacy Policy](https://testomat.io/privacy-policy/). + +## Open Source + +The extension is open source under the MIT license. The source code and developer docs are on [GitHub](https://github.com/testomatio/browser-extension). + +### Report a Bug or Request a Feature + +Open an issue in the [extension's GitHub repository](https://github.com/testomatio/browser-extension/issues). To help us fix it faster, include: + +- what you clicked and what happened, with the exact wording of any message; +- your Chrome version (see `chrome://settings/help`); +- whether the **Basic mode** pill was showing in the panel. + +Leave out access tokens and any run URLs you'd rather keep private. + +## Next Steps + +- [Install and Connect](/advanced/browser-extension/install/) +- [Run Manual Tests](/advanced/browser-extension/run-tests/) diff --git a/src/content/docs/advanced/browser-extension/install.md b/src/content/docs/advanced/browser-extension/install.md index 27645380..034e9203 100644 --- a/src/content/docs/advanced/browser-extension/install.md +++ b/src/content/docs/advanced/browser-extension/install.md @@ -1,82 +1,95 @@ --- -title: "Install and update" +title: Install and Connect +description: Install the Testomat.io Browser Extension from the Chrome Web Store and connect it to your Testomat.io project, including self-hosted instances. type: article +url: https://docs.testomat.io/advanced/browser-extension/install/ +head: + - tag: meta + attrs: + name: keywords + content: Testomat.io browser extension, install, Chrome Web Store, connect, access token, self-hosted, basic mode --- -Install the extension from the Chrome Web Store. Chrome 123 or newer. +Add the extension to Chrome and connect it to your project. It takes a couple of minutes, and you do it only once. -## Install +## Install from the Chrome Web Store -1. Open [Testomat.io in the Chrome Web Store](https://chromewebstore.google.com/detail/testomatio/amcnjlghmkkjfaajanfeghpgbjakdcka) - and click **Add to Chrome**, then **Add extension**. -2. Click the puzzle icon in Chrome's toolbar and pin **Testomat.io** with the - pushpin: +1. Open [Testomat.io on the Chrome Web Store](https://chromewebstore.google.com/detail/testomatio/amcnjlghmkkjfaajanfeghpgbjakdcka). +2. Click **Add to Chrome**, then click **Add extension** in the dialog. +3. Click the puzzle icon in Chrome's toolbar, then click the pushpin next to **Testomat.io**. The extension icon now stays in the toolbar. +4. Click the Testomat.io icon. The side panel opens on the **Connect to Testomat.io** screen. - ![Pinning Testomat.io from the puzzle menu](img/install-pin.png) -3. Click the pinned icon — the panel opens and asks you to connect - (**Connect to Testomat.io**). That is the next page: [Connect](connect.md). +## Connect to Your Project -## Update +You authorize once. After that, the extension finds each project's API key on its own, so you don't need to copy any keys. -Chrome updates the extension by itself. Your token, settings and unsent -results survive an update. +![The Connect to Testomat.io screen in the side panel](./img/install/1-authorize-via-testomat.png) -## If it didn't work +1. Click **Open Testomat.io & authorize**. Testomat.io opens in a new tab and shows an access token. Sign in first if it asks you to. +2. Copy the token, paste it into **Access token**, and click **Connect**. +3. On the **Choose a project** screen, find your project and click it. -- **Chrome refuses to add it** — check your Chrome is 123 or newer - (`chrome://settings/help`). +That's it — the panel is connected. You can switch to another project any time from the panel header. -## Install from source +:::note -For developers: run the code from this repository instead of the store copy. -The source copy has the same ID as the store copy, so Chrome holds only one of -them: remove the store copy on `chrome://extensions` first. Removing it -deletes its token and settings, so you connect again. +A **General token** works too. Create one in Testomat.io under **Account → Access Tokens** and paste it into **Access token**. -1. Get the folder — either way works: - - download the newest `testomat-io-.zip` from - [Releases](https://github.com/testomatio/browser-extension/releases) — - the file under **Assets** without `-webstore` in its name (that one is - the Chrome Web Store upload) — and unpack it, **or** +::: - ![The zip under Assets on the Releases page](img/install-release-zip.png) +### Connect a Self-Hosted Instance - - `git clone https://github.com/testomatio/browser-extension.git` -2. Open `chrome://extensions` and switch on **Developer mode** (top right). -3. Click **Load unpacked**: +If your company runs its own Testomat.io server, set its address before you authorize: - ![Load unpacked on chrome://extensions](img/install-load-unpacked.png) +1. On the connect screen, open **Advanced**. +2. Enter your server's `https://` URL in **Instance**. The panel connects only over HTTPS. +3. Continue from step 1 of [Connect to Your Project](#connect-to-your-project). The authorize button now opens your server. - …and pick the folder: - - from the zip — the folder you unpacked; - - from the clone — the **`extension/`** folder inside it, not the - repository root. +![Advanced options for Testomat.io extension](./img/install/3-advanced-connection.png) - Either way, the right folder is the one with `manifest.json` directly - inside. +## Check or End the Connection -4. Pin the icon and connect, as in steps 2–3 of [Install](#install). +1. Open **Settings**. +2. Go to **Connection**. The card shows the server you're connected to, the **Connected** badge, and the current project. +3. To disconnect, click **Disconnect** — the panel returns to the connect screen. -There is nothing to build or install beyond that — the folder runs as is. +![The Connection card in Settings](./img/install/2-check-connection.png) -### Update a source copy +## Basic Mode -A source copy does not update itself. To get a new version: +If the panel loses its session with Testomat.io, it switches to basic mode instead of stopping. A banner tells you when this happens. -1. Replace the folder contents: unpack a newer zip over the same folder, or - `git pull` in the clone. -2. On `chrome://extensions`, press the reload (↻) icon on the Testomat.io - card: +In basic mode you can still open runs, set statuses, and add comments. These features turn off until the session is back: - ![The reload icon on the extension card](img/install-card-reload.png) +- finishing a run; +- priority, custom statuses, and assignee; +- syncing ticked steps — they stay only in your panel. -Your token, settings and unsent results survive the reload. +To get the full panel back, sign in to Testomat.io in the same browser and click **Refresh** on the banner. -### If a source copy didn't work +## Install from GitHub -- **"Load unpacked" is missing** — Developer mode is off; the switch is in - the top right corner of `chrome://extensions`. -- **"Manifest file is missing or unreadable"** — you picked the repository - root; pick the `extension/` folder inside it. -- **Updated, but behaves like the old version** — press reload (↻) on the - extension's card; replacing the files alone is not enough. +![Install from GitHub in six steps: download the code, open chrome://extensions, turn on Developer mode, click Load unpacked, select the folder, then pin the icon and connect](./img/install/4-install-from-github.png) + +The extension is available on [GitHub](https://github.com/testomatio/browser-extension). Run the source code instead of the store version. The GitHub copy and the store copy share the same ID, so Chrome keeps only one of them. + +1. Get the extension folder in one of two ways: + - download the newest `testomat-io-.zip` from [Releases](https://github.com/testomatio/browser-extension/releases) — the file under **Assets** without `-webstore` in its name — and unpack it; + - or clone the repository: `git clone https://github.com/testomatio/browser-extension.git`. +2. Open `chrome://extensions`. +3. Turn on **Developer mode** in the top-right corner. +4. Click **Load unpacked** and select the folder that has `manifest.json` directly inside: the unpacked folder from the zip, or the `extension/` folder in the cloned repository. +5. Pin the icon and connect, as described in [Install from the Chrome Web Store](#install-from-the-chrome-web-store) and [Connect to Your Project](#connect-to-your-project). + +A copy loaded from GitHub doesn't update on its own. To update it, replace the folder contents with a newer version (or run `git pull`), then click the reload icon on the Testomat.io card in `chrome://extensions`. Your token, settings, and unsent results stay after the reload. + +:::note + +Before you start, remove the store copy in `chrome://extensions`. This also deletes its token and settings, so you'll need to connect again. + +::: + +## Next Steps + +- [Run Manual Tests](/advanced/browser-extension/run-tests/) +- [Create Tests](/advanced/browser-extension/create-tests/) diff --git a/src/content/docs/advanced/browser-extension/run-tests.md b/src/content/docs/advanced/browser-extension/run-tests.md index 9c7b86b7..d56d5dd8 100644 --- a/src/content/docs/advanced/browser-extension/run-tests.md +++ b/src/content/docs/advanced/browser-extension/run-tests.md @@ -1,84 +1,71 @@ --- -title: "Run a manual run" +title: Run Manual Tests +description: Open a Testomat.io run in the browser extension, mark tests and steps, use keyboard shortcuts, and finish the run next to the website you're testing. type: article +url: https://docs.testomat.io/advanced/browser-extension/run-tests/ +head: + - tag: meta + attrs: + name: keywords + content: Testomat.io browser extension, manual run, mark test, passed, failed, skipped, keyboard shortcuts, finish run --- -You open a run, walk its tests next to the site under test, and mark each -one. Nothing ever navigates on its own — you move on when you choose to. +Go through a run in the side panel while the website you're testing stays open next to it. The panel never moves on by itself — you go to the next test when you're ready. -## Open a run +## Open a Run -1. **Runs** tab. The list shows the project's runs with their progress. -2. Click a run — or paste a run's URL from the web app into the search box; - the same box also filters the list by title as you type. (**New run** - opens the web app's create-run page — runs are made there and then show - up in this list.) +1. Open the **Runs** tab. +2. Click a run. +3. The run opens as a checklist grouped by suite, with a progress bar and status filters. - ![The Runs tab](img/run-tests-list.png) +![A run open as a checklist, with one suite expanded](./img/run-tests/2-run-view.png) -The run opens as a checklist grouped by suite, with a progress bar and -status chips to filter by. +To create a new run, click **New run**. It opens the run creation page in Testomat.io. When you save the run, it appears in this list. -![The run checklist, one suite open](img/run-tests-run-view.png) +To find run fast, type part of its title in the search box or paste the run's URL from Testomat.io. -## Mark a test +![The Runs tab in the side panel](./img/run-tests/1-run-search.png) -Quick marks live right on the checklist: every row carries its own -✓ / ✗ / − buttons. For everything else — steps, a comment, the log — -click the test's title to open it. +## Mark Tests -![Ticking steps, marking passed, jumping to the next test](img/run-tests-mark.gif) +To mark a test quickly, use the ✓ / ✗ / − buttons on its row in the checklist. To tick steps, click the test's title to open it: -- **Steps** tick on click: once for pass, again for fail, again for skip. - Ticks sync to the server so a colleague sees them (in basic mode they - stay local). -- **Passed / Failed / Skipped** save immediately and stay put — moving on - is the **›** arrow of the *n of N* pager under the progress bar, or the - hotkeys below. -- A comment saved with a status lands on the result in the web app too. -- Failing a test can attach the console & network log of the tab under - test automatically — that is the [Rec recorder](console-network-log.md). -- A parametrized test shows one row per example; each row is marked on its - own. +1. Click a step to tick it: once for passed, twice for failed, three times for skipped. +2. Add a comment if you need one. +3. Click **Passed**, **Failed**, or **Skipped**. The result saves with the comment. +4. Go to the next test with the **›** arrow under the progress bar, or press `N`. -Hotkeys, in the test view only: +![Ticking steps, marking a test as Passed, and moving to the next test](./img/run-tests/3-steps-requirements.png) + +A test with parameters shows one row per example. Mark each row on its own. + +When you mark a test **Failed**, the panel can attach the browser log to it automatically. See [Attach Screenshots, Recordings, and Logs](/advanced/browser-extension/attachments/#collect-console-and-network-logs). + +## Keyboard Shortcuts + +These shortcuts work in an open test when no text field is active. Cmd and Ctrl both work on any system. | Keys | Action | |---|---| | `Cmd/Ctrl+Enter` | Passed | | `Cmd/Ctrl+U` | Failed | | `Cmd/Ctrl+I` | Skipped | -| `N` | Next still-untested test | +| `N` | Next untested test | | `↓` / `→`, `↑` / `←` | Next / previous test | -![A failed test open: steps, statuses, the result](img/run-tests-test-view.png) - -## Stay in sync +To see this list in the panel, click **?** next to the test pager. -An open run re-reads itself about every 20 seconds while you look at it, so -a colleague's marks land on their own. The server's state wins; your own -in-flight write is never overwritten by a poll. +## Finish the Run -## Finish the run +Click **Finish run** at the top of the run. Confirm in the dialog — any tests you haven't marked become Skipped. -**Finish run** on the run screen asks once — *"Finish run? Pending tests -will be marked skipped."* — and closes the run. It needs the full (not -basic) mode. +## Work with Colleagues and Offline -## If the network drops +While a run is open, the panel refreshes it about every 20 seconds, so you see your colleagues' results. To refresh right now, click Refresh in the panel header. -A status that fails to save is not lost: it queues in the panel, the row -gets a `queued` badge, and a bar counts the *changes pending*. They replay -when the connection returns — or press **Retry** on the bar. +If your connection drops, your results aren't lost. They wait in the panel with a `queued` badge and are sent when the connection returns, as long as the panel stays open. To send them right away, click **Retry**. -## If it didn't work +## Next Steps -- **The run you pasted doesn't open** — the panel says when a URL leads - nowhere it can reach: check the project the panel is on matches the URL. -- **Finish run is greyed out** — *"Finish run needs an active … web login"*: - you are in basic mode; see [Connect](connect.md#basic-mode). -- **Ticked steps aren't visible to a colleague** — basic mode again; steps - sync only with a session. -- **Marks from a colleague don't appear** — the panel polls only while the - run is open and the panel is visible; press the header's Refresh for an - immediate pull. +- [Attach Screenshots, Recordings, and Logs](/advanced/browser-extension/attachments/) +- [Create Tests](/advanced/browser-extension/create-tests/) diff --git a/src/content/docs/advanced/browser-extension/screen-recording.md b/src/content/docs/advanced/browser-extension/screen-recording.md deleted file mode 100644 index 152d9c07..00000000 --- a/src/content/docs/advanced/browser-extension/screen-recording.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: "Attach a screen recording" -type: article ---- - -The panel records the tab you are testing into a `.webm` — no audio — and -lets you review and trim it before anything uploads. - -## Record - -Three ways to start, same recording: - -- **Attach screen recording** in the test's **Attachments** fold; -- `Alt+Shift+R` while you are on the page; -- right-click the page → **Testomat.io** → start recording. - -While it runs, the controls sit on the page itself, where you are looking: -a timer, **Pause / Resume**, **Stop**. - -![Record, stop, cut a range, attach](img/screen-recording-flow.gif) - -The recording stops itself at **5 minutes** or **50 MB** — the bar says -which limit was hit. - -One Chrome quirk worth knowing: the fast capture route works when you -start *from the page* (the hotkey or the right-click item). Starting from -the panel button records over Chrome's DevTools protocol instead — same -file, but Chrome shows its *"…is debugging this browser"* bar while it -runs. That bar is expected; it goes away at Stop. - -## Review and trim - -Every **Stop** opens a review right over the page: a player and a -timeline. - -![The review over the page: player, timeline, a cut](img/screen-recording-review.png) - -- **Play** previews exactly what will upload — it skips what you cut. -- **Drag on the timeline** to cut a range out; cut as many ranges as you - like, anywhere. Each cut becomes a chip under the timeline with an ✕ to - undo it. -- **Attach to the result** uploads the kept parts. With cuts, the panel - re-records the kept ranges once ("replays" them) — the uploaded file is - a normal video, and the uncut original is destroyed in the same moment. -- **Discard** deletes the take. Uploading never happens by itself: - closing the review keeps the take parked, and the panel button reads - **Review recording…** until you decide. - -## If it didn't work - -- **"…is debugging this browser" appeared** — expected on a panel-started - recording; see above. -- **Chrome refuses to start on this page** — the panel quotes Chrome's own - reason. A leftover frame from a disabled extension can cause it; the - panel works around that by itself, but if Chrome still refuses, reload - the page once and start again. -- **It stopped on its own** — the bar said why: *"Time limit reached"* - (5 min) or *"Size limit reached"* (50 MB). Attach what you have and - start another take if needed. -- **No sound in the file** — by design; the tab's audio is never captured. diff --git a/src/content/docs/advanced/browser-extension/screenshots.md b/src/content/docs/advanced/browser-extension/screenshots.md deleted file mode 100644 index 845bd4a2..00000000 --- a/src/content/docs/advanced/browser-extension/screenshots.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: "Attach a screenshot" -type: article ---- - -The panel captures the tab you are testing and opens an annotator right -over that page. Nothing uploads until you press **Save** there. - -## Take and annotate - -1. Open the test in the panel and unfold **Attachments**. -2. Press **Attach screenshot**. The picture is taken and the annotator - opens over the page itself. - - ![Box the field, blur the address, Save](img/screenshots-annotate.gif) - -3. Mark it up and press **Save** (`Cmd/Ctrl+Enter`) — the annotated image - lands on the test's attachments. The other two ways out: **Keep - original** attaches the raw shot, **Discard** attaches nothing. Both - ask first once you have marked the picture up, and `Esc` is **Discard**. - -The tools, each with a one-letter hotkey: - -| Tool | Key | What it does | -|---|---|---| -| Select | `V` | Drag to move an annotation, double-click a label to retype, `Delete` removes | -| Pen | `P` | Freehand line | -| Arrow | `A` | Point at something | -| Line | `L` | Straight line, no head | -| Box | `R` | Box an area | -| Ellipse | `O` | Circle an area | -| Highlight | `H` | Translucent marker ink | -| Blur | `B` | Pixelates an area — hides sensitive data for real, the pixels are destroyed | -| Text | `T` | Click, type, `Enter` | -| Number | `N` | Numbered step markers 1, 2, 3…; `S`/`M`/`L` size the badge | -| Crop | `C` | Keep only the dragged part (undoable) | - -Every annotation stays editable until Save: select it, move it, delete it. -**Blur is not reversible** — after Save the blurred pixels are gone from -the uploaded file, which is exactly why it is safe for tokens and personal -data. - -## Full page - -The **Full page** toggle on the Attachments row makes the next shot cover -the whole scrollable page, not just the visible part. It works through -Chrome's debugger, so while it happens Chrome shows its *"…is debugging -this browser"* bar — that is expected and it goes away by itself. - -Pages that refuse the debugger (the Chrome Web Store, `chrome://` pages) -fall back to a viewport shot, and the panel says so. - -## If it didn't work - -- **The annotator didn't appear** — the panel says why instead of hanging; - usually the page is one extensions cannot touch (Web Store, `chrome://`, - another extension's page). Switch to the site tab and try again. -- **A full-page shot fails on a page that used to work** — another - extension's leftover frame can block the debugger; the panel works - around it by itself, but if Chrome still refuses, reload the page once. -- **The buttons are greyed out** — the reason is written right under the - row: no saved result yet, a finished (locked) run, or basic mode. diff --git a/src/content/docs/advanced/browser-extension/settings.md b/src/content/docs/advanced/browser-extension/settings.md index f44f35b3..d61da187 100644 --- a/src/content/docs/advanced/browser-extension/settings.md +++ b/src/content/docs/advanced/browser-extension/settings.md @@ -1,132 +1,93 @@ --- -title: "Settings and shortcuts" +title: Settings +description: Configure failure logs, step recording, appearance, self-hosted instances, and stored credentials in the Testomat.io browser extension. type: article +url: https://docs.testomat.io/advanced/browser-extension/settings/ +head: + - tag: meta + attrs: + name: keywords + content: Testomat.io browser extension, settings, failure log, step recorder, appearance, self-hosted instance, sign out, side panel --- -The **Settings** tab in the panel header holds six folds. **Connection** and -**Failure log** start open; click a heading to unfold the rest. Every -checkbox and field is committed by **Save & validate** at the bottom — it -also re-checks the connection, then lands you on the Runs tab. The one -exception is **Appearance**, which applies the moment you click it. +Choose what the extension records, how it looks, and which server it connects to. Open the **Settings** tab in the panel header. Click a section heading to expand it. -Settings are kept per instance: switch to another Testomat.io server and -you get that server's own set. +![The Settings tab with the Connection and Failure log sections open](./img/settings/1-settings-pt1.png) -![The Settings tab as you arrive: Connection and Failure log open, the rest folded](img/settings-folds.png) +Click **Save & validate** at the bottom to apply your changes. It also checks the connection and then opens the **Runs** tab. Only **Appearance** applies right away. + +Settings are saved separately for each Testomat.io server you connect to. ## Connection -The card names the host you are connected to, shows the **Connected** badge -(or *Project not picked* while the first-time setup is half done — token in, -no project chosen yet) and offers **Disconnect**. Authorizing, picking a -project and ending the connection are on [Connect](connect.md). +Shows the server you're connected to and the current project. See [Install and Connect](/advanced/browser-extension/install/#check-or-end-the-connection). -## Failure log +## Failure Log -What gets recorded, and what leaves the browser, when you mark a test -**Failed**. Details of the recorder itself are on -[Console & network log](console-network-log.md). +Controls what the panel records and attaches when you mark a test **Failed**. To learn how logging works, see [Collect Console and Network Logs](/advanced/browser-extension/attachments/#collect-console-and-network-logs). -| Setting | Default | What it does | +| Setting | Default | What It Does | |---|---|---| -| **Auto-start console & network recorder when you open a test in a run** | Off | Rec starts by itself when you open a test in a run, bound to that test, and stops when you leave it. | -| **Attach log to failures** | On | The recorded log is uploaded and linked on a test you mark Failed. Off skips only that automatic upload — **Attach** on a single log entry still works. | -| **Include response bodies** | On | A failed request carries a snippet of what came back, up to 16 KB. Off keeps the request line and writes *(body capture disabled)* where the snippet would be. | -| **Log window** | 60 seconds | How much console & network history is kept and attached. Any value from 10 to 600; blank means 60. A number outside the range is refused — Save reports *Log window must be between 10 and 600 seconds* and nothing is saved. | -| **Record environment info** | On | Browser, OS, the viewport of the tab under test and its page URL are written onto the run as meta, with every status you set — not only a failure. | -| **Include the query string** | Off | The recorded URL — and the step recorder's first `Open` step — is cut to origin + path, so reset tokens and signed links in a query string stay out of the run. On records it whole. | +| **Auto-start console & network recorder when you open a test in a run** | Off | Starts **Rec** when you open a test and stops it when you leave the test | +| **Attach log to failures** | On | Attaches the log to every test you mark Failed. When off, you can still attach a single log entry with **Attach** | +| **Include response bodies** | On | Saves up to 16 KB of the response for failed requests | +| **Log window** | 60 seconds | How much history the log keeps: from 10 to 600 seconds. Leave it empty for 60 | +| **Record environment info** | On | Adds the browser, OS, viewport size, and page URL to every result you set | +| **Include the query string** | Off | When off, URLs are saved without query parameters, so tokens in links stay private. This also applies to the first `Open` step in recorded steps | -## Step recorder +## Step Recorder -| Setting | Default | What it does | +| Setting | Default | What It Does | |---|---|---| -| **Never record entered values** | Off | Off, the recorder saves what you type into the steps and masks what it recognises as a password, card number, CVV or one-time code. On, every entry reads *Type text into the … field* — only a password field still says so — and a dropdown choice reads *Select an option in the … dropdown*. Turn it on when the site under test handles real payment or identity data. See [Sensitive values](step-recorder.md#sensitive-values). | +| **Never record entered values** | Off | When on, no typed value is saved: steps read *Type text into the … field* and *Select an option in the … dropdown*. Turn it on if the website handles real payment or personal data. See [Sensitive Values](/advanced/browser-extension/create-tests/#sensitive-values) | -## Appearance +![The Step recorder, Appearance, Advanced, and Stored credentials sections open](./img/settings/2-settings-pt2.png) -**System**, **Light** or **Dark**. The click is the save — no **Save & -validate** needed. System follows your operating system as it changes. -The choice belongs to the browser, not to an instance: it holds across -projects and servers, applies to the test editor tab too, and survives -**Sign out**. +## Appearance -![The lower folds open: Step recorder, Appearance, Advanced, Stored credentials](img/settings-lower.png) +Choose **System**, **Light**, or **Dark**. The change stays the same for all projects and servers. ## Advanced -For a self-hosted Testomat.io. On app.testomat.io leave it as it is — the -fold stays closed; it unfolds by itself once a self-hosted instance is -saved. - -- **Instance** — the server's `https://` URL. HTTP is refused. The - authorize link in Connection follows this field. -- **Pick a saved instance** — this dropdown appears once you have saved two - or more servers. Picking one loads its saved settings into the form; - **Save & validate** switches the panel to it. A server you hold no token - for brings the **Access token** field back. -- **Forget this instance** — deletes the saved token, project and - preferences of the instance the form points at, after a confirmation. - If that is the instance you are on, its restored session, queued results - waiting to be sent, recorded steps, captured log, screen recording and - unsaved drafts go too, a running recording is stopped, and the panel - returns to the connect screen. Other instances are kept. - -## Stored credentials - -**Sign out** is for a shared machine: after a confirmation it erases every -saved token, instance, history entry, queued result, session, unsaved test -draft, recorded step, captured log and screen recording from this browser, -stops a running recording, and reloads the panel onto the connect screen. The colour -scheme and the side-panel-or-window choice stay. Site access is Chrome's -own setting for the extension, on `chrome://extensions`, and is not -touched. - -## Side panel or window - -The header's **Open in window** button reopens the panel as a window of its -own — tall and narrow, like the side panel — for a second screen or a -site that fights the side panel. In that window the same button reads -**Dock to side panel**. The choice is remembered: the toolbar icon opens -whichever surface you used last. - -## Keyboard shortcuts - -In the test view, when no field has the focus: - -| Keys | Action | +Used only for self-hosted Testomat.io. On app.testomat.io, you don't need it. + +- **Instance** — your server's `https://` URL. +- **Pick a saved instance** — appears when you've saved two or more servers. Choose one and click **Save & validate** to switch to it. +- **Forget this instance** — deletes the saved token, project, and settings for this server, after you confirm. If it's the server you're using now, its queued results, recorded steps, logs, screen recordings, and unsaved drafts are deleted too, and the panel returns to the connect screen. Other servers aren't affected. + +## Diagnostics + +Shows the technical state of the extension in one place. Use it when something doesn't work as expected, or when you report a bug. + +Nothing in this section is sent anywhere. Click **Copy** to copy all rows to your clipboard, then paste them into your bug report or support request. + +| Row | What It Shows | |---|---| -| `Cmd/Ctrl+Enter` | Passed | -| `Cmd/Ctrl+U` | Failed | -| `Cmd/Ctrl+I` | Skipped | -| `N` | Next still-untested test | -| `↓` / `→`, `↑` / `←` | Next / previous test | - -Cmd and Ctrl both work on every system. The **?** button beside the -test pager at the bottom of the test view opens the same list in the -panel. None of the marks moves you on — that is `N`. - -From any tab, `Alt+Shift+R` starts or stops a -[screen recording](screen-recording.md) of the tab in front; change it on -`chrome://extensions/shortcuts`. - -## If it didn't work - -- **"Instance and access token are required"** — the Access token field is - empty for a server the panel holds no token for; authorize and paste. -- **"Instance URL must be https://"** / **"Instance is not a valid URL"** — - fix the Instance field; the fold opens on the error. -- **"Log window must be between 10 and 600 seconds"** — the number in **Log - window** is outside the range; nothing was saved, and the field still holds - what you typed. Leave it blank for 60. -- **"Token rejected by …"** — the token is stale for that server; press - **Open Testomat.io & authorize** again and save the new one. -- **"This token reaches no projects"** — ask for access to a project on that - server, then save again. -- **"Couldn't load your projects from …"** — the server did not answer; - check the connection and save again. -- **"Nothing saved for …"** — Forget was pressed for a server that was never - saved; nothing was erased. -- **A warning about the recording after Forget or Sign out** — the erase - happened, but the console & network recorder or the screen recorder could - not be stopped; the warning names which. Restart the browser to be sure - the log or the video is gone. +| **Version** | The installed extension version | +| **Instance** | The Testomat.io server the panel is connected to, such as app.testomat.io | +| **Project** | The current project | +| **Auth** | How the panel is signed in. If your web session has expired, the panel works in [basic mode](/advanced/browser-extension/install/#basic-mode) | +| **Access** | Your access to the project: read/write, or read-only | +| **Queue** | Results waiting to be sent. **empty** means everything is saved in Testomat.io | +| **Live sync** | How often an open run refreshes | +| **Storage used** | How much space the extension uses in your browser | +| **Worker** | Whether the extension's background process is running. **answering** means it is | + +![The Diagnostics section open](./img/settings/3-settings-diagnostics.png) + +## Stored Credentials + +On a shared computer, click **Sign out** when you're done. After you confirm, it deletes all saved tokens, servers, queued results, drafts, recorded steps, logs, and screen recordings from this browser. Your color scheme and panel layout stay. + +## Side Panel or Window + +To open the panel in a separate window, for example on a second screen, click **Open in window** in the panel header. To bring it back, click **Dock to side panel**. The extension remembers your choice. + +## Keyboard Shortcuts + +For shortcuts in an open test, see [Run Manual Tests](/advanced/browser-extension/run-tests/#keyboard-shortcuts). `Alt+Shift+R` starts or stops a screen recording from any tab. To change this shortcut, go to `chrome://extensions/shortcuts`. + +## Next Steps + +- [Install and Connect](/advanced/browser-extension/install/) +- [Run Manual Tests](/advanced/browser-extension/run-tests/) diff --git a/src/content/docs/advanced/browser-extension/step-recorder.md b/src/content/docs/advanced/browser-extension/step-recorder.md deleted file mode 100644 index 797105e2..00000000 --- a/src/content/docs/advanced/browser-extension/step-recorder.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -title: "Step recorder" -type: article ---- - -Instead of typing steps, do the flow once on the page and let the panel -write it down — as readable Markdown, not code. - -## Record - -1. Open the page you want to record, then start a new test in the panel - (see [Create tests](create-tests.md)). -2. Press **Record steps** in the editor. A dark pill appears in the - page's bottom-right corner: `Recording · N steps`, with **+ Expected**, - **Pause** and **Stop**. -3. Do the flow. Every click, entry, selection and navigation lands in the - test's Steps list a second or so after you do it, while you keep going. -4. Press **Stop** — in the pill or in the editor. The steps are already - there; Stop only ends the recording. - -![Record steps, do the flow on the page, the test writes itself](img/step-recorder-record.gif) - -What landed in the editor after Stop: - -![Five recorded steps, one with the page-change Expected line](img/step-recorder-editor.png) - -What a step looks like: *Click the "Add to cart" button*, *Type "pliers" -into the Search field*, *Select "Hand Tools" in the Category dropdown*. A -control gets named by its label, text or placeholder; one inside a table -row or a card carries that row's name, so *Click the button in the "Bolt -Cutters" row* rather than a bare *Click the button*. A page change hangs -under the step that caused it as an `Expected:` line — *The "Cart" page -opens*. - -## Expected results as you go - -Checked something? Press **+ Expected** in the pill, type what you saw, -Enter (Esc cancels). It attaches to the step you just did, as the same -`Expected:` line a run shows under that step. The page never sees those -keystrokes. - -## Pause, limits, continue - -- **Pause** in the pill drops everything until **Resume** — handy for a - detour that is not part of the scenario. -- The recorder pauses itself at **50 steps** and asks *"Still - recording?"* — **Continue** grants another 50. -- Closing the recorded tab or the editor ends the recording; what was - recorded up to then is already in the test. - -## Sensitive values - -A password, card number, CVV, expiry, one-time code, passport or tax id -records as *Type the password / the card number / the value into the … -field* — the field is named, the value is not. Recognition uses the -field's type and `autocomplete`, its wording, and for cards the number's -own checksum. A dropdown recognised the same way — a card expiry month, -a birth year — records as *Select the value in the … dropdown*. It is -best-effort: if the site handles real payment or identity data, switch on -**Settings → Step recorder → Never record entered values** and every entry -reads *Type text into the … field*, every dropdown *Select an option in -the … dropdown*. - -## Polish with AI - -The **Polish with AI** switch next to Record steps is off by default. -With it on, nothing changes while you record; when you stop, your -Testomat.io AI rewrites the recorded steps into cleaner prose. **Undo -polish** puts the recorded wording back. If the AI is unavailable, the -raw steps are kept and the editor says so. - -The polish runs on your company's Testomat.io AI. When your company has no -AI features — the plan does not include them, or the company owner has not -switched them on in the company settings — the switch stays off and says -so when you click it, and nothing is sent. On a server with no AI at all, -the switch is not shown. - -## If it didn't work - -- **Record steps does nothing / says the page can't be recorded** — the - tab in front is one extensions cannot touch (Web Store, `chrome://`, - another extension's page); switch to the site under test first. -- **A click wasn't recorded** — the recorder was paused, or the control - is drawn on a canvas; type the step by hand. -- **Steps stopped at 50** — the soft cap; press **Continue**.