mediawiki_selenium 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 329d08a407bf34d62782833f29ddc148c36e75c0
-  data.tar.gz: 34f4f2700b159884ddb8b5e6ddf77c935c8fd9ee
+  metadata.gz: 9883a47e71cdb76841699d8292442f00a6312a63
+  data.tar.gz: 6af66ee6695ba0e33cb68ade1aa2bae67566cadc
 SHA512:
-  metadata.gz: b87efa97ee1d7ad227c7d30264daf1b1144a0cedaf3ccb46495a5a68081781fe8ae4cab1db855d7b5dfce880c7ede665e3de58736a4582a521c847c1f16b43e3
-  data.tar.gz: 84993de521a0a42243a8420d91fdb6a41eef45abbc9281a356197968715652b9b5fad2f809799ec5d716b18e4e081da249c8dd248d3865baff9d26be6aea78b8
+  metadata.gz: 1656892e8f622ce63c4683d0a14f5626834d102be62512bbc8c7510adce55467a1b6cc9eee1a5e229f1b6985323997ca86b9cf86b914607d3117d7dd95d28d30
+  data.tar.gz: 4a7fb08977d4c047721e9329a8e31fdfabf176c4a7efd1d83cee36014e68eb084abe2acfc8dca13bab39c5c5054b61547ab8a045f635c786b9d4d573fef9066e

data/.gitignore

@@ -1,6 +1,7 @@
 .bundle
 /.yardoc/
 /doc/
+/tmp/
 .gem
 *.gem
 Gemfile.lock

data/README.md

@@ -37,7 +37,7 @@ Create a `Gemfile` in the root of your MediaWiki-related project that
 specifies the version of `mediawiki_selenium` you wish to use (typically the
 latest version).
 
-    gem 'mediawiki_selenium', '~> 1.4.0'
+    gem 'mediawiki_selenium', '~> 1.5.0'
 
 Install the gem and its dependencies by running `bundle install`. (If
 [Bundler](http://bundler.io/) is not yet installed, install it with
@@ -223,6 +223,12 @@ See https://www.mediawiki.org/wiki/Gerrit
 
 ## Release notes
 
+### 1.5.0 2015-07-23
+* Video recording of headless browser sessions are now saved to
+  `HEADLESS_CAPTURE_PATH` for failed scenarios
+* Page objects can now reference the current `Environment` object as `env` in
+  their page URL ERb
+
 ### 1.4.0 2015-06-26
 * New user factory module provides account fixtures for a greater level of
   isolation/atomicity between scenarios

data/UPGRADE.md

@@ -5,7 +5,7 @@
 First, update the `Gemfile` in your project's root directory to specify the
 new version.
 
-    gem 'mediawiki_selenium', '~> 1.4.0'
+    gem 'mediawiki_selenium', '~> 1.5.0'
 
 ## Upgrade gems and dependencies
 

data/features/recording.feature

@@ -0,0 +1,40 @@
+@integration
+Feature: Recording of headless sessions
+
+  As a developer writing and running headless tests, it would be helpful to
+  have a video recording of the session so that troubleshooting/debugging
+  failures can be done more easily.
+
+  Background:
+    Given I have `Xvfb` installed
+      And I have `avconv` installed
+      And I have configured my environment from `ENV` and with:
+      """
+      headless: true
+      headless_display: 20
+      headless_capture_path: tmp/log
+      """
+      And the "tmp/log" directory exists
+
+  Scenario: A video file is saved upon teardown for failed scenarios
+    Given the current scenario name is "Some scenario"
+      And I have started a browser
+    When the scenario fails
+    Then the file "tmp/log/Some scenario.mp4" should exist
+
+  Scenario: A video file is not saved for passing scenarios
+    Given the current scenario name is "Some scenario"
+      And I have started a browser
+    When the scenario passes
+    Then the file "tmp/log/Some scenario.mp4" should not exist
+
+  Scenario: A video per session is saved
+    Given the current scenario name is "Some scenario"
+      And I have started a browser
+      And the scenario fails
+      And the next scenario begins
+      And the current scenario name is "Some other scenario"
+      And I have started a browser
+    When the scenario fails
+    Then the file "tmp/log/Some scenario.mp4" should exist
+      And the file "tmp/log/Some other scenario.mp4" should exist

data/features/step_definitions/environment_steps.rb

@@ -1,12 +1,22 @@
+Before do
+  @tmp_files = []
+end
+
+After do
+  @env.teardown unless @env.nil?
+  @tmp_files.each { |path| FileUtils.rm_r(path) if File.exist?(path) }
+end
+
 Given(/^I have configured my environment with:$/) do |yaml|
-  @env = MediawikiSelenium::Environment.new(YAML.load(yaml))
+  @configs = [YAML.load(yaml)]
+  @env = MediawikiSelenium::Environment.new(*@configs)
 end
 
 Given(/^I have configured my environment from `ENV`(?: and with:)?$/) do |*args|
-  configs = [ENV]
-  configs << YAML.load(args.first) if args.length > 0
+  @configs = [ENV]
+  @configs << YAML.load(args.first) if args.length > 0
 
-  @env = MediawikiSelenium::Environment.new(*configs)
+  @env = MediawikiSelenium::Environment.new(*@configs)
 end
 
 Given(/^I have set "(.*?)" in my shell$/) do |var|
@@ -17,6 +27,44 @@ Given(/^I have set "(.*?)" in my shell$/) do |var|
   end
 end
 
-After do
-  @env.teardown unless @env.nil?
+Given(/^I have `(.*?)` installed$/) do |cmd|
+  unless system("which #{cmd} > /dev/null") == true
+    pending "you must have #{cmd} installed to run this test"
+  end
+end
+
+Given(/^the "(.*?)" directory exists$/) do |dir|
+  @tmp_files << dir unless File.exist?(dir)
+  FileUtils.mkdir_p(dir)
+end
+
+Given(/^the environment has been setup$/) do
+  @env.setup
+end
+
+Given(/^the current scenario name is "(.*?)"$/) do |name|
+  @scenario_name = name
+end
+
+Given(/^the next scenario begins$/) do
+  @env = MediawikiSelenium::Environment.new(*@configs)
+end
+
+When(/^the scenario ends$/) do
+  begin
+    # Avoid a race condition within the headless video recorder by waiting
+    sleep 0.3
+    @env.teardown(name: @scenario_name, status: @scenario_status)
+  ensure
+    @env = nil
+  end
+end
+
+When(/^the scenario (fails|passes)$/) do |status|
+  @scenario_status = status == 'fails' ? :failed : :passed
+  step 'the scenario ends'
+end
+
+Then(/^the file "(.*?)" should (not )?exist$/) do |file, negate|
+  expect(Pathname.new(file)).send(negate ? :to_not : :to, exist)
 end

data/lib/mediawiki_selenium.rb

@@ -4,6 +4,7 @@ module MediawikiSelenium
   autoload :BrowserFactory, 'mediawiki_selenium/browser_factory'
   autoload :ConfigurationError, 'mediawiki_selenium/configuration_error'
   autoload :Environment, 'mediawiki_selenium/environment'
+  autoload :HeadlessHelper, 'mediawiki_selenium/support/modules/headless_helper'
   autoload :Initializer, 'mediawiki_selenium/initializer'
   autoload :PageFactory, 'mediawiki_selenium/page_factory'
   autoload :Raita, 'mediawiki_selenium/raita'

data/lib/mediawiki_selenium/environment.rb

@@ -104,6 +104,8 @@ module MediawikiSelenium
       @_config = configs.map { |config| normalize_config(config) }.reduce(:merge)
       @_factory_cache = {}
       @_current_alternatives = {}
+
+      extend(HeadlessHelper) if headless?
     end
 
     # Whether the given environment is equal to this one. Two environments are
@@ -201,6 +203,15 @@ module MediawikiSelenium
       self
     end
 
+    # Whether this environment is configured to run in headless mode (using
+    # Xvfb via the headless gem).
+    #
+    # @return [true, false]
+    #
+    def headless?
+      lookup(:headless, default: 'false').to_s == 'true'
+    end
+
     # Executes the given block within the context of an environment that uses
     # a unique browser session and possibly different configuration. Note that
     # any given configuration overrides are scoped with a `:browser_` prefix.
@@ -339,23 +350,23 @@ module MediawikiSelenium
     # close any open browsers and perform their own teardown tasks.
     #
     # @example Teardown environment resources after each scenario completes
-    #   After do
-    #     teardown(scenario.status)
+    #   After do |scenario|
+    #     teardown(name: scenario.name, status: scenario.status)
     #   end
     #
-    # @param status [Symbol] Status of the executed scenario.
+    # @param info [Hash] Hash of test case information.
     #
     # @yield [browser]
     # @yieldparam browser [Watir::Browser] Browser object, before it's closed.
     #
-    def teardown(status = :passed)
+    def teardown(info = {})
       @_factory_cache.each do |(_, browser_name), factory|
         factory.each do |browser|
           yield browser if block_given?
           browser.close unless keep_browser_open? && browser_name != :phantomjs
         end
 
-        factory.teardown(self, status)
+        factory.teardown(self, info[:status] || :passed)
       end
     end
 

data/lib/mediawiki_selenium/page_factory.rb

@@ -11,12 +11,25 @@ module MediawikiSelenium
     # `PageObject::PageFactory#on_page`. All page URLs are also qualified
     # using {Environment#wiki_url}.
     #
+    # Additionally, an instance of the current {Environment} is made available
+    # as `env` for interpolation of page URLs.
+    #
+    # @example Referencing the `env` in page URLs
+    #   class ArticlePage
+    #     page_url 'User:<%= env.user %>'
+    #   end
+    #
     # @see http://www.rubydoc.info/github/cheezy/page-object
     #
     def on_page(page_class, params = { using_params: {} }, visit = false)
       @browser = browser if visit || !defined?(@browser)
+      env = self
 
       super(page_class, params, false) do |page|
+        page.define_singleton_method(:env) do
+          env
+        end
+
         if page.respond_to?(:goto)
           wiki_url = method(:wiki_url)
 

data/lib/mediawiki_selenium/support/hooks.rb

@@ -16,20 +16,6 @@ AfterConfiguration do |config|
     raita_build = MediawikiSelenium::Raita.build_from(env)
     config.formats << ['MediawikiSelenium::Raita::Logger', { url: raita_url, build: raita_build }]
   end
-
-  # Initiate headless mode
-  if ENV['HEADLESS'] == 'true' && ENV['BROWSER'] != 'phantomjs'
-    require 'headless'
-
-    headless_options = {}.tap do |options|
-      options[:display] = ENV['HEADLESS_DISPLAY'] if ENV.include?('HEADLESS_DISPLAY')
-      options[:reuse] = false if ENV['HEADLESS_REUSE'] == 'false'
-      options[:destroy_at_exit] = false if ENV['HEADLESS_DESTROY_AT_EXIT'] == 'false'
-    end
-
-    headless = Headless.new(headless_options)
-    headless.start
-  end
 end
 
 # Enforce a dependency check for all scenarios tagged with @extension- tags
@@ -79,10 +65,12 @@ Before do |scenario|
 end
 
 After do |scenario|
+  scenario_name = test_name(scenario)
+
   if scenario.respond_to?(:status)
     require 'fileutils'
 
-    teardown(scenario.status) do |browser|
+    teardown(name: scenario_name, status: scenario.status) do |browser|
       # Embed remote session URLs
       if remote? && browser.driver.respond_to?(:session_id)
         embed("http://saucelabs.com/jobs/#{browser.driver.session_id}", 'text/url')
@@ -92,14 +80,13 @@ After do |scenario|
       if scenario.failed? && lookup(:screenshot_failures, default: false) == 'true'
         screen_dir = lookup(:screenshot_failures_path, default: 'screenshots')
         FileUtils.mkdir_p screen_dir
-        name = test_name(scenario).gsub(/ /, '_')
+        name = scenario_name.gsub(/ /, '_')
         path = "#{screen_dir}/#{name}.png"
         browser.screenshot.save path
         embed path, 'image/png'
       end
-
     end
   else
-    teardown
+    teardown(name: scenario_name)
   end
 end

data/lib/mediawiki_selenium/support/modules/headless_helper.rb

@@ -0,0 +1,116 @@
+require 'fileutils'
+require 'headless'
+
+module MediawikiSelenium
+  # Adds support to {Environment} for running sessions in a headless mode
+  # using Xvfb. Video will be recorded for the display and saved for failed
+  # scenarios if a `headless_capture_path` environment variable is configured.
+  #
+  module HeadlessHelper
+    class << self
+      # Creates a global headless display using the given environment's
+      # configuration. If a display has already been created once before, it
+      # is simply returned.
+      #
+      # @param env [Environment] Environment for which to start headless.
+      #
+      # @return [Headless]
+      #
+      def create_or_reuse_display(env)
+        return @_display unless @_display.nil?
+
+        options = { video: { provider: :libav, codec: 'libx264' } }
+
+        display = env.lookup(:headless_display, default: nil)
+        options[:display] = display unless display.nil?
+
+        if env.lookup(:headless_reuse, default: true).to_s == 'false'
+          options[:reuse] = false
+        end
+
+        if env.lookup(:headless_destroy_at_exit, default: true).to_s == 'false'
+          options[:destroy_at_exit] = false
+        end
+
+        @_display = Headless.new(options)
+        @_display.start
+
+        @_display
+      end
+
+      # Destroys the global headless display created by
+      # {create_or_reuse_display}.
+      #
+      def destroy_display
+        @_display.destroy if @_display
+        @_display = nil
+      end
+
+      # Whether a global headless display has been created.
+      #
+      # @return [true, false]
+      #
+      def display_created?
+        !@_display.nil?
+      end
+    end
+
+    # Starts a headless display and starts recording before the {Environment}
+    # opens a browser for the first time.
+    #
+    # @see Environment#browser
+    #
+    def browser
+      @_headless_display = HeadlessHelper.create_or_reuse_display(self)
+
+      if !@_headless_capture && headless_capture?
+        @_headless_capture = true
+        @_headless_display.video.start_capture
+      end
+
+      super
+    end
+
+    # Whether or not we should perform video capture of the headless display
+    # for each new browser session.
+    #
+    # @return [true, false]
+    #
+    def headless_capture?
+      !headless_capture_path.nil?
+    end
+
+    # Directory where screenshot/video files of headless sessions will be
+    # saved. Defaults to writing them to a `log` directory under the workspace
+    # directory.
+    #
+    # @return [String, nil]
+    #
+    def headless_capture_path
+      lookup(:headless_capture_path, default: nil)
+    end
+
+    # Performs teardown tasks for headless operation, saving any video
+    # captures to file.
+    #
+    # @see Environment#teardown
+    #
+    def teardown(info = {})
+      super
+    ensure
+      if @_headless_capture
+        if info[:status] == :failed
+          dir = File.absolute_path(headless_capture_path)
+          FileUtils.mkdir_p(dir)
+
+          filename = "#{(info[:name] || 'scenario').tr("#{File::SEPARATOR}\000", '-')}.mp4"
+          filename = File.join(dir, filename)
+
+          @_headless_display.video.stop_and_save(filename)
+        else
+          @_headless_display.video.stop_and_discard
+        end
+      end
+    end
+  end
+end

data/lib/mediawiki_selenium/version.rb

@@ -1,3 +1,3 @@
 module MediawikiSelenium
-  VERSION = '1.4.0'
+  VERSION = '1.5.0'
 end

data/mediawiki_selenium.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'cucumber', '~> 1.3', '>= 1.3.20'
-  spec.add_runtime_dependency 'headless', '~> 1.0', '>= 1.0.1'
+  spec.add_runtime_dependency 'headless', '~> 2.0', '>= 2.1.0'
   spec.add_runtime_dependency 'json', '~> 1.8', '>= 1.8.1'
   spec.add_runtime_dependency 'mediawiki_api', '~> 0.4', '>= 0.4.1'
   spec.add_runtime_dependency 'page-object', '~> 1.0'

data/spec/environment_spec.rb

@@ -83,6 +83,22 @@ module MediawikiSelenium
       end
     end
 
+    describe '#initialize' do
+      subject { Environment.new(config) }
+
+      context 'when headless mode is enabled' do
+        let(:config) { { headless: 'true' } }
+
+        it { is_expected.to be_a(HeadlessHelper) }
+      end
+
+      context 'when headless mode is disabled' do
+        let(:config) { { headless: nil } }
+
+        it { is_expected.to_not be_a(HeadlessHelper) }
+      end
+    end
+
     describe '#==' do
       subject { env == other }
 
@@ -381,7 +397,7 @@ module MediawikiSelenium
     end
 
     describe '#teardown' do
-      subject { env.teardown(status) }
+      subject { env.teardown(status: status) }
 
       let(:status) { :passed }
       let(:browser_instance) { double(Watir::Browser) }
@@ -393,7 +409,7 @@ module MediawikiSelenium
 
       it 'yields the given block and closes the browser' do
         expect(browser_instance).to receive(:close)
-        expect { |blk| env.teardown(status, &blk) }.to yield_with_args(browser_instance)
+        expect { |blk| env.teardown(status: status, &blk) }.to yield_with_args(browser_instance)
       end
 
       context 'when keep_browser_open is set to "true"' do

data/spec/headless_helper_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+module MediawikiSelenium
+  describe HeadlessHelper do
+    let(:env) { Environment.new(config.merge(headless: true)) }
+    let(:config) { {} }
+
+    describe '.create_or_reuse_display' do
+      subject { HeadlessHelper.create_or_reuse_display(env) }
+
+      let(:headless) { double('Headless') }
+
+      before { allow(headless).to receive(:destroy) }
+      after { HeadlessHelper.destroy_display }
+
+      context 'called for the first time' do
+        it 'creates, starts, and returns a new Headless' do
+          expect(Headless).to receive(:new).and_return(headless)
+          expect(headless).to receive(:start)
+          expect(subject).to be(headless)
+        end
+      end
+
+      context 'called a second time' do
+        it 'only creates one Headless' do
+          expect(Headless).to receive(:new).once.and_return(headless)
+          expect(headless).to receive(:start).once
+
+          2.times { HeadlessHelper.create_or_reuse_display(env) }
+        end
+      end
+    end
+  end
+end

data/spec/page_factory_spec.rb

@@ -47,8 +47,6 @@ module MediawikiSelenium
 
       context 'when told to visit a page' do
         let(:visit) { true }
-        let(:config) { { mediawiki_url: 'http://an.example/wiki/' } }
-
         let(:page_object_platform) { double('PageObject::WatirPageObject') }
 
         before do
@@ -57,6 +55,8 @@ module MediawikiSelenium
         end
 
         context 'where the page URL is defined' do
+          let(:config) { { mediawiki_url: 'http://an.example/wiki/' } }
+
           let(:page_class) do
             Class.new do
               include ::PageObject
@@ -64,15 +64,35 @@ module MediawikiSelenium
             end
           end
 
-          it 'qualifies the path with the configured :mediawiki_url' do
+          before do
             expect_any_instance_of(page_class).to receive(:platform).
               and_return(page_object_platform)
+          end
 
+          it 'qualifies the path with the configured :mediawiki_url' do
             expect(page_object_platform).to receive(:navigate_to).
               with('http://an.example/wiki/Special:RandomPage')
 
             subject
           end
+
+          context 'and it contains ERb that references `env`' do
+            let(:config) { { mediawiki_url: 'http://an.example/wiki/', mediawiki_user: 'user1' } }
+
+            let(:page_class) do
+              Class.new do
+                include ::PageObject
+                page_url 'User:<%= env.user %>'
+              end
+            end
+
+            it 'successfully calls the `env` method that was added to the page object' do
+              expect(page_object_platform).to receive(:navigate_to).
+                with('http://an.example/wiki/User:user1')
+
+              subject
+            end
+          end
         end
 
         context 'where the page URL is undefined' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mediawiki_selenium
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Chris McMahon
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-26 00:00:00.000000000 Z
+date: 2015-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -41,20 +41,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -332,6 +332,7 @@ files:
 - bin/mediawiki-selenium-init
 - features/api.feature
 - features/basic_usage.feature
+- features/recording.feature
 - features/saucelabs.feature
 - features/step_definitions/api_helper_steps.rb
 - features/step_definitions/browser_steps.rb
@@ -364,6 +365,7 @@ files:
 - lib/mediawiki_selenium/support/env.rb
 - lib/mediawiki_selenium/support/hooks.rb
 - lib/mediawiki_selenium/support/modules/api_helper.rb
+- lib/mediawiki_selenium/support/modules/headless_helper.rb
 - lib/mediawiki_selenium/support/modules/strict_pending.rb
 - lib/mediawiki_selenium/support/modules/user_factory_helper.rb
 - lib/mediawiki_selenium/support/pages.rb
@@ -381,6 +383,7 @@ files:
 - spec/browser_factory/firefox_spec.rb
 - spec/browser_factory/phantomjs_spec.rb
 - spec/environment_spec.rb
+- spec/headless_helper_spec.rb
 - spec/page_factory_spec.rb
 - spec/remote_browser_factory_spec.rb
 - spec/spec_helper.rb