Class: Fastlane::Actions::EmergeAction

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

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



170
171
172
 
# File 'lib/fastlane/plugin/emerge/actions/emerge_action.rb', line 170

def self.authors
  ["Emerge Tools"]
end

.available_options ⇒ Object 



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
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
 
# File 'lib/fastlane/plugin/emerge/actions/emerge_action.rb', line 183

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :api_token,
                                 env_name: "EMERGE_API_TOKEN",
                                 description: "An API token for Emerge",
                                 optional: false,
                                 type: String),
    FastlaneCore::ConfigItem.new(key: :file_path,
                                 env_name: "EMERGE_FILE_PATH",
                                 description: "Path to the zipped xcarchive or app to upload",
                                 optional: true,
                                 type: String),
    FastlaneCore::ConfigItem.new(key: :linkmaps,
                                 description: "List of paths to linkmaps",
                                 optional: true,
                                 type: Array),
    FastlaneCore::ConfigItem.new(key: :pr_number,
                                 description: "The PR number that triggered this upload",
                                 optional: true,
                                 type: String),
    FastlaneCore::ConfigItem.new(key: :branch,
                                 description: "The current git branch",
                                 optional: true,
                                 type: String),
    FastlaneCore::ConfigItem.new(key: :sha,
                                 description: "The git SHA that triggered this build",
                                 optional: true,
                                 type: String),
    FastlaneCore::ConfigItem.new(key: :base_sha,
                                 description: "The git SHA of the base build",
                                 optional: true,
                                 type: String),
    FastlaneCore::ConfigItem.new(key: :build_id,
                                 description: "A string to identify this build",
                                 deprecated: "Replaced by `sha`",
                                 optional: true,
                                 type: String),
    FastlaneCore::ConfigItem.new(key: :base_build_id,
                                 description: "Id of the build to compare with this upload",
                                 deprecated: "Replaced by `base_sha`",
                                 optional: true,
                                 type: String),
    FastlaneCore::ConfigItem.new(key: :repo_name,
                                 description: "Full name of the respository this upload was triggered from. For example: EmergeTools/Emerge",
                                 optional: true,
                                 type: String),
    FastlaneCore::ConfigItem.new(key: :gitlab_project_id,
                                 description: "Id of the gitlab project this upload was triggered from",
                                 optional: true,
                                 type: Integer),
    FastlaneCore::ConfigItem.new(key: :tag,
                                 description: "String to label the build. Useful for grouping builds together in our dashboard, like development, default, or pull-request",
                                 optional: true,
                                 type: String),
    FastlaneCore::ConfigItem.new(key: :order_file_version,
                                 description: "Version of the order file to download",
                                 optional: true,
                                 type: String),
    FastlaneCore::ConfigItem.new(key: :config_path,
                                 description: "Path to Emerge config path",
                                 optional: true,
                                 type: String)
  ]
end

.copy_config(config_path, tmp_dir) ⇒ Object 



153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/fastlane/plugin/emerge/actions/emerge_action.rb', line 153

def self.copy_config(config_path, tmp_dir)
  return if config_path.nil?

  expanded_path = File.expand_path(config_path)
  unless File.exist?(expanded_path)
    UI.error("No config file found at path '#{expanded_path}'.\nUploading without config file")
    return
  end

  emerge_config_path = "#{tmp_dir}/emerge_config.yaml"
  FileUtils.cp(expanded_path, emerge_config_path)
end

.copy_dsyms(from, to) ⇒ Object 



146
147
148
149
150
151
 
# File 'lib/fastlane/plugin/emerge/actions/emerge_action.rb', line 146

def self.copy_dsyms(from, to)
  Dir.glob(from) do |filename|
    UI.message("Found dSYM: #{Pathname.new(filename).basename}")
    FileUtils.cp_r(filename, to)
  end
end

.description ⇒ Object 



166
167
168
 
# File 'lib/fastlane/plugin/emerge/actions/emerge_action.rb', line 166

def self.description
  "Fastlane plugin for Emerge"
end

.details ⇒ Object 



178
179
180
181
 
# File 'lib/fastlane/plugin/emerge/actions/emerge_action.rb', line 178

def self.details
  # Optional:
  ""
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


248
249
250
251
252
253
254
 
# File 'lib/fastlane/plugin/emerge/actions/emerge_action.rb', line 248

def self.is_supported?(platform)
  # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
  # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
  #
  # [:ios, :mac, :android].include?(platform)
  platform == :ios
end

.return_value ⇒ Object 



174
175
176
 
# File 'lib/fastlane/plugin/emerge/actions/emerge_action.rb', line 174

def self.return_value
  # If your method provides a return value, you can describe here what it does
end

.run(params) ⇒ Object 



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
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
 
# File 'lib/fastlane/plugin/emerge/actions/emerge_action.rb', line 12

def self.run(params)
  api_token = params[:api_token]
  file_path = params[:file_path] || lane_context[SharedValues::XCODEBUILD_ARCHIVE]

  if file_path.nil?
    file_path = Dir.glob("#{lane_context[SharedValues::SCAN_DERIVED_DATA_PATH]}/Build/Products/Debug-iphonesimulator/*.app").first
  end
  pr_number = params[:pr_number]
  branch = params[:branch]
  sha = params[:sha] || params[:build_id]
  base_sha = params[:base_sha] || params[:base_build_id]
  repo_name = params[:repo_name]
  gitlab_project_id = params[:gitlab_project_id]
  tag = params[:tag]
  order_file_version = params[:order_file_version]
  config_path = params[:config_path]

  if file_path.nil? || !File.exist?(file_path)
    UI.error("Invalid input file")
    return
  end

  # If the user provided a .app we will look for dsyms and package it into a zipped xcarchive
  if File.extname(file_path) == '.app'
    absolute_path = Pathname.new(File.expand_path(file_path))
    UI.message("A .app was provided, dSYMs will be looked for in #{absolute_path.dirname}")
    Dir.mktmpdir do |d|
      application_folder = "#{d}/archive.xcarchive/Products/Applications/"
      dsym_folder = "#{d}/archive.xcarchive/dSYMs/"
      FileUtils.mkdir_p(application_folder)
      FileUtils.mkdir_p(dsym_folder)
      if params[:linkmaps] && params[:linkmaps].length > 0
        linkmap_folder = "#{d}/archive.xcarchive/Linkmaps/"
        FileUtils.mkdir_p(linkmap_folder)
        params[:linkmaps].each do |l|
          FileUtils.cp(l, linkmap_folder)
        end
      end
      copy_config(config_path, "#{d}/archive.xcarchive")
      FileUtils.cp_r(file_path, application_folder)
      copy_dsyms("#{absolute_path.dirname}/*.dsym", dsym_folder)
      copy_dsyms("#{absolute_path.dirname}/*/*.dsym", dsym_folder)
      Xcodeproj::Plist.write_to_path({ "NAME" => "Emerge Upload" }, "#{d}/archive.xcarchive/Info.plist")
      file_path = "#{absolute_path.dirname}/archive.xcarchive.zip"
      ZipAction.run(
        path: "#{d}/archive.xcarchive",
        output_path: file_path,
        exclude: [],
        include: []
      )
      UI.message("Archive generated at #{file_path}")
    end
  elsif File.extname(file_path) == '.xcarchive'
    zip_path = file_path + ".zip"
    if params[:linkmaps] && params[:linkmaps].length > 0
      linkmap_folder = "#{file_path}/Linkmaps/"
      FileUtils.mkdir_p(linkmap_folder)
      params[:linkmaps].each do |l|
        FileUtils.cp(l, linkmap_folder)
      end
    end
    copy_config(config_path, file_path)
    Actions::ZipAction.run(
      path: file_path,
      output_path: zip_path,
      exclude: [],
      include: []
    )
    file_path = zip_path
  elsif File.extname(file_path) == '.zip' && params[:linkmaps] && params[:linkmaps].length > 0
    UI.error("Provided zipped archive and linkmaps, linkmaps will not be added to zip.")
  elsif File.extname(file_path) != '.zip'
    UI.error("Invalid input file")
    return
  end

  filename = File.basename(file_path)
  url = 'https://api.emergetools.com/upload'
  params = {
    filename: filename
  }
  if pr_number
    params[:prNumber] = pr_number
  end
  if branch
    params[:branch] = branch
  end
  if sha
    params[:sha] = sha
  end
  if base_sha
    params[:baseSha] = base_sha
  end
  if repo_name
    params[:repoName] = repo_name
  end
  if gitlab_project_id
    params[:gitlabProjectId] = gitlab_project_id
  end
  if order_file_version
    params[:orderFileVersion] = order_file_version
  end
  params[:tag] = tag || "default"
  FastlaneCore::PrintTable.print_values(
    config: params,
    hide_keys: [],
    title: "Summary for Emerge #{Fastlane::Emerge::VERSION}"
  )
  resp = Faraday.post(
    url,
    params.to_json,
    'Content-Type' => 'application/json', 'X-API-Token' => api_token, 'User-Agent' => "fastlane-plugin-emerge/#{Fastlane::Emerge::VERSION}"
  )
  case resp.status
  when 200
    json = JSON.parse(resp.body)
    upload_id = json["upload_id"]
    upload_url = json["uploadURL"]
    warning = json["warning"]
    if warning
      UI.important(warning)
    end
    return Helper::EmergeHelper.perform_upload(upload_url, upload_id, file_path)
  when 403
    UI.error("Invalid API token")
  when 400
    UI.error("Invalid parameters")
    json = JSON.parse(resp.body)
    UI.error("Error: #{json['errorMessage']}")
  else
    UI.error("Upload failed")
  end
end