lapis_lazuli 0.9.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69ecad4834664da669d77a7df4e33aeaf78599f1
-  data.tar.gz: 8c8c532e1dcf5858a2d6a4e122b77596c50617dd
+  metadata.gz: 678920ee3f67c315ee099d4fa4e7d7d30f287265
+  data.tar.gz: 74f2220ac07fb93d431ebe44f18d11058c94b9b1
 SHA512:
-  metadata.gz: 0feef2515e1dd72ab4d7d815c0776a6feb1f05985eaf49f31fa1feb768c0e7e25f0a73af220b42ac2a50cea84a1beaf6c7f330c90cbb66923a5101f686ec1f96
-  data.tar.gz: 9957ee6a24b7c780527f6fa48e2f5a855d649c3a29e77aac292a3485bced58f1d0050cba7c22b1c1459d9bc645f4ec9c52280e70a6432bd551f38ce8a1730ce5
+  metadata.gz: 84fb25b85cf65cc290b286f2d3aec0c97bb58bd5287844752513d2de52e863821fe4ea58a1cd302c48e29dfb9e2c5db500bd73599a99d4d10a8e1e6dffb8b02e
+  data.tar.gz: cc24ed22c6bf41293ebfbc789dc1b36d7f239499c5a53abb6211dfbea378e66778735f654226b968ece874c1f85615c432be226396fcbe9430b2cf48e2cb61dd

data/README.md

@@ -17,6 +17,8 @@ such as:
 
 ## Installation
 
+For detailed installation notes, go to: http://www.testautomation.info/Installing_ruby_with_cucumber
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -67,7 +69,7 @@ name component will be considered the project name, so e.g. a path of
 Change to that newly created project directory and read the README.md file there
 for further instructions.
 
-Be sure to read [the Wiki](https://github.com/spriteCloud/lapis-lazuli/wiki) for
+Be sure to read [the GitHub Wiki](https://github.com/spriteCloud/lapis-lazuli/wiki) or [testautomation.info](http://www.testautomation.info/) for
 further documentation.
 
 ## Contributing
@@ -75,4 +77,4 @@ further documentation.
 Please see [the Wiki page on contributing](https://github.com/spriteCloud/lapis-lazuli/wiki/Contributing)
 
 ## License
-Copyright (c) 2013-2016 spriteCloud B.V. and other node-apinator contributors. See [the LICENSE file](LICENSE) for details.
+Copyright (c) 2013-2017 spriteCloud B.V. and other node-apinator contributors. See [the LICENSE file](LICENSE) for details.

data/lapis_lazuli.gemspec

@@ -23,6 +23,8 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{Cucumber helper functions and scaffolding for easier test automation suite development.}
   spec.homepage      = "https://github.com/spriteCloud/lapis-lazuli"
   spec.license       = "MITNFA"
+  spec.required_ruby_version = '~> 2'
+  spec.platform    = Gem::Platform::RUBY
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -42,4 +44,14 @@ Gem::Specification.new do |spec|
   spec.add_dependency "multi_xml", "~> 0.6"
   spec.add_dependency "teelogger", "~> 0.5"
   spec.add_dependency "minitest", "~> 5.10"
+  spec.add_dependency "ffi", "~> 1.9"
+  spec.add_dependency "rspec", "~> 3.5"
+
+  # webdriver specifics
+  spec.add_dependency "selenium-webdriver", "~> 3"
+  spec.add_dependency "watir", "~> 6"
+  spec.add_dependency "cucumber", "~> 2"
+
+  # Debugging tool
+  spec.add_dependency "byebug", "~> 9"
 end

data/lib/lapis_lazuli.rb

@@ -2,7 +2,7 @@
 # LapisLazuli
 # https://github.com/spriteCloud/lapis-lazuli
 #
-# Copyright (c) 2013-2016 spriteCloud B.V. and other LapisLazuli contributors.
+# Copyright (c) 2013-2017 spriteCloud B.V. and other LapisLazuli contributors.
 # All rights reserved.
 #
 

data/lib/lapis_lazuli/api.rb

@@ -2,7 +2,7 @@
 # LapisLazuli
 # https://github.com/spriteCloud/lapis-lazuli
 #
-# Copyright (c) 2013-2016 spriteCloud B.V. and other LapisLazuli contributors.
+# Copyright (c) 2013-2017 spriteCloud B.V. and other LapisLazuli contributors.
 # All rights reserved.
 #
 

data/lib/lapis_lazuli/argparse.rb

@@ -2,7 +2,7 @@
 # LapisLazuli
 # https://github.com/spriteCloud/lapis-lazuli
 #
-# Copyright (c) 2013-2016 spriteCloud B.V. and other LapisLazuli contributors.
+# Copyright (c) 2013-2017 spriteCloud B.V. and other LapisLazuli contributors.
 # All rights reserved.
 #
 

data/lib/lapis_lazuli/browser.rb

@@ -2,7 +2,7 @@
 # LapisLazuli
 # https://github.com/spriteCloud/lapis-lazuli
 #
-# Copyright (c) 2013-2016 spriteCloud B.V. and other LapisLazuli contributors.
+# Copyright (c) 2013-2017 spriteCloud B.V. and other LapisLazuli contributors.
 # All rights reserved.
 #
 

data/lib/lapis_lazuli/browser/error.rb

@@ -2,7 +2,7 @@
 # LapisLazuli
 # https://github.com/spriteCloud/lapis-lazuli
 #
-# Copyright (c) 2013-2016 spriteCloud B.V. and other LapisLazuli contributors.
+# Copyright (c) 2013-2017 spriteCloud B.V. and other LapisLazuli contributors.
 # All rights reserved.
 #
 

data/lib/lapis_lazuli/browser/find.rb

@@ -2,7 +2,7 @@
 # LapisLazuli
 # https://github.com/spriteCloud/lapis-lazuli
 #
-# Copyright (c) 2013-2016 spriteCloud B.V. and other LapisLazuli contributors.
+# Copyright (c) 2013-2017 spriteCloud B.V. and other LapisLazuli contributors.
 # All rights reserved.
 #
 

data/lib/lapis_lazuli/browser/interaction.rb

@@ -2,7 +2,7 @@
 # LapisLazuli
 # https://github.com/spriteCloud/lapis-lazuli
 #
-# Copyright (c) 2013-2016 spriteCloud B.V. and other LapisLazuli contributors.
+# Copyright (c) 2013-2017 spriteCloud B.V. and other LapisLazuli contributors.
 # All rights reserved.
 #
 

data/lib/lapis_lazuli/browser/remote.rb

@@ -2,7 +2,7 @@
 # LapisLazuli
 # https://github.com/spriteCloud/lapis-lazuli
 #
-# Copyright (c) 2013-2016 spriteCloud B.V. and other LapisLazuli contributors.
+# Copyright (c) 2013-2017 spriteCloud B.V. and other LapisLazuli contributors.
 # All rights reserved.
 #
 

data/lib/lapis_lazuli/browser/screenshots.rb

@@ -2,7 +2,7 @@
 # LapisLazuli
 # https://github.com/spriteCloud/lapis-lazuli
 #
-# Copyright (c) 2013-2016 spriteCloud B.V. and other LapisLazuli contributors.
+# Copyright (c) 2013-2017 spriteCloud B.V. and other LapisLazuli contributors.
 # All rights reserved.
 #
 

data/lib/lapis_lazuli/browser/wait.rb

@@ -2,7 +2,7 @@
 # LapisLazuli
 # https://github.com/spriteCloud/lapis-lazuli
 #
-# Copyright (c) 2013-2016 spriteCloud B.V. and other LapisLazuli contributors.
+# Copyright (c) 2013-2017 spriteCloud B.V. and other LapisLazuli contributors.
 # All rights reserved.
 #
 
@@ -59,11 +59,14 @@ module BrowserModule
       condition = options[:condition]
       options.delete(:condition)
 
-      # The easiest way to deal with find's new :throw policy is to set it to
-      # false.
-      options[:throw] = false
+      # Removing context from the options to preven an error in Marshal.dump
+      context = options[:selectors][0][:context]
+      options[:selectors][0].delete(:context)
 
-      # pp "got options: #{options}"
+      # The easiest way to deal with find's new :throw policy is to set it to false.
+      # We'll store the original value in a variable to catch it later.
+      throw = options[:throw]
+      options[:throw] = false
 
       # The proc we're waiting for invokes the find_func
       results = []
@@ -74,7 +77,10 @@ module BrowserModule
         retries.times do
           begin
             opts = Marshal.load(Marshal.dump(options))
+            # Putting :context back in the selector if it was used
+            opts[:selectors][0][:context] = context unless context.nil?
             results = send(find_func.to_sym, opts)
+
             if results.respond_to? :length
               res = (results.length > 0)
             else
@@ -104,16 +110,21 @@ module BrowserModule
         res = Watir::Wait.send(condition, timeout: timeout, &find_proc)
       rescue Watir::Wait::TimeoutError => e
         world.log.debug("Caught timeout: #{e}")
-        err = e
+        begin
+          # Catch the default error and add the selectors to it.
+          unless throw === false
+            # Only raise an error if :throw is not false
+            raise "#{e.message} with selectors: #{options[:selectors]}"
+          end
+        rescue RuntimeError => err
+          options[:exception] = err
+          options[:message] = optional_message('Error in wait', options)
+          world.error(options)
+        end
       end
 
       # Filter out any nil results
       filter_results = results.select {|i| not i.nil?}
-      # Error handling
-      if not err.nil?
-        options[:exception] = err
-        world.error(options)
-      end
 
       # Set if the underlying find function returns single results
       if has_single
@@ -132,6 +143,7 @@ module BrowserModule
         :stale_retries => 3,
         :condition => :until,
         :screenshot => false,
+        :throw => true
       }
       options = ERROR_OPTIONS.merge options
       options = parse_args(options, :selectors, *args)
@@ -150,7 +162,6 @@ module BrowserModule
           sel[:filter_by] = :present?
         end
       end
-
       return options
     end
   end # module Wait

data/lib/lapis_lazuli/cli.rb

@@ -2,7 +2,7 @@
 # LapisLazuli
 # https://github.com/spriteCloud/lapis-lazuli
 #
-# Copyright (c) 2013-2016 spriteCloud B.V. and other LapisLazuli contributors.
+# Copyright (c) 2013-2017 spriteCloud B.V. and other LapisLazuli contributors.
 # All rights reserved.
 #
 require 'thor'

data/lib/lapis_lazuli/cucumber.rb

@@ -2,7 +2,7 @@
 # LapisLazuli
 # https://github.com/spriteCloud/lapis-lazuli
 #
-# Copyright (c) 2013-2016 spriteCloud B.V. and other LapisLazuli contributors.
+# Copyright (c) 2013-2017 spriteCloud B.V. and other LapisLazuli contributors.
 # All rights reserved.
 #
 

data/lib/lapis_lazuli/generators/cucumber.rb

@@ -2,7 +2,7 @@
 # LapisLazuli
 # https://github.com/spriteCloud/lapis-lazuli
 #
-# Copyright (c) 2013-2016 spriteCloud B.V. and other LapisLazuli contributors.
+# Copyright (c) 2013-2017 spriteCloud B.V. and other LapisLazuli contributors.
 # All rights reserved.
 #
 

data/lib/lapis_lazuli/generators/cucumber/template/Gemfile

@@ -1,12 +1,8 @@
 source 'http://rubygems.org'
 
-# Add following two lines to your ~/.gemrc or /etc/gemrc:
-# install: --no-rdoc --no-ri
-# update:  --no-rdoc --no-ri
-
-# Install all the webdriver gems and cucumber
-gem 'watir'
-gem 'cucumber'
+# Run your project as following
+# > bundle install
+# > bundle exec cucumber
 
 # LapisLazul itself
 gem 'lapis_lazuli', <%= config[:lapis_lazuli][:dependency] %>

data/lib/lapis_lazuli/generators/cucumber/template/README.md

@@ -6,8 +6,10 @@ Author: "<%= config[:user] %>" <<%= config[:email] %>>
 
 ## General
 
-- Make sure you have ruby 1.9 or later installed.
+- Make sure you have ruby 2.0 or later installed.
 - Make sure you have firefox and/or chrome installed
+- Download chromedriver and put it into your ./ruby/bin folder
+- Download geckodriver and put it into your ./ruby/bin folder
 - Install the bundler gem:
 
     $ gem install bundler

data/lib/lapis_lazuli/generators/cucumber/template/config/config.yml

@@ -21,9 +21,39 @@ error_strings:
 ################################################################################
 # Environment specific variables
 test:
+  pages:
+    root: http://username:password@test.spritecloud.com #Not an existing page, note the username/password user inside the URL
+    home: /
+    about-us: /about-us/
 
 uat:
+  pages:
+    root: http://username:password@uat.spritecloud.com #Not an existing page, note the username/password user inside the URL
+    home: /
+    about-us: /about-us/
 
 production:
-  google:
-      english: http://www.google.com/ncr
+  pages:
+    root: https://spritecloud.com
+    home: /
+    about-us: /about-us/
+    testing: /testing/
+    blog: /blog/
+    functional-testing: /testing/functional/
+  training-page: http://training-page.testautomation.info
+
+
+# Different user variables
+users:
+  default-user: # These are the default variable settings. If no setting was specified, these values will be used.
+    username: test
+    password: test
+    gender: 'Male'
+    experience: 'Ruby,Cucumber,HTML,XPath'
+    biography: 'Hello, I am Gijs, I am a Test Engineer for spriteCloud and I like to be lazy and let machines do my work'
+  random-user: # In ./features/support/functions.rb '_RAND-ALPHA_' is replaces for random alphanumeric characters.
+    username: usr_RAND-ALPHA_
+    password: test_RAND_
+    gender: 'Female'
+    experience: 'Ruby,Gherkin'
+    biography: 'Hello, I am a randomized user, today is _TIMESTAMP_ seconds after the existance of computers'

data/lib/lapis_lazuli/generators/cucumber/template/config/cucumber.yml

@@ -1,13 +1,4 @@
-################################################################################
-# Copyright <%= config[:year] %> spriteCloud B.V. All rights reserved.
-# Generated by LapisLazuli, version <%= config[:lapis_lazuli][:version] %>
-# Author: "<%= config[:user] %>" <<%= config[:email] %>>
-#
-# Ask developer of testsuite to add profiles where desired.
-# This file defines predefined profiles that can be used.
-# Example > Cucumber -t @homepage -p default -p localhost
 
-<%% timestamp = Time.now.strftime("%Y%m%d_%H%M") %>
 
 ################################################################################
 # Type of testrun

data/lib/lapis_lazuli/generators/cucumber/template/features/account.feature

@@ -0,0 +1,26 @@
+@account
+Feature: User accounts
+  This feature will make sure the user account functionality is working as expected
+  By checking registration, login and logout functionality
+
+  # This is a best practise example. Please note the following
+  # By defining a register, log-in and log-out state, we can easily re-use all these preconditions
+  # All the scenario's aren't completed, but it should be easy to implement it into your own project.
+
+  @account01 @log_in #@pause # You can add @pause to have a break between every step.
+  Scenario: account01 - Logging in
+    Given the user is logged out
+    When "default-user" logs in
+    Then the page should display as logged in state
+
+  @account02 @log_out
+  Scenario: account01 - Logging out
+    Given "default-user" is logged in
+    When the user clicks on the logout button
+    Then the page should display as logged out state
+
+  @account03 @registration
+  Scenario: account03 - Registation
+    Given the user is logged out
+    When "random-user" registers for a new account
+    Then the page should display as logged in state

data/lib/lapis_lazuli/generators/cucumber/template/features/example.feature

@@ -4,14 +4,27 @@ When I want to learn how to make test cases
 As a user of the test automation tool
 I want to run and adjust the tests below
 
-    @example01
-    Scenario: example01 - Google Search
-        Given the user navigates to Google in english
-        When the user searches for "spriteCloud"
-        Then text "www.spriteCloud.com" should display
+  @example01
+  Scenario: example01 - Spritecloud search
+    Given the user navigates to "blog"
+    When the user searches for "lapis lazuli"
+    Then text "Open Source" should display
 
-    @example02
-    Scenario: example02 - Going to a search result
-        Given the user has searched for "spriteCloud" on Google in english
-        When the user clicks on link "spritecloud.com"
-        Then text "Test your software, not your reputation" should display
+  @example02
+  Scenario: example02 - Going to a search result
+    Given the user has searched for "lapis lazuli" on "blog"
+    When the user clicks on link "/announcing-lapislazuli/"
+    Then text "Let's talk about testing" should display
+
+  @example03
+  Scenario Outline: example03 - checking multiple pages for the logo
+    Given the user navigates to "<page>"
+    When the user clicks on the spritecloud logo
+    Then the user should be on page "home"
+    Scenarios:
+      | page               |
+      | blog               |
+      | home               |
+      | about-us           |
+      | testing            |
+      | functional-testing |

data/lib/lapis_lazuli/generators/cucumber/template/features/step_definitions/interaction_steps.rb

@@ -5,18 +5,29 @@
 
 # interactions_steps.rb is used to interact with elements on the page.
 
-Given(/^the user navigates to (.*?) in (.*?)$/) do |site, language|
-  # Combine the configuration depth with dots
-  config_name = "#{site.downcase}.#{language.downcase}"
+Given(/^the user navigates to "(.*?)"$/) do |page|
   # Get the value of the configuration (see /config/config.yml)
-  url         = env(config_name)
+
+  # First grab the root URL defined in the config
+  url = env('pages.root')
+  # Then add the page specific part to the URL
+  url += env("pages.#{page}")
+
+  # Go to the URL
+  browser.goto url
+end
+
+Given(/^the user navigates to the "(.*?)" page$/) do |page|
+  # Get the value of the configuration (see /config/config.yml)
+  url = env("#{page}")
+
   # Go to the URL
   browser.goto url
 end
 
 Given(/^the user searches for "(.*?)"$/) do |query|
   # Get the input element
-  searchbox = browser.find(:text_field => {:name => "q"})
+  searchbox = browser.find(:text_field => {:name => "s"})
   # Make sure the input field is empty
   searchbox.clear rescue log.debug "Could not clear searchbox"
   # Fill in the query
@@ -29,9 +40,126 @@ When(/^the user clicks on link "(.*?)"$/) do |url|
   # Search for the element that includes the expected text
   browser.wait(
     :like => {
-      :element   => :a,
+      :element => :a,
       :attribute => :href,
-      :include   => url
+      :include => url
     }
   ).click
+end
+
+When(/^the user clicks on the spritecloud logo$/) do
+  # Search for the logo
+  logo = browser.find(
+    :like => [:img, :id, 'logo'],
+    :message => 'Unable to find the logo on this page.'
+  )
+  # And click the logo
+  logo.click
+end
+
+# A step definition is a regex, to learn more about this go to http://rubular.com/
+# The following step definition accepts both:
+# - the user logs in > will use the last stored user data
+# - "user-x" logs in > will load user data from config.yml
+When(/^"?(.*?|the user)"? logs in$/) do |user_tag|
+  if user_tag != 'the user'
+    # Set the user data
+    set_user_data(user_tag)
+  end
+  # Fill in the user form
+  browser.find(
+    :like => [:input, :id, 'login-username']
+  ).set(get_user_data('username'))
+  browser.find(
+    :like => [:input, :id, 'login-password']
+  ).set(get_user_data('password'))
+
+  # Press the submit button
+  browser.find(
+    :like => [:button, :id, 'button-login']
+  ).click
+end
+
+When(/^the user clicks on the logout button$/) do
+  # pending # This is an example
+
+  # First get the header to use as a context for the logout button
+  header = browser.wait(:like => [:nav, :class, 'navbar-fixed-top'])
+
+  # Then click the logout button (in this case, first a drop down needs to be clicked, before the logout button shows)
+  browser.find(
+    :like => [:a, :id, 'user_dropdown'],
+    :context => header,
+    :message => 'Unable to click on the user icon'
+  ).click
+  dropdown = browser.wait(
+    :like => [:ul, :class, 'dropdown-menu'],
+    :timeout => 5,
+    :message => 'The user dropdown didn`t become present.'
+  )
+  browser.find(
+    :like => [:a, :id, 'link-logout'],
+    :context => dropdown,
+    :error => 'Failed to click the logout button.'
+  ).click
+end
+
+When(/^"(.*?)" registers for a new account$/) do |user_tag|
+  # pending # Write code here that turns the phrase above into concrete actions
+
+  # Set the user data
+  set_user_data(user_tag)
+
+  # Go to the registration page
+  step 'the user navigates to the "training-page" page'
+  browser.find(:like => [:button, :id, 'button-register']).click
+
+  # Fill in the form
+
+  # Get the form container and use it as a context to find the fields
+  form = browser.wait(:like => [:form, :id, 'form-register'])
+
+  # Fill in the details
+  browser.find(:element => {:name => 'username'}, :context => form).set get_user_data('username')
+  browser.find(:element => {:name => 'password'}, :context => form).set get_user_data('password')
+
+  # Select gender
+  browser.find(
+    :label => {:text => /#{get_user_data('gender')}/i},
+    :context => form,
+    :message => "Unable to find gender `#{get_user_data('gender')}`, are you sure it's an option to select??"
+  ).click
+
+  # Select experiences from the multi-select list
+  multi_selector = browser.find(:like => [:select, :id, "register-experience"], :context => form)
+  experiences = get_user_data('experience')
+  # Experiences is a list of words comma separated, EG `Ruby,Cucumber,Watir`
+  # The following function will cut text at every comma, and loop trough every separate word
+  experiences.split(',').each do |exp|
+    option = browser.find(
+      :option => {:value => /#{exp}/i},
+      :context => multi_selector
+    )
+    option.click
+  end
+
+  # Fill in the biagraphy
+  browser.find(
+    :like => [:textarea, :id, 'register-bio']
+  ).send_keys(get_user_data('biography'))
+
+  # Click the accept policy checkbox
+  browser.find(:like => [:input, :id, 'register-complete-all']).click
+
+  # Press the submit button
+  browser.find(:button => {:id => 'button-save'}).click
+
+  # Wait for the success message to display
+  browser.wait(
+    :like => [:div, :class, 'alert-success'],
+    :message => 'The successfully registered message did not display.'
+  )
+
+  # The website we're testing on, doesn't log in the user automatically. So let's trigger that step manually
+  step 'the user logs in'
 end