Skip to content

System tests: Archive fieldcompare diff files on failure#740

Merged
MakisH merged 8 commits into
precice:developfrom
PranjalManhgaye:issue-441-archive-fieldcompare-diffs
May 14, 2026
Merged

System tests: Archive fieldcompare diff files on failure#740
MakisH merged 8 commits into
precice:developfrom
PranjalManhgaye:issue-441-archive-fieldcompare-diffs

Conversation

@PranjalManhgaye
Copy link
Copy Markdown
Contributor

@PranjalManhgaye PranjalManhgaye commented Mar 4, 2026

Summary

Implements #441: archive fieldcompare diff VTK files so they are easy to find in CI artifacts when a comparison fails.

Changes

  • tools/tests/systemtests/Systemtest.py: When fieldcompare fails, copy *diff*.vtu, *diff*.vtk, and *diff*.vtp files from precice-exports/ into a diff-results/ folder in the same run directory.
  • tools/tests/README.md: Document that diff files are copied into diff-results/ for inspection (e.g. in ParaView) when debugging comparison failures.

Checklist

  • I added a summary of any user-facing changes (compared to the last release) in the changelog-entries/441.md.
  • I will remember to squash-and-merge, providing a useful summary of the changes of this PR.

@MakisH MakisH added GSoC Contributed in the context of the Google Summer of Code systemtests labels Mar 6, 2026
@PranjalManhgaye PranjalManhgaye changed the title Archive fieldcompare diff files in fieldcompare-diffs/ (fixes #441) Archive fieldcompare diff files in fieldcompare-diffs/ only on failure (fixes #441) Mar 7, 2026
@PranjalManhgaye PranjalManhgaye changed the title Archive fieldcompare diff files in fieldcompare-diffs/ only on failure (fixes #441) Archive fieldcompare diff files in diff-results/ on failure (fixes #441) Mar 7, 2026
@PranjalManhgaye PranjalManhgaye force-pushed the issue-441-archive-fieldcompare-diffs branch from 44fb3ea to a904f4f Compare March 7, 2026 07:05
@precice-bot
Copy link
Copy Markdown
Collaborator

This pull request has been mentioned on preCICE Forum on Discourse. There might be relevant details there:

https://precice.discourse.group/t/gsoc-2026-pranjal-manhgaye/2769/6

@MakisH MakisH requested a review from Copilot May 12, 2026 21:29
@MakisH MakisH changed the title Archive fieldcompare diff files in diff-results/ on failure (fixes #441) System tests: Archive fieldcompare diff files in diff-results/ on failure May 12, 2026
@MakisH MakisH changed the title System tests: Archive fieldcompare diff files in diff-results/ on failure System tests: Archive fieldcompare diff files on failure May 12, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds automatic archiving of fieldcompare-generated VTK diff files into a dedicated folder to make CI artifact debugging easier when comparisons fail.

Changes:

  • Add logic to collect and copy *diff*.(vtu|vtk|vtp) files into diff-results/ when fieldcompare fails.
  • Invoke the archiving step during systemtest failure handling.
  • Document the new diff-results/ behavior in the systemtests README and add a changelog entry.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 6 comments.

File Description
tools/tests/systemtests/Systemtest.py Copies fieldcompare diff VTK files into diff-results/ on fieldcompare failure.
tools/tests/README.md Documents where to find diff VTK files in CI artifacts for debugging.
changelog-entries/441.md Notes the user-facing behavior change for archiving diff files.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread tools/tests/systemtests/Systemtest.py
Comment thread tools/tests/systemtests/Systemtest.py Outdated
Comment thread tools/tests/systemtests/Systemtest.py Outdated
Comment thread tools/tests/systemtests/Systemtest.py Outdated
Comment thread tools/tests/systemtests/Systemtest.py Outdated
Comment thread tools/tests/README.md Outdated
@MakisH
Copy link
Copy Markdown
Member

MakisH commented May 13, 2026

@PranjalManhgaye could you please have a look at the copilot comments in this PR?

PranjalManhgaye and others added 2 commits May 13, 2026 23:12
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Move DIFF_RESULTS_DIR below imports; archive with rglob and preserve
precice-exports/ paths under diff-results/; lazy debug log once after
copy; README clarifies archiving only runs on fieldcompare failure.
@PranjalManhgaye
Copy link
Copy Markdown
Contributor Author

yea i pushed an update that should cover the Copilot points (recursive copy under precice-exports/, paths preserved under diff-results/, README only on failure, constant + logging tidy‑ups) , could you take another look when you have time , thanks

@PranjalManhgaye PranjalManhgaye requested a review from MakisH May 13, 2026 18:25
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

Comment thread tools/tests/README.md Outdated
Comment thread tools/tests/systemtests/Systemtest.py
Comment thread tools/tests/systemtests/Systemtest.py
PranjalManhgaye and others added 2 commits May 14, 2026 11:13
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
Member

@MakisH MakisH left a comment

Choose a reason for hiding this comment

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

I tested this locally, and it works as expected. Thanks!

@MakisH MakisH merged commit cee5c67 into precice:develop May 14, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

GSoC Contributed in the context of the Google Summer of Code systemtests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants