fix: incorrect espresso and xcuitest flags (#999)

* Cleaned up unused schema values * Fixed naming convention in golang space for consistency * Fixed schemas to distinguish platforms * Fixed json syntax errors * fix JSON schema * cleanup unused common appSettings in JSON schema * cleanup unused common appSettings in v1 JSON schema --------- Co-authored-by: Tian Feng <[email protected]>
saucelabs · Jan 15, 2025 · c02ba60 · c02ba60
1 parent fca048e
commit c02ba60
Show file tree

Hide file tree

Showing 10 changed files with 125 additions and 128 deletions.
diff --git a/api/saucectl.schema.json b/api/saucectl.schema.json
@@ -1124,14 +1124,6 @@
                           "description": "Overwrite app settings for real device to enable screenshot restriction.",
                           "type": "boolean"
                         },
-                        "groupFolderRedirect": {
-                          "description": "Overwrite app settings for real device to redirect group folder.",
-                          "type": "boolean"
-                        },
-                        "sysAlertsDelay": {
-                          "description": "Overwrite app settings for real device to delay system alerts.",
-                          "type": "boolean"
-                        },
                         "vitals": {
                           "description": "Overwrite app settings for real device to enable vitals.",
                           "type": "boolean"
@@ -1143,10 +1135,6 @@
                         "biometrics": {
                           "description": "Overwrite app settings for real device to intercept biometric authentication.",
                           "type": "boolean"
-                        },
-                        "groupDirectory": {
-                          "description": "Overwrite app settings for real device to enable group directory access.",
-                          "type": "boolean"
                         }
                       }
                     }
@@ -2160,7 +2148,48 @@
                   "additionalProperties": false
                 },
                 "appSettings": {
-                  "$ref": "#/allOf/1/then/properties/suites/items/properties/appSettings"
+                  "description": "Overwrite real device settings.",
+                  "type": "object",
+                  "properties": {
+                    "resigningEnabled": {
+                      "description": "Overwrite app settings for real device to enable app resigning.",
+                      "type": "boolean"
+                    },
+                    "audioCapture": {
+                      "description": "Overwrite app settings for real device to capture audio.",
+                      "type": "boolean"
+                    },
+                    "instrumentation": {
+                      "description": "Overwrite app settings for real device instrumentation.",
+                      "type": "object",
+                      "properties": {
+                        "imageInjection": {
+                          "description": "Overwrite app settings for real device to inject provided images in the user app.",
+                          "type": "boolean"
+                        },
+                        "sysAlertsDelay": {
+                          "description": "Overwrite app settings for real device to delay system alerts.",
+                          "type": "boolean"
+                        },
+                        "vitals": {
+                          "description": "Overwrite app settings for real device to enable vitals.",
+                          "type": "boolean"
+                        },
+                        "networkCapture": {
+                          "description": "Overwrite app settings for real device to capture network.",
+                          "type": "boolean"
+                        },
+                        "biometrics": {
+                          "description": "Overwrite app settings for real device to intercept biometric authentication.",
+                          "type": "boolean"
+                        },
+                        "groupDirectory": {
+                          "description": "Overwrite app settings for real device to enable group directory access.",
+                          "type": "boolean"
+                        }
+                      }
+                    }
+                  }
                 },
                 "simulators": {
                   "description": "Defines details for running this suite on virtual devices using a simulator.",

diff --git a/api/v1/subschema/common.schema.json b/api/v1/subschema/common.schema.json
@@ -58,58 +58,6 @@
       "description": "Exclude test files to skip the tests.",
       "type": "array"
     },
-    "appSettings": {
-      "description": "Overwrite real device settings.",
-      "type": "object",
-      "properties": {
-        "resigningEnabled": {
-          "description": "Overwrite app settings for real device to enable app resigning.",
-          "type": "boolean"
-        },
-        "audioCapture": {
-          "description": "Overwrite app settings for real device to capture audio.",
-          "type": "boolean"
-        },
-        "instrumentation": {
-          "description": "Overwrite app settings for real device instrumentation.",
-          "type": "object",
-          "properties": {
-            "imageInjection": {
-              "description": "Overwrite app settings for real device to inject provided images in the user app.",
-              "type": "boolean"
-            },
-            "bypassScreenshotRestriction": {
-              "description": "Overwrite app settings for real device to enable screenshot restriction.",
-              "type": "boolean"
-            },
-            "groupFolderRedirect": {
-              "description": "Overwrite app settings for real device to redirect group folder.",
-              "type": "boolean"
-            },
-            "sysAlertsDelay": {
-              "description": "Overwrite app settings for real device to delay system alerts.",
-              "type": "boolean"
-            },
-            "vitals": {
-              "description": "Overwrite app settings for real device to enable vitals.",
-              "type": "boolean"
-            },
-            "networkCapture": {
-              "description": "Overwrite app settings for real device to capture network.",
-              "type": "boolean"
-            },
-            "biometrics": {
-              "description": "Overwrite app settings for real device to intercept biometric authentication.",
-              "type": "boolean"
-            },
-            "groupDirectory": {
-              "description": "Overwrite app settings for real device to enable group directory access.",
-              "type": "boolean"
-            }
-          }
-        }
-      }
-    },
     "timeZone": {
       "description": "Specifies the timeZone for the suite.",
       "type": "string"

diff --git a/api/v1alpha/framework/espresso.schema.json b/api/v1alpha/framework/espresso.schema.json
@@ -279,7 +279,44 @@
             "$ref": "../subschema/common.schema.json#/definitions/timeout"
           },
           "appSettings": {
-            "$ref": "../subschema/common.schema.json#/definitions/appSettings"
+            "description": "Overwrite real device settings.",
+            "type": "object",
+            "properties": {
+              "resigningEnabled": {
+                "description": "Overwrite app settings for real device to enable app resigning.",
+                "type": "boolean"
+              },
+              "audioCapture": {
+                "description": "Overwrite app settings for real device to capture audio.",
+                "type": "boolean"
+              },
+              "instrumentation": {
+                "description": "Overwrite app settings for real device instrumentation.",
+                "type": "object",
+                "properties": {
+                  "imageInjection": {
+                    "description": "Overwrite app settings for real device to inject provided images in the user app.",
+                    "type": "boolean"
+                  },
+                  "bypassScreenshotRestriction": {
+                    "description": "Overwrite app settings for real device to enable screenshot restriction.",
+                    "type": "boolean"
+                  },
+                  "vitals": {
+                    "description": "Overwrite app settings for real device to enable vitals.",
+                    "type": "boolean"
+                  },
+                  "networkCapture": {
+                    "description": "Overwrite app settings for real device to capture network.",
+                    "type": "boolean"
+                  },
+                  "biometrics": {
+                    "description": "Overwrite app settings for real device to intercept biometric authentication.",
+                    "type": "boolean"
+                  }
+                }
+              }
+            }
           },
           "passThreshold": {
             "$ref": "../subschema/common.schema.json#/definitions/passThreshold"
@@ -315,4 +352,3 @@
   ],
   "additionalProperties": true
 }
-
diff --git a/api/v1alpha/framework/xcuitest.schema.json b/api/v1alpha/framework/xcuitest.schema.json
@@ -139,7 +139,48 @@
             "additionalProperties": false
           },
           "appSettings": {
-            "$ref": "../subschema/common.schema.json#/definitions/appSettings"
+            "description": "Overwrite real device settings.",
+            "type": "object",
+            "properties": {
+              "resigningEnabled": {
+                "description": "Overwrite app settings for real device to enable app resigning.",
+                "type": "boolean"
+              },
+              "audioCapture": {
+                "description": "Overwrite app settings for real device to capture audio.",
+                "type": "boolean"
+              },
+              "instrumentation": {
+                "description": "Overwrite app settings for real device instrumentation.",
+                "type": "object",
+                "properties": {
+                  "imageInjection": {
+                    "description": "Overwrite app settings for real device to inject provided images in the user app.",
+                    "type": "boolean"
+                  },
+                  "sysAlertsDelay": {
+                    "description": "Overwrite app settings for real device to delay system alerts.",
+                    "type": "boolean"
+                  },
+                  "vitals": {
+                    "description": "Overwrite app settings for real device to enable vitals.",
+                    "type": "boolean"
+                  },
+                  "networkCapture": {
+                    "description": "Overwrite app settings for real device to capture network.",
+                    "type": "boolean"
+                  },
+                  "biometrics": {
+                    "description": "Overwrite app settings for real device to intercept biometric authentication.",
+                    "type": "boolean"
+                  },
+                  "groupDirectory": {
+                    "description": "Overwrite app settings for real device to enable group directory access.",
+                    "type": "boolean"
+                  }
+                }
+              }
+            }
           },
           "simulators": {
             "description": "Defines details for running this suite on virtual devices using a simulator.",

diff --git a/api/v1alpha/subschema/common.schema.json b/api/v1alpha/subschema/common.schema.json
@@ -58,58 +58,6 @@
       "description": "Exclude test files to skip the tests.",
       "type": "array"
     },
-    "appSettings": {
-      "description": "Overwrite real device settings.",
-      "type": "object",
-      "properties": {
-        "resigningEnabled": {
-          "description": "Overwrite app settings for real device to enable app resigning.",
-          "type": "boolean"
-        },
-        "audioCapture": {
-          "description": "Overwrite app settings for real device to capture audio.",
-          "type": "boolean"
-        },
-        "instrumentation": {
-          "description": "Overwrite app settings for real device instrumentation.",
-          "type": "object",
-          "properties": {
-            "imageInjection": {
-              "description": "Overwrite app settings for real device to inject provided images in the user app.",
-              "type": "boolean"
-            },
-            "bypassScreenshotRestriction": {
-              "description": "Overwrite app settings for real device to enable screenshot restriction.",
-              "type": "boolean"
-            },
-            "groupFolderRedirect": {
-              "description": "Overwrite app settings for real device to redirect group folder.",
-              "type": "boolean"
-            },
-            "sysAlertsDelay": {
-              "description": "Overwrite app settings for real device to delay system alerts.",
-              "type": "boolean"
-            },
-            "vitals": {
-              "description": "Overwrite app settings for real device to enable vitals.",
-              "type": "boolean"
-            },
-            "networkCapture": {
-              "description": "Overwrite app settings for real device to capture network.",
-              "type": "boolean"
-            },
-            "biometrics": {
-              "description": "Overwrite app settings for real device to intercept biometric authentication.",
-              "type": "boolean"
-            },
-            "groupDirectory": {
-              "description": "Overwrite app settings for real device to enable group directory access.",
-              "type": "boolean"
-            }
-          }
-        }
-      }
-    },
     "timeZone": {
       "description": "Specifies the timeZone for the suite.",
       "type": "string"

diff --git a/internal/cmd/run/espresso.go b/internal/cmd/run/espresso.go
@@ -80,12 +80,9 @@ func NewEspressoCmd() *cobra.Command {
 	sc.Bool("audioCapture", "suite::appSettings::audioCapture", false, "Overwrite app settings for real device to capture audio.")
 	sc.Bool("imageInjection", "suite::appSettings::instrumentation::imageInjection", false, "Overwrite app settings for real device to inject provided images in the user app.")
 	sc.Bool("bypassScreenshotRestriction", "suite::appSettings::instrumentation::bypassScreenshotRestriction", false, "Overwrite app settings for real device to enable screenshot restriction.")
-	sc.Bool("groupFolderRedirect", "suite::appSettings::instrumentation::groupFolderRedirect", false, "Overwrite app settings for real device to redirect group folder.")
-	sc.Bool("sysAlertsDelay", "suite::appSettings::instrumentation::sysAlertsDelay", false, "Overwrite app settings for real device to delay system alerts.")
 	sc.Bool("vitals", "suite::appSettings::instrumentation::vitals", false, "Overwrite app settings for real device to enable vitals.")
 	sc.Bool("networkCapture", "suite::appSettings::instrumentation::networkCapture", false, "Overwrite app settings for real device to capture network.")
 	sc.Bool("biometrics", "suite::appSettings::instrumentation::biometrics", false, "Overwrite app settings for real device to intercept biometric authentication.")
-	sc.Bool("groupDirectory", "suite::appSettings::instrumentation::groupDirectory", false, "Overwrite app settings for real device to enable group directory access.")
 
 	return cmd
 }

diff --git a/internal/cmd/run/xcuitest.go b/internal/cmd/run/xcuitest.go
@@ -76,8 +76,6 @@ func NewXCUITestCmd() *cobra.Command {
 	sc.Bool("resigningEnabled", "suite::appSettings::resigningEnabled", false, "Overwrite app settings for real device to enable app resigning.")
 	sc.Bool("audioCapture", "suite::appSettings::audioCapture", false, "Overwrite app settings for real device to capture audio.")
 	sc.Bool("imageInjection", "suite::appSettings::instrumentation::imageInjection", false, "Overwrite app settings for real device to inject provided images in the user app.")
-	sc.Bool("bypassScreenshotRestriction", "suite::appSettings::instrumentation::bypassScreenshotRestriction", false, "Overwrite app settings for real device to enable screenshot restriction.")
-	sc.Bool("groupFolderRedirect", "suite::appSettings::instrumentation::groupFolderRedirect", false, "Overwrite app settings for real device to redirect group folder.")
 	sc.Bool("sysAlertsDelay", "suite::appSettings::instrumentation::sysAlertsDelay", false, "Overwrite app settings for real device to delay system alerts.")
 	sc.Bool("vitals", "suite::appSettings::instrumentation::vitals", false, "Overwrite app settings for real device to enable vitals.")
 	sc.Bool("networkCapture", "suite::appSettings::instrumentation::networkCapture", false, "Overwrite app settings for real device to capture network.")

diff --git a/internal/config/config.go b/internal/config/config.go
@@ -215,7 +215,7 @@ type AppSettings struct {
 type Instrumentation struct {
 	ImageInjection              bool `yaml:"imageInjection,omitempty" json:"imageInjection"`
 	BypassScreenshotRestriction bool `yaml:"bypassScreenshotRestriction,omitempty" json:"bypassScreenshotRestriction"`
-	GroupFolderRedirect         bool `yaml:"groupDirectory,omitempty" json:"groupDirectory"`
+	GroupDirectory              bool `yaml:"groupDirectory,omitempty" json:"groupDirectory"`
 	SysAlertsDelay              bool `yaml:"sysAlertsDelay,omitempty" json:"sysAlertsDelay"`
 	Biometrics                  bool `yaml:"biometrics,omitempty" json:"biometrics"`
 	Vitals                      bool `yaml:"vitals,omitempty" json:"vitals"`

diff --git a/internal/job/options.go b/internal/job/options.go
@@ -119,7 +119,7 @@ type Instrumentation struct {
 type Resigning struct {
 	ImageInjection         bool `json:"image_injection,omitempty"`
 	SystemAlertsDelay      bool `json:"sys_alerts_delay,omitempty"`
-	GroupFolderRedirect    bool `json:"group_directory,omitempty"`
+	GroupDirectory         bool `json:"group_directory,omitempty"`
 	BiometricsInterception bool `json:"biometrics,omitempty"`
 	Vitals                 bool `json:"vitals,omitempty"`
 	NetworkCapture         bool `json:"network_capture,omitempty"`

diff --git a/internal/saucecloud/xcuitest.go b/internal/saucecloud/xcuitest.go
@@ -245,7 +245,7 @@ func (r *XcuitestRunner) startJob(jobOpts chan<- job.StartOptions, appFileID, te
 			AudioCapture:     s.AppSettings.AudioCapture,
 			Resigning: job.Resigning{
 				ImageInjection:         s.AppSettings.Instrumentation.ImageInjection,
-				GroupFolderRedirect:    s.AppSettings.Instrumentation.GroupFolderRedirect,
+				GroupDirectory:         s.AppSettings.Instrumentation.GroupDirectory,
 				SystemAlertsDelay:      s.AppSettings.Instrumentation.SysAlertsDelay,
 				BiometricsInterception: s.AppSettings.Instrumentation.Biometrics,
 				Vitals:                 s.AppSettings.Instrumentation.Vitals,