7242391285

Committed 18 Dec 2023 01:23AM UTC coverage: 61.432% (-21.3%) from 82.732%

Build # 7242391285

Build Type

Pull #3671

github

Committed by

RenkuBot

Commit Message

chore: release v2.8.1

Pull Request Pull Request #3671: chore: release v2.8.1

Run Details

104 of 137 new or added lines in 31 files covered. (75.91%)

6464 existing lines in 180 files now uncovered.

18537 of 30175 relevant lines covered (61.43%)

1.25 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

54.74

/renku/ui/cli/exception_handler.py

# Copyright Swiss Data Science Center (SDSC). A partnership between
# École Polytechnique Fédérale de Lausanne (EPFL) and
# Eidgenössische Technische Hochschule Zürich (ETHZ).
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Renku is not bug-free and you can help us to find them.

GitHub
~~~~~~

You can quickly open an issue on GitHub with a traceback and minimal system
information when you hit an unhandled exception in the CLI.

.. code-block:: text

    Ahhhhhhhh! You have found a bug. 🐞

    1. Open an issue by typing "open";
    2. Print human-readable information by typing "print";
    3. See the full traceback without submitting details (default: "ignore").

    Please select an action by typing its name (open, print, ignore) [ignore]:

Sentry
~~~~~~

When using ``renku`` as a hosted service the Sentry integration can be enabled
to help developers iterate faster by showing them where bugs happen, how often,
and who is affected.

1. Install ``Sentry-SDK`` with ``python -m pip install sentry-sdk``;
2. Set environment variables ``SENTRY_DSN=true`` and
   ``SENTRY_DSN=https://<key>@sentry.<domain>/<project>``.
3. Set the environment variable ``SENTRY_SAMPLE_RATE=0.2``. This would track
   20% of all requests in Sentry performance monitoring. Set to 0 to disable.

.. warning:: User information might be sent to help resolving the problem.
   If you are not using your own Sentry instance you should inform users
   that you are sending possibly sensitive information to a 3rd-party service.
"""

import os
import platform
import re
import sys
import textwrap
import traceback
from urllib.parse import urlencode

import click

import renku.ui.cli.utils.color as color
from renku.command.util import ERROR
from renku.core import errors
from renku.ui.service.config import SENTRY_ENABLED, SENTRY_SAMPLERATE

_BUG = click.style("Ahhhhhhhh! You have found a bug. 🐞\n\n", fg=color.RED, bold=True)
HAS_SENTRY = SENTRY_ENABLED

if SENTRY_ENABLED:
    try:
        from importlib.metadata import PackageNotFoundError, distribution
    except ImportError:
        from importlib_metadata import PackageNotFoundError, distribution  # type: ignore

    try:
        distribution("sentry-sdk")
    except PackageNotFoundError:
        HAS_SENTRY = False


class RenkuExceptionsHandler(click.Group):
    """Handles all RenkuExceptions."""

    def main(self, *args, **kwargs):
        """Catch and print all Renku exceptions."""
        from renku.core.errors import MigrationRequired, ParameterError, ProjectNotSupported, RenkuException, UsageError

        try:
            return super().main(*args, **kwargs)
        except errors.LockError:
            click.echo(
                click.style("Unable to acquire lock.\n", fg=color.RED)
                + "Hint: Please wait for another renku process to finish and then try again."
            )
        except RenkuException as e:
            click.echo(ERROR + str(e), err=True)
            if e.__cause__ is not None:
                click.echo(f"\n{traceback.format_exc()}")
            exit_code = 1
            if isinstance(e, (ParameterError, UsageError)):
                exit_code = 2
            elif isinstance(e, MigrationRequired):
                exit_code = 3
            elif isinstance(e, ProjectNotSupported):
                exit_code = 4
            sys.exit(exit_code)


class IssueFromTraceback(RenkuExceptionsHandler):
    """Create an issue with formatted exception."""

    REPO_URL = "https://github.com/SwissDataScienceCenter/renku-python"

    ISSUE_SUFFIX = "/issues/new"

    def __init__(self, *args, **kwargs):
        """Initialize a Sentry client."""
        super().__init__(*args, **kwargs)

        if HAS_SENTRY:
            import sentry_sdk

            sentry_sdk.init(
                dsn=os.getenv("SENTRY_DSN"), environment=os.getenv("SENTRY_ENV"), traces_sample_rate=SENTRY_SAMPLERATE
            )

    def main(self, *args, **kwargs):
        """Catch all exceptions."""
        try:
            return super().main(*args, **kwargs)
        except Exception:
            if HAS_SENTRY:
                self._handle_sentry()

            if not (sys.stdin.isatty() and sys.stdout.isatty()):
                raise

            self._handle_github()

    def _handle_sentry(self):
        """Handle exceptions using Sentry."""
        from sentry_sdk import capture_exception, configure_scope
        from sentry_sdk.utils import capture_internal_exceptions

        with configure_scope() as scope:
            with capture_internal_exceptions():
                from renku.core.util.git import get_git_repository

                user = get_git_repository().get_user()

                scope.user = {"name": user.name, "email": user.email}

            event_id = capture_exception()
            click.echo(_BUG + f"Recorded in Sentry with ID: {event_id}\n", err=True)
            raise

    def _handle_github(self):
        """Handle exception and submit it as GitHub issue."""
        value = click.prompt(
            _BUG
            + click.style('1. Open an issue by typing "open";\n', fg=color.GREEN)
            + click.style("2. Print human-readable information by typing " '"print";\n', fg=color.YELLOW)
            + click.style(
                "3. See the full traceback without submitting details " '(default: "ignore").\n\n', fg=color.RED
            )
            + "Please select an action by typing its name",
            type=click.Choice(["open", "print", "ignore"]),
            default="ignore",
        )
        getattr(self, "_process_" + value)()

    def _format_issue_title(self):
        """Return formatted title."""
        return textwrap.shorten("cli: renku " + " ".join(sys.argv[1:]), width=50)

    def _format_issue_body(self, limit=-5):
        """Return formatted body."""
        from renku import __version__

        re_paths = r"(" + r"|".join([path or os.getcwd() for path in sys.path]) + r")"
        tb = re.sub(re_paths, "[...]", traceback.format_exc(limit=limit))

        return (
            "## Describe the bug\nA clear and concise description.\n\n"
            "## Details\n"
            "*Please verify and redact the details.*\n\n"
            "**Renku version:** " + __version__ + "\n"
            "**OS:** " + platform.system() + " (" + platform.version() + ")\n"
            "**Python:** " + platform.python_version() + "\n\n"
            "### Traceback\n\n```\n" + tb + "```\n\n"
            "## Additional context\nAdd any other context about the problem."
        )

    def _format_issue_url(self):
        """Format full issue URL."""
        query = urlencode({"title": self._format_issue_title(), "body": self._format_issue_body()})
        return self.REPO_URL + self.ISSUE_SUFFIX + "?" + query

    def _process_open(self):
        """Open link in a browser."""
        click.launch(self._format_issue_url())
        if not click.confirm("Did it work?", default=True):
            click.echo()
            self._process_print()
            click.secho("\nOpen the line manually and copy the text above\n", fg=color.YELLOW)
            click.secho("  " + self.REPO_URL + self.ISSUE_SUFFIX + "\n", bold=True)

    def _process_print(self):
        """Print link in a console."""
        click.echo(self._format_issue_body(limit=None))

    def _process_ignore(self):
        """Print original exception in a console."""
        raise

1	# Copyright Swiss Data Science Center (SDSC). A partnership between
2	# École Polytechnique Fédérale de Lausanne (EPFL) and
3	# Eidgenössische Technische Hochschule Zürich (ETHZ).
4	#
5	# Licensed under the Apache License, Version 2.0 (the "License");
6	# you may not use this file except in compliance with the License.
7	# You may obtain a copy of the License at
8	#
9	# http://www.apache.org/licenses/LICENSE-2.0
10	#
11	# Unless required by applicable law or agreed to in writing, software
12	# distributed under the License is distributed on an "AS IS" BASIS,
13	# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14	# See the License for the specific language governing permissions and
15	# limitations under the License.
16	"""Renku is not bug-free and you can help us to find them.	3✔
17
18	GitHub
19	~~~~~~
20
21	You can quickly open an issue on GitHub with a traceback and minimal system
22	information when you hit an unhandled exception in the CLI.
23
24	.. code-block:: text
25
26	Ahhhhhhhh! You have found a bug. 🐞
27
28	1. Open an issue by typing "open";
29	2. Print human-readable information by typing "print";
30	3. See the full traceback without submitting details (default: "ignore").
31
32	Please select an action by typing its name (open, print, ignore) [ignore]:
33
34	Sentry
35	~~~~~~
36
37	When using ``renku`` as a hosted service the Sentry integration can be enabled
38	to help developers iterate faster by showing them where bugs happen, how often,
39	and who is affected.
40
41	1. Install ``Sentry-SDK`` with ``python -m pip install sentry-sdk``;
42	2. Set environment variables ``SENTRY_DSN=true`` and
43	``SENTRY_DSN=https://<key>@sentry.<domain>/<project>``.
44	3. Set the environment variable ``SENTRY_SAMPLE_RATE=0.2``. This would track
45	20% of all requests in Sentry performance monitoring. Set to 0 to disable.
46
47	.. warning:: User information might be sent to help resolving the problem.
48	If you are not using your own Sentry instance you should inform users
49	that you are sending possibly sensitive information to a 3rd-party service.
50	"""
51
52	import os	3✔
53	import platform	3✔
54	import re	3✔
55	import sys	3✔
56	import textwrap	3✔
57	import traceback	3✔
58	from urllib.parse import urlencode	3✔
59
60	import click	3✔
61
62	import renku.ui.cli.utils.color as color	3✔
63	from renku.command.util import ERROR	3✔
64	from renku.core import errors	3✔
65	from renku.ui.service.config import SENTRY_ENABLED, SENTRY_SAMPLERATE	3✔
66
67	_BUG = click.style("Ahhhhhhhh! You have found a bug. 🐞\n\n", fg=color.RED, bold=True)	3✔
68	HAS_SENTRY = SENTRY_ENABLED	3✔
69
70	if SENTRY_ENABLED:	3✔
71	try:	×
72	from importlib.metadata import PackageNotFoundError, distribution	×
73	except ImportError:	×
74	from importlib_metadata import PackageNotFoundError, distribution # type: ignore	×
75
76	try:	×
77	distribution("sentry-sdk")	×
78	except PackageNotFoundError:	×
79	HAS_SENTRY = False	×
80
81
82	class RenkuExceptionsHandler(click.Group):	3✔
83	"""Handles all RenkuExceptions."""
84
85	def main(self, args, *kwargs):	3✔
86	"""Catch and print all Renku exceptions."""
87	from renku.core.errors import MigrationRequired, ParameterError, ProjectNotSupported, RenkuException, UsageError	2✔
88
89	try:	2✔
90	return super().main(args, *kwargs)	2✔
91	except errors.LockError:	2✔
UNCOV 92	click.echo(	×
93	click.style("Unable to acquire lock.\n", fg=color.RED)
94	+ "Hint: Please wait for another renku process to finish and then try again."
95	)
96	except RenkuException as e:	2✔
97	click.echo(ERROR + str(e), err=True)	1✔
98	if e.__cause__ is not None:	1✔
UNCOV 99	click.echo(f"\n{traceback.format_exc()}")	×
100	exit_code = 1	1✔
101	if isinstance(e, (ParameterError, UsageError)):	1✔
102	exit_code = 2	1✔
103	elif isinstance(e, MigrationRequired):	1✔
UNCOV 104	exit_code = 3	×
105	elif isinstance(e, ProjectNotSupported):	1✔
UNCOV 106	exit_code = 4	×
107	sys.exit(exit_code)	1✔
108
109
110	class IssueFromTraceback(RenkuExceptionsHandler):	3✔
111	"""Create an issue with formatted exception."""
112
113	REPO_URL = "https://github.com/SwissDataScienceCenter/renku-python"	3✔
114
115	ISSUE_SUFFIX = "/issues/new"	3✔
116
117	def __init__(self, args, *kwargs):	3✔
118	"""Initialize a Sentry client."""
119	super().__init__(args, *kwargs)	3✔
120
121	if HAS_SENTRY:	3✔
122	import sentry_sdk	×
123
124	sentry_sdk.init(	×
125	dsn=os.getenv("SENTRY_DSN"), environment=os.getenv("SENTRY_ENV"), traces_sample_rate=SENTRY_SAMPLERATE
126	)
127
128	def main(self, args, *kwargs):	3✔
129	"""Catch all exceptions."""
130	try:	2✔
131	return super().main(args, *kwargs)	2✔
132	except Exception:	2✔
133	if HAS_SENTRY:	1✔
134	self._handle_sentry()	×
135
136	if not (sys.stdin.isatty() and sys.stdout.isatty()):	1✔
137	raise	1✔
138
139	self._handle_github()	×
140
141	def _handle_sentry(self):	3✔
142	"""Handle exceptions using Sentry."""
143	from sentry_sdk import capture_exception, configure_scope	×
144	from sentry_sdk.utils import capture_internal_exceptions	×
145
146	with configure_scope() as scope:	×
147	with capture_internal_exceptions():	×
148	from renku.core.util.git import get_git_repository	×
149
150	user = get_git_repository().get_user()	×
151
152	scope.user = {"name": user.name, "email": user.email}	×
153
154	event_id = capture_exception()	×
155	click.echo(_BUG + f"Recorded in Sentry with ID: {event_id}\n", err=True)	×
156	raise	×
157
158	def _handle_github(self):	3✔
159	"""Handle exception and submit it as GitHub issue."""
160	value = click.prompt(	×
161	_BUG
162	+ click.style('1. Open an issue by typing "open";\n', fg=color.GREEN)
163	+ click.style("2. Print human-readable information by typing " '"print";\n', fg=color.YELLOW)
164	+ click.style(
165	"3. See the full traceback without submitting details " '(default: "ignore").\n\n', fg=color.RED
166	)
167	+ "Please select an action by typing its name",
168	type=click.Choice(["open", "print", "ignore"]),
169	default="ignore",
170	)
171	getattr(self, "_process_" + value)()	×
172
173	def _format_issue_title(self):	3✔
174	"""Return formatted title."""
175	return textwrap.shorten("cli: renku " + " ".join(sys.argv[1:]), width=50)	×
176
177	def _format_issue_body(self, limit=-5):	3✔
178	"""Return formatted body."""
179	from renku import __version__	×
180
181	re_paths = r"(" + r"\|".join([path or os.getcwd() for path in sys.path]) + r")"	×
182	tb = re.sub(re_paths, "[...]", traceback.format_exc(limit=limit))	×
183
184	return (	×
185	"## Describe the bug\nA clear and concise description.\n\n"
186	"## Details\n"
187	"Please verify and redact the details.\n\n"
188	"Renku version: " + __version__ + "\n"
189	"OS: " + platform.system() + " (" + platform.version() + ")\n"
190	"Python: " + platform.python_version() + "\n\n"
191	"### Traceback\n\n```\n" + tb + "```\n\n"
192	"## Additional context\nAdd any other context about the problem."
193	)
194
195	def _format_issue_url(self):	3✔
196	"""Format full issue URL."""
197	query = urlencode({"title": self._format_issue_title(), "body": self._format_issue_body()})	×
198	return self.REPO_URL + self.ISSUE_SUFFIX + "?" + query	×
199
200	def _process_open(self):	3✔
201	"""Open link in a browser."""
202	click.launch(self._format_issue_url())	×
203	if not click.confirm("Did it work?", default=True):	×
204	click.echo()	×
205	self._process_print()	×
206	click.secho("\nOpen the line manually and copy the text above\n", fg=color.YELLOW)	×
207	click.secho(" " + self.REPO_URL + self.ISSUE_SUFFIX + "\n", bold=True)	×
208
209	def _process_print(self):	3✔
210	"""Print link in a console."""
211	click.echo(self._format_issue_body(limit=None))	×
212
213	def _process_ignore(self):	3✔
214	"""Print original exception in a console."""
215	raise	×

SwissDataScienceCenter / renku-python / 7242391285

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous