scoutui 2.0.0 → 2.0.1

data/examples/ex2/page_model.json

@@ -0,0 +1,28 @@
+{
+    "home": {
+        "cars4sale": {
+            "locator": "//a[text()='Find Cars for Sale']",
+            "visible_when": "always"
+        },
+        "whyCarMax": {
+            "locator": "//*[@id='header']//a[text()='Why CarMax']",
+            "visible_when": "always"
+        },
+
+        "sign_in": {
+            "locator": "//input[text()='Sign in']",
+            "visible_when": "always"
+        }
+    },
+
+    "main_nav": {
+        "search_input": "//input[@id='search']",
+        "search_btn": "//a[@id='search-btn']"
+    },
+
+
+    "search": {
+        "header": "//title"
+    }
+}
+

data/examples/ex2/test-example.sh

@@ -0,0 +1,39 @@
+#/bin/bash
+##
+# Description
+#   This test script overrides the provided title and appname (if provided in the test config. file)
+#
+# Set the APPLITOOLS_API_KEY environment variable with your key.
+#
+#          export APPLITOOLS_API_KEY="__YOUR_KEY_HERE__"
+##
+SCOUTUI_BIN=../../bin/scoutui_driver.rb
+# Specify browser under test  (chrome, firefox, ie, safari)
+BUT=firefox
+
+# Specify the title and appName needed by Applitools
+## NOTE:  If the test configuration file specifies the title and app, it is superseded by the
+##        command line options.
+TITLE=DEMO-CarMax
+APP=Oct2015
+
+# Specify the test configuration file
+TEST_CFG="./test.config.json"
+
+##
+# content
+# strict
+# exact
+# layyout
+##
+MATCH_TYPE="layout"
+
+EYES=--eyes
+EYES=
+
+
+# The following command line parameters will override provided title and appName (if provided in test config file)
+$SCOUTUI_BIN  --config $TEST_CFG  --browser $BUT $EYES --app $APP --title $TITLE  --match $MATCH_TYPE --pagemodel ./page_model.json  --debug
+
+# The following
+# $SCOUTUI_BIN --config $TEST_CFG  --eyes  --match $MATCH_TYPE  --browser $BUT

data/examples/ex2/test.config.json

@@ -0,0 +1,25 @@
+{
+  "Project": "Example",
+  "Version": "1.00",
+  "Description": "Example - CarMax",
+
+  "browser": "chrome",
+
+  "eyes": {
+    "title": "Example - CarMax",
+    "viewport": "1024x718",
+    "app": "10-16"
+  },
+
+  "host": "http://www.carmax.com",
+  "dut": "./commands.yml",
+
+
+  "user_vars": {
+    "Search_Me": "BMW M3",
+    "View_Tickets_Link": "page(main_nav).get(ViewTicketsLink)",
+    "WhyCarMax": "page(home).get(whyCarMax)"
+  }
+
+}
+

data/lib/scoutui.rb

@@ -0,0 +1,8 @@
+
+module Scoutui
+
+  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

data/lib/scoutui/appmodel/q_model.rb

@@ -0,0 +1,82 @@
+
+
+module Scoutui::ApplicationModel
+
+  class QModel
+    attr_accessor :_file
+    attr_accessor :app_model
+
+    def initialize(f=nil)
+
+      if !f.nil?
+        @_file=f
+        loadPages(@_file)
+      end
+
+    end
+
+    def getAppModel()
+      @app_model
+    end
+
+    def loadPages(jlist)
+
+      json_list=[]
+      if jlist.kind_of?(String)
+        json_list << jlist
+      else
+        json_list=jlist
+      end
+
+      jsonData={}
+      json_list.each  { |f|
+        Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " JSON.parse(#{f})"
+
+        begin
+          data_hash = JSON.parse File.read(f)
+          jsonData.merge!(data_hash)
+        rescue JSON::ParserError
+          Scoutui::Logger::LogMgr.instance.fatal "raise JSON::ParseError - #{f.to_s}"
+          raise "JSONLoadError"
+        end
+
+      }
+      Scoutui::Logger::LogMgr.instance.debug "merged jsonData => " + jsonData.to_json
+      @app_model = jsonData
+    end
+
+
+    # getPageElement("page(login).get(login_form).get(button)")
+    def getPageElement(s)
+      Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " getPageElement(#{s})"
+      hit=@app_model
+
+      nodes = s.split(/\./)
+
+      nodes.each { |elt|
+        getter = elt.split(/\(/)[0]
+        _obj = elt.match(/\((.*)\)/)[1]
+
+        Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " getter : #{getter}  obj: #{_obj}" if Scoutui::Utils::TestUtils.instance.isDebug?
+
+        if getter.downcase.match(/(page|pg)/)
+          Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " -- process page --"  if Scoutui::Utils::TestUtils.instance.isDebug?
+          hit=@app_model[_obj]
+        elsif getter.downcase=='get'
+          hit=hit[_obj]
+        else
+          Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " getter : #{getter} is unknown."
+          return nil
+        end
+        Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " HIT => #{hit}" if Scoutui::Utils::TestUtils.instance.isDebug?
+      }
+
+      hit
+
+    end
+
+  end
+
+
+
+end

data/lib/scoutui/base/assertions.rb

@@ -0,0 +1,62 @@
+
+require 'singleton'
+
+
+module Scoutui::Base
+
+
+  class Assertions
+    include Singleton
+
+    attr_accessor :drv
+
+
+    def setDriver(_drv)
+      @drv=_drv
+    end
+
+    # { "visible_when" => "always" }
+    def visible_when_always(_k, _v, _obj=nil)
+
+      _locator=nil
+      rc=false
+      if _v.has_key?('locator')
+        _locator = _v['locator'].to_s
+      end
+
+      if !_locator.nil? &&  _v.has_key?('visible_when') && _v['visible_when'].match(/always/i)
+          Scoutui::Logger::LogMgr.instance.info "Verify #{_k} - #{_locator} always visible - #{!_obj.nil?.to_s}"
+          Testmgr::TestReport.instance.getReq('UI').get_child('visible_when').add(!_obj.nil?, "Verify #{_k} - #{_locator} always visible")
+          rc=true
+      end
+      rc
+    end
+
+    # { "visible_when" => true }
+    def visible_when_skip(_k, _v)
+
+      Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " visible_when_visible : #{_v.to_s}" if Scoutui::Utils::TestUtils.instance.isDebug?
+      rc=false
+
+      if _v.is_a?(Hash) && _v.has_key?('visible_when') && _v['visible_when'].match(/skip/i)
+        rc=true
+
+        Scoutui::Logger::LogMgr.instance.asserts.info "Skip verify #{_k.to_s} - skipped"
+        Testmgr::TestReport.instance.getReq('UI').get_child('visible_when').add(nil, "Skip verify #{_k.to_s}")
+      end
+
+      rc
+    end
+
+    # _a : Hash
+    # o locator => String
+    # o visible_when => Hash
+    def visible_when_visible(_a)
+
+    end
+
+  end
+
+
+
+end

data/lib/scoutui/base/q_accounts.rb

@@ -0,0 +1,52 @@
+
+module Scoutui::Base
+
+  class QAccounts
+
+
+    attr_accessor :dut
+    attr_accessor :accounts
+
+    def initialize(f)
+
+      if !f.nil?
+        @accounts = YAML.load_stream File.read(f)
+      end
+
+    end
+
+    def _find(id, attr)
+      hit = @accounts.find { |h| h['account']['loginid'] == id }
+      if !hit.nil?
+        id=hit['account'][attr]
+      end
+      id
+    end
+
+    def getUserRecord(u)
+      hit=nil
+
+      userid=getUserId(u)
+      if !userid.nil?
+        hit={'userid' => getUserId(u), 'password' => getPassword(u) }
+      end
+
+      hit
+    end
+
+    def getUserId(userid)
+      id=nil
+      hit = @accounts.find { |h| h['account']['loginid'].to_s == userid.to_s }
+      if !hit.nil?
+        id=hit['account']['loginid']
+      end
+      id
+    end
+
+    def getPassword(u)
+      _find(u, 'password')
+    end
+
+  end
+
+end

data/lib/scoutui/base/q_applitools.rb

@@ -0,0 +1,127 @@
+
+require 'eyes_selenium'
+require 'httparty'
+
+
+module Scoutui::Base
+
+  class QApplitools
+
+
+    attr_accessor :eyes
+
+    def initialize
+      @eyes=nil
+    end
+
+
+    def setup
+      @eyes = Applitools::Eyes.new
+      # This is your api key, make sure you use it in all your tests.
+      @eyes.api_key = "API_KEY"
+
+      # Get a selenium web driver object.
+      @driver = Selenium::WebDriver.for :chrome
+      #Eyes.log_handler = Logger.new(STDOUT)
+    end
+
+    # Called after every test method runs. Can be used to tear
+    # down fixtures information.
+
+    def teardown
+      @eyes.abort_if_not_closed
+    end
+
+    def report(results)
+      download_diffs(results, "VIEW_KEY", '/tmp/diff_images')
+    end
+
+    # Fake test
+    def xxxtestit
+      #@eyes.baseline_name='my_test_name'
+      wrapped_driver = @eyes.open(
+          app_name: 'Applitools website',
+          test_name: 'Example test',
+          viewport_size: {width: 900, height: 650},
+          driver: @driver)
+      wrapped_driver.get 'https://www.applitools.com'
+      # Visual validation point #1
+      @eyes.check_window('Main Page')
+
+      wrapped_driver.find_element(:css, ".features>a").click
+      # Visual validation point #2
+      @eyes.check_window('Features Page')
+      results = @eyes.close(false)
+
+      download_diffs(results, "VIEW_KEY", './diff_images')
+      print_results(results, "VIEW_KEY")
+    end
+
+    def print_results(results, view_key)
+      if results.is_passed
+        print "Your test was passed!\n"
+      elsif results.is_new
+        print "Created new baseline, this is a new test or/and new configuration!"
+      else
+        print "Your test was failed!\n"
+        print "#{results.mismatches} out of #{results.steps} steps failed \n"
+        print "Here are the failed steps:\n"
+        session_id = get_session_id(results.url)
+        diff_urls = get_diff_urls(session_id, view_key)
+        diff_urls.each do |index, diff_url|
+          print "Step #{index} --> #{diff_url} \n"
+        end
+        print "For more details please go to #{results.url} to review the differences! \n"
+      end
+    end
+
+    def download_diffs(results, view_key, destination)
+      Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " download_diffs()"
+
+      session_id = get_session_id(results.url)
+      diff_urls = get_diff_urls(session_id, view_key)
+      download_images(diff_urls, destination)
+    end
+
+    def download_images(diff_urls, destination)
+      diff_urls.each do |index, url|
+        File.open("#{destination}/step_#{index}_diff.png", 'wb') do |file|
+          file.write HTTParty.get(url)
+        end
+      end
+    end
+
+    def get_diff_urls(session_id, view_key)
+      info = "https://eyes.applitools.com/api/sessions/#{session_id}/?ApiKey=#{view_key}&format=json"
+      diff_template = "https://eyes.applitools.com/api/sessions/#{session_id}/steps/%s/diff?ApiKey=#{view_key}"
+      diff_urls = Hash.new
+
+      Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " info => #{info}"
+      response = HTTParty.get(info)
+
+      begin
+        data = JSON.parse(response.body)
+        index = 1
+        data['actualOutput'].each do |elem|
+          if (elem['isMatching'] == false)
+            diff_urls[index] = diff_template % [index]
+            index+=1
+          end
+        end
+
+        diff_urls
+
+      rescue JSON::ParserError
+        ;
+      end
+
+    end
+
+    def get_session_id(url)
+      /sessions\/(?<session>\d+)/.match(url)[1]
+    end
+
+  end
+
+
+end

data/lib/scoutui/base/q_browser.rb

@@ -0,0 +1,185 @@
+
+require 'eyes_selenium'
+require 'selenium-webdriver'
+
+module Scoutui::Base
+
+
+  class QBrowser
+
+    attr_accessor :driver
+
+    def initialize()
+    end
+
+    def self.wait_for_displayed(drv, locator, _timeout=30)
+      Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " wait_for_displayed(#{xpath}"
+      rc=nil
+      begin
+        Selenium::WebDriver::Wait.new(timeout: _timeout).until { rc=drv.find_element(:xpath => xpath).displayed? }
+      rescue => ex
+        ;
+      end
+      rc
+    end
+
+    def self.wait_for_exist(drv, xpath, _timeout=30)
+      Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " wait_for_exist(#{xpath}"
+      rc=nil
+      begin
+        Selenium::WebDriver::Wait.new(timeout: _timeout).until { drv.find_element(:xpath => xpath) }
+        rc=drv.find_element(:xpath => xpath)
+      rescue => ex
+        ;
+      end
+      rc
+    end
+
+    def self.getFirstObject(drv, _locator, _timeout=30)
+
+      Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " getFirstObject(#{_locator})" if Scoutui::Utils::TestUtils.instance.isDebug?
+      rc=nil
+      locator=_locator
+
+      begin
+        locateBy=:xpath
+
+        if _locator.match(/^css\=/i)
+          locateBy = :css
+          locator = _locator.match(/css\=(.*)/i)[1].to_s
+        elsif _locator.match(/^#/i)
+          locateBy = :css
+        end
+
+        Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " locator => #{locator.to_s}"  if Scoutui::Utils::TestUtils.instance.isDebug?
+        Selenium::WebDriver::Wait.new(timeout: _timeout).until { drv.find_elements(locateBy => locator).size > 0 }
+        rc=drv.find_elements(locateBy => locator)[0]
+      rescue => ex
+        Scoutui::Logger::LogMgr.instance.debug "getFirstObject.Exception: #{locator.to_s} - #{ex}"
+        ;
+      end
+
+      Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " #{_locator} => #{rc}"
+      rc
+    end
+
+    # http://stackoverflow.com/questions/15164742/combining-implicit-wait-and-explicit-wait-together-results-in-unexpected-wait-ti#answer-15174978
+    def self.getObject(drv, obj, _timeout=30)
+      Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " getObject(#{obj})  class:#{obj.class.to_s}   hash : #{obj.is_a?(Hash)}" if Scoutui::Utils::TestUtils.instance.isDebug?
+      rc=nil
+      visible_when=nil
+      locator=obj
+      locateBy=:xpath
+      locator=nil
+
+      begin
+
+        if obj.is_a?(Hash)
+
+
+          if obj.has_key?('visible_when')
+            visible_when=!obj['visible_when'].match(/always/i).nil?
+          end
+
+          locator = obj['locator'].to_s
+
+
+        elsif !obj.match(/^page\([\w\d]+\)/).nil?
+
+          elt = Scoutui::Utils::TestUtils.instance.getPageElement(obj)
+
+          if elt.is_a?(Hash)
+            Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " JSON or Hash => #{elt}"  if Scoutui::Utils::TestUtils.instance.isDebug?
+            locator = elt['locator'].to_s
+          else
+            locator=elt.to_s
+          end
+
+          Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " Process page request #{obj} => #{locator}" if Scoutui::Utils::TestUtils.instance.isDebug?
+
+        else
+          locator=obj.to_s
+        end
+
+        if !locator.match(/\$\{.*\}/).nil?
+          _x = Scoutui::Base::UserVars.instance.get(locator)
+          Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " User specified user var : #{locator} ==> #{_x}"
+          if !_x.nil?
+
+
+            if !_x.match(/^page\([\w\d]+\)/).nil?
+              elt = Scoutui::Utils::TestUtils.instance.getPageElement(_x)
+
+              if elt.is_a?(Hash)
+                Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " JSON or Hash => #{elt}" if Scoutui::Utils::TestUtils.instance.isDebug?
+                locator = elt['locator'].to_s
+              else
+                locator=elt.to_s
+              end
+            end
+
+          end
+
+        end
+
+        Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " locator : #{locator}" if Scoutui::Utils::TestUtils.instance.isDebug?
+
+        if locator.match(/^\s*css\s*\=\s*/i)
+          locateBy = :css
+          locator = locator.match(/css\s*\=\s*(.*)/i)[1].to_s
+        elsif locator.match(/^#/i)
+          locateBy = :css
+        #  locator = locator.match(/\#(.*)/)[1].to_s
+        end
+
+
+        Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " By      => #{locateBy.to_s}"
+        Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " Locator => #{locator}"
+        Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " Visible_When => #{visible_when}"
+
+      #  Selenium::WebDriver::Wait.new(timeout: _timeout).until { drv.find_element(:xpath => locator).displayed? }
+        # rc=drv.find_element(:xpath => locator)
+        Selenium::WebDriver::Wait.new(timeout: _timeout).until { rc=drv.find_element( locateBy => locator) }
+
+
+      rescue Selenium::WebDriver::Error::TimeOutError
+          Scoutui::Logger::LogMgr.instance.debug __FILE__  + (__LINE__).to_s + " #{locator} time out."
+          rc=nil
+
+      rescue Selenium::WebDriver::Error::NoSuchElementError
+        Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " #{locator} not found."
+        rc=nil
+
+      rescue => ex
+        Scoutui::Logger::LogMgr.instance.debug "Error during processing: #{$!}"
+        Scoutui::Logger::LogMgr.instance.debug "Backtrace:\n\t#{ex.backtrace.join("\n\t")}"
+      end
+
+      Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " getObject(#{locator}) => #{rc.to_s}" if Scoutui::Utils::TestUtils.instance.isDebug?
+
+#      if rc.kind_of?(Selenium::WebDriver::Element)
+#
+#        if visible_when
+#          Scoutui::Logger::LogMgr.instance.debug __FILE__ + (__LINE__).to_s + " Displayed => #{rc.displayed?}"
+#          Testmgr::TestReport.instance.getReq('UI').tc('visible_when').add(rc.displayed?, "Verify #{locator} is visible")
+#        end
+#
+#      end
+
+      rc
+    end
+
+    def wait_for(seconds)
+      Selenium::WebDriver::Wait.new(timeout: seconds).until { yield }
+    end
+
+    def driver
+      @driver
+    end
+
+
+
+  end
+
+
+end