Class: Fastlane::Actions::SauceUploadAction

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

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



86
87
88
 
# File 'lib/fastlane/plugin/saucectl/actions/sauce_upload_action.rb', line 86

def self.authors
  ["Ian Hamilton"]
end

.available_options ⇒ Object 



30
31
32
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
 
# File 'lib/fastlane/plugin/saucectl/actions/sauce_upload_action.rb', line 30

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :platform,
                                 description: "application under test platform (ios or android)",
                                 optional: false,
                                 is_string: true,
                                 verify_block: proc do |value|
                                   UI.user_error!(@messages['platform_error']) if value.to_s.empty?
                                 end),
    FastlaneCore::ConfigItem.new(key: :file,
                                 description: "File to upload to sauce storage",
                                 optional: false,
                                 is_string: true,
                                 verify_block: proc do |value|
                                   UI.user_error!(@messages['file_error']) unless value && !value.empty?
                                   if value
                                     UI.user_error!("Could not find file to upload \"#{value}\" ") unless File.exist?(value)
                                     extname = File.extname(value)
                                     UI.user_error!("Extension not supported for \"#{value}\" ") unless @messages['accepted_file_types'].include?(extname)
                                   end
                                 end),
    FastlaneCore::ConfigItem.new(key: :app,
                                 description: "Name of the application to be uploaded",
                                 optional: false,
                                 is_string: true,
                                 verify_block: proc do |value|
                                   UI.user_error!(@messages['app_name_error']) unless value && !value.empty?
                                 end),
    FastlaneCore::ConfigItem.new(key: :region,
                                 description: "Data Center region (us or eu), set using: region: 'eu'",
                                 optional: false,
                                 is_string: true,
                                 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: :sauce_username,
                                 env_name: "SAUCE_USERNAME",
                                 description: "Your sauce labs username in order to authenticate upload requests",
                                 default_value: Actions.lane_context[SharedValues::SAUCE_USERNAME],
                                 optional: false,
                                 type: String,
                                 verify_block: proc do |value|
                                   UI.user_error!(@messages['sauce_username_error']) unless value && !value.empty?
                                 end),
    FastlaneCore::ConfigItem.new(key: :sauce_access_key,
                                 env_name: "SAUCE_ACCESS_KEY",
                                 description: "Your sauce labs access key in order to authenticate upload requests",
                                 default_value: Actions.lane_context[SharedValues::SAUCE_ACCESS_KEY],
                                 optional: false,
                                 type: String,
                                 verify_block: proc do |value|
                                   UI.user_error!(@messages['sauce_api_key_error']) unless value && !value.empty?
                                 end)
  ]
end

.category ⇒ Object 



90
91
92
 
# File 'lib/fastlane/plugin/saucectl/actions/sauce_upload_action.rb', line 90

def self.category
  :testing
end

.description ⇒ Object 



22
23
24
 
# File 'lib/fastlane/plugin/saucectl/actions/sauce_upload_action.rb', line 22

def self.description
  "Upload test artifacts to sauce labs storage"
end

.details ⇒ Object 



26
27
28
 
# File 'lib/fastlane/plugin/saucectl/actions/sauce_upload_action.rb', line 26

def self.details
  "Upload test artifacts to sauce labs storage"
end

.example_code ⇒ Object 



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
 
# File 'lib/fastlane/plugin/saucectl/actions/sauce_upload_action.rb', line 98

def self.example_code
  [
    "sauce_upload({
              platform: 'android',
              sauce_username: 'username',
              sauce_access_key: 'accessKey',
              app: 'Android.MyCustomApp.apk',
              file: 'app/build/outputs/apk/debug/app-debug.apk',
              region: 'eu'
            })",
    "sauce_upload({
              platform: 'android',
              sauce_username: 'username',
              sauce_access_key: 'accessKey',
              app: 'Android.MyCustomApp.apk',
              file: 'app/build/outputs/apk/debug/app-debug.apk',
              region: 'eu',
              app_description: 'this is a test description'
            })",
    "sauce_upload({
              platform: 'ios',
              sauce_username: 'username',
              sauce_access_key: 'accessKey',
              app: 'MyTestApp.ipa',
              file: 'path/to/my/app/MyTestApp.ipa',
              region: 'eu'
            })"
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


94
95
96
 
# File 'lib/fastlane/plugin/saucectl/actions/sauce_upload_action.rb', line 94

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

.return_value ⇒ Object 



128
129
130
 
# File 'lib/fastlane/plugin/saucectl/actions/sauce_upload_action.rb', line 128

def self.return_value
  "Returns the application id of the app uploaded"
end

.run(params) ⇒ Object 



16
17
18
19
20
 
# File 'lib/fastlane/plugin/saucectl/actions/sauce_upload_action.rb', line 16

def self.run(params)
  response = Fastlane::Saucectl::Api.new(params).upload
  body = JSON.parse(response.body)
  body['item']['id']
end