Added resume_log and create_log functions.

Function resume_log checks if there is a previous log file that needs to be continued.
Covers 3 cases:
Case 1: Test runs for 1st time and there is no previous log file.
Case 2: Test runs for 2nd time and there is a previous log file which contains some of the urls that should be compiled and log file should be completed with the rest.
Case 3: Test runs for 2nd time and there is a previous log file which contains all the urls that should be compiled and test should be run again for all urls.
Function create_log dumps the test results to `log_file`.

Author: Konstantinacc

codebender_testing/utils.py

@@ -528,62 +528,136 @@ def compile_all_sketches(self, url, selector, **kwargs):
         assert len(sketches) > 0
         self.compile_sketches(sketches, **kwargs)
 
-    def compile_sketches(self, sketches, iframe=False, project_view=False, logfile=None, compile_type='sketch', create_report=False, comment=False):
-        """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.
-        If the `--full` argument is provided (and hence
-        `self.run_full_compile_tests` is `True`, we do not log, and limit the
-        number of sketches compiled to 1.
+    def resume_log (self, logfile, compile_type, sketches):
+        """Resume previous log, if any. Coves 3 cases:
+        Case 1: Test runs for 1st time and there is no previous log file.
+        Case 2: Test runs for 2nd time and there is a previous log file which contains
+        some of the urls that should be compiled and log file should be completed with
+        the rest.
+        Case 3: Test runs for 2nd time and there is a previous log file which contains
+        all the urls that should be compiled and test should be run again for all urls.
         """
-
-        # Log filename
+        """Creates a variable in which current date and time are stored."""
         log_time = gmtime()
-        # Keeps the logs of each compile
+
+        """Creates an empty dictionary each time that a test runs."""
         log_entry = {}
 
+        """Creates an empty dictionary each time that a test runs."""
         urls_visited = {}
+
+        """Calls `read_last_log` function and checks if there is a previous log file
+        of the same compile_type (e.g. sketch). If there is, a dictionary containing
+        `timestamp` and `log` keys with their corresponding values is returned.
+        Otherwise, a dictionary where `timestamp` and `log` values are `None` is returned.
+        No previous log:
+        {'timestamp': None, 'log': None}
+        Previous log exists:
+        {'timestamp': '2016-02-14_10-42-17',
+         'log': {
+                'https://staging.codebender.cc/sketch:30360': {'success': ['Arduino Uno']},
+                'https://staging.codebender.cc/sketch:30352': {'success': ['Arduino Uno']}
+                }
+        }
+        """
         last_log = read_last_log(compile_type)
-        if compile_type != 'target_library' and last_log['log']:
-            # resume previous compile
-            log_time = strptime(last_log['timestamp'], '%Y-%m-%d_%H-%M-%S')
-            log_entry = last_log['log']
-            for url in last_log['log']:
-                urls_visited[url] = True
 
+        if compile_type != 'target_library' and last_log['log']:
+            """Checks if `last_log[log]` has a value (is not `None`).
+            If it has, this means that there is a log file created previously and dictionaries
+            `log_entry` and `urls_visited` should be updated.
+            {'timestamp': '2016-02-14_12-44-16',
+             'log': {
+                    'https://staging.codebender.cc/sketch:30360': {'success': ['Arduino Uno']},
+                    'https://staging.codebender.cc/sketch:30352': {'success': ['Arduino Uno']}
+                    }
+            }
+            """
+            if last_log['log']:
+                log_time = strptime(last_log['timestamp'], '%Y-%m-%d_%H-%M-%S')
+
+                """ Test has stopped its execution for some reason, (e.g.to avoid saucelabs timeout)
+                and `log_entry` dictionary will be filled with the entries of `last_log[log]` values.
+                log_entry = {'https://staging.codebender.cc/sketch:30360': {'success': ['Arduino Uno']},
+                             'https://staging.codebender.cc/sketch:30352': {'success': ['Arduino Uno']}}
+                """
+                log_entry = last_log['log']
+
+                """ Test has stopped its execution for some reason,(e.g.to avoid saucelabs timeout)
+                and `urls_visited` dictionary will be filled with the urls already visited when the test stopped.
+                urls_visited = {'https://staging.codebender.cc/sketch:30360': True,
+                                'https://staging.codebender.cc/sketch:30352': True}
+                """
+                for url in last_log['log']:
+                    urls_visited[url] = True
+
+        """Creates an empty dictionary each time that a test runs."""
         urls_to_visit = []
+
+        """If a test has stopped its execution for some reason,
+        (e.g.to avoid saucelabs timeout) `urls_to_visit` dictionary will
+        be filled with the urls that remain to be visited.
+        urls_to_visit = {'https://staging.codebender.cc/sketch:30358',
+                         'https://staging.codebender.cc/sketch:30355'}
+        """
         for url in sketches:
             if url not in urls_visited:
                 urls_to_visit.append(url)
 
+        """If the urls_to_visit is empty, this means that the test was completed
+        and should start again. `urls_to_visit` equals to all `sketches` and `log_entry`
+        is an empty dictionary.
+        """
         if len(urls_to_visit) == 0:
             urls_to_visit = sketches
             log_entry = {}
             log_time = gmtime()
 
         current_date = strftime('%Y-%m-%d', log_time)
-        # Initialize DisqusWrapper
-        disqus_wrapper = DisqusWrapper(log_time)
+
+        """ If `logfile` has a value and is not `None` we create `log_file`."""
         if logfile:
             log_file = strftime(logfile, log_time)
 
+        return (urls_to_visit, log_entry, log_file, disqus_wrapper, current_date)
+
+    def create_log (self, log_file, log_entry,compile_type):
+        # Dump the test results to `log_file`.
+        with open(log_file, 'w') as f:
+            f.write(jsondump(log_entry))
+
+
+    def compile_sketches(self, sketches, iframe=False, project_view=False, logfile=None, compile_type='sketch', create_report=False, comment=False):
+        """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.
+        If the `--full` argument is provided (and hence
+        `self.run_full_compile_tests` is `True`, we do not log, and limit the
+        number of sketches compiled to 1.
+        """
+
+        urls_to_visit, log_entry, log_file, log_time, current_date = self.resume_log(logfile, compile_type, sketches)
+
+        # Initialize DisqusWrapper.
+        disqus_wrapper = DisqusWrapper(log_time)
+
         print '\nCompiling:', len(urls_to_visit), 'sketches'
         total_sketches = len(urls_to_visit)
         tic = time.time()
 
         for sketch in urls_to_visit:
-            # Read the boards map in case current sketch/example requires a special board configuration
+            # Read the boards map in case current sketch/example requires a special board configuration.
             boards = BOARDS_DB['default_boards']
             url_fragments = urlparse(sketch)
             if url_fragments.path in BOARDS_DB['special_boards']:
                 boards = BOARDS_DB['special_boards'][url_fragments.path]
 
             if len(boards) > 0:
-                # Run Verify
+                # Run Verify.
                 results = self.compile_sketch(sketch, boards, iframe=iframe, project_view=project_view)
             else:
                 results = [
@@ -592,22 +666,28 @@ def compile_sketches(self, sketches, iframe=False, project_view=False, logfile=N
                     }
                 ]
 
-            # Used when not funning in Full mode
+            """If test is not running in full mode (-F option) or logfile is None
+            no logs are produced inside /logs directory and we continue with sketches
+            compilation.
+            """
             if logfile is None or not self.run_full_compile_tests:
                 toc = time.time()
                 continue
 
-            # Register current URL into log
+            # Register current URL into log.
             if sketch not in log_entry:
                 log_entry[sketch] = {}
+                print "\n"
+                print "sketch"
+                print "log_entry[" + sketch +"]", log_entry[sketch]
 
             test_status = '.'
-            # Log the compilation results
+
+            # Log the compilation results.
             openFailFlag = False
             for result in results:
                 if result['status'] in ['success', 'fail', 'error'] and result['status'] not in log_entry[sketch]:
                     log_entry[sketch][result['status']] = []
-
                 if result['status'] == 'success':
                     log_entry[sketch]['success'].append(result['board'])
                 elif result['status'] == 'fail':
@@ -627,13 +707,11 @@ def compile_sketches(self, sketches, iframe=False, project_view=False, logfile=N
                     log_entry[sketch]['unsupported'] = True
                     test_status = 'U'
 
-            # Update Disqus comments
-            if compile_type in ['library', 'target_library'] and comment:
-                log_entry = disqus_wrapper.update_comment(sketch, results, current_date, log_entry, openFailFlag, total_sketches)
+            self.create_log(log_file,log_entry, compile_type)
 
-            # Dump the test results to `logfile`.
-            with open(log_file, 'w') as f:
-                f.write(jsondump(log_entry))
+            # Update Disqus comments.
+            if comment and compile_type in ['library', 'target_library']:
+                log_entry = disqus_wrapper.update_comment(sketch, results, current_date, log_entry, openFailFlag, total_sketches)
 
             # Display progress
             sys.stdout.write(test_status)
@@ -645,7 +723,7 @@ def compile_sketches(self, sketches, iframe=False, project_view=False, logfile=N
                 print 'Test duration:', int(toc - tic), 'sec'
                 return
 
-        # Generate a report if requested
+        # Generate a report if requested.
         if compile_type != 'target_library' and create_report:
             report_creator(compile_type, log_entry, log_file)
         print '\nTest duration:', int(toc - tic), 'sec'