Updated documentation for Test Artifacts (#492)

testomatio · Mar 3, 2025 · 0357335 · 0357335
1 parent d210667
commit 0357335
Show file tree

Hide file tree

Showing 5 changed files with 201 additions and 50 deletions.
diff --git a/.DS_Store b/.DS_Store
diff --git a/docs/artifacts.md b/docs/artifacts.md
@@ -1,24 +1,75 @@
-# 🛡 Artifacts
-
-Artifacts are files produced by test runner, usually screenshots, videos or traces.
+---
+title: Test Artifacts
+description: Understand how to manage and upload test artifacts in Testomat.io using external S3-compatible storage. This guide covers configuring public and private access to test artifacts, setting up an S3 bucket, and automating the upload of screenshots, videos, and other test-related files. Learn how to securely store and manage artifacts to improve test analysis and reporting.
+type: article
+url: https://docs.testomat.io/project/runs/reporter/artifacts
+head:
+  - tag: meta
+    attrs:
+      name: og:image
+      content: https://docs.testomat.io/_astro/shared_artifacts.B-l29chE_ZH695H.webp
+
+  - tag: meta
+    attrs:
+      name: keywords
+      content: Testomat.io, test artifacts, S3 storage, public access, private access, test management, test reports, automation, artifact upload, S3 configuration, QA tools
+---
+# 🛡 Test Artifacts
+
+To inspect a failing test additional files (usually screenshots, videos or traces) can be attached to a test. These files are called test artifacts.
 
 Testomat.io Reporter uses a custom S3 bucket for artifacts which can be obtained from any S3 provider, like AWS, DigitalOcean and others. This makes artifacts storage to be independent from Testomat.io Application. In case you decide to stop using it, you still control your data. It is also up to you to clean old artifacts when you don't need them.
 
 By using external storage Testomat.io allows getting full control over how the storage is used. You can either clean up old test artifacts or contrary extend storage to store all history for all periods. S3 was chosen as a de-facto standard for file storage so all cloud providers support it. If you don't have S3 storage yet, you can purchase one from your favorite cloud provider and create a new bucket (storage space) on it. Testomat.io has no direct access to artifacts storage.
 
-![](./images/artifacts.png)
+## Set Up S3 Bucket
+
+To have test artifacts uploaded you need to create S3 Object Storage bucket on AWS, DigitalOcean, Azure, or Google Cloud Storage in interoperability mode.
+
+<Aside type="caution" title="Important">
+
+You need to obtain the following credentials: `ACCESS_KEY_ID`, `SECRET_ACCESS_KEY`, `BUCKET`, `REGION`, `ENDPOINT` (not required for AWS) to access S3 bucket. Then to to [Configuration](#configuration) section to enable S3 access.
+</Aside>
 
-Test artifacts can be uploaded with public (default) or private access to a bucket
+## Overview
 
-1. reporter sends a file to S3 storage and sends link back
+Test artifacts can be uploaded with **public (default) or private** access to a bucket
+
+![Test Artifacts](./images/artifacts.png)
+
+1. Reporter sends a file to S3 storage and sends link back
 2. Testomat.io displays artifacts by the link in public mode or pre-signed links in private mode
 
-> **Note**
 > Testomat.io Application won't bill you for stored artifacts, as they are stored in your bucket. If you don't have S3 bucket yet, it's not more than 5$ a month to purchase them one of the cloud providers. S3 was chosen as it is de-facto standard for file storage for cloud hosting. All popular hosting except Microsoft Azure support S3 protocol for storing files.
 
-If a test files, a test runner may produce screenshot, video, or trace of a failed test. These files will be picked up by a reporter and uploaded to S3 bucket and attached to test.
+If a test fails, a test runner may produce screenshot, video, or trace of a failed test. These files will be picked up by a reporter and uploaded to S3 bucket and attached to test.
+
+## Privacy
+
+### Public Access
+
+**By default tests artifacts are uploaded to bucket with `public-read` permission.**
+
+In this case uploaded files will be publicly accessible in Internet for any user via a permalink. These public links will be used by [Testomat.io Application](https://testomat.io) as well as [GitHub](./pipes/github.md#github-pipe) and [GitLab](./pipes/gitlab.md#gitlab-pipe) Pipes to display images.
+
+A bucket can be configured to disable the public listing of files, an arbitrary user can't access a file without knowing that permalink.
+
+Stored files will be served publicly via an appropriately configured ACL (Access Control List) or ACP (Access Control Policy).
+
+### Private Access
 
-### Configuration
+If you need a more secure approach use **private access** mode. In this case, you will need to configure access credentials for Testomat.io, so it could access files inside a bucket.
+
+First, add `TESTOMATIO_PRIVATE_ARTIFACTS=1` environment value.
+Then provide the same S3 credentials in "Settings > Artifacts" section of a project, so [Testomat.io Application](https://testomat.io) could connect to the same bucket and fetch uploaded artifacts.
+
+Links to files will be pre-signed and expire automatically in 10 minutes.
+
+![Testomatio - Private Access](./images/Test_artifacts.png)
+
+> Test Artifacts settings are available only to managers and owners of a project!
+
+## Configuration
 
 There are two options for setting S3 bucket credentials:
 
@@ -27,35 +78,46 @@ There are two options for setting S3 bucket credentials:
 
 Recommended way is to set S3 bucket credentials as environment variables:
 
-- **S3_REGION** - Region your bucket lies.
-- **S3_BUCKET** - Bucket name.
-- **S3_ACCESS_KEY_ID** - Access key.
-- **S3_SECRET_ACCESS_KEY** - Secret.
-- **S3_ENDPOINT** - for providers other than AWS
-
-These variables can be stored into `.env` file if tests are executed locally or added to CI configuration. Please keep `S3_SECRET_ACCESS_KEY` in secret.
+* `S3_ACCESS_KEY_ID` - Access key.
+* `S3_SECRET_ACCESS_KEY` - Secret.
+* `S3_REGION` - Region your bucket lies.
+* `S3_BUCKET` - Bucket name.
+* `S3_ENDPOINT` - for providers other than AWS
 
-If you use Testomat.io Application, you can set those variables inside **Settings > Artifacts** and share credentials with reporter
+If you use Testomat.io Application, you can set those variables inside **Settings > Artifacts** page: enable "Share credentials" toggle to pass credentials into reporter and fill in S3 credentials into the displayed form.
 
-![](./images/shared_artifacts.png)
+![Testomatio - Configuration](./images/Configuration.png)
 
 In this case Testomat.io Reporter will obtain S3 credentials for server and use them to save artifacts.
 
-### Privacy
+Alternatively, you can configure reporter by using environment variables. If `S3_BUCKET` environment variable is defined reporter will start uploading test artifacts.
 
-**👀 By default tests artifacts are uploaded to bucket with `public-read` permission.**
+We recommend storing S3 configuration in `.env` files when running tests locally and using job configuration when running on the Continuous Integration server.
+Please keep `S3_SECRET_ACCESS_KEY` in secret.
 
-In this case uploaded files will be publicly accessible in Internet. These public links will be used by [Testomat.io Application](https://testomat.io) as well as [GitHub](./pipes/github.md#github-pipe) and [GitLab](./pipes/gitlab.md#gitlab-pipe) Pipes to display images.
+```
+# enable private access mode
+TESTOMATIO_PRIVATE_ARTIFACTS=1
 
-**➿ To upload files with private access** bucket add `TESTOMATIO_PRIVATE_ARTIFACTS=1` environment value.
-Then update provide the same S3 credentials in "Settings > Artifacts" section of a project,
-so [Testomat.io Application](https://testomat.io) could connect to the same bucket and fetch uploaded artifacts.
+# s3 upload config
+S3_ACCESS_KEY_ID=
+S3_SECRET_ACCESS_KEY=
+S3_REGION=
+S3_BUCKET=
+S3_ENDPOINT=
 
-Links to files will be pre-signed and expire automatically in 10 minutes.
+```
+> `S3_ENDPOINT` is required only if you use S3 provider other than AWS
+
+To disable publishing of artifacts use `TESTOMATIO_DISABLE_ARTIFACTS=1` environment variable.
+
+Examples of upload configuration defined in environment variables are displayed below.
 
-### Providers
+## Providers
 
-##### AWS
+### AWS
+
+Upload to AWS with private access mode:
 
 ```bash
 TESTOMATIO_PRIVATE_ARTIFACTS=1
@@ -65,7 +127,71 @@ S3_BUCKET=artifacts
 S3_REGION=us-west-1
 ```
 
-##### DigitalOcean
+To allow Testomat.io access stored files it is recommended to apply this policy to the bucket:
+
+```json
+{
+    "Version": "2012-10-17",
+    "Statement": [
+        {
+            "Sid": "VisualEditor0",
+            "Effect": "Allow",
+            "Action": [
+                "s3:PutObject",
+                "s3:GetObjectAcl",
+                "s3:GetObject",
+                "s3:GetObjectVersionAcl"
+            ],
+            "Resource": "arn:aws:s3:::<bucket_name>/*"
+        },
+        {
+            "Sid": "VisualEditor1",
+            "Effect": "Allow",
+            "Action": [
+                "s3:ListBucket",
+                "s3:PutBucketCORS",
+                "s3:GetBucketAcl"
+            ],
+            "Resource": "arn:aws:s3:::<bucket_name>"
+        },
+        {
+            "Sid": "VisualEditor2",
+            "Effect": "Allow",
+            "Action": "s3:ListAllMyBuckets",
+            "Resource": "*"
+        }
+    ]
+}
+```
+
+If you use **Playwright** and you want to enable trace viewing ensure that CORS policy is enabled for the bucket:
+
+```
+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
+        }
+    ]
+}'
+```
+
+### DigitalOcean
+
+Upload to DigitalOcean in private access mode:
 
 ```bash
 TESTOMATIO_PRIVATE_ARTIFACTS=1
@@ -76,7 +202,9 @@ S3_BUCKET=artifacts
 S3_REGION=ams3
 ```
 
-##### Minio
+### Minio
+
+Upload to Minio in public access mode:
 
 ```bash
 S3_ENDPOINT=http://company.storage.com
@@ -88,13 +216,13 @@ S3_FORCE_PATH_STYLE=true
 
 > It is important to add S3_FORCE_PATH_STYLE var for minio setup
 
-##### Google Cloud Storage
+### Google Cloud Storage
 
 Google Cloud Storage can work via S3 protocol if **Interoperability mode** is enabled.
 
-![](./images/google-interoperability.png)
+![Testomatio - Google Cloud Storage](./images/Google_Cloud.png)
 
-Open Cloud Storage. Create a bucket for artifacts, then inside Settings select "Interoperability". Create Access Key and Secret Key for the current user.
+Open Cloud Storage. Create a bucket for artifacts, then inside Settings select "Interoperability". Create `ACCESS_KEY` and `SECRET_ACCESS_KEY` for the current user.
 
 ```bash
 S3_ENDPOINT=https://storage.googleapis.com
@@ -103,21 +231,53 @@ S3_SECRET_ACCESS_KEY=2222222
 S3_BUCKET=testomatio
 S3_REGION=us-east1
 ```
+Please note, that you need to enable [Use Private URLs for Test Artifacts](https://docs.testomat.io/project/runs/reporter/artifacts/#privacy) in Testomat.io Project Settings if you configure bucket credentials on Testomat.io side.
+
+## Adding Artifacts
 
-### Adding Artifacts
+### JavaScript Frameworks
 
-#### JavaScript Frameworks
+If you successfully configured `@testomatio/reporter` to work with the current test runner you can set up S3 credentials via environment variables.
 
-Testomat.io Reporter has built-in support for test artifacts of following frameworks:
+We recommend using [dotenv](https://www.npmjs.com/package/dotenv) library in development mode to store all config variables in a file. Create .env files in the same folder where a test configuration is stored and add require('dotenv').config(); to the top of the file:
+
+```js
+// config file
+require('dotenv').config()
+
+// ...
+```
 
-- Playwright
-- CodeceptJS
-- Cypress
-- webdriverio
+Testomat.io Reporter has built-in support and automatically uploads saved artifacts for the following test frameworks:
 
-If a screenshot, a video, or a trace was saved and attached to test, Testomat.io reporter will automatically upload any of these as artifacts.
+* Playwright
+* CodeceptJS
+* Сypress
+* WebdriverIO
 
-Usually, artifacts are stored automatically for failed test cases. To send arbitrary files as artifacts use [`artifact`](./functions.md#artifact) method from testomat functions `@testomatio/reporter` package.
+If a screenshot, a video, or a trace was saved and attached to test, Testomat.io Reporter will automatically upload any of these as artifacts.
+
+Usually, artifacts are stored automatically for failed test cases. To send arbitrary files as artifacts use [`artifact`](./functions.md#artifact) method from Testomat.io functions `@testomatio/reporter` package.
+
+If you use other test runners or you want to add more files to test report you can add this via `@testomatio/reporter` API. To attach a file inside a test, add a filename of an existing file to `global.testomatioArtifacts` array:
+
+```js
+// inside a test:
+
+// attach a local file to a report
+global.testomatioArtifacts.push(fileName);
+
+// attach a picture inside a test
+
+global.testomatioArtifacts.push('img/file.png');
+
+// attach a picture and add a name to it
+global.testomatioArtifacts.push({ name: 'Screenshot', path: 'img/file.png' });
+```
+
+Artifacts will be uploaded for the current test when it is finished:
+
+If everything was configured correctly test artifacts will be uploaded on the next run.
 
 If S3 credentials are not set, artfact file will be ignored.
 
@@ -155,8 +315,6 @@ Console.WriteLine("file://" + pathToScreenshot);
 Attaching a screenshot to the Python test
 
 ```python
-# assume you created a screenshot
-# which is located at `pathToScreenshot`
 print("file://" + pathToScreenshot)
 ```
 
@@ -165,13 +323,9 @@ print("file://" + pathToScreenshot)
 Attaching a screenshot to the Ruby test
 
 ```python
-# assume you created a screenshot
-# which is located at `path_to_screenshot`
 puts "file://" + path_to_screenshot
 ```
 
-<!-- post-uploading-artifacts -->
-
 ## Troubleshooting
 
 #### I don't have a S3 Bucket
@@ -200,6 +354,3 @@ This can be caused by various reasons. As an alternative approach, you can try t
 At this moment we don't provide any tools for the cleanup of files.
 It is recommended to write a custom cleanup tool on a S3 bucket.
 
-<!-- retry upload artifacts -->
-
-<!-- upload big artifacts slows down -->
diff --git a/docs/images/Configuration.png b/docs/images/Configuration.png
diff --git a/docs/images/Google_Cloud.png b/docs/images/Google_Cloud.png
diff --git a/docs/images/Test_artifacts.png b/docs/images/Test_artifacts.png