scoutui 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d9e2fde17563fe12087fe92fa34af5062ea17dd
-  data.tar.gz: 4bdfcf36e43d291564a99daab5b09528debd3ffe
+  metadata.gz: fe92fe04ff0e9daf07a6521ad4ba598f5e32bd5c
+  data.tar.gz: 104265382adad105254e0b5e9e357fc53b60e27f
 SHA512:
-  metadata.gz: 8fe016fcdb86bdbbd0e9017b9dbf4813b3a3bbb099815da656f7b336c8f3a29056b67cc9537fbd2c1b571b17eb83b23e13e3ac72709bf1a26e688da1fcea08f5
-  data.tar.gz: e2941891d3e702659b569bc37ca4afbe5804ccda571a1494c55c36ece98fb15cdd18e04545d7e4a57c45ce5d5211b3b13144fff9ff921a83c493fdf1052ddd61
+  metadata.gz: 93e4bd0ada8f1a6d10ac5016ddf1b296c2df39aa721a2a3cabfc3a7088f9cd193800b971ff70a5f5fcdbc4b8b82ef4026a53c94191919cb0c6dbfbb885bf0e01
+  data.tar.gz: f5c2df5075a7db4c9ae19b9bc898af64fa0b5e0d61d374a0270574fa0e58066a48a5b564ca4ba84593c1708ec3f65a4c03d72bcb2858134f2a85d5ba6449d317

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/spec/reports/
+/test/gateway
+/tmp/
+/test/travel

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in scoutui.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 H20Dragon - Application Model Based Automation Framework
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,154 @@
+# ScoutUI
+
+The ScoutUI gem provides a simple, yet powerful visual test framework to help you and your team with an automated visual test strategy.
+
+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
+       e. testmgr
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'scoutui'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install scoutui
+    
+To run unit tests:
+
+    $ bundle exec rake spec
+    
+To run a specific unit test:
+
+    $ rspec spec/json_spec.rb
+
+## Running the examples
+
+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
+
+
+## Creating Tests
+
+### Command files
+Command files are currently supported only in YAML format, however JSON will be supported very shortly (by 10/28/2015).
+
+Each stanza of a Command YAML file starts with the key *page*
+
+    page:
+    
+and can have the following *properties*
+
+    name: <String>
+used to name the snapshot stored in Applitools.  
+The string, representing the logical name of this window/validation point will appear in the test result report.
+
+    url: <Full URL>
+    
+specifies the URL to load right before the snapshot
+
+    url: <Partial URL>
+    
+    
+specifies the partial URL that should be concatenated to the provided host, before the snapshot
+    
+    
+    skip: <true | false>
+specifies whether or not to skip this stanza  (if skip is omitted, it's default value is true)
+   
+
+
+
+#### 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"]
+        
+
+## A word about using Applitools Eyes
+
+1. CSS Transitions
+    
+    This method is to make the floating bar not captured when scrolling the screen in force-to-fullscreen mode.
+        use_css_transition
+2. Viewport
+
+    You can obtain the viewport by resizing the browser, to a desired width/height, then obtain the following values using Javascript console.
+   
+        window.innerWidth
+        window.innerHeight
+        
+        
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+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
+
+Advanced Test Reporting
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "scoutui"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

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/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/ex1/commands.holidays.yml

@@ -0,0 +1,45 @@
+page:
+  name: Home
+  url: http://www.elvis.com
+  expected:
+    wait: frame()
+---
+page:
+  action: click(//a[@class='ui-dialog-titlebar-close ui-corner-all' and @role='button']/i[@class='icon-cms-thinx')
+  snapit: false
+---
+page:
+  name: Mouseover Music
+  action: mouseover(//a[@class='ParentNav' and @title='Holidays'])
+  snapit: true
+---
+page:
+  name: Studio Albums
+  action: click(//a[@title='Holiday Decorations'])
+  snapit: true
+  expected:
+    wait: //*[@id='PagingViewAll']
+---
+page:
+  name: Hot Items
+  action: mouseover(//*[@id='NavList']//a[@title='Hot Items'])
+  snapit: true
+  expected:
+    wait: //div[@class='SubmenuContainer']/a[@title='New Arrivals']
+---
+page:
+  name: New Arrivals
+  action: click(//div[@class='SubmenuContainer']/a[@title='New Arrivals'])
+  snapit: true
+  expected:
+    wait: //*[@id='PagingViewAll']
+---
+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/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,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__"
+##
+
+# 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"
+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  --debug
+
+# 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.holidays.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)
+    wait2: 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: false
+  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']