Add testing for error trace attributes. (#217)

* Add testing for error trace attributes.

* Correct usage of attribute validators.

* Add exact_attrs to more validators

* Correct testing logic

Author: TimPansino

tests/agent_features/test_ignore_expected_errors.py

@@ -23,13 +23,14 @@
 from newrelic.common.object_names import callable_name
 
 from testing_support.fixtures import (
-    reset_core_stats_engine,
-    validate_transaction_errors,
     override_application_settings,
+    reset_core_stats_engine,
+    validate_error_event_attributes_outside_transaction,
     validate_error_event_sample_data,
+    validate_error_trace_attributes_outside_transaction,
+    validate_transaction_error_trace_attributes,
+    validate_transaction_errors,
     validate_transaction_metrics,
-    validate_transaction_error_event_count,
-    validate_error_event_attributes_outside_transaction,
 )
 
 
@@ -158,6 +159,70 @@ def _test():
     _test()
 
 
+# =============== Test error trace attributes ===============
+
+
+error_trace_settings_matrix = [
+    ({}, False),
+    (expected_runtime_error_settings, True),
+]
+override_expected_matrix = (True, False, None)
+
+
+@pytest.mark.parametrize("settings,expected", error_trace_settings_matrix)
+@pytest.mark.parametrize("override_expected", override_expected_matrix)
+def test_error_trace_attributes_inside_transaction(
+    settings, expected, override_expected
+):
+    expected = override_expected if override_expected is not None else expected
+
+    error_trace_attributes = {
+        "intrinsic": {
+            "error.expected": expected,
+        },
+        "agent": {},
+        "user": {},
+    }
+
+    @validate_transaction_error_trace_attributes(exact_attrs=error_trace_attributes)
+    @background_task(name="test")
+    @override_application_settings(settings)
+    def _test():
+        exercise(override_expected)
+
+    _test()
+
+
+@pytest.mark.parametrize("settings,expected", error_trace_settings_matrix)
+@pytest.mark.parametrize("override_expected", override_expected_matrix)
+def test_error_trace_attributes_outside_transaction(
+    settings, expected, override_expected
+):
+    expected = override_expected if override_expected is not None else expected
+
+    error_trace_attributes = {
+        "intrinsic": {
+            "error.class": _runtime_error_name,
+            "error.message": _error_message,
+            "error.expected": expected,
+            "transactionName": None,
+        },
+        "agent": {},
+        "user": {},
+    }
+
+    @reset_core_stats_engine()
+    @validate_error_trace_attributes_outside_transaction(
+        _runtime_error_name,
+        exact_attrs=error_trace_attributes
+    )
+    @override_application_settings(settings)
+    def _test():
+        exercise(override_expected)
+
+    _test()
+
+
 # =============== Test metrics not incremented ===============
 
 
@@ -415,4 +480,3 @@ def _test():
         exercise(**kwargs)
 
     _test()
-

tests/testing_support/fixtures.py

@@ -1158,7 +1158,7 @@ def wrapper(wrapped, instance, args, kwargs):
 
 
 def validate_transaction_error_trace_attributes(required_params={},
-        forgone_params={}):
+        forgone_params={}, exact_attrs={}):
     """Check the error trace for attributes, expect only one error to be
     present in the transaction.
     """
@@ -1178,15 +1178,15 @@ def _validate_transaction_error_trace(wrapped, instance, args, kwargs):
             traced_error = error_data[0]
 
             check_error_attributes(traced_error.parameters, required_params,
-                    forgone_params, is_transaction=True)
+                    forgone_params, exact_attrs, is_transaction=True)
 
         return result
 
     return _validate_transaction_error_trace
 
 
 def check_error_attributes(parameters, required_params={}, forgone_params={},
-        is_transaction=True):
+        exact_attrs={}, is_transaction=True):
 
     parameter_fields = ['userAttributes']
     if is_transaction:
@@ -1202,10 +1202,10 @@ def check_error_attributes(parameters, required_params={}, forgone_params={},
     assert 'request_params' not in parameters
     assert 'request_uri' not in parameters
 
-    check_attributes(parameters, required_params, forgone_params)
+    check_attributes(parameters, required_params, forgone_params, exact_attrs)
 
 
-def check_attributes(parameters, required_params={}, forgone_params={}):
+def check_attributes(parameters, required_params={}, forgone_params={}, exact_attrs={}):
     if required_params:
         for param in required_params['agent']:
             assert param in parameters['agentAttributes']
@@ -1223,6 +1223,17 @@ def check_attributes(parameters, required_params={}, forgone_params={}):
         for param in forgone_params['user']:
             assert param not in parameters['userAttributes']
 
+    if exact_attrs:
+        for param, value in exact_attrs['agent'].items():
+            assert parameters['agentAttributes'][param] == value, (
+                    (param, value), parameters['agentAttributes'])
+        for param, value in exact_attrs['user'].items():
+            assert parameters['userAttributes'][param] == value, (
+                    (param, value), parameters['userAttributes'])
+        for param, value in exact_attrs['intrinsic'].items():
+            assert parameters['intrinsics'][param] == value, (
+                    (param, value), parameters['intrinsics'])
+
 
 def validate_error_trace_collector_json():
     @transient_function_wrapper('newrelic.core.stats_engine',
@@ -1605,7 +1616,7 @@ def _validate_error_event_attributes(wrapped, instance, args, kwargs):
 
 
 def validate_error_trace_attributes_outside_transaction(err_name,
-        required_params={}, forgone_params={}):
+        required_params={}, forgone_params={}, exact_attrs={}):
     @transient_function_wrapper('newrelic.core.stats_engine',
             'StatsEngine.notice_error')
     def _validate_error_trace_attributes_outside_transaction(wrapped, instance,
@@ -1618,7 +1629,7 @@ def _validate_error_trace_attributes_outside_transaction(wrapped, instance,
             target_error = core_application_stats_engine_error(err_name)
 
             check_error_attributes(target_error.parameters, required_params,
-                    forgone_params, is_transaction=False)
+                    forgone_params, exact_attrs, is_transaction=False)
 
         return result