hive-runner-tv 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b6afb887754f6f8863ac063c54724322aeb1ea80
+  data.tar.gz: a3d420f7922168d075b88c4a6b6e34e2055fb735
+SHA512:
+  metadata.gz: 2a2fbaaf867d636638972f7c99c21921a8ec97b1125fea6455bdd9af9ccf8973ca733ebe4c4e936bb9a006367c31509f31b93c22d67eab5c8d117adca6480862
+  data.tar.gz: 3a9526b391be926e1a8d3aa5d4bf7053732ee498c68bdfb1126363ae8eed2a790a7a8a8b1f4374c815a60bb877b45aabec9e78607a4600625bb92b5953432cd5

data/README.md

@@ -0,0 +1,53 @@
+# hive-runner-tv
+TV module for Hive Runner
+
+## Configuration file
+
+```
+controllers:
+  tv:
+    ir_blaster_clients:
+      <devicedb id>:
+        type: <Blaster type, eg rat_blaster>
+        mac: <IR blaster mac address, eg 00-11-22-33-44-55>
+        dataset: <IR blaster dataset name>
+        output: <IP blaster output id>
+        sequences:
+          launch_titantv:
+            - signal:Power
+            - sleep:2
+            - signal:Power
+
+network:
+  remote_talkshow_address: <talkshow url, eg talkshow.remote>
+  remote_talkshow_port_offset: <minimum port number>
+  tv:
+    titantv_url: <eg http://titantv.url/titantv>
+    titantv_name: <Application name reported by Titan TV>
+    ir_blaster_host: <ip address of IR blaster hub, eg, 10.20.30.40>
+    ir_blaster_port: <port number of IR blaster hub>
+
+diagnostics:
+  tv:
+    uptime:
+      reboot_time: <seconds between reboots>
+    dead:
+```
+
+Note, the `ir\_blaster\_clients` section under `controllers` may ultimately
+move to the information provided by the Device Database.
+
+## IR Blaster
+
+To use an IR blaster with `hive-runner` add the line
+
+    gem 'device_api-tv', git: 'git@github.com:bbc/device_api-tv'
+
+to the Hive's Gemfile and add the configuration as shown above.
+
+## License
+
+Hive Runner TV is available to everyone under the terms of the MIT open source licence.
+Take a look at the LICENSE file in the code.
+
+Copyright (c) 2016 BBC

data/lib/hive/controller/tv.rb

@@ -0,0 +1,48 @@
+require 'hive/controller'
+require 'hive/worker/tv'
+
+module Hive
+  class Controller
+    # The TV controller
+    class Tv < Controller
+      @@exclusion = []
+
+      def self.add_exclusion ex
+        @@exclusion << ex
+      end
+
+      def detect
+        Hive.logger.debug("Checking Hive Mind")
+        device_list = Hive.hive_mind.device_details['connected_devices']
+        Hive.logger.debug("Device list: #{device_list}")
+        devices = []
+        if device_list.is_a? Array
+          device_list.select { |d| valid? d }.collect do |device|
+            Hive.logger.debug("Found TV: #{device.inspect}")
+            devices << self.create_device(device)
+          end
+        else
+          raise Hive::Controller::DeviceDetectionFailed
+        end
+        Hive.logger.debug("Devices: #{devices}")
+        devices
+      end
+
+      private
+      def valid? device
+        if device['device_type'] == 'Tv'
+          @@exclusion.each do |ex|
+            match = true
+            ex.each_pair do |key, value|
+              match = match && device[key.to_s] != value
+            end
+            return false if ! match
+          end
+          return true
+        else
+          false
+        end
+      end
+    end
+  end
+end

data/lib/hive/device/tv.rb

@@ -0,0 +1,13 @@
+require 'hive/device'
+
+module Hive
+  class Device
+    # The TV worker
+    class Tv < Device
+      def initialize(config)
+        @identity = config['id']
+        super
+      end
+    end
+  end
+end

data/lib/hive/diagnostic/tv/dead.rb

@@ -0,0 +1,44 @@
+require 'hive/diagnostic'
+
+module Hive
+  class Diagnostic
+    class Tv
+      class Dead < Diagnostic
+        def diagnose
+          status = @device_api.status
+          case status
+          when 'idle'
+            self.pass('Device is idle')
+          else
+            self.fail("Device is #{status}")
+          end
+        end
+
+        def repair(result)
+          tries = [
+            [ :launch_titantv ],
+            [ :power_cycle, :launch_titantv ],
+            [ :power_on, :launch_titantv ]
+          ]
+
+          tries.each do |commands|
+            catch :commands_failed do
+              commands.each do |command|
+                throw :commands_failed if ! @device_api.run_sequence(command)
+              end
+              timeout = Time.now + 600
+              while Time.now < timeout
+                if @device_api.status == 'idle'
+                  return self.pass('Titan TV launched')
+                end
+                sleep 5
+              end
+            end
+          end
+
+          self.fail("Failed to recover device")
+        end
+      end
+    end
+  end
+end

data/lib/hive/diagnostic/tv/uptime.rb

@@ -0,0 +1,31 @@
+require 'hive/diagnostic'
+
+module Hive
+  class Diagnostic
+    class Tv
+      class Uptime < Diagnostic
+        def initialize(config, options)
+          @next_reboot_time = Time.now + config[:reboot_timeout] if config.has_key?(:reboot_timeout)
+          super(config, options)
+        end
+
+        def diagnose
+          if config.has_key?(:reboot_timeout)
+            if Time.now < @next_reboot_time
+              self.pass("Time to next reboot: #{@next_reboot_time - Time.now}s")
+            else
+              self.fail("Reboot required")
+            end
+          else
+            self.pass("Not configured to reboot")
+          end
+        end
+
+        def repair(result)
+          @next_reboot_time += config[:reboot_timeout]
+          @device_api.power_cycle ? self.pass("Successful reboot") : self.fail("Reboot failed")
+        end
+      end
+    end
+  end
+end

data/lib/hive/messages/tv_job.rb

@@ -0,0 +1,20 @@
+# encoding: UTF-8
+
+require 'hive/messages'
+
+module Hive
+  module Messages
+    class TvJob <  Hive::Messages::Job
+# TODO Fix this validation
+#      validates :application_url, :application_url_parameters, presence: true
+
+      def application_url
+        self.target.symbolize_keys[:application_url]
+      end
+
+      def application_url_parameters
+        self.target.symbolize_keys[:application_url_parameters]
+      end
+    end
+  end
+end

data/lib/hive/worker/tv.rb

@@ -0,0 +1,226 @@
+require 'hive/worker'
+require 'hive/messages/tv_job'
+require 'mind_meld/tv'
+require 'talkshow'
+
+module Hive
+  class Worker
+    # The TV worker
+    class Tv < Worker
+      class FailedRedirect < StandardError
+      end
+
+      def initialize(config)
+        @brand = config['brand'].downcase.gsub(/\s/, '_')
+        @model = config['model'].downcase.gsub(/\s/, '_')
+
+        if config['ir_blaster_clients'] and config['ir_blaster_clients'].has_key?(config['id'])
+          require 'device_api/tv'
+          DeviceAPI::RatBlaster.configure do |rb_config|
+            rb_config.host = Hive.config.network.tv.ir_blaster_host if Hive.config.network.tv.ir_blaster_host?
+            rb_config.port = Hive.config.network.tv.ir_blaster_port if Hive.config.network.tv.ir_blaster_port?
+          end
+
+          config.merge!({"device_api" => DeviceAPI::TV::Device.new(
+            id: config['id'],
+            ir: {
+              type: config['ir_blaster_clients'][config['id']].type,
+              mac: config['ir_blaster_clients'][config['id']].mac,
+              dataset: config['ir_blaster_clients'][config['id']].dataset,
+              output: config['ir_blaster_clients'][config['id']].output
+            }
+          )})
+          config['ir_blaster_clients'][config['id']].sequences.each do |name, pattern|
+            config['device_api'].set_sequence(name.to_sym, pattern)
+          end
+        end
+        super(config)
+      end
+
+      # Prepare the TV
+      def pre_script(job, job_paths, script)
+        url = job.application_url
+        @log.info("Application url: #{url}")
+        # TODO Set device as busy in Hive mind
+
+        params = ""
+
+        # 'cross_network_restriction' means that the device requires Talkshow
+        # on the same network as the application.
+        # For the moment, assume networks are '10.10.*.*' and'*.bbc.co.uk'
+        # TODO Make this more general
+        if @options['features'] && @options['features'].include?('cross_network_restriction') and /bbc.co.uk/.match url
+          ts_address = Hive.config.network.remote_talkshow_address
+          ts_port = @ts_port = Hive.config.network.remote_talkshow_port_offset + @options['id']
+          @log.info("Using remote talkshow on port #{ts_port}")
+          script.set_env 'TALKSHOW_REMOTE_URL', "http://#{ts_address}:#{ts_port}"
+          # Not actually required but talkshow fails without it set
+          script.set_env 'TALKSHOW_PORT', ts_port
+        else
+          ts_port = @ts_port = self.allocate_port
+          @log.info("Using talkshow on port #{ts_port}")
+          # TODO Move this more centrally
+          ip = Socket.ip_address_list.detect { |intf| intf.ipv4_private? }
+          ts_address = ip.ip_address
+          script.set_env 'TALKSHOW_PORT', ts_port
+        end
+        @log.info("Talkshow server address is: #{ts_address}")
+
+        if job.application_url_parameters.present?
+          params = "?#{job.application_url_parameters}&talkshowurl=#{ts_address}:#{ts_port}"
+        else
+          params = "?talkshowurl=#{ts_address}:#{ts_port}"
+        end
+        url += params
+
+        self.redirect(
+          url: url,
+          old_app: Hive.config.network.tv.titantv_name,
+          skip_first_load: true
+        )
+        load_hive_mind ts_port, url
+
+        @log.info("Starting TV Application monitor")
+        @monitor = Thread.new do
+          loop do
+            poll_response = Hive.hive_mind.poll(@device_id)
+#            if poll_response.is_a? Array and poll_response.length > 0
+#              @log.debug("[TV app monitor] Polled TV. Application = #{poll_response.first['application']}")
+#        #    if @hive_mind.device_details(refresh: true)['application'] == Hive.config.network.tv.titantv_name
+#              if poll_response.first['application'] == Hive.config.network.tv.titantv_name
+#                # TV has returned to the holding app
+#                # Put back in the app under test
+#                self.redirect(
+#                  url: url,
+#                  old_app: Hive.config.network.tv.titantv_name,
+#                  log_prefix: '[TV app monitor] '
+#                )
+#              end
+#            else
+#              @log.warn("[TV app monitor] Failed to poll TV")
+#            end
+            sleep 20
+          end
+        end
+
+        return nil
+      end
+
+      def job_message_klass
+        Hive::Messages::TvJob
+      end
+
+      def mind_meld_klass
+        MindMeld::Tv
+      end
+
+      def post_script(job, job_paths, script)
+        self.release_port(@ts_port) if @ts_port
+
+        signal_safe_post_script(job, job_paths, script)
+      end
+
+      def signal_safe_post_script(job, job_paths, script)
+        @log.info('Terminating TV Application monitor')
+        @monitor.exit if @monitor
+
+        self.redirect(url: Hive.config.network.tv.titantv_url, new_app: Hive.config.network.tv.titantv_name, skip_last_load: true)
+        # TODO Set device as idle in Hive Mind
+      end
+
+      def device_status
+        @hive_mind.device_details['status']
+      end
+
+      def set_device_status(status)
+        # TODO Set status from Hive Mind
+        # At the moment the device state cannot be changed
+        device_status
+      end
+
+      def autogenerated_queues
+        [ "#{@brand}-#{@model}" ]
+      end
+
+      def redirect(opts)
+        raise ArgumentError if ! ( opts.has_key?(:url) && ( opts.has_key?(:old_app) || opts.has_key?(:new_app) ) )
+        load_hive_mind(@ts_port, opts[:old_app] || "Trying to redirect ...") if ! opts[:skip_first_load]
+        opts[:log_prefix] ||= ''
+        @log.info("#{opts[:log_prefix]}Redirecting to #{opts[:url]}")
+        @hive_mind.create_action(action_type: 'redirect', body: opts[:url])
+        sleep 5
+        load_hive_mind(@ts_port, opts[:url]) if ! opts[:skip_last_load]
+
+        max_wait_count = 30
+        wait_count = 0
+        max_retry_count = 15
+        retry_count = 0
+
+        app_name = @hive_mind.device_details(refresh: true)['application']
+        @log.debug("#{opts[:log_prefix]}Current app: #{app_name}")
+        while (opts.has_key?(:new_app) && app_name != opts[:new_app]) || (opts.has_key?(:old_app) && app_name == opts[:old_app])
+          if wait_count >= max_wait_count
+            if retry_count >= max_retry_count
+              raise FailedRedirect
+            else
+              retry_count += 1
+              wait_count = 0
+              @log.info("#{opts[:log_prefix]}Redirecting to #{opts[:url]} [#{retry_count}]")
+              @hive_mind.create_action(action_type: 'redirect', body: opts[:url])
+              sleep 5
+            end
+          else
+            wait_count += 1
+            @log.info("#{opts[:log_prefix]}  . [#{wait_count}]")
+            sleep 5
+            load_hive_mind(@ts_port, opts[:url]) if ! opts[:skip_last_load]
+          end
+          app_name = @hive_mind.device_details(refresh: true)['application']
+          @log.debug("#{opts[:log_prefix]}Current app: #{app_name}")
+        end
+      end
+
+      # Between tests the TV must be in the holding app
+      def diagnostics
+        app_name = @hive_mind.device_details(refresh: true)['application']
+        raise DeviceNotReady.new("Current application: '#{app_name}'") if app_name != Hive.config.network.tv.titantv_name
+        super
+      end
+
+      def load_hive_mind ts_port, app_name
+        ts = Talkshow.new
+        @log.info("Port: #{ts_port}")
+        @log.info("App: #{app_name}")
+        @log.info("Logfile: #{@file_system.results_path}/talkshowserver.log")
+        @log.info("titantv_url: #{Hive.config.network.tv.titantv_url}")
+        ts.start_server(port: ts_port, logfile: "#{@file_system.results_path}/talkshowserver.log")
+        5.times do
+          begin
+            ts.execute <<JS
+(function(){
+  var load_script = document.createElement('script');
+  load_script.type = 'text/javascript';
+  load_script.charset = 'utf-8';
+  load_script.src = '#{Hive.config.network.tv.titantv_url}/script/hive_mind_com.js';
+  document.getElementsByTagName('head')[0].appendChild(load_script);
+  // Give it 10 seconds to load
+  // TODO Do this with a retry
+  setTimeout(function() {
+    hive_mind_com.init('#{app_name}', '#{Hive.config.network.tv.titantv_url}');
+    hive_mind_com.start();
+  }, 10000);
+  return true;
+})()
+JS
+            break
+          rescue Talkshow::Timeout
+            @log.info("Talkshow timeout")
+            sleep 5
+          end
+        end
+        ts.stop_server
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: hive-runner-tv
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Joe Haig
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hive-runner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: talkshow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+- !ruby/object:Gem::Dependency
+  name: res
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: The TV controller module for Hive Runner
+email: joe.haig@bbc.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/hive/controller/tv.rb
+- lib/hive/device/tv.rb
+- lib/hive/diagnostic/tv/dead.rb
+- lib/hive/diagnostic/tv/uptime.rb
+- lib/hive/messages/tv_job.rb
+- lib/hive/worker/tv.rb
+homepage: https://github.com/bbc-test/hive-runner-tv
+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.5.0
+signing_key: 
+specification_version: 4
+summary: Hive Runner TV
+test_files: []