Merge remote-tracking branch 'origin/bduffany-docker-2' into development

Author: freskoulix

Dockerfile

@@ -0,0 +1,23 @@
+# Dockerfile to build container with Codebender selenium tests.
+
+FROM ubuntu:12.04
+# TODO: add MAINTAINER
+
+# Install requirements and their dependencies
+RUN apt-get update && apt-get install -y \
+  python \
+  python-setuptools
+
+RUN easy_install pip
+RUN pip install -U setuptools
+
+# Add source code and install dependencies
+RUN mkdir -p /opt/codebender
+ADD . /opt/codebender/seleniumTests
+WORKDIR /opt/codebender/seleniumTests
+RUN pip install -r requirements-dev.txt
+
+# Specify a default command for the container.
+# Right now we simply run bash. TODO: add ENTRYPOINT for running tests.
+WORKDIR /opt/codebender/seleniumTests
+CMD ["/bin/bash"]

README.md

@@ -1,41 +1,50 @@
 # Codebender Selenium Tests
 
 This repo contains Selenium tests for the codebender website.  The tests are
-written in Python 3, and utilize pytest as a testing framework and Selenium
+written in Python 2, and utilize pytest as a testing framework and Selenium
 for browser automation.
 
 ## Running Tests
 
-### Dependencies
+Tests are run by invoking `tox`. Run `tox --help` to see all the
+Codebender-specific arguments that can be passed to `py.test`.
 
-To run these tests, you'll need to have Python 3 installed. In addition, it is
-advantageous to have pip, a package manager for Python, in order to install
-dependencies.
+In addition to these arguments, there are certain environment variables that
+should be set when running tests:
 
-Notably, the pip2 (for Python 2) and pip3 (for Python 3) packages both attempt
-to link `/usr/local/bin/pip` to the `pip2` or `pip3` executable, respectively.
-To deal with this, you could explicitly type out `pip3` or `pip2` instead of
-`pip` whenever you use pip via the command line. (It may be best to just remove
-`/usr/local/bin/pip` entirely).
+- `CODEBENDER_SELENIUM_HUB_URL`: the URL of the Selenium Hub. If you are using
+  SauceLabs, the URL has the following format:
+  `http://{USERNAME}:{ACCESS_KEY}@ondemand.saucelabs.com:80/wd/hub`. You can
+  also use a [docker-selenium](https://github.com/SeleniumHQ/docker-selenium)
+  hub. In that case, it is necessary to link the docker-selenium instance to the
+  Docker instance from which tests are running.
+- `CODEBENDER_TEST_USER`: username that the webdriver will use to log into the
+  site in order to perform tests.
+- `CODEBENDER_TEST_PASS`: password for `CODEBENDER_TEST_USER`.
 
-To install `pip` in Ubuntu, run `$ sudo apt-get install python3
-python3-setuptools`, then `$ sudo easy_install3 pip`.
+Rather than invoking `tox` directly, the easiest way to run tests is with
+Docker. If you are not familiar with Docker, please consult the
+[documentation](http://docs.docker.com/) for an introduction.
 
-After getting set up with pip and cloning the seleniumTests repo, you should
-make sure to install all the seleniumTests dependencies by `cd`ing to your local
-clone of the repo and running `$ sudo pip3 install -r requirements-dev.txt`.
+First, build the image with `$ docker build . -t codebender/selenium`.
 
-### Invoking Tests via `tox`
+Then invoke `tox` via `docker run`. Here is a sample command to run all tests,
+where the Codebender server is running at `http://192.168.1.2:8080`:
 
-After installing dependencies, you should have the `tox` command available. To
-run all of the tests, you can simply run `$ tox` from within the cloned repo.
+```
+$ docker run -e CODEBENDER_SELENIUM_HUB_URL=http://johndoe:[email protected]:80/wd/hub \
+             -e CODEBENDER_TEST_USER=tester \
+             -e CODEBENDER_TEST_PASS=1234 \
+             -it codebender/selenium \
+             tox -- --url http://192.168.1.2:8080 --source bachelor
+```
 
-You can also run individual tests by providing the appropriate directory or
-filename as an argument, for example: `$ tox tests/sketch`.
+### Running Tests Manually
 
-Invoking tox will also run `flake8`, which is essentially a lint checker for
-Python. It is best to fix any issues reported by `flake8` before committing
-to the repo. It can be run on its own via the command `$ flake8`.
+The recommended way of running tests is with Docker. If you would like to
+manually provision your machine to be able to run tests, you can use the
+Dockerfile as a step-by-step guide for provisioning. Then invoke `tox` to run
+tests.
 
 #### Specifying a URL for Tests
 
@@ -105,6 +114,11 @@ The most important class is `SeleniumTestCase`, which all of the unit test cases
 inherit from. This grants them access (via `self`) to a number of methods and
 attributes that are useful for performing codebender-specific actions.
 
+**`codebender_testing/capabilities.yaml`** defines a list of `capabilities` to
+be passed as arguments when instantiating remote webdrivers. In particular, it
+specifies the web browsers that we would like to use. Consult this file for more
+information.
+
 #### `batch/`
 
 The `batch/` directory contains any executable scripts not directly used to

batch/requirements-batch.txt

@@ -0,0 +1,6 @@
+# Requirements for running batch scripts.
+
+# If lxml fails to install in Ubuntu, install the following dependencies with
+# apt-get: libxml2-dev libxslt1-dev python3-dev
+
+lxml

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,6 +1,9 @@
 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):
@@ -12,6 +15,10 @@ def _rel_path(*args):
 # URL of the actual Codebender website
 LIVE_SITE_URL = "http://codebender.cc"
 
+# Names of sources (i.e. repositories) used to generate the codebender site.
+SOURCE_BACHELOR = 'bachelor'
+SOURCE_CODEBENDER_CC = 'codebender_cc'
+
 # User whose projects we'd like to compile in our compile_tester
 # test case(s).
 COMPILE_TESTER_URL = "/user/cb_compile_tester"
@@ -29,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')
@@ -51,18 +66,72 @@ def _get_firefox_profile():
     )
     return firefox_profile
 
-# Webdrivers to be used for testing. Specifying additional webdrivers here
-# will cause every test to be re-run using that webdriver.
-# These webdrivers are specified as lambdas to allow for "lazy" evaluation.
-# The lambda invocation will return the actual webdriver and open up a
-# browser window, and we don't want a browser window to open whenever this
-# module is imported (hence the need for lazy evaluation).
-WEBDRIVERS = {
-    "firefox": lambda: webdriver.Firefox(firefox_profile=_get_firefox_profile()),
-    # "chrome": lambda: webdriver.Chrome()
-}
+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.
+
+    `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):
+    """Creates a new remote webdriver with the following properties:
+      - The remote URL of the webdriver is defined by `command_executor`.
+      - desired_capabilities is a dict with the same interpretation as
+        it is used elsewhere in selenium. If no browserName key is present,
+        we default to firefox.
+    """
+    if 'browserName' not in desired_capabilities:
+        desired_capabilities['browserName'] = 'firefox'
+    browser_name = desired_capabilities['browserName']
+    # 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)
+
+        # 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)
+        browser_profile = _get_firefox_profile()
+    else:
+        raise ValueError("Invalid webdriver %s (only chrome and firefox are supported)" % browser_name)
+    return webdriver.Remote(
+        command_executor=command_executor,
+        desired_capabilities=desired_capabilities,
+        browser_profile=browser_profile,
+    )
+
 
-# Credentials to use when logging into the site via selenium
+# Credentials to use when logging into the bachelor site
 TEST_CREDENTIALS = {
     "username": "tester",
     "password": "testerPASS"
@@ -71,4 +140,4 @@ def _get_firefox_profile():
 TEST_PROJECT_NAME = "test_project"
 
 # How long we wait until giving up on trying to locate an element
-ELEMENT_FIND_TIMEOUT = 5
+ELEMENT_FIND_TIMEOUT = 10

codebender_testing/utils.py

@@ -20,7 +20,6 @@
 from codebender_testing.config import ELEMENT_FIND_TIMEOUT
 from codebender_testing.config import TEST_CREDENTIALS
 from codebender_testing.config import TEST_PROJECT_NAME
-from codebender_testing.config import WEBDRIVERS
 
 
 # Time to wait until we give up on a DOM property becoming available.
@@ -92,16 +91,13 @@ class CodebenderSeleniumBot(object):
     # It is set via command line option in _testcase_attrs (below)
     site_url = None
 
-    def start(url=None, webdriver=None):
-        """Create the selenium webdriver, operating on `url`. We can't do this
-        in an __init__ method, otherwise py.test complains about
-        SeleniumTestCase having an init method.
-        The webdriver that is created is specified as a key into the WEBDRIVERS
-        dict (in codebender_testing.config)
+    def init(self, url=None, webdriver=None):
+        """Create a bot with the given selenium webdriver, operating on `url`.
+        We can't do this in an __init__ method, otherwise py.test complains,
+        presumably because it does something special with __init__ for test
+        cases.
         """
-        if webdriver is None:
-            webdriver = WEBDRIVERS.keys()[0]
-        self.driver = WEBDRIVERS[webdriver]()
+        self.driver = webdriver
 
         if url is None:
             url = BASE_URL
@@ -186,17 +182,22 @@ def upload_project(self, test_fname, project_name=None):
 
         return last_project.text, last_project.get_attribute('href')
 
-    def login(self):
-        """Performs a login."""
+    def login(self, credentials=None):
+        """Performs a login. Note that the current URL may change to an
+        unspecified location when calling this function.
+        `credentials` should be a dict with keys 'username' and 'password',
+        mapped to the appropriate values."""
+        if credentials is None:
+            credentials = TEST_CREDENTIALS
         try:
             self.open()
             login_button = self.driver.find_element_by_id('login_btn')
             login_button.send_keys(Keys.ENTER)
             # Enter credentials and log in
             user_field = self.driver.find_element_by_id('username')
-            user_field.send_keys(TEST_CREDENTIALS['username'])
+            user_field.send_keys(credentials['username'])
             pass_field = self.driver.find_element_by_id('password')
-            pass_field.send_keys(TEST_CREDENTIALS['password'])
+            pass_field.send_keys(credentials['password'])
             do_login = self.driver.find_element_by_id('_submit')
             do_login.send_keys(Keys.ENTER)
         except NoSuchElementException:
@@ -238,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')
@@ -344,11 +347,15 @@ def _testcase_attrs(cls, webdriver, testing_url, testing_full):
         cls.run_full_compile_tests = testing_full
 
     @pytest.fixture(scope="class")
-    def tester_login(self):
-        self.login()
+    def tester_login(self, testing_credentials):
+        """A fixture to perform a login with the credentials provided by the
+        `testing_credentials` fixture.
+        """
+        self.login(credentials=testing_credentials)
 
     @pytest.fixture(scope="class")
     def tester_logout(self):
+        """A fixture to guarantee that we are logged out before running a test."""
         self.logout()
 
 

extensions/codebender-app.crx

@@ -1,5 +1,4 @@
 flake8
-lxml
 pytest
 setuptools>=12.1
 tox

extensions/codebendercc-extension.crx

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