npm - testeiya - Versions diffs - 0.2.1 → 0.3.9 - Mend

testeiya 0.2.1 → 0.3.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (414) hide show

package/skills/testeiya/testomatio-docs/docs/tutorials/java.md DELETED Viewed

@@ -1,478 +0,0 @@
----
-title: Java
-description: Learn how to integrate Java test frameworks with Testomat.io for efficient test management and reporting. This guide covers importing JUnit, TestNG tests, managing parametrized tests, reporting test results, uploading artifacts to S3, and configuring parallel execution reporting for CI workflows.
-type: article
-url: https://docs.testomat.io/tutorials/java
-head:
-  - tag: meta
-    attrs:
-      name: og:image
-      content: https://docs.testomat.io/images/java-integration-cover.png
-  - tag: meta
-    attrs:
-      name: keywords
-      content: Java, JUnit, JUnit 5, TestNG, Testomat.io, test automation, test management, automated testing, test reporting, test import, parameterized tests, Gradle, Maven, CI/CD, GitHub Actions, Jenkins, GitLab CI, test IDs, parallel execution, test analytics, QA automation, S3 integration, artifacts
----
-<!--
-    ## Importing Tests
-        - JUnit 5 support
-        - TestNG support
-        - parameterized tests
-        - auto-assign test IDs
-        - source code synchronization
-    ## Reporting Tests
-        - report execution results
-        - local execution
-        - artifacts
-        - S3 integration
-        - logs
-        - CI/CD reporting
-        - Gradle integration
-        - Maven integration
-    ## Advanced
-        - parallel execution
-        - run title configuration
--->
-# Java Integration with Testomat.io
-Testomat.io supports Java test automation projects built with popular testing frameworks such as JUnit 5, TestNG. This integration allows teams to import automated tests, synchronize test IDs, track execution results, and consolidate reports from local and CI environments.
-In this guide, you'll learn how to use Testomat.io with Java-based test automation projects.
----
-## Supported Frameworks
-Currently, the following Java testing frameworks are supported:
-- JUnit 5
-- TestNG
----
-## Importing Java Tests
-You can import your Java tests into Testomat.io on the **Imports** page.
-![Testomat.io - Import Java Project from Source Code](./images/java-import.png)
-### Steps to Import Your Tests
-1. **Select Framework**: In the **Project Framework** field, choose `TestNg, JUnit`.
-2. **Choose Language**: Select `Java` as your project language.
-3. **Select OS**: Choose your operating system (`Mac`, `Linux`, or `Windows`) under **Import tests**.
-![Testomat.io - Import Java tests](./images/java-import-2.png)
-### Additional Import Options
-- **Auto assign IDs**: Automatically assigns unique IDs to each test.
-- **Purge Old IDs**: Removes previously assigned IDs.
-- **Disable Detached Tests**: Disables tests marked as detached.
-- **Prefer Source Code Structure**: Maintains your project's source code structure in the test hierarchy.
-After setting up, copy the generated command and run it in your project's terminal.
-Your tests will then appear on the **Tests** page in Testomat.io.
-![Testomat.io - View imported Java tests](./images/java-imported-tests.png)
-> **Example Project**: Try importing using the Testomat.io Java example project.
-For more details, refer to the [Import Tests from Source Code documentation](https://docs.testomat.io/getting-started/import-tests-from-source-code/).
----
-## JUnit Example
-Example JUnit 5 test:
-```java
-@ParameterizedTest(name = "Create user {0}")
-@ValueSource(strings = {"John", "Kate", "Mike"})
-void createUser(String userName) {
-    assertNotNull(userName);
-}
-@Test
-void userShouldBeFine() {
-    assertEquals("fine", user.getStatus());
-}
-```
-Imported tests appear in Testomat.io and can be linked to automated executions.
----
-## TestNG Example
-Example TestNG test:
-```java
-@Test(dataProvider = "users")
-public void createUser(String userName) {
-    Assert.assertNotNull(userName);
-}
-@DataProvider
-public Object[][] users() {
-    return new Object[][]{
-        {"John"},
-        {"Kate"},
-        {"Mike"}
-    };
-}
-@Test
-public void userShouldBeFine() {
-    Assert.assertEquals(user.getStatus(), "fine");
-}
-```
-TestNG tests are imported and managed the same way as JUnit tests.
-Testomat.io displays parameterized executions together with their parameter values.
----
-## Auto assigning Test IDs
-When importing tests, enable **Auto assign IDs** (`--update-ids`) to track changes without creating duplicate tests as your project grows.
-Before:
-```java
-@Test
-void userShouldBeFine() {
-    assertEquals("fine", user.getStatus());
-}
-```
-After:
-```java
-@Test
-@TestId("T12345678")
-void userShouldBeFine() {
-    assertEquals("fine", user.getStatus());
-}
-```
-Test IDs help Testomat.io identify tests even when test names, packages, or source files change.
----
-## Reporting Test Steps
-Testomat.io can display execution steps inside test results, making it easier to understand what happened during a test run and quickly identify the exact step where a failure occurred.
-```java
-@Test
-void userShouldBeFine() {
-    Testomatio.step("Check user status",
-        () -> assertEquals("fine", user.getStatus()));
-}
-```
-Annotated steps:
-```java
-import io.testomat.core.annotation.Step;
-@Step("Check user status")
-private void checkUserStatus() {
-    assertEquals("fine", user.getStatus());
-}
-@Test
-void userShouldBeFine() {
-    checkUserStatus();
-}
-```
-### Using Allure Steps
-If your project already uses Allure, Testomat.io can automatically import and display Allure steps.
-```java
-@Test
-void userShouldBeFine() {
-    Allure.step("Check user status", () -> {
-        assertEquals("fine", user.getStatus());
-    });
-}
-```
-Annotated steps are also supported:
-```java
-import io.qameta.allure.Step;
-@Step("Check user status")
-private void checkUserStatus() {
-    assertEquals("fine", user.getStatus());
-}
-@Test
-void userShouldBeFine() {
-    checkUserStatus();
-}
-```
-When Allure integration is enabled step information is synchronized with Testomat.io and displayed as part of the test execution report.
----
-## Reporting Test Results
-Reports provide visibility into test execution results and the performance of your automation workflows.
-After importing tests, execution results can be reported back to Testomat.io.
-Provide your project API key using the `TESTOMATIO` environment variable.
-### Gradle
-```bash
-TESTOMATIO=<API_KEY> ./gradlew test
-```
-### Maven
-```bash
-TESTOMATIO=<API_KEY> mvn test
-```
-Execution results will automatically be associated with the corresponding tests in Testomat.io.
----
-## Artifacts with Testomat.io Reporter and S3
-Artifacts such as logs, screenshots, reports, videos, and other generated files are essential for debugging test failures.
-With the Testomat.io reporter, artifacts can be automatically uploaded to an S3 bucket and linked to test results in the Testomat.io dashboard.
-[Read more about Artifacts](https://docs.testomat.io/usage/test-artifacts/)
-![Testomat.io - Artifacts](./images/artefacts_settings.jpg)
-### Supported Artifacts
-Artifacts may include:
-- Execution logs
-- HTML reports
-- Screenshots
-- Videos
-- Generated files
-- Custom attachments
-### Setting Up Artifacts
-1. Configure artifact generation in your test framework or build tool.
-2. Set up an S3 bucket.
-3. Configure S3 integration in Testomat.io.
-4. Run your tests.
-5. Open a test result in Testomat.io to access uploaded artifacts.
-### Viewing Attachments
-View attachments by clicking on a test in a Test Run and selecting the artifact you want to inspect.
-Artifacts can be downloaded or viewed directly from the Testomat.io interface.
----
-## Reporting Test Attachments
-Testomat.io can display attachments inside test results, making it easier to investigate failures and review logs, screenshots, API responses, and other execution artifacts.
-### Using Testomat.io Attachments
-Java projects can attach files directly to Testomat.io reports.
-```java
-@Test
-void userShouldBeFine() {
-    Testomatio.artifact("build/logs/test.log");
-}
-```
-Attached files are displayed in the test result and can be downloaded or viewed directly from the Testomat.io interface.
-### Using Step Attachments
-Attachments can also be linked to a specific test step.
-```java
-@Test
-void userShouldBeFine() {
-    Testomatio.step("Check user status", () -> {
-        Testomatio.stepArtifact("screenshots/status.png");
-        assertEquals("fine", user.getStatus());
-    });
-}
-```
-Step attachments are displayed within the corresponding step, making it easier to understand the context of failures and review screenshots, logs, and other files related to a specific action.
-### Using Allure Attachments
-If your project already uses Allure, Testomat.io can automatically import and display Allure attachments.
-```java
-Allure.addAttachment("Log File",
-    Files.newInputStream(Path.of("logs/test.log"));
-);
-```
-Annotated attachments are supported as well:
-```java
-import io.qameta.allure.Attachment;
-@Attachment(
-    value = "Screenshot",
-    type = "image/png"
-)
-private byte[] screenshot() {
-    return Files.readAllBytes(
-        Path.of("screenshot.png")
-    );
-}
-@Test
-void userShouldBeFine() {
-    screenshot();
-}
-```
-When Allure integration is enabled, attachment information is synchronized with Testomat.io and displayed as part of the test execution report.
----
-## Parallel Execution Reporting
-To report parallel test executions to the same Testomat.io run, assign a shared title to all parallel runs and set the `TESTOMATIO_SHARED_RUN` environment variable.
-```bash
-TESTOMATIO_TITLE="{TITLE}" TESTOMATIO_SHARED_RUN=1 <actual run command>
-```
----
-## Running Tests with Gradle
-Run all tests:
-```bash
-./gradlew test
-```
-Run a specific test class:
-```bash
-./gradlew test --tests UserTests
-```
-Run a specific test method:
-```bash
-./gradlew test --tests UserTests.userShouldBeFine
-```
----
-## Running Tests with Maven
-Run all tests:
-```bash
-mvn test
-```
-Run a specific test class:
-```bash
-mvn -Dtest=UserTests test
-```
-Run a specific test method:
-```bash
-mvn -Dtest=UserTests#userShouldBeFine test
-```
----
-## CI Integration
-### GitHub Actions
-```yaml
-- name: Run Tests
-  run: ./gradlew test
-  env:
-    TESTOMATIO: ${{ secrets.TESTOMATIO }}
-```
-### Jenkins
-```groovy
-withEnv(["TESTOMATIO=${TESTOMATIO}"]) {
-    sh './gradlew test'
-}
-```
-### GitLab CI
-```yaml
-test:
-  script:
-    - ./gradlew test
-  variables:
-    TESTOMATIO: $TESTOMATIO
-```
----
-### Setting Up the Reporter
-The easiest way to configure reporting for your Java project is to use the **Reporter Setup Skill**.
-The Reporter Setup Skill automatically detects your testing framework and build tool, installs the required dependencies, and generates the configuration needed to report test results to Testomat.io.
-To use it:
-1. Open your Testomat.io project.
-2. Navigate to **Skills**.
-3. Select **Reporter Setup**.
-4. Follow the generated instructions for your project.
-The skill supports Java projects using JUnit, TestNG as well as both Maven and Gradle build systems.
-> The Reporter Setup Skill is the recommended way to configure Testomat.io reporting for new projects.
----
-## Related Repositories
-### java-reporter
-Official Java reporter for Testomat.io.
-Use it to report test execution results, steps, and artifacts from JUnit and TestNG projects.
-[java-reporter](https://github.com/testomatio/java-reporter)
-### java-check-tests
-Utility for importing Java tests, synchronizing test IDs, and maintaining test metadata in Testomat.io.
-[java-check-tests](https://github.com/testomatio/java-check-tests)

package/skills/testeiya/testomatio-docs/docs/tutorials/playwright.md DELETED Viewed

@@ -1,207 +0,0 @@
----
-title: Playwright
-description: Learn how to integrate Playwright with Testomat.io for efficient test management and reporting. The guide covers importing Playwright tests, managing parametrized tests, reporting artifacts like screenshots and logs, enabling the Trace Viewer, and configuring parallel execution reporting for CI workflows.
-type: article
-url: https://docs.testomat.io/tutorials/playwright
-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: Playwright, Testomat.io, test reporting, automation, test management, artifacts, parallel execution, trace viewer, parametrized tests, S3 integration, CI workflows, test import, browser automation
----
-<!--
-    ## Importing Playwright Tests
-        - import playwright tests
-        - JS tests (link to example project)
-        - TypeScript tests (link to example project)
-        - BDD tests
-        - parametrized tests importing
-        - add IDs to tests
-    ## Reporting Playwright tests
-        - configure reporter
-        - artifacts (link to artifacts page)
-        - videos
-        - traces (move from Reporting page)
-    ## Advanced
-        - parallel run (link to parallel page)
--->
-# Playwright Integration with Testomat.io
-Playwright is an open-source framework developed by Microsoft for end-to-end testing of web applications. It allows developers and testers to automate browser interactions across platforms, including Chromium, Firefox, and WebKit. With support for JavaScript, TypeScript, Python, C#, and Java, Playwright enables cross-browser testing with a single codebase. The framework is known for its reliability and advanced features like auto-waiting, network interception, and seamless testing of modern web apps, making it an excellent tool for ensuring consistent user experiences across different environments.
-In this guide, you’ll learn how to use [Testomat.io](https://app.testomat.io) with Playwright to streamline test management and reporting.
----
-## Importing Playwright Tests
-You can import your Playwright tests into Testomat.io on the **Imports** page.
-![Testomat.io - Import Project from Source Code](./images/New_gTxse3EF_2024-08-29.png)
-### Steps to Import Your Tests
-1. **Select Framework**: In the **Project Framework** field, choose Playwright.
-2. **Choose Language**: Select your project’s language from the **Project Language** field: `JavaScript`, `TypeScript`, or `Gherkin` (for BDD tests).
-3. **Select OS**: Choose your device’s OS (Mac, Linux, or Windows) under **Import tests**.
-Additional options to customize your import:
-- **Auto-assign Ids**: Automatically assigns unique IDs to each test.
-- **Purge Old Ids**: Removes previously set IDs from tests.
-- **Disable Detached Tests**: Disables tests marked as detached.
-- **Prefer Source Code Structure**: Maintains your project’s source code structure in the test hierarchy.
-![Testomat.io - Set up Playwright project import](./images/New_b1BS3EKN_2024-08-29.png)
-After setting up, copy the generated command and run it in your project’s terminal. Your tests will then appear on the **Tests** page in [Testomat.io](https://app.testomat.io).
-> **Example Project**: Try importing using the [Testomat.io Playwright example project](https://github.com/testomatio/examples/tree/master/playwright).
-For more details, refer to the [Import Tests from Source Code documentation](https://docs.testomat.io/getting-started/import-tests-from-source-code/).
----
-### Importing Parametrized Tests
-When importing parametrized tests, you can include variable parameters in test names using template literals, ensuring they display dynamically in Testomat.io.
-Example:
-```javascript
-test(`Create user ${userName} @T12345678`, () => {
-  expect(user).toBe('fine');
-});
-```
-Avoid string concatenation like `title + name`. Instead, use template literals for a clear and informative test name with variable values.
-> This test will be imported with its placeholder in the name, and results will display parameter values in Testomat.io reports.
-![Testomat.io - Parameterised Tests in Code](./images/New_y02Q6Exe_2024-08-29.png)
-![Testomat.io - Imported Parameterised Tests](./images/New_cQu8Khiq_2024-08-29.png)
-### Auto-assigning Test IDs
-When importing tests, enable **Auto-assign Ids** (`--update-ids`) to track changes without duplicating tests when scaling your project. Without this, CI processes may not launch correctly.
-```diff
-- test('user should be fine', () => {
-+ test('user should be fine @T12345678', () => {
-  expect(user).toBe('fine');
-});
-```
-IDs will be automatically assigned in your code and appear in Testomat.io.
-![Testomat.io - Auto-assign Ids in Code](./images/New_WTxw4TbZ_2024-08-29.png)
-![Testomat.io - Auto-assign Ids in Tests](./images/New_JhM1Hqz3_2024-08-29.png)
----
-## Reporting Playwright Tests
-Reports provide insights into test results and the performance of your automation workflows. Testomat.io allows for comprehensive Playwright test reports, including Trace Viewer.
-### Artifacts in Playwright with Testomat.io Reporter and S3
-Artifacts like screenshots, videos, and logs are essential for debugging. With the Testomat.io reporter, these artifacts can be automatically uploaded to an S3 bucket and linked to test cases in the Testomat.io dashboard. [Read more about Artifacts](https://docs.testomat.io/usage/test-artifacts/)
-![Testomat.io - Artifacts](./images/artefacts_settings.jpg)
-- **Configure Artifacts**: Enable options in Playwright (e.g., recordVideo, screenshot, logs).
-- **Setup S3 and Testomat.io Reporter**: Link your S3 bucket with Testomat.io for smooth integration.
-- **View and Debug**: Access artifacts in Testomat.io for easy downloading and analysis.
-#### Viewing Playwright Attachments
-View attachments by clicking on the test in Test Run and selecting the attachment (screenshots, videos) you want to view.
-**Screenshot example**:
-![Testomat.io - Open Playwright Screenshot](./images/view_image.gif)
-**Video example**:
-![Testomat.io - Open Playwright Video](./images/view_video.gif)
----
-### Enabling Playwright Trace Viewer
-Trace logs in Playwright capture a detailed sequence of browser events. Here’s how to enable Playwright trace viewing for Test Runs:
-1. Set up an S3 Bucket ([See Documentation](https://docs.testomat.io/usage/test-artifacts#set-up-s3-bucket)).
-2. Enable third-party cookies in your browser.
-3. Run your tests.
-4. In Test Run, click the test, then select `trace.zip` to open.
-![Testomat.io - Open Playwright Trace Viewer](./images/Open-Playwright-Trace.gif)
-### Playwright Trace Viewer: Troubleshooting
-If traces were uploaded but you don't see them and you get error message, please grant CORS access to the bucket.
-If you use the AWS CLI, you can set up CORS for your bucket with the following command:
-```
-aws s3api put-bucket-cors \
-    --bucket YOUR_BUCKET_NAME \
-    --cors-configuration '{
-    "CORSRules": [
-        {
-            "AllowedHeaders": ["*"],
-            "AllowedMethods": ["GET"],
-            "AllowedOrigins": ["https://app.testomat.io"],
-            "ExposeHeaders": ["Access-Control-Allow-Origin"],
-            "MaxAgeSeconds": 3000
-        },
-        {
-            "AllowedHeaders": ["*"],
-            "AllowedMethods": ["GET"],
-            "AllowedOrigins": ["https://trace.playwright.dev"],
-            "ExposeHeaders": ["Access-Control-Allow-Origin"],
-            "MaxAgeSeconds": 3000
-        }
-    ]
-}'
-```
-If you use S3 other than AWS consider setting CORS settings otherwise. Ensure, that websites:
-* `https://trace.playwright.dev`
-* `https://app.testomat.io`
-Have access to your S3 bucket and can perform `GET` requests.
----
-## Parallel Execution Reporting
-To report parallel test executions to the same Testomat.io run, assign a shared title to all parallel runs and set the `TESTOMATIO_SHARED_RUN` environment variable.
-```bash
-TESTOMATIO_TITLE="report for commit ${GIT_COMMIT}" TESTOMATIO_SHARED_RUN=1 <actual run command>
-```
-> **Tip**: Use a commit hash as the title for unique run identification across parallel jobs.
-### Extending Shared Run Timeout
-The default shared run timeout is 20 minutes. To extend it, use the `TESTOMATIO_SHARED_RUN_TIMEOUT` variable. For example, set it to 2 hours (120 minutes) as follows:
-```bash
-TESTOMATIO={API_KEY} TESTOMATIO_TITLE="report for commit ${GIT_COMMIT}" TESTOMATIO_SHARED_RUN=1 TESTOMATIO_SHARED_RUN_TIMEOUT=120 <actual run command>
-```
----
-This README provides an overview of setting up Playwright with Testomat.io for efficient test management and reporting. For additional guidance, visit the [Testomat.io documentation](https://docs.testomat.io).