Udpate docs

Flank · Oct 26, 2020 · a710203 · a710203
1 parent 8dbfcd2
commit a710203
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 2 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -145,6 +145,12 @@ gcloud:
   #   version: 12.0
   #   locale: es_ES
   #   orientation: landscape
+
+  ## A list of paths that will be copied from the device's storage to the designated results bucket after the test
+  ## is complete. These must be absolute paths under /private/var/mobile/Media or /Documents
+  ## of the app under test. If the path is under an app's /Documents, it must be prefixed with the app's bundle id and a colon
+  # directories-to-pull:
+  #   - /private/var/mobile/Media
 
 flank:
   # -- FlankYml --

diff --git a/test_runner/flank.ios.yml b/test_runner/flank.ios.yml
@@ -77,6 +77,12 @@ gcloud:
   #   locale: es_ES
   #   orientation: landscape
 
+  ## A list of paths that will be copied from the device's storage to the designated results bucket after the test
+  ## is complete. These must be absolute paths under /private/var/mobile/Media or /Documents
+  ## of the app under test. If the path is under an app's /Documents, it must be prefixed with the app's bundle id and a colon
+  # directories-to-pull:
+  #   - /private/var/mobile/Media
+
 flank:
   # -- FlankYml --
 

diff --git a/test_runner/src/main/kotlin/ftl/config/common/CommonGcloudConfig.kt b/test_runner/src/main/kotlin/ftl/config/common/CommonGcloudConfig.kt
@@ -124,11 +124,13 @@ data class CommonGcloudConfig @JsonIgnore constructor(
         names = ["--directories-to-pull"],
         split = ",",
         description = ["A list of paths that will be copied from the device's " +
-            "storage to the designated results bucket after the test is complete. These must be absolute paths under " +
+            "storage to the designated results bucket after the test is complete. For Android devices these must be absolute paths under " +
             "/sdcard or /data/local/tmp (for example, --directories-to-pull /sdcard/tempDir1,/data/local/tmp/tempDir2). " +
             "Path names are restricted to the characters a-zA-Z0-9_-./+. The paths /sdcard and /data will be made available " +
             "and treated as implicit path substitutions. E.g. if /sdcard on a particular device does not map to external " +
-            "storage, the system will replace it with the external storage path prefix for that device."]
+            "storage, the system will replace it with the external storage path prefix for that device. " +
+            "For iOS devices these must be absolute paths under /private/var/mobile/Media or /Documents " +
+            "of the app under test. If the path is under an app's /Documents, it must be prefixed with the app's bundle id and a colon"]
     )
     @set:JsonProperty("directories-to-pull")
     var directoriesToPull: List<String>? by data