Class: Fastlane::Actions::SauceConfigAction

Inherits:
Action
  • Object
show all
Defined in:
lib/fastlane/plugin/saucectl/actions/sauce_config_action.rb

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



199
200
201
 
# File 'lib/fastlane/plugin/saucectl/actions/sauce_config_action.rb', line 199

def self.authors
  ["Ian Hamilton"]
end

.available_options ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/fastlane/plugin/saucectl/actions/sauce_config_action.rb', line 33

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :platform,
                                 description: "application under test platform (ios or android)",
                                 optional: false,
                                 type: String,
                                 verify_block: proc do |value|
                                   UI.user_error!(@messages['platform_error']) if value.to_s.empty?
                                 end),
    FastlaneCore::ConfigItem.new(key: :kind,
                                 description: "Specifies which framework is associated with the automation tests configured in this specification (xcuitest & espresso)",
                                 optional: false,
                                 type: String,
                                 verify_block: proc do |value|
                                   UI.user_error!(@messages['platform_error']) if value.to_s.empty?
                                 end),
    FastlaneCore::ConfigItem.new(key: :app,
                                 description: "The path to the app",
                                 optional: false,
                                 type: String,
                                 verify_block: proc do |value|
                                   UI.user_error!(@messages['app_name_error']) unless value && !value.empty?
                                 end),
    FastlaneCore::ConfigItem.new(key: :test_app,
                                 description: "The path to the testing app",
                                 optional: false,
                                 is_string: true,
                                 verify_block: proc do |value|
                                   UI.user_error!(@messages['test_runner_app_error']) unless value && !value.empty?
                                 end),
    FastlaneCore::ConfigItem.new(key: :region,
                                 description: "Data Center region (us or eu), set using: region: 'eu'",
                                 optional: false,
                                 type: String,
                                 verify_block: proc do |value|
                                   UI.user_error!(@messages['region_error'].gsub!('$region', value)) unless @messages['supported_regions'].include?(value)
                                 end),
    FastlaneCore::ConfigItem.new(key: :retries,
                                 description: "Sets the number of times to retry a failed suite",
                                 optional: true,
                                 type: Integer,
                                 default_value: 0),
    FastlaneCore::ConfigItem.new(key: :test_distribution,
                                 description: "Test distribution method",
                                 optional: true,
                                 type: String,
                                 default_value: 'class'),
    FastlaneCore::ConfigItem.new(key: :test_class,
                                 description: "Array of tests to execute",
                                 optional: true,
                                 type: Array),
    FastlaneCore::ConfigItem.new(key: :emulators,
                                 description: "The parent property that defines details for running this suite on virtual devices using an emulator",
                                 optional: true,
                                 type: Array,
                                 verify_block: proc do |emulators|
                                   emulators.each do |emulator|
                                     if emulator.class != Hash
                                       UI.user_error!("Each emulator must be represented by a Hash object, #{emulator.class} found")
                                     end
                                     verify_device_property(emulator, :name)
                                     set_default_property(emulator, :orientation, 'portrait')
                                     verify_device_property(emulator, :platform_versions)
                                   end
                                 end),
    FastlaneCore::ConfigItem.new(key: :devices,
                                 description: "The parent property that defines details for running this suite on real devices",
                                 optional: true,
                                 type: Array,
                                 verify_block: proc do |devices|
                                   devices.each do |device|
                                     if device.class != Hash
                                       UI.user_error!("Each device must be represented by a Hash object, #{device.class} found")
                                     end
                                     verify_optional_device_props(device)
                                     set_default_property(device, :orientation, 'portrait')
                                     set_default_property(device, :device_type, 'phone')
                                     set_default_property(device, :private, true)
                                     set_default_property(device, :carrier_connectivity, false)
                                   end
                                 end),
    FastlaneCore::ConfigItem.new(key: :name,
                                 description: "The name of the device or emulator",
                                 optional: true,
                                 type: String),
    FastlaneCore::ConfigItem.new(key: :id,
                                 description: "The id of the device",
                                 optional: true,
                                 type: String),
    FastlaneCore::ConfigItem.new(key: :platform_versions,
                                 description: "Platform versions of the virtual device you wish to test your application on: Virtual Device only",
                                 optional: true,
                                 type: Array),
    FastlaneCore::ConfigItem.new(key: :platform_version,
                                 description: "Platform version of the real device you wish to test your application on: Real device only",
                                 optional: true,
                                 type: String),
    FastlaneCore::ConfigItem.new(key: :orientation,
                                 description: "The orientation of the device. Default: portrait",
                                 optional: true,
                                 type: String,
                                 default_value: 'portrait'),
    FastlaneCore::ConfigItem.new(key: :device_type,
                                 description: "Request that the matching device is a specific type of device. Valid values are: ANY TABLET PHONE any tablet phone",
                                 optional: true,
                                 type: String,
                                 default_value: 'phone'),
    FastlaneCore::ConfigItem.new(key: :private,
                                 description: "Request that the matching device is from your organization's private pool",
                                 optional: true,
                                 is_string: false),
    FastlaneCore::ConfigItem.new(key: :carrier_connectivity,
                                 description: "Request that the matching device is also connected to a cellular network",
                                 optional: true,
                                 is_string: false),
    FastlaneCore::ConfigItem.new(key: :test_target,
                                 description: "Name of the Xcode test target name",
                                 optional: true,
                                 type: String),
    FastlaneCore::ConfigItem.new(key: :test_plan,
                                 description: "Name of the Xcode test plan",
                                 optional: true,
                                 type: String),
    FastlaneCore::ConfigItem.new(key: :path_to_tests,
                                 description: "Path to your espresso tests",
                                 optional: true,
                                 type: String,
                                 default_value: "#{Dir.pwd}/app/src/androidTest"),
    FastlaneCore::ConfigItem.new(key: :clear_data,
                                 description: "Clear package data from device (android only)",
                                 optional: true,
                                 is_string: false,
                                 default_value: true),
    FastlaneCore::ConfigItem.new(key: :use_test_orchestrator,
                                 description: "User Android test orchestrator (android only)",
                                 optional: true,
                                 is_string: false,
                                 default_value: true),
    FastlaneCore::ConfigItem.new(key: :max_concurrency_size,
                                 description: "Sets the maximum number of suites to execute at the same time. If the test defines more suites than the max, excess suites are queued and run in order as each suite completes",
                                 optional: true,
                                 type: Integer,
                                 default_value: 1)
  ]
end

.category ⇒ Object 



203
204
205
 
# File 'lib/fastlane/plugin/saucectl/actions/sauce_config_action.rb', line 203

def self.category
  :testing
end

.description ⇒ Object 



25
26
27
 
# File 'lib/fastlane/plugin/saucectl/actions/sauce_config_action.rb', line 25

def self.description
  "Create SauceLabs configuration file for test execution based on given parameters"
end

.details ⇒ Object 



29
30
31
 
# File 'lib/fastlane/plugin/saucectl/actions/sauce_config_action.rb', line 29

def self.details
  "Create SauceLabs configuration file for test execution based on given parameters"
end

.example_code ⇒ Object 



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/fastlane/plugin/saucectl/actions/sauce_config_action.rb', line 211

def self.example_code
  [
    "sauce_config({platform: 'android',
                   kind: 'espresso',
                   app: 'path/to/myTestApp.apk',
                   test_app: 'path/to/myTestRunner.apk',
                   path_to_tests: 'path/to/app/src/androidTest',
                   region: 'eu',
                   emulators: [ {name: 'Android GoogleApi Emulator', platform_versions: %w[10.0 11.0], orientation: 'portrait'}]
                 })",
    "sauce_config({platform: 'android',
                   kind: 'espresso',
                   app: 'path/to/myTestApp.apk',
                   test_app: 'path/to/myTestRunner.apk',
                   path_to_tests: 'path/to/app/src/androidTest',
                   region: 'eu',
                   test_distribution: 'testCase',
                   devices: [ {name: 'RDC One', orientation: 'portrait', platform_version: '11.0'}]
    })",
    "sauce_config({platform: 'android',
                   kind: 'espresso',
                   app: 'path/to/myTestApp.apk',
                   test_app: 'path/to/myTestRunner.apk',
                   path_to_tests: 'path/to/app/src/androidTest',
                   region: 'eu',
                   test_distribution: 'shard',
                   devices: [ {name: 'RDC One', orientation: 'portrait', platform_version: '11.0'}]
    })",
    "sauce_config({platform: 'ios',
                   kind: 'xcuitest',
                   app: 'path/to/MyTestApp.ipa',
                   test_app: 'path/to/MyTestAppRunner.ipa',
                   region: 'eu',
                   devices: [ {name: 'iPhone RDC One'}, {id: 'iphone_rdc_two'} ],
                   test_target: 'MyDemoAppUITests'
    })",
    "sauce_config({platform: 'ios',
                   kind: 'xcuitest',
                   app: 'path/to/MyTestApp.ipa',
                   test_app: 'path/to/MyTestAppRunner.ipa',
                   region: 'eu',
                   devices: [ {name: 'iPhone RDC One'}, {id: 'iphone_rdc_two'} ],
                   test_target: 'MyDemoAppUITests',
                   test_distribution: 'shard',
    })",
    " sauce_config({platform: 'ios',
                   kind: 'xcuitest',
                   app: 'path/to/MyTestApp.ipa',
                   test_app: 'path/to/MyTestAppRunner.ipa',
                   region: 'eu',
                   devices: [ {name: 'iPhone RDC One'}, {id: 'iphone_rdc_two'} ],
                   test_target: 'MyDemoAppUITests',
                   test_distribution: 'testCase'
    })",
    "sauce_config({platform: 'ios',
                   kind: 'xcuitest',
                   app: 'path/to/MyTestApp.ipa',
                   test_app: 'path/to/MyTestAppRunner.ipa',
                   region: 'eu',
                   devices: [ {name: 'iPhone RDC One'}, {id: 'iphone_rdc_two'} ],
                   test_plan: 'EnabledUITests',
                   test_distribution: 'shard'
    })",
    "sauce_config({platform: 'ios',
                   kind: 'xcuitest',
                   app: 'path/to/MyTestApp.ipa',
                   test_app: 'path/to/MyTestAppRunner.ipa',
                   region: 'eu',
                   devices: [ {name: 'iPhone RDC One'}, {id: 'iphone_rdc_two'} ],
                   test_plan: 'UITests'
    })",
    "sauce_config({platform: 'android',
                   kind: 'espresso',
                   app: 'path/to/myTestApp.apk',
                   test_app: 'path/to/myTestRunner.apk',
                   path_to_tests: 'path/to/app/src/androidTest',
                   region: 'eu',
                   devices: [ {name: 'iPhone RDC One'}],
                   test_class: ['com.some.package.testing.SomeClassOne', 'com.some.package.testing.SomeClassTwo', 'com.some.package.testing.SomeClassThree', 'com.some.package.testing.SomeClassFour']
    })",
    "sauce_config({platform: 'android',
                   kind: 'espresso',
                   app: 'path/to/myTestApp.apk',
                   test_app: 'path/to/myTestRunner.apk',
                   path_to_tests: 'path/to/app/src/androidTest',
                   region: 'eu',
                   emulators: [ {name: 'iPhone RDC One', platform_versions: ['11.0']}, {name: 'iPhone RDC Two', platform_versions: ['11.0']}],
                   test_class: ['com.some.package.testing.SomeClassOne', 'com.some.package.testing.SomeClassTwo', 'com.some.package.testing.SomeClassThree', 'com.some.package.testing.SomeClassFour']
    })",
    "sauce_config({platform: 'ios',
                   kind: 'xcuitest',
                   app: 'path/to/myTestApp.app',
                   test_app: 'path/to/myTestRunner.app',
                   region: 'eu',
                   devices: [ {name: 'iPhone RDC One'}],
                   test_class: ['MyDemoAppUITests.SomeClassOne', 'MyDemoAppUITests.SomeClassTwo', 'MyDemoAppUITests.SomeClassThree', 'MyDemoAppUITests.SomeClassFour']
    })"
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


207
208
209
 
# File 'lib/fastlane/plugin/saucectl/actions/sauce_config_action.rb', line 207

def self.is_supported?(platform)
  [:ios, :android].include?(platform)
end

.run(params) ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/fastlane/plugin/saucectl/actions/sauce_config_action.rb', line 12

def self.run(params)
  if params[:platform].eql?('android')
    UI.user_error!("❌ For android platform you must specify devices or emulators under test in order to execute tests") if params[:emulators].nil? && params[:devices].nil?
  else
    if params[:emulators]
      UI.user_error!("❌ Sauce Labs platform does not currently support virtual device execution for ios apps")
    end
    UI.user_error!("❌ For ios platform you must specify devices under test in order to execute tests") if params[:devices].nil?
  end

  Fastlane::Saucectl::ConfigGenerator.new(params).create
end

.verify_optional_device_props(device) ⇒ Object 



183
184
185
186
187
 
# File 'lib/fastlane/plugin/saucectl/actions/sauce_config_action.rb', line 183

def self.verify_optional_device_props(device)
  unless device.key?(:name) || device.key?(:id)
    UI.user_error!("Real devices must have a device name or device id")
  end
end