You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/guides/modules/test/pages/collect-test-data.adoc
+8-7Lines changed: 8 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
[#introduction]
7
7
== Introduction
8
8
9
-
When you run tests in CircleCI there are two ways to store your test results. You can either use xref:optimize:artifacts.adoc[artifacts] or the xref:reference:ROOT:configuration-reference.adoc#storetestresults[`store_test_results` step]. Each of these methods has advantages, so the decision needs to be made for each project.
9
+
When you run tests in CircleCI there are two ways to store your test results. You can either use xref:optimize:artifacts.adoc[Artifacts] or the xref:reference:ROOT:configuration-reference.adoc#storetestresults[`store_test_results` step]. Each of these methods has advantages, so the decision needs to be made for each project.
10
10
11
11
When you save test data using the `store_test_results` step, CircleCI collects data from XML files and uses it to provide insights into your job. This page describes how to configure CircleCI to output test data as XML for some common test runners and store reports with the `store_test_results` step.
12
12
@@ -18,20 +18,21 @@ Using the *`store_test_results` step* gives you access to:
18
18
19
19
You can also store test results as *artifacts*, which means you can look at the raw XML. Using artifacts can be useful when debugging issues with setting up your project's test results handling, for example, finding incorrectly uploaded files.
20
20
21
-
To see test results as build artifacts, upload them using the xref:reference:ROOT:configuration-reference.adoc#storeartifacts[`store_artifacts` step]. Storing artifacts has associated costs due to the use of storage. See the xref:optimize:persist-data.adoc#custom-storage-usage[Persisting data] page for information on how to customize storage retention periods for objects like artifacts.
21
+
To see test results as build artifacts, upload them using the xref:reference:ROOT:configuration-reference.adoc#storeartifacts[`store_artifacts` Step]. Storing artifacts has associated costs due to the use of storage. See the xref:optimize:persist-data.adoc#custom-storage-usage[Persisting Data] page for information on how to customize storage retention periods for objects like artifacts.
22
22
23
23
TIP: You can choose to upload your test results using both `store_test_results` and `store_artifacts`.
24
24
25
-
Using the xref:reference:ROOT:configuration-reference.adoc#storetestresults[`store_test_results` step] allows you to do the following:
25
+
Using the xref:reference:ROOT:configuration-reference.adoc#storetestresults[`store_test_results` Step] allows you to do the following:
26
26
27
27
* Upload and store test results.
28
28
* Get a view of your passing/failing tests in the CircleCI web app.
29
29
30
30
Access test results from the *Tests tab* when viewing a job, as shown below.
Below is an example of using the xref:reference:ROOT:configuration-reference.adoc#storetestresults[`store_test_results` key] in your `.circleci/config.yml`.
35
+
Below is an example of using the xref:reference:ROOT:configuration-reference.adoc#storetestresults[`store_test_results` Key] in your `.circleci/config.yml`.
35
36
36
37
[,yml]
37
38
----
@@ -44,14 +45,14 @@ steps:
44
45
path: test-results
45
46
----
46
47
47
-
The `path` key is an absolute or relative path to your `working_directory` containing subdirectories of JUnit XML test metadata files, or the path of a single file containing all test results.
48
+
The `path` key is an absolute or relative path to your `working_directory`. It can contain JUnit XML test metadata files directly in the directory, in subdirectories, or point to a single file containing all test results.
48
49
49
50
CAUTION: Make sure that your `path` value is not a hidden folder. For example, `.my_hidden_directory` would be an invalid format.
50
51
51
52
[#viewing-storage-usage]
52
53
== Viewing storage usage
53
54
54
-
For information on viewing your storage usage, and calculating your monthly storage overage costs, see the xref:optimize:persist-data.adoc#managing-network-and-storage-usage[Persisting data] guide.
55
+
For information on viewing your storage usage, and calculating your monthly storage overage costs, see the xref:optimize:persist-data.adoc#managing-network-and-storage-usage[Persisting Data] guide.
55
56
56
57
[#test-insights]
57
58
== Test Insights
@@ -84,7 +85,7 @@ gem 'minitest-ci'
84
85
85
86
* Django should be configured using the link:https://github.com/django-nose/django-nose[`django-nose`] test runner.
86
87
87
-
For detailed information on how to test your iOS applications, refer to the xref:testing-ios.adoc[Testing iOS applications] page.
88
+
For detailed information on how to test your iOS applications, refer to the xref:testing-ios.adoc[Testing iOS Applications] page.
0 commit comments