scoutui 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a30ec1b576da5316bdcab5d783e012b38162c8ff
-  data.tar.gz: 0fa6ec360deb548399164ea9fd1ecea9726b79a1
+  metadata.gz: 597490bc864b9a5ab5ae2abb47f5ab6d384f26db
+  data.tar.gz: 250daf6f585493301d23a20b73b0ffec728ee177
 SHA512:
-  metadata.gz: 4115dda6300e3d3ca932060c4ee560f6753db16ccc1adefaae70a3eb4ee40abda227a4d02b3964f712b3cdcefadf0171183d7bfbb1af962ff3d9fc5cc0250a8d
-  data.tar.gz: 8380d47fae11e943e80b162fa6338862c05a7170cbcc9481b14761bc21055e94e27ddf4557999b3cb0a1c722c83eaf41e9b7ba3004419c22aaae28c17dcc3ead
+  metadata.gz: 9e64db3af7536e55a3d18769ef42d334c3dee36a05147a3fe014a16a77193677f8f0fc6799509377bf8a359a9e6a177bb991ebdc7ab90c9410c91351454c19b9
+  data.tar.gz: d64d32a4627e59340781012c27f88d08423ab4eebd407a1f8e8cdfad5482a3a9fac345d1824fbb4c1b1721361eba0fee21ffb1c8859ac928029018cb44047477

data/README.md

@@ -1,11 +1,31 @@
-# Scoutui
+# ScoutUI
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/scoutui`. To experiment with that code, run `bin/console` for an interactive prompt.
+The ScoutUI gem provides a simple, yet powerful visual test framework to help you and your team with an automated visual test strategy.
 
-TODO: Delete this and the text above, and describe your gem
+This project is still in beta, but working - the version '1.0.0' will be the first "stable" release.
+
+## What does ScoutUI provide?
+
+    1. Command driven test strategy using YAML and/or JSON format
+    2. Integration with Applitools Eyes (this is optional - only if you have an Eyes account)
+    3. Leverage Selenium/WebDriver without having to hassle with it (e.g. APIs) to conduct browser testing
+       a. UI Regression with Eyes
+       b. Functional Testing
+    
+    
+## Helpful Links
+    YouTube
 
 ## Installation
 
+### Prerequisites
+    1. Ruby 1.9.3 or higher
+    2. Following Gems
+       a. selenium-webdriver
+       b. eyes_selenium
+       c. yaml
+       d. json
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -24,16 +44,58 @@ To run unit tests:
 
     $ bundle exec rake spec
 
-## Usage
+## Running the examples
 
-TODO: Write usage instructions here
+Following these steps to get started.
+
+1. Goto the ./examples/ex1 folder
+2. Set the environment variable APPLITOOLS_API_KEY with your key
+
+    export APPLITOOLS_API_KEY=[__YOUR_APPLITOOLS_KEY__]
+3. Set the environment variable SCOUTUI_BIN to the ScoutUi driver
+    
+    export SCOUTUI_BIN=[ScoutUI Path]\bin\scoutui_driver.rb
+   
+4. Run the script 'test-simple.sh'
+5. Goto your Applitools account and look for the test named "Graceland"
 
 ## Development
 
 
-## Ti ryb
+## Creating Tests
+
+### Command files
+Command files are currently supported only in YAML format, however JSON will be supported very shortly (by 10/28/2015).
 
-ruby test_script.rb  --file ../spec/fixtures/static_test_settings.json --host rqa3 --lang en-us  --title "abc 123"  --user peter --password Hello --browser chrome  --eyes TruE
+Each stanza of a Command YAML file starts with *page*.
+
+    page:
+   
+The following 
+
+
+#### Example 1. Navigate to a URL then take snapshots after user actions (e.g. mouse events).
+
+    page:
+      name: Home
+      url: http://www.elvis.com
+    ---
+    page:
+      name: Mouseover Music
+      action: mouseover(//ul[@class="nav-primary"]//a[text()="Music"])
+      snapit: true
+    ---
+    page:
+      name: Studio Albums
+      action: click(//*[@id='music']//a[text()="Studio Albums"])
+      snapit: true
+      expected:
+        wait: //footer[@id="footer"]//a[@class="credits"]
+        
+
+## To run from the command line
+
+ruby test_script.rb  --config <your test settings JSON file> --eyes
 
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -42,20 +104,13 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/scoutui. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/h20dragon/scoutui.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
 ## To do
-1. Refactor test_settings handling of JSON in method setConfig() - if Hash then we're fine, otherwise load the file (where String is passed)
-
-    jFile = File.read(static_settings_file)
-    jsonData=JSON.parse(jFile)
-
-    puts "jsonData type is #{jsonData.class.to_s}"
 
-    t.setConfig(jsonData)
+Advanced Test Reporting
 

data/bin/scoutui_driver.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/ruby
+require_relative '../lib/scoutui'
+
+require 'logger'
+
+##
+# --file <Yaml>
+# --host <String>
+# --lang <String>
+# --title <Applitools Title>
+# --browser <chrome|firefox|ie>
+
+
+nav = Scoutui::Navigator.new(Scoutui::Utils::TestUtils.instance.parseCommandLine())
+
+
+runner = Scoutui::Base::TestScout.new(nav)
+
+runner.start()
+runner.report()
+
+

data/examples/ex1/commands.yml

@@ -0,0 +1,25 @@
+page:
+  name: Home
+  url: http://www.elvis.com
+---
+page:
+  name: Mouseover Music
+  action: mouseover(//ul[@class="nav-primary"]//a[text()="Music"])
+  snapit: true
+---
+page:
+  name: Studio Albums
+  action: click(//*[@id='music']//a[text()="Studio Albums"])
+  snapit: true
+  expected:
+    xyz: //footer[@id="footer"]//a[@class="credits"]
+---
+page:
+  skip: true
+  action: type(//input[@id="password"], ${password})
+---
+page:
+  skip: true
+  action: click(//input[@id="btnSubmit"])
+  expected:
+    avatar: //img[@id="cnqr-profile-avatar"]

data/examples/ex1/test-example.sh

@@ -0,0 +1,36 @@
+#/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__"
+##
+
+# Specify browser under test  (chrome, firefox, ie, safari)
+BUT=chrome
+
+# Specify the title and appName needed by Applitools
+# 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=Graceland
+APP=Elvis
+
+# Specify the test configuration file
+TEST_CFG="./test.config.json"
+
+##
+# content
+# strict
+# exact
+# layyout
+##
+MATCH_TYPE="layout"
+
+# 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
+
+# The following
+# $SCOUTUI_BIN --config $TEST_CFG  --eyes  --match $MATCH_TYPE  --browser $BUT

data/examples/ex1/test.config.json

@@ -0,0 +1,16 @@
+{
+  "Project": "Example",
+  "Version": "1.00",
+  "Description": "Example1 - http://www.Elvis.com",
+
+  "browser": "chrome",
+
+  "eyes": {
+    "title": "Example1",
+    "viewport": "1700x718",
+    "app": "09-26"
+  },
+
+  "host": "http://www.elvis-presley.com",
+  "dut": "./commands.yml"
+}

data/examples/ex2/commands.yml

@@ -0,0 +1,35 @@
+page:
+  name: Home
+  description: Navigate to a specified URL and wait until the expected elements are present
+  url: http://www.carmax.com
+  expected:
+    wait: page(home).get(cars4sale)
+    wait: page(home).get(whyCarMax)
+---
+page:
+  name: Mouseover View Tickets
+  action: mouseover(page(home).get(whyCarMax))
+  snapit: true
+---
+page:
+  name: Click - specified by Alias
+  action: click(${whyCarMax})
+  snapit: true
+---
+page:
+  skip: true
+  action: pause
+---
+page:
+  skip: true
+  name: Click on Input
+  action: click(page(main_nav).get(search_input))
+  snapit: true
+---
+page:
+  action: type(page(main_nav).get(search_input), ${Search_Me})
+---
+page:
+  action: click(page(main_nav).get(search_btn))
+  expected:
+    wait: //input[@id='zip']

data/examples/ex2/page_model.json

@@ -0,0 +1,18 @@
+{
+    "home": {
+        "cars4sale": "//a[text()='Find Cars for Sale']",
+        "whyCarMax": "//a[text()='Why CarMax']",
+        "wait2": "//input[text()='Sign in']"
+    },
+
+    "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,38 @@
+#/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
+## 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
+
+
+# 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
+
+# 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/examples/ex6/commands.yml

@@ -0,0 +1,53 @@
+page:
+  name: Home
+  description: Navigate to a specified URL and wait until the expected elements are present
+  url: http://localhost:8081/trac/PWK/wiki
+  expected:
+    wait: page(home).get(wiki_link)
+    wait2: page(home).get(login_form).get(password)
+---
+page:
+  name: Mouseover View Tickets
+  action: mouseover(page(main_nav).get(ViewTicketsLink))
+  snapit: true
+---
+page:
+  name: Click - specified by Alias
+  action: click(${View_Tickets_Link})
+  snapit: true
+---
+page:
+  skip: true
+  action: pause
+---
+page:
+  name: Click on Input
+  action: click(page(main_nav).get(search_input))
+  snapit: true
+---
+page:
+  action: type(page(main_nav).get(search_input), ${Search_Me})
+---
+page:
+  skip: true
+  name: Mouseover Music
+  action: mouseover(//ul[@class="nav-primary"]//a[text()="Music"])
+  snapit: true
+---
+page:
+  skip: true
+  name: Studio Albums
+  action: click(//*[@id='music']//a[text()="Studio Albums"])
+  snapit: true
+  expected:
+    wait: //footer[@id="footer"]//a[@class="credits"]
+---
+page:
+  skip: true
+  action: type(//input[@id="password"], ${password})
+---
+page:
+  skip: true
+  action: click(//input[@id="btnSubmit"])
+  expected:
+    avatar: //img[@id="cnqr-profile-avatar"]

data/examples/ex6/ex1.config.json

@@ -0,0 +1,24 @@
+{
+  "Project": "Example",
+  "Version": "1.00",
+  "Description": "Example1",
+
+  "browser": "chrome",
+
+  "eyes": {
+    "title": "Example1",
+    "viewport": "1700x718",
+    "app": "09-26"
+  },
+
+  "host": "http://localhost:8081/trac/PWK/wiki",
+  "dut": "./commands.yml",
+
+
+  "user_vars": {
+    "Search_Me": "Van Halen",
+    "View_Tickets_Link": "page(main_nav).get(ViewTicketsLink)"
+  }
+
+}
+

data/examples/ex6/test-example.sh

@@ -0,0 +1,36 @@
+#/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