scoutui 2.0.1 → 2.0.2

data/examples/ex2/commands/ex2.yml

@@ -0,0 +1,24 @@
+page:
+  skip: false
+  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)
+    wait2: page(home).get(whyCarMax)
+    wait3: page(find_cars_by).get(make)
+  assertions: [
+    assert1: {
+      "locator": "page(find_cars_by).get(make)",
+      "visible_when": "never",
+      "reqid": "REQ-MAKE"
+      },
+    assert2: {
+      "locator": "page(home)",
+      "reqid": "REQ-HOME"
+    }
+  ]
+---
+page:
+  action: pause
+  skip: false

data/examples/ex2/data.json

@@ -0,0 +1,6 @@
+{
+
+  "make": "porsche"
+
+
+}

data/examples/ex2/test-configs/test.config.basic.json

@@ -0,0 +1,12 @@
+{
+  "Project": "Example",
+  "Version": "1.00",
+  "Description": "Example - CarMax",
+
+  "browser": "chrome",
+
+  "host": "http://www.carmax.com",
+
+  "dut": ""
+}
+

data/examples/ex2/{test.config.json → test-configs/test.config.json}

@@ -12,13 +12,19 @@
   },
 
   "host": "http://www.carmax.com",
-  "dut": "./commands.yml",
+  "dut": "../commands/home.command.yml",
+  "dut2": "../commands/commands.yml",
 
 
   "user_vars": {
     "Search_Me": "BMW M3",
     "View_Tickets_Link": "page(main_nav).get(ViewTicketsLink)",
-    "WhyCarMax": "page(home).get(whyCarMax)"
+    "WhyCarMax": "page(home).get(whyCarMax)",
+
+    "firstname": "Elvis",
+
+    "MyMake": "Porsche",
+    "make_aut": "file(porsche.json)"
   }
 
 }

data/examples/ex2/tests/run-test.sh

@@ -0,0 +1,125 @@
+#!/usr/bin/env bash
+
+
+
+#VIEXPORT="--viewport 800x600"
+
+while getopts ":a:b:c:d:eh:il:m:p:r:st:u:A:P:O:S:T:V:vw:" opt; do
+  case $opt in
+    a)
+      echo "-a was triggered, Parameter: $OPTARG" >&2
+      ;;
+    b)
+       BROWSER="--browser $OPTARG"
+
+       if [[ $BROWSER=="chrome" ]];
+       then
+          rc=`/usr/local/bin/which chromedriver`
+          if [ $? -ne 0 ]
+          then
+            echo "-- Error: unable to find chromedriver. --"
+            exit 2
+          fi
+
+       fi
+       ;;
+    c)
+       CAPS="--capabilities $OPTARG"
+       ;;
+    d)
+       DUT="--dut $OPTARG"
+          ;;
+    e)
+      EYES="--eyes"
+          ;;
+    h)
+      HOST="--host \"$OPTARG\""
+      ;;
+    i)
+      INC_EXP="--include_expectations"
+      ;;
+    l)
+      LEVEL="--loglevel $OPTARG"
+        ;;
+    m)
+      MATCH_LEVEL="--match $OPTARG"
+      ;;
+    p)
+        PASSWORD="--password $OPTARG"
+        ;;
+    r)
+        ROLE="--role $OPTARG"
+        ;;
+    s)
+       SAUCE="--sauce"
+       ;;
+    S)
+       SAUCE_NAME="--sauce_name $OPTARG"
+       ;;
+    t)
+       TEST_CFG="$OPTARG"
+       ;;
+    u)
+       USERID="--user $OPTARG"
+       ;;
+    v)
+      VERBOSE="--debug"
+      ;;
+    w)
+      DEFAULT_WAIT="--wait $OPTARG"
+      ;;
+    A)
+       APP="--app $OPTARG"
+       ;;
+    O)
+       mkdir -p $OPTARGET 2>/dev/null
+       DIFF_DIR="--diffs $OPTARG"
+       ;;
+    P)
+       PAGE_MODEL="--pages $OPTARG"
+       ;;
+    T)
+       TITLE="--title $OPTARG"
+       ;;
+    V)
+       VIEWPORT="--viewport $OPTARG"
+       ;;
+    \?)
+      echo "Invalid option: -$OPTARG" >&2
+      exit 1
+      ;;
+    :)
+      echo "Option -$OPTARG requires an argument." >&2
+      exit 1
+      ;;
+  esac
+done
+
+echo "BROWSER: ${BROWSER}"
+echo "EYES : ${EYES}"
+echo "HOST : ${HOST}"
+echo "VERBOSE: ${VERBOSE}"
+echo "MATCH: ${MATCH_LEVEL}"
+echo "SAUCE: ${SAUCE}"
+echo "CAPS: ${CAPS}"
+echo "DUT: ${DUT}"
+echo "TITLE: ${TITLE}"
+echo "APP: ${APP}"
+echo "VIEWPORT: ${VIEWPORT}"
+
+
+# --dut ../commands/login.fail.yml
+#TITLE="--title DEMO-XYZ"
+#APP="--app LOC.ALL-HANDS"
+#PAGE_MODEL="--pages ../appmodels/page_model.cge.json,../appmodels/page_model.traveler.json,../appmodels/page_model.common_bar.json"
+
+if [[ -f $TEST_CFG ]]; then
+
+  CMD="ruby  $SCOUTUI_BIN --config ${TEST_CFG} ${INC_EXP} ${DIFF_DIR}  ${LEVEL} ${USERID} ${PASSWORD} ${DUT} ${VIEWPORT} ${ROLE} ${EYES} ${SAUCE} ${SAUCE_NAME} $TITLE ${APP} ${CAPS} ${MATCH_LEVEL} ${BROWSER} ${HOST}  ${PAGE_MODEL} ${DEFAULT_WAIT}  ${VERBOSE}"
+
+  echo $CMD
+  eval $CMD
+else
+  echo "Error: unable to access ${TEST_CFG}."
+  exit 1
+fi

data/examples/ex2/tests/test-basic-appmodel.sh

@@ -0,0 +1,14 @@
+#/bin/bash
+##
+# Description
+#   Main test script.
+##
+export SCOUTUI_BIN=../../../bin/scoutui_driver.rb
+
+
+# Specify the test configuration file
+TEST_CFG="../test-configs/test.config.basic.json"
+APP_MODEL="../appmodel/page_model.json"
+
+
+./run-test.sh -b chrome -d ../commands/commands.basic.appmodel.yml -P $APP_MODEL  -t $TEST_CFG -v

data/examples/ex2/{test-example.sh → tests/test-example.sh}

@@ -7,7 +7,7 @@
 #
 #          export APPLITOOLS_API_KEY="__YOUR_KEY_HERE__"
 ##
-SCOUTUI_BIN=../../bin/scoutui_driver.rb
+SCOUTUI_BIN=../../../bin/scoutui_driver.rb
 # Specify browser under test  (chrome, firefox, ie, safari)
 BUT=firefox
 
@@ -18,7 +18,7 @@ TITLE=DEMO-CarMax
 APP=Oct2015
 
 # Specify the test configuration file
-TEST_CFG="./test.config.json"
+TEST_CFG="../test-configs/test.config.json"
 
 ##
 # content
@@ -33,7 +33,7 @@ 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
+$SCOUTUI_BIN  --config $TEST_CFG  --browser $BUT $EYES --app $APP --title $TITLE  --match $MATCH_TYPE --pagemodel ../appmodel/page_model.json  --debug
 
 # The following
 # $SCOUTUI_BIN --config $TEST_CFG  --eyes  --match $MATCH_TYPE  --browser $BUT

data/examples/ex2/tests/test-example1a.sh

@@ -0,0 +1,16 @@
+#/bin/bash
+##
+# Description
+#   Load a page and wait for expected elements, however these are
+#   explicit 'waits' - included in assertions.
+#
+#    The parameter '-i' will include the 'waits' on expected elements
+#   as assertions (e.g. will be used for pass/fail criteria).  The "-i" is used.
+##
+export SCOUTUI_BIN=../../../bin/scoutui_driver.rb
+
+
+# Specify the test configuration file
+TEST_CFG="../test-configs/test.config.basic.json"
+
+./run-test.sh -b chrome -d ../commands/ex1.yml -t $TEST_CFG -v -i

data/examples/ex2/tests/test-example1b.sh

@@ -0,0 +1,13 @@
+#/bin/bash
+##
+# Description
+#   Load a page and wait for expected elements, however these are
+#   explicit 'waits' - WITHOUT assertions  (e.g. the "-i" is omitted).
+##
+export SCOUTUI_BIN=../../../bin/scoutui_driver.rb
+
+
+# Specify the test configuration file
+TEST_CFG="../test-configs/test.config.basic.json"
+
+./run-test.sh -b chrome -d ../commands/ex1.yml -t $TEST_CFG -v

data/examples/ex2/tests/test-example1c.sh

@@ -0,0 +1,15 @@
+#/bin/bash
+##
+# Description
+#   Load a page and wait for expected elements, however these are
+#   explicit 'waits' - included in assertions.
+#
+#   Set a default timeout (wait) in seconds when searching/finding for elements.
+##
+export SCOUTUI_BIN=../../../bin/scoutui_driver.rb
+
+
+# Specify the test configuration file
+TEST_CFG="../test-configs/test.config.basic.json"
+
+./run-test.sh -b chrome -d ../commands/ex1c.yml -t $TEST_CFG -v  -w 5  -i

data/examples/ex2/tests/test-example1d.sh

@@ -0,0 +1,15 @@
+#/bin/bash
+##
+# Description
+#   Load a page and wait for expected elements, however these are
+#   explicit 'waits' - included in assertions.
+#
+#   Set a default timeout (wait) in seconds when searching/finding for elements.
+##
+export SCOUTUI_BIN=../../../bin/scoutui_driver.rb
+
+
+# Specify the test configuration file
+TEST_CFG="../test-configs/test.config.basic.json"
+
+./run-test.sh -b chrome -d ../commands/ex1d.yml -t $TEST_CFG -v  -w 5

data/examples/ex2/tests/test-example2.forms.eyes.sh

@@ -0,0 +1,40 @@
+#!/usr/bin/env bash
+#/bin/bash
+##
+# Description
+##
+
+export 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=STPCon-Springx
+
+# Specify the test configuration file
+TEST_CFG="../test-configs/test.config.json"
+
+##
+# content
+# strict
+# exact
+# layyout
+##
+MATCH_TYPE="layout"
+
+
+PM="../appmodel/page_model.json,../appmodel/common.json,../appmodel/register.model.json"
+
+
+eyes() {
+    ./run-test.sh -b chrome -i -d ../commands/ex2.hover.yml -P "${PM}" -t ../test-configs/test.config.json -v \
+                  -e -m content -T CarMax_Hover -A Ex1 -O /tmp/vt \
+                  -d ../commands/ex.forms.yml
+}
+
+
+./run-test.sh -b firefox -i -d ../commands/ex2.hover.yml -P "${PM}" -t ../test-configs/test.config.json -v \
+              -d ../commands/ex.forms.yml

data/examples/ex2/tests/test-example2.hover.eyes.sh

@@ -0,0 +1,40 @@
+#/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__"
+##
+
+export 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=STPCon-Springx
+
+# Specify the test configuration file
+TEST_CFG="../test-configs/test.config.json"
+
+##
+# content
+# strict
+# exact
+# layyout
+##
+MATCH_TYPE="layout"
+
+
+
+
+
+PM="../appmodel/page_model.json,../appmodel/common.json"
+
+
+./run-test.sh -b chrome -i -d ../commands/ex2.hover.yml -P "${PM}" -t ../test-configs/test.config.json -v \
+              -e -m content -T CarMax_Hover -A Ex1 -O /tmp/vt

data/examples/ex2/tests/test-example2.hover.sh

@@ -0,0 +1,26 @@
+#/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__"
+##
+
+export 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-configs/test.config.json"
+
+PM="../appmodel/page_model.json,../appmodel/common.json"
+
+./run-test.sh -b chrome -i -d ../commands/ex2.hover.yml -P "${PM}" -t ../test-configs/test.config.json -v

data/examples/ex2/tests/test-example2.sh

@@ -0,0 +1,43 @@
+#/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-configs/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 ../appmodel/page_model.json  --debug
+
+# The following
+# $SCOUTUI_BIN --config $TEST_CFG  --eyes  --match $MATCH_TYPE  --browser $BUT
+
+PM="../appmodel/page_model.json,../appmodel/common.json"
+
+./run-test.sh -b chrome -i -d ../commands/ex2.yml -P "${PM}" -t ../test-configs/test.config.json -v