Include root cause when using DataTable.asList and friends #2949
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mpkorstanje
force-pushed
the
fix-include-datatable-list--root-cause
branch
from
af9ae79 to
eee33ab
Compare
The `CucumberInvocationTargetException` was originally designed to be used as a wrapper around `InvocationTargetException` to track the step definition that caused the exception. The cause of `InvocationTargetException` would then be rewritten to appear to have originated from the step definition. This would effectively hide the whole backend from view. Unfortunately using DataTable.asList inside a step, this also invokes the backend. And because `CucumberInvocationTargetException` did not have cause, the cause of any exceptions would also be hidden. By exposing the cause of the `InvocationTargetException` as the cause of the `CucumberInvocationTargetException` and removing any frames before the step definition was invoked we can clean this up somewhat. ```log io.cucumber.datatable.CucumberDataTableException: 'java.util.List<io.cucumber.skeleton.StepDefinitions$Ingredient>' could not transform | NAME | QUANTITY | UNITS | | Flour | 1 | KG | | Water | 0.65 | L | | Salt | 0.08 | KG | at io.cucumber.datatable.DataTableType.transform(DataTableType.java:158) at io.cucumber.datatable.DataTableTypeRegistryTableConverter.toListOrProblems(DataTableTypeRegistryTableConverter.java:158) at io.cucumber.datatable.DataTableTypeRegistryTableConverter.toList(DataTableTypeRegistryTableConverter.java:139) at io.cucumber.datatable.DataTable.asList(DataTable.java:199) at io.cucumber.skeleton.StepDefinitions.i_wait_hour(StepDefinitions.java:40) at ✽.I mix the following ingredients(classpath:io/cucumber/skeleton/belly.feature:6) Caused by: io.cucumber.core.backend.CucumberInvocationTargetException at io.cucumber.java.Invoker.doInvoke(Invoker.java:73) at io.cucumber.java.Invoker.invoke(Invoker.java:24) at io.cucumber.java.AbstractGlueDefinition.invokeMethod(AbstractGlueDefinition.java:47) at io.cucumber.java.JavaDataTableTypeDefinition.lambda$createDataTableType$2(JavaDataTableTypeDefinition.java:47) at io.cucumber.datatable.DataTableType$TableEntryTransformerAdaptor.transform(DataTableType.java:342) at io.cucumber.datatable.DataTableType$TableEntryTransformerAdaptor.transform(DataTableType.java:319) at io.cucumber.datatable.DataTableType.transform(DataTableType.java:155) ... 5 more Caused by: java.lang.IllegalArgumentException: This message is never shown during test execution at io.cucumber.skeleton.StepDefinitions.mySystemEntry(StepDefinitions.java:29) at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method) at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:77) at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) at java.base/java.lang.reflect.Method.invoke(Method.java:568) at io.cucumber.java.Invoker.doInvoke(Invoker.java:66) ... 11 more ``` Unfortunately, it is not possible to remove the `CucumberInvocationTargetException` entirely. Fixes: #2948
mpkorstanje
force-pushed
the
fix-include-datatable-list--root-cause
branch
from
eee33ab to
79f1cf9
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🤔 What's changed?
The
CucumberInvocationTargetExceptionwas originally designed to be used as a wrapper aroundInvocationTargetExceptionto track the step definition that caused the exception. The cause ofInvocationTargetExceptionwould then be rewritten to appear to have originated from the step definition. This would effectively hide the whole backend from view.Unfortunately using DataTable.asList inside a step, this also invokes the backend. And because
CucumberInvocationTargetExceptiondid not have cause, the cause of any exceptions would also be hidden.By exposing the cause of the
InvocationTargetExceptionas the cause of theCucumberInvocationTargetExceptionand removing any frames before the step definition was invoked we can clean this up somewhat.Unfortunately, it is not possible to remove the
CucumberInvocationTargetExceptionentirely.⚡️ What's your motivation?
Fixes: #2948
🏷️ What kind of change is this?
♻️ Anything particular you want feedback on?
@jean-michel-gonet do think this stack trace is something the tester you are working with can understand?
📋 Checklist: