Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): adding test run events CSV dabatase #2248

Merged
merged 6 commits into from
Mar 28, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
39 changes: 39 additions & 0 deletions TEST_RUN_EVENTS.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
Test Run Events,,,
,,,
EVENT_SUFFIX,Description,,
_INFO,Adding extra context for an specific task,,
_SUCCESS,The task has finalized with no errors,,
_ERROR,An execution problem was found,,
_START,A new task section has begun,,
,,,
,,,
,,,
,,,
,,,
Stage ,Event Type,Description,Definition
Trigger,CREATED_INFO,Trigger Run has been created,
Trigger,RESOLVE_ERROR,Resolving trigger details failed,
Trigger,RESOLVE_SUCCESS,Successful resolving of trigger details,
Trigger,RESOLVE_START,Resolving trigger details based on environment variables,
Trigger,EXECUTION_START,Initial trigger execution,
Trigger,EXECUTION_SUCCESS,Successful trigger execution,
Trigger,HTTP_UNREACHABLE_HOST_ERROR,Tracetest could not reach the defined host in the trigger,
Trigger,DOCKER_COMPOSE_HOST_MISMATCH_ERROR,"We identified Tracetest is running inside a docker compose container, so if you are trying to access your local host machine please use the host.docker.internal hostname. For more information, see https://docs.docker.com/docker-for-mac/networking/#use-cases-and-workarounds",
Trigger,GRPC_UNREACHABLE_HOST_ERROR,Tracetest could not reach the defined host in the trigger,
Trace,FETCHING_START,Starting the trace fetching process,
Trace,QUEUED_INFO,Trace Run has been queued to start the fetching process,
Trace,DATA_STORE_CONNECTION_INFO,A Data store connection request has been executed,test connection result information
Trace,POLLING_START,Starting the trace polling process,
Trace,POLLING_ITERATION_INFO,A polling iteration has been executed,# of spans - iteration # - reason of next iteration
Trace,POLLING_SUCCESS,The polling strategy has succeeded in fetching the trace from the Data Store,
Trace,POLLING_ERROR,The polling strategy has failed to fetch the trace,
Trace,FETCHING_SUCCESS,The trace was successfully processed by the backend,
Trace,FETCHING_ERROR,The trace was not able to be fetched,
Trace,STOPPED_INFO,The test run was stopped during its execution,
Test,OUTPUT_GENERATION_WARNING,The value for output <output_name> could not be generated,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the output is not generated, should this be a warning or an error? Today we keep executing the test because we don't have any way of showing the user why the test failed, but with this event system, it would be possible to halt the test and say "output X could not be generated: " and mark the test as failed.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a great point, I was thinking about the same. I'll add a ticket to the epic for Test error handling improvements as we are only covering trigger and trace, I would say that the run shouldn't be stopped tho, just having some warning or error signs around the outputs that failed. what do you think @kdhamric?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This and everything regarding the Test section will be considered as follow-ups as we need to focus on trigger and trace for the moment.

#2256
#2257

Test,RESOLVE_START,Resolving test specs details start,
Test,RESOLVE_SUCCESS,Resolving test specs details success,
Test,RESOLVE_ERROR,An error ocurred while parsing the test specs,
Test,TEST_SPECS_RUN_SUCCESS,Test Specs were successfully executed,
Test,TEST_SPECS_RUN_ERROR,Test specs execution error,
Test,TEST_SPECS_RUN_START,Test specs execution start,