stf-client 0.3.0.rc10 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: c249656e07f06e0277ef3bcb2cf2a7ab407b6147207d2e564e89eb8714b7520f
-  data.tar.gz: 13bfab11bd241d2c6b0af14ba559ea242ef2a8e203ba3f6ffa3e1bd7dc7f54a3
+SHA1:
+  metadata.gz: 1e9c7988df5dfcedbb4dcdbf9806393cbccbc52a
+  data.tar.gz: 7edad8804eb4b5dba79f1f72d4beb3987886d7ff
 SHA512:
-  metadata.gz: d8929c2e8b8e406b8196e130766be14fde6c91a505ab3ea626a64aa332fd8f4739967700d2771f8abe1509a6d3fd01d5ad7a21411665259c97ebd5e316cba8ae
-  data.tar.gz: ae9311e60e7402761a1287d560b3093d09e4511d790989c1b13fd1c6c9f4e4d05117b7d2b1ab5d7131eb26e8a3681d4872e6cb68a1c420eec88bd8f0b5d1ed40
+  metadata.gz: 31ae93d7103a8646ea1bf546d0e5e8b0031f22fb97795497f6e168d7e3cb65f9efcab778ede8519fbd387574d313b94a86df0b6ad0ee072b2c550191f4679ef5
+  data.tar.gz: a1be4ebb8e2a8cdc6d4ea6cb1c4c721c815c303a9d8eef8e80724e0f38810ba8f7e027880785681962fb3d661ff24451f965c4a486ca9ab5bca5acf85f170426

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/interactor/add_adb_public_key'
 require 'stf/validate/uri_validator'
 
 class DI
@@ -64,6 +65,10 @@ class DI
       c.register(:uri_validator,
                  -> {Stf::URIValidator.new},
                  memoize: true)
+
+      c.register(:add_adb_public_key_interactor,
+                 -> {Stf::AddAdbPublicKeyInteractor.new},
+                 memoize: true)
     end
 
     def [](what)

data/lib/stf/client.rb

@@ -54,6 +54,11 @@ module Stf
       return response.success
     end
 
+    def add_adb_public_key(adb_public_key)
+      response = execute '/api/v1/user/adbPublicKeys', Net::HTTP::Post, { publickey: adb_public_key }.to_json
+      return response.success
+    end
+
     private
 
     def execute(relative_url, type, body='')

data/lib/stf/interactor/add_adb_public_key.rb

@@ -0,0 +1,20 @@
+require 'di'
+
+require 'stf/client'
+require 'stf/log/log'
+
+module Stf
+  class AddAdbPublicKeyInteractor
+    include Log
+
+    def execute(adb_public_key_location)
+      public_key = File.open(adb_public_key_location, 'rb', &:read)
+      success = DI[:stf].add_adb_public_key public_key
+      if success
+        logger.info "adb public key from '#{adb_public_key_location}' has been added"
+      elsif logger.error "Can't add public key from '#{adb_public_key_location}'"
+        return false
+      end
+    end
+  end
+end

data/lib/stf/interactor/start_debug_session_interactor.rb

@@ -17,18 +17,23 @@ module Stf
       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.message}\""
         DI[:stop_all_debug_sessions_interactor].execute
@@ -46,12 +51,14 @@ module Stf
 
       # will be daemon here
       DI[:demonizer].run do
-        connect_loop(all_flag,
-                     max_n,
-                     filter,
-                     true,
-                     30,
-                     session)
+        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
@@ -59,29 +66,39 @@ module Stf
       return true
     end
 
-    def connect_loop(all_flag, wanted, filter, daemon_mode, delay, timeout)
+    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
 
         all_devices = DeviceList.new(DI[:stf].get_devices)
-        stf_devices = all_devices.filterReadyToConnect
-        stf_devices = stf_devices.byFilter(filter) if filter
+        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
           to_connect = stf_devices.size
         else
-          connected = devices & all_devices.asConnectUrlList
+          connected = devices & all_devices.as_connect_url_list
           to_connect = wanted - connected.size
         end
 
-        return if one_time_mode && to_connect == 0
+        return if one_time_mode && to_connect <= 0
 
         if to_connect > 0
           if stf_devices.empty?
@@ -99,17 +116,38 @@ module Stf
 
     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|
+      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
+
+      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
+
+      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
+
+      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

data/lib/stf/interactor/stop_all_debug_sessions_interactor.rb

@@ -12,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/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,15 +11,28 @@ 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
+    def select_healthy(pattern)
+      pattern ? select { |d| d.healthy?(pattern) } : this
+    end
+
+    # 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;
@@ -28,11 +41,19 @@ module Stf
       #   CONNECTING = 4;
       #   AUTHORIZING = 5;
       # }
-      select {|d| d.ready == true && d.present == true && d.usage.nil? && d.status == 3 }
+      #
+      # 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 asConnectUrlList
-      @devices.map {|d| d.remoteConnectUrl}
+    def as_connect_url_list
+      @devices.map {|d| d.remoteConnectUrl}.reject { |c| c.nil? || c.empty? }
     end
 
     def select

data/lib/stf/version.rb

@@ -1,3 +1,3 @@
 module Stf
-  VERSION = '0.3.0.rc10'
+  VERSION = '0.3.0'
 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]
@@ -50,6 +50,10 @@ 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'
@@ -98,6 +102,19 @@ module Stf
       c.action {DI[:remove_all_user_devices_interactor].execute}
     end
 
+    desc 'Add adb public key into STF'
+    command :trustme do |c|
+      c.desc 'Location of adb public key'
+      c.flag [:k, :adb_public_key_location]
+      c.default_value '~/.android/adbkey.pub'
+
+      c.action do |_, options, _|
+        filename = File.expand_path(options[:adb_public_key_location])
+        exit_now!("File does not exist: '#{options[:adb_public_key_location]}'") unless File.exist? filename
+        DI[:add_adb_public_key_interactor].execute(options[:adb_public_key_location])
+      end
+    end
+
     exit run(ARGV)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stf-client
 version: !ruby/object:Gem::Version
-  version: 0.3.0.rc10
+  version: 0.3.0
 platform: ruby
 authors:
 - Anton Malinskiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-31 00:00:00.000000000 Z
+date: 2019-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
@@ -199,6 +199,7 @@ files:
 - lib/di.rb
 - lib/stf.rb
 - lib/stf/client.rb
+- lib/stf/interactor/add_adb_public_key.rb
 - lib/stf/interactor/get_keys_interactor.rb
 - lib/stf/interactor/get_values_interactor.rb
 - lib/stf/interactor/remove_all_user_devices_interactor.rb
@@ -229,12 +230,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Request devices from Smartphone Test Farm for adb connection