mediawiki_selenium 1.6.5 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b586d9776790289bc4652f8a959ba1571359a9ee
-  data.tar.gz: 2a94ab474b58420757a688553be1988ef0bbc77a
+  metadata.gz: 3406e3a83ca87d98254baab7ad0e8aaba8a63804
+  data.tar.gz: 3cfa9c9d4be2e9646457f481a3b78948eb6fb4bf
 SHA512:
-  metadata.gz: 4665b7a2048bbfadc846778c7d88df7a6ec2c436856d31198f699305af6cb7d07d073a0a7a693de285c7f9a98598bddd356657700a6bad7c8677a9474be56299
-  data.tar.gz: 5fad19dfbfdb73de35fe183c1cde46ee940090cdf6c9372d80eb282ba21127a9e886566c3bd6b3177fb347e3b927f9da829d99c1d04aadce6d8744f1464c7beb
+  metadata.gz: 4f0ac98aeab7706c6a24f04ebc28a7253bc1fb068481106660826bf34016509765ef2337ada75b227cc666c3f5f69d88d994e4a381fb49565fd9827df8a80c3d
+  data.tar.gz: f4631f18d8ea831cac316304f9840fc7ac560c2fac92d0b1ea357deac026b9e263a1d2c26dccf82abee8c3af6df37c188cd0be867f3fe08603b154d93c8537e6

data/CREDITS

@@ -5,6 +5,7 @@ following names for their contribution to the product.
 For further details on licensing, see the LICENSE file.
 
 == Developers ==
+* Antoine Musso
 * Chris McMahon
 * Dan Duvall
 * Jeff Hall

data/README.md

@@ -204,6 +204,40 @@ the destination path for screenshots. Example:
 
     SCREENSHOT_FAILURES=true SCREENSHOT_FAILURES_PATH="/tmp/screenshots" bundle exec cucumber
 
+### CI Rake task
+
+To utilize the CI rake task, add the following to your `Rakefile`:
+
+    require 'mediawiki_selenium/rake_task'
+    MediawikiSelenium::RakeTask.new
+
+It defaults to look for `environments.yml` and `features` under `tests/browser`.
+You can specify the directory:
+
+    require 'mediawiki_selenium/rake_task'
+    MediawikiSelenium::RakeTask.new(test_dir: modules/ve-mw/tests/browser)
+
+By default, it will run something like this:
+
+    bundle exec cucumber (...) --tags ~@skip --tags @en.wikipedia.beta.wmflabs.org --tags @firefox
+
+To exclude Cucumber site tag (example: `--tags @en.wikipedia.beta.wmflabs.org`):
+
+    require 'mediawiki_selenium/rake_task'
+    MediawikiSelenium::RakeTask.new(site_tag: false)
+
+The above will run:
+
+    bundle exec cucumber (...) --tags ~@skip -tags @firefox
+
+CI specific options are passed to cucumber when the rake task detects the
+environment variable WORKSPACE is set. It will emit JUnit results under
+`$WORKSPACE/log/junit`. To reproduce that behavior one can:
+
+    export WORKSPACE=/tmp/myplace
+    mkdir -p $WORKSPACE/log/junit
+    bundle exec rake spec
+
 ## Updating Your Gemfile
 
 In your repository, the `Gemfile` specifies dependencies and `Gemfile.lock` defines

data/RELEASES.md

@@ -1,5 +1,9 @@
 ## Release notes
 
+### 1.7.0 2016-04-25
+
+* Provide Rake task to serve as a CI entrypoint
+
 ### 1.6.5 2016-01-27
 
 * Fixed `NoMethodError` in `EmbedBrowserSession` helper

data/lib/mediawiki_selenium.rb

@@ -10,6 +10,7 @@ module MediawikiSelenium
   autoload :LoginHelper, 'mediawiki_selenium/helpers/login_helper'
   autoload :PageFactory, 'mediawiki_selenium/page_factory'
   autoload :Raita, 'mediawiki_selenium/raita'
+  autoload :RakeTask, 'mediawiki_selenium/rake_task'
   autoload :RemoteBrowserFactory, 'mediawiki_selenium/remote_browser_factory'
   autoload :ScreenshotHelper, 'mediawiki_selenium/helpers/screenshot_helper'
   autoload :StrictPending, 'mediawiki_selenium/cucumber/strict_pending'

data/lib/mediawiki_selenium/cucumber/hooks.rb

@@ -3,6 +3,8 @@ Before('@custom-browser') do |scenario|
 end
 
 AfterConfiguration do |config|
+  MediawikiSelenium::Environment.default_test_directory = config.paths.first || '.'
+
   # Install a formatter that can be used to show feature-related warnings
   pretty_format, io = config.formats.find { |(format, _io)| format == 'pretty' }
   config.formats << ['MediawikiSelenium::WarningsFormatter', io] if pretty_format

data/lib/mediawiki_selenium/environment.rb

@@ -63,7 +63,7 @@ module MediawikiSelenium
     include Comparable
 
     class << self
-      attr_accessor :default_configuration
+      attr_accessor :default_configuration, :default_test_directory
 
       # Instantiates a new environment using the given set of default
       # configuration from `environments.yml` in the current working
@@ -71,20 +71,23 @@ module MediawikiSelenium
       #
       # @param name [String] Name of the environment.
       # @param extra [Hash] Additional configuration to use.
+      # @param test_dir [String] Path from which to search upward for
+      # `environments.yml`
       #
-      def load(name, extra = {})
+      def load(name, extra = {}, test_dir = nil)
         name = name.to_s
         configs = []
 
         unless name.empty?
-          envs = YAML.load_file(default_configuration)
+          envs = YAML.load_file(search_for_configuration(test_dir || default_test_directory))
           raise ConfigurationError, "unknown environment `#{name}`" unless envs.include?(name)
           configs << envs[name]
         end
 
         configs << extra
 
-        new(*configs)
+        env = new(*configs)
+        env
       end
 
       # Instantiates a new environment from the values of `ENV` and the
@@ -93,12 +96,29 @@ module MediawikiSelenium
       #
       # @see load
       #
-      def load_default
-        load(ENV['MEDIAWIKI_ENVIRONMENT'] || 'default', ENV)
+      def load_default(test_dir = nil)
+        load(ENV['MEDIAWIKI_ENVIRONMENT'] || 'default', ENV, test_dir)
+      end
+
+      # Searches for `environments.yml` in the given path. If it isn't found,
+      # the search continues upward in the directory hierarchy.
+      #
+      # @param path [String] Path to search for configuration
+      #
+      # @return [String] Qualified path to the configuration file
+      #
+      def search_for_configuration(path)
+        return default_configuration if path.nil? || path.empty?
+
+        file_path = File.join(path, default_configuration)
+        return file_path if File.exist?(file_path)
+
+        search_for_configuration(File.dirname(path))
       end
     end
 
     self.default_configuration = 'environments.yml'
+    self.default_test_directory = 'tests/browser'
 
     def initialize(*configs)
       @_config = configs.map { |config| normalize_config(config) }.reduce(:merge)
@@ -174,12 +194,41 @@ module MediawikiSelenium
       end
     end
 
-    # Name of the browser we're using.
+    # Name of the browser we're using. If the `:browser` configuration
+    # contains a version at the end, only the name is returned.
+    #
+    # @example
+    #   env = Environment.new(browser: 'internet_explorer 8.0')
+    #   env.browser_name # => :internet_explorer
     #
     # @return [Symbol]
     #
     def browser_name
-      lookup(:browser, default: 'firefox').downcase.to_sym
+      browser_spec[0].to_sym
+    end
+
+    # Tag names that can be used to filter test scenarios for a specific
+    # browser and/or version.
+    #
+    # @return [Array<String>]
+    #
+    def browser_tags
+      tags = [browser_name.to_s]
+
+      version = browser_version
+      tags << "#{browser_name}_#{version}" if version
+
+      tags
+    end
+
+    # Version of the browser we're using. If a `:version` configuration
+    # is provided, that value is returned. Otherwise a version is searched for
+    # in the `:browser` configuration.
+    #
+    # @return [String]
+    #
+    def browser_version
+      lookup(:version, default: browser_spec[1])
     end
 
     # Returns the current alternate ID for the given configuration key.
@@ -514,7 +563,19 @@ module MediawikiSelenium
     private
 
     def browser_config
-      lookup_all(browser_factory.all_binding_keys, default: nil).reject { |_k, v| v.nil? }
+      config = lookup_all(browser_factory.all_binding_keys, default: nil).reject { |_k, v| v.nil? }
+
+      # The browser version may be provided as part of the `:browser`
+      # configuration or separately as `:version`. In either case,
+      # `browser_version` will return the right value.
+      version = browser_version
+      config[:version] = version unless version.nil?
+
+      config
+    end
+
+    def browser_spec
+      lookup(:browser, default: 'firefox').to_s.downcase.split(' ')
     end
 
     def normalize_config(hash)

data/lib/mediawiki_selenium/rake_task.rb

@@ -0,0 +1,31 @@
+require 'cucumber/rake/task'
+require 'mediawiki_selenium'
+require 'uri'
+
+module MediawikiSelenium
+  class RakeTask < Cucumber::Rake::Task
+    def initialize(name: :selenium, test_dir: Environment.default_test_directory, site_tag: true)
+      target = File.expand_path(test_dir, Rake.original_dir)
+      env = Environment.load_default(target)
+
+      workspace = env.lookup(:workspace, default: nil)
+      site = URI.parse(env.lookup(:mediawiki_url)).host
+      browser_tags = env.browser_tags.map { |tag| "@#{tag}" }.join(',')
+
+      options = Shellwords.escape(test_dir)
+
+      if workspace
+        options +=
+          ' --backtrace --verbose --color --format pretty'\
+          " --format Cucumber::Formatter::Sauce --out '#{workspace}/log/junit'"\
+          ' --tags ~@skip'
+        options +=
+          " --tags @#{site}" if site_tag
+      end
+
+      super(name) do |t|
+        t.cucumber_opts = "#{options} --tags #{browser_tags}"
+      end
+    end
+  end
+end

data/lib/mediawiki_selenium/version.rb

@@ -1,3 +1,3 @@
 module MediawikiSelenium
-  VERSION = '1.6.5'
+  VERSION = '1.7.0'
 end

data/spec/environment_spec.rb

@@ -23,18 +23,16 @@ module MediawikiSelenium
     let(:mediawiki_user) { 'mw user' }
     let(:mediawiki_password) { 'mw password' }
 
-    def mock_environment_name(name)
-      expect(ENV).to receive(:[]).with('MEDIAWIKI_ENVIRONMENT').and_return(name)
-    end
-
     describe '.load' do
       subject { Environment.load(name, extra) }
 
       let(:name) { 'foo' }
       let(:extra) { {} }
+      let(:env_file) { 'environments.yml' }
 
       before do
-        expect(YAML).to receive(:load_file).with('environments.yml').
+        allow(Environment).to receive(:search_for_configuration).and_return(env_file)
+        allow(YAML).to receive(:load_file).with(env_file).
           and_return('foo' => { 'x' => 'a', 'y' => 'b' })
       end
 
@@ -63,21 +61,43 @@ module MediawikiSelenium
           expect(subject[:y]).to eq('b')
         end
       end
+
+      context 'when a test_dir is given' do
+        subject { Environment.load('foo', {}, test_dir) }
+
+        let(:test_dir) { '/srv/workspace/job' }
+        let(:env_file) { File.join(test_dir, 'environments.yml') }
+
+        it 'loads configuration in the given test_dir' do
+          expect(Environment).to receive(:search_for_configuration).with(test_dir).
+            and_return(env_file)
+          expect(YAML).to receive(:load_file).with(env_file).
+            and_return('foo' => { 'x' => 'a', 'y' => 'b' })
+          subject
+        end
+      end
+
     end
 
     describe '.load_default' do
       subject { Environment.load_default }
 
+      let(:mediawiki_environment) { 'foo' }
+
+      before do
+        expect(ENV).to receive(:[]).with('MEDIAWIKI_ENVIRONMENT').and_return(mediawiki_environment)
+      end
+
       it 'loads the environment configuration specified by MEDIAWIKI_ENVIRONMENT' do
-        mock_environment_name('foo')
-        expect(Environment).to receive(:load).with('foo', ENV)
+        expect(Environment).to receive(:load).with(mediawiki_environment, ENV, nil)
         subject
       end
 
       context 'where MEDIAWIKI_ENVIRONMENT is not defined' do
+        let(:mediawiki_environment) { nil }
+
         it 'looks for a "default" environment' do
-          mock_environment_name(nil)
-          expect(Environment).to receive(:load).with('default', ENV)
+          expect(Environment).to receive(:load).with('default', ENV, nil)
           subject
         end
       end
@@ -250,6 +270,60 @@ module MediawikiSelenium
           expect(subject).to be(:firefox)
         end
       end
+
+      context 'when browser and version are combined' do
+        let(:browser) { 'internet_explorer 8.0' }
+
+        it 'returns only the name' do
+          expect(subject).to be(:internet_explorer)
+        end
+      end
+    end
+
+    describe '#browser_tags' do
+      subject { env.browser_tags }
+
+      context 'when a version is specified' do
+        let(:browser) { 'internet_explorer 8.0' }
+
+        it 'returns tags for use in filter test scenarios' do
+          expect(subject).to eq(['internet_explorer', 'internet_explorer_8.0'])
+        end
+      end
+
+      context 'when no version is specified' do
+        let(:browser) { 'internet_explorer' }
+
+        it 'includes only a tag for the browser name' do
+          expect(subject).to eq(['internet_explorer'])
+        end
+      end
+    end
+
+    describe '#browser_version' do
+      subject { env.browser_version }
+
+      let(:browser) { 'internet_explorer 8.0' }
+
+      context 'when no explicit version configuration is provided' do
+        it 'is the version specified at the end of browser' do
+          expect(subject).to eq('8.0')
+        end
+      end
+
+      context 'when an explicit version configuration is provided' do
+        let(:config) { minimum_config.merge(version: '9.0') }
+
+        it 'ignores the version given at the end of browser and returns the explicit one' do
+          expect(subject).to eq('9.0')
+        end
+      end
+
+      context 'when no version is specified' do
+        let(:browser) { 'internet_explorer' }
+
+        it { is_expected.to be(nil) }
+      end
     end
 
     describe '#current_alternative' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mediawiki_selenium
 version: !ruby/object:Gem::Version
-  version: 1.6.5
+  version: 1.7.0
 platform: ruby
 authors:
 - Chris McMahon
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-27 00:00:00.000000000 Z
+date: 2016-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -395,6 +395,7 @@ files:
 - lib/mediawiki_selenium/raita/formatter.rb
 - lib/mediawiki_selenium/raita/logger.rb
 - lib/mediawiki_selenium/raita/null_io.rb
+- lib/mediawiki_selenium/rake_task.rb
 - lib/mediawiki_selenium/remote_browser_factory.rb
 - lib/mediawiki_selenium/rspec.rb
 - lib/mediawiki_selenium/rspec/environment.rb
@@ -445,7 +446,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: An easy way to run MediaWiki Selenium tests.