Skip to content

Move reference results metadata into each archive - #882

Merged
MakisH merged 7 commits into
precice:developfrom
PranjalManhgaye:issue-811-embed-reference-metadata
Aug 9, 2026
Merged

Move reference results metadata into each archive#882
MakisH merged 7 commits into
precice:developfrom
PranjalManhgaye:issue-811-embed-reference-metadata

Conversation

@PranjalManhgaye

@PranjalManhgaye PranjalManhgaye commented Jul 17, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Store reference-results-metadata.txt inside each archive's case directory

  • Stop writing one shared metadata file per tutorial

  • Drop the SHA256 checksum from the metadata (it described the outer .tar.gz, which no longer makes sense once the file lives inside that archive)

  • Ignore the embedded metadata during field comparison

  • Rename the metadata file to reference-results-metadata.txt so editors open it as plain text

  • Update the system-test documentation

Closes #811

Test Plan

Packed sample archives locally and verified reference-results-metadata.txt ends up inside each case folder, with exports and iteration logs unchanged, and no shared metadata file written anymore. Also verified fieldcompare ignores the metadata file, and ran pre-commit on the changed files. Full regeneration of reference archives happens after merge, as discussed.

Store generation metadata inside each archive's case directory instead
of writing one shared file per tutorial.
@PranjalManhgaye PranjalManhgaye changed the title Embed metadata in each reference results archive Move reference results metadata into each archive Jul 17, 2026
Comment thread tools/tests/docker-compose.field_compare.template.yaml Outdated
Comment thread tools/tests/reference-results-metadata.txt.template
Comment thread tools/tests/generate_reference_results.py
Rename the per-archive metadata file to reference-results-metadata.txt
and add --ignore-missing-source-files so fieldcompare does not fail on
the metadata when comparing against regenerated archives.
@PranjalManhgaye
PranjalManhgaye requested a review from MakisH July 18, 2026 08:48
MakisH and others added 3 commits July 18, 2026 20:58
Replace --ignore-missing-source-files with --exclude-files
reference-results-metadata.txt so only the embedded metadata is
skipped and missing timesteps still fail comparison.

@MakisH MakisH left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. I would further simplify and polish the template, but I can directly do that in a separate PR.

@MakisH
MakisH merged commit b8cbf76 into precice:develop Aug 9, 2026
2 checks passed
@github-project-automation github-project-automation Bot moved this from Needs review to Done in GSoC 2026: System tests improvements Aug 9, 2026
@MakisH

MakisH commented Aug 10, 2026

Copy link
Copy Markdown
Member

The system tests are now failing, complaining about the fieldcompare option:

#8 resolving provenance for metadata file
#8 DONE 0.0s
[stderr]  Image breaking-dam-2d_fluid-openfoam-solid-calculix_2026-08-10-035105-field-compare Built 
[stderr] time="2026-08-10T03:51:43+02:00" level=warning msg="Found orphan containers (breaking-dam-2d_fluid-openfoam-solid-calculix_2026-08-10-035105-solid-calculix-1, breaking-dam-2d_fluid-openfoam-solid-calculix_2026-08-10-035105-fluid-openfoam-1, breaking-dam-2d_fluid-openfoam-solid-calculix_2026-08-10-035105-prepare-1) for this project. If you removed or renamed this service in your compose file, you can run this command with the --remove-orphans flag to clean it up."
[stderr]  Container breaking-dam-2d_fluid-openfoam-solid-calculix_2026-08-10-035105-field-compare-1 Creating 
[stderr]  Container breaking-dam-2d_fluid-openfoam-solid-calculix_2026-08-10-035105-field-compare-1 Created 
Attaching to field-compare-1
[stderr]  Container breaking-dam-2d_fluid-openfoam-solid-calculix_2026-08-10-035105-field-compare-1 Starting 
[stderr]  Container breaking-dam-2d_fluid-openfoam-solid-calculix_2026-08-10-035105-field-compare-1 Started 
[stderr] field-compare-1  | usage: fieldcompare [-h] [--version] {file,dir} ...
[stderr] field-compare-1  | fieldcompare: error: unrecognized arguments: --exclude-files reference-results-metadata.txt --ignore-unsupported-file-formats

I did not expect this to fail, but it looks like the fieldcompare version we use is too old: https://github.com/dglaeser/fieldcompare-action

I will contribute upstream. -> dglaeser/fieldcompare-action#15

edit: Since this is anyway trivial, I dropped the dependency in #895

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Development

Successfully merging this pull request may close these issues.

reference_results.metadata is outside the respective archive

2 participants