etf-validator / etf-webapp

:earth_africa: :mag: ETF is an open source testing framework for spatial data and services
https://www.etf-validator.net
European Union Public License 1.2
18 stars 19 forks source link

Documentation for /v2/TestRuns/{id}/progress #137

Closed heidivanparys closed 6 years ago

heidivanparys commented 6 years ago

Would it be possible to provide more documentation about this method and how to use parameter "pos" and the "val" and "max" from the response?

The documentation says "the number of executed and remaining Test Steps", how does this relate to "val" and "max"?

It seems that the following logic works:

boolean isFinished = val < max ? false : true;
cportele commented 6 years ago

That is correct. If you click on "Model" (instead of "Example Value") you will see:

log (Array[string], optional): Log messages ,
max (string, optional): Maximum number of Test Steps ,
val (string, optional): Completed Test Steps

max is the total number of test steps in all the test suites of the test run and val is the number of those test steps that have been completed. Do you have any recommendations of what should be added to the documentation?

heidivanparys commented 6 years ago

Ok, I didn't notice the "Model" links until now, I only looked at the example values so far, the documentation there is helpful of course.

I would suggest the following in the Implementation Notes: "Retrieve one Test Run status including log messages, the maximum number of Test Steps and the number of already executed TestSteps at the time of the request".

image

How is the maximum number of test steps calculated? Because it seems that this value is not necessarily a constant in the course of one test run:

image

etfclient.log etf-webapp.log

cportele commented 6 years ago

Thanks, Heidi. @jonherrmann, can you have a look? Probably we should rather say "estimated total number of Test Steps".

Regarding the increasing number of test steps: In service tests this is normal. For example, you know how many feature types you have to test only after you have analysed the capabilities. Additional test steps are created for testing each feature type.