[rb] deprecate browser class methods for Capabilities

This matches what Java did in 3.x to encourage people to move to the Options classes.

Author: titusfortner

rb/lib/selenium/webdriver/remote/capabilities.rb

@@ -83,38 +83,46 @@ def platform=(value)
 
         class << self
           def chrome(opts = {})
+            WebDriver.logger.deprecate('Remote::Capabilities.chrome', 'Options.chrome', id: :caps_browsers)
             new({
               browser_name: 'chrome'
             }.merge(opts))
           end
 
           def edge(opts = {})
+            WebDriver.logger.deprecate('Remote::Capabilities.edge', 'Options.edge', id: :caps_browsers)
             new({
               browser_name: 'MicrosoftEdge'
             }.merge(opts))
           end
           alias microsoftedge edge
 
           def firefox(opts = {})
+            WebDriver.logger.deprecate('Remote::Capabilities.firefox', 'Options.firefox', id: :caps_browsers)
             new({
               browser_name: 'firefox'
             }.merge(opts))
           end
           alias ff firefox
 
           def safari(opts = {})
+            WebDriver.logger.deprecate('Remote::Capabilities.safari', 'Options.safari', id: :caps_browsers)
             new({
               browser_name: Selenium::WebDriver::Safari.technology_preview? ? 'Safari Technology Preview' : 'safari'
             }.merge(opts))
           end
 
           def htmlunit(opts = {})
+            WebDriver.logger.deprecate('Remote::Capabilities.htmlunit',
+                                       'as argument in constructor',
+                                       id: :caps_browsers)
             new({
               browser_name: 'htmlunit'
             }.merge(opts))
           end
 
           def internet_explorer(opts = {})
+            WebDriver.logger.deprecate('Remote::Capabilities.ie', 'Options.ie', id: :caps_browsers)
             new({
               browser_name: 'internet explorer',
               platform_name: :windows

rb/spec/unit/selenium/webdriver/chrome/driver_spec.rb

@@ -27,7 +27,7 @@ module Chrome
         let(:service_manager) { instance_double(ServiceManager, uri: 'http://example.com') }
         let(:valid_response) do
           {status: 200,
-           body: {value: {sessionId: 0, capabilities: Remote::Capabilities.chrome}}.to_json,
+           body: {value: {sessionId: 0, capabilities: {browserName: 'chrome'}}}.to_json,
            headers: {content_type: 'application/json'}}
         end
 
@@ -64,7 +64,7 @@ def expect_request(body: nil, endpoint: nil)
           msg = "Don't use both :options and :capabilities when initializing Selenium::WebDriver::Chrome::Driver, " \
                 'prefer :options'
           expect {
-            described_class.new(options: Options.new, capabilities: Remote::Capabilities.chrome)
+            described_class.new(options: Options.new, capabilities: Remote::Capabilities.new(browser_name: 'chrome'))
           }.to raise_exception(ArgumentError, msg)
         end
 
@@ -74,15 +74,6 @@ def expect_request(body: nil, endpoint: nil)
             expect { described_class.new(capabilities: :chrome) }.to have_deprecated(:capabilities)
           end
 
-          it 'accepts Capabilities.chrome' do
-            expect_request(body: {capabilities: {alwaysMatch: {browserName: 'chrome', invalid: 'foobar'}}})
-
-            expect {
-              capabilities = Remote::Capabilities.chrome(invalid: 'foobar')
-              described_class.new(capabilities: capabilities)
-            }.to have_deprecated(:capabilities)
-          end
-
           it 'accepts constructed Capabilities with Snake Case as Symbols' do
             expect_request(body: {capabilities: {alwaysMatch: {browserName: 'chrome', invalid: 'foobar'}}})
 

rb/spec/unit/selenium/webdriver/edge/driver_spec.rb

@@ -27,7 +27,7 @@ module Edge
         let(:service_manager) { instance_double(ServiceManager, uri: 'http://example.com') }
         let(:valid_response) do
           {status: 200,
-           body: {value: {sessionId: 0, capabilities: Remote::Capabilities.edge}}.to_json,
+           body: {value: {sessionId: 0, capabilities: {browserName: 'MicrosoftEdge'}}}.to_json,
            headers: {content_type: 'application/json'}}
         end
 
@@ -69,7 +69,7 @@ def expect_request(body: nil, endpoint: nil)
           msg = "Don't use both :options and :capabilities when initializing Selenium::WebDriver::Edge::Driver, " \
                 'prefer :options'
           expect {
-            described_class.new(options: Options.new, capabilities: Remote::Capabilities.edge)
+            described_class.new(options: Options.new, capabilities: Remote::Capabilities.new(browser_name: 'msedge'))
           }.to raise_exception(ArgumentError, msg)
         end
 
@@ -83,13 +83,6 @@ def expect_request(body: nil, endpoint: nil)
             }.not_to raise_exception
           end
 
-          it 'accepts Capabilities.edge' do
-            capabilities = Remote::Capabilities.edge(invalid: 'foobar')
-            expect_request(body: {capabilities: {alwaysMatch: {browserName: 'MicrosoftEdge', invalid: 'foobar'}}})
-
-            expect { described_class.new(capabilities: capabilities) }.to have_deprecated(:capabilities)
-          end
-
           it 'accepts constructed Capabilities with Snake Case as Symbols' do
             capabilities = Remote::Capabilities.new(browser_name: 'MicrosoftEdge', invalid: 'foobar')
             expect_request(body: {capabilities: {alwaysMatch: {browserName: 'MicrosoftEdge', invalid: 'foobar'}}})

rb/spec/unit/selenium/webdriver/firefox/driver_spec.rb

@@ -27,7 +27,7 @@ module Firefox
         let(:service_manager) { instance_double(ServiceManager, uri: 'http://example.com') }
         let(:valid_response) do
           {status: 200,
-           body: {value: {sessionId: 0, capabilities: Remote::Capabilities.firefox}}.to_json,
+           body: {value: {sessionId: 0, capabilities: {browserName: 'firefox'}}}.to_json,
            headers: {content_type: 'application/json'}}
         end
 
@@ -69,7 +69,7 @@ def expect_request(body: nil, endpoint: nil)
           msg = "Don't use both :options and :capabilities when initializing Selenium::WebDriver::Firefox::Driver, " \
                 'prefer :options'
           expect {
-            described_class.new(options: Options.new, capabilities: Remote::Capabilities.firefox)
+            described_class.new(options: Options.new, capabilities: Remote::Capabilities.new(browser_name: 'firefox'))
           }.to raise_exception(ArgumentError, msg)
         end
 
@@ -79,13 +79,6 @@ def expect_request(body: nil, endpoint: nil)
             expect { described_class.new(capabilities: :firefox) }.to have_deprecated(:capabilities)
           end
 
-          it 'accepts Capabilities.firefox' do
-            capabilities = Remote::Capabilities.firefox(invalid: 'foobar')
-            expect_request(body: {capabilities: {alwaysMatch: {browserName: 'firefox', invalid: 'foobar'}}})
-
-            expect { described_class.new(capabilities: capabilities) }.to have_deprecated(:capabilities)
-          end
-
           it 'accepts constructed Capabilities with Snake Case as Symbols' do
             capabilities = Remote::Capabilities.new(browser_name: 'firefox', invalid: 'foobar')
             expect_request(body: {capabilities: {alwaysMatch: {browserName: 'firefox', invalid: 'foobar'}}})

rb/spec/unit/selenium/webdriver/ie/driver_spec.rb

@@ -27,7 +27,7 @@ module IE
         let(:service_manager) { instance_double(ServiceManager, uri: 'http://example.com') }
         let(:valid_response) do
           {status: 200,
-           body: {value: {sessionId: 0, capabilities: Remote::Capabilities.ie}}.to_json,
+           body: {value: {sessionId: 0, capabilities: {browserName: 'internet explorer'}}}.to_json,
            headers: {content_type: 'application/json'}}
         end
 
@@ -67,7 +67,8 @@ def expect_request(body: nil, endpoint: nil)
           msg = "Don't use both :options and :capabilities when initializing Selenium::WebDriver::IE::Driver, " \
                 'prefer :options'
           expect {
-            described_class.new(options: Options.new, capabilities: Remote::Capabilities.ie)
+            described_class.new(options: Options.new,
+                                capabilities: Remote::Capabilities.new(browser_name: 'internet explorer'))
           }.to raise_exception(ArgumentError, msg)
         end
 
@@ -77,15 +78,6 @@ def expect_request(body: nil, endpoint: nil)
             expect { described_class.new(capabilities: :ie) }.to have_deprecated(:capabilities)
           end
 
-          it 'accepts Capabilities.ie' do
-            capabilities = Remote::Capabilities.ie(invalid: 'foobar')
-            expect_request(body: {capabilities: {alwaysMatch: {browserName: 'internet explorer',
-                                                               platformName: 'windows',
-                                                               invalid: 'foobar'}}})
-
-            expect { described_class.new(capabilities: capabilities) }.to have_deprecated(:capabilities)
-          end
-
           it 'accepts constructed Capabilities with Snake Case as Symbols' do
             capabilities = Remote::Capabilities.new(browser_name: 'internet explorer', invalid: 'foobar')
             expect_request(body: {capabilities: {alwaysMatch: {browserName: 'internet explorer', invalid: 'foobar'}}})

rb/spec/unit/selenium/webdriver/remote/bridge_spec.rb

@@ -33,12 +33,11 @@ module Remote
           let(:http) { WebDriver::Remote::Http::Default.new }
           let(:bridge) { described_class.new(http_client: http, url: 'http://localhost') }
 
-          it 'sends plain capabilities' do
+          it 'accepts Hash' do
             payload = JSON.generate(
               capabilities: {
                 alwaysMatch: {
-                  browserName: 'internet explorer',
-                  platformName: 'windows'
+                  browserName: 'internet explorer'
                 }
               }
             )
@@ -47,27 +46,7 @@ module Remote
               .with(any_args, payload)
               .and_return('status' => 200, 'value' => {'sessionId' => 'foo', 'capabilities' => {}})
 
-            bridge.create_session(Capabilities.ie)
-            expect(http).to have_received(:request).with(any_args, payload)
-          end
-
-          it 'passes options as capabilities' do
-            payload = JSON.generate(
-              capabilities: {
-                alwaysMatch: {
-                  'browserName' => 'chrome',
-                  'goog:chromeOptions' => {
-                    args: %w[foo bar]
-                  }
-                }
-              }
-            )
-
-            allow(http).to receive(:request)
-              .with(any_args, payload)
-              .and_return('status' => 200, 'value' => {'sessionId' => 'foo', 'capabilities' => {}})
-
-            bridge.create_session(Options.chrome(args: %w[foo bar]).as_json)
+            bridge.create_session(browserName: 'internet explorer')
             expect(http).to have_received(:request).with(any_args, payload)
           end
 
@@ -84,7 +63,7 @@ module Remote
               .with(any_args, payload)
               .and_return('status' => 200, 'value' => {'sessionId' => 'foo', 'capabilities' => {}})
 
-            bridge.create_session(Capabilities.always_match(Capabilities.chrome).as_json)
+            bridge.create_session('alwaysMatch' => {'browserName' => 'chrome'})
             expect(http).to have_received(:request).with(any_args, payload)
           end
 
@@ -102,7 +81,10 @@ module Remote
               .with(any_args, payload)
               .and_return('status' => 200, 'value' => {'sessionId' => 'foo', 'capabilities' => {}})
 
-            bridge.create_session(Capabilities.first_match(Capabilities.chrome, Capabilities.firefox).as_json)
+            bridge.create_session('firstMatch' => [
+                                    {'browserName' => 'chrome'},
+                                    {'browserName' => 'firefox'}
+                                  ])
             expect(http).to have_received(:request).with(any_args, payload)
           end
 

rb/spec/unit/selenium/webdriver/remote/capabilities_spec.rb

@@ -24,28 +24,45 @@ module WebDriver
     module Remote
       describe Capabilities do
         it 'has default capabilities for Chrome' do
-          caps = described_class.chrome
-          expect(caps.browser_name).to eq('chrome')
+          expect {
+            caps = described_class.chrome
+            expect(caps.browser_name).to eq('chrome')
+          }.to have_deprecated(:caps_browsers)
         end
 
         it 'has default capabilities for Edge' do
-          caps = described_class.edge
-          expect(caps.browser_name).to eq('MicrosoftEdge')
+          expect {
+            caps = described_class.edge
+            expect(caps.browser_name).to eq('MicrosoftEdge')
+          }.to have_deprecated(:caps_browsers)
         end
 
         it 'has default capabilities for Firefox' do
-          caps = described_class.firefox
-          expect(caps.browser_name).to eq('firefox')
+          expect {
+            caps = described_class.firefox
+            expect(caps.browser_name).to eq('firefox')
+          }.to have_deprecated(:caps_browsers)
         end
 
         it 'has default capabilities for HtmlUnit' do
-          caps = described_class.htmlunit
-          expect(caps.browser_name).to eq('htmlunit')
+          expect {
+            caps = described_class.htmlunit
+            expect(caps.browser_name).to eq('htmlunit')
+          }.to have_deprecated(:caps_browsers)
         end
 
         it 'has default capabilities for Internet Explorer' do
-          caps = described_class.internet_explorer
-          expect(caps.browser_name).to eq('internet explorer')
+          expect {
+            caps = described_class.internet_explorer
+            expect(caps.browser_name).to eq('internet explorer')
+          }.to have_deprecated(:caps_browsers)
+        end
+
+        it 'has default capabilities for Safari' do
+          expect {
+            caps = described_class.safari
+            expect(caps.browser_name).to eq('safari')
+          }.to have_deprecated(:caps_browsers)
         end
 
         it 'converts noProxy from string to array' do
@@ -75,7 +92,7 @@ module Remote
         end
 
         it 'can set and get arbitrary capabilities' do
-          caps = described_class.chrome
+          caps = described_class.new(browser_name: 'chrome')
           caps['chrome'] = :foo
           expect(caps['chrome']).to eq(:foo)
         end
@@ -99,8 +116,8 @@ module Remote
         end
 
         it 'can merge capabilities' do
-          a = described_class.chrome
-          b = described_class.firefox
+          a = described_class.new(browser_name: 'chrome')
+          b = described_class.new(browser_name: 'firefox')
           a.merge!(b)
 
           expect(a.browser_name).to eq('firefox')
@@ -121,7 +138,7 @@ module Remote
           expected = {'alwaysMatch' => {'browserName' => 'chrome'}}
           expect(described_class.always_match(browser_name: 'chrome').as_json).to eq(expected)
           expect(described_class.always_match('browserName' => 'chrome').as_json).to eq(expected)
-          expect(described_class.always_match(described_class.chrome).as_json).to eq(expected)
+          expect(described_class.always_match(described_class.new(browser_name: 'chrome')).as_json).to eq(expected)
         end
 
         it 'allows to set firstMatch' do
@@ -130,7 +147,8 @@ module Remote
                                              {browser_name: 'firefox'}).as_json).to eq(expected)
           expect(described_class.first_match({'browserName' => 'chrome'},
                                              {'browserName' => 'firefox'}).as_json).to eq(expected)
-          expect(described_class.first_match(described_class.chrome, described_class.firefox).as_json).to eq(expected)
+          expect(described_class.first_match(described_class.new(browser_name: 'chrome'),
+                                             described_class.new(browser_name: 'firefox')).as_json).to eq(expected)
         end
 
         it 'sets browser version with version' do
@@ -178,7 +196,7 @@ module Remote
           end
 
           it 'processes timeouts as hash' do
-            caps = described_class.chrome(timeouts: {implicit: 1, page_load: 2, script: 3})
+            caps = described_class.new(browser_name: 'chrome', timeouts: {implicit: 1, page_load: 2, script: 3})
             expect(caps.timeouts).to eq(implicit: 1, page_load: 2, script: 3)
             expect(caps.implicit_timeout).to eq(1)
             expect(caps.page_load_timeout).to eq(2)
@@ -187,7 +205,7 @@ module Remote
           end
 
           it 'processes timeouts via timeouts reader' do
-            caps = described_class.chrome
+            caps = described_class.new(browser_name: 'chrome')
             caps.timeouts[:implicit] = 1
             caps.timeouts[:page_load] = 2
             caps.timeouts[:script] = 3
@@ -199,7 +217,7 @@ module Remote
           end
 
           it 'processes timeouts via per-timeout writers' do
-            caps = described_class.chrome
+            caps = described_class.new(browser_name: 'chrome')
             caps.implicit_timeout = 1
             caps.page_load_timeout = 2
             caps.script_timeout = 3