Get Chrome working with SauceLabs

Author: Brandon Duffany

codebender_testing/capabilities.yaml

@@ -0,0 +1,11 @@
+# This file contains a list of capabilities which will be used to instantiate
+# the remote selenium webdrivers.
+# Each list entry will cause the entire test suite to be run for a remote
+# webdriver with the capabilities specified in the entry.
+
+# See here for more on test configuration:
+#   https://docs.saucelabs.com/reference/test-configuration
+
+- browserName: "firefox"
+- browserName: "chrome"
+  version: 41

codebender_testing/config.py

@@ -1,7 +1,10 @@
 import os
 
 from selenium import webdriver
+from selenium.webdriver import chrome
 from selenium.webdriver.common.desired_capabilities import DesiredCapabilities
+import yaml
+
 
 def _rel_path(*args):
     """Forms a path relative to this file's directory."""
@@ -33,6 +36,14 @@ def _rel_path(*args):
 
 _EXTENSIONS_DIR = _rel_path('..', 'extensions')
 _FIREFOX_EXTENSION_FNAME = 'codebender.xpi'
+_CHROME_EXTENSION_FNAME = 'codebendercc-extension.crx'
+
+# Maximum version number that we can use the Chrome extension with.
+# For versions higher than this, we need to use the newer Codebender app
+CHROME_EXT_MAX_CHROME_VERSION = 41
+
+# Path to YAML file specifying capability list
+DEFAULT_CAPABILITIES_FILE_PATH = _rel_path('capabilities.yaml')
 
 # Files used for testing
 TEST_DATA_DIR = _rel_path('..', 'test_data')
@@ -55,22 +66,19 @@ def _get_firefox_profile():
     )
     return firefox_profile
 
-
-def _get_chrome_profile():
-    # TODO
-    return None
-
-
-def get_browsers(config_path=None):
+def get_browsers(capabilities_file_path=None):
     """Returns a list of capabilities. Each item in the list will cause
     the entire suite of tests to be re-run for a browser with those
-    particular capabilities."""
-    # TODO: read from browsers.yaml, and allow specifying custom config file.
-    return [
-        {
-            "browserName": "firefox", # OK with other defaults for now.
-        }
-    ]
+    particular capabilities.
+
+    `capabilities_file_path` is a path to a YAML file specifying a list of
+    capabilities for each browser. "Capabilities" are the dictionaries
+    passed as the `desired_capabilities` argument to the webdriver constructor.
+    """
+    if capabilities_file_path is None:
+        capabilities_file_path = DEFAULT_CAPABILITIES_FILE_PATH
+    stream = file(capabilities_file_path, 'rb')
+    return yaml.load(stream)
 
 
 def create_webdriver(command_executor, desired_capabilities):
@@ -86,10 +94,30 @@ def create_webdriver(command_executor, desired_capabilities):
     # Fill in defaults from DesiredCapabilities.{CHROME,FIREFOX} if they are
     # missing from the desired_capabilities dict above.
     _capabilities = desired_capabilities
+    browser_profile = None
+
     if browser_name == "chrome":
         desired_capabilities = DesiredCapabilities.CHROME.copy()
         desired_capabilities.update(_capabilities)
-        browser_profile = _get_chrome_profile()
+
+        # NOTE: the following logic is disabled since the remote webdriver is
+        # not properly installing the codebender extension. It is kept for
+        # reference until we can figure out how to properly add the Chrome
+        # extension.
+
+        # # Add chrome extension to capabilities
+        # options = chrome.options.Options()
+        # options.add_extension(os.path.join(_EXTENSIONS_DIR, _CHROME_EXTENSION_FNAME))
+        # desired_capabilities.update(options.to_capabilities())
+        # # Right now we only support up to v41 for this testing suite.
+        # if "version" in desired_capabilities:
+        #     if desired_capabilities["version"] > CHROME_EXT_MAX_CHROME_VERSION:
+        #         raise ValueError("The testing suite only supports Chrome versions up to v%d, "
+        #                          "but v%d was specified. Please specify a lower version "
+        #                          "number." % (CHROME_EXT_MAX_CHROME_VERSION, desired_capabilities["version"]))
+        # else:
+        #     desired_capabilities["version"] = CHROME_EXT_MAX_CHROME_VERSION
+
     elif browser_name == "firefox":
         desired_capabilities = DesiredCapabilities.FIREFOX.copy()
         desired_capabilities.update(_capabilities)

codebender_testing/utils.py

@@ -239,6 +239,8 @@ def delete_project(self, project_name):
         """Deletes the project specified by `project_name`. Note that this will
         navigate to the user's homepage."""
         self.open('/')
+        # Scroll to the bottom so that the footer doesn't obscure anything
+        self.execute_script("window.scrollTo(0, document.body.scrollHeight);")
         created_project = self.get_element(By.LINK_TEXT, project_name)
         delete_button_li = created_project.find_element_by_xpath('..')
         delete_button = delete_button_li.find_element_by_css_selector('button:last-child')

requirements.txt

@@ -1,3 +1,4 @@
 flake8
 pytest==2.6.4
+pyyaml
 selenium==2.44.0

tests/conftest.py

@@ -17,27 +17,43 @@
 def pytest_addoption(parser):
     """Adds command line options to the testing suite."""
 
-    parser.addoption("--url", action="store", default=config.BASE_URL,
+    parser.addoption("-U", "--url", action="store", default=config.BASE_URL,
                      help="URL to use for testing, e.g. http://localhost, http://codebender.cc")
 
-    parser.addoption("--full", action="store_true", default=False,
-                     help="Run the complete set of compile tests (a minimal set of tests is run by default).")
+    parser.addoption("-F", "--full", action="store_true", default=False,
+                     help="Run the complete set of compile tests "
+                          "(a minimal set of tests is run by default).")
 
-    parser.addoption("--source", action="store", default=config.SOURCE_BACHELOR,
+    parser.addoption("-S", "--source", action="store", default=config.SOURCE_BACHELOR,
                      help="Indicate the source used to generate the repo. "
-                          "By default, we assume `bachelor`.")
+                          "By default, we assume `bachelor`. "
+                          "You can instead use `codebender_cc` for the live site.")
 
+    parser.addoption("-C", "--capabilities", action="store",
+                     default=config.DEFAULT_CAPABILITIES_FILE_PATH,
+                     help="Custom path to a YAML file containing a capability list.")
 
-@pytest.fixture(scope="session", params=config.get_browsers())
-def webdriver(request):
+
+def pytest_generate_tests(metafunc):
+    """Special function used by pytest to configure test generation."""
+
+    # Paremetrize the desired_capabilities fixture on each of the capabilities
+    # objects in the YAML file.
+    if 'desired_capabilities' in metafunc.fixturenames:
+        capabilities_path = metafunc.config.option.capabilities
+        metafunc.parametrize('desired_capabilities',
+                             config.get_browsers(capabilities_path),
+                             scope="session")
+
+
+@pytest.fixture(scope="session")
+def webdriver(request, desired_capabilities):
     """Returns a webdriver that persists across the entire test session,
     and registers a finalizer to close the browser once the session is
     complete. The entire test session is repeated once per driver.
     """
 
-    # TODO: maybe have a different way of specifying this (?)
     command_executor = os.environ['CODEBENDER_SELENIUM_HUB_URL']
-    desired_capabilities = request.param
 
     driver = config.create_webdriver(command_executor, desired_capabilities)
 
@@ -113,7 +129,7 @@ def test_some_feature():
 @pytest.fixture(autouse=True)
 def requires_url(request, testing_url):
     """Skips tests that require a certain site URL in order to run properly.
-    This is strictly more specific than skip_by_source; consider using that
+    This is strictly more specific than requires_source; consider using that
     marker instead.
 
     This functionality should be invoked as a pytest marker, e.g.:
@@ -128,3 +144,26 @@ def test_some_feature():
         required_url = request.node.get_marker('requires_url').args[0]
         if required_url.rstrip('/') != testing_url.rstrip('/'):
             pytest.skip('skipped test that requires --url=%s' % required_url)
+
+
+@pytest.fixture(autouse=True)
+def requires_extension(request, webdriver):
+    """Mark that a test requires the codebender extension.
+    Ideally, this marker would not be necessary. However, it is used so that we
+    skip tests when running under chrome that require the extension (for now).
+    This is due to the fact that the chrome driver leaves open the
+    "confirm extension" dialogue without actually installing it.
+
+     This functionality should be invoked as a pytest marker, e.g.:
+
+    ```
+    @pytest.mark.requires_extension
+    def test_some_feature():
+        ...
+    ```
+    """
+    if request.node.get_marker('requires_extension'):
+        if webdriver.desired_capabilities["browserName"] == "chrome":
+            pytest.skip("skipped test that requires codebender extension. "
+                        "The current webdriver is Chrome, and the ChromeDriver "
+                        "does not properly install extensions.")

tests/sketch/test_sketch.py

@@ -50,10 +50,12 @@ def test_boards_dropdown(self):
 
         assert boards_dropdown.first_selected_option.text == TEST_BOARD
 
+    @pytest.mark.requires_extension
     def test_ports_dropdown(self):
         """Tests that the ports dropdown exists."""
         self.get_element(By.ID, "ports")
 
+    @pytest.mark.requires_extension
     def test_run_with_no_port(self):
         """Makes sure that there is an error when we attempt to run with no
         port selected."""
@@ -63,10 +65,12 @@ def test_run_with_no_port(self):
             expected_conditions.text_to_be_present_in_element(
                 (By.ID, "operation_output"), "Please select a valid port or enable the plugin!!"))
 
+    @pytest.mark.requires_extension
     def test_speeds_dropdown(self):
         """Tests that the speeds dropdown exists."""
         self.get_element(By.ID, "baudrates")
 
+    @pytest.mark.requires_extension
     def test_serial_monitor_disables_fields(self):
         """Tests that opening the serial monitor disables the port and baudrate
         fields."""