chore(docs): adding test run events CSV dabatase #2248
Conversation
| 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, |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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?
TEST_RUN_EVENTS.csv
Outdated
| Stage ,Event Type,Description,Definition | ||
| Trigger,CREATED_INFO,Trigger Run has been created, | ||
| Trigger,RESOLVE_ERROR,Resolving trigger details failed, | ||
| Trigger,RESOLVE_SUCCESS,Resolving trigger details failed, |
There was a problem hiding this comment.
Should this be:
Trigger,RESOLVE_SUCCESS,Successful resolving of trigger details,
TEST_RUN_EVENTS.csv
Outdated
| 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 in docker compose, to connect to the host machine use the `host.docker.internal` hostname. For more information see https://docs.docker.com/docker-for-mac/networking/#use-cases-and-workarounds", |
There was a problem hiding this comment.
Trigger,DOCKER_COMPOSE_HOST_MISMATCH_ERROR,"We identified Tracetest is running in docker compose, so if 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",
TEST_RUN_EVENTS.csv
Outdated
| 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 to fetch the trace from the Data Store, |
There was a problem hiding this comment.
Trace,POLLING_SUCCESS,The polling strategy has succeeded in fetching the trace from the Data Store,
TEST_RUN_EVENTS.csv
Outdated
| 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 in docker compose, so if 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", |
There was a problem hiding this comment.
| Trigger,DOCKER_COMPOSE_HOST_MISMATCH_ERROR,"We identified Tracetest is running in docker compose, so if 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,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", | |
This PR adds the initial list of events triggered by the test run, this will allow clients to hook up into the events to display live information to users to have better feedback on what is happening.
Changes
Fixes
Checklist