Class: Fastlane::Actions::UploadToTpaAction

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

Direct Known Subclasses

TpaAction

Documentation collapse

Class Method Summary collapse

Class Method Details

.app_file(params) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/fastlane/plugin/tpa/actions/upload_to_tpa_action.rb', line 44

def self.app_file(params)
  app_file = [
    params[:ipa],
    params[:apk],
    params[:aab]
  ].detect { |e| !e.to_s.empty? }

  if app_file.nil?
    UI.user_error!("You have to provide a build file")
  end

  app_file
end

.authors ⇒ Object 



206
207
208
 
# File 'lib/fastlane/plugin/tpa/actions/upload_to_tpa_action.rb', line 206

def self.authors
  ["mbogh", "Stefan Veis Pennerup", "madsbogeskov"]
end

.available_options ⇒ Object 



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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/fastlane/plugin/tpa/actions/upload_to_tpa_action.rb', line 134

def self.available_options
  Fastlane::Helper::TpaHelper.shared_available_options + [
    FastlaneCore::ConfigItem.new(key: :ipa,
                                 env_name: "FL_TPA_IPA",
                                 description: "Path to your IPA file. Optional if you use the `gym` or `xcodebuild` action",
                                 default_value: Actions.lane_context[SharedValues::IPA_OUTPUT_PATH],
                                 optional: true,
                                 verify_block: proc do |value|
                                   UI.user_error!("Couldn't find ipa file at path '#{value}'") unless File.exist?(value)
                                 end,
                                 conflicting_options: [:apk, :aab],
                                 conflict_block: proc do |value|
                                   UI.user_error!("You can't use 'ipa' and '#{value.key}' options in one run")
                                 end),
    FastlaneCore::ConfigItem.new(key: :apk,
                                 env_name: "FL_TPA_APK",
                                 description: "Path to your APK file",
                                 default_value: Actions.lane_context[SharedValues::GRADLE_APK_OUTPUT_PATH],
                                 optional: true,
                                 verify_block: proc do |value|
                                   UI.user_error!("Couldn't find apk file at path '#{value}'") unless File.exist?(value)
                                 end,
                                 conflicting_options: [:aab, :ipa],
                                 conflict_block: proc do |value|
                                   UI.user_error!("You can't use 'apk' and '#{value.key}' options in one run")
                                 end),
    FastlaneCore::ConfigItem.new(key: :aab,
                                 env_name: "FL_TPA_AAB",
                                 description: "Path to your AAB file",
                                 default_value: Actions.lane_context[SharedValues::GRADLE_AAB_OUTPUT_PATH],
                                 optional: true,
                                 verify_block: proc do |value|
                                   UI.user_error!("Couldn't find aab file at path '#{value}'") unless File.exist?(value)
                                 end,
                                 conflicting_options: [:apk, :ipa],
                                 conflict_block: proc do |value|
                                   UI.user_error!("You can't use 'aab' and '#{value.key}' options in one run")
                                 end),
    FastlaneCore::ConfigItem.new(key: :mapping,
                                 env_name: "FL_TPA_MAPPING",
                                 description: "Path to your symbols files. For iOS provide path to app.dSYM.zip. For Android provide path to mappings.txt file. For React-Native also provide paths to your source-maps",
                                 default_value: Actions.lane_context[SharedValues::DSYM_OUTPUT_PATH],
                                 optional: true,
                                 is_string: false,
                                 verify_block: proc do |value|
                                   # validation is done in the action
                                 end),
    FastlaneCore::ConfigItem.new(key: :publish,
                                 env_name: "FL_TPA_PUBLISH",
                                 description: "Publish build upon upload",
                                 default_value: true,
                                 is_string: false),
    FastlaneCore::ConfigItem.new(key: :force,
                                 env_name: "FL_TPA_FORCE",
                                 description: "Should a version with the same number already exist, force the new app to take the place of the old one",
                                 default_value: false,
                                 is_string: false),
    FastlaneCore::ConfigItem.new(key: :notes,
                                 env_name: "FL_TPA_NOTES",
                                 description: "Release notes",
                                 optional: true)
  ]
end

.body(params) ⇒ Object 



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
 
# File 'lib/fastlane/plugin/tpa/actions/upload_to_tpa_action.rb', line 68

def self.body(params)
  body = {
    app: File.new(app_file(params), 'rb'),
    notes: params[:notes],
    publish: params[:publish],
    force: params[:force]
  }

  # Only set mapping key if mapping file exists.
  # Even setting a nil value will cause Fastlane to send an empty value causing an error.
  unless params[:mapping].nil?
    case params[:mapping]
    when String
      if File.exist?(params[:mapping])
        body[:mapping] = File.new(params[:mapping], 'rb')
      end
    when Array
      mapping_files = []
      params[:mapping].each do |mapping|
        if File.exist?(mapping)
          mapping_files.push(File.new(mapping, 'rb'))
        else
          UI.message("Unable to find mapping file at #{mapping}")
        end
      end
      unless mapping_files.empty?
        body[:mapping] = mapping_files
      end
    else
      UI.user_error!("Specified mapping files do not exists.")
    end
  end

  body
end

.category ⇒ Object 



220
221
222
 
# File 'lib/fastlane/plugin/tpa/actions/upload_to_tpa_action.rb', line 220

def self.category
  :beta
end

.description ⇒ Object 



121
122
123
 
# File 'lib/fastlane/plugin/tpa/actions/upload_to_tpa_action.rb', line 121

def self.description
  "Upload app builds to The Perfect App (tpa.io)"
end

.details ⇒ Object 



125
126
127
128
129
130
131
132
 
# File 'lib/fastlane/plugin/tpa/actions/upload_to_tpa_action.rb', line 125

def self.details
  [
    "This plugin helps you to easily setup a CI/CD integration with The Perfect App. Simply",
    "install this plugin and add the `tpa` command to your normal building lane. This will guide",
    "you through the necessary parameters to use this plugin, which we recommend setting up as",
    " as environmental to automate the whole process."
  ].join(" ")
end

.example_code ⇒ Object 



214
215
216
217
218
 
# File 'lib/fastlane/plugin/tpa/actions/upload_to_tpa_action.rb', line 214

def self.example_code
  [
    'upload_to_tpa'
  ]
end

.handle_exception_response(ex) ⇒ Object 



104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/fastlane/plugin/tpa/actions/upload_to_tpa_action.rb', line 104

def self.handle_exception_response(ex)
  if Fastlane::Helper::TpaHelper.valid_json?(ex.response)
    res = JSON.parse(ex.response)
    if res.key?("detail")
      UI.abort_with_message!("Something went wrong while uploading your app to TPA: #{res['detail']}")
    else
      UI.abort_with_message!("Something went wrong while uploading your app to TPA: #{res}")
    end
  else
    UI.abort_with_message!("Something went wrong while uploading your app to TPA: #{ex.response}")
  end
end

.headers(params) ⇒ Object 



62
63
64
65
66
 
# File 'lib/fastlane/plugin/tpa/actions/upload_to_tpa_action.rb', line 62

def self.headers(params)
  {
    :"X-API-Key" => params[:api_key]
  }
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


210
211
212
 
# File 'lib/fastlane/plugin/tpa/actions/upload_to_tpa_action.rb', line 210

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

.output ⇒ Object 



198
199
200
 
# File 'lib/fastlane/plugin/tpa/actions/upload_to_tpa_action.rb', line 198

def self.output
  nil
end

.return_value ⇒ Object 



202
203
204
 
# File 'lib/fastlane/plugin/tpa/actions/upload_to_tpa_action.rb', line 202

def self.return_value
  nil
end

.run(params) ⇒ Object 



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/fastlane/plugin/tpa/actions/upload_to_tpa_action.rb', line 11

def self.run(params)
  require 'rest_client'

  upload_url = upload_url(params)
  headers = headers(params)
  body = body(params)

  UI.success("🚀 Uploading app to TPA 🚀")
  UI.important("This might take a few minutes. Please don't interrupt the script. 🚀")

  # Starts the upload
  begin
    response = RestClient.post(upload_url, body, headers)
    if Fastlane::Helper::TpaHelper.valid_json?(response)
      res = JSON.parse(response)
      app_name = res["name"]
      version = res["version_string"]
      build_number = res["version_number"]
      build_url = res["build_url"]
      install_url = res["install_url"]
      Actions.lane_context[SharedValues::TPA_INSTALL_URL] = install_url
      Actions.lane_context[SharedValues::TPA_BUILD_URL] = build_url
      UI.success("🎉 #{app_name} version #{version} (#{build_number}) has successfully been uploaded to TPA 🎉")
    else
      UI.abort_with_message!("Something went wrong while uploading your app to TPA")
    end
  rescue RestClient::ExceptionWithResponse => ex
    handle_exception_response(ex)
  rescue => ex
    UI.abort_with_message!("Something went wrong while uploading your app to TPA: #{ex}")
  end
end

.upload_url(params) ⇒ Object 



58
59
60
 
# File 'lib/fastlane/plugin/tpa/actions/upload_to_tpa_action.rb', line 58

def self.upload_url(params)
  "#{params[:base_url]}/rest/api/v2/projects/#{params[:api_uuid]}/apps/versions/app/"
end