Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,14 @@ export default defineConfig({
items: [
{ label: 'Overview', link: '/advanced' },
{
label: 'Artifacts',
collapsed: true,
items: [
{ label: 'Artifacts', link: '/advanced/test-artifacts/artifacts' }
],
},
{
label: 'Tags, Custom fields',
label: 'Tags & Labels',
collapsed: true,
items: [
Expand Down
123 changes: 123 additions & 0 deletions src/content/docs/advanced/test-artifacts/artifacts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
---
title: Artifacts
description: Learn how Testomat.io handles test artifacts and attachments, such as screenshots, videos, and logs, to enhance test management and reporting. This guide explains how to add and manage attachments during test case creation, manual testing, and automated test execution with S3 cloud storage support. It also covers features like in-platform artifact preview and integrations with various frameworks and tools to streamline debugging and project documentation.
type: article
url: https://docs.testomat.io/advanced/test-artifacts/artifacts
head:
- tag: meta
attrs:
name: keywords
content: test artifacts, test attachments, screenshots, videos, test management, test reporting, debugging, manual testing, automation testing, S3 storage, AWS, DigitalOcean, Azure, Google Cloud, CI/CD, preview attachments, suite-level attachments, folder-level attachments, readme section, Jira Integration, Video Capturing, Automated Tests Analytics
---

Testomat.io offers various ways to handle test artifacts and attachments, such as screenshots, videos, logs, documents, etc. These features enhance test management, reporting, and debugging by providing visual evidence and supporting documentation.

You can add test artifacts and attachments during **test case creation**, **manual testing**, or **automation testing**.

## Add Attachments to Test Cases

Testomat.io allows you to add attachments, including screenshots, files, and videos to your test cases. It helps to visualize tests, make them more clear and offer additional information for QA managers, developers, other QAs, or stakeholders.

You can add attachments during test case creation or editing by directly **dragging & dropping** them, using the hot key **CTR+C/CTR+V** for copy/past or by using the **browse a file** option.

![Testomat.io - Add attachment](./images/Add_attachment_1.gif)

For more details on adding and managing attachments, refer to the [Add Attachments to Test](https://docs.testomat.io/project/tests/test-case-creation-and-editing/#add-attachments-to-test).

You can also manage attachments across Testomat.io by adding them to **suites**, **folders**, and the **readme section**. This streamline workflows by keeping all relevant files and documentation in one place. Whether you’re sharing important notes, reference materials, or test data, you can now attach them directly to the relevant test structures for easy access.

**Use cases:**

- **Suite-level attachments:** Attach detailed test execution reports or configuration files to specific test suites for easy reference by team members.
- **Folder-level attachments:** Add relevant project documentation or setup instructions to test folders, ensuring that all files related to a specific testing area are easily accessible.
- **Readme section attachments:** Include critical resources or additional context in the readme section, such as diagrams, code samples, or links to external resources, improving overall clarity for team members.

## Delete Attachments

If you no longer need your attachments, you can delete them.

Go to [How to Delete Attachment from Test Case](https://docs.testomat.io/project/tests/test-case-creation-and-editing/#how-to-delete-attachment-from-test-case) section to read more about this feature.

:::note

You can delete attachments from Suite, Folder and Readme section in the same way you would from a Test Case.

:::

## Add Test Arfifacts During Manual Testing

Attaching a short video or screenshots is highly useful for manual testing, especially for failing tests. These artifacts provide comprehensive information, making it easier for the QA tester to understand what went wrong.

To add test artifacts during manual tests execution:

1. Launch a run.
2. On manual run window, select the test case.
3. **Drag&drop** the test evidence into the **'Attachments'** section (or use **browse a file** or **copy/paste** option).

![Testomat.io - Add attachment](./images/Add_attachment_2.gif)

## Preview Attachments

Attachments are available for viewing without downloading. To preview an attachment, select it in the Test Case Attachment section to view it in the open dialog window.

![Testomat.io - Preview attachment](./images/Preview_attachment_2.gif)

Testomat.io also allows you to watch attached video or screenshots directly from the **Report** page.

![Testomat.io - Preview attachment](./images/Preview_attachment_1.gif)

Additionally, you can switch between list and tile views to make reviewing test artifacts easier.

![Testomat.io - Preview attachment](./images/Preview_attachment_3.gif)

## Add Test Arfifacts During Automation Testing

Testomat.io also allows you to add test artifacts during automation testing.
Test artifacts, which include screenshots and video files, provide a complete picture of your test results as soon as autotests are completed, helping you understand the root cause of a problem.

### Support Artifacts Storing to S3

This kind of implementation of **Video recording** or **Screenshots** artifacts is possible due to our integration with many **S3 Storages**: AWS, DigitalOcean, Azure, and Google Cloud. After a test run is completed, video and other artifacts are uploaded to the chosen storage, and from there, they automatically go to Testomat.io.

Testomat.io provides the ability to download unlimited data by choosing one of the available S3 Storages depending on your company’s priorities or the location of your preferred CI\CD service.

:::note

All cloud providers charge for their services. Be sure to check their rates in detail before starting.

:::

Thanks to **S3 Cloud Services** integration, you can easily find any test artifacts stored in the test project structure on your local PC or in the cloud when running tests on Github, Jenkins, or any other CI\CD service.

### How Artifact Recording Works

1. **Get test artifacts when you run autotests:** To enable this, you need to set the right parameters – specify the configuration of your cloud storage. As a result, all screenshots or video files from S3 Storage will be placed in the test report, helping you prioritize issues. You can configure artifacts to be collected from failed, passed, or all tests, whatever status was assigned to them after the end of the run. This parameter is typically configured within your testing framework (e.g., Cypress, Playwright), not in Testomat.io.

:::note

Read how to **Set up S3 Bucket** on the relevant [Test Artifacts](https://docs.testomat.io/test-reporting/artifacts/) page.

:::

2. **Upload a public or private test artifacts:** These processes are identical; the artifact travels the same path in both cases. But if a private format is selected, additional settings and data encryption are used. This feature is used by companies that pay special attention to data privacy and security of their projects or when company policy forbids public access to their projects. The necessary settings are set in the **'Artifacts'** tab and apply to all tests of a particular project. For more detail, visit the [Privacy](https://docs.testomat.io/test-reporting/artifacts/#privacy) section in the Docs.

3. **Preview or download test artifact:** You can view videos or screenshots directly on the platform or download them on your device. The latter is relevant if you need to share the test results with stakeholders.

:::note

If you share a private artifact, your recipient will receive a message that they do not have permission to view the file.

:::

### Associated Test Screenshot-Recording Features

- **Reporters by Popular Testing Frameworks** – real-time reports supporting of popular programming languages give you a complete picture of the software product’s quality level. With Advanced Reporters by popular testing frameworks, you can see the results of end-to-end, integration, unit testing, and API testing. Thanks to the integration with many S3 Storages, our SaaS test management solution retrieves test artifacts (including screenshots during a test runs) and uploads them to the report in a convenient format.

- **Automated Tests Analytics** – all test results of test executions are used for in-depth analytics. Determining the percentage of test automation, the total number of tests, the ratio of tests to uncompleted tests, failed tests, [flaky tests](https://docs.testomat.io/project/analytics/#flaky-tests), never-run tests help prioritize daily tasks and make the process transparent to all Agile team members.

- **Jira Integration** – after installing the [Jira plugin](https://docs.testomat.io/advanced/jira-plugin/), you have the ability to run test cases from Atlassian Jira and work on projects directly from either Jira or Testomat.io.; switching between tools is no longer necessary. You can also navigate from Jira to the Run Report to view a specific artifact.

- **Video Capturing Artifacts** – in addition to saving screenshots, you can also save videos from tests (passed, failed, or all completed, regardless of the result). From Test Runner and Reporter, video files, like screenshots, are uploaded to S3 Storage and then displayed in the test management system in a user-friendly format, where they can be viewed or downloaded.

- **Artifact S3 Support** – you can store [Test Artifacts](https://docs.testomat.io/test-reporting/artifacts/) in the cloud and choose the provider your company or CI\CD tool is comfortable working with: AWS, DigitalOcean, Azure, and Google Cloud.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/content/docs/legal/security/jira.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ Namely, you can:
- Use tracebility matrix and reports to check test coverage in sprints and project.
- Manage project branches.

For details on how to use Testomat.io JIRA Plugin, please refer to [JIRA guide](../../advanced/jira-plugin/index.md) in our documentation.
For details on how to use Testomat.io JIRA Plugin, please refer to [JIRA guide](https://docs.testomat.io/advanced/jira-plugin/) in our documentation.

## FAQ

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 28 additions & 0 deletions src/content/docs/project/tests/test-case-creation-and-editing.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,34 @@ After saving the changes in the edit mode, you will see a preview of the drawing

![Testomatio.io - Draw Preview](./images/New_1hpi4Xy4_2024-10-07.png)

## How to Delete Attachment from Test Case

Save time by quickly deleting unnecessary attachments, ensuring your test cases remain relevant and clutter-free. To delete attachment:

1. On 'Tests' page open Test Case.
2. Click **'Attachments'** tab.
3. Click **'Delete'** icon on the attachment you want to delete.

![Testomat.io - Delete attachment](./images/Delete_attachment_1.png)

4. Confirm action.

![Testomat.io - Delete attachment](./images/Confirm_deleting_1.png)

OR

1. On 'Tests' page open Test Case.
2. Click **'Edit'** button.

![Testomat.io - Delete attachment](./images/Delete_attachment_2.png)

3. Click **'Attachments'** tab inside edit mode.
4. Click **'Delete'** icon on the attachment you want to delete.

![Testomat.io - Delete attachment](./images/Delete_attachment_3.png)

5. Confirm action and Save changes.

## How to add a label/tag to a test

This option is the easiest one! You simply need to add the label's name (preceeded by @ char) in the name field of the test. The drop-down list of tags already used in projects appears, when you type the @ symbol.
Expand Down