Ignore device registration errors (#142)

* Supress device registration errors due to invalid UDID or registering Mac device

Author: lpusok

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2021-02-08 17:52:56 +0100 using RuboCop version 0.61.1.
+# on 2021-02-23 11:55:14 +0100 using RuboCop version 0.61.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -16,7 +16,7 @@ Layout/AlignHash:
   Exclude:
     - 'lib/autoprovision/portal/app_client.rb'
 
-# Offense count: 16
+# Offense count: 15
 # Cop supports --auto-correct.
 Layout/EmptyLineAfterGuardClause:
   Exclude:
@@ -25,7 +25,6 @@ Layout/EmptyLineAfterGuardClause:
     - 'lib/autoprovision/device.rb'
     - 'lib/autoprovision/portal/app_client.rb'
     - 'lib/autoprovision/portal/common.rb'
-    - 'lib/autoprovision/portal/device_client.rb'
     - 'lib/autoprovision/project_helper.rb'
     - 'log/log.rb'
     - 'params.rb'
@@ -56,11 +55,11 @@ Layout/TrailingBlankLines:
 Metrics/AbcSize:
   Max: 65
 
-# Offense count: 1
+# Offense count: 2
 # Configuration parameters: CountComments, ExcludedMethods.
 # ExcludedMethods: refine
 Metrics/BlockLength:
-  Max: 28
+  Max: 32
 
 # Offense count: 4
 # Configuration parameters: CountComments.
@@ -81,7 +80,7 @@ Metrics/MethodLength:
 Metrics/ParameterLists:
   Max: 8
 
-# Offense count: 14
+# Offense count: 13
 Metrics/PerceivedComplexity:
   Max: 22
 
@@ -124,7 +123,7 @@ Style/StringLiterals:
   Exclude:
     - 'main.rb'
 
-# Offense count: 231
+# Offense count: 234
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:

lib/autoprovision/portal/device_client.rb

@@ -7,7 +7,7 @@ module Portal
   class DeviceClient
     def self.ensure_test_devices(test_devices, device_client = Spaceship::Portal.device)
       if test_devices.to_a.empty?
-        Log.success('no test devices registered on bitrise')
+        Log.success('No test devices registered on Bitrise.')
         return
       end
 
@@ -26,6 +26,7 @@ def self.ensure_test_devices(test_devices, device_client = Spaceship::Portal.dev
       portal_devices = fetch_devices(device_client)
 
       new_device_registered = false
+      valid_devices = []
       test_devices.each do |test_device|
         registered_test_device = nil
 
@@ -43,20 +44,22 @@ def self.ensure_test_devices(test_devices, device_client = Spaceship::Portal.dev
             registered_test_device = device_client.create!(name: test_device.name, udid: test_device.udid)
           rescue Spaceship::Client::UnexpectedResponse => ex
             message = result_string(ex)
-            raise ex unless message
-            raise message
+            Log.warn("Failed to register device with name: #{test_device.name} udid: #{test_device.udid} error: #{message}")
+            next
           rescue
-            raise "Failed to register device with name: #{test_device.name} udid: #{test_device.udid}"
+            Log.warn("Failed to register device with name: #{test_device.name} udid: #{test_device.udid}")
+            next
           end
 
           Log.success("registering test device #{registered_test_device.name} (#{registered_test_device.udid})")
         end
 
+        valid_devices = valid_devices.append(test_device)
         raise 'failed to find or create device' unless registered_test_device
       end
 
-      Log.success("every test devices (#{test_devices.length}) registered on bitrise are registered on developer portal")
-      [new_device_registered, portal_devices]
+      Log.success("#{valid_devices.length} Bitrise test devices are present on Apple Developer Portal.")
+      valid_devices
     end
 
     def self.fetch_devices(device_client = Spaceship::Portal.device)

spec/device_client_spec.rb

@@ -17,6 +17,31 @@
     allow(fake_portal_client).to receive(:all).and_return(nil)
     allow(fake_portal_client).to receive(:create!).and_return(fake_portal_device)
 
-    Portal::DeviceClient.ensure_test_devices([device], fake_portal_client)
+    valid_devices = Portal::DeviceClient.ensure_test_devices([device], fake_portal_client)
+
+    expect(valid_devices).to eq([device])
+  end
+
+  it 'supresses error due to invalid od mac device UDID' do
+    existing_device = Device.new(
+      'device_identifier' => '123456',
+      'title' => 'Existing Device'
+    )
+    invalid_device = Device.new(
+      'device_identifier' => 'invalid-udid',
+      'title' => 'Invalid Device'
+    )
+
+    fake_portal_device = double
+    allow(fake_portal_device).to receive(:name).and_return(existing_device.name)
+    allow(fake_portal_device).to receive(:udid).and_return(existing_device.udid)
+
+    fake_portal_client = double
+    allow(fake_portal_client).to receive(:all).and_return([fake_portal_device])
+    allow(fake_portal_client).to receive(:create!).and_raise('error')
+
+    valid_devices = Portal::DeviceClient.ensure_test_devices([existing_device, invalid_device], fake_portal_client)
+
+    expect(valid_devices).to eq([existing_device])
   end
 end

step.rb

@@ -77,17 +77,18 @@
   ###
 
   # Ensure test devices
+  valid_devices = []
   if ['development', 'ad-hoc'].include?(params.distribution_type)
     Log.info('Ensure test devices on Developer Portal')
-    Portal::DeviceClient.ensure_test_devices(auth.test_devices)
+    valid_devices = Portal::DeviceClient.ensure_test_devices(auth.test_devices)
   end
   ###
 
   # Ensure Provisioning Profiles on Developer Portal
   Log.info('Ensure Provisioning Profiles on Developer Portal')
 
   profile_helper = ProfileHelper.new(project_helper, cert_helper)
-  xcode_managed_signing = profile_helper.ensure_profiles(params.distribution_type, auth.test_devices, params.generate_profiles == 'yes', params.min_profile_days_valid)
+  xcode_managed_signing = profile_helper.ensure_profiles(params.distribution_type, valid_devices, params.generate_profiles == 'yes', params.min_profile_days_valid)
   ###
 
   unless xcode_managed_signing