Some issues I ran into during deployment.
I hope this information can help improve the documentation. Some of these maybe just I need to be confirmed that I am doing the right thing. Please correct me if I misunderstand anything.
- I used the docker image then I realized I have to mount a local folder which contains data files(e.g. build.ini, runconfig.ini…). I have to edited cibuglog-docker-run to do that. If I am doing the right thing then it would be nice to state that in the doc.
- Doc Line 214 build.ini example. The parameter and comment cannot be at the same line. This could be a bug. I use the example from the doc and I got an error. ValueError: Could not find the object named 'IGT # Component or Testsuite name' in <class 'CIResults.models.Component'>. Please create it first!
- Line 261 “hierarchy:
runconfig/
testsuite/machine/
shard_id/{result files}” In the beginning I am not sure what $shard_id means and at line 326 there is another example which makes me think this is a string. But turn out it has to be a number otherwise the code will raise an error. Now I understand this is kind of a test run id. - Same line the results files has to be named “results.xml/json” otherwise it doesn’t load. It would be nice to have this info in the doc.
- Line 310 “If you want to add test suite run results, you will also need to add the 'results' parameter which point to a file containing the list of results to import”. I cannot make this work by create an extra file. Not sure what am I missing.
- Line 312 “or '-' if you want to read this from stdin.” I am confused how to enter the test result via stdin.
- To allow people to try out my docker instance I need to edit CIBUGLOG_HOST=my_public_IP. It would be nice we can mention it in the doc.
- What is the benefit run cibuglog as a service instead of a docker container?
- It would be nice to explain the relationship between build, runconfig and component. Correct me if I am wrong. My understanding is:
- A runconfig can have multiple build of different components but not multiple build of the same component.
- A runconfig can have same test suite but runs on different test machines. If I use below folder structure I can use “./add_run.py runconfig“ to load all results at once. The test result in 01 and 02 are for the same build and same runconfig. In this case how can I tell which test result is from which test run on the GUI?(Maybe this is not a good practice the test run id should be unique all the time )
E.g.: /rungconfig/IGT/m1/01/results.json
| |-/02/results.json
|
|-/m2/01/results.json
|-/02/results.json