Skip to main content

Using ChromeOptions for Capybara: Disable Images and More

Image
By

Chromedriver lets us set preferences via capabilities when it is initiated by Webdriver. These preferences can be used for specific purposes for example disabling images can reduce network needs and fasten the test runs; and disabling popups can make your cases more stable by reducing non-deterministic cases. In this post I want to explain how to use these feature of Chromedriver for Capybara with Ruby, you can also apply the same method for other languages with their bindings.

Sometimes bandwidth is crucial if you have parallel pipelines for test runs. Think that you have 10 parallel pipes and very pipeline consume bandwidth to complete its tasks, the most heavy part of website generally images. If we disable the images we can fasten the overall test runs. To disable the images you should set the images option to 2 in preferences. For Capybara you can disable the images by following Chrome instance:
Capybara.register_driver :chrome_no_image do |app|
preferences = {
"profile.managed_default_content_settings.images" => 2,
}
caps = Selenium::WebDriver::Remote::Capabilities.chrome(
'chromeOptions' => {
'prefs' => preferences
}
)
Capybara::Selenium::Driver.new(app, {:browser => :chrome, :desired_capabilities => caps})
end
view raw capybara_chrome_disable_images.rb hosted with ❤ by GitHub

Sometimes you need to disable popups which intermittently occurs and make your cases flacky. These kind of popups generally controls by another team of the company such instant campaign popups by CRM teams, and etc. To disable the popups, you should set the popups option to 2 in preferences. For Capybara you can disable the popups by following Chrome instance:
Capybara.register_driver :chrome_no_image_popup_maximize do |app|
preferences = {
"profile.default_content_settings.popups" => 2
}
caps = Selenium::WebDriver::Remote::Capabilities.chrome(
'chromeOptions' => {
'prefs' => preferences
}
)
Capybara::Selenium::Driver.new(app, {:browser => :chrome, :desired_capabilities => caps})
end
view raw capybara_chrome_disable_popups.rb hosted with ❤ by GitHub


Sometimes you need to make chrome fullscreen for UI related problems. You can set chrome instance as a full-screened view by passing the argument "--start-fullscreen" in args so it will open full page as default by the following Chrome instance. If you want to add more command line arguments you can add it separating by comma "--disable-infobars" this disables the information bars on the top of the page. See the example:
Capybara.register_driver :chrome_fullscreen_noinfobar do |app|
args = ["--start-fullscreen", "--disable-infobars" ]
Capybara::Selenium::Driver.new(app, {:browser => :chrome, :args => args})
end
view raw capybara_chrome_maximize.rb hosted with ❤ by GitHub

Sure we can use combination of these features together. The important point is that you need to know which features are under preferences and which features are arguments. For maximized windows, disabled images and popups check the following Chrome instance:
require 'capybara/dsl';
require 'capybara/poltergeist'
include Capybara::DSL;
require 'selenium-webdriver'
Capybara.register_driver :chrome_no_image_popup_maximize do |app|
# 2: disable, other than 2 means enable it
preferences = {
"profile.managed_default_content_settings.images" => 2,
"profile.managed_default_content_settings.popups" => 2
}
caps = Selenium::WebDriver::Remote::Capabilities.chrome(
'chromeOptions' => {
'prefs' => preferences,
}
)
args = [ "--start-maximized" ]
Capybara::Selenium::Driver.new(app, {:browser => :chrome, :desired_capabilities => caps, :args => args})
end
Capybara.default_driver = :chrome_no_image_popup_maximize
Capybara.javascript_driver = :chrome_no_image_popup_maximize
view raw capybara_chrome_disable_images_popups_maximize.rb hosted with ❤ by GitHub
To check whole list of args click this link and the whole list of preferences check this link or see the list of preferences below:
// Preferences that are exclusively used to store managed values for default
// content settings.
const char kManagedDefaultCookiesSetting[] =
"profile.managed_default_content_settings.cookies";
const char kManagedDefaultImagesSetting[] =
"profile.managed_default_content_settings.images";
const char kManagedDefaultJavaScriptSetting[] =
"profile.managed_default_content_settings.javascript";
const char kManagedDefaultPluginsSetting[] =
"profile.managed_default_content_settings.plugins";
const char kManagedDefaultPopupsSetting[] =
"profile.managed_default_content_settings.popups";
const char kManagedDefaultGeolocationSetting[] =
"profile.managed_default_content_settings.geolocation";
const char kManagedDefaultNotificationsSetting[] =
"profile.managed_default_content_settings.notifications";
const char kManagedDefaultMediaStreamSetting[] =
"profile.managed_default_content_settings.media_stream";
// Preferences that are exclusively used to store managed
// content settings patterns.
const char kManagedCookiesAllowedForUrls[] =
"profile.managed_cookies_allowed_for_urls";
const char kManagedCookiesBlockedForUrls[] =
"profile.managed_cookies_blocked_for_urls";
const char kManagedCookiesSessionOnlyForUrls[] =
"profile.managed_cookies_sessiononly_for_urls";
const char kManagedImagesAllowedForUrls[] =
"profile.managed_images_allowed_for_urls";
const char kManagedImagesBlockedForUrls[] =
"profile.managed_images_blocked_for_urls";
const char kManagedJavaScriptAllowedForUrls[] =
"profile.managed_javascript_allowed_for_urls";
const char kManagedJavaScriptBlockedForUrls[] =
"profile.managed_javascript_blocked_for_urls";
const char kManagedPluginsAllowedForUrls[] =
"profile.managed_plugins_allowed_for_urls";
const char kManagedPluginsBlockedForUrls[] =
"profile.managed_plugins_blocked_for_urls";
const char kManagedPopupsAllowedForUrls[] =
"profile.managed_popups_allowed_for_urls";
const char kManagedPopupsBlockedForUrls[] =
"profile.managed_popups_blocked_for_urls";
const char kManagedNotificationsAllowedForUrls[] =
"profile.managed_notifications_allowed_for_urls";
const char kManagedNotificationsBlockedForUrls[] =
"profile.managed_notifications_blocked_for_urls";
const char kManagedAutoSelectCertificateForUrls[] =
"profile.managed_auto_select_certificate_for_urls";
view raw chrome_profile_preferences_capabilities.java hosted with ❤ by GitHub

Labels

Labels:Software testing

Popular posts for software testing and automation

Selenium Error "Element is not currently interactable and may not be manipulated"

By
Selenium webdriver can drive different browsers like as Firefox, Chrome or Internet Explorer. These browsers actually cover the majority of internet users, so testing these browsers possibly covers the 90% of the internet users. However, there is no guaranty that the same automation scripts can work without a failure on these three browsers. For this reason, automation code should be error-prone for the browsers you want to cover. The following error is caught when the test script run for Chrome and Internet Explorer, but surprisingly there is no error for the Firefox. Selenium gives an error like below: Traceback (most recent call last):   File "D:\workspace\sample_project\sample_run.py", line 10, in <module>     m.login()   File "D:\workspace\ sample_project \test_case_imps.py", line 335, in login     driver.find_element_by_id("id_username").clear()   File "C:\Python27\lib\site-packages\selenium-2.35.0-py2.7.egg\seleni...
Read more

Change Default Timeout and Wait Time of Capybara

By
One of the biggest challenge for automation is handling timeout problem. Most of the time, timeout is 60 seconds but it may sometimes not enough if you have badly designed asynchronous calls or the third party ajax calls. This makes handling timeout more complex. set large enough to tolerate network related problems. For Selenium based automation frameworks, like Capybara, default Webdriver timeout is set to Net::ReadTimeout (Net::ReadTimeout) Changing ReadTimeout If you have timeout problem for Capybara, it gives an error like above. This means that the page is not fully loaded in given timeout period. Even you can see that page is loaded correctly but webdriver wait until the Ajax calls finish. class BufferedIO #:nodoc: internal use only def initialize (io) @io = io @read_timeout = 60 @continue_timeout = nil @debug_output = nil @rbuf = '' end . . . . . def rbuf_fill beg...
Read more

Create an Alias for Interactive Console Work: Selenium and Capybara

By
If you are working on shell most of the time Aliases are very helpfull and time saving. For testing purposes you can use Alias for getting ready your test suites. In this post, I want to explain both running Selenium and Capybara on console and creating aliases for each.  This post is for Windows machines, if you are using Unix-like see   this post . Creating Scripts for Selenium and Capybara First of all, it is assumed that you have installed Selenium and Capybara correctly and they work on your machines. If you haven't installed, you can see my previous posts. I am using the Selenium with Python and the Capybara with Ruby. You can use several different language for Selenium but Capybara works only with Ruby.  Create scripts in a directory called scripts (in your home folder, like as  ~/scripts ) for your automation tool as following, save them as capybara.rb, sel.py :  Creating Aliases Depends on your favourite shell, you need to add the al...
Read more

Page-Object Pattern for Selenium Test Automation with Python

By
Page-object model is a pattern that you can apply it to develop efficient automation framework. With the page-model, it is possible to minimize maintenance cost. Basically page-object means that your every page is inherited from a base class which includes basic functionalities for every page. If you have some new functionalities that every page should have, you can simple add it to the base class. Base class is like the following: In this part we are creating pages which are inherited from base page. Every page has its own functionalities written as python functions. Some functions return to a new page, it means that these functions leave the current page and produce a new page. You should write as much as functions you need in the assertion part because this is the only part you can use the webdriver functions to interact with web pages . This part can be evaluate as providing data to assertion part.   The last part is related to...
Read more

Performance Testing on CI: Locust is running on Jenkins

By
For a successful Continuous Integration pipeline, there should be jobs for testing the performance of the application. It is necessary if the application is still performing well. Generally performance testing is thought as kinds of activities performed one step before going to live. In general approach it is true but don't forget to test your application's performance as soon as there is an testable software, such as an api end point, functions, and etc. For CI it is a good approach to testing performance after functional testing and just before the deployment of next stage. In this post, I want to share some info about Jenkins and Locust. In my previous post you can find some information about Locust and Jenkins. Jenkins operates the CI environment and Locust is a tool for performance testing. To run the Locust on Jenkins you need command line arguments which control the number of clients ,   hatch rate,  running locust without web interface and there s...
Read more