watirmark 5.14.16 → 5.27.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2cd92d1a9b252f89b9bd5d392fd880321ea5eee0
+  data.tar.gz: 87d2a5c9088b3c8eaa7fe58fdc51618de4b56c19
+SHA512:
+  metadata.gz: ffd2177cd8b04c599fb803f4ab52e611b85da37a3ac8c72547549d693475084b342c43c769eee7a3c3a449e9196bedea140d43765462400826333770c9d3ec2d
+  data.tar.gz: 9b45889cebcc93fb2c6f5124e9d191f152c6443e2e94ec32cd9b6b23c04aea862c9b3df5113aebff0296be548301d9ac1ce47c660657f62dab7a7068e036051e

data/bin/watirmark

@@ -1,10 +1,4 @@
 #!/usr/bin/env ruby
-$:<< File.dirname(__FILE__)
 
-require 'rubigen'
-require 'rubigen/scripts/generate'
-
-source = RubiGen::PathSource.new(:application, File.join(File.dirname(__FILE__), "../app_generators"))
-RubiGen::Base.reset_sources
-RubiGen::Base.append_sources source
-RubiGen::Scripts::Generate.new.run(ARGV, :generator => 'create_project')
+require File.expand_path('../../generators/new_project/generator', __FILE__)
+NewProject.start

data/generators/new_project/generator.rb

@@ -0,0 +1,58 @@
+require 'thor/group'
+require 'active_support/inflector'
+
+class NewProject < Thor::Group
+  include Thor::Actions
+
+  argument :name, banner: 'creates new test project'
+
+  def self.source_root
+    File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+  end
+
+  def root_files
+    template "gemfile.rb.erb", "#{name}/Gemfile"
+    template "config.yml.erb", "#{name}/config.yml"
+    template "rakefile.rb.erb", "#{name}/rakefile.rb"
+  end
+
+  def lib_files
+    template "lib/configuration.rb.erb", File.join(name, "lib", name, "configuration.rb")
+    template "lib/workflows.rb.erb", File.join(name, "lib", name, "workflows.rb")
+    template "lib/core_libraries.rb.erb", File.join(name, "lib", name, "core_libraries.rb")
+    template "lib/loader.rb.erb", File.join(name, "lib", name, "loader.rb")
+    template "lib/name.rb.erb", File.join(name, "lib", "#{name}.rb")
+  end
+
+  def lib_checkers_files
+    template "lib/name/checkers/page_load_checker.rb.erb", File.join(name, "lib", name, "checkers", "page_load_checker.rb")
+    template "lib/name/checkers/post_errors_checker.rb.erb", File.join(name, "lib", name, "checkers", "post_errors_checker.rb")
+  end
+
+  def lib_site_files
+    template "lib/name/site/base_controller.rb.erb", File.join(name, "lib", name, "site", "base_controller.rb")
+    template "lib/name/site/search_controller.rb.erb", File.join(name, "lib", name, "site", "search_controller.rb")
+    template "lib/name/site/base_view.rb.erb", File.join(name, "lib", name, "site", "base_view.rb")
+  end
+
+  def features_files
+    template "features/model_steps.rb.erb", File.join(name, "features", "step_definitions", "model_steps.rb")
+    template "features/post_error_steps.rb.erb", File.join(name, "features", "step_definitions", "post_error_steps.rb")
+    template "features/site_steps.rb.erb", File.join(name, "features", "step_definitions", "site_steps.rb")
+    template "features/env.rb.erb", File.join(name, "features", "support", "env.rb")
+    template "features/sample.feature.erb", File.join(name, "features", "#{name}_home.feature")
+  end
+
+  def script_files
+    template "script/generate.rb.erb", File.join(name, "script", "generate.rb")
+    chmod File.join(name, "script", "generate.rb"), 0755
+  end
+
+  def generators_mvc_files
+    template "generators/mvc/generator.rb.erb", File.join(name, "generators", "mvc", "generator.rb")
+
+    template "generators/mvc/templates/controller.rb.erb", File.join(name, "generators", "mvc", "templates", "controller.rb.erb")
+    template "generators/mvc/templates/model.rb.erb", File.join(name, "generators", "mvc", "templates", "model.rb.erb")
+    template "generators/mvc/templates/view.rb.erb", File.join(name, "generators", "mvc", "templates", "view.rb.erb")
+  end
+end

data/generators/new_project/templates/gemfile.rb.erb

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gem 'watirmark', :git => 'https://github.com/convio/watirmark.git'
+gem 'watir-webdriver'
+gem 'rspec'
+gem 'rake'
+gem 'builder'
+gem 'cucumber'
+gem 'gherkin'
+gem 'bundler'

data/generators/new_project/templates/generators/mvc/generator.rb.erb

@@ -0,0 +1,61 @@
+require 'thor'
+require 'active_support/inflector'
+
+class MvcGenerator < Thor
+
+  attr_accessor :product, :name
+
+  def self.source_root
+    File.join(File.dirname(__FILE__), 'templates')
+  end
+
+  include Thor::Actions
+
+  desc "mvc WORKFLOW BASENAME", "creates model view controller in your project workflow directory"
+
+  def mvc(product, name)
+
+    self.product = product
+    self.name = name
+
+    template "model.rb.erb", File.join(workflows_path, product, "#{name}_model.rb")
+    template "view.rb.erb", File.join(workflows_path, product, "#{name}_view.rb")
+    template "controller.rb.erb", File.join(workflows_path, product, "#{name}_controller.rb")
+
+    append_to_file "#{workflows_path}/../workflows.rb" do
+      "#{workflow_loader} '#{product.downcase}/#{name.downcase}'\n"
+    end
+
+  end
+
+  no_commands do
+
+    def workflows_path
+      "lib/<%= name.downcase %>/workflows"
+    end
+
+    def workflow_loader
+      "<%= name.camelize %>::Loader.load_workflow"
+    end
+
+    def create_modules
+      product.split('/').zip(indents).map { |e| "#{e[1]}module #{e[0].camelize}" }.join("\n").rstrip
+    end
+
+    # for workflow a/b/c returns ["", "  ", "    "] spaces for formatting output plus initial indentation
+    def indents
+      @indents ||= indents_calc_and_format
+    end
+
+    def indents_calc_and_format
+      i = []
+      product.split('/').each_index { |e| i << e * 2 }
+      i.map { |e| "\s" * e }.map { |e| "\s\s#{e}" }
+    end
+
+    def create_module_end
+      indents.reverse.map { |e| "#{e}end" }.join("\n")
+    end
+
+  end
+end

data/generators/new_project/templates/generators/mvc/templates/controller.rb.erb

@@ -0,0 +1,9 @@
+module <%= @name.camelize %>
+<%%= create_modules %>
+  <%%= indents.last %>class <%%= name.camelize %> < BaseController
+  <%%= indents.last %>  @model = <%%= name.camelize %>Model
+  <%%= indents.last %>  @view = <%%= name.camelize %>View
+  <%%= indents.last %>end
+<%%= create_module_end %>
+end
+

data/generators/new_project/templates/generators/mvc/templates/model.rb.erb

@@ -0,0 +1,7 @@
+module <%= name.camelize %>
+<%%= create_modules %>
+  <%%= indents.last %>class <%%= name.camelize %>Model < Watirmark::Model::Factory
+  <%%= indents.last %>  keywords <%%= name.camelize %>View.keywords
+  <%%= indents.last %>end
+<%%= create_module_end %>
+end

data/generators/new_project/templates/generators/mvc/templates/view.rb.erb

@@ -0,0 +1,16 @@
+module <%= name.camelize %>
+<%%= create_modules %>
+  <%%= indents.last %>class <%%= name.camelize %>View < BaseView
+  <%%= indents.last %>  keyword(:keyword_name)  { browser.text_field(:id, 'element_id') }
+
+  <%%= indents.last %>  def home(model)
+  <%%= indents.last %>  end
+
+  <%%= indents.last %>  def create(model)
+  <%%= indents.last %>  end
+
+  <%%= indents.last %>  def edit(model)
+  <%%= indents.last %>  end
+  <%%= indents.last %>end
+<%%= create_module_end %>
+end

data/{app_generators/create_project/templates/project → generators/new_project/templates}/rakefile.rb.erb

@@ -14,7 +14,7 @@ require 'cucumber/rake/task'
 module RakeHelper
   def self.cucumber_task(task_name, files=nil)
     Cucumber::Rake::Task.new(task_name) do |t|
-      t.cucumber_opts = "-r features #{FileList[files]} -b --format html -o reports/report.html --format pretty"
+      t.cucumber_opts = "-r features #{FileList[files]} -b --format html -o cucumber_#{task_name}.html --format pretty"
     end
   end
 end

data/generators/new_project/templates/script/generate.rb.erb

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require File.expand_path('../../generators/mvc/generator', __FILE__)
+MvcGenerator.start

data/lib/watirmark/at_exit.rb

@@ -1,13 +1,9 @@
 module Watirmark
-  def self.add_exit_task &block
+  def self.add_exit_task
     at_exit {
-      if $!.nil? || $!.is_a?(SystemExit) && $!.success?
-        code = 0
-      else
-        code = $!.is_a?(SystemExit) ? $!.status : 1
-      end
-      block.call
-      exit code
+      code = $watirmark_exit
+      yield if block_given?
+      exit code if code
     }
   end
-end
+end

data/lib/watirmark/configuration.rb

@@ -1,5 +1,6 @@
 require 'singleton'
 require 'logger'
+require 'yaml'
 
 module Watirmark
 
@@ -21,6 +22,7 @@ module Watirmark
         :loglevel           => Logger::INFO,
         :uuid               => nil,
         :webdriver          => :firefox,
+        :headless           => false,
         # database
         :dbhostname         => nil,
         :dbusername         => nil,
@@ -30,8 +32,10 @@ module Watirmark
         # snapshots
         :snapshotwidth      => 1000,
         :snapshotheight     => 1000,
-        :sandbox            => false,
         :projectpath        => nil,
+        :sauce_username     => nil,
+        :sauce_access_key   => nil,
+        :dbi_url            => nil,
 
         #to deprecate
         :profile            => Hash.new { |h, k| h[k] = Hash.new },
@@ -109,12 +113,13 @@ module Watirmark
     def read_from_environment
       @settings.each_key do |var|
         next if var.to_s.upcase == "USERNAME"
+        next if var.to_s.upcase == "HOSTNAME" && self.hostname
         env = ENV[var.to_s.upcase]
         if var == :webdriver
           ENV['JOB_NAME']=~ /WEBDRIVER=(\w+)/
           env ||= $1
         end
-        update var.to_sym => env if env
+        update_key var, env if env
       end
     end
 

data/lib/watirmark/controller/actions.rb

@@ -3,12 +3,12 @@ module Watirmark
 
     attr_accessor :records
 
-    def run(*actions)
+    def run(*actions, &block)
       begin
         run_callback_method :before_all
         record_list.each do |record|
-          create_model_if_hash(record)
-          execute_actions(actions)
+          create_model(record)
+          execute_actions(actions, block)
         end
         run_callback_method :after_all
       ensure
@@ -26,6 +26,14 @@ module Watirmark
       end
     end
 
+    def populate_data_overridden?
+      self.class.instance_method(:populate_data).owner == self.class
+    end
+
+    def check_for_noop_populate
+      warn "Warning: Expected to populate values but none were provided" unless @seen_value || populate_data_overridden?
+    end
+
     # Navigate to the View's edit page and for every value in
     # the models hash, verify that the html element has
     # the proper value for each keyword
@@ -41,6 +49,7 @@ module Watirmark
       search_for_record
       @view.edit @model
       populate_data
+      check_for_noop_populate
     end
 
     # Navigate to the View's create page and
@@ -48,8 +57,10 @@ module Watirmark
     def create
       @view.create @model
       populate_data
+      check_for_noop_populate
     end
 
+
     def verify_until(&block)
       run_with_stop_condition(:verify, block)
     end
@@ -115,6 +126,7 @@ module Watirmark
       @view.create @model
       verify_data
     end
+
     alias :check_create_defaults :check_defaults
 
 
@@ -125,10 +137,17 @@ module Watirmark
     end
 
     # Stubs so converted XLS->RSPEC files don't fail
-    def before_all; end
-    def before_each; end
-    def after_all; end
-    def after_each; end
+    def before_all;
+    end
+
+    def before_each;
+    end
+
+    def after_all;
+    end
+
+    def after_each;
+    end
 
     private
 
@@ -138,7 +157,7 @@ module Watirmark
           Watirmark::Session.instance.stop_condition_block = block
           send(method)
         ensure
-          Watirmark::Session.instance.stop_condition_block = Proc.new{}
+          Watirmark::Session.instance.stop_condition_block = Proc.new {}
         end
         raise Watirmark::TestError, "Expected a stop condition but no stop conditon met!"
       end
@@ -157,16 +176,20 @@ module Watirmark
       send name if respond_to?(name)
     end
 
-    def execute_actions(actions)
+    def execute_actions(actions, block)
       actions.each do |action|
         run_callback_method :before_each
-        send(action)
+        send(action, &block)
         run_callback_method :after_each
       end
     end
 
-    def create_model_if_hash(model)
-      @model = hash_to_model(model) if model.kind_of?(Hash)
+    def create_model(record)
+      if record.kind_of?(Hash)
+        @model = hash_to_model(record)
+      else
+        @model = record
+      end
     end
   end
 end

data/lib/watirmark/controller/controller.rb

@@ -69,10 +69,10 @@ module Watirmark
 
       def populate_keyword(keyed_element)
         begin
-          @seen_value = true
           before_keyword(keyed_element)
           populate_keyword_value(keyed_element)
           after_keyword(keyed_element)
+          @seen_value = true
         rescue => e
           Watirmark.logger.warn "Unable to populate '#{keyed_element.keyword}'"
           raise e
@@ -97,11 +97,11 @@ module Watirmark
         @seen_value = false
       end
 
-      def call_method_if_exists(override, &block)
+      def call_method_if_exists(override)
         if respond_to?(override)
           send(override)
         else
-          block.call if block
+          yield if block_given?
         end
       end
 
@@ -122,7 +122,11 @@ module Watirmark
       end
 
       def populate_keyword_value(keyed_element)
-        call_method_if_exists("populate_#{keyed_element.keyword}") {@view.send("#{keyed_element.keyword}=", value(keyed_element))}
+        call_method_if_exists("populate_#{keyed_element.keyword}") do
+          # for the first element on a page we populate, wait for it to appear
+          @view.send(keyed_element.keyword).send(:wait_until_present) unless @seen_value
+          @view.send("#{keyed_element.keyword}=", value(keyed_element))
+        end
       end
 
       def verify_keyword_value(keyed_element)

data/lib/watirmark/controller/dialogs.rb

@@ -4,13 +4,13 @@ module Watirmark
       !!(Page.browser.windows.size > 1)
     end
 
-    def with_modal_dialog(&block)
+    def with_modal_dialog
       wait_for_modal_dialog
       parent_window = (Page.browser.windows.size) - 2
       begin
         Page.browser.windows.last.use
         Page.browser.wait
-        block.call
+        yield
       ensure
         Page.browser.windows[parent_window].use
       end
@@ -30,4 +30,4 @@ module Watirmark
       end
     end
   end
-end
+end

data/lib/watirmark/cucumber/email_helper.rb

@@ -32,6 +32,15 @@ module EmailHelper
         email[model.model_name] = EmailBody.new(email_content)
       end
 
+      def read_email_from(model, from, timeout=30)
+        email_content = qa_inbox(model).get_email_text(["FROM", from, "TO", model.email], timeout)
+        email[model.model_name] = EmailBody.new(email_content)
+      end
+
+      def read_email_replyto(model, from, timeout=30)
+        qa_inbox(model).get_email_replyto(["FROM", from, "TO", model.email], timeout)
+      end
+
       def log_email(model)
         Watirmark.logger.info "Email Received"
         Watirmark.logger.info email[model.model_name].body.inspect
@@ -63,6 +72,16 @@ module EmailHelper
     end
   end
 
+  class EmailEnvelope
+    attr_accessor :envelope
+
+    def initialize(envelope)
+      @envelope = envelope
+      @from = envelope.from
+    end
+
+  end
+
   class EmailBody
     attr_accessor :doc, :body
 

data/lib/watirmark/cucumber/env.rb

@@ -1,8 +1,9 @@
-require 'watirmark/cucumber/cuke_helper'
-require 'watirmark/cucumber/email_helper'
-require 'watirmark/cucumber/model_helper'
-require 'watirmark/cucumber/transforms'
-require 'watirmark/cucumber/hooks'
+require_relative 'cuke_helper'
+require_relative 'email_helper'
+require_relative 'model_helper'
+require_relative 'transforms'
+require_relative 'hooks'
+require_relative 'load_cached_models' if Watirmark::Configuration.instance.use_cached_models
 
 World CukeHelper
 World EmailHelper

data/lib/watirmark/cucumber/hook_helper.rb

@@ -0,0 +1,38 @@
+module HookHelper
+  class << self
+
+    def clear_post_errors
+      Watirmark::Session.instance.post_failure = nil
+    end
+
+    def trap_post_errors(&block)
+      Watirmark::Session.instance.catch_post_failures(&block)
+    end
+
+
+    def take_screenshot
+      image = "#{Time.now.to_i}-#{UUID.new.generate(:compact)}.png"
+      path = "reports/screenshots"
+      file = "#{path}/#{image}"
+      FileUtils.mkdir_p path unless File.directory? path
+      begin
+        Page.browser.screenshot.save file
+        data = File.open(file, 'rb') { |f| f.read }
+        data = Base64.encode64(data)
+      rescue Exception => e
+        Watirmark.logger.warn("Screenshot was not taken due to an exception")
+        Watirmark.logger.warn(e.to_s)
+        Watirmark.logger.warn(e.backtrace)
+      end
+
+      [data, 'image/png']
+    end
+
+    def serialize_models
+      return unless Watirmark::Configuration.instance.use_cached_models
+      Dir.mkdir("cache") unless Dir.exists? "cache"
+      File.unlink "cache/DataModels" if File.exists? "cache/DataModels"
+      File.open("cache/DataModels", "wb") { |f| f.print Marshal::dump(DataModels) }
+    end
+  end
+end

data/lib/watirmark/cucumber/hooks.rb

@@ -1,16 +1,21 @@
+require_relative "hook_helper"
+
 Around('@catch-post-failure') do |scenario, block|
-  Watirmark::Session.instance.catch_post_failures(&block)
+  HookHelper.trap_post_errors(&block)
 end
 
-# Initialize post failures so we don't get leakage between scenarios
 Before('~@catch-post-failure') do
-  Watirmark::Session.instance.post_failure = nil
+  HookHelper.clear_post_errors
+end
+
+Before do |scenario|
+  HookHelper.serialize_models
 end
 
 After do |scenario|
-  image = "#{Time.now.to_i}-#{UUID.new.generate(:compact)}.png"
-  path = "reports/screenshots"
-  FileUtils.mkdir_p path unless File.directory? path
-  Page.browser.screenshot.save "#{path}/#{image}"
-  embed "screenshots/#{image}", 'image/png'
+  (file, file_type) = HookHelper.take_screenshot
+  embed file, file_type
+  HookHelper.serialize_models
 end
+
+

data/lib/watirmark/cucumber/load_cached_models.rb

@@ -0,0 +1,9 @@
+if  File.exists?("cache/DataModels")
+  file = File.open("cache/DataModels", "rb")
+  DataModels = Marshal::load(file.read)
+  #DataModels.each_key { |k| DataModels.delete(k) unless DataModels[k].cache? == true }
+  warn "=========="
+  warn "USING CACHED MODELS:"
+  DataModels.each_pair { |k, v| warn "  #{k}: #{v.to_h}" }
+  warn "=========="
+end

data/lib/watirmark/cucumber/model_helper.rb

@@ -9,20 +9,20 @@ module ModelHelper
     model.update(hash_record(table))
   end
 
-  def with_updated_model(model, table, &block)
+  def with_updated_model(model, table)
     unless model.includes?(hash_record(table))
       update_model(model, table)
-      block.call
+      yield
       Watirmark.logger.info "Updated models '#{model.model_name}':\n#{hash_record(table).inspect}"
     end
   end
 
 # Perform an action using a models and update
 # the models if that action is successful
-  def with_model(model, table, &block)
+  def with_model(model, table)
     orig_model = model.clone
     update_model(model, table)
-    block.call
+    yield
     if Watirmark::Session.instance.post_failure
       Watirmark.logger.info  "Reverting Model #{Watirmark::Session.instance.post_failure}"
       model.update(orig_model.to_h) # revert models on failure

data/lib/watirmark/cucumber/transforms.rb

@@ -26,7 +26,9 @@ module Watirmark
       end
 
       def model_class_name(name)
-        "#{name.split.map(&:camelize).join}Model"
+        class_name = name.split.map(&:camelize).join
+        class_name = "#{class_name}Model" unless class_name =~ /.+Model$/
+        class_name
       end
 
       def temporary_model?(user_defined_name)

data/lib/watirmark/extensions/ruby_extensions.rb

@@ -1,3 +1,11 @@
+module Kernel
+  alias :original_exit :exit
+  def exit(status=true)
+    $watirmark_exit=status
+    original_exit(status)
+  end
+end
+
 module Watirmark::MatchMethod
   def matches(x)
     self == x