Skip to content

Commit b750b9e

Browse files
committed
Update docs, yml, and command description
1 parent 117f350 commit b750b9e

8 files changed

Lines changed: 20 additions & 11 deletions

File tree

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,9 @@ flank:
204204

205205
## Enable create additional local junit result on local storage with failure nodes on passed flaky tests.
206206
# full-junit-result: false
207+
208+
## Disables flank results upload on gcloud storage.
209+
# disable-results-upload: false
207210
```
208211

209212
### Android example

test_runner/docs/ascii/flank.jar_-android-run.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ Configuration is read from flank.yml
157157
Output style of execution status. May be one of [verbose, multi, single]. For runs with only one test execution the default value is 'verbose', in other cases 'multi' is used as the default. The output style 'multi' is not displayed correctly on consoles which don't support ansi codes, to avoid corrupted output use `single` or `verbose`.
158158

159159
*--disable-results-upload*::
160-
Disables flank results.
160+
Disables flank results upload on gcloud storage.
161161

162162
*--test*=_<test>_::
163163
The path to the binary file containing instrumentation tests. The given path may be in the local filesystem or in Google Cloud Storage using a URL beginning with gs://.

test_runner/docs/ascii/flank.jar_-firebase-test-android-run.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ Configuration is read from flank.yml
170170
Output style of execution status. May be one of [verbose, multi, single]. For runs with only one test execution the default value is 'verbose', in other cases 'multi' is used as the default. The output style 'multi' is not displayed correctly on consoles which don't support ansi codes, to avoid corrupted output use `single` or `verbose`.
171171

172172
*--disable-results-upload*::
173-
Disables flank results.
173+
Disables flank results upload on gcloud storage.
174174

175175
*--test*=_<test>_::
176176
The path to the binary file containing instrumentation tests. The given path may be in the local filesystem or in Google Cloud Storage using a URL beginning with gs://.

test_runner/docs/ascii/flank.jar_-firebase-test-ios-run.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -149,17 +149,17 @@ Configuration is read from flank.yml
149149
Output style of execution status. May be one of [verbose, multi, single]. For runs with only one test execution the default value is 'verbose', in other cases 'multi' is used as the default. The output style 'multi' is not displayed correctly on consoles which don't support ansi codes, to avoid corrupted output use `single` or `verbose`.
150150

151151
*--disable-results-upload*::
152-
Disables flank results.
152+
Disables flank results upload on gcloud storage.
153+
154+
*--test*=_<test>_::
155+
The path to the test package (a zip file containing the iOS app and XCTest files). The given path may be in the local filesystem or in Google Cloud Storage using a URL beginning with gs://. Note: any .xctestrun file in this zip file will be ignored if --xctestrun-file is specified.
153156

154157
*--xctestrun-file*=_<xctestrunFile>_::
155158
The path to an .xctestrun file that will override any .xctestrun file contained in the --test package. Because the .xctestrun file contains environment variables along with test methods to run and/or ignore, this can be useful for customizing or sharding test suites. The given path may be in the local filesystem or in Google Cloud Storage using a URL beginning with gs://.
156159

157160
*--xcode-version*=_<xcodeVersion>_::
158161
The version of Xcode that should be used to run an XCTest. Defaults to the latest Xcode version supported in Firebase Test Lab. This Xcode version must be supported by all iOS versions selected in the test matrix.
159162

160-
*--test*=_<test>_::
161-
The path to the test package (a zip file containing the iOS app and XCTest files). The given path may be in the local filesystem or in Google Cloud Storage using a URL beginning with gs://. Note: any .xctestrun file in this zip file will be ignored if --xctestrun-file is specified.
162-
163163
*--test-targets*=_<testTargets>_[,_<testTargets>_...]::
164164
A list of one or more test method names to run (default: run all test targets).
165165

test_runner/docs/ascii/flank.jar_-ios-run.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -141,17 +141,17 @@ Configuration is read from flank.yml
141141
Output style of execution status. May be one of [verbose, multi, single]. For runs with only one test execution the default value is 'verbose', in other cases 'multi' is used as the default. The output style 'multi' is not displayed correctly on consoles which don't support ansi codes, to avoid corrupted output use `single` or `verbose`.
142142

143143
*--disable-results-upload*::
144-
Disables flank results.
144+
Disables flank results upload on gcloud storage.
145+
146+
*--test*=_<test>_::
147+
The path to the test package (a zip file containing the iOS app and XCTest files). The given path may be in the local filesystem or in Google Cloud Storage using a URL beginning with gs://. Note: any .xctestrun file in this zip file will be ignored if --xctestrun-file is specified.
145148

146149
*--xctestrun-file*=_<xctestrunFile>_::
147150
The path to an .xctestrun file that will override any .xctestrun file contained in the --test package. Because the .xctestrun file contains environment variables along with test methods to run and/or ignore, this can be useful for customizing or sharding test suites. The given path may be in the local filesystem or in Google Cloud Storage using a URL beginning with gs://.
148151

149152
*--xcode-version*=_<xcodeVersion>_::
150153
The version of Xcode that should be used to run an XCTest. Defaults to the latest Xcode version supported in Firebase Test Lab. This Xcode version must be supported by all iOS versions selected in the test matrix.
151154

152-
*--test*=_<test>_::
153-
The path to the test package (a zip file containing the iOS app and XCTest files). The given path may be in the local filesystem or in Google Cloud Storage using a URL beginning with gs://. Note: any .xctestrun file in this zip file will be ignored if --xctestrun-file is specified.
154-
155155
*--test-targets*=_<testTargets>_[,_<testTargets>_...]::
156156
A list of one or more test method names to run (default: run all test targets).
157157

test_runner/flank.ios.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,3 +140,6 @@ flank:
140140

141141
## Enable create additional local junit result on local storage with failure nodes on passed flaky tests.
142142
# full-junit-result: false
143+
144+
## Disables flank results upload on gcloud storage.
145+
# disable-results-upload: false

test_runner/flank.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -212,3 +212,6 @@ flank:
212212

213213
## Enable create additional local junit result on local storage with failure nodes on passed flaky tests.
214214
# full-junit-result: false
215+
216+
## Disables flank results upload on gcloud storage.
217+
# disable-results-upload: false

test_runner/src/main/kotlin/ftl/config/common/CommonFlankConfig.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ data class CommonFlankConfig @JsonIgnore constructor(
135135

136136
@set:CommandLine.Option(
137137
names = ["--disable-results-upload"],
138-
description = ["Disables flank results."]
138+
description = ["Disables flank results upload on gcloud storage."]
139139
)
140140
@set:JsonProperty("disable-results-upload")
141141
var disableResultsUpload: Boolean? by data

0 commit comments

Comments
 (0)