Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More informative output for failed CLI tests in CI #15544

Merged
merged 2 commits into from
Oct 25, 2024
Merged

More informative output for failed CLI tests in CI #15544

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
edc352b
cmdlineTests.sh: Compare stderr first and exit code last
cameel Oct 25, 2024
21df054
parallel_cli_tests.py: Handle test runner failures gracefully, by pri…
cameel Oct 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions .circleci/parallel_cli_tests.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,13 @@
else:
filters = list(selected_tests)

subprocess.run(
['test/cmdlineTests.sh'] + filters,
stdin=sys.stdin,
stdout=sys.stdout,
stderr=sys.stderr,
check=True,
)
try:
subprocess.run(
['test/cmdlineTests.sh'] + filters,
stdin=sys.stdin,
stdout=sys.stdout,
stderr=sys.stderr,
check=True,
)
except subprocess.CalledProcessError as exception:
sys.exit(exception)
Copy link
Member

Choose a reason for hiding this comment

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

I didn't know you could exit with an object instead of an integer code. Neat.

Copy link
Member Author

Choose a reason for hiding this comment

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

I actually didn't know that myself. I forgot a string conversion here at first, then realized it still works :)

But I did know that you can pass in a string and it makes it exit with code 1 and print the message to stderr, which is a nice shortcut.

28 changes: 14 additions & 14 deletions test/cmdlineTests.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,12 +275,18 @@ EOF
sed -i.bak -e 's/^\(Dynamic exception type:\).*/\1/' "$stderr_path"
rm "$stderr_path.bak"

if [[ $exitCode -ne "$exit_code_expected" ]]
if [[ "$(cat "$stderr_path")" != "${stderr_expected}" ]]
Copy link
Member Author

Choose a reason for hiding this comment

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

Note that while the diff may at first look like there are more changes here, I'm really only changing the order of the ifs.

then
printError "Incorrect exit code. Expected $exit_code_expected but got $exitCode."
printError "Incorrect output on stderr received. Expected:"
echo -e "${stderr_expected}"

[[ $exit_code_expectation_file != "" ]] && ask_expectation_update "$exitCode" "$exit_code_expectation_file"
[[ $exit_code_expectation_file == "" ]] && fail
printError "But got:"
echo -e "$(cat "$stderr_path")"

printError "When running $solc_command"

[[ $stderr_expectation_file != "" ]] && ask_expectation_update "$(cat "$stderr_path")" "$stderr_expectation_file"
[[ $stderr_expectation_file == "" ]] && fail
fi

if [[ "$(cat "$stdout_path")" != "${stdout_expected}" ]]
Expand All @@ -297,18 +303,12 @@ EOF
[[ $stdout_expectation_file == "" ]] && fail
fi

if [[ "$(cat "$stderr_path")" != "${stderr_expected}" ]]
if [[ $exitCode -ne "$exit_code_expected" ]]
then
printError "Incorrect output on stderr received. Expected:"
echo -e "${stderr_expected}"

printError "But got:"
echo -e "$(cat "$stderr_path")"

printError "When running $solc_command"
printError "Incorrect exit code. Expected $exit_code_expected but got $exitCode."

[[ $stderr_expectation_file != "" ]] && ask_expectation_update "$(cat "$stderr_path")" "$stderr_expectation_file"
[[ $stderr_expectation_file == "" ]] && fail
[[ $exit_code_expectation_file != "" ]] && ask_expectation_update "$exitCode" "$exit_code_expectation_file"
[[ $exit_code_expectation_file == "" ]] && fail
fi

rm "$stdout_path" "$stderr_path"
Expand Down