testeiya 0.2.1 → 0.3.9

package/skills/testeiya/testomatio-docs/docs/test-reporting/workflows.md

@@ -1,325 +0,0 @@
----
-title: Workflows
-description: This guide covers various Continuous Integration (CI) workflows using Testomat.io Reporter, including configurations for GitHub Actions, Azure Pipelines, and testing frameworks like CodeceptJS, Cypress, Playwright, MiniTest, and PHPUnit. It details how to execute tests, report results, and send data to Testomat.io during different stages of CI pipelines.
-type: article
-url: https://docs.testomat.io/test-reporting/workflows
-head:  
-  - tag: meta
-    attrs:
-      name: keywords
-      content: CI workflows, Testomat.io Reporter, GitHub Actions, Azure Pipelines, CodeceptJS, Cypress, Playwright, MiniTest, PHPUnit, automated testing, test reporting, Continuous Integration
----
-
-
-List of CI configurations which include Testomat.io Reporter
-
-## GitHub Actions and CodeceptJS
-
-Execute CodeceptJS in parallel mode with 2 wokers and report data to Testomat.io Application.
-This workflow will be executed from Testomat.io Application when you click "Run on CI"
-
-```yaml
-name: CodeceptJS Tests
-
-on:
-  workflow_dispatch:
-    inputs:
-      grep:
-        description: 'A grep '
-        required: false
-        default: ''
-      testomatio:
-        required: false
-      run:
-        required: false
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v2
-      - name: Setup node
-        uses: actions/setup-node@v1
-        with:
-          node-version: 16.x
-      - run: npm i
-      - run: npx @testomatio/reporter run 'npx codeceptjs run-workers 2 --grep "${{ github.event.inputs.grep }}"'
-        env:
-          TESTOMATIO: '${{ github.event.inputs.testomatio }}'
-          TESTOMATIO_RUN: '${{ github.event.inputs.run }}'
-```
-
-## Azure Pipelines and CodeceptJS
-
-Simple workflow for CodeceptJS and Azure
-
-```yaml
-trigger:
-  - master
-
-pool:
-  vmImage: ubuntu-latest
-
-steps:
-  - task: NodeTool@0
-    inputs:
-      versionSpec: '16.x'
-    displayName: 'Install Node.js'
-
-  - script: |
-      npm install
-      TESTOMATIO=$(testomatio) npx codeceptjs run --grep="$(grep)"
-    displayName: 'run tests'
-```
-
-Enable `testomatio` variable inside Azure Pipelines config to pass this value
-
-## GitHub Actions and MiniTest
-
-GitHub Actions workflow that uses Testomat.io Reporter to send results from Minitest to Testomat.io Application and add comment to GitHub pull request:
-
-```yaml
-name: CI
-
-on:
-  pull_request:
-
-jobs:
-  test:
-    name: Tests
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-
-      - name: Setup node
-        uses: actions/setup-node@v1
-
-      - name: install nodejs deps
-        run: npm i
-
-      - name: install ruby deps
-        run: bundle install
-
-      # all required preperations
-
-      - name: test
-        run: bundle exec rails test
-        env:
-          RAILS_ENV: test
-      - name: Testomatio Report
-        run: npx @testomatio/reporter xml "test/reports/**.xml" --lang=Ruby
-        if: always()
-        env:
-          TESTOMATIO: ${{ secrets.TESTOMATIO }}
-          TESTOMATIO_RUN: 'PR ${{ github.event.number }} ${{ github.event.pull_request.title }}'
-          GH_PAT: ${{ github.token }}
-```
-
-## GitHub Actions and PHPUnit
-
-GitHub Actions workflow that uses Testomat.io Reporter to send results from Minitest to Testomat.io Application and add comment to GitHub pull request:
-
-```yaml
-name: CI
-
-on:
-  pull_request:
-
-jobs:
-  test:
-    name: Tests
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-
-      - name: Install dependencies
-        run: composer install
-
-      # all required preparations
-
-      - name: Run PHPUnit tests
-        run: vendor/bin/phpunit --log-junit=report.xml
-
-      - name: Testomatio Report
-        run: npx @testomatio/reporter xml report.xml --lang=PHP
-        if: always()
-        env:
-          TESTOMATIO: ${{ secrets.TESTOMATIO }}
-          TESTOMATIO_TITLE: 'PR ${{ github.event.number }} ${{ github.event.pull_request.title }}'
-          GH_PAT: ${{ github.token }}
-```
-
-## GitHub Actions and Cypress (trigger = PR)
-
-Execute Cypress tests and report data to Testomat.io Application after each pull request:
-
-```yaml
-name: Cypress reporting
-
-on:
-  pull_request:
-
-jobs:
-  reporting:
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [18.x]
-
-    steps:
-      - uses: actions/checkout@v3
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.node-version }}
-
-      - name: Setup dependencies
-        run: npm i
-
-      - name: Run tests
-        run: npx cypress run
-        env:
-          TESTOMATIO: '${{ secrets.TESTOMATIO }}'
-          TESTOMATIO_TITLE: 'PR ${{ github.event.number }} ${{ github.event.pull_request.title }}'
-```
-
-## GitHub Actions and Cypress (trigger = click "Run Automated Tests on CI")
-
-Execute Cypress tests and report data to Testomat.io Application.
-This workflow will be executed from Testomat.io Application when you click "Run on CI":
-
-```yaml
-name: Cypress reporting
-
-on:
-  workflow_dispatch:
-    inputs:
-      grep:
-        required: false
-        default: ''
-      run:
-        required: false
-      testomatio:
-        required: false
-      testomatio_url:
-        required: false
-
-jobs:
-  reporting:
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [18.x]
-
-    steps:
-      - uses: actions/checkout@v3
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.node-version }}
-
-      - name: Setup dependencies
-        run: npm i
-
-      - name: Run tests
-        run: npx cypress run
-        env:
-          TESTOMATIO: '${{ secrets.TESTOMATIO }}'
-          TESTOMATIO_RUN: '${{ github.event.inputs.run }}'
-```
-
-## GitHub Actions and Playwright (trigger = PR)
-
-Execute Playwright tests and report data to Testomat.io Application after each pull request:
-
-```yaml
-name: Playwright reporting
-
-on:
-  pull_request:
-
-jobs:
-  reporting:
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [18.x]
-
-    steps:
-      - uses: actions/checkout@v3
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.node-version }}
-
-      - name: Setup dependencies
-        run: npm i
-
-      - name: Playwright browser updates
-        run: npx playwright install
-
-      - name: Run tests
-        run: npx playwright test
-        env:
-          TESTOMATIO: '${{ secrets.TESTOMATIO }}'
-          TESTOMATIO_TITLE: 'PR ${{ github.event.number }} ${{ github.event.pull_request.title }}'
-```
-
-## GitHub Actions and Playwright (trigger = click "Run Automated Tests on CI")
-
-Execute Playwright tests and report data to Testomat.io Application.
-This workflow will be executed from Testomat.io Application when you click "Run on CI":
-
-```yaml
-name: Playwright reporting
-
-on:
-  workflow_dispatch:
-    inputs:
-      grep:
-        description: 'tests to grep '
-        required: false
-        default: ''
-      run:
-        required: false
-      testomatio:
-        required: false
-      testomatio_url:
-        required: false
-
-jobs:
-  reporting:
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [18.x]
-
-    steps:
-      - uses: actions/checkout@v3
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.node-version }}
-
-      - name: Setup dependencies
-        run: npm i
-
-      - name: Playwright browser updates
-        run: npx playwright install
-
-      - name: Run tests
-        run: npx playwright test --grep "${{ github.event.inputs.grep }}"
-        env:
-          TESTOMATIO: '${{ secrets.TESTOMATIO }}'
-          TESTOMATIO_RUN: '${{ github.event.inputs.run }}'
-```
-
-...more examples are coming
-

package/skills/testeiya/testomatio-docs/docs/tutorials/Interacting-via-API.md

@@ -1,159 +0,0 @@
----
-title: Interacting via API
-description: Learn how to interact with the Testomat.io API. This guide walks you through choosing an access token, authenticating to receive a JWT, listing suites and tests, working with runs and test results, and using project tokens for importing and reporting.
-type: article
-url: https://docs.testomat.io/tutorials/interacting-via-api
-head:
-  - tag: meta
-    attrs:
-      name: og:image
-      content: https://docs.testomat.io/_astro/New_b1BS3EKN_2024-08-29.DGrFkMLR_ZOOgn1.webp
-
-  - tag: meta
-    attrs:
-      name: keywords
-      content: Testomat.io API, REST API, API access, API token, general token, project token, JWT authentication, Public API v2, MCP Server, JSON API, suites, tests, test runs, test results, importing API, reporting API, automation, CI/CD integration, test management
----
-
-Welcome! 
-
-This tutorial shows you how to work with Testomat.io from code. Basic comfort with HTTP requests and a tool like curl or Postman is all you need.
-
-The API lets you work with Testomat.io straight from your own code, so you can fetch tests, start runs, and send results without opening the app. It's what you use to plug Testomat.io into your pipelines and scripts.
-
-![Tokens needed for API interaction chart](./images/interacting-via-api/api-token-flows.png)
-
-What you will do:
-
-1. Get an access token.
-2. Authenticate and get a JSON Web Token (JWT).
-3. Fetch your suites and tests.
-4. Create a run.
-
-The base URL for every request is `https://app.testomat.io`.
-
-## Before you start: two kinds of tokens
-
-Learn more: [API Access](https://docs.testomat.io/advanced/api-access/#_top).
-
-Testomat.io has two token types, and you pick based on the job:
-
-* General token. Full API access across all your projects. Use it to read data, like fetching tests. It starts with `testomat_`.
-* Project token. Access limited to one project, used for importing and reporting. Use it to create runs and report results. It starts with `tstmt_`.
-
-You will use both in this tutorial: a General token to fetch, a Project token to create a run.
-
-## Get an Access Token
-
-Learn more: [Access Tokens](https://docs.testomat.io/advanced/api-access/#access-tokens-overview).
-
-To get your tokens:
-
-1. Open your account settings.
-2. Go to **Access-Tokens**.
-3. Copy a General token for reading and a Project token for your project.
-
-![The Access Tokens page showing a General token and a Project token](./images/interacting-via-api/1-copy-token.png)
-
-Treat tokens like passwords. Keep them out of your code and commits, and store them as secrets.
-
-## Authenticate
-
-Learn more: [API Reference](https://docs.testomat.io/advanced/api-access/#api-reference).
-
-The API uses a short-lived JWT. You trade your General token for a JWT once, then send that JWT on every read request.
-
-Send your General token to the login endpoint via your API testing platform (e.g., Postman or Swagger):
-
-`POST https://app.testomat.io/api/login`
-
-```
-{
-  "api_token": "testomat_YOUR_GENERAL_TOKEN"
-}
-```
-
-You will receive a JWT in the response:
-
-```
-{
-  "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
-}
-```
-
-Copy the `jwt` value. Include it in the Authorization header on every read request from here on.
-
-## Read Your Suites and Tests
-
-Suites are nested, so you fetch the root suites first, then walk into each one to build the full tree. Each suite response includes the tests, so you do not need a separate call for tests.
-
-List the root suites:
-
-`GET https://app.testomat.io/api/<project>/suites`
-
-```
-Authorization: <your JWT>
-```
-
-Then fetch each child suite by its ID to go deeper:
-
-`GET https://app.testomat.io/api/<project>/suites/<suite_id>`
-
-```
-Authorization: <your JWT>
-```
-
-Repeat for each child suite to rebuild the whole tree. Replace &lt;project&gt; with your project ID, which you can see in the project URL.
-
-## Create a Run
-
-Learn more: [Reporting API](https://docs.testomat.io/advanced/api-access/#importing-and-reporting-with-project-token).
-
-To create and report runs, use the Reporting API with your Project token, passed as api_key. For example, if you need to create runs outside the Testomat.io app. Creating a run returns a unique run ID that you report results to.
-
-Create the run:
-
-`POST https://app.testomat.io/api/reporter?api_key=tstmt_YOUR_PROJECT_TOKEN`
-
-```
-{
-  "title": "API run"
-}
-```
-
-You will receive the run ID:
-
-```
-{
-  "uid": "run-id-12345"
-}
-```
-
-Save the uid, then report a test result to that run:
-
-`POST https://app.testomat.io/api/reporter/<run-id-12345>/testrun?api_key=<tstmt_YOUR_PROJECT_TOKEN>`
-
-```
-{
-  "title": "User can log in",
-  "status": "passed"
-}
-```
-
-When every result is in, finish the run so its status is calculated. See the Reporting API reference for the exact finishing call and the full list of fields.
-
-## Use Public API v2 and the MCP Server
-
-Testomat.io also offers Public API v2, a newer interface with a consistent request and response structure across all endpoints, designed to make integrations simpler and more predictable. Its exact endpoints and fields are listed in the API Reference.
-
-Testomat.io MCP Server lets AI assistants such as Claude or Cursor talk to Public API v2 directly, so an assistant can read tests, search, and manage runs for you. Run it with your project token:
-
-```
-npx -y @testomatio/mcp@latest --token <PROJECT_TOKEN> --project <PROJECT_ID>
-```
-
-## Next Steps
-
-* See every endpoint, parameter, and schema in the [API Reference](https://docs.testomat.io/advanced/api-access/#api-reference).
-* Reporting from a test framework instead of raw requests? See the [Testomat.io Reporter](https://docs.testomat.io/test-reporting/reporter/#_top).
-* Want to filter results precisely? Learn the query language in [TQL](https://docs.testomat.io/advanced/tql/#_top).

package/skills/testeiya/testomatio-docs/docs/tutorials/Manual-Testing-Classic.md

@@ -1,164 +0,0 @@
----
-title: Manual Testing - Classic
-description: Learn how to run manual tests in a Classical project in Testomat.io. This guide walks you through creating a project, adding a suite, writing test cases in the editor, running them by hand, recording results, and reading the report.
-type: article
-url: https://docs.testomat.io/tutorials/manual-testing-classic
-head:
-  - tag: meta
-    attrs:
-      name: og:image
-      content: https://docs.testomat.io/_astro/New_b1BS3EKN_2024-08-29.DGrFkMLR_ZOOgn1.webp
-
-  - tag: meta
-    attrs:
-      name: keywords
-      content: manual testing, Testomat.io, test management, classical project, test cases, test suite, manual run, test results, test report, QA, test case editor, markdown test cases
----
-
-Welcome!
-
-This tutorial walks you through the whole manual testing flow in a Classical project, from an empty project to a finished report you can share. 
-
-You do not need any automated tests or code for this. If you are brand new to Testomat.io, this is the right place to start.
-
-What you will do:
-
-1. Create a Classical project.
-2. Add a suite to hold your tests.
-3. Write a few test cases.
-4. Run them manually.
-5. Read and share the report.
-
-## Create a project
-
-A project is the home for all your tests, runs, and reports.
-
-1. On app.testomat.io, click **Create** in the top-right corner.
-2. Enter a name in the **Project Title** field.
-3. Choose a **Classical Project**.
-4. Leave **Fill demo data** unchecked, so you start with a clean project.
-5. Click **Create**.
-
-![Create Project dialog](./images/manual-testing-classic/1-new-project-testomat-io.png)
-
-Your empty project opens, ready for its first suite.
-
-:::note
-
-Classical projects use free-form Markdown for test cases, which is the simplest way to start. 
-
-:::
-
-## Create a suite
-
-Test cases always live inside a suite, so you make a suite first. A suite is just a group of related tests, like all the tests for your login page.
-
-1. Go to Tests page.
-2. Click **New suite**.
-3. Type a name in the suite input field.
-4. Press `Enter`.
-
-![Create new suite](./images/manual-testing-classic/2-create-suite.png)
-
-That's it. Your suite appears in the tree on the left. 
-
-You can add as many suites as you like, and group them in folders later if you need to.
-
-## Add test cases
-
-Now add the tests you want to run. You can create several at once and fill in the details after.
-
-1. Click your suite to select it.
-2. Type a test name in the input field, for example, "User can log in with valid details."
-3. Click **Create**.
-4. Repeat for a few more tests, or turn on the Bulk switch to add several names at once, one per line.
-
-![Suite selected](./images/manual-testing-classic/3-creating-tests.png)
-
-New tests are marked as manual by default, which is exactly what you need.
-
-Next, open a test and describe how to run it, so anyone in your team can follow it:
-
-1. Click a test to open it. 
-2. Then click **Edit**.
-3. In the editing area, enter the steps and the expected result.
-4. Click **Save**.
-
-![The block-based Classical editor](./images/manual-testing-classic/4-edit-test.png)
-
-The Classical editor uses a block-based layout, so it is easy to add an expected result to each step and attach images directly within each step. 
-
-It is still fully Markdown-compatible. Keep steps short and clear, one action per line.
-
-For everything the editor can do, see the [Editor](https://docs.testomat.io/project/tests/classical-test-case-editor/#test-editor-overview).
-
-### Bulk-create Tests
-
-Read full article: [Bulk Edit](https://docs.testomat.io/advanced/bulk-edit-folder/bulk-edit-on-suite-and-test-level/).
-
-You also can add multiple tests by listing their names, without adding each one individually:
-1. Open (or create) a suite.
-2. Turn on the **Bulk** toggle.
-3. Type **one test name per line** in the input field.
-4. Click **Create** - every line becomes a separate test, all added together.
-
-![Testomat.io - Create test case](../getting-started/images/bulk-create-tests.png)
-
-## Run your tests manually
-
-With your tests written, you can run them and record what happened.
-
-1. Open the **Runs** tab in the sidebar.
-2. Click **Manual Run**.
-3. Give the run a title, and set the environment if you want to note the browser or device.
-4. Select tests you need to complete or switch to **All Manual Tests**.
-5. Click **Launch**.
-
-![Manual Run setup](./images/manual-testing-classic/5-create-manual-run.png)
-
-You now see your test cases one by one. For each test, follow the steps and mark the result:
-
-| Mark the result | Shortcut |
-|---|---|
-| Passed, if it worked as expected. | `Cmd`+`Enter` on Mac, `Ctrl`+`Enter` on Windows |
-| Failed, if it did not. You can add a note, attach a screenshot, or link a defect. | `Cmd`+`U` on Mac, `Ctrl`+`U` on Windows |
-| Skipped, if you did not run it. | `Cmd`+`I` on Mac, `Ctrl`+`I` on Windows |
-
-![Test during a manual run](./images/manual-testing-classic/6-manual-test-run.png)
-
-If the run has many tests, use the search box in the run to jump straight to a test or suite by name instead of scrolling through the whole list.
-
-When all tests have results, click **Finish Run** to close the run. That is what turns it into a report. 
-
-:::note
-
-Linking a defect needs a bug tracker connected to your project:
-
-1. Open your project and go to **Settings**.
-2. Click **Integrations**.
-3. Pick your tracker (GitHub, GitLab, Azure, Linear, Jira).
-4. Click **Connect** and sign in to authorize it.
-5. Done, the tracker now shows as connected.
-
-After that, **Link to Issue** and **Report Defect** work on your tests and runs.
-
-:::
-
-For more on running tests, see [Running Tests Manually](https://docs.testomat.io/project/runs/running-tests-manually/#_top).
-
-## Read and share the report
-
-Once the run is complete, Testomat.io automatically generates a report for you.
-
-1. On the **Runs** page, click your run to open its report.
-2. Review the results: how many passed, failed, or were skipped, plus the duration and who ran it.
-3. Filter by status or tag to focus on what matters, for example, just the failures.
-
-![Finished run report](./images/manual-testing-classic/7-finished-manual-run.png)
-
-To share the outcome with your team or stakeholders, use the share option on the report. For a deeper look at reports, see [Reports](https://docs.testomat.io/project/runs/reports/#_top).
-
-## Next steps
-
-* Ready to add automation? See [Import Tests From Source Code](https://docs.testomat.io/project/import-export/import/import-tests-from-source-code/#_top).
-* See [Test Case Creation and Editing](https://docs.testomat.io/project/tests/test-case-creation-and-editing/#_top).