Add test for cb_compile_tester in bachelor

Author: Brandon Duffany

codebender_testing/config.py

@@ -12,7 +12,6 @@ def _rel_path(*args):
 # URL of the actual Codebender website
 LIVE_SITE_URL = "http://codebender.cc"
 
-
 # User whose projects we'd like to compile in our compile_tester
 # test case(s).
 COMPILE_TESTER_URL = "/user/cb_compile_tester"
@@ -36,6 +35,9 @@ def _rel_path(*args):
 TEST_DATA_BLANK_PROJECT = os.path.join(TEST_DATA_DIR, 'blank_project.ino')
 TEST_DATA_BLANK_PROJECT_ZIP = os.path.join(TEST_DATA_DIR, 'blank_project.zip')
 
+# Directory in which the local compile tester files are stored.
+COMPILE_TESTER_DIR = os.path.join(TEST_DATA_DIR, 'cb_compile_tester')
+
 # Set up Selenium Webdrivers to be used for selenium tests
 
 def _get_firefox_profile():

codebender_testing/utils.py

@@ -2,6 +2,7 @@
 from time import gmtime
 from time import strftime
 import json
+import os
 import re
 import tempfile
 
@@ -161,6 +162,30 @@ def open_project(self, project_name=None):
         project_link = self.driver.find_element_by_link_text(project_name)
         project_link.send_keys(Keys.ENTER)
 
+    def upload_project(self, test_fname, project_name=None):
+        """Tests that we can successfully upload `test_fname`.
+        `project_name` is the expected name of the project; by
+        default it is inferred from the file name.
+        Returns a pair of (the name of the project, the url of the project sketch)
+        """
+        # A tempfile is used here since we want the name to be
+        # unique; if the file has already been successfully uploaded
+        # then the test might give a false-positive.
+        with temp_copy(test_fname) as test_file:
+            self.dropzone_upload("#dropzoneForm", test_file.name)
+            if project_name is None:
+                project_name = os.path.split(test_file.name)[-1].split('.')[0]
+
+            # The upload was successful <==> we get a green "check" on its
+            # Dropzone upload indicator
+            self.get_element(By.CSS_SELECTOR, '#dropzoneForm .dz-success')
+
+        # Make sure the project shows up in the Projects list
+        last_project = self.get_element(By.CSS_SELECTOR,
+            '#sidebar-list-main li:last-child .project_link')
+
+        return last_project.text, last_project.get_attribute('href')
+
     def login(self):
         """Performs a login."""
         try:
@@ -244,20 +269,25 @@ def dropzone_upload(self, selector, fname):
         test_input.send_keys(fname)
         self.execute_script(_move_file_to_dropzone_script(selector))
 
-    def compile_all_sketches(self, url, selector, iframe=False, logfile=None):
-        """Compiles all projects on the page at `url`. `selector` is a CSS selector
+    def compile_all_sketches(self, url, selector, **kwargs):
+        """Compiles all sketches on the page at `url`. `selector` is a CSS selector
         that should select all relevant <a> tags containing links to sketches.
+        See `compile_sketches` for the possible keyword arguments that can be specified.
+        """
+        self.open(url)
+        sketches = self.execute_script(_GET_SKETCHES_SCRIPT.format(selector=selector))
+        assert len(sketches) > 0
+        self.compile_sketches(sketches, **kwargs)
+
+    def compile_sketches(self, sketches, iframe=False, logfile=None):
+        """Compiles the sketches with URLs given by the `sketches` list.
         `logfile` specifies a path to a file to which test results will be
         logged. If it is not `None`, compile errors will not cause the test
         to halt, but rather be logged to the given file. `logfile` may be a time
         format string, which will be formatted appropriately.
         `iframe` specifies whether the urls pointed to by `selector` are contained
         within an iframe.
         """
-        self.open(url)
-        sketches = self.execute_script(_GET_SKETCHES_SCRIPT.format(selector=selector))
-        assert len(sketches) > 0
-
         if logfile is None:
             for sketch in sketches:
                 self.compile_sketch(sketch, iframe=iframe)
@@ -278,7 +308,6 @@ def compile_all_sketches(self, url, selector, iframe=False, logfile=None):
             json.dump(log_entry, f)
             f.close()
 
-
     def execute_script(self, script, *deps):
         """Waits for all JavaScript variables in `deps` to be defined, then
         executes the given script."""

tests/compile_tester/test_compile_tester_projects.py

@@ -1,9 +1,14 @@
+import os
+
 import pytest
 
+from codebender_testing.config import BASE_URL
+from codebender_testing.config import COMPILE_TESTER_DIR
 from codebender_testing.config import COMPILE_TESTER_LOGFILE
 from codebender_testing.config import COMPILE_TESTER_URL
 from codebender_testing.config import LIVE_SITE_URL
 from codebender_testing.utils import SeleniumTestCase
+from codebender_testing.utils import temp_copy
 
 
 class TestCompileTester(SeleniumTestCase):
@@ -16,3 +21,19 @@ def test_compile_all_user_projects(self):
         self.compile_all_sketches(COMPILE_TESTER_URL, '#user_projects tbody a',
             iframe=True, log_file=COMPILE_TESTER_LOGFILE)
 
+    # Here we require BASE_URL since cb_compile_tester's projects are already
+    # uploaded to the live site.
+    @pytest.mark.requires_url(BASE_URL)
+    def test_compile_local_files(self, tester_login):
+        """Tests that we can upload all of cb_compile_tester's projects
+        (stored locally in test_data/cb_compile_tester), compile them,
+        and finally delete them."""
+        test_files = [os.path.join(COMPILE_TESTER_DIR, name)
+            for name in next(os.walk(COMPILE_TESTER_DIR))[2]]
+        projects = [self.upload_project(fname) for fname in test_files]
+        project_names, project_urls = zip(*projects)
+
+        self.compile_sketches(project_urls, logfile=COMPILE_TESTER_LOGFILE)
+        for name in project_names:
+            self.delete_project(name)
+

tests/user_home/test_user_home.py

@@ -60,30 +60,15 @@ def _upload_test(self, test_fname, project_name=None):
         """Tests that we can successfully upload `test_fname`.
         `project_name` is the expected name of the project; by
         default it is inferred from the file name.
+        We delete the project if it is successfully uploaded.
         """
-
-        # A tempfile is used here since we want the name to be
-        # unique; if the file has already been successfully uploaded
-        # then the test might give a false-positive.
-        with temp_copy(test_fname) as test_file:
-            self.dropzone_upload("#dropzoneForm", test_file.name)
-            if project_name is None:
-                project_name = os.path.split(test_file.name)[-1].split('.')[0]
-
-            # The upload was successful <==> we get a green "check" on its
-            # Dropzone upload indicator
-            self.get_element(By.CSS_SELECTOR, '#dropzoneForm .dz-success')
-
-        # Make sure the project shows up in the Projects list
-        last_project = self.get_element(By.CSS_SELECTOR,
-            '#sidebar-list-main li:last-child .project_link')
-
-        assert last_project.text == project_name
-
+        name, _ = self.upload_project(test_fname, project_name=project_name)
+        if project_name is not None:
+            assert name == project_name
         # Cleanup. If the above assertion failed, then we leave
         # garbage behind. This is unavoidable for now since we don't
         # have proper test fixtures. (TODO?)
-        self.delete_project(project_name)
+        self.delete_project(name)
 
     def test_upload_project_ino(self):
         """Tests that we can upload a .ino file."""