Merge pull request #25 from codebendercc/tests_fixes

Tests fixes

Author: freskoulix

bin/seleniumbender

@@ -68,7 +68,6 @@ URL="https://codebender.cc"
 email_date=$(date +"%Y-%m-%d %H:%M:%S")
 
 RETVAL=0
-NO_LOGS=0 # flag for tests that do not send any logs on their email
 
 if [ "${target}" -eq 1 ]; then
     IDENTIFIER="test_target_libraries"
@@ -86,12 +85,10 @@ elif [ "${common}" -eq 1 ]; then
     IDENTIFIER="common"
     tox tests/common -- --url=${URL} --plugin
     RETVAL=$?
-    NO_LOGS=1
 elif [ "${noplugin}" -eq 1 ]; then
     IDENTIFIER="noplugin"
     tox tests/noplugin -- --url=${URL}
     RETVAL=$?
-    NO_LOGS=1
 elif [ "${walkthrough}" -eq 1 ]; then
     IDENTIFIER="walkthrough"
     RETVALS=()
@@ -117,25 +114,24 @@ elif [ "${walkthrough}" -eq 1 ]; then
             RETVAL=${i}
         fi
     done
-    NO_LOGS=1
+
 elif [ "${staging}" -eq 1 ]; then
     IDENTIFIER="cb_compile_tester_staging"
     URL="https://staging.codebender.cc"
     tox tests/compile_tester -- --url=${URL} -F --plugin
-    # No need to send email for tests in staging
+    # No need to send email for tests in staging.
     exit $?
 fi
 
-# email notification without attaching any logs
+# Email notification without attaching any logs (options: common, noplugin, walkthrough).
 if [ ${RETVAL} -ne 0 ]; then
     mail -s "Selenium Tests: ${IDENTIFIER} Failed To Run" ${EMAIL} <<< "Something went wrong with ${IDENTIFIER} tests. Please check the logs."
-fi
-
-if [ ${NO_LOGS} -eq 1 ]; then
+    exit ${RETVAL}
+elif [ ${RETVAL} -eq 0 ]; then
     exit ${RETVAL}
 fi
 
-# email notification with attaching the produced reports
+# Email notification attaching the produced logs/reports(options: target, examples, libraries, sketches).
 LOGS="${ROOTDIR}/logs"
 REPORTS="${ROOTDIR}/reports"
 

codebender_testing/config.py

@@ -151,11 +151,11 @@ def create_webdriver(command_executor, desired_capabilities):
 
     if browser_name == "chrome":
         desired_capabilities = DesiredCapabilities.CHROME.copy()
-        options = chrome.options.Options()
-        browser_profile_path = os.path.join('/tmp', _get_chrome_profile())
-        options.add_argument('--user-data-dir=' + browser_profile_path)
         if desired_capabilities["version"] > CHROME_EXT_MAX_CHROME_VERSION:
             # Add the chrome app to capabilities.
+            options = chrome.options.Options()
+            browser_profile_path = os.path.join('/tmp', _get_chrome_profile())
+            options.add_argument('--user-data-dir=' + browser_profile_path)
             options.add_extension(os.path.join(_EXTENSIONS_DIR, _CHROME_APP_FNAME))
             options.add_argument("--user-agent=" + TESTS_USER_AGENT_CHROME)
         else:

codebender_testing/disqus.py

@@ -63,11 +63,11 @@ def update_comment(self, sketch, results, current_date, log_entry, openFailFlag,
         `self.last_library`: The library in which belongs the previously compiled example.
         `library_to_comment`: The library in which a comment should be added.
         """
-
         library_match = re.match(r'.+\/example\/(.+)\/.+', sketch)
         library = None
         library_to_comment = None
 
+        # Set the library in which belongs the currently compiled example.
         if library_match:
             library = library_match.group(1)
 
@@ -76,11 +76,10 @@ def update_comment(self, sketch, results, current_date, log_entry, openFailFlag,
             library_to_comment = library
 
         #Check if we should add a comment to the library.
-        if library_to_comment:
+        if library_to_comment and library not in self.examples_without_library:
             log_entry = self.handle_library_comment(library_to_comment, current_date, log_entry)
 
         self.last_library = library
-
         #Add a comment to the currently compiled library example.
         if not openFailFlag:
             log_entry = self.handle_example_comment(sketch, results, current_date, log_entry)
@@ -90,25 +89,42 @@ def update_comment(self, sketch, results, current_date, log_entry, openFailFlag,
     def handle_library_comment(self, library, current_date, log):
         url = '/library/' + library
         identifier = 'ident:' + url
+
         if url not in log:
             log[url] = {}
         try:
             log[url]['comment'] = False
+
+            """ Returns a Paginator object that matches the desired criteria:
+            `self.disqus.api.threads.list`: Returns a list containg all urls in which Disqus loaded.
+            `forum`: Looks up a forum by short name.
+            `thread`: Looks up a thread by ID BUT you may pass us the 'ident' query type instead of
+            an ID by including 'forum'. Filters results returned from `self.disqus.api.threads.list`
+            and returns only those which match `forum` and `thread`.
+            IMPORTANT: If `thread` is not found, all threads are returned!!!
+            """
             paginator = disqusapi.Paginator(self.disqus.api.threads.list,
                                             forum=FORUM,
-                                            thread=identifier, method='GET')
+                                            thread=identifier)
             if paginator:
                 comment_updated = False
                 new_message = self.messages['library'].replace('TEST_DATE', current_date)
-                for page in paginator:
-                    post_id, existing_message = self.get_posts(page['id'])
+
+                for thread in paginator:
+
+                    # Check if library has already a comment.
+                    post_id, existing_message = self.get_posts(thread['id'])
+
+                    #If library already has a comment, update it.
                     if post_id and existing_message:
                         log[url]['comment'] = self.update_post(post_id, new_message)
                         comment_updated = True
                         break
 
+                #If library doesn't have a comment, create it.
                 if not comment_updated:
                     log[url]['comment'] = self.create_post(identifier, new_message)
+
         except Exception as error:
             print 'Error:', error
             log[url]['comment'] = False
@@ -161,15 +177,21 @@ def get_posts(self, thread_id):
         post_id = None
         raw_message = None
         try:
+            """ Returns a Paginator object that matches the desired criteria:
+            `self.disqus.api.posts.list`: Returns a list of posts ordered by the date created.
+            `forum`: Looks up a forum by short name.
+            `thread`: Looks up a thread by ID. Filters results returned from `self.disqus.api.posts.list`
+            and returns only those which match `forum` and `thread`.
+            """
             paginator = disqusapi.Paginator(self.disqus.api.posts.list,
                                             forum=FORUM,
                                             thread=thread_id,
-                                            order='asc', method='GET')
+                                            order='asc')
             if paginator:
-                for result in paginator:
-                    if result['author']['name'] == self.user['username'] and result['author']['url'] == AUTHOR_URL:
-                        post_id = result['id']
-                        raw_message = result['raw_message']
+                for post in paginator:
+                    if post['author']['name'] == self.user['username'] and post['author']['url'] == AUTHOR_URL:
+                        post_id = post['id']
+                        raw_message = post['raw_message']
                         break
         except Exception as error:
             print 'Error:', error

codebender_testing/utils.py

@@ -123,9 +123,17 @@ def read_last_log(compile_type):
     }
 
 
-# Creates a report json after each compile test
 def report_creator(compile_type, log_entry, log_file):
+    """Creates a report json after each compile.
+    `logs`: a list in which all log files located in logs directory are added.
+    `logs_to_examine`: the list of all log files located in logs directory sorted.
+    `tail`: the two most recent logs in logs directory.
+    `diff`: a dictionary where all differences between the two logs are stored.
+    `changes`: a counter indicating the number of differences found between the two logs.
+    """
+
     logs = os.listdir(get_path('logs'))
+
     logs_re = re.compile(r'.+cb_compile_tester.+')
     if compile_type == 'library':
         logs_re = re.compile(r'.+libraries_test.+')
@@ -134,8 +142,10 @@ def report_creator(compile_type, log_entry, log_file):
     elif compile_type == 'target_library':
         logs_re = re.compile(r'.+target_libraries.+')
 
-    logs = sorted([x for x in logs if x != '.gitignore' and logs_re.match(x)])
+    logs = sorted([x for x in logs if logs_re.match(x)])
     tail = logs[-2:]
+
+    # Opens the last, or the last two log files and gathers all their contents.
     logs_to_examine = []
     for log in tail:
         try:
@@ -146,68 +156,75 @@ def report_creator(compile_type, log_entry, log_file):
 
     diff = {}
     changes = 0
+
+    # We have only one log file, it is the first time we run the test.
+    if len(logs_to_examine) == 1:
+        diff = logs_to_examine[0]
+        changes += 1
+
+    # We have more than one log files, it is not the first time we run the test.
     if len(logs_to_examine) >= 2:
+
         old_log = logs_to_examine[0]
         new_log = logs_to_examine[1]
 
+        #Iterate over all new_log keys (urls).
         for url in new_log.keys():
+
+            # Check if key (url) is included in `old_log`. If not, add an entry to `diff` dictionary.
             if url not in old_log:
                 diff[url] = new_log[url]
                 changes += 1
                 continue
 
+            """Check if log comes from test test_libraries_fetch.py test.
+            If yes, we check if the `old_log[url]`value is the same with
+            `new_log[url]`value. If not, add an entry to `diff` dictionary."""
             if compile_type == 'fetch':
                 if old_log[url] != new_log[url]:
                     diff[url] = new_log[url]
                     changes += 1
                 continue
 
-            for result in  new_log[url].keys():
-                if result not in old_log[url]:
-                    if not url in diff:
+            """Iterate over all `new_log[url]` keys. Keys can have one of the following
+            values: 'success', 'fail', 'open_fail', 'error', 'comment'."""
+            for result in new_log[url].keys():
+
+                """Check if for the specific url, result is included in
+                `old_log[url]` keys. If not, check if specific url has an entry in
+                `diff` dictionary and if not create one. Then add the `result` value.
+                e.g. `result`: success
+                     `old_log[url].keys()`: ['fail', 'success']"""
+
+                if result not in old_log[url].keys():
+                    if url not in diff:
                         diff[url] = {}
                     diff[url][result] = new_log[url][result]
                     changes += 1
                     continue
 
-                if result == 'success' or result == 'fail':
-                    if result not in old_log[url]:
-                        if not url in diff:
+                # Check if for the specific url, the result is `comment` or `open_fail` or `error`.
+                if result == 'comment' or result == 'open_fail' or result == 'error':
+                    # Check if the value for the specific result is the same in both logs.
+                    if old_log[url][result] != new_log[url][result]:
+                        # Check if the url is on diff dictionary, if not I add it.
+                        if url not in diff:
                             diff[url] = {}
                         diff[url][result] = new_log[url][result]
                         changes += 1
-                        continue
 
+                # Check if for the specific url, the result is `success` or `fail`.
+                elif result == 'success' or result == 'fail':
                     for board in new_log[url][result]:
-                        oposite = 'success'
-                        if result == 'success':
-                            oposite = 'fail'
-                        if oposite in old_log[url] and board in old_log[url][oposite]:
-                            if not url in diff:
+                        if board not in old_log[url][result]:
+                            if url not in diff:
                                 diff[url] = {}
                             if result not in diff[url]:
                                 diff[url][result] = []
                             diff[url][result].append(board)
                             changes += 1
-                elif result == 'open_fail' or result == 'error' or result == 'comment':
-                    if result not in old_log[url]:
-                        if not url in diff:
-                            diff[url] = {}
-                        diff[url][result] = new_log[url][result]
-                        changes += 1
-                        continue
-                    if old_log[url][result] != new_log[url][result]:
-                        if not url in diff:
-                            diff[url] = {}
-                        diff[url][result] = new_log[url][result]
-                        changes += 1
-    elif len(logs_to_examine) == 1:
-        diff = logs_to_examine[0]
-        changes += 1
-    else:
-        diff = log_entry
-        changes += 1
 
+    #Create report and write the results.
     filename_tokens = os.path.basename(log_file).split('.')
     filename = '.'.join(filename_tokens[0:-1])
     extension = filename_tokens[-1]
@@ -696,7 +713,7 @@ def compile_sketches(self, sketches, iframe=False, project_view=False, logfile=N
                 return
 
         # Generate a report if requested.
-        if compile_type != 'target_library' and create_report:
+        if compile_type != 'target_library' and create_report and self.run_full_compile_tests:
             report_creator(compile_type, log_entry, log_file)
         print '\nTest duration:', int(toc - tic), 'sec'
 

tests/common/how_it_works/test_how_it_works.py

@@ -106,7 +106,7 @@ def test_how_it_works_page_7 (self):
         WebDriverWait(self.driver, TIMEOUT).until(
             expected_conditions.text_to_be_present_in_element(
                 (By.CSS_SELECTOR,
-                '.navbar .popover:nth-child(3) .popover-title'),
+                '.navbar-inner .nav.pull-right .popover.fade.bottom.in .popover-title'),
                 "That's all for now."
             )
         )

tests/target_libraries/test_target_libraries.py

@@ -8,12 +8,8 @@
 
 GET_ALL_LIBRARIES_SCRIPT = """
     var libraries = {};
-    var humanNameRegExp = /^.+\((.+)\)$/;
     $('#mycontainer').find('.library-expand-handle').map(function () {
-        var libraryName = $(this).text();
-        if (humanNameRegExp.test(libraryName)) {
-            libraryName = libraryName.match(humanNameRegExp)[1].trim().replace(/\.h/, '');
-        }
+        var libraryName = $(this).parents('.accordion-group').attr('data-name');
         libraries[libraryName] = $(this).parent().find('.library_link').attr('href');
     });
     return libraries;
@@ -38,6 +34,7 @@ def test_compile_target_libraries(self):
 
         urls_to_follow = []
         for target in targets:
+            target = target.lower()
             if target in libraries:
                 library_url = libraries[target]
                 self.open(library_url)