change flag name

Author: ian-sift

python/lib/sift_client/_tests/util/test_test_results_utils.py

@@ -386,7 +386,7 @@ def test_bad_assert(self, report_context, step):
                     "Has a bad assert and shows assertion errors. Pytest util should mark this as error.",
                 ) as nested_substep_2_context:
                     nested_substep_2 = nested_substep_2_context.current_step
-                    nested_substep_2_context.show_assertion_errors = True
+                    nested_substep_2_context.assertion_as_fail_not_error = True
                     nested_substep_2_context.force_result = True
                     assert False == True
                 with substep_context.substep(

python/lib/sift_client/util/test_results/context_manager.py

@@ -95,11 +95,14 @@ def __exit__(self, exc_type, exc_value, traceback):
         return True
 
     def new_step(
-        self, name: str, description: str | None = None, show_assertion_errors: bool = True
+        self, name: str, description: str | None = None, assertion_as_fail_not_error: bool = True
     ) -> NewStep:
         """Alias to return a new step context manager from this report context. Use create_step for actually creating a TestStep in the current context."""
         return NewStep(
-            self, name=name, description=description, show_assertion_errors=show_assertion_errors
+            self,
+            name=name,
+            description=description,
+            assertion_as_fail_not_error=assertion_as_fail_not_error,
         )
 
     def get_next_step_path(self) -> str:
@@ -195,28 +198,28 @@ class NewStep(AbstractContextManager):
 
     report_context: ReportContext
     client: SiftClient
-    show_assertion_errors: bool = True
+    assertion_as_fail_not_error: bool = True
     current_step: TestStep | None = None
 
     def __init__(
         self,
         report_context: ReportContext,
         name: str,
         description: str | None = None,
-        show_assertion_errors: bool = True,
+        assertion_as_fail_not_error: bool = True,
     ):
         """Initialize a new step context.
 
         Args:
             report_context: The report context to create the step in.
             name: The name of the step.
             description: The description of the step.
-            show_assertion_errors: Whether to show assertion errors in the step (exists because users don't want to see them when using pytest).
+            assertion_as_fail_not_error: Mark steps with assertion errors as failed instead of error+traceback (some users want assertions to work as simple failures especially when using pytest).
         """
         self.report_context = report_context
         self.client = report_context.report.client
         self.current_step = self.report_context.create_step(name, description)
-        self.show_assertion_errors = show_assertion_errors
+        self.assertion_as_fail_not_error = assertion_as_fail_not_error
 
     def __enter__(self):
         """Enter the context manager to create a new step.
@@ -243,7 +246,7 @@ def update_step_from_result(
         error_info = None
         assert self.current_step is not None
         if exc:
-            if isinstance(exc_value, AssertionError) and not self.show_assertion_errors:
+            if isinstance(exc_value, AssertionError) and not self.assertion_as_fail_not_error:
                 # If we're not showing assertion errors (i.e. pytest), mark step as failed but don't set error info.
                 self.report_context.record_step_outcome(False, self.current_step)
             else:
@@ -435,5 +438,7 @@ def report_outcome(self, name: str, result: bool, reason: str | None = None) ->
     def substep(self, name: str, description: str | None = None) -> NewStep:
         """Alias to return a new step context manager from the current step. The ReportContext will manage nesting of steps."""
         return self.report_context.new_step(
-            name=name, description=description, show_assertion_errors=self.show_assertion_errors
+            name=name,
+            description=description,
+            assertion_as_fail_not_error=self.assertion_as_fail_not_error,
         )

python/lib/sift_client/util/test_results/pytest_util.py

@@ -64,7 +64,7 @@ def _step_impl(
     name = str(request.node.name)
     existing_docstring = request.node.obj.__doc__ or None
     with report_context.new_step(
-        name=name, description=existing_docstring, show_assertion_errors=False
+        name=name, description=existing_docstring, assertion_as_fail_not_error=False
     ) as new_step:
         yield new_step
         if hasattr(request.node, "rep_call") and request.node.rep_call.excinfo: