feat: create a script to obtain the status of the simulation

[Namyalg]

Pull Request Template

Description

The existing endpoints for the gcbm example do not report a failure in the simulation.
The script simulation-status.py returns the logs of the docker container (if it is running).
This can be used in the process of automated testing

To obtain the logs of the simulation :

1. Start the simulation
2. Run the script simulation-status.py , a text file containing the logs will be created

Fixes #93

Type of change

Please delete options that are not relevant.

• New feature (non-breaking change which adds functionality)

[aornugent]

I think in order to make this an integration test, we need to publish a reference to compare against. Can you add the scaffolding to save the results and compare with another file of the same schema? Then we check the reference into version control and monitor change from there.

This does not tell us whether the results are numerically identical, which is considered the holy grail in integration tests.

[Namyalg]

A quick demonstration on how the script can be used

logs.mp4

[Namyalg]

Logs from a successful simulation :

docker_logs.txt

[aornugent]

@radistoubalidis - could you use this script in your CML Action?

@Namyalg - if it weren't for the timestamps, we would be able to use the hash of these logs as a reference. Are timestamps included in the console output when you run the simulation inside the container interactively? Or are they part of th Docker output?

[radistoubalidis]

@radistoubalidis - could you use this script in your CML Action?

@Namyalg - if it weren't for the timestamps, we would be able to use the hash of these logs as a reference. Are timestamps included in the console output when you run the simulation inside the container interactively? Or are they part of th Docker output?

I just added it to my action here , the only issue is a haven't yet managed to run the whole workflow inside actions so for now, I made it use the results from a sim I run locally.

[Namyalg]

The timestamp can be removed, I'll process it such that only

@radistoubalidis - could you use this script in your CML Action?

@Namyalg - if it weren't for the timestamps, we would be able to use the hash of these logs as a reference. Are timestamps included in the console output when you run the simulation inside the container interactively? Or are they part of th Docker output?

Yes, this can be removed, I'll process it in such a way that <2022-06-08 00:16:24.906554> (info) - Config has files: 7 will be stored as Config has files: 7

To identify the simulation uniquely, how about appending the end of the file with a randomly generated string?

[radistoubalidis]

I managed to add the python script to my simulation results and retrieve the log file

[aornugent]

@Namyalg - can you please remind me if this is ready to merge? Do you have permissions to do so?

[Namyalg]

Yes @aornugent, I tested the script again, it works as expected -> retrieve the logs of a container running the simulation
It is ready for merge.