Use context manager to manage OS environment in tests

test/lib/TestGyp.py

 # Copyright (c) 2012 Google Inc. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """
 TestGyp.py:  a testing framework for GYP integration tests.
 """
 
 import collections
+from contextlib import contextmanager
 import itertools
 import os
 import re
 import shutil
 import stat
 import subprocess
 import sys
 import tempfile
 
 import TestCmd
 import TestCommon
 from TestCommon import __all__
 
 __all__.extend([
   'TestGyp',
 ])
 
+
 def remove_debug_line_numbers(contents):
   """Function to remove the line numbers from the debug output
-  of gyp and thus remove the exremem fragility of the stdout
+  of gyp and thus reduce the extreme fragility of the stdout
   comparison tests.
   """
   lines = contents.splitlines()
   # split each line on ":"
   lines = [l.split(":", 3) for l in lines]
   # join each line back together while ignoring the
   # 3rd column which is the line number
   lines = [len(l) > 3 and ":".join(l[3:]) or l for l in lines]
   return "\n".join(lines)
 
+
 def match_modulo_line_numbers(contents_a, contents_b):
   """File contents matcher that ignores line numbers."""
   contents_a = remove_debug_line_numbers(contents_a)
   contents_b = remove_debug_line_numbers(contents_b)
   return TestCommon.match_exact(contents_a, contents_b)
 
+
+@contextmanager

[Nils Barth (inactive), 2014/04/08 08:56:32]

This is a simple single-use context manager (CM), which is fine:
these nest correctly.
We only need a re-entrant CM if reusing the same CM multiple times, but we want
to set the local environment (formally, new frame) each time.

https://docs.python.org/3/library/contextlib.html#single-use-reusable-and-ree...

+def LocalEnv(local_env):
+  """Context manager to provide a local OS environment."""
+  env_copy = os.environ.copy()
+  os.environ.update(local_env)
+  yield

[Stefan Haller, 2014/04/08 17:05:41]

Sorry for jumping in here: for correctness, this should read

try:
  yield
finally:
  os.environ.clear()
  os.environ.update(env_copy)

Otherwise the environment won't be restored for failing tests, possibly
affecting the results of other tests that run after it.

[Nils Barth (inactive), 2014/04/09 03:09:18]

Oh, good catch -- thanks!
*don't* need try: ... finally: ... for manually written context managers
with cleanup in __exit__,
but *do* need try: ... finally: ... for @contextlib.contextmanager

+  os.environ.clear()
+  os.environ.update(env_copy)
+
+
 class TestGypBase(TestCommon.TestCommon):
   """
   Class for controlling end-to-end tests of gyp generators.
 
   Instantiating this class will create a temporary directory and
   arrange for its destruction (via the TestCmd superclass) and
   copy all of the non-gyptest files in the directory hierarchy of the
   executing script.
 
   The default behavior is to test the 'gyp' or 'gyp.bat' file in the
@@ skipping 1052 matching lines @@
 
 def TestGyp(*args, **kw):
   """
   Returns an appropriate TestGyp* instance for a specified GYP format.
   """
   format = kw.pop('format', os.environ.get('TESTGYP_FORMAT'))
   for format_class in format_class_list:
     if format == format_class.format:
       return format_class(*args, **kw)
   raise Exception, "unknown format %r" % format