allow passing selenium options #537

odedniv · 2018-02-09T21:57:16Z

Chrome now allows headless capability, but teaspoon stood between my app and the ability to use it. Here's the fix, and this is how I use it in my spec/teaspoon_env.rb (I recommend adding it to the wiki):

Teaspoon.configure do |config|
  config.driver_options = {
    client_driver: :chrome,
    selenium_options: {
      options: Selenium::WebDriver::Chrome::Options.new(args: ['headless', 'disable-gpu'])
    }
  }
end

To my understanding PhantomJS ceased development because of overwhelming security issues, and the fact it can be replaced by Chrome's headless capability. I think it's time to replace it with Selenium as the default driver.

houndci-bot · 2018-02-09T21:57:24Z

lib/teaspoon/driver/selenium.rb

@@ -44,7 +44,8 @@ def driver_options
          client_driver: :firefox,
          timeout: Teaspoon.configuration.driver_timeout.to_i,
          interval: 0.01,
-          message: "Timed out"
+          message: "Timed out",
+          selenium_options: {},


Avoid comma after the last parameter of a method call.

houndci-bot · 2018-02-09T21:57:24Z

lib/teaspoon/driver/selenium.rb

@@ -44,7 +44,8 @@ def driver_options
          client_driver: :firefox,
          timeout: Teaspoon.configuration.driver_timeout.to_i,
          interval: 0.01,
-          message: "Timed out"
+          message: "Timed out",


Prefer single-quoted strings when you don't need string interpolation or special symbols.

houndci-bot · 2018-02-09T21:57:24Z

lib/teaspoon/driver/selenium.rb

@@ -23,7 +23,7 @@ def initialize(options = nil)
      end

      def run_specs(runner, url)
-        driver = ::Selenium::WebDriver.for(driver_options[:client_driver])
+        driver = ::Selenium::WebDriver.for(driver_options[:client_driver], **driver_options[:selenium_options].to_options)


Line is too long. [122/120]

jejacks0n · 2018-02-09T21:59:17Z

Agree with your points about phantom being deprecated. It's been on my list of things to get to -- I would accept a PR that effectively removes phantomjs and makes the chrome driver primary, otherwise I'd rather wait to pull this in to avoid two passes at trying to resolve this.

houndci-bot · 2018-02-09T22:13:52Z

spec/teaspoon/driver/selenium_spec.rb

+        client_driver: :firefox,
+        timeout: 180,
+        interval: 0.01,
+        message: "Timed out",


Prefer single-quoted strings when you don't need string interpolation or special symbols.

odedniv · 2018-02-09T22:14:17Z

Is the way I passed the options reasonable? If so I don't see why this PR cannot be merged regardless of changing the default.

I'm assuming you refer to the docs and the generator? Or do you want to remove support? That would be a hurtful breaking change (that may delay this little change unnecessarily)

If you'd lay out exactly what you want done (e.g. do you want to change the default to what I wrote above? do you want to add documentation in the wiki and the generator? etc) I'd be happy to push a PR (though I don't know where the wiki is or the generator).

bmulholland · 2018-03-05T19:00:08Z

@jejacks0n There's a few other PRs to do the same thing (#519, #530), perhaps there's enough demand to merge (one of) this change on its own?

josh08h · 2018-05-30T13:01:20Z

Is there any movement on this? I am looking at migrating off phantomjs onto headless chrome but obviously need this change in.

odedniv · 2018-05-30T13:07:50Z

@josh08h until the maintainer gets a chance to work on it, you can use the branch directly (I have ever since I opened this PR). In your Gemfile:

  gem 'teaspoon', github: 'odedniv/teaspoon', branch: 'selenium-options'

You can fork and use your own branch if you're intimidated by doing that.

The only problem I had with using Chrome is that console.log no longer appears in the terminal, I have to stop using headless mode and open the inspect element window to see them.

josh08h · 2018-05-30T17:25:14Z

Thanks for the heads up re console.log.

Your patch looks good to me - I'll most likely fork off your branch.

jejacks0n · 2018-05-30T17:27:32Z

If y’all can figure out why console log doesn’t work I’ll merge this.

odedniv · 2018-05-30T17:30:46Z

@jejacks0n I think it's still better than using a deprecated driver :) Also this PR doesn't break anything, it just allows additional driver options (whatever driver you happen to use)

pjmelling · 2018-08-20T17:02:36Z

@odedniv and @jejacks0n Thanks for the work on this! I would love to see this merged in. We are using headless FF in our CI environment for our ruby based feature specs. And I want to ditch PhantomJS and use headless FF for teaspoon, too. Is there something holding this back that I could help with? Thanks!

jejacks0n · 2018-08-20T17:29:12Z

@pjmelling would you be willing to sort out CI? IT's pretty hard to merge when CI is broken and I simply haven't had time to work on open source much in the past year or two.

pablobm · 2018-12-07T22:09:56Z

#552 fixes the build. Perhaps we can proceed to merge this? :-) /cc @odedniv @jejacks0n

jejacks0n · 2018-12-08T16:34:55Z

I’m mobile, anybody want to rebase and check things?

odedniv · 2018-12-09T09:22:54Z

Done, seem to work

odedniv · 2018-12-09T13:43:46Z

Oops, if anyone was using my PR branch (including me), your Gemfile.lock is now broken (fatal: Could not parse object 'f64781ee6097e18fb838bc4fd5725172e3a24d27').

Run bundle update --source teaspoon to fix

Teaspoon master has support for driver_options, but no new gem release has been cut for 2+ years (?). The merged PR including this support is here: jejacks0n/teaspoon#537 Monkey patching teaspoon locally to add chrome support until we change test frameworks.

Teaspoon: use chrome driver, via monkey patch Teaspoon master has support for driver_options, but no new gem release has been cut for 2+ years (?). The merged PR including this support is here: jejacks0n/teaspoon#537 Monkey patching teaspoon locally to add chrome support until we change test frameworks. Rubocop: clean up StringLiterals and SafeNavigation Teaspoon: set driver explicitly to :chrome Teaspoon: One more try to spin chrome here.

The changes to the CI configuration are needed because teaspoon_env is now[1] searched starting from Rails.root when Rails is available, which breaks our test suite because Rails.root is spec/dummy, while teaspoon_env.rb is in spec. The monkey-patch was removed because Teaspoon now supports passing options to Selenium[2]. [1]: jejacks0n/teaspoon@5b912da [2]: jejacks0n/teaspoon#537

houndci-bot reviewed Feb 9, 2018

View reviewed changes

odedniv force-pushed the selenium-options branch from b43880f to 76fabb2 Compare February 9, 2018 22:13

houndci-bot reviewed Feb 9, 2018

View reviewed changes

odedniv force-pushed the selenium-options branch 2 times, most recently from 7b9b862 to f64781e Compare February 9, 2018 22:21

odedniv force-pushed the selenium-options branch from f64781e to 14d5a18 Compare June 24, 2018 15:25

thehenster mentioned this pull request Oct 17, 2018

Allow passing selenium options #550

Closed

This was referenced Dec 7, 2018

Trying to fix the build + Selenium options #551

Closed

Fix the build #552

Merged

allow passing selenium options

d2e82d9

odedniv force-pushed the selenium-options branch from 14d5a18 to d2e82d9 Compare December 9, 2018 08:35

jejacks0n merged commit 0fa9b8f into jejacks0n:master Dec 9, 2018

pablobm mentioned this pull request Dec 21, 2018

Version Update #494

Closed

trcarden mentioned this pull request Apr 7, 2019

Allow client options to be passed into Jasmine #519

Closed

jejacks0n pushed a commit that referenced this pull request May 9, 2019

allow passing selenium options (#537)

55d83ca

This was referenced Mar 11, 2021

Selenium Net::ReadTimeout #518

Closed

Jasmine client options #530

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

allow passing selenium options #537

allow passing selenium options #537

odedniv commented Feb 9, 2018

houndci-bot Feb 9, 2018

houndci-bot Feb 9, 2018

houndci-bot Feb 9, 2018

jejacks0n commented Feb 9, 2018

houndci-bot Feb 9, 2018

odedniv commented Feb 9, 2018

bmulholland commented Mar 5, 2018

josh08h commented May 30, 2018

odedniv commented May 30, 2018

josh08h commented May 30, 2018

jejacks0n commented May 30, 2018

odedniv commented May 30, 2018

pjmelling commented Aug 20, 2018

jejacks0n commented Aug 20, 2018

pablobm commented Dec 7, 2018

jejacks0n commented Dec 8, 2018

odedniv commented Dec 9, 2018

odedniv commented Dec 9, 2018

allow passing selenium options #537

allow passing selenium options #537

Conversation

odedniv commented Feb 9, 2018

houndci-bot Feb 9, 2018

Choose a reason for hiding this comment

houndci-bot Feb 9, 2018

Choose a reason for hiding this comment

houndci-bot Feb 9, 2018

Choose a reason for hiding this comment

jejacks0n commented Feb 9, 2018

houndci-bot Feb 9, 2018

Choose a reason for hiding this comment

odedniv commented Feb 9, 2018

bmulholland commented Mar 5, 2018

josh08h commented May 30, 2018

odedniv commented May 30, 2018

josh08h commented May 30, 2018

jejacks0n commented May 30, 2018

odedniv commented May 30, 2018

pjmelling commented Aug 20, 2018

jejacks0n commented Aug 20, 2018

pablobm commented Dec 7, 2018

jejacks0n commented Dec 8, 2018

odedniv commented Dec 9, 2018

odedniv commented Dec 9, 2018