yi_appium_caps_util 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 61fff7c392146eeb830c6ffd3fcba1ff20c8a006
+  data.tar.gz: 27dac3650436aba685c4c1c434593d24e43f7f25
+SHA512:
+  metadata.gz: 34f3666823814f56f94a73d5b2bd39f51b1b68f8581c64fb9dcedb65d1f82fb325ac5650ebbc306d16f3068813373acd05a37fe6ded2e28740c98d2d3f6e9049
+  data.tar.gz: 1b07d5ca33848277491c94b9b7d0648ddcba5a02a657c680928ed030966bd0d614d381ba52eefda8330137ea2ad0ca7ae1aa1fcbf7fa8ccfb7c37caeac6ca09a

data/bin/yi_appium_caps_util

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require_relative '../lib/yi_appium_caps_util.rb'
+
+action = 'help'
+
+options = {}
+
+OptionParser.new do |opts|
+  opts.banner = "You.i Utility for appium.txt capabilities"
+  puts opts.banner
+
+  opts.on("-u", "--update", "update device ID and IP address") do
+    options[:update] = true
+  end
+  opts.on("-cPLATFORM", "--create PLATFORM", "creates the appium.txt file for specefied platform") do |c|
+    options[:create_caps] = c
+  end
+  opts.on("-fFILE", "--file FILE", "capabilities path and file name (default: ./appium.txt)") do |f|
+    options[:file] = f
+  end
+  opts.on("-h", "--help", "Prints this help") do
+    puts opts
+    exit
+  end
+end.parse!
+
+raise "You should pass -u or -c PLATFORM as an input argument. Type -h for help" if options[:update] == nil and options[:create_caps] == nil
+
+if options[:update]
+  if options[:file]
+    YiAppiumCapsUtil.update(options[:file])
+  else
+    YiAppiumCapsUtil.update
+  end
+end
+
+if options[:create_caps]
+  YiAppiumCapsUtil.create(options[:create_caps].downcase)
+end

data/lib/yi_appium_caps_util.rb

@@ -0,0 +1,196 @@
+require "ipaddress"
+require 'socket'
+require 'toml'
+require 'shellwords'
+
+class YiAppiumCapsUtil
+  class << self
+    public
+    def update (caps_file_name = './appium.txt')
+      raise "appium.txt file is missing" if not File.file?(caps_file_name)
+
+      #Read capability file
+      parsed_data = TOML.load_file(caps_file_name)
+
+      #Update caps
+      output_data = run_update(parsed_data)
+
+      #Save the file if caps have changed
+      if (output_data != parsed_data)
+        puts 'Updating caps'
+        write_caps(caps_file_name, output_data)
+      else
+        puts 'caps have not changed'
+      end
+    end
+
+    def create (platform_name)
+      template = {"caps"=>{"app"=>"",
+      "automationName"=>"YouiEngine",
+      "deviceName"=>"DeviceName",
+      "platformName"=>"#{platform_name}",
+      "youiEngineAppAddress"=>""}}
+
+      File.open("./appium.txt","w") do |f|
+        f.puts(TOML::Generator.new(template).body)
+      end
+      update()
+    end
+
+    private
+
+    # Helper function used in creating ios specefic caps
+    def getTeamID()
+      path = "/Library/MobileDevice/Provisioning Profiles".shellescape
+      `ln -s ~#{path} ./temp`
+      Dir.foreach("./temp/") do |fname|
+        next if fname == '.' or fname == '..'
+        matches = open('./temp/'+fname) { |f| f.each_line.find { |line| line.include?("TeamIdentifier") } }
+        if matches then
+          s = IO.binread('./temp/'+fname)
+          teamID = s.match(/TeamIdentifier(.*)TeamName/m)[1].match(/string(.*)string/m)[1].match(/>(.*)</m)[1]
+          `rm -fr ./temp`
+          return teamID
+        end
+      end
+    end
+
+    def run_update(parsed_data)
+      #Make a copy of the parsed data
+      output_data = Marshal.load(Marshal.dump(parsed_data))
+
+      if parsed_data['caps'] == nil
+        raise '[caps] is missing form appium.txt'
+      else
+        platformName_value = parsed_data['caps']['platformName']
+
+        if platformName_value == nil
+          raise 'platformName is missing from appium.txt'
+        else
+          case platformName_value.downcase
+          when 'android'
+            update_android_caps (output_data)
+          when 'ios'
+            update_ios_caps (output_data)
+          else
+            raise 'platformName: ' + platformName_value + ' is not supported'
+          end
+        end
+      end
+      return output_data
+    end
+
+    def update_android_caps (output_data)
+      puts 'Looking for Android device'
+      #Get the device name
+      new_device_name = `adb devices | grep -w "device" | awk -F'\tdevice' '{print $1}'`
+      #Remove whitespace
+      new_device_name = new_device_name.strip
+      raise "No Devices found / attached. If it is connected then check that it USB debugging is allowed and access to usb debugging for this machine is granted." if new_device_name == ''
+      #Replace value of deviceName
+      output_data['caps']['deviceName'] = new_device_name
+      puts 'Device ID: ' +  new_device_name
+
+      #Get the device's ip address and mask
+      address_String = `adb shell ifconfig wlan0 | grep -oE '((1?[0-9][0-9]?|2[0-4][0-9]|25[0-5])\.){3}(1?[0-9][0-9]?|2[0-4][0-9]|25[0-5])'`
+      raise "Cannot get device details. Check that it USB debugging is authorized." if !$?.success?
+      #Split IP from mask
+      new_address = address_String.split("\n")
+      #Replace value of youiEngineAppAddress
+      output_data['caps']['youiEngineAppAddress'] = new_address[0]
+      puts 'IP address: ' + new_address[0]
+    rescue RuntimeError => ex
+      puts ex.message
+      raise
+    rescue Exception => ex
+      puts "An error of type #{ex.class} happened, message is #{ex.message}"
+      raise
+    end
+
+    def update_ios_caps (output_data)
+      puts 'Looking for iOS device'
+      #Get the device UDID
+      new_udid = %x[idevice_id -l]
+      #Remove whitespace
+      new_udid = new_udid.strip
+
+      raise "No Devices found / attached." if (new_udid == '')
+
+      #Replace value of udid
+      output_data['caps']['udid'] = new_udid
+      puts 'udid: ' + new_udid
+
+      if (output_data['caps']['skipYouiEngineAppAddress'] != nil)
+        puts
+        puts 'Skiping IP check since skipYouiEngineAppAddress is present in appium.txt'
+      else
+        puts 'Searching for IP, this may take a few seconds...'
+
+        # uswish/Test/tools/getIOSIP
+        myAppFolder = File.dirname(__FILE__) + "/../app/"
+        myApp = myAppFolder + "Payload/getIOSIP.app"
+        myZipApp = myAppFolder + "getIOSIP.zip"
+        %x[unzip -o #{myZipApp} -d #{myAppFolder}]
+
+        puts "Launching getIP app"
+        #Launching app and putting (5 seconds of) log into file
+        ipcounter = 1
+        while ipcounter <= 5 do
+          puts "Try \# #{ipcounter}"
+          logs = %x[ios-deploy --justlaunch --bundle #{myApp} & (idevicesyslog) & sleep 7 ; kill $!]
+          File.write('logs.txt', logs)
+          #Getting ip from file
+          ip = %x[grep -Eo "youiEngineAppAddress.*" logs.txt | head -1 | awk '{print $3}'| tr -d '"']
+          #Remove whitespace
+          ip = ip.strip
+          puts 'IP Address: ' + ip
+          if (ip == "")
+            ipcounter +=1
+          else
+            #Found it!  
+            ipcounter = 999
+          end
+        end
+        # Get the device name before deleting the file
+        deviceName = %x[grep -Eo "deviceName =.*" logs.txt| head -1|cut -d " " -f 3-|tr -d '"'|tr -d '\n']
+        platformVersion = %x[grep -Eo "platformVersion =.*" logs.txt| head -1|awk '{print $3}'| tr -d '"'|tr -d '\n']
+        puts 'DeviceName: ' + deviceName
+        puts 'platformVersion: ' + platformVersion
+        File.delete('logs.txt')
+        #Replace value of ip if found
+        if (ip != '') then 
+          output_data['caps']['youiEngineAppAddress'] = ip 
+        else 
+          puts "Update ip address manually"
+        end
+        output_data['caps']['deviceName'] = deviceName
+        output_data['caps']['platformVersion'] = platformVersion
+
+        xcodeBuildVersion = %x[xcodebuild -version | head -1 | awk '{print $2}']
+
+        # Add the xcodeConfigFile in the caps if dealing with iOS 10+
+        if (platformVersion.to_f>=10) then
+          output_data['caps']['xcodeOrgId'] = getTeamID()
+          # NewWDA: Forces uninstall of any existing WebDriverAgent app on device. This provides stability.
+          output_data['caps']['useNewWDA'] = true
+          # Confirm xcode command line tools > xcode 7
+          if (xcodeBuildVersion.to_f<8) then
+            puts "Change to xcode version higher than xcode 7! Current version is: "+xcodeBuildVersion
+          end
+        elsif (xcodeBuildVersion.to_f>8) then
+            puts "Change to xcode version to xcode 7! Current version is: "+xcodeBuildVersion
+        end
+    end
+
+    rescue Exception => ex
+      puts "An error of type #{ex.class} happened, message is #{ex.message}"
+      exit
+    end
+
+    def write_caps(caps_file_name, output_data)
+      #Write the new caps to file
+      doc = TOML::Generator.new(output_data).body
+      File.open(caps_file_name, "w") {|file| file.puts doc }
+    end
+  end
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: yi_appium_caps_util
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Simon Granger
+- Mohamed Maamoun
+- Tamimi Ahmad
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-10 00:00:00.000000000 Z
+dependencies: []
+description: 'Updates real device caps: device ID and IP for Android & iOS'
+email: simon.granger@youi.tv
+executables:
+- yi_appium_caps_util
+extensions: []
+extra_rdoc_files: []
+files:
+- app/getIOSIP.zip
+- bin/yi_appium_caps_util
+- lib/yi_appium_caps_util.rb
+homepage: https://github.com/YOU-i-Labs/yi_appium_caps_util
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Updates your appium.txt capabilities
+test_files: []