Module: FastlaneCore::Helper

Defined in:
fastlane_core/lib/fastlane_core/helper.rb

Class Method Summary collapse

Class Method Details

.ask_password(message: "Passphrase: ", confirm: nil, confirmation_message: "Type passphrase again: ") ⇒ Object 



469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 469

def self.ask_password(message: "Passphrase: ", confirm: nil, confirmation_message: "Type passphrase again: ")
  raise "This code should only run in interactive mode" unless UI.interactive?

  loop do
    password = UI.password(message)
    if confirm
      password2 = UI.password(confirmation_message)
      if password == password2
        return password
      end
    else
      return password
    end
    UI.error("Your entries do not match. Please try again")
  end
end

.backticks(command, print: true) ⇒ Object

Runs a given command using backticks (‘) and prints them out using the UI.command method



301
302
303
304
305
306
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 301

def self.backticks(command, print: true)
  UI.command(command) if print
  result = `#{command}`
  UI.command_output(result) if print
  return result
end

.buildlog_path ⇒ Object

Logs base directory



119
120
121
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 119

def self.buildlog_path
  return ENV["FL_BUILDLOG_PATH"] || "~/Library/Logs"
end

.bundler? ⇒ boolean

Returns true if executing with bundler (like ‘bundle exec fastlane [action]’).

Returns:

  • (boolean) —

    true if executing with bundler (like ‘bundle exec fastlane [action]’)



29
30
31
32
33
34
35
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 29

def self.bundler?
  # Bundler environment variable
  ['BUNDLE_BIN_PATH', 'BUNDLE_GEMFILE'].each do |current|
    return true if ENV.key?(current)
  end
  return false
end

.ci? ⇒ boolean

Returns true if building in a known CI environment.

Returns:

  • (boolean) —

    true if building in a known CI environment



73
74
75
76
77
78
79
80
81
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 73

def self.ci?
  return true if self.is_circle_ci?

  # Check for Jenkins, Travis CI, ... environment variables
  ['JENKINS_HOME', 'JENKINS_URL', 'TRAVIS', 'CI', 'APPCENTER_BUILD_ID', 'TEAMCITY_VERSION', 'GO_PIPELINE_NAME', 'bamboo_buildKey', 'GITLAB_CI', 'XCS', 'TF_BUILD', 'GITHUB_ACTION', 'GITHUB_ACTIONS', 'BITRISE_IO', 'BUDDY'].each do |current|
    return true if FastlaneCore::Env.truthy?(current)
  end
  return false
end

.colors_disabled? ⇒ Boolean

Do we want to disable the colored output?

Returns:



109
110
111
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 109

def self.colors_disabled?
  FastlaneCore::Env.truthy?("FASTLANE_DISABLE_COLORS") || ENV.key?("NO_COLOR")
end

.contained_fastlane? ⇒ Boolean

Do we run from a bundled fastlane, which contains Ruby and OpenSSL? Usually this means the fastlane directory is ~/.fastlane/bin/ We set this value via the environment variable ‘FASTLANE_SELF_CONTAINED`

Returns:



40
41
42
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 40

def self.contained_fastlane?
  ENV["FASTLANE_SELF_CONTAINED"].to_s == "true" && !self.homebrew?
end

.executable?(cmd_path) ⇒ Boolean

checks if a given path is an executable file

Returns:



382
383
384
385
386
387
388
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 382

def self.executable?(cmd_path)
  if !cmd_path || File.directory?(cmd_path)
    return false
  end

  return File.exist?(get_executable_path(cmd_path))
end

.fastlane_enabled? ⇒ Boolean

fastlane

Returns:



15
16
17
18
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 15

def self.fastlane_enabled?
  # This is called from the root context on the first start
  !FastlaneCore::FastlaneFolder.path.nil?
end

.fastlane_enabled_folder_path ⇒ Object

Checks if fastlane is enabled for this project and returns the folder where the configuration lives



21
22
23
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 21

def self.fastlane_enabled_folder_path
  fastlane_enabled? ? FastlaneCore::FastlaneFolder.path : '.'
end

.gem_path(gem_name) ⇒ Object

DEPRECATED: Use the ‘ROOT` constant from the appropriate tool module instead e.g. File.join(Sigh::ROOT, ’lib’, ‘assets’, ‘resign.sh’)

Path to the installed gem to load resources (e.g. resign.sh)



452
453
454
455
456
457
458
459
460
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 452

def self.gem_path(gem_name)
  UI.deprecated('`Helper.gem_path` is deprecated. Use the `ROOT` constant from the appropriate tool module instead.')

  if !Helper.test? && Gem::Specification.find_all_by_name(gem_name).any?
    return Gem::Specification.find_by_name(gem_name).gem_dir
  else
    return './'
  end
end

.get_executable_path(cmd_path) ⇒ Object

returns the path of the executable with the correct extension on Windows



391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 391

def self.get_executable_path(cmd_path)
  cmd_path = localize_file_path(cmd_path)

  if self.windows?
    # PATHEXT contains the list of file extensions that Windows considers executable, semicolon separated.
    # e.g. ".COM;.EXE;.BAT;.CMD"
    exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : []

    # no executable files on Windows, so existing is enough there
    # also check if command + ext is present
    exts.each do |ext|
      executable_path = "#{cmd_path}#{ext.downcase}"
      return executable_path if File.exist?(executable_path)
    end
  end

  return cmd_path
end

.hide_loading_indicator ⇒ Object 



372
373
374
375
376
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 372

def self.hide_loading_indicator
  if self.should_show_loading_indicator? && @require_fastlane_spinner
    @require_fastlane_spinner.success
  end
end

.homebrew? ⇒ Boolean

returns true if fastlane was installed via Homebrew

Returns:



50
51
52
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 50

def self.homebrew?
  ENV["FASTLANE_INSTALLED_VIA_HOMEBREW"].to_s == "true"
end

.is_ci? ⇒ Boolean

Returns:



436
437
438
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 436

def self.is_ci?
  ci?
end

.is_circle_ci? ⇒ Boolean

Returns:



83
84
85
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 83

def self.is_circle_ci?
  return ENV.key?('CIRCLECI')
end

.is_mac? ⇒ Boolean

Returns:



440
441
442
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 440

def self.is_mac?
  self.mac?
end

.is_test? ⇒ Boolean

Use Helper.test?, Helper.ci?, Helper.mac? or Helper.windows? instead (legacy calls)

Returns:



432
433
434
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 432

def self.is_test?
  self.test?
end

.is_windows? ⇒ Boolean

Returns:



444
445
446
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 444

def self.is_windows?
  self.windows?
end

.itms_path ⇒ Object

Returns the full path to the iTMSTransporter executable.

Returns:

  • the full path to the iTMSTransporter executable



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
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 227

def self.itms_path
  return self.user_defined_itms_path if FastlaneCore::Env.truthy?("FASTLANE_ITUNES_TRANSPORTER_PATH")

  if self.mac?
    # First check for manually install iTMSTransporter
    user_local_itms_path = "/usr/local/itms"
    return user_local_itms_path if File.exist?(user_local_itms_path)

    # Then check for iTMSTransporter in the Xcode path
    [
      "../Applications/Application Loader.app/Contents/MacOS/itms",
      "../Applications/Application Loader.app/Contents/itms",
      "../SharedFrameworks/ContentDeliveryServices.framework/Versions/A/itms" # For Xcode 11
    ].each do |path|
      result = File.expand_path(File.join(self.xcode_path, path))
      return result if File.exist?(result)
    end
    UI.user_error!("Could not find transporter at #{self.xcode_path}. Please make sure you set the correct path to your Xcode installation.")
  elsif self.windows?
    [
      "C:/Program Files (x86)/itms"
    ].each do |path|
      return path if File.exist?(path)
    end
    UI.user_error!("Could not find transporter at usual locations. Please use environment variable `FASTLANE_ITUNES_TRANSPORTER_PATH` to specify your installation path.")
  else
    # not Mac or Windows
    return ''
  end
end

.json_file?(filename) ⇒ Boolean

checks if given file is a valid json file base taken from: stackoverflow.com/a/26235831/1945875

Returns:



418
419
420
421
422
423
424
425
426
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 418

def self.json_file?(filename)
  return false unless File.exist?(filename)
  begin
    JSON.parse(File.read(filename))
    return true
  rescue JSON::ParserError
    return false
  end
end

.keychain_path(keychain_name) ⇒ Object

keychain



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
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 261

def self.keychain_path(keychain_name)
  # Existing code expects that a keychain name will be expanded into a default path to Library/Keychains
  # in the user's home directory. However, this will not allow the user to pass an absolute path
  # for the keychain value
  #
  # So, if the passed value can't be resolved as a file in Library/Keychains, just use it as-is
  # as the keychain path.
  #
  # We need to expand each path because File.exist? won't handle directories including ~ properly
  #
  # We also try to append `-db` at the end of the file path, as with Sierra the default Keychain name
  # has changed for some users: https://github.com/fastlane/fastlane/issues/5649

  # Remove the ".keychain" at the end of the keychain name
  name = keychain_name.sub(/\.keychain$/, "")

  possible_locations = [
    File.join(Dir.home, 'Library', 'Keychains', name),
    name
  ].map { |path| File.expand_path(path) }

  # Transforms ["thing"] to ["thing-db", "thing.keychain-db", "thing", "thing.keychain"]
  keychain_paths = []
  possible_locations.each do |location|
    keychain_paths << "#{location}-db"
    keychain_paths << "#{location}.keychain-db"
    keychain_paths << location
    keychain_paths << "#{location}.keychain"
  end

  keychain_path = keychain_paths.find { |path| File.file?(path) }
  UI.user_error!("Could not locate the provided keychain. Tried:\n\t#{keychain_paths.join("\n\t")}") unless keychain_path
  keychain_path
end

.linux? ⇒ Boolean

Returns:



99
100
101
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 99

def self.linux?
  (/linux/ =~ RUBY_PLATFORM) != nil
end

.localize_file_path(path) ⇒ Object

returns the path with the platform-specific path separator (‘/` on UNIX, `` on Windows)



411
412
413
414
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 411

def self.localize_file_path(path)
  # change `/` to `\` on Windows
  return self.windows? ? path.gsub('/', '\\') : path
end

.log ⇒ Object

This method is deprecated, use the ‘UI` class docs.fastlane.tools/advanced/#user-input-and-output



464
465
466
467
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 464

def self.log
  UI.deprecated("Helper.log is deprecated. Use `UI` class instead")
  UI.current.log
end

.mac? ⇒ Boolean

Is the currently running computer a Mac?

Returns:



104
105
106
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 104

def self.mac?
  (/darwin/ =~ RUBY_PLATFORM) != nil
end

.mac_app? ⇒ Boolean

returns true if fastlane was installed from the Fabric Mac app

Returns:



45
46
47
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 45

def self.mac_app?
  ENV["FASTLANE_SELF_CONTAINED"].to_s == "false"
end

.mac_stock_terminal? ⇒ Boolean

Does the user use the Mac stock terminal

Returns:



114
115
116
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 114

def self.mac_stock_terminal?
  FastlaneCore::Env.truthy?("TERM_PROGRAM_VERSION")
end

.open_uri(*rest, &block) ⇒ Object

URI.open added by ‘require ’open-uri’‘ is not available in Ruby 2.4. This helper lets you open a URI by choosing appropriate interface to do so depending on Ruby version. This helper is subject to be removed when fastlane drops Ruby 2.4 support.



489
490
491
492
493
494
495
496
497
498
499
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 489

def self.open_uri(*rest, &block)
  require 'open-uri'

  if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.5')
    dup = rest.dup
    uri = dup.shift
    URI.parse(uri).open(*dup, &block)
  else
    URI.open(*rest, &block)
  end
end

.operating_system ⇒ Object 



87
88
89
90
91
92
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 87

def self.operating_system
  return "macOS" if RUBY_PLATFORM.downcase.include?("darwin")
  return "Windows" if RUBY_PLATFORM.downcase.include?("mswin")
  return "Linux" if RUBY_PLATFORM.downcase.include?("linux")
  return "Unknown"
end

.rubygems? ⇒ Boolean

returns true if fastlane was installed via RubyGems

Returns:



55
56
57
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 55

def self.rubygems?
  !self.bundler? && !self.contained_fastlane? && !self.homebrew? && !self.mac_app?
end

.sh_enabled? ⇒ Boolean

Returns true if it is enabled to execute external commands.

Returns:

  • (Boolean) —

    true if it is enabled to execute external commands



68
69
70
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 68

def self.sh_enabled?
  !self.test? || ENV["FORCE_SH_DURING_TESTS"]
end

.should_show_loading_indicator? ⇒ Boolean

loading indicator

Returns:



353
354
355
356
357
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 353

def self.should_show_loading_indicator?
  return false if FastlaneCore::Env.truthy?("FASTLANE_DISABLE_ANIMATION")
  return false if Helper.ci?
  return true
end

.show_loading_indicator(text = nil) ⇒ Object

Show/Hide loading indicator



360
361
362
363
364
365
366
367
368
369
370
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 360

def self.show_loading_indicator(text = nil)
  if self.should_show_loading_indicator?
    # we set the default here, instead of at the parameters
    # as we don't want to `UI.message` a rocket that's just there for the loading indicator
    text ||= "🚀"
    @require_fastlane_spinner = TTY::Spinner.new("[:spinner] #{text} ", format: :dots)
    @require_fastlane_spinner.auto_spin
  else
    UI.message(text) if text
  end
end

.strip_ansi_colors(str) ⇒ Object

removes ANSI colors from string



309
310
311
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 309

def self.strip_ansi_colors(str)
  str.gsub(/\e\[([;\d]+)?m/, '')
end

.swift_version ⇒ Object

Returns Swift version.

Returns:

  • Swift version



181
182
183
184
185
186
187
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 181

def self.swift_version
  if system("which swift > /dev/null 2>&1")
    output = `swift --version`
    return output.split("\n").first.match(/version ([0-9.]+)/).captures.first
  end
  return nil
end

.test? ⇒ Boolean

Returns true if the currently running program is a unit test.

Returns:

  • (Boolean) —

    true if the currently running program is a unit test



63
64
65
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 63

def self.test?
  Object.const_defined?("SpecHelper")
end

.transporter_java_executable_path ⇒ Object

iTMSTransporter



192
193
194
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 192

def self.transporter_java_executable_path
  return File.join(self.transporter_java_path, 'bin', 'java')
end

.transporter_java_ext_dir ⇒ Object 



196
197
198
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 196

def self.transporter_java_ext_dir
  return File.join(self.transporter_java_path, 'lib', 'ext')
end

.transporter_java_jar_path ⇒ Object 



200
201
202
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 200

def self.transporter_java_jar_path
  return File.join(self.itms_path, 'lib', 'itmstransporter-launcher.jar')
end

.transporter_java_path ⇒ Object 



208
209
210
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 208

def self.transporter_java_path
  return File.join(self.itms_path, 'java')
end

.transporter_path ⇒ Object

Returns the full path to the iTMSTransporter executable.

Returns:

  • the full path to the iTMSTransporter executable



213
214
215
216
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 213

def self.transporter_path
  return File.join(self.itms_path, 'bin', 'iTMSTransporter') unless Helper.windows?
  return File.join(self.itms_path, 'iTMSTransporter')
end

.transporter_user_dir ⇒ Object 



204
205
206
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 204

def self.transporter_user_dir
  return File.join(self.itms_path, 'bin')
end

.user_defined_itms_path ⇒ Object 



222
223
224
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 222

def self.user_defined_itms_path
  return ENV["FASTLANE_ITUNES_TRANSPORTER_PATH"] if self.user_defined_itms_path?
end

.user_defined_itms_path? ⇒ Boolean

Returns:



218
219
220
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 218

def self.user_defined_itms_path?
  return FastlaneCore::Env.truthy?("FASTLANE_ITUNES_TRANSPORTER_PATH")
end

.windows? ⇒ Boolean

Returns:



94
95
96
97
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 94

def self.windows?
  # taken from: https://stackoverflow.com/a/171011/1945875
  (/cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM) != nil
end

.with_env_values(hash, &block) ⇒ Object

Executes the provided block after adjusting the ENV to have the provided keys and values set as defined in hash. After the block completes, restores the ENV to its previous state.



337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 337

def self.with_env_values(hash, &block)
  old_vals = ENV.select { |k, v| hash.include?(k) }
  hash.each do |k, v|
    ENV[k] = hash[k]
  end
  yield
ensure
  hash.each do |k, v|
    ENV.delete(k) unless old_vals.include?(k)
    ENV[k] = old_vals[k]
  end
end

.xcode_at_least?(version) ⇒ Boolean

Returns true if installed Xcode version is ‘greater than or equal to’ the input parameter version.

Returns:

  • (Boolean) —

    true if installed Xcode version is ‘greater than or equal to’ the input parameter version



171
172
173
174
175
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 171

def self.xcode_at_least?(version)
  installed_xcode_version = xcode_version
  UI.user_error!("Unable to locate Xcode. Please make sure to have Xcode installed on your machine") if installed_xcode_version.nil?
  Gem::Version.new(installed_xcode_version) >= Gem::Version.new(version)
end

.xcode_path ⇒ Object

Returns the full path to the Xcode developer tools of the currently running system.

Returns:

  • the full path to the Xcode developer tools of the currently running system



128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 128

def self.xcode_path
  return "" unless self.mac?

  if self.xcode_server?
    # Xcode server always creates a link here
    xcode_server_xcode_path = "/Library/Developer/XcodeServer/CurrentXcodeSymlink/Contents/Developer"
    UI.verbose("We're running as XcodeServer, setting path to #{xcode_server_xcode_path}")
    return xcode_server_xcode_path
  end

  return `xcode-select -p`.delete("\n") + "/"
end

.xcode_server? ⇒ Boolean

Returns:



141
142
143
144
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 141

def self.xcode_server?
  # XCS is set by Xcode Server
  return ENV["XCS"].to_i == 1
end

.xcode_version ⇒ Object

Returns The version of the currently used Xcode installation (e.g. “7.0”).

Returns:

  • The version of the currently used Xcode installation (e.g. “7.0”)



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 147

def self.xcode_version
  return nil unless self.mac?
  return @xcode_version if @xcode_version && @developer_dir == ENV['DEVELOPER_DIR']

  xcodebuild_path = "#{xcode_path}/usr/bin/xcodebuild"

  xcode_build_installed = File.exist?(xcodebuild_path)
  unless xcode_build_installed
    UI.verbose("Couldn't find xcodebuild at #{xcodebuild_path}, check that it exists")
    return nil
  end

  begin
    output = `DEVELOPER_DIR='' "#{xcodebuild_path}" -version`
    @xcode_version = output.split("\n").first.split(' ')[1]
    @developer_dir = ENV['DEVELOPER_DIR']
  rescue => ex
    UI.error(ex)
    UI.user_error!("Error detecting currently used Xcode installation, please ensure that you have Xcode installed and set it using `sudo xcode-select -s [path]`")
  end
  @xcode_version
end

.zip_directory(path, output_path, contents_only: false, overwrite: false, print: true) ⇒ Object

Zips directory



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'fastlane_core/lib/fastlane_core/helper.rb', line 314

def self.zip_directory(path, output_path, contents_only: false, overwrite: false, print: true)
  if overwrite
    overwrite_command = " && rm -f '#{output_path}'"
  else
    overwrite_command = ""
  end

  if contents_only
    command = "cd '#{path}'#{overwrite_command} && zip -r '#{output_path}' *"
  else
    containing_path = File.expand_path("..", path)
    contents_path = File.basename(path)

    command = "cd '#{containing_path}'#{overwrite_command} && zip -r '#{output_path}' '#{contents_path}'"
  end

  UI.command(command) unless print
  Helper.backticks(command, print: print)
end