@testream/pytest-reporter 1.2.1 → 1.2.2
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/README.md +32 -6
- package/package.json +15 -10
package/README.md
CHANGED
|
@@ -1,8 +1,17 @@
|
|
|
1
|
-
# @testream/pytest-reporter
|
|
1
|
+
# @testream/pytest-reporter: pytest test reporting for Jira
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
`@testream/pytest-reporter` runs pytest or ingests existing JUnit XML, then publishes Python test results to Testream as durable, Jira-visible evidence. It is suited to Python and Django projects that want CI reporting without recreating every automated test as a manual Jira case.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## What the reporter sends to Testream and Jira
|
|
6
|
+
|
|
7
|
+
- pytest outcomes converted from JUnit XML to CTRF
|
|
8
|
+
- Failure messages, stack traces, duration, and suite structure
|
|
9
|
+
- Branch, commit, build, environment, and CI metadata
|
|
10
|
+
- Suite changes and trends for Jira work and release reviews
|
|
11
|
+
|
|
12
|
+
Your pytest suite remains the execution source. Testream adds history, failure inspection, and Jira context around the results it produces.
|
|
13
|
+
|
|
14
|
+
## Install and run in CI
|
|
6
15
|
|
|
7
16
|
```yaml
|
|
8
17
|
- uses: actions/setup-python@v5
|
|
@@ -23,7 +32,24 @@ Run pytest and send the results from your codebase to Jira via Testream.
|
|
|
23
32
|
--fail-on-error
|
|
24
33
|
```
|
|
25
34
|
|
|
26
|
-
By default, `testream-pytest` runs `pytest` and writes JUnit XML to `junit/pytest-junit.xml`.
|
|
27
|
-
|
|
35
|
+
By default, `testream-pytest` runs `pytest` and writes JUnit XML to `junit/pytest-junit.xml`. Use `--junit-path` when pytest already ran and you only need to ingest an existing JUnit XML report.
|
|
36
|
+
|
|
37
|
+
## pytest evidence in CI/CD
|
|
38
|
+
|
|
39
|
+
Store `TESTREAM_API_KEY` as a protected secret. The same command can run in GitHub Actions, GitLab CI/CD, Azure Pipelines, Jenkins, or another command-based CI provider. Testream publishes the structured run so Python and Django test evidence can be reviewed with Jira and release context.
|
|
40
|
+
|
|
41
|
+
## Frequently asked questions
|
|
42
|
+
|
|
43
|
+
### Do we need to recreate automated tests as manual Jira cases?
|
|
44
|
+
|
|
45
|
+
No. pytest remains the code-first execution source. Testream publishes its results without requiring a duplicate manual case for every automated test.
|
|
46
|
+
|
|
47
|
+
### Can we upload JUnit XML from an existing pytest job?
|
|
48
|
+
|
|
49
|
+
Yes. Pass `--junit-path` to ingest the report without running pytest again.
|
|
50
|
+
|
|
51
|
+
## Official Testream resources
|
|
28
52
|
|
|
29
|
-
|
|
53
|
+
- [pytest Jira integration](https://testream.app/pytest-jira-integration)
|
|
54
|
+
- [Complete pytest reporter setup guide](https://docs.testream.app/reporters/pytest)
|
|
55
|
+
- [Install Testream – Automated Test Management for Jira](https://marketplace.atlassian.com/3048460704)
|
package/package.json
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@testream/pytest-reporter",
|
|
3
|
-
"version": "1.2.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "1.2.2",
|
|
4
|
+
"description": "Run pytest or ingest JUnit XML, then publish Python test results and CI metadata to Testream and Jira.",
|
|
5
|
+
"homepage": "https://testream.app/pytest-jira-integration",
|
|
5
6
|
"main": "dist/index.js",
|
|
6
7
|
"types": "dist/index.d.ts",
|
|
7
8
|
"scripts": {
|
|
@@ -20,15 +21,19 @@
|
|
|
20
21
|
"url": "git+https://github.com/testream/docs.git"
|
|
21
22
|
},
|
|
22
23
|
"keywords": [
|
|
24
|
+
"testream",
|
|
23
25
|
"pytest",
|
|
26
|
+
"pytest-reporter",
|
|
27
|
+
"pytest-jira",
|
|
28
|
+
"python",
|
|
29
|
+
"django",
|
|
24
30
|
"junit",
|
|
25
|
-
"reporter",
|
|
26
|
-
"testing",
|
|
27
|
-
"test-management",
|
|
28
|
-
"test-results",
|
|
29
31
|
"jira",
|
|
30
|
-
"
|
|
31
|
-
"
|
|
32
|
+
"test-management",
|
|
33
|
+
"automated-test-management",
|
|
34
|
+
"test-reporting",
|
|
35
|
+
"ci-cd",
|
|
36
|
+
"ctrf"
|
|
32
37
|
],
|
|
33
38
|
"author": "Testream",
|
|
34
39
|
"license": "SEE LICENSE IN LICENSE",
|
|
@@ -48,13 +53,13 @@
|
|
|
48
53
|
},
|
|
49
54
|
"devDependencies": {
|
|
50
55
|
"@jira-test-manager/shared-types": "*",
|
|
51
|
-
"@types/node": "^
|
|
56
|
+
"@types/node": "^25.9.3",
|
|
52
57
|
"@typescript-eslint/eslint-plugin": "^6.17.0",
|
|
53
58
|
"@typescript-eslint/parser": "^6.17.0",
|
|
54
59
|
"@vercel/ncc": "^0.38.1",
|
|
55
60
|
"eslint": "^8.56.0",
|
|
56
61
|
"prettier": "^3.1.1",
|
|
57
|
-
"typescript": "^
|
|
62
|
+
"typescript": "^6.0.3",
|
|
58
63
|
"vitest": "^4.1.9"
|
|
59
64
|
},
|
|
60
65
|
"engines": {
|