stf-client 0.2.6 → 0.3.0.pre.rc.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7db448c2c0164d028021aa694aa0a726cee55941
-  data.tar.gz: 5dca57695b59bfa254ced82f32ba0c8cc10489b4
+SHA256:
+  metadata.gz: 52a4f2a68edf69cda4d74621215c184f14ea2fbf97d2c27948581f7dee93e838
+  data.tar.gz: 622083a2cd27df2e8b3ba9dd78ff79cf9054bdfe27049544816dc04fed77b3b6
 SHA512:
-  metadata.gz: 597d3bd7df408f76a32f0a6b6f79534a450e0a8233df2e70893fdf7981cebee79c810bb9dadef5fa275d622d6062a4a6ad06abf50a21f5a5d388581ea1b055a6
-  data.tar.gz: 762ca50470092120eeda8b84348f650a95da64406f8da2c75b1d1a1f68bef1a8be99d14768fb506d185c12d7e7591730d67730eb349902265a424d00ebbdf6b9
+  metadata.gz: 42f63749eb0a0f748b3a66051f3a409d92765d7b519627608b52e34a7241ae8b58b91a35dcc1c28ef61d18c482d18b0aebba88af50e52227cfd78fbdc4f6671d
+  data.tar.gz: 3a27762217fad2da4895997c33def45bd35044b3b4a0a3e17f48fa0434236b899ae058802c0fa1c6e9a110aae3ccfc4fd2f72f068360adbd8c47f04ab0085554

data/README.md

@@ -48,7 +48,7 @@ COMMANDS
     connect    - Search for a device available in STF and attach it to local adb server
     disconnect - Disconnect device(s) from local adb server and remove device(s) from user devices in STF
     help       - Shows a list of commands or help for one command
-    keys       - Show avaliable keys for filtering
+    keys       - Show available keys for filtering
     values     - Show known values for the filtering key
     
 ENVIRONMENT VARIABLES

data/lib/di.rb

@@ -9,6 +9,7 @@ require 'stf/interactor/stop_all_debug_sessions_interactor'
 require 'stf/interactor/remove_all_user_devices_interactor'
 require 'stf/interactor/get_keys_interactor'
 require 'stf/interactor/get_values_interactor'
+require 'stf/validate/uri_validator'
 
 class DI
   class << self
@@ -60,6 +61,9 @@ class DI
                  -> {Stf::RemoveAllUserDevicesInteractor.new},
                  memoize: true)
 
+      c.register(:uri_validator,
+                 -> {Stf::URIValidator.new},
+                 memoize: true)
     end
 
     def [](what)

data/lib/stf/client.rb

@@ -4,7 +4,6 @@ require 'ostruct'
 
 require 'stf/version'
 require 'stf/log/log'
-require 'stf/errors'
 
 module Stf
   class Client

data/lib/stf/interactor/get_keys_interactor.rb

@@ -3,8 +3,6 @@ require 'di'
 
 require 'stf/client'
 require 'stf/log/log'
-require 'stf/errors'
-require 'stf/model/session'
 require 'stf/model/device'
 
 module Stf

data/lib/stf/interactor/get_values_interactor.rb

@@ -3,8 +3,6 @@ require 'ADB'
 
 require 'stf/client'
 require 'stf/log/log'
-require 'stf/errors'
-require 'stf/model/session'
 require 'stf/model/device'
 
 module Stf

data/lib/stf/interactor/start_debug_session_interactor.rb

@@ -2,8 +2,6 @@ require 'ADB'
 
 require 'stf/client'
 require 'stf/log/log'
-require 'stf/errors'
-require 'stf/model/session'
 require 'stf/model/device_list'
 
 module Stf
@@ -14,30 +12,34 @@ module Stf
 
     def execute(opts = {})
       all_flag = opts[:all]
-      forever_flag = opts[:forever]
       nodaemon_flag = opts[:nodaemon]
       filter = opts[:filter]
       max_n = opts[:n].to_i > 0 ? opts[:n].to_i : 1
       start_timeout = opts[:starttime].to_i > 0 ? opts[:starttime].to_i : 120
       session = opts[:worktime].to_i > 0 ? opts[:session].to_i : 10800
-      min_n = opts[:min].to_s.empty? ? (max_n + 1) / 2 : opts[:min].to_i
+      min_n = opts[:min].to_s.empty? ? (max_n + 1) / 2 : [opts[:min].to_i, max_n].min
+      healthcheck = opts[:health]
+      force_filter = opts[:forcefilter]
 
       DI[:demonizer].kill unless opts[:nokill]
 
-      if filter
-        DI[:stop_all_debug_sessions_interactor].execute(exceptFilter: filter)
-      end
-
       wanted = nodaemon_flag ? max_n : min_n
 
       begin
-        connect_loop(all_flag, wanted, filter, false, 5, start_timeout)
+        connect_loop(all_flag: all_flag,
+                     wanted: wanted,
+                     filter: filter,
+                     force_filter: force_filter,
+                     healthcheck: healthcheck,
+                     delay: 5,
+                     timeout: start_timeout)
+
       rescue SignalException => e
-        logger.info "Caught signal #{e}"
+        logger.info "Caught signal \"#{e.message}\""
         DI[:stop_all_debug_sessions_interactor].execute
         return false
-      rescue
-        logger.info "Exception #{e} during initial connect loop"
+      rescue Exception => e
+        logger.info "Exception \"#{e.message}\" during initial connect loop"
         DI[:stop_all_debug_sessions_interactor].execute
         return false
       end
@@ -49,13 +51,14 @@ module Stf
 
       # will be daemon here
       DI[:demonizer].run do
-        connect_loop(all_flag,
-                     max_n,
-                     filter,
-                     true,
-                     30,
-                     session,
-                     forever_flag)
+        connect_loop(all_flag: all_flag,
+                     wanted: max_n,
+                     filter: filter,
+                     force_filter: force_filter,
+                     healthcheck: healthcheck,
+                     daemon_mode: true,
+                     delay: 30,
+                     timeout: session)
 
         DI[:stop_all_debug_sessions_interactor].execute(byFilter: filter, nokill: true)
       end
@@ -63,74 +66,91 @@ module Stf
       return true
     end
 
-    def connect_loop(all_flag, wanted, filter, infinite_flag, delay, timeout, forever_flag = false)
+    def connect_loop(all_flag: false,
+                     wanted: 1,
+
+                     filter: nil,
+                     force_filter: false,
+                     healthcheck: nil,
+
+                     daemon_mode: false,
+                     delay: 5,
+                     timeout: 120)
       finish_time = Time.now + timeout
+      one_time_mode = !daemon_mode
 
       while true do
-        cleanup_disconnected_devices(filter)
+        cleanup_disconnected_devices(filter, force_filter, healthcheck)
+
+        if one_time_mode && Time.now > finish_time
+          raise "Connect loop timeout reached"
+        end
 
-        stf_devices = DeviceList.new(DI[:stf].get_devices)
-        stf_devices = stf_devices.byFilter(filter) if filter
+        all_devices = DeviceList.new(DI[:stf].get_devices)
+        stf_devices = all_devices.select_ready_to_connect
+        stf_devices = stf_devices.by_filter(filter) if filter
+        stf_devices = stf_devices.select_healthy_for_connect(healthcheck) if healthcheck
 
         if all_flag
-          batch = stf_devices.filterReadyToConnect.size
+          to_connect = stf_devices.size
         else
-          connected = devices & stf_devices.asConnectUrlList
-          batch = wanted - connected.size
+          connected = devices & all_devices.as_connect_url_list
+          to_connect = wanted - connected.size
         end
 
-        if batch > 0
-          n = connect(filter, all_flag, batch)
-          break if n == batch && !infinite_flag
-        elsif !infinite_flag
-          break
+        return if one_time_mode && to_connect <= 0
+
+        if to_connect > 0
+          if stf_devices.empty?
+            logger.error 'There is no available devices with criteria ' + filter
+          else
+            random_device = stf_devices.asArray.sample
+            DI[:start_one_debug_session_interactor].execute(random_device)
+            next
+          end
         end
 
         sleep delay
-
-        if !forever_flag || Time.now > finish_time
-          raise "Connect loop timeout reached"
-        end
       end
-
     end
 
     def count_connected_devices(filter)
       stf_devices = DeviceList.new(DI[:stf].get_user_devices)
-      stf_devices = stf_devices.byFilter(filter) if filter
-      connected = devices & stf_devices.asConnectUrlList
+      stf_devices = stf_devices.by_filter(filter) if filter
+      connected = devices & stf_devices.as_connect_url_list
       connected.size
     end
 
-    def cleanup_disconnected_devices(filter)
+    def cleanup_disconnected_devices(filter, force_filter, healthcheck)
+      to_disconnect = []
       stf_devices = DeviceList.new(DI[:stf].get_user_devices)
-      stf_devices = stf_devices.byFilter(filter) if filter
-      connected = stf_devices.asConnectUrlList - devices
 
-      connected.reject {|url| url.to_s.empty?}.each do |url|
-        logger.info 'Cleanup the device ' + url.to_s
-        DI[:stop_debug_session_interactor].execute(url)
+      if filter && force_filter
+        disconnect_because_filter = stf_devices.except_filter(filter).as_connect_url_list
+        unless disconnect_because_filter.empty?
+          logger.info 'will be disconnected by filter: ' + disconnect_because_filter.join(',')
+          to_disconnect += disconnect_because_filter
+        end
       end
-    end
-
-    def connect(filter, all_flag, wanted)
-      devices = DeviceList.new(DI[:stf].get_devices)
-      devices = devices.filterReadyToConnect
-      devices = devices.byFilter(filter) if filter
 
-      if devices.empty?
-        logger.error 'There is no available devices with criteria ' + filter
-        return 0
+      if healthcheck
+        disconnect_by_health = stf_devices.select_not_healthy(healthcheck).as_connect_url_list
+        unless disconnect_by_health.empty?
+          logger.info 'will be disconnected by health check: ' + disconnect_by_health.join(',')
+          to_disconnect += disconnect_by_health
+        end
       end
 
-      n = 0
-      devices.asArray.shuffle.each do |d|
-        n += 1 if DI[:start_one_debug_session_interactor].execute(d)
-        break if !all_flag && n >= wanted
+      dead_persons = stf_devices.as_connect_url_list - devices
+      unless dead_persons.empty?
+        logger.info 'will be disconnected because not present locally: ' + dead_persons.join(',')
+        to_disconnect += dead_persons
       end
 
-      n
+      to_disconnect.reject {|url| url.to_s.empty?}.uniq.each do |url|
+        logger.info 'Cleanup the device ' + url.to_s
+        DI[:stop_debug_session_interactor].execute(url)
+      end
     end
-
   end
 end

data/lib/stf/interactor/start_one_debug_session_interactor.rb

@@ -3,8 +3,6 @@ require 'ADB'
 
 require 'stf/client'
 require 'stf/log/log'
-require 'stf/errors'
-require 'stf/model/session'
 
 module Stf
   class StartOneDebugSessionInteractor
@@ -40,23 +38,26 @@ module Stf
 
         return true
 
-      rescue SignalException => e
-        raise e
-      rescue => e
+      rescue StandardError, SignalException => e
         begin
           # we will try clean anyway
           DI[:stf].remove_device serial
           if test ?d, '/custom-metrics'
-            File.open('/custom-metrics/openstf_connect_fail', 'a') do
-                |f| f.write("openstf_connect_fail #{serial} #{Time.now.to_i}")
+            File.open('/custom-metrics/openstf_connect_fail', 'a') do |f|
+              message = (!e.nil? || !e.message.nil?) ? e.message : ""
+              f.write("openstf_connect_fail,reason=\"#{escape(message)}\",serial=\"#{escape(serial)}\" count=1i #{Time.now.to_i}\n")
             end
           end
         rescue
         end
 
-        logger.error "Failed to connect to #{serial}: " + e.message
+        logger.error "Failed to connect to #{serial}: " + e&.message
         return false
       end
     end
+
+    def escape(s)
+      s.gsub(/["]/, '\"').gsub(/[ ]/, '\ ').gsub(/[=]/, '\=').gsub(/[,]/, '\,')
+    end
   end
 end

data/lib/stf/interactor/stop_all_debug_sessions_interactor.rb

@@ -3,7 +3,6 @@ require 'ADB'
 
 require 'stf/client'
 require 'stf/log/log'
-require 'stf/errors'
 require 'stf/interactor/stop_debug_session_interactor'
 require 'stf/model/device_list'
 
@@ -13,19 +12,14 @@ module Stf
     include ADB
 
     # byFilter:
-    # exceptFilter:
     def execute(options = {})
       DI[:demonizer].kill unless options[:nokill]
 
       stf_devices = DeviceList.new(DI[:stf].get_user_devices)
 
-      stf_devices = stf_devices.byFilter options[:byFilter] if options[:byFilter]
-      stf_devices = stf_devices.exceptFilter options[:exceptFilter] if options[:exceptFilter]
+      stf_devices = stf_devices.by_filter options[:byFilter] if options[:byFilter]
 
-      connected_devices = devices()
-      remote_devices = stf_devices.asConnectUrlList
-
-      pending_disconnect = connected_devices & remote_devices
+      pending_disconnect = stf_devices.as_connect_url_list
 
       pending_disconnect.each {|d| DI[:stop_debug_session_interactor].execute d}
     end

data/lib/stf/interactor/stop_debug_session_interactor.rb

@@ -3,7 +3,6 @@ require 'ADB'
 
 require 'stf/client'
 require 'stf/log/log'
-require 'stf/errors'
 
 module Stf
   class StopDebugSessionInteractor

data/lib/stf/model/device.rb

@@ -8,7 +8,33 @@ module Stf
       getKeysNextLevel('', self)
     end
 
-    def checkFilter(filter)
+    # more pessimistic decision
+    def healthy_for_connect?(pattern)
+      return true if pattern.nil?
+      health = healthy?(pattern)
+      ppp = pattern.split(',')
+      ppp.each do |p|
+        health &&= getValue('battery.temp').to_i < 30 if ['t', 'temp', 'temperature'].include? p
+        health &&= getValue('battery.level').to_f > 30.0 if ['b', 'batt', 'battery'].include? p
+      end
+      health
+    end
+
+    def healthy?(pattern)
+      return true if pattern.nil?
+      ppp = pattern.split(',')
+      health = true
+      ppp.each do |p|
+        health &&= getValue('battery.temp').to_i < 32 if ['t', 'temp', 'temperature'].include? p
+        health &&= getValue('battery.level').to_f > 20.0 if ['b', 'batt', 'battery'].include? p
+        health &&= getValue('network.connected') if ['n', 'net', 'network'].include? p
+        health &&= getValue('network.type') == 'VPN' if ['vpn'].include? p
+        health &&= getValue('network.type') == 'WIFI' if ['wifi'].include? p
+      end
+      health
+    end
+
+    def checkFilter?(filter)
       return true if filter.nil?
       key, value = filter.split(':', 2)
       getValue(key) == value

data/lib/stf/model/device_list.rb

@@ -11,20 +11,49 @@ module Stf
       end
     end
 
-    def byFilter(filter)
-      filter ? select {|d| d.checkFilter(filter)} : Array.new
+    def by_filter(filter)
+      filter ? select {|d| d.checkFilter?(filter)} : []
     end
 
-    def exceptFilter(filter)
-      filter ? reject {|d| d.checkFilter(filter)} : this
+    def except_filter(filter)
+      filter ? reject {|d| d.checkFilter?(filter)} : this
     end
 
-    def filterReadyToConnect
-      select {|d| d.ready == true && d.present == true && d.usage.nil? }
+    def select_healthy(pattern)
+      pattern ? select { |d| d.healthy?(pattern) } : this
     end
 
-    def asConnectUrlList
-      @devices.map {|d| d.remoteConnectUrl}
+    # more pessimistic than healthy()
+    def select_healthy_for_connect(pattern)
+      pattern ? select { |d| d.healthy_for_connect?(pattern) } : this
+    end
+
+    def select_not_healthy(pattern)
+      pattern ? reject { |d| d.healthy?(pattern) } : []
+    end
+
+    def select_ready_to_connect
+      # https://github.com/openstf/stf/blob/93d9d7fe859bb7ca71669f375d841d94fa47d751/lib/wire/wire.proto#L170
+      # enum DeviceStatus {
+      #   OFFLINE = 1;
+      #   UNAUTHORIZED = 2;
+      #   ONLINE = 3;
+      #   CONNECTING = 4;
+      #   AUTHORIZING = 5;
+      # }
+      #
+      # https://github.com/openstf/stf/blob/93d9d7fe859bb7ca71669f375d841d94fa47d751/res/app/components/stf/device/enhance-device/enhance-device-service.js
+      select {|d|
+        d.present == true &&
+            d.status == 3 &&
+            d.ready == true &&
+            d.using == false &&
+            d.owner.nil?
+      }
+    end
+
+    def as_connect_url_list
+      @devices.map {|d| d.remoteConnectUrl}.reject { |c| c.nil? || c.empty? }
     end
 
     def select
@@ -32,7 +61,6 @@ module Stf
     end
 
     def reject
-      # DeviceList.new(@devices.reject {|d| yield(d)})
       DeviceList.new(@devices.select {|d| !yield(d)})
     end
 
@@ -48,4 +76,4 @@ module Stf
       @devices
     end
   end
-end
+end

data/lib/stf/validate/uri_validator.rb

@@ -0,0 +1,7 @@
+module Stf
+  class URIValidator
+    def validate(uri)
+      return (uri =~ /\A#{URI::regexp(%w(http https))}\z/) != nil
+    end
+  end
+end

data/lib/stf/version.rb

@@ -1,3 +1,3 @@
 module Stf
-  VERSION = '0.2.6'
+  VERSION = '0.3.0-rc.12'
 end

data/lib/stf/view/cli.rb

@@ -7,7 +7,7 @@ module Stf
 
     extend self
 
-    program_desc 'Smartphone Test Lab client'
+    program_desc "Smartphone Test Lab client (version #{Stf::VERSION})"
 
     desc 'Be verbose'
     switch [:v, :verbose]
@@ -35,6 +35,9 @@ module Stf
       Log::verbose(global_options[:verbose])
 
       DI.init(global_options)
+
+      help_now!('Valid STF url is required, e.g. http(s)://openstf.local') if !DI[:uri_validator].validate(global_options[:url])
+      true
     end
 
     desc 'Search for a device available in STF and attach it to local adb server'
@@ -47,12 +50,14 @@ module Stf
       c.flag [:min]
       c.desc 'Filter key:value for devices'
       c.flag [:f, :filter]
+      c.desc 'Force filter check for connected devices'
+      c.switch [:forcefilter, :ff]
+      c.desc 'Check selected health parameters, could be any of the: battery,temperature,network,vpn,wifi'
+      c.flag [:health]
       c.desc 'Maximum session duration in seconds, 10800 (3h) by default'
       c.flag [:session]
       c.desc 'Maximum time to connect minimal quantity of devices in seconds, 120 (2m) by default'
       c.flag [:starttime]
-      c.desc 'Maintain connactions before explicitly kill'
-      c.switch [:forever]
       c.desc 'Do not start daemon'
       c.switch [:nodaemon]
 
@@ -63,7 +68,7 @@ module Stf
       end
     end
 
-    desc 'Show avaliable keys for filtering'
+    desc 'Show available keys for filtering'
     command :keys do |c|
       c.action {puts DI[:get_keys_interactor].execute}
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stf-client
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.0.pre.rc.12
 platform: ruby
 authors:
 - Anton Malinskiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-28 00:00:00.000000000 Z
+date: 2018-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
@@ -199,7 +199,6 @@ files:
 - lib/di.rb
 - lib/stf.rb
 - lib/stf/client.rb
-- lib/stf/errors.rb
 - lib/stf/interactor/get_keys_interactor.rb
 - lib/stf/interactor/get_values_interactor.rb
 - lib/stf/interactor/remove_all_user_devices_interactor.rb
@@ -210,8 +209,8 @@ files:
 - lib/stf/log/log.rb
 - lib/stf/model/device.rb
 - lib/stf/model/device_list.rb
-- lib/stf/model/session.rb
 - lib/stf/system/demonizer.rb
+- lib/stf/validate/uri_validator.rb
 - lib/stf/version.rb
 - lib/stf/view/cli.rb
 - stf-client.gemspec
@@ -230,12 +229,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Request devices from Smartphone Test Farm for adb connection

data/lib/stf/errors.rb

@@ -1,7 +0,0 @@
-module Stf
-  class DeviceNotAvailableError < StandardError
-    def message
-      'Device not available'
-    end
-  end
-end

data/lib/stf/model/session.rb

@@ -1,12 +0,0 @@
-module Stf
-  class Session
-
-    attr_accessor :serial, :url
-
-    def initialize(serial, url)
-      @serial = serial
-      @url = url
-    end
-
-  end
-end