smartdust-client 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d5ad0e2e8968ddc2d92112ef56c8ad15403b99507f9699b45e18fd75c42adf76
+  data.tar.gz: a44754161a3a0a3eb9ce069717c6c00e5ce2ffce12d00380c43764863172101d
+SHA512:
+  metadata.gz: 9ff4070a8ba7c49778a713b777e149487747a9aa28462f5cbc8bbbc7f0e8d918a344312f6652c49a4a6a2469fd4ab56d0ef09f4f6cb1b3feb1cb49598df3a7df
+  data.tar.gz: 84bd40b60b759ea84d4b498c96b0a91c139be9bc398bb0de72c3cc71d89347b5713b0c502d034bc3e75edd25447bd38c36832263059b632754bf5dd8145ad03f

data/.gitignore

@@ -0,0 +1,103 @@
+/.bundle/
+/.yardoc
+/_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
+
+# RubyMine
+.idea/.rakeTasks
+.idea/misc.xml
+.idea/modules.xml
+.idea/stf-client.iml
+
+## 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,5 @@
+--color
+--require spec_helper
+--format documentation
+--format RspecJunitFormatter --out spec/reports/rspec.xml
+--format html --out spec/reports/rspec.html

data/.simplecov

@@ -0,0 +1,10 @@
+require 'simplecov-json'
+
+SimpleCov.formatters = [
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::JSONFormatter
+]
+SimpleCov.minimum_coverage 80
+SimpleCov.start do
+  add_filter '/spec/'
+end

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.3.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,90 @@
+PATH
+  remote: .
+  specs:
+    smartdust-client (1.0.0)
+      ADB (~> 0.5)
+      dante (~> 0.2.0)
+      dry-configurable (~> 0.1.4)
+      dry-container (~> 0.6.0)
+      facets (~> 3.1.0)
+      gli (~> 2.17)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ADB (0.5.6)
+      childprocess (>= 0.3.5)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    childprocess (4.1.0)
+    concurrent-ruby (1.2.2)
+    crack (0.4.5)
+      rexml
+    dante (0.2.0)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    dry-configurable (0.1.7)
+      concurrent-ruby (~> 1.0)
+    dry-container (0.6.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    facets (3.1.0)
+    gli (2.21.0)
+    hashdiff (1.0.1)
+    json (2.6.3)
+    public_suffix (5.0.1)
+    rack (1.6.13)
+    rack-protection (1.5.5)
+      rack
+    rake (10.5.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rspec_junit_formatter (0.6.0)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov-json (0.2.3)
+      json
+      simplecov
+    simplecov_json_formatter (0.1.4)
+    sinatra (1.4.8)
+      rack (~> 1.5)
+      rack-protection (~> 1.4)
+      tilt (>= 1.3, < 3)
+    tilt (2.1.0)
+    webmock (2.3.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16.a)
+  rake (~> 10.0)
+  rspec (~> 3.5)
+  rspec_junit_formatter (~> 0.2)
+  simplecov (~> 0.14)
+  simplecov-json (~> 0.2)
+  sinatra (~> 1.4)
+  smartdust-client!
+  webmock (~> 2.1)
+
+BUNDLED WITH
+   1.17.3

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,68 @@
+[![Build Status](https://travis-ci.org/Malinskiy/stf-client.svg?branch=master)](https://travis-ci.org/Malinskiy/stf-client)
+[![Gem](https://img.shields.io/gem/v/stf-client.svg)](https://rubygems.org/gems/stf-client)
+[![Gem](https://img.shields.io/gem/dt/stf-client.svg)](https://rubygems.org/gems/stf-client)
+
+# Smartdust CLI client
+![smartdust-logo-text-2021.png](smartdust-logo-text-2021.png)
+Automation client for connecting to Smartdust Lab devices via adb from a terminal.
+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
+
+Due to it being a console tool, it's very easy to use  it for test automation in a CI\CD pipeline, for example in Jenkins.
+
+Allows for filtering by any device description parameter
+as well as listing all available values of a given parameter
+e.g. all unique names of devices in the lab instance.
+
+## Installation from source
+## Prequisities
+
+- Ruby along with RubyGems installed - versions higher than 3.0.2 are not guaranteed to work
+- This repository cloned
+
+## Installation
+- Enter the directory where the repository is cloned
+- adding "sudo" before the following commands might be needed:
+- ```gem build smartdust-client.gemspec```
+- ```gem install smartdust-client-1.0.0.gem``` (or different version, see output of the previous command)
+
+- Run it by simply entering ```smartdust-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, can also be set by environment variable STF_TOKEN (default: none)
+    -u, --url=arg      - URL to STF, can also be set by environment variable STF_URL (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
+    keys       - Show available keys for filtering
+    values     - Show known values for the filtering key
+    
+ENVIRONMENT VARIABLES
+    STF_TOKEN - Authorization token 
+    STF_URL   - URL to STF 
+```
+- Authorization token can be obtained from the Smartdust Lab web interface in Settings -> Keys
+- When connecting with this tool for the first time, have the Smartdust Lab web interface open
+to accept adding a new ADB key. This is necessary for every new machine that hasn't connected 
+yet to Remote Debug on a given Lab instance.
+
+## 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/smartdust-client

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

data/lib/di.rb

@@ -0,0 +1,86 @@
+require 'dry-container'
+require 'dante'
+require 'stf/system/demonizer'
+
+require 'stf/interactor/start_debug_session_interactor'
+require 'stf/interactor/start_one_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'
+require 'stf/interactor/get_keys_interactor'
+require 'stf/interactor/get_values_interactor'
+require 'stf/interactor/add_adb_public_key'
+require 'stf/validate/uri_validator'
+require 'stf/model/device_enhancer'
+
+class DI
+  class << self
+    def init (opts = {})
+
+      c = Dry::Container.new
+      @@container = c
+
+      # one time object
+      c.register(:dante_runner,
+                 -> {Dante::Runner.new('stf-client')})
+
+      # one time object because dante is one time
+      c.register(:demonizer,
+                 -> do
+                   Stf::Demonizer.new(c[:dante_runner],
+                                 log_path: opts[:log], pid_path: opts[:pid])
+                 end)
+
+      c.register(:stf,
+                 -> {Stf::Client.new(opts[:url], opts[:token])},
+                 memoize: true)
+
+      c.register(:start_debug_session_interactor,
+                 -> {Stf::StartDebugSessionInteractor.new},
+                 memoize: true)
+
+      c.register(:start_one_debug_session_interactor,
+                 -> {Stf::StartOneDebugSessionInteractor.new},
+                 memoize: true)
+
+      c.register(:get_keys_interactor,
+                 -> {Stf::GetKeysInteractor.new},
+                 memoize: true)
+
+      c.register(:get_values_interactor,
+                 -> {Stf::GetValuesInteractor.new},
+                 memoize: true)
+
+      c.register(:stop_all_debug_sessions_interactor,
+                 -> {Stf::StopAllDebugSessionsInteractor.new},
+                 memoize: true)
+
+      c.register(:stop_debug_session_interactor,
+                 -> {Stf::StopDebugSessionInteractor.new},
+                 memoize: true)
+
+      c.register(:remove_all_user_devices_interactor,
+                 -> {Stf::RemoveAllUserDevicesInteractor.new},
+                 memoize: true)
+
+      c.register(:uri_validator,
+                 -> {Stf::URIValidator.new},
+                 memoize: true)
+
+      c.register(:add_adb_public_key_interactor,
+                 -> {Stf::AddAdbPublicKeyInteractor.new},
+                 memoize: true)
+      c.register(:device_enhancer,
+                 -> {Stf::DeviceEnhancer.new},
+                 memoize: true)
+    end
+
+    def [](what)
+      @@container.resolve(what)
+    end
+
+    def container
+      @@container
+    end
+  end
+end

data/lib/stf/client.rb

@@ -0,0 +1,109 @@
+require 'net/http'
+require 'json'
+require 'ostruct'
+
+require 'stf/version'
+require 'stf/log/log'
+
+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 open_tunnel(provider_ip, port)
+      response = execute "/api/v1/tunnel", Net::HTTP::Post, {ipAddress: provider_ip, port: port}.to_json
+      return response
+    end
+
+    def destroy_tunnel(ip, port)
+      response = execute "/api/v1/tunnel", Net::HTTP::Delete, {ipAddress: ip, port: port}.to_json
+      return response.success
+    end
+
+    def stop_debug(serial)
+      response = execute "/api/v1/user/devices/#{serial}/remoteConnect", Net::HTTP::Delete
+      return response.success
+    end
+
+    def check_tunnel(provider_ip, port)
+      response = execute "/api/v1/tunnel/#{provider_ip}/#{port}", Net::HTTP::Get
+      return response
+    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='')
+      return execute_absolute @base_url + relative_url, type, body
+    end
+
+    def execute_absolute(url, type, body='', limit = 10)
+      raise ArgumentError, 'too many HTTP redirects' if limit == 0
+
+      uri          = URI.parse(url)
+      http         = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true if uri.scheme == 'https'
+      request      = type.new(uri, 'Authorization' => "Bearer #{@token}", 'Content-Type' => 'application/json')
+      request.body = body
+      response     = http.request(request)
+
+      case response
+        when Net::HTTPSuccess then
+          json = JSON.parse(response.body, object_class: OpenStruct)
+
+          logger.debug "API returned #{json}"
+        when Net::HTTPRedirection then
+          location = response['location']
+          logger.debug "redirected to #{location}"
+          return execute_absolute(location, type, body, limit - 1)
+        else
+          logger.error "API returned #{response.value}"
+      end
+
+      return json
+    end
+  end
+end

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/get_keys_interactor.rb

@@ -0,0 +1,28 @@
+require 'ADB'
+require 'di'
+
+require 'stf/client'
+require 'stf/log/log'
+require 'stf/model/device'
+
+module Stf
+  class GetKeysInteractor
+    include Log
+    include ADB
+
+    def execute
+      devices = DI[:stf].get_devices
+
+      if devices.nil? || (devices.is_a?(Array) && devices.empty?)
+        logger.info 'No devices connected to STF'
+        return []
+      end
+
+      devices
+          .map {|d| Device.new(d)}
+          .flat_map {|d| d.getKeys}
+          .uniq
+          .sort
+    end
+  end
+end

data/lib/stf/interactor/get_values_interactor.rb

@@ -0,0 +1,29 @@
+require 'di'
+require 'ADB'
+
+require 'stf/client'
+require 'stf/log/log'
+require 'stf/model/device'
+
+module Stf
+  class GetValuesInteractor
+
+    include Log
+    include ADB
+
+    def execute(key)
+      devices = DI[:stf].get_devices
+
+      if devices.nil? || (devices.is_a?(Array) && devices.empty?)
+        logger.info r 'No devices connected to STF'
+        return []
+      end
+
+      devices
+          .map {|d| Device.new(d)}
+          .map {|d| d.getValue(key)}
+          .uniq
+    end
+
+  end
+end

data/lib/stf/interactor/remove_all_user_devices_interactor.rb

@@ -0,0 +1,12 @@
+require 'di'
+
+module Stf
+  class RemoveAllUserDevicesInteractor
+    def execute(opts = {})
+      DI[:demonizer].kill unless opts[:nokill]
+
+      devices = DI[:stf].get_user_devices
+      devices.each {|d| DI[:stf].remove_device d.serial}
+    end
+  end
+end