scoutui 0.1.3 → 2.0.0

data/examples/ex6/test-example.sh

@@ -1,36 +0,0 @@
-#/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=chrome
-
-# Specify the title and appName needed by Applitools
-TITLE=DEMO-ONE
-APP=Elvis
-
-# Specify the test configuration file
-TEST_CFG="./ex6.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  --debug --config $TEST_CFG  --browser $BUT $EYES --app $APP --title $TITLE  --match $MATCH_TYPE --pagemodel ./page_model.json
-
-# The following
-# $SCOUTUI_BIN --config $TEST_CFG  --eyes  --match $MATCH_TYPE  --browser $BUT

data/lib/scoutui/base/q_accounts.rb

@@ -1,52 +0,0 @@
-
-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

@@ -1,125 +0,0 @@
-
-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)
-      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
-
-      puts __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

@@ -1,74 +0,0 @@
-
-require 'eyes_selenium'
-require 'selenium-webdriver'
-
-
-module Scoutui::Base
-
-
-  class QBrowser
-
-    attr_accessor :driver
-
-    def initialize()
-    end
-
-    def self.wait_for_exist(drv, xpath, _timeout=30)
-      puts __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, xpath, _timeout=30)
-      rc=nil
-      begin
-        Selenium::WebDriver::Wait.new(timeout: _timeout).until { drv.find_elements(:xpath => xpath).size > 0 }
-        rc=drv.find_elements(:xpath => xpath)[0]
-      rescue => ex
-        ;
-      end
-      rc
-    end
-
-    def self.getObject(drv, xpath, _timeout=30)
-      rc=nil
-      begin
-
-        if !xpath.match(/^page\([\w\d]+\)/).nil?
-
-          xpath = Scoutui::Utils::TestUtils.instance.getPageElement(xpath)
-          puts __FILE__ + (__LINE__).to_s + " Process page request #{xpath} => #{xpath}" if Scoutui::Utils::TestUtils.instance.isDebug?
-        end
-
-
-        Selenium::WebDriver::Wait.new(timeout: _timeout).until { drv.find_element(:xpath => xpath).displayed? }
-        rc=drv.find_element(:xpath => xpath)
-      rescue => ex
-        ;
-      end
-
-      puts __FILE__ + (__LINE__).to_s + " getObject(#{xpath}) => #{rc.to_s}" if Scoutui::Utils::TestUtils.instance.isDebug?
-
-      rc
-    end
-
-    def wait_for(seconds)
-      Selenium::WebDriver::Wait.new(timeout: seconds).until { yield }
-    end
-
-    def driver
-      @driver
-    end
-
-
-
-  end
-
-
-end

data/lib/scoutui/base/test_scout.rb

@@ -1,123 +0,0 @@
-
-
-module Scoutui::Base
-
-
-  class TestScout
-    attr_reader :context
-    attr_reader :test_settings  # { host, 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
-
-      if Scoutui::Utils::TestUtils.instance.hasTestConfig?
-
-        puts __FILE__ + (__LINE__).to_s +  " * test config json => " + Scoutui::Utils::TestUtils.instance.testConfigFile() if Scoutui::Utils::TestUtils.instance.isDebug?
-
-        @test_settings=Scoutui::Utils::TestUtils.instance.getTestSettings()
-
-        @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
-      @eyeScout.generateReport()
-    end
-
-    def hasSettings?
-      Scoutui::Utils::TestUtils.instance.hasTestConfig?
-    end
-
-    def dumpSettings()
-      puts '-' * 72
-      puts @test_settings
-
-      puts "UserRecord => #{@userRecord}"
-      puts "Eyes Record => #{@eyesRecord}"
-      puts "Host => #{@test_settings['host']}"
-    end
-
-  def teardown()
-    @eyeScout.teardown()
-  end
-
-    def setup()
-
-      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
-
-      begin
-
-        eyeScout=Scoutui::Eyes::EyeFactory.instance.createScout()
-      rescue => ex
-        puts ex.backtrace
-      end
-
-      eyeScout
-    end
-
-
-
-    def goto(url=nil)
-      @eyeScout.navigate(url) if !url.nil?
-    end
-
-    def snapPage(tag)
-      @eyeScout.check_window(tag)
-    end
-
-
-    def run()
-      puts __FILE__ + (__LINE__).to_s + " run()" if Scoutui::Utils::TestUtils.instance.isDebug?
-
-      begin
-
-        @eyeScout=setup()    # Browser is created
-
-        # Navigate to the specified host
-        goto(Scoutui::Base::UserVars.instance.get(:host))
-
-        snapPage('Landing Page')
-
-        Scoutui::Base::VisualTestFramework.processFile(@eyeScout, @test_settings)
-
-        teardown()
-
-      rescue => ex
-        puts ex.backtrace
-      ensure
-        puts __FILE__ + (__LINE__ ).to_s + " Close Eyes" if Scoutui::Utils::TestUtils.instance.isDebug?
-        @eyeScout.closeOut()
-
-      end
-
-    end
-
-
-
-  end
-
-
-end

data/lib/scoutui/base/test_settings.rb

@@ -1,109 +0,0 @@
-require 'json'
-
-module Scoutui::Base
-
-
-  class TestSettings
-
-    attr_accessor :bEyes
-    attr_accessor :browserType
-    attr_accessor :eut
-    attr_accessor :user
-    attr_accessor :eyesReport
-    attr_accessor :url
-
-
-    def initialize(opts)
-      @bEyes=false
-      @browserType=opts[:but] || :firefox
-      @eut=opts[:eut] || :qa
-      @lang=opts[:lang] || "en-us"
-      @user=opts[:user] || nil
-      @eyesReport=opts[:eyesReport] || nil
-      @url=opts[:url]||nil
-
-    end
-
-    def setConfig(c)
-      if c.instance_of?(Hash)
-        @testConfig=c
-      else
-        # a JSON file was passed  (ERROR handling needed)
-        jFile = File.read(c)
-        @testConfig=JSON.parse(jFile)
-      end
-
-      @testConfig
-    end
-
-
-    def getScout()
-      @testConfig["dut"]
-    end
-
-    def setLang(lang)
-      @lang=lang
-    end
-
-    def getUrl()
-      @url
-    end
-
-    def url
-      getUrl()
-    end
-
-    def setUrl(u)
-      @url=u
-    end
-
-    def getEyesReport()
-      @eyesReport
-    end
-
-    def getLanguage()
-      getLang()
-    end
-
-    def getUser()
-      @user
-    end
-
-    def getLang()
-      @lang
-    end
-
-    def getBUT()
-      @browserType
-    end
-
-    def setEUT(e)
-      @eut=e
-    end
-
-    def getEUT()
-      @eut
-    end
-
-    def browserType()
-      @browserType
-    end
-
-    def enableEyes(b=true)
-      @bEyes=b
-    end
-
-    def disableEyes()
-      @bEyes=false
-    end
-
-    def isEyes?
-      @bEyes
-    end
-
-  end
-
-
-end
-
-

data/lib/scoutui/base/user_vars.rb

@@ -1,105 +0,0 @@
-require 'singleton'
-
-module Scoutui::Base
-
-  class UserVars
-    include Singleton
-
-    attr_accessor :globals
-
-    def initialize
-      @globals={
-          :accounts => '/tmp/qa/accounts.yaml',
-          :browser => 'chrome',
-          :userid => nil,
-          :password => nil,
-          :host => nil,
-          :localization => 'en-us'
-      }
-    end
-
-    def dump()
-      @globals.each_pair do |k, v|
-        puts __FILE__ + (__LINE__).to_s + " #{k} => #{v}"
-      end
-    end
-
-    def getViewPort()
-      arr=Scoutui::Base::UserVars.instance.getVar('eyes.viewport').match(/(\d+)\s*x\s*(\d+)$/i)
-      if arr.size==3
-        _sz = {:width => arr[1].to_i, :height => arr[2].to_i }
-      end
-
-      _sz
-    end
-
-    def getBrowserType()
-      @globals[:browser].to_sym
-    end
-
-    def getHost()
-      @globals[:host].to_s
-    end
-
-    def get(k)
-      foundKey=true
-
-      v=k
-
-      _rc = k.match(/\$\{(.*)\}$/)
-
-      # Needs refactoring!
-      if k=='${userid}'
-        k=:userid
-      elsif k=='${password}'
-        k=:password
-      elsif k=='${host}'
-        k=:host
-      elsif k.is_a?(Symbol)
-        foundKey=true
-      elsif !_rc.nil?
-        k=_rc[1].to_s
-        puts __FILE__ + (__LINE__).to_s + " User Var found => #{k}"  if Scoutui::Utils::TestUtils.instance.isDebug?
-        if Scoutui::Utils::TestUtils.instance.getTestConfig().has_key?("user_vars")
-
-          if Scoutui::Utils::TestUtils.instance.getTestConfig()["user_vars"].has_key?(k)
-            v=Scoutui::Utils::TestUtils.instance.getTestConfig()["user_vars"][k].to_s
-          end
-
-        end
-
-      else
-        foundKey=false
-      end
-
-      puts __FILE__ + (__LINE__).to_s + " get(#{k} => #{@globals.has_key?(k)}" if Scoutui::Utils::TestUtils.instance.isDebug?
-
-      if @globals.has_key?(k) && foundKey
-        v=@globals[k]
-      end
-
-      puts __FILE__ + (__LINE__).to_s + " get(#{k} => #{@globals.has_key?(k)} ==> #{v.to_s}" if Scoutui::Utils::TestUtils.instance.isDebug?
-
-      v
-    end
-
-    def set(k, v)
-      setVar(k, v)
-      v
-    end
-
-    def getVar(k)
-      @globals[k].to_s
-    end
-
-    def setVar(k, v)
-      @globals[k]=v
-      v
-    end
-
-
-  end
-
-
-
-end