mediawiki_selenium 1.5.0 → 1.6.0

data/lib/mediawiki_selenium/{support/modules → helpers}/api_helper.rb

@@ -27,6 +27,21 @@ module MediawikiSelenium
       lookup(:mediawiki_api_url, default: -> { api_url_from(lookup(:mediawiki_url)) })
     end
 
+    # Queries MW via the API to check for missing extension dependencies.
+    #
+    # @param dependencies [Array] Extension dependencies.
+    #
+    # @return [Array] Missing extensions.
+    #
+    def missing_extensions(dependencies)
+      return [] if dependencies.empty?
+
+      extensions = api.meta(:siteinfo, siprop: 'extensions').data['extensions']
+      extensions = extensions.map { |ext| ext['name'] }.compact.map(&:downcase)
+
+      dependencies - extensions
+    end
+
     # Ensures the given alternative account exists by attempting to create it
     # via the API. Any errors related to the account already existing are
     # swallowed.

data/lib/mediawiki_selenium/{support/modules → helpers}/headless_helper.rb

@@ -96,21 +96,29 @@ module MediawikiSelenium
     # @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
+      artifacts = {}
+
+      begin
+        artifacts = 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)
+
+            artifacts[filename] = 'video/mp4'
+          else
+            @_headless_display.video.stop_and_discard
+          end
         end
       end
+
+      artifacts
     end
   end
 end

data/lib/mediawiki_selenium/helpers/login_helper.rb

@@ -0,0 +1,36 @@
+require 'uri'
+
+module MediawikiSelenium
+  # Expepiates logging in to wikis by authenticating with the MW API and
+  # transfering the returned cookie to the current browser.
+  #
+  module LoginHelper
+    # Authenticate with the current wiki's API and save the resulting cookie
+    # in the current browser.
+    #
+    # @param cookies [Hash] Extra cookies to set.
+    #
+    def log_in(cookies = {})
+      visit_wiki do |url|
+        uri = URI.parse(url)
+
+        options = {}
+        options[:domain] = uri.host unless ['localhost', '127.0.0.1'].include?(uri.host)
+
+        api.cookies.each do |cookie|
+          browser.cookies.add cookie.name, cookie.value, options.merge({
+            secure: cookie.secure,
+            path: cookie.path,
+            expires: cookie.expires
+          })
+        end
+
+        cookies.each do |name, value|
+          browser.cookies.add name.to_s, value, options
+        end
+
+        browser.refresh
+      end
+    end
+  end
+end

data/lib/mediawiki_selenium/helpers/screenshot_helper.rb

@@ -0,0 +1,58 @@
+require 'fileutils'
+
+module MediawikiSelenium
+  # Adds support to {Environment} for taking screenshots of the current
+  # browser window. If `screenshot_failures` is set to `true` for the current
+  # environment, one is automatically taken at the end of each failed
+  # test case.
+  #
+  module ScreenshotHelper
+    # Takes a screenshot of the given browser window and returns the path
+    # to the saved image.
+    #
+    # @param browser [Watir::Browser] Browser to take a sceeenshot of.
+    # @param name [String] Base name to use for the saved image file.
+    #
+    # @return [String] Path to the new screenshot.
+    #
+    def screenshot(browser, name)
+      dir = screenshot_failures_path
+      FileUtils.mkdir_p dir
+
+      name = name.tr("#{File::SEPARATOR}\000", '-')
+
+      path = File.join(dir, "#{name}.png")
+      browser.screenshot.save(path)
+
+      path
+    end
+
+    # Takes screenshots for failed tests.
+    #
+    # @param info [Hash] Test case information.
+    #
+    def teardown(info = {})
+      screenshots = []
+
+      artifacts = super(info) do |browser|
+        if info[:status] == :failed && screenshot_failures?
+          screenshots << screenshot(browser, info[:name] || 'scenario')
+        end
+
+        yield browser if block_given?
+      end
+
+      artifacts.merge(screenshots.each.with_object({}) { |img, arts| arts[img] = 'image/png' })
+    end
+
+    private
+
+    def screenshot_failures?
+      lookup(:screenshot_failures, default: false).to_s == 'true'
+    end
+
+    def screenshot_failures_path
+      lookup(:screenshot_failures_path, default: 'screenshots')
+    end
+  end
+end

data/lib/mediawiki_selenium/pages.rb

@@ -0,0 +1,3 @@
+require 'mediawiki_selenium/pages/login_page'
+require 'mediawiki_selenium/pages/random_page'
+require 'mediawiki_selenium/pages/reset_preferences_page'

data/lib/mediawiki_selenium/remote_browser_factory.rb

@@ -1,5 +1,3 @@
-require 'mediawiki_selenium/support/sauce'
-
 require 'rest_client'
 require 'uri'
 
@@ -17,6 +15,9 @@ module MediawikiSelenium
     URL = 'http://ondemand.saucelabs.com/wd/hub'
 
     class << self
+      # @attr [Array] SauceLabs job IDs from the most recent sessions.
+      attr_accessor :last_session_ids
+
       def extend_object(base)
         return if base.is_a?(self)
 
@@ -42,6 +43,10 @@ module MediawikiSelenium
     # Submits status and Jenkins build info to Sauce Labs.
     #
     def teardown(env, status)
+      artifacts = super
+
+      self.class.last_session_ids = []
+
       each do |browser|
         sid = browser.driver.session_id
         url = browser.driver.send(:bridge).http.send(:server_url)
@@ -61,8 +66,12 @@ module MediawikiSelenium
           }.to_json
         )
 
-        Cucumber::Formatter::Sauce.current_session_id = sid
+        self.class.last_session_ids << sid
+
+        artifacts["http://saucelabs.com/jobs/#{sid}"] = 'text/url'
       end
+
+      artifacts
     end
 
     protected

data/lib/mediawiki_selenium/rspec.rb

@@ -0,0 +1,51 @@
+require 'rspec/core'
+require 'mediawiki_selenium'
+require 'mediawiki_selenium/rspec/features'
+
+module MediawikiSelenium
+  module RSpec
+    # Returns a name for the given example metadata, derived from its example
+    # groups and description.
+    #
+    # @param metadata [RSpec::Core::Metadata, Hash] Base or nested metadata.
+    #
+    # @return [String]
+    #
+    def self.example_name(metadata)
+      name = metadata[:example_group] ? "#{example_name(metadata[:example_group])} " : ''
+      name += metadata[:description_args].first.to_s if metadata[:description_args].any?
+      name
+    end
+
+    # Returns a status for the given RSpec example result.
+    #
+    # @param result [Object] Result of `example.run`.
+    #
+    # @return [:passed, :failed, :skipped]
+    #
+    def self.example_status(result)
+      case result
+      when Exception
+        :failed
+      when String
+        :skipped
+      else
+        :passed
+      end
+    end
+
+    autoload :Environment, 'mediawiki_selenium/rspec/environment'
+  end
+end
+
+RSpec.configure do |config|
+  config.include MediawikiSelenium::RSpec::Environment
+
+  config.around(:each) do |example|
+    name = MediawikiSelenium::RSpec.example_name(example.metadata)
+
+    mw.setup(name: name)
+    result = example.run
+    mw.teardown(name: name, status: MediawikiSelenium::RSpec.example_status(result))
+  end
+end

data/lib/mediawiki_selenium/rspec/environment.rb

@@ -0,0 +1,36 @@
+module MediawikiSelenium
+  module RSpec
+    module Environment
+      # Sets up and returns a new default environment.
+      #
+      # @return [Environment]
+      #
+      def mw
+        @_mw ||= MediawikiSelenium::Environment.load_default.extend(
+          MediawikiSelenium::ApiHelper,
+          MediawikiSelenium::PageFactory,
+          MediawikiSelenium::ScreenshotHelper,
+          MediawikiSelenium::UserFactoryHelper
+        )
+      end
+
+      private
+
+      # Allow for indirect calls to the {Environment} object.
+      #
+      # @see mw
+      #
+      def method_missing(name, *args, &block)
+        mw.respond_to?(name) ? mw.__send__(name, *args, &block) : super
+      end
+
+      # Allow for indirect calls to the {Environment} object.
+      #
+      # @see mw
+      #
+      def respond_to_missing?(name, include_all = false)
+        mw.respond_to?(name) || super
+      end
+    end
+  end
+end

data/lib/mediawiki_selenium/rspec/features.rb

@@ -0,0 +1,49 @@
+# This was "derived" from Capybara's RSpec integration
+#
+# https://github.com/jnicklas/capybara/blob/master/lib/capybara/rspec/features.rb
+#
+if RSpec::Core::Version::STRING.to_f >= 3.0
+  RSpec.shared_context "MW-Selenium Features", :mw_selenium_feature => true do
+    instance_eval do
+      alias background before
+      alias given let
+      alias given! let!
+    end
+  end
+
+  RSpec.configure do |config|
+    config.alias_example_group_to :feature, :mw_selenium_feature => true, :type => :feature
+    config.alias_example_to :scenario
+    config.alias_example_to :xscenario, :skip => "Temporarily disabled with xscenario"
+    config.alias_example_to :fscenario, :focus => true
+  end
+else
+  module MediawikiSelenium::RSpec
+    module Features
+      def self.included(base)
+        base.instance_eval do
+          alias :background :before
+          alias :scenario :it
+          alias :xscenario :xit
+          alias :given :let
+          alias :given! :let!
+          alias :feature :describe
+        end
+      end
+    end
+  end
+
+
+  def self.feature(*args, &block)
+    options = if args.last.is_a?(Hash) then args.pop else {} end
+    options[:mw_selenium_feature] = true
+    options[:type] = :feature
+    options[:caller] ||= caller
+    args.push(options)
+
+    #call describe on RSpec in case user has expose_dsl_globally set to false
+    RSpec.describe(*args, &block)
+  end
+
+  RSpec.configuration.include MediawikiSelenium::RSpec::Features, :mw_selenium_feature => true
+end

data/lib/mediawiki_selenium/step_definitions/login_steps.rb

@@ -1,5 +1,3 @@
 Given(/^I am logged in(?: as (\w+))?$/) do |user|
-  as_user(user) do |user, password|
-    visit(LoginPage).login_with(user, password)
-  end
+  as_user(user) { log_in }
 end

data/lib/mediawiki_selenium/version.rb

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

data/mediawiki_selenium.gemspec

@@ -30,9 +30,10 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'cucumber', '~> 1.3', '>= 1.3.20'
   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 'mediawiki_api', '~> 0.5', '>= 0.5.0'
   spec.add_runtime_dependency 'page-object', '~> 1.0'
   spec.add_runtime_dependency 'rest-client', '~> 1.6', '>= 1.6.7'
+  spec.add_runtime_dependency 'rspec-core', '~> 2.14', '>= 2.14.4'
   spec.add_runtime_dependency 'rspec-expectations', '~> 2.14', '>= 2.14.4'
   spec.add_runtime_dependency 'syntax', '~> 1.2', '>= 1.2.0'
   spec.add_runtime_dependency 'thor', '~> 0.19', '>= 0.19.1'
@@ -41,6 +42,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'yard', '~> 0.8', '>= 0.8.7.4'
   spec.add_development_dependency 'redcarpet', '~> 3.2', '>= 3.2.0'
   spec.add_development_dependency 'rubocop', '~> 0.29.1'
-  spec.add_development_dependency 'rspec-core', '~> 2.14', '>= 2.14.4'
   spec.add_development_dependency 'rspec-mocks', '~> 2.14', '>= 2.14.4'
 end

data/spec/environment_spec.rb

@@ -396,6 +396,18 @@ module MediawikiSelenium
       end
     end
 
+    describe '#setup' do
+      subject { env.setup(name: 'Some test name') }
+
+      it 'configures the browser factory to accept `:job_name` and `:build_number`' do
+        expect(env.browser_factory).to receive(:configure)
+        expect(env.browser_factory).to receive(:configure).with(:job_name)
+        expect(env.browser_factory).to receive(:configure).with(:build_number)
+
+        subject
+      end
+    end
+
     describe '#teardown' do
       subject { env.teardown(status: status) }
 

data/spec/screenshot_helper_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+module MediawikiSelenium
+  describe ScreenshotHelper do
+    let(:env) { Environment.new(config).extend(ScreenshotHelper) }
+
+    let(:config) { {} }
+
+    describe '#screenshot' do
+      subject { env.screenshot(browser, name) }
+
+      let(:config) { { screenshot_failures_path: 'screenshots' } }
+
+      let(:browser) { double('Watir::Browser') }
+      let(:name) { 'Some test name' }
+
+      it 'takes a screenshot of the browser' do
+        screenshot = double('Watir::Screenshot')
+        expect(browser).to receive(:screenshot).and_return(screenshot)
+        expect(screenshot).to receive(:save).with('screenshots/Some test name.png')
+
+        subject
+      end
+
+      it 'returns the path to the image file' do
+        screenshot = double('Watir::Screenshot')
+        allow(browser).to receive(:screenshot).and_return(screenshot)
+        allow(screenshot).to receive(:save)
+
+        expect(subject).to eq('screenshots/Some test name.png')
+      end
+    end
+
+    describe '#teardown' do
+      subject { env.teardown(info) }
+
+      let(:info) { { name: 'Some test name', status: status } }
+      let(:status) { :passed }
+
+      let(:browser) { double(Watir::Browser) }
+
+      before do
+        # mock {Environment#teardown}
+        allow(env.browser_factory).to receive(:each) { |&blk| [browser].each(&blk) }
+        allow(env.browser_factory).to receive(:teardown)
+        allow(browser).to receive(:close)
+      end
+
+      it 'invokes the given block with each browser' do
+        allow(env).to receive(:screenshot)
+
+        expect { |blk| env.teardown(info, &blk) }.to yield_with_args(browser)
+      end
+
+      context 'configured to take screenshots of failures' do
+        let(:config) { { screenshot_failures: true } }
+
+        context 'when the test case has failed' do
+          let(:status) { :failed }
+
+          it 'takes a screenshot of each browser' do
+            expect(env).to receive(:screenshot).with(browser, 'Some test name')
+            subject
+          end
+
+          it 'includes each screenshot in the returned artifacts' do
+            allow(env).to receive(:screenshot).and_return('Some test name.png')
+
+            expect(subject).to include('Some test name.png')
+            expect(subject['Some test name.png']).to eq('image/png')
+          end
+        end
+
+        context 'when the test case has not failed' do
+          let(:status) { :passed }
+
+          it 'takes no screenshot' do
+            expect(env).not_to receive(:screenshot)
+            subject
+          end
+        end
+      end
+
+      context 'configured to not take screenshots of failures' do
+        let(:config) { { screenshot_failures: false } }
+        let(:status) { :failed }
+
+        it 'takes no screenshot' do
+          expect(env).not_to receive(:screenshot)
+          subject
+        end
+      end
+    end
+  end
+end