Skip to content

Split the system tests log file into stages#801

Open
PranjalManhgaye wants to merge 8 commits into
precice:developfrom
PranjalManhgaye:issue-790-system-tests-logs
Open

Split the system tests log file into stages#801
PranjalManhgaye wants to merge 8 commits into
precice:developfrom
PranjalManhgaye:issue-790-system-tests-logs

Conversation

@PranjalManhgaye
Copy link
Copy Markdown
Collaborator

Description

Fixes #790.
Right now, system-tests-stdout.log and system-tests-stderr.log only appear after a test finishes, which makes it hard to inspect failures during long Docker builds or solver runs.
This PR changes the logging so output is written to disk while the test is running. The existing combined logs are still kept, but there are now also separate phase logs:

  • system-tests-build.log
  • system-tests-solver.log
  • system-tests-fieldcompare.log

Scope: 4 files only (~350 LOC). No tutorial or reference-result changes.
Largest change: streaming Docker output in Systemtest.py (replaces communicate() buffering).
I also cleaned up the console output a bit:

  • [n/m] progress prefix
  • less noisy logging (INFO: removed)
  • clearer grouping/banners
  • PASS / FAIL markers on TTY
    The PR is split into 4 commits so the logging change can be reviewed separately from the console formatting cleanup.

Checklist

  • I added a summary of any user-facing changes (compared to the last release) in the changelog-entries/<PRnumber>.md.
  • New tutorial case (e.g., new fluid-openfoam folder for existing tutorial)? Add it to the respective README.md.
  • New tutorial? Update the website.

Resources

Write build, solver, and fieldcompare output incrementally to
system-tests-stdout.log and system-tests-stderr.log, and add phase
logs (system-tests-build.log, -solver.log, -fieldcompare.log) so
failures can be debugged before a test finishes. Extend CI artifact
globs for the new log files.

Fixes the log-file part of precice#790.
Drop INFO prefix on routine log lines, put test index at the start of
start/finish messages, and add blank lines between tests for easier
scanning in CI and local runs.

Addresses the console formatting part of precice#790.
@PranjalManhgaye
Copy link
Copy Markdown
Collaborator Author

PranjalManhgaye commented May 27, 2026

passed (17/17), but the console output still looks like the old style, is this workflow expected to run with develop runner scripts, so formatting changes from this PR may not appear there?

@MakisH
Copy link
Copy Markdown
Member

MakisH commented May 27, 2026

@PranjalManhgaye I am not sure if this is currently documented (please check), but the trigger-system-tests does not take the tools/tests/ from the PR branch. This is often misleading when testing changes to the system tests scripts.

By the way, I think this PR can use a more descriptive title. How about "Split the system tests log file into stages"?

Do not forget to update the documentation and the hints in the workflow files (look for the original file name).

@PranjalManhgaye PranjalManhgaye changed the title Issue 790 system tests logs Split the system tests log file into stages May 27, 2026
Document combined and per-stage system test logs in README and job summary hints, and clarify workflow artifact step names to reflect staged log files.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

System tests logs appear only at the end

2 participants