Handled unhandled exception to show bug report message

samcli/commands/exceptions.py

@@ -1,6 +1,9 @@
 """
 Class containing error conditions that are exposed to the user.
 """
+import urllib.parse
+import typing as t
+import traceback
 
 import click
 
@@ -25,6 +28,41 @@ def __init__(self, message, wrapped_from=None):
         click.ClickException.__init__(self, message)
 
 
+class UnhandledException(click.ClickException):
+    """
+    Exception class to re-wrap any exception that is not a UserException.
+    Typically this means there is a bug in SAM CLI.
+    """
+
+    GH_BUG_REPORT_URL = "https://github.com/aws/aws-sam-cli/issues/new?template=Bug_report.md&title={title}"
+    exit_code = 255
+
+    def __init__(self, command: str, exception: Exception) -> None:
+        self._command = command
+        self._exception = exception
+        self.__traceback__ = self._exception.__traceback__
+
+        click.ClickException.__init__(self, type(exception).__name__)
+
+    def show(self, file: t.Optional[t.IO] = None) -> None:
+        """Overriding show to customize printing stack trace and message"""
+        if file is None:
+            file = click._compat.get_text_stderr() # pylint: disable=protected-access
+
+        tb = "".join(traceback.format_tb(self.__traceback__))
+        click.echo(f"\nTraceback:\n{tb}", file=file, err=True)
+
+        url = self.GH_BUG_REPORT_URL.format(
+            title=urllib.parse.quote(f"{self._command} - {type(self._exception).__name__}")
+        )
+        msg = (
+            f'While trying to execute "{self._command}", we encountered an unexpected error.\n'
+            "To create a bug report, follow the Github issue template below:\n"
+            f"{url}"
+        )
+        click.secho(msg, file=file, err=True, fg="yellow")
+
+
 class CredentialsError(UserException):
     """
     Exception class when credentials that have been passed are invalid.

samcli/lib/telemetry/metric.py

@@ -18,7 +18,7 @@
 from samcli.cli.context import Context
 from samcli.cli.global_config import GlobalConfig
 from samcli.commands._utils.experimental import get_all_experimental_statues
-from samcli.commands.exceptions import UserException
+from samcli.commands.exceptions import UserException, UnhandledException
 from samcli.lib.hook.hook_config import HookPackageConfig
 from samcli.lib.hook.hook_wrapper import INTERNAL_PACKAGES_ROOT
 from samcli.lib.hook.exceptions import InvalidHookPackageConfigException
@@ -148,16 +148,18 @@ def wrapped(*args, **kwargs):
             # Execute the function and capture return value. This is returned back by the wrapper
             # First argument of all commands should be the Context
             return_value = func(*args, **kwargs)
-        except UserException as ex:
+        except (UserException, click.BadOptionUsage, click.BadArgumentUsage, click.BadParameter) as ex:
             # Capture exception information and re-raise it later so we can first send metrics.
             exception = ex
-            exit_code = ex.exit_code
-            if ex.wrapped_from is None:
-                exit_reason = type(ex).__name__
-            else:
+            # TODO (hawflau): review exitcode meaning. We now understand exitcode 1 as errors fixable by users.
+            exit_code = 1
+            if hasattr(ex, "wrapped_from") and ex.wrapped_from:
                 exit_reason = ex.wrapped_from
+            else:
+                exit_reason = type(ex).__name__
         except Exception as ex:
-            exception = ex
+            command = ctx.command_path if ctx else ""
+            exception = UnhandledException(command, ex)
             # Standard Unix practice to return exit code 255 on fatal/unhandled exit.
             exit_code = 255
             exit_reason = type(ex).__name__

tests/unit/lib/telemetry/test_metric.py

@@ -1,15 +1,13 @@
 import platform
 import time
 
-from parameterized import parameterized
-
-import samcli
-
 from unittest import TestCase
 from unittest.mock import patch, Mock, ANY, call
 
 import pytest
+from parameterized import parameterized
 
+import samcli
 from samcli.lib.hook.exceptions import InvalidHookPackageConfigException, InvalidHookWrapperException
 from samcli.lib.iac.plugins_interfaces import ProjectTypes
 from samcli.lib.telemetry.event import EventTracker
@@ -28,7 +26,7 @@
     ProjectDetails,
     _send_command_run_metrics,
 )
-from samcli.commands.exceptions import UserException
+from samcli.commands.exceptions import UserException, UnhandledException
 
 
 class TestSendInstalledMetric(TestCase):
@@ -194,7 +192,8 @@ def test_records_exceptions(self, exception, expected_exception, expected_code,
         def real_fn():
             raise exception
 
-        with self.assertRaises(exception.__class__) as context:
+        expected_exception_class = exception.__class__ if isinstance(exception, UserException) else UnhandledException
+        with self.assertRaises(expected_exception_class) as context:
             track_command(real_fn)()
             self.assertEqual(
                 context.exception,
@@ -261,17 +260,18 @@ def func(**kwargs):
     )
     @patch("samcli.lib.telemetry.metric.Context")
     @patch("samcli.lib.telemetry.metric._send_command_run_metrics")
-    def test_context_contains_exception(self, expected_exception, expected_code, run_metrics_mock, context_mock):
-        self.context_mock.exception = expected_exception("some exception")
+    def test_context_contains_exception(self, exception, exitcode, run_metrics_mock, context_mock):
+        self.context_mock.exception = exception("some exception")
         context_mock.get_current_context.return_value = self.context_mock
 
         mocked_func = Mock()
 
+        expected_exception = exception if exitcode == 1 else UnhandledException
         with self.assertRaises(expected_exception):
             track_command(mocked_func)()
 
         mocked_func.assert_not_called()
-        run_metrics_mock.assert_called_with(self.context_mock, ANY, expected_exception.__name__, expected_code)
+        run_metrics_mock.assert_called_with(self.context_mock, ANY, exception.__name__, exitcode)
 
 
 class TestSendCommandMetrics(TestCase):