Skip to content

replace full trace message for extension check command with simple pass/fail message#4892

Merged
lexming merged 2 commits intoeasybuilders:developfrom
boegel:exts_check_msg
May 23, 2025
Merged

replace full trace message for extension check command with simple pass/fail message#4892
lexming merged 2 commits intoeasybuilders:developfrom
boegel:exts_check_msg

Conversation

@boegel
Copy link
Copy Markdown
Member

@boegel boegel commented May 23, 2025 •
edited
Loading

This makes the output of the sanity check step of whole lot easier to digest.

For example, for matplotlib-3.9.2-gfbf-2024a.eb, instead of:

>> running shell command:
        /user/gent/400/vsc40023/eb_arcaninescratch/RHEL9/zen2-ib/software/Python/3.12.3-GCCcore-13.3.0/bin/python -c "import fontTools"
        [started at: 2025-05-23 09:15:17]
        [working dir: /arcanine/scratch/gent/vo/000/gvo00002/vsc40023/easybuild_tests/RHEL9/zen2-ib/software/matplotlib/3.9.2-gfbf-2024a]
        [output and state saved to /tmp/eb-sec1umjh/run-shell-cmd-output/python-khf3qko_]
  >> command completed: exit 0, ran in < 1s
  >> running shell command:
        /user/gent/400/vsc40023/eb_arcaninescratch/RHEL9/zen2-ib/software/Python/3.12.3-GCCcore-13.3.0/bin/python -c "import cycler"
        [started at: 2025-05-23 09:15:17]
        [working dir: /arcanine/scratch/gent/vo/000/gvo00002/vsc40023/easybuild_tests/RHEL9/zen2-ib/software/matplotlib/3.9.2-gfbf-2024a]
        [output and state saved to /tmp/eb-sec1umjh/run-shell-cmd-output/python-m_236t9m]
  >> command completed: exit 0, ran in < 1s
  >> running shell command:
        /user/gent/400/vsc40023/eb_arcaninescratch/RHEL9/zen2-ib/software/Python/3.12.3-GCCcore-13.3.0/bin/python -c "import kiwisolver"
        [started at: 2025-05-23 09:15:18]
        [working dir: /arcanine/scratch/gent/vo/000/gvo00002/vsc40023/easybuild_tests/RHEL9/zen2-ib/software/matplotlib/3.9.2-gfbf-2024a]
        [output and state saved to /tmp/eb-sec1umjh/run-shell-cmd-output/python-iqsl5h7s]
  >> command completed: exit 0, ran in < 1s
  >> running shell command:
        /user/gent/400/vsc40023/eb_arcaninescratch/RHEL9/zen2-ib/software/Python/3.12.3-GCCcore-13.3.0/bin/python -c "import contourpy"
        [started at: 2025-05-23 09:15:18]
        [working dir: /arcanine/scratch/gent/vo/000/gvo00002/vsc40023/easybuild_tests/RHEL9/zen2-ib/software/matplotlib/3.9.2-gfbf-2024a]
        [output and state saved to /tmp/eb-sec1umjh/run-shell-cmd-output/python-ug535xt5]
  >> command completed: exit 0, ran in < 1s
  >> running shell command:
        /user/gent/400/vsc40023/eb_arcaninescratch/RHEL9/zen2-ib/software/Python/3.12.3-GCCcore-13.3.0/bin/python -c "import matplotlib"
        [started at: 2025-05-23 09:15:19]
        [working dir: /arcanine/scratch/gent/vo/000/gvo00002/vsc40023/easybuild_tests/RHEL9/zen2-ib/software/matplotlib/3.9.2-gfbf-2024a]
        [output and state saved to /tmp/eb-sec1umjh/run-shell-cmd-output/python-kdjcjjbe]
  >> command completed: exit 0, ran in < 1s

we now get:

  >> Extension sanity check command '/user/gent/400/vsc40023/eb_arcaninescratch/RHEL9/zen2-ib/software/Python/3.12.3-GCCcore-13.3.0/bin/python -c "import fontTools"': OK
  >> Extension sanity check command '/user/gent/400/vsc40023/eb_arcaninescratch/RHEL9/zen2-ib/software/Python/3.12.3-GCCcore-13.3.0/bin/python -c "import cycler"': OK
  >> Extension sanity check command '/user/gent/400/vsc40023/eb_arcaninescratch/RHEL9/zen2-ib/software/Python/3.12.3-GCCcore-13.3.0/bin/python -c "import kiwisolver"': OK
  >> Extension sanity check command '/user/gent/400/vsc40023/eb_arcaninescratch/RHEL9/zen2-ib/software/Python/3.12.3-GCCcore-13.3.0/bin/python -c "import contourpy"': OK
  >> Extension sanity check command '/user/gent/400/vsc40023/eb_arcaninescratch/RHEL9/zen2-ib/software/Python/3.12.3-GCCcore-13.3.0/bin/python -c "import matplotlib"': OK

@boegel boegel added this to the next release (5.1.0) milestone May 23, 2025
@boegel
use 'OK' instead of 'PASS' to keep output in sanity check more consis…
202d628 
…tent (with result of sanity check commands, for example)
lexming
lexming reviewed May 23, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@lexming lexming left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Nice change, just 2 minor comments:

  • I would still print the work dir of the sanity check commands. Since this is the same for all commands we can just print it once before running them. (OR alternatively we can also just print the work dir when the command fails).
  • If the command fails, we still get the path to the output file?

@lexming lexming mentioned this pull request May 23, 2025
Merged
@boegel
Copy link
Copy Markdown
Member Author

boegel commented May 23, 2025

Nice change, just 2 minor comments:

* I would still print the work dir of the sanity check commands. Since this is the same for all commands we can just print it once before running them. (OR alternatively we can also just print the work dir when the command fails).

* If the command fails, we still get the path to the output file?

Note that this is only for the default check that's done for extensions (the import check for Python packages), it does not apply to custom sanity check commands (there we still see the full trace message, at least for now).

Since the sanity check runs through the full sanity check before reporting any failures, we need a better way to report on failing checks anyway (for example to point to the relevant out.txt and cmd.sh), so that can be tackled later.

This change is mainly motivated by being annoying by seeing all those import checks produce so much output, which is hard to parse (for humans).

This is a step in the right direction, but by no means meant to be a fully fledged per cleanup of the sanity check output...

lexming
lexming approved these changes May 23, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@lexming lexming left a comment

Choose a reason for hiding this comment

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

LGTM

@lexming
Copy link
Copy Markdown
Contributor

lexming commented May 23, 2025

Merging, thanks @boegel !

@lexming lexming merged commit 7bc1f0e into easybuilders:develop May 23, 2025
37 checks passed
@boegel boegel deleted the exts_check_msg branch May 23, 2025 09:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lexming lexming lexming approved these changes

Assignees

No one assigned

Labels

enhancement

Projects

None yet

Milestone

5.1.0

Development

Successfully merging this pull request may close these issues.

2 participants

@boegel @lexming