tutorials icon indicating copy to clipboard operation
tutorials copied to clipboard

Contents of the system tests archive

Open MakisH opened this issue 9 months ago • 2 comments

Example of the contents of an archive:

Screenshot from 2023-11-19 21-48-16

I think we still need some changes:

  • [x] reference_results and reference-data seems to be confusing (which is what?). One of them needs to be renamed, maybe to results_to_compare.
  • [x] What is the tutorials_ref? It currently contains master, but in that job, I had asked for develop (see #399).
  • [x] The actual git commits of each repository are not reported anywhere. See https://github.com/precice/tutorials/issues/401
  • [x] Do we need the metadata.yaml, docker-compose.tutorial.yaml, and docker-compose.field_compare.yaml? Are they only useful for debugging the system tests themselves? I would suggest to either delete them, or move them to a subfolder (e.g., system-tests-debug).

cc @valentin-seitz

MakisH avatar Nov 19 '23 21:11 MakisH

* [ ]  Do we need the `metadata.yaml`, `docker-compose.tutorial.yaml`, and `docker-compose.field_compare.yaml`? Are they only useful for debugging the system tests themselves? I would suggest to either delete them, or move them to a subfolder (e.g., `system-tests-debug`).

One of the big benefits of using containers is, that its very easy to "debug" a problem with a precice component, without having to install all of them manually. So having the docker-compose.tutorial.yaml and the fieldcompare.yaml is a crucial step in reproducing the failed pipeline in your local machine. So i would def. keep them around. A related Issue is: #387 where we need to move some absolute paths into relative ones to allow this "debug the pipeline in your local machine" feature.

valentin-seitz avatar Nov 25 '23 16:11 valentin-seitz

Then, let's focus on what is currently not included (or how it is named), and remove stuff later.

MakisH avatar Nov 27 '23 15:11 MakisH