Class: Fastlane::Actions::AwsS3Action

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

Class Method Summary collapse

Class Method Details

.author ⇒ Object 



547
548
549
 
# File 'lib/fastlane/plugin/aws_s3/actions/aws_s3_action.rb', line 547

def self.author
  "joshdholtz"
end

.available_options ⇒ Object 



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/fastlane/plugin/aws_s3/actions/aws_s3_action.rb', line 436

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :apk,
                                 env_name: "",
                                 description: ".apk file for the build ",
                                 optional: true,
                                 default_value: Actions.lane_context[SharedValues::GRADLE_APK_OUTPUT_PATH]),
    FastlaneCore::ConfigItem.new(key: :ipa,
                                 env_name: "",
                                 description: ".ipa file for the build ",
                                 optional: true,
                                 default_value: Actions.lane_context[SharedValues::IPA_OUTPUT_PATH]),
    FastlaneCore::ConfigItem.new(key: :dsym,
                                 env_name: "",
                                 description: "zipped .dsym package for the build ",
                                 optional: true,
                                 default_value: Actions.lane_context[SharedValues::DSYM_OUTPUT_PATH]),
    FastlaneCore::ConfigItem.new(key: :upload_metadata,
                                 env_name: "",
                                 description: "Upload relevant metadata for this build",
                                 optional: true,
                                 default_value: true,
                                 is_string: false),
    FastlaneCore::ConfigItem.new(key: :plist_template_path,
                                 env_name: "",
                                 description: "plist template path",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :plist_file_name,
                                 env_name: "",
                                 description: "uploaded plist filename",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :html_template_path,
                                 env_name: "",
                                 description: "html erb template path",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :html_file_name,
                                 env_name: "",
                                 description: "uploaded html filename",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :skip_html_upload,
                                 env_name: "",
                                 description: "skip html upload if true",
                                 optional: true,
                                 default_value: false,
                                 is_string: false),
    FastlaneCore::ConfigItem.new(key: :version_template_path,
                                 env_name: "",
                                 description: "version erb template path",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :version_file_name,
                                 env_name: "",
                                 description: "uploaded version filename",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :access_key,
                                 env_name: "S3_ACCESS_KEY",
                                 description: "AWS Access Key ID ",
                                 optional: true,
                                 default_value: ENV['AWS_ACCESS_KEY_ID']),
    FastlaneCore::ConfigItem.new(key: :secret_access_key,
                                 env_name: "S3_SECRET_ACCESS_KEY",
                                 description: "AWS Secret Access Key ",
                                 optional: true,
                                 default_value: ENV['AWS_SECRET_ACCESS_KEY']),
    FastlaneCore::ConfigItem.new(key: :bucket,
                                 env_name: "S3_BUCKET",
                                 description: "AWS bucket name",
                                 optional: true,
                                 default_value: ENV['AWS_BUCKET_NAME']),
   FastlaneCore::ConfigItem.new(key: :region,
                                 env_name: "S3_REGION",
                                 description: "AWS region (for bucket creation) ",
                                 optional: true,
                                 default_value: ENV['AWS_REGION']),
    FastlaneCore::ConfigItem.new(key: :app_directory,
                                 env_name: "S3_BUCKET_APP_DIRECTORY",
                                 description: "Directory in bucket for the app",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :path,
                                 env_name: "S3_PATH",
                                 description: "S3 'path'. Values from Info.plist will be substituded for keys wrapped in {}  ",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :source,
                                 env_name: "S3_SOURCE",
                                 description: "Optional source directory e.g. ./build ",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :acl,
                                 env_name: "S3_ACL",
                                 description: "Uploaded object permissions e.g public_read (default), private, public_read_write, authenticated_read ",
                                 optional: true,
                                 default_value: "public-read"
                                ),
    FastlaneCore::ConfigItem.new(key: :endpoint,
                                 env_name: "S3_ENDPOINT",
                                 description: "The base endpoint for your S3 bucket",
                                 optional: true,
                                 default_value: nil
                                ),
  ]
end

.description ⇒ Object 



432
433
434
 
# File 'lib/fastlane/plugin/aws_s3/actions/aws_s3_action.rb', line 432

def self.description
  "Generates a plist file and uploads all to AWS S3"
end

.expand_path_with_substitutions_from_ipa_plist(ipa, path) ⇒ Object

NOT a fan of this as this was taken straight from Shenzhen github.com/nomad/shenzhen/blob/986792db5d4d16a80c865a2748ee96ba63644821/lib/shenzhen/plugins/s3.rb#L32

Need to find a way to not use this copied method

AGAIN, I am not happy about this right now. Using this for prototype reasons.



418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/fastlane/plugin/aws_s3/actions/aws_s3_action.rb', line 418

def self.expand_path_with_substitutions_from_ipa_plist(ipa, path)
  substitutions = path.scan(/\{CFBundle[^}]+\}/)
  return path if substitutions.empty?
  info = FastlaneCore::IpaFileAnalyser.fetch_info_plist_file(ipa) or return path

  substitutions.uniq.each do |substitution|
    key = substitution[1...-1]
    value = info[key]
    path.gsub!(Regexp.new(substitution), value) if value
  end

  return path
end

.get_apk_version(apk_file) ⇒ Object 



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/fastlane/plugin/aws_s3/actions/aws_s3_action.rb', line 346

def self.get_apk_version(apk_file)
  require 'apktools/apkxml'

  # Load the XML data
  parser = ApkXml.new(apk_file)
  parser.parse_xml("AndroidManifest.xml", false, true)

  elements = parser.xml_elements

  versionCode = nil
  versionName = nil
  name = nil

  elements.each do |element|
    if element.name == "manifest"
      element.attributes.each do |attr|
        if attr.name == "versionCode"
          versionCode = attr.value
        elsif attr.name == "versionName"
          versionName = attr.value
        end
      end
    elsif element.name == "application"
      element.attributes.each do |attr|
        if attr.name == "label"
          name = attr.value
        end
      end
    end
  end

  if versionCode =~ /^0x[0-9A-Fa-f]+$/ #if is hex
    versionCode = versionCode.to_i(16)
  end

  [versionCode, versionName, name]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


551
552
553
 
# File 'lib/fastlane/plugin/aws_s3/actions/aws_s3_action.rb', line 551

def self.is_supported?(platform)
  platform == :ios || platform == :android
end

.output ⇒ Object 



536
537
538
539
540
541
542
543
544
545
 
# File 'lib/fastlane/plugin/aws_s3/actions/aws_s3_action.rb', line 536

def self.output
  [
    ['S3_IPA_OUTPUT_PATH', 'Direct HTTP link to the uploaded ipa file'],
    ['S3_DSYM_OUTPUT_PATH', 'Direct HTTP link to the uploaded dsym file'],
    ['S3_PLIST_OUTPUT_PATH', 'Direct HTTP link to the uploaded plist file'],
    ['S3_HTML_OUTPUT_PATH', 'Direct HTTP link to the uploaded HTML file'],
    ['S3_VERSION_OUTPUT_PATH', 'Direct HTTP link to the uploaded Version file'],
    ['S3_SOURCE_OUTPUT_PATH', 'Direct HTTP link to the uploaded source ']
  ]
end

.run(config) ⇒ Object 



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
 
# File 'lib/fastlane/plugin/aws_s3/actions/aws_s3_action.rb', line 20

def self.run(config)
  # Calling fetch on config so that default values will be used
  params = {}
  params[:apk] = config[:apk]
  params[:ipa] = config[:ipa]
  params[:dsym] = config[:dsym]
  params[:access_key] = config[:access_key]
  params[:secret_access_key] = config[:secret_access_key]
  params[:bucket] = config[:bucket]
  params[:endpoint] = config[:endpoint]
  params[:region] = config[:region]
  params[:app_directory] = config[:app_directory]
  params[:acl] = config[:acl]
  params[:source] = config[:source]
  params[:path] = config[:path]
  params[:upload_metadata] = config[:upload_metadata]
  params[:plist_template_path] = config[:plist_template_path]
  params[:plist_file_name] = config[:plist_file_name]
  params[:html_template_path] = config[:html_template_path]
  params[:html_file_name] = config[:html_file_name]
  params[:skip_html_upload] = config[:skip_html_upload]
  params[:version_template_path] = config[:version_template_path]
  params[:version_file_name] = config[:version_file_name]

  # Pulling parameters for other uses
  s3_region = params[:region]
  s3_access_key = params[:access_key]
  s3_secret_access_key = params[:secret_access_key]
  s3_bucket = params[:bucket]
  s3_endpoint = params[:endpoint]
  apk_file = params[:apk]
  ipa_file = params[:ipa]
  dsym_file = params[:dsym]
  s3_path = params[:path]
  acl     = params[:acl].to_sym

  UI.user_error!("No S3 access key given, pass using `access_key: 'key'`") unless s3_access_key.to_s.length > 0
  UI.user_error!("No S3 secret access key given, pass using `secret_access_key: 'secret key'`") unless s3_secret_access_key.to_s.length > 0
  UI.user_error!("No S3 bucket given, pass using `bucket: 'bucket'`") unless s3_bucket.to_s.length > 0
  UI.user_error!("No IPA or APK file path given, pass using `ipa: 'ipa path'` or `apk: 'apk path'`") if ipa_file.to_s.length == 0 && apk_file.to_s.length == 0
  UI.user_error!("Please only give IPA path or APK path (not both)") if ipa_file.to_s.length > 0 && apk_file.to_s.length > 0

  require 'aws-sdk'
  Aws.config.update({
    region: s3_region,
    credentials: Aws::Credentials.new(s3_access_key, s3_secret_access_key)
  })

  s3_client = if s3_endpoint
                Aws::S3::Client.new(endpoint: s3_endpoint)
              else
                Aws::S3::Client.new
              end

  upload_ipa(s3_client, params, s3_region, s3_access_key, s3_secret_access_key, s3_bucket, ipa_file, dsym_file, s3_path, acl) if ipa_file.to_s.length > 0
  upload_apk(s3_client, params, s3_region, s3_access_key, s3_secret_access_key, s3_bucket, apk_file, s3_path, acl) if apk_file.to_s.length > 0

  return true
end

.upload_apk(s3_client, params, s3_region, s3_access_key, s3_secret_access_key, s3_bucket, apk_file, s3_path, acl) ⇒ Object 



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
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/fastlane/plugin/aws_s3/actions/aws_s3_action.rb', line 227

def self.upload_apk(s3_client, params, s3_region, s3_access_key, s3_secret_access_key, s3_bucket, apk_file, s3_path, acl)
  version = get_apk_version(apk_file)

  version_code = version[0]
  version_name = version[1]
  title = version[2]

  s3_path = "#{version_code}_#{version_name}/" unless s3_path

  app_directory = params[:app_directory]

  html_template_path = params[:html_template_path]
  html_file_name = params[:html_file_name]
  version_template_path = params[:version_template_path]
  version_file_name = params[:version_file_name]

  url_part = s3_path

  apk_file_basename = File.basename(apk_file)
  apk_file_name = "#{url_part}#{apk_file_basename}"
  apk_file_data = File.open(apk_file, 'rb')

  apk_url = self.upload_file(s3_client, s3_bucket, app_directory, apk_file_name, apk_file_data, acl)

  # Setting action and environment variables
  Actions.lane_context[SharedValues::S3_APK_OUTPUT_PATH] = apk_url
  ENV[SharedValues::S3_APK_OUTPUT_PATH.to_s] = apk_url

  if params[:upload_metadata] == false
    return true
  end

  #####################################
  #
  # html and plist building
  #
  #####################################

  html_file_name ||= "index.html"

  version_file_name ||= "version.json"

  # grabs module
  eth = Fastlane::Helper::AwsS3Helper

  # Creates html from template
  if html_template_path && File.exist?(html_template_path)
    html_template = eth.load_from_path(html_template_path)
  else
    html_template = eth.load("s3_android_html_template")
  end
  html_render = eth.render(html_template, {
    apk_url: apk_url,
    version_code: version_code,
    version_name: version_name,
    title: title
  })

  # Creates version from template
  if version_template_path && File.exist?(version_template_path)
    version_template = eth.load_from_path(version_template_path)
  else
    version_template = eth.load("s3_android_version_template")
  end
  version_render = eth.render(version_template, {
    apk_url: apk_url,
    version_code: version_code,
    version_name: version_name,
    full_version: "#{version_code}_#{version_name}"
  })

  #####################################
  #
  # html and plist uploading
  #
  #####################################
  
  skip_html = params[:skip_html_upload]

  html_url = self.upload_file(s3_client, s3_bucket, app_directory, html_file_name, html_render, acl) unless skip_html
  version_url = self.upload_file(s3_client, s3_bucket, app_directory, version_file_name, version_render, acl)

  Actions.lane_context[SharedValues::S3_HTML_OUTPUT_PATH] = html_url unless skip_html
  ENV[SharedValues::S3_HTML_OUTPUT_PATH.to_s] = html_url unless skip_html

  Actions.lane_context[SharedValues::S3_VERSION_OUTPUT_PATH] = version_url
  ENV[SharedValues::S3_VERSION_OUTPUT_PATH.to_s] = version_url

  self.upload_source(s3_client, params, s3_bucket, params[:source], s3_path, acl)
  
  UI.success("Successfully uploaded apk file to '#{Actions.lane_context[SharedValues::S3_APK_OUTPUT_PATH]}'")
  UI.success("Android app can be downloaded at '#{Actions.lane_context[SharedValues::S3_HTML_OUTPUT_PATH]}'") unless skip_html
end

.upload_file(s3_client, bucket_name, app_directory, file_name, file_data, acl) ⇒ Object 



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/fastlane/plugin/aws_s3/actions/aws_s3_action.rb', line 384

def self.upload_file(s3_client, bucket_name, app_directory, file_name, file_data, acl)

  if app_directory
    file_name = "#{app_directory}/#{file_name}"
  end

  bucket = Aws::S3::Bucket.new(bucket_name, client: s3_client)
  obj = bucket.put_object({
    acl: acl,
    key: file_name,
    body: file_data
  })

  # When you enable versioning on a S3 bucket,
  # writing to an object will create an object version
  # instead of replacing the existing object.
  # http://docs.aws.amazon.com/AWSRubySDK/latest/AWS/S3/ObjectVersion.html
  if obj.kind_of? Aws::S3::ObjectVersion
    obj = obj.object
  end

  # Return public url
  obj.public_url.to_s
end

.upload_ipa(s3_client, params, s3_region, s3_access_key, s3_secret_access_key, s3_bucket, ipa_file, dsym_file, s3_path, acl) ⇒ Object 



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
178
179
180
181
182
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
 
# File 'lib/fastlane/plugin/aws_s3/actions/aws_s3_action.rb', line 80

def self.upload_ipa(s3_client, params, s3_region, s3_access_key, s3_secret_access_key, s3_bucket, ipa_file, dsym_file, s3_path, acl)

  s3_path = "v{CFBundleShortVersionString}_b{CFBundleVersion}/" unless s3_path

  app_directory = params[:app_directory]

  plist_template_path = params[:plist_template_path]
  plist_file_name = params[:plist_file_name]
  html_template_path = params[:html_template_path]
  html_file_name = params[:html_file_name]
  version_template_path = params[:version_template_path]
  version_file_name = params[:version_file_name]

  url_part = self.expand_path_with_substitutions_from_ipa_plist(ipa_file, s3_path)

  ipa_file_basename = File.basename(ipa_file)
  ipa_file_name = "#{url_part}#{ipa_file_basename}"
  ipa_file_data = File.open(ipa_file, 'rb')

  ipa_url = self.upload_file(s3_client, s3_bucket, app_directory, ipa_file_name, ipa_file_data, acl)

  # Setting action and environment variables
  Actions.lane_context[SharedValues::S3_IPA_OUTPUT_PATH] = ipa_url
  ENV[SharedValues::S3_IPA_OUTPUT_PATH.to_s] = ipa_url

  if dsym_file
    dsym_file_basename = File.basename(dsym_file)
    dsym_file_name = "#{url_part}#{dsym_file_basename}"
    dsym_file_data = File.open(dsym_file, 'rb')

    dsym_url = self.upload_file(s3_client, s3_bucket, app_directory, dsym_file_name, dsym_file_data, acl)

    # Setting action and environment variables
    Actions.lane_context[SharedValues::S3_DSYM_OUTPUT_PATH] = dsym_url
    ENV[SharedValues::S3_DSYM_OUTPUT_PATH.to_s] = dsym_url

  end

  if params[:upload_metadata] == false
    return true
  end

  #####################################
  #
  # html and plist building
  #
  #####################################

  # Gets info used for the plist
  info = FastlaneCore::IpaFileAnalyser.fetch_info_plist_file(ipa_file)

  build_num = info['CFBundleVersion']
  bundle_id = info['CFBundleIdentifier']
  bundle_version = info['CFBundleShortVersionString']
  title = CGI.escapeHTML(info['CFBundleName'])
  full_version = "#{bundle_version}.#{build_num}"

  # Creating plist and html names
  plist_file_name ||= "#{url_part}#{URI.escape(title.delete(' '))}.plist"

  html_file_name ||= "index.html"

  version_file_name ||= "version.json"

  # grabs module
  eth = Fastlane::Helper::AwsS3Helper

  # Creates plist from template
  if plist_template_path && File.exist?(plist_template_path)
    plist_template = eth.load_from_path(plist_template_path)
  else
    plist_template = eth.load("s3_ios_plist_template")
  end
  plist_render = eth.render(plist_template, {
    url: ipa_url,
    ipa_url: ipa_url,
    build_num: build_num,
    bundle_id: bundle_id,
    bundle_version: bundle_version,
    title: title
  })

  #####################################
  #
  # plist uploading
  #
  #####################################
  plist_url = self.upload_file(s3_client, s3_bucket, app_directory, plist_file_name, plist_render, acl)

  # Creates html from template
  if html_template_path && File.exist?(html_template_path)
    html_template = eth.load_from_path(html_template_path)
  else
    html_template = eth.load("s3_ios_html_template")
  end
  html_render = eth.render(html_template, {
    url: plist_url,
    plist_url: plist_url,
    ipa_url: ipa_url,
    build_num: build_num,
    bundle_id: bundle_id,
    bundle_version: bundle_version,
    title: title
  })

  # Creates version from template
  if version_template_path && File.exist?(version_template_path)
    version_template = eth.load_from_path(version_template_path)
  else
    version_template = eth.load("s3_ios_version_template")
  end
  version_render = eth.render(version_template, {
    url: plist_url,
    plist_url: plist_url,
    ipa_url: ipa_url,
    build_num: build_num,
    bundle_version: bundle_version,
    full_version: full_version
  })

  #####################################
  #
  # html uploading
  #
  #####################################
  
  skip_html = params[:skip_html_upload]
  
  html_url = self.upload_file(s3_client, s3_bucket, app_directory, html_file_name, html_render, acl) unless skip_html
  version_url = self.upload_file(s3_client, s3_bucket, app_directory, version_file_name, version_render, acl)

  # Setting action and environment variables
  Actions.lane_context[SharedValues::S3_PLIST_OUTPUT_PATH] = plist_url
  ENV[SharedValues::S3_PLIST_OUTPUT_PATH.to_s] = plist_url

  Actions.lane_context[SharedValues::S3_HTML_OUTPUT_PATH] = html_url unless skip_html
  ENV[SharedValues::S3_HTML_OUTPUT_PATH.to_s] = html_url unless skip_html

  Actions.lane_context[SharedValues::S3_VERSION_OUTPUT_PATH] = version_url
  ENV[SharedValues::S3_VERSION_OUTPUT_PATH.to_s] = version_url
  
  self.upload_source(s3_client, params, s3_bucket, params[:source], s3_path, acl)

  UI.success("Successfully uploaded ipa file to '#{Actions.lane_context[SharedValues::S3_IPA_OUTPUT_PATH]}'")
  UI.success("iOS app can be downloaded at '#{Actions.lane_context[SharedValues::S3_HTML_OUTPUT_PATH]}'") unless skip_html
end

.upload_source(s3_client, params, s3_bucket, source_directory, s3_path, acl) ⇒ Object 



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/fastlane/plugin/aws_s3/actions/aws_s3_action.rb', line 321

def self.upload_source(s3_client, params, s3_bucket, source_directory, s3_path, acl)
  if source_directory && File.directory?(source_directory)
    source_directory = File.absolute_path source_directory
    output_file_path = Tempfile.new('aws_s3_source').path
    
    output_file_path = other_action.zip(
      path: source_directory,
      output_path: output_file_path.gsub(/(?<!.zip)$/, ".zip")
    )
    
    s3_path = "#{version_code}_#{version_name}/" unless s3_path
    app_directory = params[:app_directory]
    url_part = s3_path
    zip_file_name = "#{url_part}source.zip"
    
    output_path_data = File.open("#{output_file_path}", 'rb')
    source_url = self.upload_file(s3_client, s3_bucket, app_directory, zip_file_name, output_path_data, acl)
    
    Actions.lane_context[SharedValues::S3_SOURCE_OUTPUT_PATH] = source_url
    ENV[SharedValues::S3_SOURCE_OUTPUT_PATH.to_s] = source_url
    
    UI.success("Source can be downloaded at '#{Actions.lane_context[SharedValues::S3_SOURCE_OUTPUT_PATH]}'")
  end
end