hive-runner-ios 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 21392f8328f698d89ed6fc4a48fa7b136b7cba6e
+  data.tar.gz: 1e9121c47f1317f7e2c2da79ecac0bc23a2c1208
+SHA512:
+  metadata.gz: 21656ea02cab268e6eb98b20707639c67c87f7086ab5a303d3272d56046f2539e5fecfb5a9387615493f9a47a04a047ddbfe451077916ef3438d3ec762b5646e
+  data.tar.gz: 1d70d6e1c672a0bdedcb3355dc1459c076452d1e62fc90ae98dfdf1835b63bf09e643ac7576ed133e22ce1327eb16fb62beb3d802992be6602d14031be64f98c

data/README.md

@@ -0,0 +1,19 @@
+# hive-runner-ios
+
+iOS component for the hive-runner
+
+## Quick start
+
+Install the hive-runner and setup your hive as described in the [hive-runner Readme](https://github.com/bbc/hive-runner/blob/master/README.md).
+
+When presented with the option of adding a module, do so and enter 'ios' as the module name, select yes to retrieve from Github and enter BBC as the account name.
+
+## Configuration file
+
+The configuration file allows you to specify the Development Team, Provisioning Certificate, Signing Identity and Bundle ID to use when testing your app, please change these as appropriate:
+
+    ios:
+      provisioning_cert: iOS Team Provisioning Profile: *
+      development_team:  DEVELOPMENT_TEAM_ID
+      signing_identity:  iPhone Developer
+      bundle_id:         TEST_APP

data/lib/hive/controller/ios.rb

@@ -0,0 +1,171 @@
+require 'hive/controller'
+require 'hive/worker/ios'
+require 'device_api/ios'
+
+module Hive
+  class Controller
+    class Ios < Controller
+
+      def detect
+        Hive.logger.debug("#{Time.now} Polling hive: #{Hive.id}")
+        Hive.devicedb('Hive').poll(Hive.id)
+        Hive.logger.debug("#{Time.now} Finished polling hive: #{Hive.id}")
+        devices = DeviceAPI::IOS.devices
+
+        Hive.logger.debug('No devices attached') if devices.empty?
+        Hive.logger.debug("#{Time.now} Retrieving hive details")
+        hive_details = Hive.devicedb('Hive').find(Hive.id)
+        Hive.logger.debug("#{Time.now} Finished retrieving hive details")
+
+        unless hive_details.key?('devices')
+          Hive.logger.debug('Could not connect to DeviceDB at this time')
+          return []
+        end
+
+        unless hive_details['devices'].empty?
+          hive_details['devices'].select {|a| a['os'] == 'ios'}.each do |device|
+            registered_device = devices.select { |a| a.serial == device['serial'] }
+            if registered_device.empty?
+              # A previously registered device isn't attached
+              Hive.logger.debug("Removing previously registered device - #{device}")
+              Hive.devicedb('Device').hive_disconnect(device['id'])
+            else
+              # A previously registered device is attached, poll it
+              Hive.logger.debug("#{Time.now} Polling attached device - #{device}")
+              Hive.devicedb('Device').poll(device['id'])
+              Hive.logger.debug("#{Time.now} Finished polling device - #{device}")
+
+              populate_queues(device)
+              devices = devices - registered_device
+            end
+          end
+        end
+
+        display_untrusted(devices)
+        display_devices
+
+        if hive_details.key?('devices')
+          hive_details['devices'].select {|a| a['os'] == 'ios'}.collect do |device|
+            object = Object
+            @device_class.split('::').each { |sub| object = object.const_get(sub) }
+            object.new(@config.merge(device))
+          end
+        else
+          []
+        end
+      end
+
+      def display_untrusted(devices)
+        untrusted_devices = []
+        # We will now have a list of devices that haven't previously been added
+        devices.each do |device|
+          begin
+            if !device.trusted?
+              untrusted_devices << device.serial
+              next
+            end
+
+            register_new_device(device)
+          end
+        end
+
+        if !untrusted_devices.empty?
+          puts Terminal::Table.new headings: ['Untrusted Devices'], rows: [untrusted_devices]
+        end
+      end
+
+      def display_devices
+        rows = []
+
+        hive_details = Hive.devicedb('Hive').find(Hive.id)
+        if hive_details.key?('devices')
+          unless hive_details['devices'].empty?
+            rows = hive_details['devices'].map do |device|
+              [
+                  "#{device['device_brand']} #{device['device_model']}",
+                  device['serial'],
+                  (device['device_queues'].map { |queue| queue['name']}).join("\n"),
+                  device['status']
+              ]
+            end
+          end
+        end
+        table = Terminal::Table.new :headings => ['Device', 'Serial', 'Queue Name', 'Status'], :rows => rows
+
+        puts(table)
+      end
+
+      def register_new_device(device)
+        Hive.logger.debug("Found iOS device: #{device.model}")
+
+        attributes = {
+            os:           'ios',
+            os_version:   device.version,
+            serial:       device.serial,
+            device_type:  device.type,
+            device_model: device.model.to_s.gsub(',','_'),
+            device_range: device.device_class,
+            device_brand: 'Apple',
+            hive:         Hive.id
+        }
+
+        registration = Hive.devicedb('Device').register(attributes)
+        Hive.devicedb('Device').hive_connect(registration['id'], Hive.id)
+      end
+
+      def populate_queues(device)
+        queues = calculate_queue_names(device)
+
+        devicedb_queues = device['device_queues'].map { |d| d['name'] }
+        # Check to see if the queues have already been registered with this device
+        missing_queues = (queues - devicedb_queues) + (devicedb_queues - queues)
+        return if missing_queues.empty?
+
+        queues << missing_queues
+
+        queue_ids = queues.flatten.uniq.map { |queue| find_or_create_queue(queue) }
+
+        values = {
+            name: device['name'],
+            hive_id: device['hive_id'],
+            feature_list: device['features'],
+            device_queue_ids: queue_ids
+        }
+
+        Hive.devicedb('Device').edit(device['id'], values)
+      end
+
+      def find_or_create_queue(name)
+        queue = Hive.devicedb('Queue').find_by_name(name)
+        return queue.first['id'] unless queue.empty?
+
+        create_queue(name, "#{name} queue created by Hive Runner")['id']
+      end
+
+      def create_queue(name, description)
+        queue_attributes = {
+            name: name,
+            description: description
+        }
+
+        Hive.devicedb('Queue').register(device_queue: queue_attributes )
+      end
+
+      def calculate_queue_names(device)
+
+        queues = [
+            device['device_model'],
+            device['os'],
+            "#{device['os']}-#{device['os_version']}",
+            "#{device['os']}-#{device['os_version']}-#{device['device_model']}",
+            device['device_type'],
+            "#{device['os']}-#{device['device_type']}"
+        ]
+
+        queues << device["features"] unless device["features"].empty?
+
+        queues.flatten
+      end
+    end
+  end
+end

data/lib/hive/device/ios.rb

@@ -0,0 +1,12 @@
+require 'hive/device'
+
+module Hive
+  class Device
+    class Ios < Device
+      def initialize(config)
+        @identity = config['id']
+        super
+      end
+    end
+  end
+end

data/lib/hive/messages/ios_job.rb

@@ -0,0 +1,11 @@
+require 'hive/messages'
+
+module Hive
+  module Messages
+    class IosJob < Hive::Messages::Job
+      def build
+        self.target.symbolize_keys[:build]
+      end
+    end
+  end
+end

data/lib/hive/worker/ios.rb

@@ -0,0 +1,125 @@
+require 'hive/worker'
+require 'hive/messages/ios_job'
+require 'fruity_builder'
+
+module Hive
+  class PortReserver
+    attr_accessor :ports
+    def initialize
+      self.ports = {}
+    end
+
+    def reserve(queue_name)
+      self.ports[queue_name] = yield
+      self.ports[queue_name]
+    end
+  end
+
+  class Worker
+    class Ios < Worker
+
+      attr_accessor :device
+
+      def initialize(device)
+        @worker_ports = PortReserver.new
+        self.device = device
+        super(device)
+      end
+
+      def alter_project(project_path)
+        dev_team              = @options['development_team']      || ''
+        signing_identity      = @options['signing_identity']      || ''
+        provisioning_profile  = @options['provisioning_profile']  || ''
+
+        helper = FruityBuilder::IOS::Helper.new(project_path)
+
+        helper.build.replace_bundle_id(@options['bundle_id'])
+
+        helper.build.replace_dev_team(dev_team)
+        helper.build.replace_code_sign_identity(signing_identity)
+        helper.build.replace_provisioning_profile(provisioning_profile)
+        helper.build.save_project_properties
+      end
+
+      def replace_project_data(options = {})
+        regex = Regexp.new(options[:regex])
+        replacements = options[:data].scan(regex).uniq.flatten
+
+        result = options[:data]
+        replacements.each do |to_replace|
+          result = result.gsub(to_replace, options[:new_value])
+        end
+
+        result
+      end
+
+      def pre_script(job, file_system, script)
+        Hive.devicedb('Device').poll(@options['id'], 'busy')
+
+        if job.build
+          FileUtils.mkdir(file_system.home_path + '/build')
+          app_path = file_system.home_path + '/build/' + 'build.ipa'
+
+          file_system.fetch_build(job.build, app_path)
+          app_info = DeviceAPI::IOS::Plistutil.get_bundle_id_from_app(app_path)
+          app_bundle = app_info['CFBundleIdentifier']
+          script.set_env 'BUNDLE_ID', app_bundle
+        else
+          alter_project(file_system.home_path + '/test_code/code/')
+        end
+
+        ip_address = DeviceAPI::IOS::IPAddress.address(self.device['serial'])
+
+        script.set_env 'CHARLES_PROXY_PORT',  @ports.reserve(queue_name: 'Charles')
+
+        # TODO: Allow the scheduler to specify the ports to use
+
+        script.set_env 'APPIUM_PORT',         @worker_ports.reserve(queue_name: 'Appium') { self.allocate_port }
+        script.set_env 'BOOTSTRAP_PORT',      @worker_ports.reserve(queue_name: 'Bootstrap') { self.allocate_port }
+        script.set_env 'CHROMEDRIVER_PORT',   @worker_ports.reserve(queue_name: 'Chromedriver') { self.allocate_port }
+
+        script.set_env 'APP_PATH', app_path
+        script.set_env 'APP_BUNDLE_PATH', app_path
+        script.set_env 'DEVICE_TARGET', self.device['serial']
+        script.set_env 'DEVICE_ENDPOINT', "http://#{ip_address}:37265"
+
+        "#{self.device['serial']} #{@ports.ports['Appium']} #{app_path} #{file_system.results_path}"
+      end
+
+      def job_message_klass
+        Hive::Messages::IosJob
+      end
+
+      def post_script(job, file_system, script)
+        @log.info('Post script')
+        @worker_ports.ports.each do |name, port|
+          self.release_port(port)
+        end
+        set_device_status('idle')
+      end
+
+      def device_status
+        details = Hive.devicedb('Device').find(@options['id'])
+        if details.key?('status')
+          @state = details['status']
+        else
+          @state
+        end
+      end
+
+      def set_device_status(status)
+        @state = status
+        begin
+          details = Hive.devicedb('Device').poll(@options['id'], status)
+          if details.key?('status')
+            @state = details['status']
+          else
+            @state
+          end
+        rescue
+          @state
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: hive-runner-ios
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jon Wilson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: device_api-ios
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: fruity_builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The iOS controller module for Hive Runner
+email: jon.wilson01@bbc.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/hive/controller/ios.rb
+- lib/hive/device/ios.rb
+- lib/hive/messages/ios_job.rb
+- lib/hive/worker/ios.rb
+homepage: https://github.com/bbc/hive-runner-ios
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Hive Runner iOS
+test_files: []