From 14418b6d80ef4652a44d9280baf369c8e3c429fd Mon Sep 17 00:00:00 2001
From: Viacheslav Hletenko <v.gletenko@vyos.io>
Date: Thu, 28 Jul 2022 23:03:41 +0000
Subject: vyos.util: T4575: Add new wrapper "rc_cmd"

It is useful to have both a return code and output of the command
Add a new wrapper "rc_cmd" that returns both

% rc_cmd('uname')
(0, 'Linux')

% rc_cmd('ip link show dev fake')
(1, 'Device "fake" does not exist.')
---
 python/vyos/util.py | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/python/vyos/util.py b/python/vyos/util.py
index bee5d7aec..b86b1949c 100644
--- a/python/vyos/util.py
+++ b/python/vyos/util.py
@@ -164,6 +164,27 @@ def cmd(command, flag='', shell=None, input=None, timeout=None, env=None,
     return decoded
 
 
+def rc_cmd(command, flag='', shell=None, input=None, timeout=None, env=None,
+           stdout=PIPE, stderr=STDOUT, decode='utf-8'):
+    """
+    A wrapper around popen, which returns the return code
+    of a command and stdout
+
+    % rc_cmd('uname')
+    (0, 'Linux')
+    % rc_cmd('ip link show dev eth99')
+    (1, 'Device "eth99" does not exist.')
+    """
+    out, code = popen(
+        command, flag,
+        stdout=stdout, stderr=stderr,
+        input=input, timeout=timeout,
+        env=env, shell=shell,
+        decode=decode,
+    )
+    return code, out
+
+
 def call(command, flag='', shell=None, input=None, timeout=None, env=None,
          stdout=PIPE, stderr=PIPE, decode='utf-8'):
     """
-- 
cgit v1.2.3