From 1f063db16a91a9140795eafd4fc6cf14dda9c89f Mon Sep 17 00:00:00 2001
From: "maruel@chromium.org"
 <maruel@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98>
Date: Mon, 18 Apr 2011 19:04:52 +0000
Subject: [PATCH] Make subprocess2.call() returned values to be the same as
 subprocess.call().

Renamed the previous subprocess2.call() to subprocess2.communicate().

R=dpranke@chromium.org
BUG=
TEST=

Review URL: http://codereview.chromium.org/6877005

git-svn-id: svn://svn.chromium.org/chrome/trunk/tools/depot_tools@81976 0039d316-1c4b-4281-b951-d872f2087c98
---
 subprocess2.py            | 18 +++++++++++++++---
 tests/subprocess2_test.py | 24 +++++++++++++-----------
 2 files changed, 28 insertions(+), 14 deletions(-)

diff --git a/subprocess2.py b/subprocess2.py
index c743b03900..64a23a8bc1 100644
--- a/subprocess2.py
+++ b/subprocess2.py
@@ -192,7 +192,7 @@ def Popen(args, **kwargs):
     raise
 
 
-def call(args, timeout=None, **kwargs):
+def communicate(args, timeout=None, **kwargs):
   """Wraps subprocess.Popen().communicate().
 
   Returns ((stdout, stderr), returncode).
@@ -244,12 +244,24 @@ def call(args, timeout=None, **kwargs):
   return out, proc.returncode
 
 
+def call(args, **kwargs):
+  """Emulates subprocess.call().
+
+  Automatically convert stdout=PIPE or stderr=PIPE to VOID.
+  """
+  if kwargs.get('stdout') == PIPE:
+    kwargs['stdout'] = VOID
+  if kwargs.get('stderr') == PIPE:
+    kwargs['stderr'] = VOID
+  return communicate(args, **kwargs)[1]
+
+
 def check_call(args, **kwargs):
   """Improved version of subprocess.check_call().
 
   Returns (stdout, stderr), unlike subprocess.check_call().
   """
-  out, returncode = call(args, **kwargs)
+  out, returncode = communicate(args, **kwargs)
   if returncode:
     raise CalledProcessError(
         returncode, args, kwargs.get('cwd'), out[0], out[1])
@@ -271,7 +283,7 @@ def capture(args, **kwargs):
     kwargs['stdout'] = PIPE
   if kwargs.get('stderr') is None:
     kwargs['stderr'] = STDOUT
-  return call(args, **kwargs)[0][0]
+  return communicate(args, **kwargs)[0][0]
 
 
 def check_output(args, **kwargs):
diff --git a/tests/subprocess2_test.py b/tests/subprocess2_test.py
index 552a93c49e..c419df022d 100755
--- a/tests/subprocess2_test.py
+++ b/tests/subprocess2_test.py
@@ -22,8 +22,9 @@ import subprocess2
 class Subprocess2Test(unittest.TestCase):
   # Can be mocked in a test.
   TO_SAVE = {
-      subprocess2: ['Popen', 'call', 'check_call', 'capture', 'check_output'],
-      subprocess2.subprocess: ['Popen'],
+    subprocess2: [
+      'Popen', 'communicate', 'call', 'check_call', 'capture', 'check_output'],
+    subprocess2.subprocess: ['Popen'],
   }
 
   def setUp(self):
@@ -40,14 +41,14 @@ class Subprocess2Test(unittest.TestCase):
         setattr(module, name, value)
 
   @staticmethod
-  def _fake_call():
+  def _fake_communicate():
     results = {}
-    def fake_call(args, **kwargs):
+    def fake_communicate(args, **kwargs):
       assert not results
       results.update(kwargs)
       results['args'] = args
       return ['stdout', 'stderr'], 0
-    subprocess2.call = fake_call
+    subprocess2.communicate = fake_communicate
     return results
 
   @staticmethod
@@ -79,7 +80,7 @@ class Subprocess2Test(unittest.TestCase):
     return results
 
   def test_check_call_defaults(self):
-    results = self._fake_call()
+    results = self._fake_communicate()
     self.assertEquals(
         ['stdout', 'stderr'], subprocess2.check_call(['foo'], a=True))
     expected = {
@@ -88,9 +89,10 @@ class Subprocess2Test(unittest.TestCase):
     }
     self.assertEquals(expected, results)
 
-  def test_call_defaults(self):
+  def test_communicate_defaults(self):
     results = self._fake_Popen()
-    self.assertEquals(((None, None), -8), subprocess2.call(['foo'], a=True))
+    self.assertEquals(
+        ((None, None), -8), subprocess2.communicate(['foo'], a=True))
     expected = {
         'args': ['foo'],
         'a': True,
@@ -118,9 +120,9 @@ class Subprocess2Test(unittest.TestCase):
     self.assertEquals(expected, results)
 
   def test_check_output_defaults(self):
-    results = self._fake_call()
+    results = self._fake_communicate()
     # It's discarding 'stderr' because it assumes stderr=subprocess2.STDOUT but
-    # fake_call() doesn't 'implement' that.
+    # fake_communicate() doesn't 'implement' that.
     self.assertEquals('stdout', subprocess2.check_output(['foo'], a=True))
     expected = {
         'args': ['foo'],
@@ -133,7 +135,7 @@ class Subprocess2Test(unittest.TestCase):
 
   def test_timeout(self):
     # It'd be better to not discard stdout.
-    out, returncode = subprocess2.call(
+    out, returncode = subprocess2.communicate(
         self.exe + ['--sleep', '--stdout'],
         timeout=0.01,
         stdout=subprocess2.PIPE)