mediawiki_selenium 0.4.3 → 1.0.0.pre.1

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

@@ -1,3 +1,4 @@
+require "page-object"
 require "mediawiki_api"
 
 class APIPage

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

@@ -1,19 +1,9 @@
-=begin
-This file is subject to the license terms in the LICENSE file found in the
-mediawiki_selenium top-level directory and at
-https://git.wikimedia.org/blob/mediawiki%2Fselenium/HEAD/LICENSE. No part of
-mediawiki_selenium, including this file, may be copied, modified, propagated, or
-distributed except according to the terms contained in the LICENSE file.
-Copyright 2013 by the Mediawiki developers. See the CREDITS file in the
-mediawiki_selenium top-level directory and at
-https://git.wikimedia.org/blob/mediawiki%2Fselenium/HEAD/CREDITS.
-=end
+require "page-object"
 
 class LoginPage
   include PageObject
 
-  include URL
-  page_url URL.url("Special:UserLogin")
+  page_url "Special:UserLogin"
 
   div(:feedback, class: "errorbox")
   button(:login, id: "wpLoginAttempt")
@@ -30,6 +20,7 @@ class LoginPage
   def login_with(username, password, wait_for_logout_element = true)
     self.username_element.when_present.send_keys(username)
     self.password_element.when_present.send_keys(password)
+    login_element.fire_event("onfocus")
     login_element.when_present.click
     logout_element.when_present(10) if wait_for_logout_element
   end

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

@@ -1,17 +1,7 @@
-=begin
-This file is subject to the license terms in the LICENSE file found in the
-mediawiki_selenium top-level directory and at
-https://git.wikimedia.org/blob/mediawiki%2Fselenium/HEAD/LICENSE. No part of
-mediawiki_selenium, including this file, may be copied, modified, propagated, or
-distributed except according to the terms contained in the LICENSE file.
-Copyright 2013 by the Mediawiki developers. See the CREDITS file in the
-mediawiki_selenium top-level directory and at
-https://git.wikimedia.org/blob/mediawiki%2Fselenium/HEAD/CREDITS.
-=end
+require "page-object"
 
 class RandomPage
   include PageObject
 
-  include URL
-  page_url URL.url("Special:Random")
+  page_url "Special:Random"
 end

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

@@ -1,18 +1,9 @@
-=begin
-This file is subject to the license terms in the LICENSE file found in the
-mediawiki_selenium top-level directory and at
-https://git.wikimedia.org/blob/mediawiki%2Fselenium/HEAD/LICENSE. No part of
-mediawiki_selenium, including this file, may be copied, modified, propagated, or
-distributed except according to the terms contained in the LICENSE file.
-Copyright 2013 by the Mediawiki developers. See the CREDITS file in the
-mediawiki_selenium top-level directory and at
-https://git.wikimedia.org/blob/mediawiki%2Fselenium/HEAD/CREDITS.
-=end
+require "page-object"
 
 class ResetPreferencesPage
   include PageObject
-  include URL
-  page_url URL.url("Special:Preferences/reset")
+
+  page_url "Special:Preferences/reset"
 
   button(:submit, class: "mw-htmlform-submit")
 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.4.3"
+  VERSION = "1.0.0.pre.1"
 end

data/mediawiki_selenium.gemspec

@@ -14,6 +14,9 @@ makes it easy to update the shared code.}
   spec.homepage      = "https://gerrit.wikimedia.org/r/#/admin/projects/mediawiki/selenium"
   spec.license       = "GPL-2"
 
+  spec.bindir      = "bin"
+  spec.executables << 'mediawiki-selenium-init'
+
   spec.files         = `git ls-files`.split($/)
   spec.require_paths = ["lib"]
 
@@ -25,9 +28,12 @@ makes it easy to update the shared code.}
   spec.add_runtime_dependency "rest-client", "~> 1.6", ">= 1.6.7"
   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"
 
-  spec.add_development_dependency "redcarpet"
+  spec.add_development_dependency "bundler", "~> 1.6", ">= 1.6.3"
+  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.26", ">= 0.26.1"
   spec.add_development_dependency "rspec-core", "~> 2.14", ">= 2.14.4"
-  spec.add_development_dependency "rubocop", "~> 0.26.1"
-  spec.add_development_dependency "yard"
+  spec.add_development_dependency "rspec-mocks", "~> 2.14", ">= 2.14.4"
 end

data/spec/api_helper_spec.rb

@@ -0,0 +1,84 @@
+require "spec_helper"
+
+module MediawikiSelenium
+  describe ApiHelper do
+    let(:env) { Environment.new(config).extend(ApiHelper) }
+
+    let(:config) do
+      {
+        mediawiki_url: wiki_url,
+        mediawiki_url_b: alternative_wiki_url,
+        mediawiki_api_url: api_url,
+        mediawiki_api_url_b: alternative_api_url,
+        mediawiki_user: "mw user",
+        mediawiki_password: "mw password"
+      }
+    end
+
+    describe "#api" do
+      subject { env.api }
+
+      let(:wiki_url) { "http://an.example/wiki/" }
+      let(:api_url) { "http://an.example/api" }
+      let(:alternative_wiki_url) { "http://another.example/wiki/" }
+      let(:alternative_api_url) { "" }
+
+      let(:client) { double(MediawikiApi::Client) }
+
+      before do
+        expect(MediawikiApi::Client).to receive(:new).with(api_url).and_return(client)
+        expect(client).to receive(:log_in).with("mw user", "mw password")
+      end
+
+      context "called for the first time" do
+        it "returns a new client" do
+          expect(subject).to be(client)
+        end
+      end
+
+      context "called subsequently" do
+        before do
+          env.api
+        end
+
+        it "returns a cached client" do
+          expect(subject).to be(client)
+        end
+      end
+    end
+
+    describe "#on_wiki" do
+      let(:wiki_url) { "http://an.example/wiki/" }
+      let(:api_url) { "http://an.example/api" }
+      let(:alternative_wiki_url) { "http://another.example/wiki/" }
+
+      context "and the given alternative API URL is configured" do
+        let(:alternative_api_url) { "http://another.example/api" }
+
+        it "executes in the new environment using the alternative wiki and API URL" do
+          expect { |block| env.on_wiki(:b, &block) }.
+            to yield_with_args(alternative_wiki_url, alternative_api_url)
+
+          env.on_wiki(:b) do
+            expect(env[:mediawiki_url]).to eq(alternative_wiki_url)
+            expect(env[:mediawiki_api_url]).to eq(alternative_api_url)
+          end
+        end
+      end
+
+      context "and no explicit API URL is configured for the wiki" do
+        let(:alternative_api_url) { "" }
+
+        it "constructs one at /w/api.php relative to the wiki URL" do
+          expect { |block| env.on_wiki(:b, &block) }.
+            to yield_with_args(alternative_wiki_url, "http://another.example/w/api.php")
+
+          env.on_wiki(:b) do
+            expect(env[:mediawiki_url]).to eq(alternative_wiki_url)
+            expect(env[:mediawiki_api_url]).to eq("http://another.example/w/api.php")
+          end
+        end
+      end
+    end
+  end
+end

data/spec/browser_factory/base_spec.rb

@@ -0,0 +1,211 @@
+require "spec_helper"
+
+module MediawikiSelenium::BrowserFactory
+  describe Base do
+    let(:factory_class) { Class.new(Base) }
+    let(:factory) { factory_class.new(browser_name) }
+    let(:browser_name) { :lynx }
+
+    describe ".bind" do
+      subject { factory_class.bind(option_name, &block) }
+
+      let(:option_name) { :foo }
+      let(:block) { proc { } }
+
+      it "adds a new default binding for the given option" do
+        subject
+        expect(factory_class.default_bindings).to include(option_name)
+        expect(factory_class.default_bindings[option_name]).to include(block)
+      end
+
+      context "given no block" do
+        subject { factory_class.bind(option_name) }
+
+        it "raises an ArgumentError" do
+          expect { subject }.to raise_error(ArgumentError)
+        end
+      end
+    end
+
+    describe ".bindings" do
+      subject { factory_class.bindings }
+
+      before do
+        factory_class.bind(:foo) {}
+      end
+
+      it "includes the base class's default bindings" do
+        expect(subject).to include(Base.default_bindings)
+      end
+
+      it "includes its own bindings" do
+        expect(subject).to include(factory_class.default_bindings)
+      end
+    end
+
+    describe ".default_bindings" do
+      subject { factory_class.default_bindings }
+
+      it { is_expected.to be_a(Hash) }
+
+      context "before any bindings are defined" do
+        it { is_expected.to be_empty }
+      end
+
+      context "when bindings are defined" do
+        before do
+          factory_class.bind(:foo) {}
+          factory_class.bind(:bar) {}
+          factory_class.bind(:bar) {}
+        end
+
+        it "includes all defined bindings" do
+          expect(subject).to include(:foo, :bar)
+        end
+
+        it "includes all bindings for the same option name" do
+          expect(subject[:bar].length).to be(2)
+        end
+      end
+    end
+
+    describe "#bind" do
+      subject { factory.bind(option_name, &block) }
+      before { subject }
+
+      let(:option_name) { :foo }
+      let(:block) { proc { } }
+
+      it "adds a new binding for the given option" do
+        expect(factory.bindings).to include(option_name)
+        expect(factory.bindings[option_name]).to include(block)
+      end
+
+      context "given no block" do
+        subject { factory.bind(option_name) }
+
+        it "will default to an empty block" do
+          expect(factory.bindings[option_name]).not_to include(nil)
+        end
+      end
+    end
+
+    describe "#bindings" do
+      subject { factory.bindings }
+
+      before do
+        factory_class.bind(:foo) {}
+        factory.bind(:bar)
+      end
+
+      it "includes the class-level bindings" do
+        expect(subject).to include(factory_class.bindings)
+      end
+
+      it "includes its own bindings" do
+        expect(subject).to include(:bar)
+      end
+    end
+
+    describe "#browser_for" do
+      subject { factory.browser_for(config) }
+
+      let(:config) { { foo: "x" } }
+
+      let(:watir_browser) { double(Watir::Browser) }
+      let(:capabilities) { double(Selenium::WebDriver::Remote::Capabilities) }
+
+      before do
+        expect(Selenium::WebDriver::Remote::Capabilities).to receive(browser_name).
+          at_least(:once).and_return(capabilities)
+        expect(capabilities).to receive(:browser_name).
+          at_least(:once).and_return(browser_name)
+      end
+
+      it "creates a new Watir::Browser" do
+        expect(Watir::Browser).to receive(:new).once.and_return(watir_browser)
+        expect(subject).to be(watir_browser)
+      end
+
+      context "called more than once" do
+        let(:config1) { config }
+
+        context "with the same configuration" do
+          let(:config2) { config }
+
+          it "returns a cached browser" do
+            expect(Watir::Browser).to receive(:new).once.and_return(watir_browser)
+            expect(factory.browser_for(config1)).to be(factory.browser_for(config2))
+          end
+        end
+
+        context "with different configuration" do
+          let(:config2) { { foo: "y" } }
+
+          it "returns two distinct browsers" do
+            expect(Watir::Browser).to receive(:new).twice
+
+            factory.browser_for(config1)
+            factory.browser_for(config2)
+          end
+        end
+      end
+    end
+
+    describe "#browser_options" do
+      subject { factory.browser_options(config) }
+
+      let(:config) { {} }
+
+      let(:capabilities) { double(Selenium::WebDriver::Remote::Capabilities) }
+      let(:client) { double(Selenium::WebDriver::Remote::Http::Default) }
+      let(:options) { { desired_capabilities: capabilities, http_client: client } }
+
+      before do
+        expect(Selenium::WebDriver::Remote::Capabilities).to receive(browser_name).
+          at_least(:once).and_return(capabilities)
+        expect(Selenium::WebDriver::Remote::Http::Default).to receive(:new).
+          and_return(client)
+      end
+
+      it { is_expected.to be_a(Hash) }
+      it { is_expected.to include(desired_capabilities: capabilities, http_client: client) }
+
+      context "with a binding" do
+        context "and corresponding configuration" do
+          let(:config) { { foo: "x" } }
+
+          it "invokes the binding with the configured value" do
+            expect { |block| factory.bind(:foo, &block) && subject }.to yield_with_args("x", options)
+          end
+        end
+
+        context "but no configuration" do
+          let(:config) { {} }
+
+          it "never invokes the binding" do
+            expect { |block| factory.bind(:foo, &block) && subject }.to_not yield_control
+          end
+        end
+      end
+
+      context "with a multi-option binding" do
+        context "and complete configuration for all options" do
+          let(:config) { { foo: "x", bar: "y" } }
+
+          it "invokes the binding with the configured values" do
+            expect { |block| factory.bind(:foo, :bar, &block) && subject }.to yield_with_args("x", "y", options)
+          end
+        end
+
+        context "but incomplete configuration for all options" do
+          let(:config) { { foo: "x" } }
+
+          it "never invokes the binding" do
+            expect { |block| factory.bind(:foo, :bar, &block) && subject }.to_not yield_control
+          end
+        end
+      end
+    end
+  end
+end

data/spec/browser_factory/chrome_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+module MediawikiSelenium::BrowserFactory
+  describe Chrome do
+    let(:factory_class) { Chrome }
+    let(:factory) { factory_class.new(:chrome) }
+
+    describe ".default_bindings" do
+      subject { factory_class.default_bindings }
+
+      it { is_expected.to include(:browser_language) }
+      it { is_expected.not_to include(:browser_timeout) }
+      it { is_expected.to include(:browser_user_agent) }
+    end
+
+    describe "#browser_options" do
+      subject { factory.browser_options(config) }
+
+      context "given a custom browser_language" do
+        let(:config) { { browser_language: "eo" } }
+
+        it "sets the intl.accept_languages preference to the given language" do
+          expect(subject[:prefs]).to include("intl.accept_languages" => "eo")
+        end
+      end
+
+      context "given a custom browser_user_agent" do
+        let(:config) { { browser_user_agent: "FooBot" } }
+
+        it "includes it as --user-agent in the chrome arguments" do
+          expect(subject[:args]).to include("--user-agent=FooBot")
+        end
+      end
+    end
+  end
+end

data/spec/browser_factory/firefox_spec.rb

@@ -0,0 +1,60 @@
+require "spec_helper"
+
+module MediawikiSelenium::BrowserFactory
+  describe Firefox do
+    let(:factory_class) { Firefox }
+    let(:factory) { factory_class.new(:firefox) }
+
+    describe ".default_bindings" do
+      subject { factory_class.default_bindings }
+
+      it { is_expected.to include(:browser_language) }
+      it { is_expected.to include(:browser_timeout) }
+      it { is_expected.to include(:browser_user_agent) }
+    end
+
+    describe "#browser_options" do
+      subject { factory.browser_options(config) }
+
+      let(:profile) { double(Selenium::WebDriver::Firefox::Profile) }
+
+      before do
+        expect(Selenium::WebDriver::Firefox::Profile).to receive(:new).and_return(profile)
+      end
+
+      context "given a custom browser_timeout" do
+        let(:config) { { browser_timeout: "30" } }
+
+        it "sets dom.max_script_run_time to the given number" do
+          expect(profile).to receive(:[]=).with("dom.max_script_run_time", 30)
+          allow(profile).to receive(:[]=)
+          subject
+        end
+
+        it "sets dom.max_chrome_script_run_time to the given number" do
+          expect(profile).to receive(:[]=).with("dom.max_chrome_script_run_time", 30)
+          allow(profile).to receive(:[]=)
+          subject
+        end
+      end
+
+      context "given a custom browser_language" do
+        let(:config) { { browser_language: "eo" } }
+
+        it "sets intl.accept_languages to the given language" do
+          expect(profile).to receive(:[]=).with("intl.accept_languages", "eo")
+          subject
+        end
+      end
+
+      context "given a custom browser_user_agent" do
+        let(:config) { { browser_user_agent: "FooBot" } }
+
+        it "sets general.useragent.override to the given string" do
+          expect(profile).to receive(:[]=).with("general.useragent.override", "FooBot")
+          subject
+        end
+      end
+    end
+  end
+end