From 0b393516ceaa03b6df58919a726c3388eefa125f Mon Sep 17 00:00:00 2001 From: Alex Lopez Date: Mon, 12 Jun 2023 14:51:55 +0200 Subject: [PATCH] Rename raw_error -> rawerror to use correct field name --- .../datadog_checks/base/utils/diagnose.py | 22 +++++++++---------- .../tests/base/utils/test_diagnose.py | 6 ++--- 2 files changed, 13 insertions(+), 15 deletions(-) diff --git a/datadog_checks_base/datadog_checks/base/utils/diagnose.py b/datadog_checks_base/datadog_checks/base/utils/diagnose.py index 7f33269f12012..5345262a64b4e 100644 --- a/datadog_checks_base/datadog_checks/base/utils/diagnose.py +++ b/datadog_checks_base/datadog_checks/base/utils/diagnose.py @@ -35,9 +35,7 @@ class Diagnosis: # RawError error # } # defined in datadog-agent\\pkg\\diagnose\\diagnosis\\loader.go - Result = namedtuple( - 'Result', ['result', 'name', 'diagnosis', 'category', 'description', 'remediation', 'raw_error'] - ) + Result = namedtuple('Result', ['result', 'name', 'diagnosis', 'category', 'description', 'remediation', 'rawerror']) # defined in # datadog-agent\\pkg\\diagnose\\diagnosis\\loader.go and @@ -63,7 +61,7 @@ def clear(self): """Remove all cached diagnoses.""" self._diagnoses = [] - def success(self, name, diagnosis, category=None, description=None, remediation=None, raw_error=None): + def success(self, name, diagnosis, category=None, description=None, remediation=None, rawerror=None): """Register a successful diagnostic result.""" self._diagnoses.append( self._result( @@ -73,11 +71,11 @@ def success(self, name, diagnosis, category=None, description=None, remediation= category=category, description=description, remediation=remediation, - raw_error=raw_error, + rawerror=rawerror, ) ) - def fail(self, name, diagnosis, category=None, description=None, remediation=None, raw_error=None): + def fail(self, name, diagnosis, category=None, description=None, remediation=None, rawerror=None): """Register a failing diagnostic result.""" self._diagnoses.append( self._result( @@ -87,11 +85,11 @@ def fail(self, name, diagnosis, category=None, description=None, remediation=Non category=category, description=description, remediation=remediation, - raw_error=raw_error, + rawerror=rawerror, ) ) - def warning(self, name, diagnosis, category=None, description=None, remediation=None, raw_error=None): + def warning(self, name, diagnosis, category=None, description=None, remediation=None, rawerror=None): """Register a warning for a diagnostic result.""" self._diagnoses.append( self._result( @@ -101,7 +99,7 @@ def warning(self, name, diagnosis, category=None, description=None, remediation= category=category, description=description, remediation=remediation, - raw_error=raw_error, + rawerror=rawerror, ) ) @@ -126,7 +124,7 @@ def run_explicit(self): try: diagnostic() except Exception as e: - self._diagnoses.append(self._result(self.DIAGNOSIS_UNEXPECTED_ERROR, "", "", raw_error=str(e))) + self._diagnoses.append(self._result(self.DIAGNOSIS_UNEXPECTED_ERROR, "", "", rawerror=str(e))) explicit_results, self._diagnoses = self._diagnoses, cached_results return explicit_results @@ -136,7 +134,7 @@ def diagnoses(self): """The list of cached diagnostics.""" return self._diagnoses - def _result(self, result, name, diagnosis, category=None, description=None, remediation=None, raw_error=None): + def _result(self, result, name, diagnosis, category=None, description=None, remediation=None, rawerror=None): return self.Result( result, name, @@ -144,5 +142,5 @@ def _result(self, result, name, diagnosis, category=None, description=None, reme category, self._sanitize(description), self._sanitize(remediation), - self._sanitize(raw_error), + self._sanitize(rawerror), ) diff --git a/datadog_checks_base/tests/base/utils/test_diagnose.py b/datadog_checks_base/tests/base/utils/test_diagnose.py index 337052a69c54c..575279007e58e 100644 --- a/datadog_checks_base/tests/base/utils/test_diagnose.py +++ b/datadog_checks_base/tests/base/utils/test_diagnose.py @@ -135,7 +135,7 @@ def bad_diagnostic(self): "category": None, "description": "something's wrong with your ********", "remediation": "change your ******** to something else", - "raw_error": None, + "rawerror": None, } assert get_diagnoses(check) == [ @@ -153,7 +153,7 @@ def get_diagnoses(check): return json.loads(check.get_diagnoses()) -def diagnose_dict(result, name, diagnosis, category=None, description=None, remediation=None, raw_error=None): +def diagnose_dict(result, name, diagnosis, category=None, description=None, remediation=None, rawerror=None): """Helper function to create diagnosis result dictionaries with defaults.""" return { "result": result, @@ -162,5 +162,5 @@ def diagnose_dict(result, name, diagnosis, category=None, description=None, reme "category": category, "description": description, "remediation": remediation, - "raw_error": raw_error, + "rawerror": rawerror, }