[PSM Interop] Print the hint for the triager on blanket errors (#33898)
This clearly indicates which errors are "blanket" errors and are not a root cause on their own. This also moves the debug info with the last known status of an object the framework was waiting for, but bailed out due to a timeout. Previously it was printed as the last error message in the test, and this PR prints it after the stack trace that caused the test failure. In addition, I added a similar debug information to the "wait for NEGs to become healthy". Now it prints the statuses of unhealthy backends To achieve that, I mimicked upcoming [PEP 678](https://peps.python.org/pep-0678/) Exception notes feature. When we're upgrade to py11, we'll be able to remove `add_note()` methods, and get the same functionality for free.pull/34003/head
Sergii Tkachenko
2 years ago
committed by
GitHub
parent
1c0f5d32a0
commit
bc41f18beb
7 changed files with 242 additions and 70 deletions
@ -0,0 +1,58 @@ |
||||
# Copyright 2023 gRPC authors. |
||||
# |
||||
# 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. |
||||
from typing import Any |
||||
|
||||
|
||||
# TODO(sergiitk): All custom error classes should extend this. |
||||
class FrameworkError(Exception): |
||||
"""Base error class for framework errors.""" |
||||
|
||||
message: str |
||||
kwargs: dict[str, Any] |
||||
note: str = "" |
||||
|
||||
def __init__(self, message: str, *args, **kwargs): |
||||
self.message = message |
||||
# Exception only stores args. |
||||
self.kwargs = kwargs |
||||
# Pass to the Exception as if message is in **args. |
||||
super().__init__(*[message, *args]) |
||||
|
||||
# TODO(sergiitk): Remove in py3.11, this will be built-in. See PEP 678. |
||||
def add_note(self, note: str): |
||||
self.note = note |
||||
|
||||
def __str__(self): |
||||
return self.message if not self.note else f"{self.message}\n{self.note}" |
||||
|
||||
@classmethod |
||||
def note_blanket_error(cls, reason: str) -> str: |
||||
return f""" |
||||
Reason: {reason} |
||||
{'#' * 80} |
||||
# IMPORTANT: This is not a root cause. This is an indication that |
||||
# _something_ -- literally _anything_ -- has gone wrong in the xDS flow. |
||||
# It is _your_ responsibility to look through the interop client and/or |
||||
# server logs to determine what exactly went wrong. |
||||
{'#' * 80} |
||||
""" |
||||
|
||||
@classmethod |
||||
def note_blanket_error_info_below( |
||||
cls, reason: str, *, info_below: str |
||||
) -> str: |
||||
return ( |
||||
f"{cls.note_blanket_error(reason)}" |
||||
f"# Please inspect the information below:\n{info_below}" |
||||
) |
||||
Loading…
Reference in new issue