lapis_lazuli 0.9.0 → 1.0.1

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

@@ -6,9 +6,58 @@
 # precondition_steps.rb is used to define steps that contain multiple steps to come to a certain start of a scenrario.
 # For example: "Given the user is logged in" will contain all steps done before logging in
 
-Given(/^the user has searched for "(.*?)" on (.*?) in (.*)$/) do |query, site, language|
+Given(/^the user has searched for "(.*?)" on "(.*?)"$/) do |query, page|
   # Run step to go to page
-  step "the user navigates to #{site} in #{language}"
+  step "the user navigates to \"#{page}\""
   # Run step to search
   step "the user searches for \"#{query}\""
-end
+
+end
+
+Given(/^the user is logged out$/) do
+  # In this step we want to make sure that the user is not logged in.
+  # If the user is not logged in, then this step does nothing, else it will trigger the logout step.
+
+  # Make this step independent by going to the homepage
+  step 'the user navigates to the "training-page" page'
+
+  # Check if the user is already logged in
+  loggedin = browser.find(
+    :like => [:img, :id, 'user-gravatar'],
+    :throw => false # This will prevent that the lookup will thow an error if it fails
+  )
+  if !loggedin.nil?
+    # Then try clicking the logout button
+    begin
+      step 'the user clicks on the logout button'
+    rescue Exception => e
+      # Ignoring the error, since it probably means we're already logged out.
+      log.debug "Logout failed, so I should already be logged out: #{e}"
+    end
+  end
+
+  # And confirm we've successfully logged out
+  step 'the page should display as logged out state'
+end
+
+Given(/^(".*?"|the user) is logged in$/) do |user_tag|
+  # First, make sure we're not logged into another account
+  step 'the user is logged out'
+  # Note: This could be more efficient, often you're already logged in with the correct user.
+  # So a different solution would be to check if the correct user is already logged in:
+  # set_user_data(user_tag)
+  # logged_in? = browser.find(
+  #          :span => {:text => get_user_data('username')},
+  #          :throw => false
+  # )
+  # if logged_in? skip the rest
+
+  # Then follow the login steps
+  step "#{user_tag} logs in"
+
+  # And confirm the login was successful
+  step 'the page should display as logged in state'
+end
+
+
+

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

@@ -20,4 +20,48 @@ Then(/text "([^"]*)" should display/) do |string|
 
   #       There's a shortcut for that in find/wait:
   browser.wait(:html => /#{string}/i)
+end
+
+Then(/^the user should be on page "(.*?)"$/) do |page|
+  # Get the expected url
+  expected_url = env('pages.root')
+  expected_url += env("pages.#{page}")
+
+  # A custom loop that waits 5 seconds until the expected_url is the same as the current url
+  start = Time.now
+  while browser.url != expected_url
+    break if (Time.now - start).to_i >= 5
+    sleep(0.1)
+  end
+
+  # Check if they are the same
+  if browser.url != expected_url
+    error("The current URL and expected URL were not the same: \n Current: #{current_url}\n Expected: #{expected_url}")
+  end
+end
+
+
+Then(/^the page should display as logged (in|out) state$/) do |logged|
+  # pending # Write code here that turns the phrase above into concrete actions
+
+  # Adjust variable for checking logged in or logged out state.
+  if logged == 'in'
+    condition = :until
+    message = 'Unable to find profile picture, the user wasnt logged in successfully'
+  elsif logged == 'out'
+    condition = :while
+    message = 'The profile picture is present, indicating that the user did not log out successfully'
+  end
+
+
+  # Try to find a way to confirm that a user is logged out.
+  # Easiest way is to a reversed check on an element that is only present when you're logged in
+  # For example, the profile picture
+  browser.wait(
+    :img => {:class => 'user-gravatar'},
+    :condition => condition,
+    :timeout => 5,
+    :message => message
+  )
+  # Lapis lazuli will automatically create a screenshot if this step fails.
 end

data/lib/lapis_lazuli/generators/cucumber/template/features/support/env.rb

@@ -6,4 +6,32 @@ require 'lapis_lazuli'
 require 'lapis_lazuli/cucumber'
 
 LapisLazuli::WorldModule::Config.config_file = "config/config.yml"
-World(LapisLazuli)
+World(LapisLazuli)
+
+# Do something when LapisLazuli is started (This is before the browser is opened)
+LapisLazuli.Start do
+
+  # This code snippet prevents the security popup to appear in FF v>47.
+  # If BROWSER is NIL, Lapis Lazuli will default to Firefox
+  if !ENV['BROWSER'] || ENV['BROWSER'] == 'firefox'
+    # Get Selenium to create a profile object
+    require 'selenium-webdriver'
+    profile = Selenium::WebDriver::Firefox::Profile.new
+    profile['network.http.phishy-userpass-length'] = 255
+    browser :firefox, :profile => profile
+  end
+end
+
+# This function is called before every scenario.
+Before do
+  # This can be very handy to make sure a browser has the same settings before a new scenario starts.
+  # For example, to enforce a certain browser window size
+  new_width = 1024
+  new_height = 768
+  current_size = browser.window.size
+  # Only change the browser size, if it is not already the correct size
+  unless current_size.width == new_width && current_size.height == new_height
+    log.info "Resizing browser to #{new_width}x#{new_height} (Was #{current_size.width}x#{current_size.height}"
+    browser.window.resize_to(new_width, new_height)
+  end
+end

data/lib/lapis_lazuli/generators/cucumber/template/features/support/functions.rb

@@ -0,0 +1,68 @@
+# Sometimes you're repeating a piece of code over and over again.
+# At that point you should consider making it a function.
+
+# Define a the user data to use.
+def set_user_data(data)
+  # Load the user data from the configuration file
+  user_data = config("users.#{data}")
+
+  # Replace all random and time values in the data
+  user_data = replace_hash_constants(user_data)
+
+  # Put it in the global variable
+  $USER_DATA = user_data
+
+end
+
+# Get the data for the requested field.
+def get_user_data(field)
+  # Make sure the user data is set before this function was called.
+  if $USER_DATA.nil?
+    error "No user data was set when get_user_data() was called for #{field}."
+  end
+  # Check if the specifically requested field is defined
+  if $USER_DATA[field].nil?
+    error "The requested user data `#{field}` does not exist. Are you sure it's defined in ./config/config.yml ?"
+  end
+  # Return te requested data
+  return $USER_DATA[field]
+end
+
+# Replace random or time values of a complete hash
+def replace_hash_constants(hash)
+  if hash.respond_to? :each
+    new_hash = {}
+    hash.each do |key, value|
+      new_hash[key] = replace_constants(value)
+    end
+  else
+    new_hash = replace_constants(hash)
+  end
+  return new_hash
+end
+
+# replace certain constants in a string, for example '_TIMESTAMP_' becomes '154875631'
+def replace_constants(value)
+  epoch = Time.now.to_i
+  alpha = number_to_letter(epoch)
+  timestamp = Time.now.strftime("D%Y-%M-%d-T%H-%M-%S")
+  value = value.to_s
+  old_val = value
+  value = value.sub('_RAND_', epoch.to_s)
+  value = value.sub('_TIMESTAMP_', timestamp)
+  value = value.sub('_RAND-ALPHA_', alpha)
+  unless value == old_val
+    log.debug "#{old_val} > #{value}"
+  end
+  return value
+end
+
+def number_to_letter(numbers)
+  num_string = numbers.to_s
+  alpha26 = ("a".."j").to_a
+  letters = ''
+  num_string.scan(/./).each do |number|
+    letters += alpha26[number.to_i]
+  end
+  return letters
+end

data/lib/lapis_lazuli/generic/xpath.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.
 #
 module LapisLazuli

data/lib/lapis_lazuli/options.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.
 #
 module LapisLazuli

data/lib/lapis_lazuli/placeholders.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/proxy.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/runtime.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 'singleton'

data/lib/lapis_lazuli/scenario.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 "securerandom"

data/lib/lapis_lazuli/storage.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.
 #
 module LapisLazuli

data/lib/lapis_lazuli/version.rb

@@ -2,9 +2,9 @@
 # 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.
 #
 module LapisLazuli
-  VERSION = "0.9.0"
+  VERSION = "1.0.1"
 end

data/lib/lapis_lazuli/versions.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 'lapis_lazuli/api'

data/lib/lapis_lazuli/world/annotate.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/world/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/world/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/world/config.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/world/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/world/hooks.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/world/logging.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/world/proxy.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/world/variable.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/test/Gemfile

@@ -1,44 +1,21 @@
 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 helper libraries
-gem 'rspec'
-gem 'gherkin'
-gem 'xml-simple'
-gem 'mechanize'
-
-# Debuggers
-platforms :ruby_18, :ruby_19 do
-  gem 'debugger'
-end
-platforms :ruby_20, :ruby_21 do
-  gem 'byebug'
-  gem 'rb-readline'
-end
-
 # Windows specific
 platforms :mswin, :mingw do
   gem 'win32console'
   gem 'term-ansicolor'
 end
 
+# LapisLazul itself; test code should point to the current repo and branch
+# repo = `git config --get remote.origin.url`
+# branch = `git rev-parse --abbrev-ref HEAD`
+# gem 'lapis_lazuli', :git => repo, :branch => branch
+# gem "lapis_lazuli", '0.9.9-dev', path: 'E:\Ruby\lib\ruby\gems\2.3.0\gems\lapis-lazuli-dev'
+gem "lapis_lazuli"
 
-# Install all the webdriver gems and cucumber
-gem 'watir-webdriver'
+# Project specific gems
 gem 'watir-scroll'
-# For testing old versions of cucumber, swap the two lines below
-gem 'cucumber', '>2.0'
-# gem 'cucumber', '=1.3.19'
-
-# Testing related
+gem 'xml-simple'
+gem 'mechanize'
 gem 'simplecov'
-gem 'test-unit'
-
-# LapisLazul itself; test code should point to the current repo and branch
-repo = `git config --get remote.origin.url`
-branch = `git rev-parse --abbrev-ref HEAD`
-gem 'lapis_lazuli', :git => repo, :branch => branch
+gem 'test-unit'