mediawiki_selenium 0.2.26 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f079ad42db103a267db048e2caf9bb03e910911d
-  data.tar.gz: b0c542267736ce3e2956b902e8b43b90e74f7a23
+  metadata.gz: 39a9f6171eeccfe111262d9a406ca3d7a569ecfc
+  data.tar.gz: 3232fb53eea9d230aaeec39878ea44d987859f70
 SHA512:
-  metadata.gz: d1760d96c06c03b8e49cc292b7fa0172da951a725610eba00fc0cd8432df1bb754f0235f013acca7495136e28c59bd4b27cf5ec9294d0a5d14a3c7bf38b2d333
-  data.tar.gz: a8c620362ea465f5399ca3c077d53310c52e3dfc22999a3825cf2386e15119517e9453187e5ce92f36f282e39ca0476d7544ea2606765b2e25208315866e105e
+  metadata.gz: aa23a5af45e5b55bd38d789c56b81c3d9e7c020a28a4039eb0281d29794235b9d718593f698c31aa06f76d059ec4b69c81578f236f011b7cd7e24c871da2e84a
+  data.tar.gz: 08146c6e2d7494b117edcc1fdd9376736713843a1867ceb965b21b7886aefdb30d13c807a81c7d16ef1a3e246643f0624a76e995942d5ad3fb3c0b05f8e4753d

data/CREDITS

@@ -6,6 +6,7 @@ For further details on licensing, see the LICENSE file.
 
 == Developers ==
 * Chris McMahon
+* Dan Duvall
 * Jeff Hall
 * Nikolas Everett
 * Tobias Gritschacher

data/README.md

@@ -11,7 +11,7 @@ versions of RubyGems and Firefox (the default browser in which the tests run).
 The easiest way to install Ruby on Linux/Unix/Mac is [RVM](https://rvm.io/) and
 on Windows [RubyInstaller](http://rubyinstaller.org/).
 
-    cd /tests/browser
+    cd tests/browser
     gem update --system
     gem install bundler
     bundle install
@@ -89,7 +89,12 @@ commit back both files.
 
 ## Links
 
-mediawiki_selenium gem: [Gerrit](https://gerrit.wikimedia.org/r/#/admin/projects/mediawiki/selenium), [GitHub](https://github.com/wikimedia/mediawiki-selenium), [RubyGems](https://rubygems.org/gems/mediawiki_selenium), [Code Climate](https://codeclimate.com/github/wikimedia/mediawiki-selenium)
+### Gems
+
+1. mediawiki_selenium: [Gerrit](https://gerrit.wikimedia.org/r/#/admin/projects/mediawiki/selenium), [GitHub](https://github.com/wikimedia/mediawiki-selenium), [RubyGems](https://rubygems.org/gems/mediawiki_selenium), [Code Climate](https://codeclimate.com/github/wikimedia/mediawiki-selenium)
+1. mediawiki_api: [Gerrit](https://gerrit.wikimedia.org/r/#/admin/projects/mediawiki/ruby/api), [GitHub](https://github.com/wikimedia/mediawiki-ruby-api), [RubyGems](https://rubygems.org/gems/mediawiki_api), [Code Climate](https://codeclimate.com/github/wikimedia/mediawiki-ruby-api)
+
+### Repositories
 
 If not stated differently, Selenium tests are in `/tests/browser` folder and Jenkins jobs are at [integration.wikimedia.org/ci/view/BrowserTests](https://integration.wikimedia.org/ci/view/BrowserTests/).
 
@@ -99,7 +104,8 @@ Repositories that use the gem:
 1. CirrusSearch: [Gerrit](https://gerrit.wikimedia.org/r/#/admin/projects/mediawiki/extensions/CirrusSearch), [GitHub](https://github.com/wikimedia/mediawiki-extensions-CirrusSearch), [Code Climate](https://codeclimate.com/github/wikimedia/mediawiki-extensions-CirrusSearch)
 1. ContentTranslation: [Gerrit](https://gerrit.wikimedia.org/r/#/admin/projects/mediawiki/extensions/ContentTranslation), [GitHub](https://github.com/wikimedia/mediawiki-extensions-ContentTranslation), [Code Climate](https://codeclimate.com/github/wikimedia/mediawiki-extensions-ContentTranslation)
 1. Flow: [Gerrit](https://gerrit.wikimedia.org/r/#/admin/projects/mediawiki/extensions/Flow), [GitHub](https://github.com/wikimedia/mediawiki-extensions-Flow), [Code Climate](https://codeclimate.com/github/wikimedia/mediawiki-extensions-Flow)
-1. MediaWiki: [Gerrit](https://gerrit.wikimedia.org/r/#/admin/projects/mediawiki/core), [GitHub](https://github.com/wikimedia/mediawiki-core), [Code Climate](https://codeclimate.com/github/wikimedia/mediawiki-core)
+1. Math: [Gerrit](https://gerrit.wikimedia.org/r/#/admin/projects/mediawiki/extensions/Math), [GitHub](https://github.com/wikimedia/mediawiki-extensions-Math), [Code Climate](https://codeclimate.com/github/wikimedia/mediawiki-extensions-Math)
+1. mediawiki/core: [Gerrit](https://gerrit.wikimedia.org/r/#/admin/projects/mediawiki/core), [GitHub](https://github.com/wikimedia/mediawiki-core), [Code Climate](https://codeclimate.com/github/wikimedia/mediawiki-core)
 1. MobileFrontend: [Gerrit](https://gerrit.wikimedia.org/r/#/admin/projects/mediawiki/extensions/MobileFrontend), [GitHub](https://github.com/wikimedia/mediawiki-extensions-MobileFrontend), [Code Climate](https://codeclimate.com/github/wikimedia/mediawiki-extensions-MobileFrontend)
 1. MultimediaViewer: [Gerrit](https://gerrit.wikimedia.org/r/#/admin/projects/mediawiki/extensions/MultimediaViewer), [GitHub](https://github.com/wikimedia/mediawiki-extensions-MultimediaViewer), [Code Climate](https://codeclimate.com/github/wikimedia/mediawiki-extensions-MultimediaViewer)
 1. PageTriage: [Gerrit](https://gerrit.wikimedia.org/r/#/admin/projects/mediawiki/extensions/PageTriage), [GitHub](https://github.com/wikimedia/mediawiki-extensions-PageTriage), [Code Climate](https://codeclimate.com/github/wikimedia/mediawiki-extensions-PageTriage)
@@ -108,22 +114,29 @@ Repositories that use the gem:
 1. UniversalLanguageSelector: [Gerrit](https://gerrit.wikimedia.org/r/#/admin/projects/mediawiki/extensions/UniversalLanguageSelector), [GitHub](https://github.com/wikimedia/mediawiki-extensions-UniversalLanguageSelector), [Code Climate](https://codeclimate.com/github/wikimedia/mediawiki-extensions-UniversalLanguageSelector)
 1. UploadWizard: [Gerrit](https://gerrit.wikimedia.org/r/#/admin/projects/mediawiki/extensions/UploadWizard), [GitHub](https://github.com/wikimedia/mediawiki-extensions-UploadWizard), [Code Climate](https://codeclimate.com/github/wikimedia/mediawiki-extensions-UploadWizard)
 1. VisualEditor: [Gerrit](https://gerrit.wikimedia.org/r/#/admin/projects/mediawiki/extensions/VisualEditor), [GitHub](https://github.com/wikimedia/mediawiki-extensions-VisualEditor), [Code Climate](https://codeclimate.com/github/wikimedia/mediawiki-extensions-VisualEditor), `/modules/ve-mw/tests/browser` folder
-1. WikidataBrowserTests: [GitHub](https://github.com/wmde/WikidataBrowserTests), [Code Climate](https://codeclimate.com/github/wmde/WikidataBrowserTests), [Jenkins](http://wdjenkins.wmflabs.org/ci/), `/` folder
+1. WikidataBrowserTests: [GitHub](https://github.com/wmde/WikidataBrowserTests), [Code Climate](https://codeclimate.com/github/wmde/WikidataBrowserTests), [Jenkins](http://wdjenkins.wmflabs.org/ci/)
 1. WikiLove: [Gerrit](https://gerrit.wikimedia.org/r/#/admin/projects/mediawiki/extensions/WikiLove), [GitHub](https://github.com/wikimedia/mediawiki-extensions-WikiLove), [Code Climate](https://codeclimate.com/github/wikimedia/mediawiki-extensions-WikiLove)
 1. ZeroBanner: [Gerrit](https://gerrit.wikimedia.org/r/#/admin/projects/mediawiki/extensions/ZeroBanner), [GitHub](https://github.com/wikimedia/mediawiki-extensions-ZeroBanner), [Code Climate](https://codeclimate.com/github/wikimedia/mediawiki-extensions-ZeroBanner)
 
-## Contributing
+### Alumni
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+1. Wikibase: [Gerrit](https://gerrit.wikimedia.org/r/#/admin/projects/mediawiki/extensions/Wikibase), [GitHub](https://github.com/wikimedia/mediawiki-extensions-Wikibase), [Code Climate](https://codeclimate.com/github/wikimedia/mediawiki-extensions-Wikibase)
+1. ZeroRatedMobileAccess: [Gerrit](https://gerrit.wikimedia.org/r/#/admin/projects/mediawiki/extensions/ZeroRatedMobileAccess), [GitHub](https://github.com/wikimedia/mediawiki-extensions-ZeroRatedMobileAccess), [Code Climate](https://codeclimate.com/github/wikimedia/mediawiki-extensions-ZeroRatedMobileAccess)
+1. browsertests: [Gerrit](https://gerrit.wikimedia.org/r/#/admin/projects/qa/browsertests), [GitHub](https://github.com/wikimedia/qa-browsertests), [Code Climate](https://codeclimate.com/github/wikimedia/qa-browsertests)
 
-Also see https://www.mediawiki.org/wiki/QA/Browser_testing#How_to_contribute
+## Contributing
+
+See https://www.mediawiki.org/wiki/Gerrit
 
 ## Release notes
 
+### 0.3.0 2014-08-08
+
+* Support for MediaWiki extension dependencies via `@extension-<name>` tags
+* World `api` helper method for direct access to a pre-authenticated API client
+* Gem dependency fixes
+* Updated readme
+
 ### 0.2.26 2014-07-18
 
 * Added runtime dependency on mediawiki_api

data/lib/mediawiki_selenium.rb

@@ -21,6 +21,7 @@ require "mediawiki_selenium/step_definitions/preferences_steps"
 require "mediawiki_selenium/step_definitions/resource_loader_steps"
 require "mediawiki_selenium/step_definitions/upload_file_steps"
 
+require "mediawiki_selenium/support/modules/api_helper"
 require "mediawiki_selenium/support/modules/url_module"
 
 require "mediawiki_selenium/support/pages/api_page"

data/lib/mediawiki_selenium/support/env.rb

@@ -15,9 +15,11 @@ require "page-object"
 require "page-object/page_factory"
 require "rest_client"
 require "watir-webdriver"
-require "yaml"
+
+require "mediawiki_selenium/support/modules/api_helper"
 
 World(PageObject::PageFactory)
+World(MediawikiSelenium::ApiHelper)
 
 def browser(test_name, configuration = nil)
   if environment == :saucelabs

data/lib/mediawiki_selenium/support/hooks.rb

@@ -19,9 +19,45 @@ Before("@login") do
   puts "MEDIAWIKI_PASSWORD environment variable is not defined! Please export a value for that variable before proceeding." unless ENV["MEDIAWIKI_PASSWORD"]
 end
 
+# Install a formatter that can be used to show feature-related warnings
+AfterConfiguration do |config|
+  pretty_format, io = config.formats.find { |(format, io)| format == "pretty" }
+  config.formats << ["MediawikiSelenium::WarningsFormatter", io] if pretty_format
+end
+
+# Enforce a dependency check for all scenarios tagged with @extension- tags
+Before do |scenario|
+  # Backgrounds themselves don't have tags, so get them from the feature
+  if scenario.is_a?(Cucumber::Ast::Background)
+    tag_source = scenario.feature
+  else
+    tag_source = scenario
+  end
+
+  tags = tag_source.source_tag_names
+  dependencies = tags.map { |tag| tag.match(/^@extension-(.+)$/) { |m| m[1] } }.compact
+
+  unless dependencies.empty?
+    extensions = api.meta(:siteinfo, siprop: "extensions").data["extensions"]
+    extensions = extensions.map { |ext| ext["type"] }
+    missing = dependencies - extensions
+
+    if missing.any?
+      scenario.skip_invoke!
+
+      if scenario.feature.respond_to?(:mw_warn)
+        warning = "Skipped feature due to missing wiki extensions: #{missing.join(", ")}"
+        scenario.feature.mw_warn(warning, "missing wiki extensions")
+      end
+    end
+  end
+end
+
 Before do |scenario|
   @random_string = Random.new.rand.to_s
-  if ENV["REUSE_BROWSER"] == "true" and $browser # CirrusSearch and VisualEditor need this
+
+  # CirrusSearch and VisualEditor need this
+  if ENV["REUSE_BROWSER"] == "true" && $browser
     @browser = $browser
   elsif scenario.source_tag_names.include? "@custom-browser"
     # browser will be started in Cucumber step
@@ -42,10 +78,15 @@ After do |scenario|
     @browser.screenshot.save path
     embed path, "image/png"
   end
+
   if environment == :saucelabs
     sauce_api(%Q{{"passed": #{scenario.passed?}}})
     sauce_api(%Q{{"public": true}})
     sauce_api(%Q{{"build": #{ENV["BUILD_NUMBER"]}}}) if ENV["BUILD_NUMBER"]
   end
-  @browser.close unless ENV["KEEP_BROWSER_OPEN"] == "true" or ENV["REUSE_BROWSER"] == "true" # CirrusSearch and VisualEditor need this
+
+  if @browser
+    # CirrusSearch and VisualEditor need this
+    @browser.close unless ENV["KEEP_BROWSER_OPEN"] == "true" || ENV["REUSE_BROWSER"] == "true"
+  end
 end

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

@@ -0,0 +1,20 @@
+require "mediawiki_api"
+
+module MediawikiSelenium
+  # Provides more direct access to the API client from hooks and step
+  # definitions.
+  #
+  module ApiHelper
+    # A pre-authenticated API client.
+    #
+    # @return [MediawikiApi::Client]
+    #
+    def api
+      return @api if defined?(@api)
+
+      @api = MediawikiApi::Client.new(ENV["MEDIAWIKI_API_URL"])
+      @api.log_in(*ENV.values_at("MEDIAWIKI_USER", "MEDIAWIKI_PASSWORD")) unless @api.logged_in?
+      @api
+    end
+  end
+end

data/lib/mediawiki_selenium/support/pages/api_page.rb

@@ -4,18 +4,23 @@ class APIPage
   include PageObject
 
   def client
-    abort "Environment variable MEDIAWIKI_API_URL must be set in order to create a target page for this test" unless ENV["MEDIAWIKI_API_URL"]
+    return @client if defined?(@client)
 
-    client = MediawikiApi::Client.new ENV["MEDIAWIKI_API_URL"]
-    client.log_in ENV["MEDIAWIKI_USER"], ENV["MEDIAWIKI_PASSWORD"]
-    client
+    unless ENV["MEDIAWIKI_API_URL"]
+      raise "Environment variable MEDIAWIKI_API_URL must be set in order to use the API"
+    end
+
+    @client = MediawikiApi::Client.new(ENV["MEDIAWIKI_API_URL"])
+    @client.log_in ENV["MEDIAWIKI_USER"], ENV["MEDIAWIKI_PASSWORD"]
+
+    @client
   end
 
-  def create title, content
+  def create(title, content)
     client.create_page title, content
   end
 
-  def protect title, reason
+  def protect(title, reason)
     client.protect_page title, reason
   end
 end

data/lib/mediawiki_selenium/version.rb

@@ -10,5 +10,5 @@ https://git.wikimedia.org/blob/mediawiki%2Fselenium/HEAD/CREDITS.
 =end
 
 module MediawikiSelenium
-  VERSION = "0.2.26"
+  VERSION = "0.3.0"
 end

data/lib/mediawiki_selenium/warnings_formatter.rb

@@ -0,0 +1,54 @@
+require "cucumber/formatter/console"
+
+module MediawikiSelenium
+  class WarningsFormatter
+    include Cucumber::Formatter::Console
+
+    def initialize(runtime, io, options)
+      @io = io
+      @warning_counts = Hash.new(0)
+    end
+
+    def after_feature(feature)
+      if feature.mw_warnings.any?
+        feature.mw_warnings.each do |type, messages|
+          messages.each { |msg| @io.puts format_string(msg, :pending) }
+          @warning_counts[type] += messages.length
+        end
+
+        @io.puts
+      end
+    end
+
+    def after_features(features)
+      if @warning_counts.any?
+        @warning_counts.each do |type, count|
+          message = "#{count} warning#{count > 1 ? "s" : ""}"
+          message += " due to #{type}" unless type == :default
+          @io.puts format_string(message, :pending)
+        end
+      end
+    end
+
+    def before_feature(feature)
+      feature.extend(FeatureWarnings)
+    end
+
+    private
+
+    module FeatureWarnings
+      def mw_warn(message, type = :default)
+        mw_warnings[type] ||= []
+        mw_warnings[type] << message
+      end
+
+      def mw_warnings
+        @__mediawiki_warnings ||= {}
+      end
+
+      def mw_warning_messages
+        mw_warnings.map(&:values).flatten
+      end
+    end
+  end
+end

data/mediawiki_selenium.gemspec

@@ -6,8 +6,8 @@ require "mediawiki_selenium/version"
 Gem::Specification.new do |spec|
   spec.name          = "mediawiki_selenium"
   spec.version       = MediawikiSelenium::VERSION
-  spec.authors       = ["Chris McMahon", "Jeff Hall", "Nikolas Everett", "Tobias Gritschacher", "Željko Filipin"]
-  spec.email         = ["cmcmahon@wikimedia.org", "jhall@wikimedia.org", "neverett@wikimedia.org", "tobias.gritschacher@wikimedia.de", "zeljko.filipin@gmail.com"]
+  spec.authors       = ["Chris McMahon", "Dan Duvall", "Jeff Hall", "Nikolas Everett", "Tobias Gritschacher", "Željko Filipin"]
+  spec.email         = ["cmcmahon@wikimedia.org", "dduvall@wikimedia.org", "jhall@wikimedia.org", "neverett@wikimedia.org", "tobias.gritschacher@wikimedia.de", "zeljko.filipin@gmail.com"]
   spec.description   = %q{Several MediaWiki extensions share code that makes it easy to run Selenium tests. This gem
 makes it easy to update the shared code.}
   spec.summary       = %q{An easy way to run MediaWiki Selenium tests.}
@@ -20,7 +20,7 @@ makes it easy to update the shared code.}
   spec.add_runtime_dependency "cucumber", "~> 1.3", ">= 1.3.10"
   spec.add_runtime_dependency "headless", "~> 1.0", ">= 1.0.1"
   spec.add_runtime_dependency "json", "~> 1.8", ">= 1.8.1"
-  spec.add_runtime_dependency "mediawiki_api", "~> 0.1.3"
+  spec.add_runtime_dependency "mediawiki_api", "~> 0.2", ">= 0.2.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-expectations", "~> 2.14", ">= 2.14.4"

metadata

@@ -1,10 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: mediawiki_selenium
 version: !ruby/object:Gem::Version
-  version: 0.2.26
+  version: 0.3.0
 platform: ruby
 authors:
 - Chris McMahon
+- Dan Duvall
 - Jeff Hall
 - Nikolas Everett
 - Tobias Gritschacher
@@ -12,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-18 00:00:00.000000000 Z
+date: 2014-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -80,14 +81,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: page-object
   requirement: !ruby/object:Gem::Requirement
@@ -167,6 +174,7 @@ description: |-
   makes it easy to update the shared code.
 email:
 - cmcmahon@wikimedia.org
+- dduvall@wikimedia.org
 - jhall@wikimedia.org
 - neverett@wikimedia.org
 - tobias.gritschacher@wikimedia.de
@@ -189,6 +197,7 @@ files:
 - lib/mediawiki_selenium/step_definitions/upload_file_steps.rb
 - 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/url_module.rb
 - lib/mediawiki_selenium/support/pages/api_page.rb
 - lib/mediawiki_selenium/support/pages/login_page.rb
@@ -196,6 +205,7 @@ files:
 - lib/mediawiki_selenium/support/pages/reset_preferences_page.rb
 - lib/mediawiki_selenium/support/sauce.rb
 - lib/mediawiki_selenium/version.rb
+- lib/mediawiki_selenium/warnings_formatter.rb
 - mediawiki_selenium.gemspec
 homepage: https://gerrit.wikimedia.org/r/#/admin/projects/mediawiki/selenium
 licenses:
@@ -217,7 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: An easy way to run MediaWiki Selenium tests.