Michael Mintz

Posted on Sep 3, 2020 • Edited on Oct 7, 2020

Bringing new life into Edge Selenium Tools

#edge #selenium #python

This year, Microsoft Edge is officially reborn (in Chromium form) with tools to automate it, such as: https://github.com/microsoft/edge-selenium-tools -> "An updated EdgeDriver implementation for Selenium 3". This includes three separate libraries with implementations for C#, JavaScript, and Python. The upcoming Selenium 4 will include these libraries automatically, with the latest stable version of Selenium being 3.141 right now.

After spending some quality time using the new Edge and running automated browser tests on it with the Python edge-selenium-tools, I can safely say that Edge can be used as a drop-in replacement for Chrome as needed for automated testing, with some small differences such as handling browser extensions. I'm also the creator of a test framework called SeleniumBase, which uses edge-selenium-tools and simplifies Edge automation by wrapping a complete framework around the APIs to enhance the automation experience.

(Above: GitHub -> SeleniumBase/examples/edge_test.py, which highlights key areas on the Edge "About" page.)

In order to make Edge automation work, you'll need EdgeDriver, which is normally obtained by going to https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/ and then downloading the version you need. Thankfully, SeleniumBase lets you install the latest stable version of EdgeDriver in seconds by running a simple command:

$ seleniumbase install edgedriver

*** edgedriver version for download = 85.0.564.44

Downloading edgedriver_mac64.zip from:
https://msedgedriver.azureedge.net/85.0.564.44/edgedriver_mac64.zip ...
Download Complete!

Extracting ['msedgedriver'] from edgedriver_mac64.zip ...
Unzip Complete!

The file [msedgedriver] was saved to:
/Users/michael/github/SeleniumBase/seleniumbase/drivers/msedgedriver

Making [msedgedriver 85.0.564.44] executable ...
[msedgedriver] is now ready for use!

Also convenient is the ability to set Edge options from the command line when running tests with SeleniumBase. For example, you can activate the built-in mobile-device emulator by simply running a test with --mobile:

(Above: GitHub -> SeleniumBase/examples/test_skype_site.py, which highlights key areas on Skype's mobile website.)

Including Edge as part of your test automation suite is more important than ever, especially since the marketshare of Edge is rapidly growing. If you're already using SeleniumBase, running a test with Edge is as easy as adding --browser=edge to your run command. This is one of the many ways that SeleniumBase expands on pytest command-line options. (For reference, pytest is a unit-testing framework that can run SeleniumBase scripts.)

In summary, the new Edge browser is ready for your automated tests, and SeleniumBase paired with edge-selenium-tools can help you get started quickly. Visit the GitHub page at https://github.com/seleniumbase/SeleniumBase to learn more. There are many example tests to guide you in the right direction, and those can be run with --browser=edge to use Edge instead of the default browser.

Special thanks to John Jansen (https://twitter.com/thejohnjansen) for answering my Edge automation questions on Twitter. And thank you to Mat Velloso (https://twitter.com/matvelloso) for the nice shout-out there.

(Above: Tweets to me by John Jansen and Mat Velloso)

About me: I'm Michael Mintz, currently the DevOps/Automation Lead at iboss, (a Microsoft "Trusted Security Partner"). In my spare time, I expand and maintain SeleniumBase (https://github.com/seleniumbase/SeleniumBase - https://seleniumbase.io/). Normally you'll find me around Boston, but I've been working from home for most of 2020. You can find me on Twitter: https://twitter.com/seleniumbase (and yes, I use that account far more frequently than my personal one).

(That's me on the right with the glasses and the hoodie.)

Top comments (13)

sreidhark • Nov 21 '20

Hi Mr Mintz,
I am really surprised by the kind of work you put in seleniumbase.

Just started using this , but is there a way to use this in Behave(BDD) as the step functions don't work with classes and I don't see a way to use BaseCase from a normal function.
Appreciate your help.

Thanks
Sri

Michael Mintz • Nov 21 '20

Hi Sri,
Thank you. There's a special format for using SeleniumBase without BaseCase. This is done by using SeleniumBase as a pytest fixture. Here's an example of that:
github.com/seleniumbase/SeleniumBa...
This format may be needed when using other pytest fixtures in your tests.

# "sb" pytest fixture test in a method with no class
def test_sb_fixture_with_no_class(sb):
    sb.open("https://google.com/ncr")
    sb.type('input[title="Search"]', 'SeleniumBase\n')
    sb.click('a[href*="github.com/seleniumbase/SeleniumBase"]')
    sb.click('a[title="seleniumbase"]')


# "sb" pytest fixture test in a method inside a class
class Test_SB_Fixture():
    def test_sb_fixture_inside_class(self, sb):
        sb.open("https://google.com/ncr")
        sb.type('input[title="Search"]', 'SeleniumBase\n')
        sb.click('a[href*="github.com/seleniumbase/SeleniumBase"]')
        sb.click('a[title="examples"]')

sreidhark • Nov 23 '20

Thanks, Let me try and update you.

sreidhark • Nov 24 '20

Sorry for the trouble as I am completely new to behave.
what is "sb" ? Is it an object of some class that needs to eb instantiated in some fixture definition ?
Help appreciated.

Thanks
Sri

Michael Mintz • Nov 24 '20

You're probably looking for stackoverflow.com/a/41151454 , which explains pytest vs behave and has a link to pytest-bdd.

sb is the pytest fixture for SeleniumBase. Using SeleniumBase-as-a-fixture gives you the compatibility that you need to use pytest-bdd fixtures in your code at the same time, such as scenario, given, when, and then. Details on pytest-bdd can be found here: pypi.org/project/pytest-bdd/ . That is completely separate from SeleniumBase, but pytest does allow for the use of multiple fixtures at the same time.

sreidhark • Nov 24 '20

Thanks for the quick response. I will try.

sreidhark • Dec 3 '20

Hi,
Sorry for the long post, I am trying to run sb without pytest. I found this code below from your examples.

1) Are all these settings mandatory ?

2)I am trying to use Allure reports, but its seems sb.pytest_html_report = "sb_report.html" is not generating any report , nor even logs in sb.log_path = "latest_logs/"

3) Eventually I want to create an object of sb and call from behave test steps, some how fixtures thing above didnt work for me . I want to create a SeleniumBase object in environment file before a feature starts running and use the same in test steps.

I have tried writing my own framework, but somehow I keep coming back to your work as I know I cant produce such a comprehensive and stable work ( Kudos!)

Thanks
Sri

Code:

from seleniumbase import BaseCase

class MyTestClass(BaseCase):

def test_basic(self):
    self.open("https://store.xkcd.com/search")
    self.type('input[name="q"]', "xkcd book")
    self.click('input[value="Search"]')
    self.assert_text("xkcd: volume 0", "h3")
    self.open("https://xkcd.com/353/")
    self.assert_title("xkcd: Python")
    self.assert_element('img[alt="Python"]')
    self.click('a[rel="license"]')
    self.assert_text("free to copy and reuse")
    self.go_back()
    self.click_link_text("About")
    self.assert_exact_text("xkcd.com", "h2")
    self.click_link_text("geohashing")
    self.assert_element("#comic img")

if name == "main":
sb = MyTestClass("test_basic")
sb.browser = "chrome"
sb.headless = False
sb.headed = True
sb.start_page = None
sb.locale_code = None
sb.servername = "localhost"
sb.port = 4444
sb.data = None
sb.environment = "test"
sb.user_agent = None
sb.incognito = False
sb.guest_mode = False
sb.devtools = False
sb.mobile_emulator = False
sb.device_metrics = None
sb.extension_zip = None
sb.extension_dir = None
sb.database_env = "test"
sb.log_path = "latest_logs/"
sb.archive_logs = False
sb.disable_csp = False
sb.disable_ws = False
sb.enable_ws = False
sb.enable_sync = False
sb.use_auto_ext = False
sb.no_sandbox = False
sb.disable_gpu = False
sb._reuse_session = False
sb._crumbs = False
sb.visual_baseline = False
sb.maximize_option = False
sb.save_screenshot_after_test = False
sb.timeout_multiplier = None
sb.report_on = True
sb.pytest_html_report = "sb_report.html"
sb.with_db_reporting = False
sb.with_s3_logging = False
sb.js_checking_on = False
sb.is_pytest = False
sb.slow_mode = False
sb.demo_mode = False
sb.time_limit = None
sb.demo_sleep = 1
sb.message_duration = 2
sb.block_images = False
sb.settings_file = None
sb.user_data_dir = None
sb.proxy_string = None
sb.swiftshader = False
sb.ad_block_on = False
sb.highlights = None
sb.check_js = False
sb.cap_file = None
sb.cap_string = None

sb.setUp()
try:
    sb.test_basic()
finally:
    sb.tearDown()
    del sb

Michael Mintz • Dec 5 '20

Hi,
1) When using a hack like github.com/seleniumbase/SeleniumBa... to avoid using pytest, the variables still need to be initialized because pytest is no longer initializing them.
2) To get a pytest html report, add --html=report.html from the pytest command line (not the test itself!). For the Allure report, use --alluredir=ALLURE_DIR on the command line.
3) When using other pytest fixtures, you need to use SeleniumBase as a fixture for compatibility. See: github.com/seleniumbase/SeleniumBa... for an example of the sb fixture.

sreidhark • Dec 5 '20

Hi
2) Sorry, forgot to mention. I need the report when NOT running from pytest. How do I pass these arguments when running from main?

Thanks
Sri

Michael Mintz • Dec 5 '20

Hi Sri, those reports are specific to pytest plugins: pytest-html and allure-pytest. You'll need to use pytest for those reports to be generated.

sreidhark • Dec 6 '20

Thanks

Pablo Calvo • Sep 3 '20

Hey man thanks for sharing. Huge fan of SeleniumBase here. I am happy to hear that Edge people is making an effort for those who have been in Selenium 3 for a while.

Keep the posts coming.

Michael Mintz • Sep 3 '20

Thank you for the kind words. I'll keep the posts coming. :)

View full discussion (13 comments)

DEV Community

Bringing new life into Edge Selenium Tools

Top comments (13)

Read next

Understanding the Factory and Factory Method Design Patterns

Supercharge Your Conversations: How to Build a Telegram Bot with OpenAI's GPT-4 (No-Code!)

Bridging Machine Learning with TensorFlow: From Python to JavaScript

Implementing Heap In Python