@testream/playwright-reporter 0.3.0 → 0.4.0
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.
- package/LICENSE +3 -4
- package/README.md +18 -26
- package/package.json +3 -3
package/LICENSE
CHANGED
|
@@ -1,20 +1,19 @@
|
|
|
1
1
|
Proprietary License
|
|
2
2
|
|
|
3
|
-
Copyright (c)
|
|
3
|
+
Copyright (c) 2026 Testream Team. All rights reserved.
|
|
4
4
|
|
|
5
5
|
This software and associated documentation files (the "Software") are licensed,
|
|
6
6
|
not sold, to you for use only under the terms of this license.
|
|
7
7
|
|
|
8
8
|
GRANT OF LICENSE:
|
|
9
9
|
You are granted a non-exclusive, non-transferable license to use the Software
|
|
10
|
-
solely for the purpose of integrating test result reporting with the
|
|
11
|
-
Manager service.
|
|
10
|
+
solely for the purpose of integrating test result reporting with the Testream service.
|
|
12
11
|
|
|
13
12
|
RESTRICTIONS:
|
|
14
13
|
- You may not modify, adapt, or create derivative works of the Software
|
|
15
14
|
- You may not distribute, sublicense, lease, or rent the Software
|
|
16
15
|
- You may not reverse engineer, decompile, or disassemble the Software
|
|
17
|
-
- The Software may only be used in conjunction with the
|
|
16
|
+
- The Software may only be used in conjunction with the Testream service
|
|
18
17
|
|
|
19
18
|
OWNERSHIP:
|
|
20
19
|
The Software is licensed, not sold. This license does not grant you any rights
|
package/README.md
CHANGED
|
@@ -1,15 +1,14 @@
|
|
|
1
1
|
# @testream/playwright-reporter
|
|
2
2
|
|
|
3
|
-
Playwright reporter that generates [CTRF](https://ctrf.io/) (Common Test Report Format) test reports and automatically uploads
|
|
3
|
+
Playwright reporter that generates [CTRF](https://ctrf.io/) (Common Test Report Format) test reports and automatically uploads test results with artifacts to Testream.
|
|
4
4
|
|
|
5
5
|
## Features
|
|
6
6
|
|
|
7
7
|
- 🎭 **Playwright Integration** - Works seamlessly with Playwright Test
|
|
8
|
-
- 📊 **
|
|
9
|
-
- ☁️ **Automatic Upload** - Uploads test results and artifacts to your backend API
|
|
8
|
+
- 📊 **Automatic Upload** - Uploads test results and artifacts to Testream
|
|
10
9
|
- 📎 **Artifact Support** - Automatically uploads screenshots, videos, and traces
|
|
11
10
|
- 🔄 **CI/CD Ready** - Auto-detects git context from GitHub Actions, GitLab CI, CircleCI, Jenkins
|
|
12
|
-
- ⚙️ **Configurable** - Full control over
|
|
11
|
+
- ⚙️ **Configurable** - Full control over upload behavior and metadata
|
|
13
12
|
- 🛡️ **Error Handling** - Graceful failure modes with optional strict mode
|
|
14
13
|
|
|
15
14
|
## Installation
|
|
@@ -32,7 +31,7 @@ export default defineConfig({
|
|
|
32
31
|
'@testream/playwright-reporter',
|
|
33
32
|
{
|
|
34
33
|
// Required: API configuration
|
|
35
|
-
apiKey: process.env.
|
|
34
|
+
apiKey: process.env.TESTREAM_API_KEY,
|
|
36
35
|
projectKey: 'PROJECT-1',
|
|
37
36
|
|
|
38
37
|
// Optional: Git context (auto-detected in CI environments)
|
|
@@ -138,7 +137,7 @@ export default defineConfig({
|
|
|
138
137
|
[
|
|
139
138
|
'@testream/playwright-reporter',
|
|
140
139
|
{
|
|
141
|
-
apiKey: process.env.
|
|
140
|
+
apiKey: process.env.TESTREAM_API_KEY,
|
|
142
141
|
projectKey: 'PROJECT-1',
|
|
143
142
|
uploadEnabled: process.env.CI === 'true', // Only upload in CI
|
|
144
143
|
},
|
|
@@ -153,8 +152,8 @@ It's recommended to store sensitive configuration in environment variables:
|
|
|
153
152
|
|
|
154
153
|
```bash
|
|
155
154
|
# .env
|
|
156
|
-
|
|
157
|
-
|
|
155
|
+
TESTREAM_API_KEY=your-api-key-here
|
|
156
|
+
TESTREAM_PROJECT_KEY=PROJECT-1
|
|
158
157
|
```
|
|
159
158
|
|
|
160
159
|
Then load them in your config:
|
|
@@ -170,8 +169,8 @@ export default defineConfig({
|
|
|
170
169
|
[
|
|
171
170
|
'@testream/playwright-reporter',
|
|
172
171
|
{
|
|
173
|
-
apiKey: process.env.
|
|
174
|
-
projectKey: process.env.
|
|
172
|
+
apiKey: process.env.TESTREAM_API_KEY,
|
|
173
|
+
projectKey: process.env.TESTREAM_PROJECT_KEY,
|
|
175
174
|
},
|
|
176
175
|
],
|
|
177
176
|
],
|
|
@@ -205,12 +204,9 @@ jobs:
|
|
|
205
204
|
- name: Install Playwright Browsers
|
|
206
205
|
run: npx playwright install --with-deps
|
|
207
206
|
|
|
208
|
-
-
|
|
209
|
-
run: npx playwright test
|
|
207
|
+
- run: npx playwright test
|
|
210
208
|
env:
|
|
211
|
-
|
|
212
|
-
TEST_MANAGER_API_URL: ${{ secrets.TEST_MANAGER_API_URL }}
|
|
213
|
-
TEST_MANAGER_PROJECT_KEY: 'PROJECT-1'
|
|
209
|
+
TESTREAM_API_KEY: ${{ secrets.TESTREAM_API_KEY }}
|
|
214
210
|
```
|
|
215
211
|
|
|
216
212
|
### GitLab CI
|
|
@@ -222,9 +218,7 @@ test:
|
|
|
222
218
|
- npm ci
|
|
223
219
|
- npx playwright test
|
|
224
220
|
variables:
|
|
225
|
-
|
|
226
|
-
TEST_MANAGER_API_URL: $TEST_MANAGER_API_URL
|
|
227
|
-
TEST_MANAGER_PROJECT_KEY: "PROJECT-1"
|
|
221
|
+
TESTREAM_API_KEY: $TESTREAM_API_KEY
|
|
228
222
|
```
|
|
229
223
|
|
|
230
224
|
### CircleCI
|
|
@@ -240,9 +234,7 @@ jobs:
|
|
|
240
234
|
- run: npm ci
|
|
241
235
|
- run: npx playwright test
|
|
242
236
|
environment:
|
|
243
|
-
|
|
244
|
-
TEST_MANAGER_API_URL: $TEST_MANAGER_API_URL
|
|
245
|
-
TEST_MANAGER_PROJECT_KEY: "PROJECT-1"
|
|
237
|
+
TESTREAM_API_KEY: $TESTREAM_API_KEY
|
|
246
238
|
```
|
|
247
239
|
|
|
248
240
|
## Troubleshooting
|
|
@@ -281,10 +273,10 @@ Manually specify branch and commit in configuration:
|
|
|
281
273
|
## How It Works
|
|
282
274
|
|
|
283
275
|
1. **Test Execution**: Playwright runs your tests
|
|
284
|
-
2. **
|
|
285
|
-
3. **Report Upload**:
|
|
286
|
-
4. **Artifact Upload**:
|
|
287
|
-
5. **
|
|
276
|
+
2. **Report Generation**: A test report is generated in standard format
|
|
277
|
+
3. **Report Upload**: The report is uploaded to Testream
|
|
278
|
+
4. **Artifact Upload**: Test artifacts (screenshots, videos, etc.) are uploaded
|
|
279
|
+
5. **Results Display**: View your results in the Testream dashboard
|
|
288
280
|
|
|
289
281
|
## Related Packages
|
|
290
282
|
|
|
@@ -297,4 +289,4 @@ Proprietary - See LICENSE file
|
|
|
297
289
|
|
|
298
290
|
## Support
|
|
299
291
|
|
|
300
|
-
For issues and questions,
|
|
292
|
+
For issues and questions, visit the [Testream Support Portal](https://testream.example.com/support).
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@testream/playwright-reporter",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"description": "Playwright CTRF reporter with automatic upload to
|
|
3
|
+
"version": "0.4.0",
|
|
4
|
+
"description": "Playwright CTRF reporter with automatic upload to Testream",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
7
|
"scripts": {
|
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
"test-results",
|
|
26
26
|
"jira"
|
|
27
27
|
],
|
|
28
|
-
"author": "
|
|
28
|
+
"author": "Testream",
|
|
29
29
|
"license": "SEE LICENSE IN LICENSE",
|
|
30
30
|
"publishConfig": {
|
|
31
31
|
"access": "public"
|