stf-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 65ca8ca05799cb4e254f7b962a362756427e37c5
+  data.tar.gz: 577b8bfaf8a406e993deca460e35f51e19878aba
+SHA512:
+  metadata.gz: 33f66f05b6bf4388cf9e8761df25efccf7db732a3fd35efee84c18ad59e7570e5862d4489253cad930685a497ffe004ca9c155165f3056d38a5cd844c1e1b801
+  data.tar.gz: 188a7c5081a5cf27756b72d0888290572aecda5f77de7d59b7e677c0c3d07f609134e29ddf0928cd3ac67b35d506f58996212814fd9f3b0a62dea3779d07924a

data/.gitignore

@@ -0,0 +1,98 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+### JetBrains template
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff:
+.idea/workspace.xml
+.idea/tasks.xml
+.idea/dictionaries
+.idea/vcs.xml
+.idea/jsLibraryMappings.xml
+
+# Sensitive or high-churn files:
+.idea/dataSources.ids
+.idea/dataSources.xml
+.idea/dataSources.local.xml
+.idea/sqlDataSources.xml
+.idea/dynamic.xml
+.idea/uiDesigner.xml
+
+# Gradle:
+.idea/gradle.xml
+.idea/libraries
+
+# Mongo Explorer plugin:
+.idea/mongoSettings.xml
+
+## File-based project format:
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+/out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+### Ruby template
+*.gem
+*.rbc
+/.config
+/InstalledFiles
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/rdoc/
+
+## Environment normalization:
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'ADB'
+gem 'gli'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Anton Malinskiy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# Stf::Client
+
+Automation client for connecting to [OpenSTF](https://github.com/openstf/stf) devices.
+
+Designed with the following scenario in mind:
+
+1. Connect to remote devices
+2. Do something with the device via adb (Instrumentation Test, adb install, etc)
+3. Disconnect from device
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'stf-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stf-client
+
+## Usage
+
+```
+NAME
+    stf-client - Smartphone Test Lab client
+
+SYNOPSIS
+    stf-client [global options] command [command options] [arguments...]
+
+GLOBAL OPTIONS
+    --help             - Show this message
+    -t, --token=arg    - Authorization token (default: none)
+    -u, --url=arg      - URL to STF (default: none)
+    -v, --[no-]verbose - Be verbose
+
+COMMANDS
+    clean      - Frees all devices that are assigned to current user in STF. Doesn't modify local adb
+    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
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Malinskiy/stf-client.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+task :default => :spec
+task :test => :spec

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/bin/stf-client

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require 'stf'

data/lib/stf/client.rb

@@ -0,0 +1,75 @@
+require 'net/http'
+require 'json'
+require 'ostruct'
+
+require 'stf/version'
+require 'stf/log/log'
+require 'stf/errors'
+
+module Stf
+  class Client
+    include Log
+
+    def initialize(base_url, token)
+      @base_url = base_url
+      @token    = token
+    end
+
+    def get_devices
+      response = execute '/api/v1/devices', Net::HTTP::Get
+      return response.devices
+    end
+
+    def get_device(serial)
+      response = execute "/api/v1/devices/#{serial}", Net::HTTP::Get
+      return response.device
+    end
+
+    def get_user
+      response = execute '/api/v1/user', Net::HTTP::Get
+      return response.user
+    end
+
+    def get_user_devices
+      response = execute '/api/v1/user/devices', Net::HTTP::Get
+      return response.devices
+    end
+
+    def add_device(serial)
+      response = execute '/api/v1/user/devices', Net::HTTP::Post, {serial: serial}.to_json
+      return response.success
+    end
+
+    def remove_device(serial)
+      response = execute "/api/v1/user/devices/#{serial}", Net::HTTP::Delete
+      return response.success
+    end
+
+    def start_debug(serial)
+      response = execute "/api/v1//user/devices/#{serial}/remoteConnect", Net::HTTP::Post
+      return response
+    end
+
+    def stop_debug(serial)
+      response = execute "/api/v1//user/devices/#{serial}/remoteConnect", Net::HTTP::Delete
+      return response.success
+    end
+
+    private
+
+    def execute(relative_url, type, body='')
+      uri          = URI.parse(@base_url + relative_url)
+      http         = Net::HTTP.new(uri.host)
+      request      = type.new(uri.request_uri, 'Authorization' => "Bearer #{@token}", 'Content-Type' => 'application/json')
+      request.body = body
+      response     = http.request(request)
+
+
+      json = JSON.parse(response.body, object_class: OpenStruct)
+
+      logger.debug "API returned #{json}"
+
+      return json
+    end
+  end
+end

data/lib/stf/errors.rb

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

data/lib/stf/interactor/remove_all_user_devices_interactor.rb

@@ -0,0 +1,11 @@
+class RemoveAllUserDevicesInteractor
+
+  def initialize(stf)
+    @stf = stf
+  end
+
+  def execute
+    devices = @stf.get_user_devices
+    devices.each { |d| @stf.remove_device d.serial }
+  end
+end

data/lib/stf/interactor/start_debug_session_interactor.rb

@@ -0,0 +1,65 @@
+require 'ADB'
+
+require 'stf/client'
+require 'stf/log/log'
+require 'stf/errors'
+require 'stf/model/session'
+
+class StartDebugSessionInteractor
+
+  include Log
+  include ADB
+
+  def initialize(stf)
+    @stf = stf
+  end
+
+  def execute
+    randomized_device = nil
+
+    1..10.times do
+      begin
+        devices = @stf.get_devices
+        if devices.nil? || (devices.is_a?(Array) && devices.empty?)
+          logger.info 'No devices connected to STF. Retrying'
+          sleep 5
+          next
+        end
+        usable_devices = devices.select { |device| device.using == false }
+        if usable_devices.empty?
+          logger.error 'All devices are being used. Retrying'
+          sleep 5
+          next
+        end
+
+        randomized_device = usable_devices.sample
+        raise new DeviceNotAvailableError if randomized_device.nil?
+
+        serial  = randomized_device.serial
+        success = @stf.add_device serial
+        if success
+          logger.info "Device #{serial} added"
+        elsif logger.error "Can't add device #{serial}. Retrying"
+          next
+        end
+
+        result = @stf.start_debug serial
+        if !result.success
+          logger.error "Can't start debugging session for device #{serial}. Retrying"
+          @stf.remove_device serial
+          next
+        end
+
+        execute_adb_with 30, "connect #{result.remoteConnectUrl}"
+
+        return Session.new(serial, result.remoteConnectUrl)
+        break
+
+        raise new DeviceNotAvailableError
+      rescue DeviceNotAvailableError
+        logger.error 'Failed to start debug session. Retrying...'
+        next
+      end
+    end
+  end
+end

data/lib/stf/interactor/stop_all_debug_sessions_interactor.rb

@@ -0,0 +1,25 @@
+require 'ADB'
+
+require 'stf/client'
+require 'stf/log/log'
+require 'stf/errors'
+require 'stf/interactor/stop_debug_session_interactor'
+
+class StopAllDebugSessionsInteractor
+  include Log
+  include ADB
+
+  def initialize(stf)
+    @stf = stf
+  end
+
+  def execute
+    connected_devices = devices()
+    remote_devices    = @stf.get_user_devices.map { |d| d.remoteConnectUrl }
+
+    pending_disconnect = connected_devices & remote_devices
+    pending_disconnect.each do |d|
+      StopDebugSessionInteractor.new(@stf).execute d
+    end
+  end
+end

data/lib/stf/interactor/stop_debug_session_interactor.rb

@@ -0,0 +1,49 @@
+require 'ADB'
+
+require 'stf/client'
+require 'stf/log/log'
+require 'stf/errors'
+
+class StopDebugSessionInteractor
+
+  include Log
+  include ADB
+
+  def initialize(stf)
+    @stf = stf
+  end
+
+  def execute(remoteConnectUrl)
+    remote_devices = @stf.get_user_devices
+    device         = remote_devices.find { |d| d.remoteConnect == true && d.remoteConnectUrl.eql?(remoteConnectUrl) }
+
+    raise DeviceNotAvailableError if device.nil?
+
+    execute_adb_with 30, "disconnect #{device.remoteConnectUrl}"
+
+    success = false
+
+    1..10.times do
+      success = @stf.stop_debug(device.serial)
+      if success == true
+        break
+      elsif logger.error 'Can\'t stop debug session. Retrying'
+      end
+    end
+
+    1..10.times do
+      success = @stf.remove_device(device.serial)
+      if success == true
+        break
+      elsif logger.error 'Can\'t remove device from user devices. Retrying'
+      end
+    end
+
+    if success == true
+      logger.info "Successfully removed #{remoteConnectUrl}"
+    elsif logger.error "Error removing #{remoteConnectUrl}"
+    end
+
+    return success
+  end
+end

data/lib/stf/log/log.rb

@@ -0,0 +1,16 @@
+require 'logger'
+
+module Log
+
+  @@logger       = Logger.new(STDOUT)
+  @@logger.level = Logger::INFO
+
+  def logger
+    @@logger
+  end
+
+  def self.verbose(enable)
+    @@logger.level = enable ? Logger::DEBUG : Logger::INFO
+  end
+
+end

data/lib/stf/model/session.rb

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

data/lib/stf/version.rb

@@ -0,0 +1,3 @@
+module Stf
+  VERSION = '0.1.0'
+end

data/lib/stf/view/cli.rb

@@ -0,0 +1,67 @@
+module Stf
+  module CLI
+    require 'gli'
+    require 'stf/client'
+
+    require 'stf/interactor/start_debug_session_interactor'
+    require 'stf/interactor/stop_debug_session_interactor'
+    require 'stf/interactor/stop_all_debug_sessions_interactor'
+    require 'stf/interactor/remove_all_user_devices_interactor'
+
+    include GLI::App
+    extend self
+
+    program_desc 'Smartphone Test Lab client'
+
+    desc 'Be verbose'
+    switch [:v, :verbose]
+
+    desc 'Authorization token'
+    flag [:t, :token]
+
+    desc 'URL to STF'
+    flag [:u, :url]
+
+    pre do |global_options, command, options, args|
+      help_now!('STF url is required') if global_options[:url].nil?
+      help_now!('Authorization token is required') if global_options[:token].nil?
+
+      Log::verbose(global_options[:verbose])
+
+      $stf = Stf::Client.new(global_options[:url], global_options[:token])
+    end
+
+    desc 'Search for a device available in STF and attach it to local adb server'
+    command :connect do |c|
+      c.action do |global_options, options, args|
+        StartDebugSessionInteractor.new($stf).execute
+      end
+    end
+
+    desc 'Disconnect device(s) from local adb server and remove device(s) from user devices in STF'
+    command :disconnect do |c|
+      c.desc '(optional) ADB connection url of the device'
+      c.flag [:d, :device]
+      c.switch [:all]
+
+      c.action do |global_options, options, args|
+        if options[:device].nil? && options[:all] == true
+          StopAllDebugSessionsInteractor.new($stf).execute
+        elsif !options[:device].nil? && options[:all] == false
+          StopDebugSessionInteractor.new($stf).execute(options[:device])
+        elsif help_now!('Please specify disconnect mode (-all or -device)')
+        end
+      end
+    end
+
+    desc 'Frees all devices that are assigned to current user in STF. Doesn\'t modify local adb'
+    command :clean do |c|
+      c.action do |global_options, options, args|
+        RemoveAllUserDevicesInteractor.new($stf).execute
+      end
+    end
+
+    exit run(ARGV)
+  end
+end
+

data/lib/stf.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'stf/view/cli'
+
+module Stf
+  include Stf::CLI
+end

data/stf-client.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stf/version'
+
+Gem::Specification.new do |spec|
+  spec.name     = 'stf-client'
+  spec.version  = Stf::VERSION
+  spec.authors  = ['Anton Malinskiy']
+  spec.email    = ['anton@malinskiy.com']
+  spec.summary  = %q{Request devices from Smartphone Test Farm for adb connection}
+  spec.homepage = 'https://github.com/Malinskiy/stf-client'
+  spec.license  = 'MIT'
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+  spec.executables   = ['stf-client']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'webmock', '~> 2.1'
+  spec.add_development_dependency 'sinatra', '~> 1.4'
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: stf-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anton Malinskiy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: 
+email:
+- anton@malinskiy.com
+executables:
+- stf-client
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/setup
+- bin/stf-client
+- lib/stf.rb
+- lib/stf/client.rb
+- lib/stf/errors.rb
+- lib/stf/interactor/remove_all_user_devices_interactor.rb
+- lib/stf/interactor/start_debug_session_interactor.rb
+- lib/stf/interactor/stop_all_debug_sessions_interactor.rb
+- lib/stf/interactor/stop_debug_session_interactor.rb
+- lib/stf/log/log.rb
+- lib/stf/model/session.rb
+- lib/stf/version.rb
+- lib/stf/view/cli.rb
+- stf-client.gemspec
+homepage: https://github.com/Malinskiy/stf-client
+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.1
+signing_key: 
+specification_version: 4
+summary: Request devices from Smartphone Test Farm for adb connection
+test_files: []