[sonic_installer]: Improve exception handling: introduce notes. (#3028)

What I did
Extended exception class with user notes
How I did it
Implemented new API
How to verify it
Run UTs
Tested branch (Please provide the tested image version)
 202305
Details if related
Backport from master: [sonic_installer]: Improve exception handling: introduce notes. #3029

Author: nazariig

sonic_installer/common.py

@@ -45,10 +45,15 @@ def run_command_or_raise(argv, raise_exception=True):
     click.echo(click.style("Command: ", fg='cyan') + click.style(' '.join(argv), fg='green'))
 
     proc = subprocess.Popen(argv, text=True, stdout=subprocess.PIPE)
-    out, _ = proc.communicate()
+    out, err = proc.communicate()
 
     if proc.returncode != 0 and raise_exception:
-        raise SonicRuntimeException("Failed to run command '{0}'".format(argv))
+        sre = SonicRuntimeException("Failed to run command '{0}'".format(argv))
+        if out:
+            sre.add_note("\nSTDOUT:\n{}".format(out.rstrip("\n")))
+        if err:
+            sre.add_note("\nSTDERR:\n{}".format(err.rstrip("\n")))
+        raise sre
 
     return out.rstrip("\n")
 

sonic_installer/exception.py

@@ -5,4 +5,15 @@
 class SonicRuntimeException(Exception):
     """SONiC Runtime Excpetion class used to report SONiC related errors
     """
-    pass
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.notes = []
+
+    def __str__(self):
+        msg = super().__str__()
+        if self.notes:
+            msg += "\n" + "\n".join(self.notes)
+        return msg
+
+    def add_note(self, note):
+        self.notes.append(note)

tests/test_sonic_installer.py

@@ -129,3 +129,18 @@ def test_set_fips(get_bootloader):
     mock_bootloader.get_fips = Mock(return_value=True)
     result = runner.invoke(sonic_installer.commands["get-fips"], [next_image])
     assert "FIPS is enabled" in result.output
+
+@patch("sonic_installer.common.subprocess.Popen")
+def test_runtime_exception(mock_popen):
+    """ This test covers the "sonic-installer" exception handling. """
+
+    mock_popen.return_value.returncode = 1
+    mock_popen.return_value.communicate.return_value = ('Running', 'Failed')
+
+    with pytest.raises(sonic_installer_common.SonicRuntimeException) as sre:
+        sonic_installer_common.run_command_or_raise(["test.sh"])
+
+    assert '\nSTDOUT:\nRunning' in sre.value.notes, "Invalid STDOUT"
+    assert '\nSTDERR:\nFailed' in sre.value.notes, "Invalid STDERR"
+
+    assert all(v in str(sre.value) for v in ['test.sh', 'Running', 'Failed']), "Invalid message"