Skip to content

Commit

Permalink
fix: updated description of instrumentation capabilities (#1002)
Browse files Browse the repository at this point in the history 
Co-authored-by: ShahRukh Ahmed <[email protected]>
  • Loading branch information
@shahrukhamd
shahrukhamd and ShahRukh Ahmed authored Jan 22, 2025
1 parent f5faff7 commit a7fc0bd
Show file tree
Hide file tree
Showing 7 changed files with 56 additions and 56 deletions.
38 changes: 19 additions & 19 deletions api/saucectl.schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1101,39 +1101,39 @@
"$ref": "#/allOf/8/then/definitions/suite/properties/timeout"
},
"appSettings": {
"description": "Overwrite real device settings.",
"description": "Configure real device settings.",
"type": "object",
"properties": {
"resigningEnabled": {
"description": "Overwrite app settings for real device to enable app resigning.",
"description": "Configure app settings for real device to enable app resigning.",
"type": "boolean"
},
"audioCapture": {
"description": "Overwrite app settings for real device to capture audio.",
"description": "Configure app settings for real device to capture audio.",
"type": "boolean"
},
"instrumentation": {
"description": "Overwrite app settings for real device instrumentation.",
"description": "Configure 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.",
"description": "Configure 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.",
"description": "Configure app settings for real device to enable bypassing of screenshot restriction.",
"type": "boolean"
},
"vitals": {
"description": "Overwrite app settings for real device to enable vitals.",
"description": "Configure app settings for real device to enable vitals.",
"type": "boolean"
},
"networkCapture": {
"description": "Overwrite app settings for real device to capture network.",
"description": "Configure app settings for real device to capture network.",
"type": "boolean"
},
"biometrics": {
"description": "Overwrite app settings for real device to intercept biometric authentication.",
"description": "Configure app settings for real device to intercept biometric authentication.",
"type": "boolean"
}
}
Expand Down Expand Up @@ -2148,43 +2148,43 @@
"additionalProperties": false
},
"appSettings": {
"description": "Overwrite real device settings.",
"description": "Configure real device settings.",
"type": "object",
"properties": {
"resigningEnabled": {
"description": "Overwrite app settings for real device to enable app resigning.",
"description": "Configure app settings for real device to enable app resigning.",
"type": "boolean"
},
"audioCapture": {
"description": "Overwrite app settings for real device to capture audio.",
"description": "Configure app settings for real device to capture audio.",
"type": "boolean"
},
"instrumentation": {
"description": "Overwrite app settings for real device instrumentation.",
"description": "Configure 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.",
"description": "Configure 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.",
"description": "Configure app settings for real device to delay system alerts.",
"type": "boolean"
},
"vitals": {
"description": "Overwrite app settings for real device to enable vitals.",
"description": "Configure app settings for real device to enable vitals.",
"type": "boolean"
},
"networkCapture": {
"description": "Overwrite app settings for real device to capture network.",
"description": "Configure app settings for real device to capture network.",
"type": "boolean"
},
"biometrics": {
"description": "Overwrite app settings for real device to intercept biometric authentication.",
"description": "Configure app settings for real device to intercept biometric authentication.",
"type": "boolean"
},
"groupDirectory": {
"description": "Overwrite app settings for real device to enable group directory access.",
"description": "Configure app settings for real device to enable group directory access.",
"type": "boolean"
}
}
Expand Down
18 changes: 9 additions & 9 deletions api/v1alpha/framework/espresso.schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -279,39 +279,39 @@
"$ref": "../subschema/common.schema.json#/definitions/timeout"
},
"appSettings": {
"description": "Overwrite real device settings.",
"description": "Configure real device settings.",
"type": "object",
"properties": {
"resigningEnabled": {
"description": "Overwrite app settings for real device to enable app resigning.",
"description": "Configure app settings for real device to enable app resigning.",
"type": "boolean"
},
"audioCapture": {
"description": "Overwrite app settings for real device to capture audio.",
"description": "Configure app settings for real device to capture audio.",
"type": "boolean"
},
"instrumentation": {
"description": "Overwrite app settings for real device instrumentation.",
"description": "Configure 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.",
"description": "Configure 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.",
"description": "Configure app settings for real device to enable bypassing of screenshot restriction.",
"type": "boolean"
},
"vitals": {
"description": "Overwrite app settings for real device to enable vitals.",
"description": "Configure app settings for real device to enable vitals.",
"type": "boolean"
},
"networkCapture": {
"description": "Overwrite app settings for real device to capture network.",
"description": "Configure app settings for real device to capture network.",
"type": "boolean"
},
"biometrics": {
"description": "Overwrite app settings for real device to intercept biometric authentication.",
"description": "Configure app settings for real device to intercept biometric authentication.",
"type": "boolean"
}
}
Expand Down
20 changes: 10 additions & 10 deletions api/v1alpha/framework/xcuitest.schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -139,43 +139,43 @@
"additionalProperties": false
},
"appSettings": {
"description": "Overwrite real device settings.",
"description": "Configure real device settings.",
"type": "object",
"properties": {
"resigningEnabled": {
"description": "Overwrite app settings for real device to enable app resigning.",
"description": "Configure app settings for real device to enable app resigning.",
"type": "boolean"
},
"audioCapture": {
"description": "Overwrite app settings for real device to capture audio.",
"description": "Configure app settings for real device to capture audio.",
"type": "boolean"
},
"instrumentation": {
"description": "Overwrite app settings for real device instrumentation.",
"description": "Configure 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.",
"description": "Configure 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.",
"description": "Configure app settings for real device to delay system alerts.",
"type": "boolean"
},
"vitals": {
"description": "Overwrite app settings for real device to enable vitals.",
"description": "Configure app settings for real device to enable vitals.",
"type": "boolean"
},
"networkCapture": {
"description": "Overwrite app settings for real device to capture network.",
"description": "Configure app settings for real device to capture network.",
"type": "boolean"
},
"biometrics": {
"description": "Overwrite app settings for real device to intercept biometric authentication.",
"description": "Configure app settings for real device to intercept biometric authentication.",
"type": "boolean"
},
"groupDirectory": {
"description": "Overwrite app settings for real device to enable group directory access.",
"description": "Configure app settings for real device to enable group directory access.",
"type": "boolean"
}
}
Expand Down
14 changes: 7 additions & 7 deletions internal/cmd/run/espresso.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,13 +76,13 @@ func NewEspressoCmd() *cobra.Command {
cmd.Flags().Var(&lflags.Device, "device", "Specifies the device to use for testing. Requires --name to be set.")

// Overwrite devices settings
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("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("resigningEnabled", "suite::appSettings::resigningEnabled", false, "Configure app settings for real device to enable app resigning.")
sc.Bool("audioCapture", "suite::appSettings::audioCapture", false, "Configure app settings for real device to capture audio.")
sc.Bool("imageInjection", "suite::appSettings::instrumentation::imageInjection", false, "Configure app settings for real device to inject provided images in the user app.")
sc.Bool("bypassScreenshotRestriction", "suite::appSettings::instrumentation::bypassScreenshotRestriction", false, "Configure app settings for real device to enable bypassing of screenshot restriction.")
sc.Bool("vitals", "suite::appSettings::instrumentation::vitals", false, "Configure app settings for real device to enable vitals.")
sc.Bool("networkCapture", "suite::appSettings::instrumentation::networkCapture", false, "Configure app settings for real device to capture network.")
sc.Bool("biometrics", "suite::appSettings::instrumentation::biometrics", false, "Configure app settings for real device to intercept biometric authentication.")

return cmd
}
Expand Down
18 changes: 9 additions & 9 deletions internal/cmd/run/xcuitest.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,15 +72,15 @@ func NewXCUITestCmd() *cobra.Command {
cmd.Flags().Var(&lflags.Device, "device", "Specifies the device to use for testing. Requires --name to be set.")
cmd.Flags().Var(&lflags.Simulator, "simulator", "Specifies the simulator to use for testing. Requires --name to be set.")

// Overwrite devices settings
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("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.")
// Configure devices settings
sc.Bool("resigningEnabled", "suite::appSettings::resigningEnabled", false, "Configure app settings for real device to enable app resigning.")
sc.Bool("audioCapture", "suite::appSettings::audioCapture", false, "Configure app settings for real device to capture audio.")
sc.Bool("imageInjection", "suite::appSettings::instrumentation::imageInjection", false, "Configure app settings for real device to inject provided images in the user app.")
sc.Bool("sysAlertsDelay", "suite::appSettings::instrumentation::sysAlertsDelay", false, "Configure app settings for real device to delay system alerts.")
sc.Bool("vitals", "suite::appSettings::instrumentation::vitals", false, "Configure app settings for real device to enable vitals.")
sc.Bool("networkCapture", "suite::appSettings::instrumentation::networkCapture", false, "Configure app settings for real device to capture network.")
sc.Bool("biometrics", "suite::appSettings::instrumentation::biometrics", false, "Configure app settings for real device to intercept biometric authentication.")
sc.Bool("groupDirectory", "suite::appSettings::instrumentation::groupDirectory", false, "Configure app settings for real device to enable group directory access.")

return cmd
}
Expand Down
2 changes: 1 addition & 1 deletion internal/saucecloud/espresso.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@ func (r *EspressoRunner) newStartOptions(
DeviceType: d.deviceType,
DevicePrivateOnly: d.privateOnly,

// Overwrite device settings
// Configure device settings
RealDeviceKind: strings.ToLower(espresso.Android),
AppSettings: job.AppSettings{
////////////////////////////////////////////////////////////////////////////////////////////////////////////
Expand Down
2 changes: 1 addition & 1 deletion internal/saucecloud/xcuitest.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ func (r *XcuitestRunner) startJob(jobOpts chan<- job.StartOptions, appFileID, te
Env: s.Env,
ARMRequired: d.armRequired,

// Overwrite device settings
// Configure device settings
RealDeviceKind: strings.ToLower(xcuitest.IOS),
AppSettings: job.AppSettings{
ResigningEnabled: s.AppSettings.ResigningEnabled,
Expand Down

0 comments on commit a7fc0bd

Please sign in to comment.