Merge lp:~gz/workspace-runner/sorted_walk_results into lp:workspace-runner

[Martin Packman]

Fix test failures by applying stable ordering to os.walk results

Currently make test complains out of order walk results from the FakePrimitives test class.

<https://docs.python.org/2/library/os.html#os.walk>

Note os.walk does not promis ordering, but does let you manipulate dirnames in place with topdown=True to apply an order you desire. So, this branch just does that.

FAIL: test_s3_upload (workspace_runner.tests.__init__.TestRunFromConfig)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "workspace_runner/tests/__init__.py", line 441, in test_s3_upload
    'upload.json', 'upload_artifacts.py'])
AssertionError: Lists differ: [('/tmp/tmp6gFog4', ['.wsr'], ... != [('/tmp/tmp6gFog4', ['.wsr'], ...

First differing element 1:
('/tmp/tmp6gFog4/.wsr', [], ['upload_artifacts.py', 'upload.json'])
('/tmp/tmp6gFog4/.wsr', [], ['upload.json', 'upload_artifacts.py'])

  [('/tmp/tmp6gFog4', ['.wsr'], []),
- ('/tmp/tmp6gFog4/.wsr', [], ['upload_artifacts.py', 'upload.json'])]
? ---------------

+ ('/tmp/tmp6gFog4/.wsr', [], ['upload.json', 'upload_artifacts.py'])]
? +++++++++++++++

[Aaron Bentley (abentley)]

Thanks.

review: Approve

=== modified file 'workspace_runner/tests/__init__.py'
--- workspace_runner/tests/__init__.py	2015-10-09 18:32:02 +0000
+++ workspace_runner/tests/__init__.py	2016-07-11 18:11:39 +0000
@@ -72,7 +72,12 @@
         return mkdtemp()
 
     def destroy(self):
-        self.walk_results = list(os.walk(self.workspace))
+        self.walk_results = []
+        for root, dirs, files in os.walk(self.workspace):
+            # Ensure walk happens in lexical order and results stored likewise.
+            dirs.sort()
+            files.sort()
+            self.walk_results.append((root, dirs, files))
         rmtree(self.workspace)
 
     def run(self, args, out_file):