lapis_lazuli 0.6.1

data/lib/lapis_lazuli/world/hooks.rb

@@ -0,0 +1,109 @@
+#
+# LapisLazuli
+# https://github.com/spriteCloud/lapis-lazuli
+#
+# Copyright (c) 2013-2014 spriteCloud B.V. and other LapisLazuli contributors.
+# All rights reserved.
+#
+
+module LapisLazuli
+module WorldModule
+  ##
+  # Module with cucumber hooks
+  #
+  # The module is special in that it does not include other modules. Instead it
+  # always tests whether World responds to a function before calling it.
+  module Hooks
+    ##
+    # Add hooks to one of the four queues :before, :after, :start or :end.
+    HOOK_QUEUES = [
+      :before,
+      :after,
+      :start,
+      # :end # FIXME hard to implement. See issue #13
+    ]
+    def self.add_hook(queue, hook)
+      if not HOOK_QUEUES.include?(queue)
+        raise "Invalid hook queue #{queue}"
+      end
+
+      @@hooks ||= {}
+      @@hooks[queue] ||= []
+      @@hooks[queue] << hook
+    end
+
+    ##
+    # Hook invoked in BeforeScenario
+    def before_scenario_hook(cuke_scenario)
+      # Update the scenario informaton
+      if respond_to? :scenario
+        scenario.running = true
+        scenario.update(cuke_scenario)
+      end
+
+      # Show the name
+      if respond_to? :log
+        log.info("Starting Scenario: #{scenario.id}")
+      end
+
+      # Run 'start' queue once.
+      @@started ||= false
+      if not @@started
+        @@started = true
+        run_queue(:start, cuke_scenario)
+      end
+
+      # Run 'before' queue
+      run_queue(:before, cuke_scenario)
+    end
+
+    ##
+    # Hook invoked in AfterScenario
+    def after_scenario_hook(cuke_scenario)
+      # Run 'after' queue
+      run_queue(:after, cuke_scenario)
+
+      # Run 'end' queue
+      # FIXME hard to implement; see issue #13
+
+      # The current scenario has finished
+      if respond_to? :scenario
+        scenario.running = false
+      end
+
+      # Sleep if needed
+      if respond_to? :config and has_env_or_config?("step_pause_time")
+        sleep env_or_config("step_pause_time")
+      end
+
+      # Did we fail?
+      if respond_to? :scenario and respond_to? :browser and respond_to? :config
+        if (cuke_scenario.failed? or (scenario.check_browser_errors and browser.has_error?))
+          # Take a screenshot if needed
+          if has_env_or_config?('screenshot_on_failure')
+            fileloc = browser.take_screenshot()
+          end
+        end
+      end
+
+      # Close browser if needed
+      if respond_to? :browser
+        browser.close_after_scenario(cuke_scenario)
+      end
+    end
+
+  private
+    def run_queue(queue, cuke_scenario)
+      @@hooks ||= {}
+
+      if @@hooks[queue].nil?
+        return
+      end
+
+      @@hooks[queue].each do |hook|
+        self.instance_exec(cuke_scenario, &hook)
+      end
+    end
+  end # module Hooks
+end # module WorldModule
+end # module LapisLazuli

data/lib/lapis_lazuli/world/logging.rb

@@ -0,0 +1,53 @@
+#
+# LapisLazuli
+# https://github.com/spriteCloud/lapis-lazuli
+#
+# Copyright (c) 2013-2014 spriteCloud B.V. and other LapisLazuli contributors.
+# All rights reserved.
+#
+
+require "teelogger"
+
+require "lapis_lazuli/runtime"
+
+require "lapis_lazuli/world/config"
+
+module LapisLazuli
+module WorldModule
+  ##
+  # Module for easy logging
+  #
+  # Manages the following:
+  #   @log        - TeeLogger instances
+  module Logging
+    include LapisLazuli::WorldModule::Config
+
+    ##
+    # Log "singleton"
+    def log
+      return Runtime.instance.set_if(self, :logger) do
+        # Make log directory
+        dir = env_or_config('log_dir')
+        begin
+          Dir.mkdir dir
+        rescue SystemCallError => ex
+          # Swallow this error; it occurs (amongst other situations) when the
+          # directory exists. Checking for an existing directory beforehand is
+          # not concurrency safe.
+        end
+
+        # Start the logger with the config filename
+        log_file = "#{dir}#{File::SEPARATOR}#{File.basename(Config.config_file, ".*")}.log"
+        # Or a filename from the environment
+        if has_env_or_config?("log_file")
+          log_file = env_or_config("log_file")
+        end
+        l = TeeLogger::TeeLogger.new(STDOUT, log_file)
+        l.level = env_or_config("log_level")
+
+        l
+      end
+    end
+  end # module Logging
+end # module WorldModule
+end # module LapisLazuli

data/lib/lapis_lazuli/world/proxy.rb

@@ -0,0 +1,59 @@
+#
+# LapisLazuli
+# https://github.com/spriteCloud/lapis-lazuli
+#
+# Copyright (c) 2013-2014 spriteCloud B.V. and other LapisLazuli contributors.
+# All rights reserved.
+#
+
+require "lapis_lazuli/proxy"
+require "lapis_lazuli/runtime"
+
+require "lapis_lazuli/world/config"
+require "lapis_lazuli/world/logging"
+
+module LapisLazuli
+module WorldModule
+  ##
+  # Module managing a proxy instance
+  module Proxy
+    include LapisLazuli::WorldModule::Config
+    include LapisLazuli::WorldModule::Logging
+
+    ##
+    # Checks if there is a proxy started
+    def has_proxy?
+      p = Runtime.instance.get :proxy
+      return !p.nil?
+    end
+
+    ##
+    # Get the current proxy
+    def proxy
+      return Runtime.instance.set_if(self, :proxy) do
+        # Check if we can start a proxy
+        begin
+          # Default proxy settings
+          proxy_ip = "localhost"
+          proxy_port = 10000
+          proxy_master = true
+
+          # Do we have a config?
+          if has_env_or_config?("proxy.ip") and has_env_or_config?("proxy.port")
+            proxy_ip = env_or_config("proxy.ip")
+            proxy_port = env_or_config("proxy.port")
+            proxy_master = env_or_config("proxy.spritecloud", true)
+          end
+
+          # Try to start the proxy
+          p = LapisLazuli::Proxy.new(proxy_ip, proxy_port, proxy_master)
+
+          log.debug("Found proxy: #{proxy_ip}:#{proxy_port}, spritecloud: #{proxy_master}")
+        rescue StandardError => err
+          log.debug("No proxy available: #{err}")
+        end
+      end
+    end
+  end # module Proxy
+end # module WorldModule
+end # module LapisLazuli

data/lib/lapis_lazuli/world/variable.rb

@@ -0,0 +1,139 @@
+#
+# LapisLazuli
+# https://github.com/spriteCloud/lapis-lazuli
+#
+# Copyright (c) 2013-2014 spriteCloud B.V. and other LapisLazuli contributors.
+# All rights reserved.
+#
+
+require "securerandom"
+require 'json'
+
+require "lapis_lazuli/scenario"
+require "lapis_lazuli/versions"
+require "lapis_lazuli/runtime"
+require "lapis_lazuli/placeholders"
+
+require "lapis_lazuli/world/config"
+
+module LapisLazuli
+module WorldModule
+  ##
+  # Module for variable replacement
+  #
+  # Manages the following:
+  #   scenario   - for per-scenario variables
+  #   uuid       - for the entire test run
+  #   time       - for the entire test run
+  #   storage    - for the entire test run
+  #   versions   - versions as gathered by e.g. fetch_versions
+  module Variable
+    include LapisLazuli::WorldModule::Config
+
+    ##
+    # Scenario "singleton"
+    def scenario
+      return data(:scenario) do
+        Scenario.new
+      end
+    end
+
+    ##
+    # Time "singleton"
+    def time
+      return data(:time) do
+        time = Time.now
+        @time = {
+          :timestamp => time.strftime('%y%m%d_%H%M%S'),
+          :iso_timestamp => time.utc.strftime("%FT%TZ"),
+          :iso_short => time.utc.strftime("%y%m%dT%H%M%SZ"),
+          :epoch => time.to_i.to_s
+        }
+      end
+    end
+
+    ##
+    # UUID "singleton"
+    def uuid
+      return data(:uuid) do
+        SecureRandom.hex
+      end
+    end
+
+    ##
+    # Storage "singleton"
+    def has_storage?
+      b = Runtime.instance.get :variable_data
+      return !b[:storage].nil?
+    end
+
+    def storage
+      return data(:storage) do
+        storage = Storage.new
+        storage.set("time", time)
+        storage.set("uuid", uuid)
+
+        storage
+      end
+    end
+
+
+    ##
+    # Update the variable with timestamps
+    def variable(string)
+      init
+
+      email_domain = "spriteymail.net"
+      if has_env_or_config?("email_domain")
+        email_domain = env_or_config("email_domain")
+      end
+      random_uuid = SecureRandom.hex
+
+      # Prepare current values.
+      values = {}
+      LapisLazuli::PLACEHOLDERS.each do |placeholder, value|
+        values[placeholder] = eval value[0]
+      end
+
+      return string % values
+    end
+
+    ##
+    # Same as variable, but modify the string.
+    def variable!(string)
+      string.replace(variable(string))
+    end
+
+  private
+
+    def data(name, &block)
+      d = Runtime.instance.get :variable_data
+      if not d.nil?
+        if not d.is_a? Hash
+          raise "Expect a hash for variables managed by the Variable module"
+        end
+      else
+        d = {}
+      end
+
+      if not d.has_key? name
+        value = block.call()
+        d[name] = value
+
+        Runtime.instance.set(self, :variable_data, d, Variable.destroy(self))
+      end
+
+      return d[name]
+    end
+
+
+    def self.destroy(world)
+      Proc.new do |w|
+        if world.has_storage?
+          world.storage.destroy(world)
+        end
+      end
+    end
+  end # module Variable
+end # module WorldModule
+end # module LapisLazuli

data/lib/lapis_lazuli.rb

@@ -0,0 +1,75 @@
+#
+# LapisLazuli
+# https://github.com/spriteCloud/lapis-lazuli
+#
+# Copyright (c) 2013-2014 spriteCloud B.V. and other LapisLazuli contributors.
+# All rights reserved.
+#
+
+begin
+  require "simplecov"
+  require "rubygems"
+  spec = Gem::Specification.find_by_name("lapis_lazuli")
+  gem_root = "#{spec.gem_dir}#{File::SEPARATOR}"
+  coverage_root = "#{gem_root}lib"
+  output_dir = "#{Dir.getwd}#{File::SEPARATOR}coverage"
+  template_dir = "#{coverage_root}lib#{File::SEPARATOR}lapis_lazuli#{File::SEPARATOR}generators#{File::SEPARATOR}cucumber"
+
+  if ENV['COVERAGE']
+    puts "Enabling code coverage for files under '#{coverage_root}';"
+    puts "coverage reports get written to '#{output_dir}'."
+    SimpleCov.start do
+      root(coverage_root)
+      coverage_dir(output_dir)
+      add_filter(template_dir)
+    end
+  end
+rescue LoadError
+  # do nothing
+end
+
+require "lapis_lazuli/version"
+
+require "lapis_lazuli/world/config"
+require "lapis_lazuli/world/hooks"
+require "lapis_lazuli/world/variable"
+require "lapis_lazuli/world/error"
+require "lapis_lazuli/world/annotate"
+require "lapis_lazuli/world/logging"
+require "lapis_lazuli/world/browser"
+require "lapis_lazuli/world/api"
+require "lapis_lazuli/generic/xpath"
+
+
+module LapisLazuli
+  ##
+  # Includes all the functionality from the following modules.
+  include LapisLazuli::WorldModule::Config
+  include LapisLazuli::WorldModule::Hooks
+  include LapisLazuli::WorldModule::Variable
+  include LapisLazuli::WorldModule::Error
+  include LapisLazuli::WorldModule::Annotate
+  include LapisLazuli::WorldModule::Logging
+  include LapisLazuli::WorldModule::Browser
+  include LapisLazuli::WorldModule::API
+  include LapisLazuli::GenericModule::XPath
+
+  ##
+  # Export equivalents to cucumber's Before/After functions
+  def self.Before(&block)
+    LapisLazuli::WorldModule::Hooks.add_hook(:before, block)
+  end
+
+  def self.After(&block)
+    LapisLazuli::WorldModule::Hooks.add_hook(:after, block)
+  end
+
+  def self.Start(&block)
+    LapisLazuli::WorldModule::Hooks.add_hook(:start, block)
+  end
+
+# FIXME hard to implement; leaving it for now. See issue #13
+#  def self.End(&block)
+#    LapisLazuli::WorldModule::Hooks.add_hook(:end, block)
+#  end
+end # module LapisLazuli

data/test/.gitignore

@@ -0,0 +1,8 @@
+.*.sw*
+
+logs
+storage
+tmp
+version_tmp
+screenshots
+Gemfile.lock

data/test/Gemfile

@@ -0,0 +1,42 @@
+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
+
+
+# Install all the webdriver gems and cucumber
+gem 'watir-webdriver'
+gem 'watir-webdriver-performance'
+gem 'watir-scroll'
+# For testing old versions of cucumber, swap the two lines below
+gem 'cucumber', '>1.3.19'
+# gem 'cucumber', '=1.3.19'
+
+# Testing related
+gem 'simplecov'
+
+# LapisLazul itself
+gem 'lapis_lazuli', :github => 'spriteCloud/lapis-lazuli', :branch => 'master'

data/test/README.md

@@ -0,0 +1,35 @@
+# Lapis Lazuli Test Suite
+
+This cucumber project contains a web server with simple test cases to validate Lapis Lazuli behavior.
+
+Author: "Onno Steenbergen" <onno@spritecloud.com>
+
+# Setup
+
+## General
+
+- Make sure you have ruby 2.1 or later installed.
+- Make sure you have firefox and/or chrome installed
+- Install the bundler gem:
+
+    $ gem install bundler
+
+- Install all of the required gems defined in the gemfile:
+
+    $ bundle install
+
+- Run cucumber through bundler:
+
+    $ bundle exec cucumber
+
+# Code Coverage
+
+Code coverage can be enabled if the `simplecov` gem is installed, by specifying
+the `COVERAGE` environment variable when running the test suite:
+
+    $ COVERAGE=1 bundle exec cucumber
+
+# Contributing
+
+If you create new utility functions and want to contribute them to the Lapis
+Lazuli project, see https://github.com/spriteCloud/lapis-lazuli

data/test/config/config.yml

@@ -0,0 +1,37 @@
+################################################################################
+# Copyright 2014 spriteCloud B.V. All rights reserved.
+# Generated by LapisLazuli, version 0.0.1
+# Author: "Onno Steenbergen" <onno@steenbe.nl>
+#
+# Config file for the test automation
+# When a config_local.yml exists, that will then be loaded instead of this default config file
+
+################################################################################
+# Set the global variables
+default_env: production                   # defines the environment
+screenshots_dir: screenshots              # where to save the screenshots
+step_pause_time: 1                        # Waiting time in seconds defined after a step completes
+make_screenshot_on_failed_scenario: true  # make a screenshot after a scenario fails
+old_portal: true
+close_browser_after: feature
+
+
+################################################################################
+# List of error strings. Step will fail if one of these strings is detected.
+error_strings:
+  [
+    "Server Error",
+    "Error: Page Not Found"
+  ]
+
+
+################################################################################
+# Environment specific variables
+test:
+
+uat:
+
+production:
+  close_browser_after: feature
+  server:
+      url: http://localhost:9090/

data/test/config/cucumber.yml

@@ -0,0 +1,37 @@
+################################################################################
+# Copyright 2014 spriteCloud B.V. All rights reserved.
+# Generated by LapisLazuli, version 0.0.1
+# Author: "Onno Steenbergen" <onno@steenbe.nl>
+#
+# 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
+default: -f pretty -x
+debug: -f pretty BREAKPOINT_ON_FAILURE=1
+html_report: -f pretty -f html --out=results/<%=timestamp%>_report.html
+junit_report: -f pretty -f junit --out=results
+
+################################################################################
+# Supported browsers (default = firefox)
+# TODO: Make it functional on Chrome and IE
+ff: BROWSER=firefox
+chrome: BROWSER=chrome
+ie: BROWSER=ie
+safari: BROWSER=safari
+
+
+################################################################################
+# Listed environments (default is set in config.yml)
+t: TEST_ENV=test -t @t,@test
+test: TEST_ENV=test -t @t,@test
+
+u: TEST_ENV=acceptatie -t @u,@uat
+uat: TEST_ENV=acceptatie -t @u,@uat
+
+p: TEST_ENV=production -t @p,@prod
+production: TEST_ENV=production -t @p,@prod

data/test/features/annotation.feature

@@ -0,0 +1,23 @@
+@annotation @p
+Feature: annotiations
+  When I want to test the Lapis Lazuli library
+  I want to run a webserver with some test files
+  And execute the each library function that handles annotations.
+
+  @annotation_01
+  Scenario Outline: annotation_01 - scenario outline
+    Given I annotate a step with <data1>
+    And I annotate a step with <data2>
+    Then the report should include <data1> and <data2> in the correct place
+
+    Examples:
+      | data1 | data2 |
+      | foo   | bar   |
+      | foo   |       |
+      |       | bar   |
+
+  @annotation_02
+  Scenario: annotation_01 - single scenario
+    Given I annotate a step with baz
+    And I annotate a step with quux
+    Then the report should include baz and quux in the correct place

data/test/features/browser.feature

@@ -0,0 +1,10 @@
+@browser @p
+Feature: Browsers
+When I want to test the Lapis Lazuli library
+And test if I can start a browser with options
+
+@browser_01
+Scenario: browser_01 - Firefox with proxy
+  When I create a firefox browser named "test" with proxy to "localhost:8008"
+  Then the firefox browser named "test" has a profile
+  Then I close the browser named "test"

data/test/features/button.feature

@@ -0,0 +1,38 @@
+@button @p
+Feature: Buttons
+  When I want to test the Lapis Lazuli library
+  I want to run a webserver with some test files
+  And execute the each library function that handles buttons.
+
+  @button_01
+  Scenario: button_01 - Find First
+    Given I navigate to the button test page
+    Then the first button should be the first element on the page
+    And the 1st button should be the first element on the page
+    And the first button should not be the last element on the page
+
+  @button_02
+  Scenario: button_02 - Find based on index
+    Given I navigate to the button test page
+    Then the 3rd button should be the 3rd element on the page
+    And the 3rd button should not be the 2nd element on the page
+    And the 3rd button should not be the last element on the page
+    And the 3rd button should not be the first element on the page
+
+  @button_03
+  Scenario: button_03 - Hidden elements
+    Given I navigate to the button test page
+    Then the 4th button should not be present
+    And the 5th button should be present
+
+  @button_04
+  Scenario: button_04 - Clicking First
+    Given I navigate to the button test page
+    And I click the first button
+    Then within 1 seconds I should see "first clicked"
+
+  @button_05
+  Scenario: button_05 - Clicking Last
+    Given I navigate to the button test page
+    And I click the last button
+    Then within 1 seconds I should see "last clicked"