mediawiki_selenium 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7aa88726278140c10f75311afdd0a7539db96fda
-  data.tar.gz: 78c6c6c468dadd5a49ae3d6dff971b4ffa46dc1e
+  metadata.gz: 0037caf23b15c884315fe6a5c1b9980c5a090133
+  data.tar.gz: d4230eccd57eb777a52ceed3bd433cf75f3f624e
 SHA512:
-  metadata.gz: 2790c6bafb50c5924b545ee72d1149732a046d45a7833bcc38f6381721b1a683dd099ec95fd9dd9e4f47fabe1b29cd83fcd0560871e0b6387e333a1d0bc56e63
-  data.tar.gz: 62f2281382c96ddc1489bb31cc0d4977b06b3a3bcecde883847fccb90ec713a43394f355a30710376118c4bdd91f6cc78f460eecc1a935df6914ddd237dda4ef
+  metadata.gz: 58be25747927e6719e1bb3bb04f3a195c24221aab7d357a2073667188f04bb3b696a76d959aaff2d109f6c4173ccdd73f678c7b866e91a65e588d526a404940f
+  data.tar.gz: ac660b1c962b03a8784c4de974395386b04d3f9d53695f97bbe1becfd0305ab4fd4f9dd0630c629d8e9c99f54afd3cf9e80f63b42e869808afe60068d8d2dc5a

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.0.2'
+    gem 'mediawiki_selenium', '~> 1.2.0'
 
 Install the gem and its dependencies by running `bundle install`. (If
 [Bundler](http://bundler.io/) is not yet installed, install it with
@@ -199,6 +199,11 @@ See https://www.mediawiki.org/wiki/Gerrit
 
 ## Release notes
 
+### 1.2.0 2015-05-28
+* Support logging to a [Raita](http://git.wikimedia.org/summary/integration%2Fraita.git)
+  Elasticsearch database by setting `RAITA_URL`
+* Removed deprecated support for `MEDIAWIKI_PASSWORD_VARIABLE`
+
 ### 1.1.0 2015-04-06
 * Support for `browser_http_proxy` in Firefox, Chrome, and Phantomjs
 * Renamed browser factory `bind` method to `configure`

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.0.0'
+    gem 'mediawiki_selenium', '~> 1.2.0'
 
 ## Upgrade gems and dependencies
 

data/lib/mediawiki_selenium.rb

@@ -6,5 +6,6 @@ module MediawikiSelenium
   autoload :Environment, 'mediawiki_selenium/environment'
   autoload :Initializer, 'mediawiki_selenium/initializer'
   autoload :PageFactory, 'mediawiki_selenium/page_factory'
+  autoload :Raita, 'mediawiki_selenium/raita'
   autoload :RemoteBrowserFactory, 'mediawiki_selenium/remote_browser_factory'
 end

data/lib/mediawiki_selenium/environment.rb

@@ -317,7 +317,7 @@ module MediawikiSelenium
     # @return [String]
     #
     def password(id = nil)
-      lookup(password_variable, id: id)
+      lookup(:mediawiki_password, id: id)
     end
 
     # Whether this environment has been configured to use remote browser
@@ -476,11 +476,6 @@ module MediawikiSelenium
       lookup_all(browser_factory.all_binding_keys, default: nil).reject { |_k, v| v.nil? }
     end
 
-    def password_variable
-      name = lookup(:mediawiki_password_variable, default: '')
-      name.empty? ? :mediawiki_password : normalize_key(name)
-    end
-
     def normalize_config(hash)
       hash.each.with_object({}) { |(k, v), acc| acc[normalize_key(k)] = v }
     end

data/lib/mediawiki_selenium/raita.rb

@@ -0,0 +1,46 @@
+module MediawikiSelenium
+  # Supports logging to a Raita Elasticsearch index. Raita is a dashboard for
+  # visualizing and taking action on the results of Cucumber tests.
+  #
+  module Raita
+    # Mapping of environment configuration/variables to Raita build fields.
+    #
+    ENV_TO_BUILD_MAPPING = {
+      build_number:          :number,
+      build_url:             :url,
+      job_name:              [:project, :name],
+      git_commit:            [:project, :commit],
+      git_branch:            [:project, :branch],
+      git_url:               [:project, :repo],
+      mediawiki_environment: [:environment, :name],
+      mediawiki_url:         [:environment, :url],
+      browser:               [:browser, :name],
+      version:               [:browser, :version],
+      platform:              [:browser, :platform]
+    }
+
+    autoload :Formatter, 'mediawiki_selenium/raita/formatter'
+    autoload :Logger, 'mediawiki_selenium/raita/logger'
+    autoload :NullIO, 'mediawiki_selenium/raita/null_io'
+
+    # Returns a hash of relevant build information from the given {Environment}.
+    #
+    # @param env {Environment}
+    #
+    # @return {Hash} Raita build object.
+    #
+    def self.build_from(env)
+      ENV_TO_BUILD_MAPPING.each.with_object({}) do |(from, to), build|
+        value = env.lookup(from, default: nil)
+
+        case to
+        when Array
+          build[to.first] ||= {}
+          build[to.first][to.last] = value
+        else
+          build[to] = value
+        end
+      end
+    end
+  end
+end

data/lib/mediawiki_selenium/raita/formatter.rb

@@ -0,0 +1,21 @@
+require 'gherkin/formatter/json_formatter'
+
+module MediawikiSelenium
+  module Raita
+    class Formatter < Gherkin::Formatter::JSONFormatter
+      attr_reader :feature_hashes
+
+      def initialize
+        super(NullIO.new)
+      end
+
+      # Allows for simple embeddings without base64 encoding.
+      #
+      def embedding(mime_type, data)
+        return unless mime_type.start_with?('text/')
+
+        embeddings << { 'mime_type' => mime_type, 'data' => data }
+      end
+    end
+  end
+end

data/lib/mediawiki_selenium/raita/logger.rb

@@ -0,0 +1,114 @@
+require 'cucumber/formatter/gherkin_formatter_adapter'
+require 'net/http'
+
+module MediawikiSelenium
+  module Raita
+    class Logger < Cucumber::Formatter::GherkinFormatterAdapter
+      def initialize(_runtime, raita_options, options)
+        super(Formatter.new, false, options)
+        @db_url = URI.parse(raita_options[:url])
+        @build = raita_options[:build].merge(result: { status: 'passed', duration: 0 })
+      end
+
+      # Log everything at once to Raita's Elasticsearch DB.
+      #
+      def after_features(*)
+        @build_id = create('build', @build)['_id']
+
+        @gf.feature_hashes.each do |feature|
+          amend_feature(feature)
+          elements = feature.delete('elements')
+
+          feature_id = create('feature', feature, @build_id)['_id']
+          bulk('feature-element', elements, feature_id)
+
+          @build[:result][:status] = change_status(
+            @build[:result][:status],
+            feature['result']['status']
+          )
+          @build[:result][:duration] += feature['result']['duration']
+        end
+
+        update('build', @build_id, @build)
+      end
+
+      private
+
+      # Add status and duration at the feature and background/scenario level.
+      #
+      # @param feature {Hash}
+      #
+      def amend_feature(feature)
+        feature['result'] = { 'duration' => 0, 'status' => 'passed' }
+
+        feature['elements'].each do |element|
+          element['result'] = { 'duration' => 0, 'status' => 'passed' }
+
+          element['steps'].each do |step|
+            feature['result']['duration'] += step['result']['duration']
+            element['result']['duration'] += step['result']['duration']
+
+            element['result']['status'] = change_status(
+              element['result']['status'],
+              step['result']['status']
+            )
+          end
+
+          feature['result']['status'] = change_status(
+            feature['result']['status'],
+            element['result']['status']
+          )
+        end
+      end
+
+      # Calculates a new status given the current parent status and the next
+      # child status. A status can go from 'passed' to anything, 'skipped' to
+      # 'failed'.
+      #
+      def change_status(cur, new)
+        case cur.to_s
+        when 'passed'
+          new
+        when 'skipped'
+          new == 'failed' ? new : cur
+        else
+          cur
+        end
+      end
+
+      def bulk(type, objects, parent = nil)
+        data = objects.reduce('') do |d, obj|
+          d << JSON.dump({ create: { _type: type, _parent: parent, _routing: @build_id } }) + "\n"
+          d << JSON.dump(obj) + "\n\n"
+        end
+
+        request(Net::HTTP::Post, ['_bulk'], data)
+      end
+
+      def create(type, object, parent = nil)
+        request(Net::HTTP::Post, [type], object, parent: parent, routing: @build_id)
+      end
+
+      def request(klass, paths, data, query = {})
+        query = query.reject { |_, v| v.nil? }
+
+        uri = @db_url.clone
+        uri.path = Pathname.new(uri.path).join(*paths.map(&:to_s)).to_s
+        uri.query = query.map { |pair| pair.join('=') unless pair.last.nil? }.compact.join('&')
+
+        data = JSON.dump(data) unless data.is_a?(String)
+        response = db.request(klass.new(uri), data)
+
+        JSON.parse(response.body)
+      end
+
+      def update(type, id, object)
+        request(Net::HTTP::Put, [type, id], object)
+      end
+
+      def db
+        Net::HTTP.new(@db_url.host, @db_url.port)
+      end
+    end
+  end
+end

data/lib/mediawiki_selenium/raita/null_io.rb

@@ -0,0 +1,8 @@
+module MediawikiSelenium
+  module Raita
+    class NullIO
+      def write(*)
+      end
+    end
+  end
+end

data/lib/mediawiki_selenium/support/hooks.rb

@@ -7,6 +7,16 @@ AfterConfiguration do |config|
   pretty_format, io = config.formats.find { |(format, _io)| format == 'pretty' }
   config.formats << ['MediawikiSelenium::WarningsFormatter', io] if pretty_format
 
+  # Set up Raita logging if RAITA_DB_URL is set. Include any useful
+  # environment variables that Jenkins would have set.
+  env = MediawikiSelenium::Environment.load_default
+  raita_url = env.lookup(:raita_url, default: nil)
+
+  if raita_url
+    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'
@@ -73,6 +83,12 @@ After do |scenario|
     require 'fileutils'
 
     teardown(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')
+      end
+
+      # Take screenshots
       if scenario.failed? && lookup(:screenshot_failures, default: false) == 'true'
         screen_dir = lookup(:screenshot_failures_path, default: 'screenshots')
         FileUtils.mkdir_p screen_dir

data/lib/mediawiki_selenium/version.rb

@@ -1,3 +1,3 @@
 module MediawikiSelenium
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mediawiki_selenium
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Chris McMahon
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-06 00:00:00.000000000 Z
+date: 2015-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -340,6 +340,10 @@ files:
 - lib/mediawiki_selenium/environment.rb
 - lib/mediawiki_selenium/initializer.rb
 - lib/mediawiki_selenium/page_factory.rb
+- lib/mediawiki_selenium/raita.rb
+- lib/mediawiki_selenium/raita/formatter.rb
+- lib/mediawiki_selenium/raita/logger.rb
+- lib/mediawiki_selenium/raita/null_io.rb
 - lib/mediawiki_selenium/remote_browser_factory.rb
 - lib/mediawiki_selenium/step_definitions.rb
 - lib/mediawiki_selenium/step_definitions/login_steps.rb