Class: Fastlane::Actions::RegisterDevicesAction

Inherits:
Fastlane::Action show all
Defined in:
lib/fastlane/actions/register_devices.rb

Constant Summary collapse

UDID_REGEXP = 
/^\h{40}$/

Class Method Summary collapse

Methods inherited from Fastlane::Action

action_name, authors, details, output, sh, step_text

Class Method Details

.author ⇒ Object 



92
93
94
 
# File 'lib/fastlane/actions/register_devices.rb', line 92

def self.author
  "lmirosevic"
end

.available_options ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/fastlane/actions/register_devices.rb', line 67

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :devices,
                                 env_name: "FL_REGISTER_DEVICES_DEVICES",
                                 description: "A hash of devices, with the name as key and the UDID as value",
                                 is_string: false,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :devices_file,
                                 env_name: "FL_REGISTER_DEVICES_FILE",
                                 description: "Provide a path to the devices to register",
                                 optional: true,
                                 verify_block: Proc.new do |value|
                                  raise "Could not find file '#{value}'".red unless File.exists?(value)
                                 end),
    FastlaneCore::ConfigItem.new(key: :team_id,
                                 env_name: "FASTLANE_TEAM_ID",
                                 description: "optional: Your team ID",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :username,
                                 env_name: "CUPERTINO_USERNAME",
                                 description: "optional: Your Apple ID ",
                                 default_value: CredentialsManager::AppfileConfig.try_fetch_value(:apple_id)),
  ]
end

.description ⇒ Object 



63
64
65
 
# File 'lib/fastlane/actions/register_devices.rb', line 63

def self.description
  "Registers new devices to the Apple Dev Portal"
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


8
9
10
 
# File 'lib/fastlane/actions/register_devices.rb', line 8

def self.is_supported?(platform)
  platform == :ios
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
 
# File 'lib/fastlane/actions/register_devices.rb', line 12

def self.run(params)
  require 'cupertino/provisioning_portal'
  require 'csv'

  devices       = params[:devices]
  devices_file  = params[:devices_file]
  team_id       = params[:team_id]
  username      = params[:username]

  if devices
    device_objs = devices.map do |k, v|
      raise "Passed invalid UDID: #{v} for device: #{k}".red unless UDID_REGEXP =~ v

      Cupertino::ProvisioningPortal::Device.new(k, v)
    end
  elsif devices_file
    devices_file = CSV.read(File.expand_path(File.join(devices_file)), col_sep: "\t")

    raise 'Please provide a file according to the Apple Sample UDID file (https://devimages.apple.com.edgekey.net/downloads/devices/Multiple-Upload-Samples.zip)'.red unless devices_file.first == ['Device ID', 'Device Name']

    device_objs = devices_file.drop(1).map do |device|
      raise 'Invalid device line, please provide a file according to the Apple Sample UDID file (https://devimages.apple.com.edgekey.net/downloads/devices/Multiple-Upload-Samples.zip)'.red unless device.count == 2
      raise "Passed invalid UDID: #{device[0]} for device: #{device[1]}".red unless UDID_REGEXP =~ device[0]

      Cupertino::ProvisioningPortal::Device.new(device[1], device[0])
    end
  else
    raise 'You must pass either a valid `devices` or `devices_file`. Please check the readme.'.red
  end

  credentials = CredentialsManager::PasswordManager.shared_manager(username)

  agent = Cupertino::ProvisioningPortal::Agent.new
  agent.username = credentials.username
  agent.password = credentials.password
  agent.team_id = team_id if team_id

  Helper.log.info "Fetching list of currently registered devices..."        
  existing_devices = agent.list_devices
  new_devices = device_objs.select{ |device| !existing_devices.map(&:udid).include?(device.udid) } # calculate the diff based on the UDID

  if new_devices.count > 0
    Helper.log.info "Adding new devices..."
    agent.add_devices(*new_devices) rescue raise 'Could not add devices. Please ensure you have passed the correct username/password combination, as well as a valid team_id if a member of multiple teams.'.red

    Helper.log.info "Successfully registered #{new_devices.count} new devices. Total devices now registered: #{existing_devices.count + new_devices.count}!".green
  else
    Helper.log.info "Device list up to date, all #{device_objs.count} devices are already registered. Total devices registed: #{existing_devices.count}.".green
  end
end