From cdced3d08fad56ae3f4311d7f21d70e393942a0b Mon Sep 17 00:00:00 2001
From: Scott Gasch <scott@gasch.org>
Date: Thu, 2 Jun 2022 17:33:29 -0700
Subject: [PATCH] Rename a method in exec_utils.

---
 exec_utils.py                       | 7 +++----
 executors.py                        | 4 ++--
 tests/run_some_dependencies_test.py | 2 +-
 3 files changed, 6 insertions(+), 7 deletions(-)

diff --git a/exec_utils.py b/exec_utils.py
index 7e45d92..0bcfc27 100644
--- a/exec_utils.py
+++ b/exec_utils.py
@@ -71,7 +71,7 @@ def cmd_showing_output(
         return p.returncode
 
 
-def cmd_with_timeout(command: str, timeout_seconds: Optional[float] = None) -> int:
+def cmd_exitcode(command: str, timeout_seconds: Optional[float] = None) -> int:
     """Run a command but do not let it run for more than timeout_seconds.
     This code doesn't capture or rebroadcast the command's output.  It
     returns the exit value of the command or raises a TimeoutExpired
@@ -86,10 +86,10 @@ def cmd_with_timeout(command: str, timeout_seconds: Optional[float] = None) -> i
         the exit status of the subprocess once the subprocess has
         exited
 
-    >>> cmd_with_timeout('/bin/echo foo', 10.0)
+    >>> cmd_exitcode('/bin/echo foo', 10.0)
     0
 
-    >>> cmd_with_timeout('/bin/sleep 2', 0.01)
+    >>> cmd_exitcode('/bin/sleep 2', 0.01)
     Traceback (most recent call last):
     ...
     subprocess.TimeoutExpired: Command '['/bin/bash', '-c', '/bin/sleep 2']' timed out after 0.01 seconds
@@ -123,7 +123,6 @@ def cmd(command: str, timeout_seconds: Optional[float] = None) -> str:
     ret = subprocess.run(
         command,
         shell=True,
-        #        capture_output=True,
         stdout=subprocess.PIPE,
         stderr=subprocess.STDOUT,
         check=True,
diff --git a/executors.py b/executors.py
index a9d25da..4269371 100644
--- a/executors.py
+++ b/executors.py
@@ -36,7 +36,7 @@ import histogram as hist
 import string_utils
 from ansi import bg, fg, reset, underline
 from decorator_utils import singleton
-from exec_utils import cmd_in_background, cmd_with_timeout, run_silently
+from exec_utils import cmd_exitcode, cmd_in_background, run_silently
 from thread_utils import background_thread
 
 logger = logging.getLogger(__name__)
@@ -1380,7 +1380,7 @@ class DefaultExecutors(object):
     def _ping(host) -> bool:
         logger.debug('RUN> ping -c 1 %s', host)
         try:
-            x = cmd_with_timeout(f'ping -c 1 {host} >/dev/null 2>/dev/null', timeout_seconds=1.0)
+            x = cmd_exitcode(f'ping -c 1 {host} >/dev/null 2>/dev/null', timeout_seconds=1.0)
             return x == 0
         except Exception:
             return False
diff --git a/tests/run_some_dependencies_test.py b/tests/run_some_dependencies_test.py
index c9f48a5..a7ee9b4 100755
--- a/tests/run_some_dependencies_test.py
+++ b/tests/run_some_dependencies_test.py
@@ -32,7 +32,7 @@ class RunSomeDependenciesTest(unittest.TestCase):
         ]
         for command in commands:
             try:
-                ret = exec_utils.cmd_with_timeout(command, 15.0)
+                ret = exec_utils.cmd_exitcode(command, 15.0)
                 self.assertEqual(0, ret)
             except Exception as e:
                 logger.exception(e)
-- 
2.46.0