scoutui 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 938077e990f3023a4aa9e4dafd7e8ae5bbc3dd3d
-  data.tar.gz: a5e065f72639d6f9776a82e821dfd9417868ea1e
+  metadata.gz: a30ec1b576da5316bdcab5d783e012b38162c8ff
+  data.tar.gz: 0fa6ec360deb548399164ea9fd1ecea9726b79a1
 SHA512:
-  metadata.gz: e0e95dc05d1f4544bdd6b50ef04e7d98c86edfe9e9ddf24e6e954a6613ceffe7a744bba48bfefbe8de49e95da93ba1de720275a89adec347612a690318090907
-  data.tar.gz: 765e55a3126b0782041d23fe47ea2d9e3708388f64f2b0c633f177c0a530d5d640d8d18d37d5f23989168013183eed7fc73cbb322effb47e5b89bc000699703e
+  metadata.gz: 4115dda6300e3d3ca932060c4ee560f6753db16ccc1adefaae70a3eb4ee40abda227a4d02b3964f712b3cdcefadf0171183d7bfbb1af962ff3d9fc5cc0250a8d
+  data.tar.gz: 8380d47fae11e943e80b162fa6338862c05a7170cbcc9481b14761bc21055e94e27ddf4557999b3cb0a1c722c83eaf41e9b7ba3004419c22aaae28c17dcc3ead

data/lib/scoutui/base/q_applitools.rb

@@ -1,4 +1,4 @@
-require 'rubygems'
+
 require 'eyes_selenium'
 require 'httparty'
 

data/lib/scoutui/base/q_browser.rb

@@ -1,4 +1,4 @@
-require 'rubygems'
+
 require 'eyes_selenium'
 require 'selenium-webdriver'
 

data/lib/scoutui/base/{test_runner.rb → test_scout.rb}

@@ -3,17 +3,16 @@
 module Scoutui::Base
 
 
-  class TestRunner
-    attr_reader :drv    # Selenium Webdriver
-    attr_reader :eyes   # Applitools::Eyes
-    attr_reader :driver  # Applitools::Eyes Driver
+  class TestScout
     attr_reader :context
     attr_reader :test_settings  # { host, localization, dut }
     attr_reader :userRecord
     attr_reader :eyesRecord   # {'title' , 'app'}
+    attr_reader :eyeScout
+    attr_reader :results
 
     def initialize(_context)
-
+      @result = nil
       @test_settings=nil
       @eyesRecord=nil
 
@@ -27,19 +26,31 @@ module Scoutui::Base
         @userRecord = accounts.getUserRecord(@test_settings['user'])
 
         @eyesRecord = @test_settings['eyes']
+      end
+
+    end
 
+
+    def start
+      if hasSettings?
+        dumpSettings if Scoutui::Utils::TestUtils.instance.isDebug?
+        run()
       end
+    end
 
+    def stop
+      # TBD
     end
 
+    def report
 
+    end
 
     def hasSettings?
       Scoutui::Utils::TestUtils.instance.hasTestConfig?
     end
 
     def dumpSettings()
-      puts __FILE__ + (__LINE__).to_s + " dumpSettings()"
       puts '-' * 72
       puts @test_settings
 
@@ -49,68 +60,59 @@ module Scoutui::Base
     end
 
   def teardown()
-    @drv.quit()
+    @eyeScout.teardown()
   end
 
     def setup()
-      browserType = Scoutui::Utils::TestUtils.instance.getBrowserType()
-      puts __FILE__ + (__LINE__).to_s + " setup() : #{browserType}"
 
-      begin
-        @drv=Selenium::WebDriver.for browserType.to_sym
-        @eyes=Scoutui::Eyes::EyeFactory.instance.create(true)
-        puts __FILE__ + (__LINE__).to_s + " eyes => #{eyes}"
+      if Scoutui::Utils::TestUtils.instance.isDebug?
+        puts __FILE__ + (__LINE__).to_s + " eyes cfg => #{@eyesRecord}"
+        puts __FILE__ + (__LINE__).to_s + " title => " + Scoutui::Base::UserVars.instance.getVar('eyes.title')
+        puts __FILE__ + (__LINE__).to_s + " app => " + Scoutui::Base::UserVars.instance.getVar('eyes.app')
+      end
 
-        @driver = @eyes.open(
-            app_name: @eyesRecord['app'],
-            test_name: @eyesRecord['title'],
-            viewport_size: {width: 1024, height: 768},
-            #    viewport_size: {width: 800, height: 600},
-            driver: @drv)
+      begin
 
+        eyeScout=Scoutui::Eyes::EyeFactory.instance.createScout()
       rescue => ex
         puts ex.backtrace
       end
-      @drv
+
+      eyeScout
     end
 
 
 
-    def goto(url)
-      @drv.navigate().to(url)
+    def goto(url=nil)
+      @eyeScout.navigate(url) if !url.nil?
     end
 
     def snapPage(tag)
-      @eyes.check_window(tag)  if Scoutui::Utils::TestUtils.instance.eyesEnabled?
+      @eyeScout.check_window(tag)
     end
 
 
     def run()
       puts __FILE__ + (__LINE__).to_s + " run()" if Scoutui::Utils::TestUtils.instance.isDebug?
 
-      my_driver=nil
-
       begin
 
-        app = Scoutui::Base::AppModel.new()
-
-        setup()    # Browser is created
+        @eyeScout=setup()    # Browser is created
 
         # Navigate to the specified host
         goto(Scoutui::Base::UserVars.instance.get(:host))
 
         snapPage('Landing Page')
 
-        Scoutui::Base::VisualTestFramework.processFile(@drv, @eyes, @test_settings)
+        Scoutui::Base::VisualTestFramework.processFile(@eyeScout, @test_settings)
 
         teardown()
 
       rescue => ex
         puts ex.backtrace
       ensure
-        puts __FILE__ + (__LINE__ ).to_s + " Close Eyes"
-        eyes.close(false)
-        eyes.abort_if_not_closed if !eyes.nil?
+        puts __FILE__ + (__LINE__ ).to_s + " Close Eyes" if Scoutui::Utils::TestUtils.instance.isDebug?
+        @eyeScout.closeOut()
       end
 
     end

data/lib/scoutui/base/user_vars.rb

@@ -1,4 +1,3 @@
-require 'rubygems'
 require 'singleton'
 
 module Scoutui::Base
@@ -10,6 +9,7 @@ module Scoutui::Base
 
     def initialize
       @globals={
+          :browser => 'chrome',
           :userid => nil,
           :password => nil,
           :host => nil,
@@ -17,6 +17,10 @@ module Scoutui::Base
       }
     end
 
+    def getBrowserType()
+      @globals[:browser].to_sym
+    end
+
     def getHost()
       @globals[:host].to_s
     end
@@ -43,6 +47,10 @@ module Scoutui::Base
       v
     end
 
+    def getVar(k)
+      @globals[k].to_s
+    end
+
     def setVar(k, v)
       @globals[k]=v
       v

data/lib/scoutui/base/visual_test_framework.rb

@@ -1,8 +1,4 @@
-require 'rubygems'
 
-##
-# 1. q_applitools
-# 2. q_accounts
 
 module Scoutui::Base
 
@@ -64,12 +60,14 @@ module Scoutui::Base
 
 
     # Scoutui::Base::VisualTestFramework.processFile(@drv, @eyes, @test_settings['host'], @test_settings['dut'])
-    def self.processFile(my_driver, eyes, test_settings)
+    def self.processFile(eyeScout, test_settings)
+
+      my_driver = eyeScout.drv()
 
       baseUrl = Scoutui::Base::UserVars.instance.getHost()
       datafile = test_settings['dut']
 
-      puts __FILE__ + (__LINE__).to_s + " processFile(#{my_driver}, #{eyes}, #{baseUrl}, #{datafile})" if Scoutui::Utils::TestUtils.instance.isDebug?
+      puts __FILE__ + (__LINE__).to_s + " processFile(#{eyeScout}, #{baseUrl}, #{datafile})" if Scoutui::Utils::TestUtils.instance.isDebug?
 
       i=0
       dut_dupes = YAML.load_stream File.read(datafile)
@@ -127,15 +125,15 @@ module Scoutui::Base
             obj = Scoutui::Base::QBrowser.getObject(my_driver, xpath)
 
             if obj.nil?
-              puts __FILE__ + (__LINE__).to_s + " NOT FOUND : #{link_name} with xpath #{xpath}"
+              puts " NOT FOUND : #{link_name} with xpath #{xpath}"
             else
-              puts __FILE__ + (__LINE__).to_s + " link object(#{link_name} with xpath #{xpath}=> #{obj.displayed?}"  if Scoutui::Utils::TestUtils.instance.isDebug?
+              puts " link object(#{link_name} with xpath #{xpath}=> #{obj.displayed?}"  if Scoutui::Utils::TestUtils.instance.isDebug?
             end
 
           end
         end
 
-        eyes.check_window(name)  if Scoutui::Utils::TestUtils.instance.eyesEnabled?
+        eyeScout.check_window(name)
 
         puts "\to links : #{e['page']['links'].class.to_s}"  if Scoutui::Utils::TestUtils.instance.isDebug?
 
@@ -150,7 +148,7 @@ module Scoutui::Base
             puts __FILE__ + (__LINE__).to_s + " [click]: link object => #{obj.to_s}"  if Scoutui::Utils::TestUtils.instance.isDebug?
             obj.click
 
-            eyes.check_window(link_name)  if Scoutui::Utils::TestUtils.instance.eyesEnabled?
+            eyeScout.check_window(link_name)
           end
         end
 

data/lib/scoutui/eyes/eye_factory.rb

@@ -0,0 +1,64 @@
+
+require 'singleton'
+
+
+module Scoutui::Eyes
+
+
+  class EyeFactory
+    include Singleton
+
+    attr_accessor :eyesList
+
+    def initialize
+      @eyesList=Array.new()
+    end
+
+    def createScout()
+      browserType = Scoutui::Base::UserVars.instance.getBrowserType()
+      eyeScout = EyeScout.new(browserType)
+    end
+
+    def createEyes()
+
+      use_eyes = Scoutui::Utils::TestUtils.instance.eyesEnabled?
+
+      puts __FILE__ + (__LINE__).to_s + " create(#{use_eyes})" if Scoutui::Utils::TestUtils.instance.isDebug?
+      eyes=nil
+
+      if use_eyes
+
+        licFile=Scoutui::Utils::TestUtils.instance.getLicenseFile()
+
+        valid_json=false
+        begin
+          jFile = File.read(licFile)
+          jLicense=jsonData=JSON.parse(jFile)
+          valid_json=true
+        rescue => ex
+          ;
+        end
+
+
+        if valid_json
+          eyes=Applitools::Eyes.new()
+          eyes.api_key = jLicense['api_key'].to_s
+          eyes.force_fullpage_screenshot = true
+
+          match_level = Scoutui::Base::UserVars.instance.getVar('eyes.match_level')
+
+          eyes.match_level = Applitools::Eyes::MATCH_LEVEL[match_level.to_sym]
+        end
+
+      end
+
+    #  eyes
+      @eyesList << eyes
+      @eyesList.last()
+    end
+
+  end
+
+
+
+end

data/lib/scoutui/eyes/eye_scout.rb

@@ -0,0 +1,77 @@
+require 'eyes_selenium'
+
+module Scoutui::Eyes
+
+
+  class EyeScout
+
+    attr_accessor :drv
+    attr_accessor :eyes
+
+    def teardown()
+      @drv.quit()
+    end
+
+    def navigate(url)
+      @drv.navigate().to(url)
+    end
+
+    def drv()
+      @drv
+    end
+
+    def eyes()
+      @eyes
+    end
+
+
+    def closeOut()
+      eyes().close(false)
+      eyes().abort_if_not_closed if !eyes().nil?
+    end
+
+    def check_window(tag)
+      puts __FILE__ + (__LINE__).to_s + " check_window(#{tag.to_s})"  if Scoutui::Utils::TestUtils.instance.isDebug?
+
+      return if !Scoutui::Utils::TestUtils.instance.eyesEnabled?
+
+      eyes().check_window(tag.to_s)
+    end
+
+    def initialize(browserType)
+      browserType = Scoutui::Base::UserVars.instance.getBrowserType()
+
+      if Scoutui::Utils::TestUtils.instance.isDebug?
+        puts __FILE__ + (__LINE__).to_s + " setup() : #{browserType}"
+        puts __FILE__ + (__LINE__).to_s + " eyes cfg => #{@eyesRecord}"
+        puts __FILE__ + (__LINE__).to_s + " title => " + Scoutui::Base::UserVars.instance.getVar('eyes.title')
+        puts __FILE__ + (__LINE__).to_s + " app => " + Scoutui::Base::UserVars.instance.getVar('eyes.app')
+        puts __FILE__ + (__LINE__).to_s + " match_level => " + Scoutui::Base::UserVars.instance.getVar('eyes.match_level')
+      end
+
+      begin
+        @drv=Selenium::WebDriver.for browserType.to_sym
+        @eyes=Scoutui::Eyes::EyeFactory.instance.createEyes()
+
+        puts __FILE__ + (__LINE__).to_s + " eyes => #{eyes}" if Scoutui::Utils::TestUtils.instance.isDebug?
+
+        @driver = @eyes.open(
+            app_name:  Scoutui::Base::UserVars.instance.getVar('eyes.app'),   # @eyesRecord['app'],
+            test_name: Scoutui::Base::UserVars.instance.getVar('eyes.title'), # @eyesRecord['title'],
+            viewport_size: {width: 1024, height: 768},
+            #    viewport_size: {width: 800, height: 600},
+            driver: @drv)
+
+      rescue => ex
+        puts ex.backtrace
+      end
+
+    end
+
+
+  end
+
+
+
+
+end

data/lib/scoutui/utils/utils.rb

@@ -1,4 +1,4 @@
-require 'rubygems'
+
 require 'singleton'
 require 'pp'
 require 'optparse'
@@ -21,12 +21,14 @@ module Scoutui::Utils
       end
 
       @options[:enable_eyes]=true
+      @options[:match_level]='strict'
     end
 
     def parseCommandLine()
-      @options = {}
+ #     @options = {}
+
       OptionParser.new do |opt|
-        opt.on('-f', '--file TESTFILE') { |o|
+        opt.on('-c', '--config TESTFILE') { |o|
             if !o.nil?
               @options[:json_config_file]=o
 
@@ -37,6 +39,9 @@ module Scoutui::Utils
         opt.on('-d', '--debug Bool')    { |o| @options[:debug] = (o.to_s.downcase=='true')}
         opt.on('-h', '--host HOST')     { |o| @options[:host] = o }
         opt.on('-l', '--lang LOCAL')    { |o| @options[:loc] = o }
+        opt.on('-k', '--key EyesLicense') { |o| options[:license_file] = o }
+        opt.on('-a', '--app AppName')   { |o| @options[:app] = o }
+        opt.on('--match [TYPE]', [:layout2, :layout, :strict, :exact, :content], "Select match level (layout, strict, exact, content)") { |o| @options[:match_level] = o }
         opt.on('-t', '--title TITLE')   { |o| @options[:title] = o }
         opt.on('-b', '--browser BROWSER') { |o| @options[:browser] = o }
         opt.on('-u', '--user USER_ID')  { |o|
@@ -45,6 +50,8 @@ module Scoutui::Utils
         }
         opt.on('-p', '--password PASSWORD') { |o| @options[:password] = o }
         opt.on('-e', '--eyes Boolean') { |o|
+          @options[:enabled_eyes]=false
+
           if !o.nil?
             if !o.match(/true|1/i).nil?
               @options[:enable_eyes]=true
@@ -55,16 +62,19 @@ module Scoutui::Utils
         }
       end.parse!
 
-      puts __FILE__ + (__LINE__).to_s +  "   " + @options.to_s
-      puts "Test file => #{@options[:test_file]}"
-      puts "Host      => #{@options[:host]}"
-      puts "Loc       => #{@options[:loc]}"
-      puts "Title     => #{@options[:title]}"
-      puts "Browser   => #{@options[:browser]}"
-      puts "UserID    => #{@options[:userid]}"
-      puts "Password  => #{@options[:password]}"
-      puts "Eyes      => #{@options[:enable_eyes]}"
-      puts "Test Cfg  => #{@options[:json_config_file]}"
+      if Scoutui::Utils::TestUtils.instance.isDebug?
+        puts __FILE__ + (__LINE__).to_s +  "   " + @options.to_s
+        puts "Test file => #{@options[:test_file]}"
+        puts "Host      => #{@options[:host]}"
+        puts "Loc       => #{@options[:loc]}"
+        puts "Title     => #{@options[:title]}"
+        puts "Browser   => #{@options[:browser]}"
+        puts "UserID    => #{@options[:userid]}"
+        puts "Password  => #{@options[:password]}"
+        puts "Eyes      => #{@options[:enable_eyes]}"
+        puts "Test Cfg  => #{@options[:json_config_file]}"
+        puts "Match Level => #{@options[:match_level]}"
+      end
 
       @options
     end
@@ -77,6 +87,10 @@ module Scoutui::Utils
       @options[:enable_eyes]
     end
 
+    def getLicenseFile()
+      @options[:license_file].to_s
+    end
+
     def getBrowser()
       getBrowserType()
     end
@@ -95,27 +109,53 @@ module Scoutui::Utils
     # Returns JSON file contents/format
     def getTestSettings()
 
-      [:host, :userid, :password].each do |k|
+      [:browser, :host, :userid, :password].each do |k|
+
+        puts __FILE__ + (__LINE__).to_s + " opt[test_config].has_key(#{k.to_s}) => #{@options[:test_config].has_key?(k.to_s)}" if Scoutui::Utils::TestUtils.instance.isDebug?
 
-        puts __FILE__ + (__LINE__).to_s + " opt[test_config].has_key(#{k.to_s}) => #{@options[:test_config].has_key?(k.to_s)}"
         if @options[:test_config].has_key?(k.to_s)
 
-          puts __FILE__ + (__LINE__).to_s + " opts[#{k}].nil => #{@options[k].nil?}"
+          puts __FILE__ + (__LINE__).to_s + " opts[#{k}].nil => #{@options[k].nil?}" if Scoutui::Utils::TestUtils.instance.isDebug?
           # Ensure commnand line takes precedence
           if !@options[k].nil?
-            puts __FILE__ + (__LINE__).to_s + " opt[#{k.to_s} => #{@options[k].to_s}"
+            puts __FILE__ + (__LINE__).to_s + " opt[#{k.to_s} => #{@options[k].to_s}"  if Scoutui::Utils::TestUtils.instance.isDebug?
             Scoutui::Base::UserVars.instance.set(k, @options[k].to_s)
           else
-
             Scoutui::Base::UserVars.instance.set(k, @options[:test_config][k.to_s].to_s)
           end
 
         end
       end
 
+      puts __FILE__ + (__LINE__).to_s + " test_config => #{@options[:test_config]}"  if Scoutui::Utils::TestUtils.instance.isDebug?
+
+      ['match_level', 'title', 'app'].each do |k|
+
+        _v=nil
+
+        if @options[:test_config].has_key?('eyes')
+          _v=@options[:test_config]['eyes'][k].to_s
+        end
+
+        if !@options[k.to_sym].nil?
+          _v=@options[k.to_sym].to_s
+        end
+
+        if Scoutui::Utils::TestUtils.instance.isDebug?
+          puts __FILE__ + (__LINE__).to_s + " #{k} => #{_v}"
+        end
+
+        Scoutui::Base::UserVars.instance.set('eyes.' + k, _v)
+
+      end
+
       @options[:test_config]
     end
 
+    def match_level()
+      @options[:match_level]
+    end
+
     def getUserId()
       @options[:userid]
     end
@@ -143,6 +183,9 @@ module Scoutui::Utils
       loc()
     end
 
+    def appName()
+      @options[:app].to_s
+    end
 
     def title()
       @options[:title]

data/lib/scoutui/version.rb

@@ -1,3 +1,3 @@
 module Scoutui
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/scoutui.rb

@@ -1,12 +1,8 @@
-#require "scoutui/version"
-#require "scoutui/utils"
-
 
 module Scoutui
-  # Your code goes here...
+
   ROOT_DIR = File.join(File.dirname(File.expand_path(__FILE__)), 'scoutui').freeze
 
   Dir["#{ROOT_DIR}/*.rb"].each { |f| require f }
   Dir["#{ROOT_DIR}/**/*.rb"].each { |f| require f }
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scoutui
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Peter Kim
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-30 00:00:00.000000000 Z
+date: 2015-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -127,14 +127,15 @@ files:
 - bin/console
 - bin/setup
 - lib/scoutui.rb
-- lib/scoutui/base/app_model.rb
 - lib/scoutui/base/q_accounts.rb
 - lib/scoutui/base/q_applitools.rb
 - lib/scoutui/base/q_browser.rb
-- lib/scoutui/base/test_runner.rb
+- lib/scoutui/base/test_scout.rb
 - lib/scoutui/base/test_settings.rb
 - lib/scoutui/base/user_vars.rb
 - lib/scoutui/base/visual_test_framework.rb
+- lib/scoutui/eyes/eye_factory.rb
+- lib/scoutui/eyes/eye_scout.rb
 - lib/scoutui/navigator.rb
 - lib/scoutui/utils/utils.rb
 - lib/scoutui/version.rb

data/lib/scoutui/base/app_model.rb

@@ -1,31 +0,0 @@
-require 'rubygems'
-#require 'selenium-webdriver'
-
-module Scoutui::Base
-
-  class AppModel
-
-    attr_accessor :drv
-    attr_accessor :pages
-
-    def initialize()
-      @drv=nil
-      @pages={}
-    end
-
-    def getPage(n)
-      @pages[n]
-    end
-
-    def addPage(n, p)
-      @pages[n]=p
-    end
-
-    def setup()
-    end
-
-  end
-
-
-
-end