Skip to content

Commit 7e82fc1

Browse files
aarltaarlt
committed
[tests] Refactor scripts/ASTImportTest.sh.
1 parent 2cc6610 commit 7e82fc1

File tree

3 files changed

+219
-103
lines changed

3 files changed

+219
-103
lines changed

‎scripts/ASTImportTest.sh

Lines changed: 169 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -1,105 +1,190 @@
11
#!/usr/bin/env bash
2+
# ------------------------------------------------------------------------------
3+
# vim:ts=4:et
4+
# This file is part of solidity.
5+
#
6+
# solidity is free software: you can redistribute it and/or modify
7+
# it under the terms of the GNU General Public License as published by
8+
# the Free Software Foundation, either version 3 of the License, or
9+
# (at your option) any later version.
10+
#
11+
# solidity is distributed in the hope that it will be useful,
12+
# but WITHOUT ANY WARRANTY; without even the implied warranty of
13+
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14+
# GNU General Public License for more details.
15+
#
16+
# You should have received a copy of the GNU General Public License
17+
# along with solidity. If not, see <http://www.gnu.org/licenses/>
18+
#
19+
# (c) solidity contributors.
20+
# ------------------------------------------------------------------------------
21+
# Bash script to test the import/exports.
22+
# ast import/export tests:
23+
# - first exporting a .sol file to JSON, then loading it into the compiler
24+
# and exporting it again. The second JSON should be identical to the first.
25+
26+
set -euo pipefail
227

3-
set -e
4-
5-
# Bash script to test the ast-import option of the compiler by
6-
# first exporting a .sol file to JSON, then loading it into the compiler
7-
# and exporting it again. The second JSON should be identical to the first
828
READLINK=readlink
929
if [[ "$OSTYPE" == "darwin"* ]]; then
1030
READLINK=greadlink
1131
fi
1232
REPO_ROOT=$(${READLINK} -f "$(dirname "$0")"/..)
1333
SOLIDITY_BUILD_DIR=${SOLIDITY_BUILD_DIR:-${REPO_ROOT}/build}
14-
SOLC=${SOLIDITY_BUILD_DIR}/solc/solc
15-
SPLITSOURCES=${REPO_ROOT}/scripts/splitSources.py
34+
SOLC="${SOLIDITY_BUILD_DIR}/solc/solc"
35+
SPLITSOURCES="${REPO_ROOT}/scripts/splitSources.py"
36+
37+
# shellcheck source=scripts/common.sh
38+
source "${REPO_ROOT}/scripts/common.sh"
39+
40+
function print_usage
41+
{
42+
fail "Usage: ${0} ast [--exit-on-error]."
43+
}
44+
45+
function print_used_commands
46+
{
47+
local test_directory="$1"
48+
local export_command="$2"
49+
local import_command="$3"
50+
printError "You can find the files used for this test here: ${test_directory}"
51+
printError "Used commands for test:"
52+
printError "# export"
53+
echo "$ ${export_command}" >&2
54+
printError "# import"
55+
echo "$ ${import_command}" >&2
56+
}
57+
58+
function print_stderr_stdout
59+
{
60+
local error_message="$1"
61+
local stderr_file="$2"
62+
local stdout_file="$3"
63+
printError "$error_message"
64+
printError ""
65+
printError "stderr:"
66+
cat "$stderr_file" >&2
67+
printError ""
68+
printError "stdout:"
69+
cat "$stdout_file" >&2
70+
}
71+
72+
IMPORT_TEST_TYPE=
73+
EXIT_ON_ERROR=0
74+
for PARAM in "$@"
75+
do
76+
case "$PARAM" in
77+
ast) IMPORT_TEST_TYPE="ast" ;;
78+
--exit-on-error) EXIT_ON_ERROR=1 ;;
79+
*) print_usage ;;
80+
esac
81+
done
1682

1783
SYNTAXTESTS_DIR="${REPO_ROOT}/test/libsolidity/syntaxTests"
1884
ASTJSONTESTS_DIR="${REPO_ROOT}/test/libsolidity/ASTJSON"
19-
NSOURCES="$(find "$SYNTAXTESTS_DIR" -type f | wc -l)"
20-
21-
# DEV_DIR="${REPO_ROOT}/../tmp/contracts/"
22-
# NSOURCES="$(find $DEV_DIR -type f | wc -l)" #TODO use find command
2385

2486
FAILED=0
2587
UNCOMPILABLE=0
2688
TESTED=0
2789

28-
if [[ "$(find . -maxdepth 0 -type d -empty)" == "" ]]; then
29-
echo "Test directory not empty. Skipping!"
30-
exit 1
31-
fi
90+
function ast_import_export_equivalence
91+
{
92+
local sol_file="$1"
93+
local input_files=( "${@:2}" )
3294

33-
# function tests whether exporting and importing again leaves the JSON ast unchanged
34-
# Results are recorded by adding to FAILED or UNCOMPILABLE.
35-
# Also, in case of a mismatch a diff and the respective ASTs are printed
36-
# Expected parameters:
37-
# $1 name of the file to be exported and imported
38-
# $2 any files needed to do so that might be in parent directories
39-
function testImportExportEquivalence {
40-
local nth_input_file="$1"
41-
IFS=" " read -r -a all_input_files <<< "$2"
95+
local export_command=("$SOLC" --combined-json ast --pretty-json --json-indent 4 "${input_files[@]}")
96+
local import_command=("$SOLC" --import-ast --combined-json ast --pretty-json --json-indent 4 expected.json)
4297

43-
if $SOLC "$nth_input_file" "${all_input_files[@]}" > /dev/null 2>&1
98+
# export ast - save ast json as expected result (silently)
99+
if ! "${export_command[@]}" > expected.json 2> stderr_export.txt
44100
then
45-
! [[ -e stderr.txt ]] || { echo "stderr.txt already exists. Refusing to overwrite."; exit 1; }
101+
print_stderr_stdout "ERROR: AST reimport failed (export) for input file ${sol_file}." ./stderr_export.txt ./expected.json
102+
print_used_commands "$(pwd)" "${export_command[*]} > expected.json" "${import_command[*]}"
103+
return 1
104+
fi
46105

47-
# save exported json as expected result (silently)
48-
$SOLC --combined-json ast --pretty-json "$nth_input_file" "${all_input_files[@]}" > expected.json 2> /dev/null
49-
# import it, and export it again as obtained result (silently)
50-
if ! $SOLC --import-ast --combined-json ast --pretty-json expected.json > obtained.json 2> stderr.txt
106+
# (re)import ast - and export it again as obtained result (silently)
107+
if ! "${import_command[@]}" > obtained.json 2> stderr_import.txt
108+
then
109+
print_stderr_stdout "ERROR: AST reimport failed (import) for input file ${sol_file}." ./stderr_import.txt ./obtained.json
110+
print_used_commands "$(pwd)" "${export_command[*]} > expected.json" "${import_command[*]}"
111+
return 1
112+
fi
113+
114+
# compare expected and obtained ast's
115+
if ! diff_files expected.json obtained.json
116+
then
117+
printError "❌ ERROR: AST reimport failed for ${sol_file}"
118+
if [[ $EXIT_ON_ERROR == 1 ]]
51119
then
52-
# For investigating, use exit 1 here so the script stops at the
53-
# first failing test
54-
# exit 1
55-
FAILED=$((FAILED + 1))
56-
echo -e "ERROR: AST reimport failed for input file $nth_input_file"
57-
echo
58-
echo "Compiler stderr:"
59-
cat ./stderr.txt
60-
echo
61-
echo "Compiler stdout:"
62-
cat ./obtained.json
120+
print_used_commands "$(pwd)" "${export_command[*]}" "${import_command[*]}"
63121
return 1
64122
fi
65-
DIFF="$(diff expected.json obtained.json)"
66-
if [ "$DIFF" != "" ]
67-
then
68-
if [ "$DIFFVIEW" == "" ]
69-
then
70-
echo -e "ERROR: JSONS differ for $1: \n $DIFF \n"
71-
echo "Expected:"
72-
cat ./expected.json
73-
echo "Obtained:"
74-
cat ./obtained.json
75-
else
76-
# Use user supplied diff view binary
77-
$DIFFVIEW expected.json obtained.json
78-
fi
79-
FAILED=$((FAILED + 1))
80-
return 2
81-
fi
82-
TESTED=$((TESTED + 1))
83-
rm expected.json obtained.json
84-
rm -f stderr.txt
123+
FAILED=$((FAILED + 1))
124+
fi
125+
TESTED=$((TESTED + 1))
126+
}
127+
128+
# function tests whether exporting and importing again is equivalent.
129+
# Results are recorded by adding to FAILED or UNCOMPILABLE.
130+
# Also, in case of a mismatch a diff is printed
131+
# Expected parameters:
132+
# $1 name of the file to be exported and imported
133+
# $2 any files needed to do so that might be in parent directories
134+
function test_import_export_equivalence {
135+
local sol_file="$1"
136+
local input_files=( "${@:2}" )
137+
local OUTPUT
138+
local SOLC_RC
139+
140+
set +e
141+
OUTPUT=$("$SOLC" --bin "${input_files[@]}" 2>&1)
142+
SOLC_RC=$?
143+
set -e
144+
145+
# if input files where compilable with success
146+
if (( SOLC_RC == 0 ))
147+
then
148+
case "$IMPORT_TEST_TYPE" in
149+
ast) ast_import_export_equivalence "${sol_file}" "${input_files[@]}" ;;
150+
*) fail "Unknown import test type '${IMPORT_TEST_TYPE}'. Aborting." ;;
151+
esac
85152
else
86-
# echo "contract $solfile could not be compiled "
87153
UNCOMPILABLE=$((UNCOMPILABLE + 1))
154+
# solc will return exit code 2, if it was terminated by an uncaught exception.
155+
if (( SOLC_RC == 2 ))
156+
then
157+
# Ignore all UnimplementedFeatureError exceptions.
158+
if [[ "$OUTPUT" != *"UnimplementedFeatureError"* ]]
159+
then
160+
printError "\n\nERROR: Uncaught Exception while executing '$SOLC --bin ${input_files[*]}':\n${OUTPUT}\n"
161+
exit 1
162+
fi
163+
fi
88164
fi
89-
# return 0
90165
}
91-
echo "Looking at $NSOURCES .sol files..."
92166

93167
WORKINGDIR=$PWD
94168

95-
# for solfile in $(find $DEV_DIR -name *.sol)
169+
command_available "$SOLC" --version
170+
command_available jq --version
171+
172+
case "$IMPORT_TEST_TYPE" in
173+
ast) TEST_DIRS=("${SYNTAXTESTS_DIR}" "${ASTJSONTESTS_DIR}") ;;
174+
*) print_usage ;;
175+
esac
176+
96177
# boost_filesystem_bug specifically tests a local fix for a boost::filesystem
97178
# bug. Since the test involves a malformed path, there is no point in running
98-
# AST tests on it. See https://github.com/boostorg/filesystem/issues/176
99-
# shellcheck disable=SC2044
100-
for solfile in $(find "$SYNTAXTESTS_DIR" "$ASTJSONTESTS_DIR" -name "*.sol" -and -not -name "boost_filesystem_bug.sol")
179+
# tests on it. See https://github.com/boostorg/filesystem/issues/176
180+
IMPORT_TEST_FILES=$(find "${TEST_DIRS[@]}" -name "*.sol" -and -not -name "boost_filesystem_bug.sol")
181+
182+
NSOURCES="$(echo "${IMPORT_TEST_FILES}" | wc -l)"
183+
echo "Looking at ${NSOURCES} .sol files..."
184+
185+
for solfile in $IMPORT_TEST_FILES
101186
do
102-
echo -n "."
187+
echo -n "·"
103188
# create a temporary sub-directory
104189
FILETMP=$(mktemp -d)
105190
cd "$FILETMP"
@@ -108,29 +193,25 @@ do
108193
OUTPUT=$("$SPLITSOURCES" "$solfile")
109194
SPLITSOURCES_RC=$?
110195
set -e
111-
if [ ${SPLITSOURCES_RC} == 0 ]
196+
197+
if (( SPLITSOURCES_RC == 0 ))
112198
then
113-
# echo $OUTPUT
114-
NSOURCES=$((NSOURCES - 1))
115-
for i in $OUTPUT;
116-
do
117-
testImportExportEquivalence "$i" "$OUTPUT"
118-
NSOURCES=$((NSOURCES + 1))
119-
done
120-
elif [ ${SPLITSOURCES_RC} == 1 ]
199+
IFS=' ' read -ra OUTPUT_ARRAY <<< "$OUTPUT"
200+
test_import_export_equivalence "$solfile" "${OUTPUT_ARRAY[@]}"
201+
elif (( SPLITSOURCES_RC == 1 ))
121202
then
122-
testImportExportEquivalence "$solfile"
123-
elif [ ${SPLITSOURCES_RC} == 2 ]
203+
test_import_export_equivalence "$solfile" "$solfile"
204+
elif (( SPLITSOURCES_RC == 2 ))
124205
then
125206
# The script will exit with return code 2, if an UnicodeDecodeError occurred.
126207
# This is the case if e.g. some tests are using invalid utf-8 sequences. We will ignore
127208
# these errors, but print the actual output of the script.
128-
echo -e "\n${OUTPUT}\n"
129-
testImportExportEquivalence "$solfile"
209+
printError "\n\n${OUTPUT}\n\n"
210+
test_import_export_equivalence "$solfile" "$solfile"
130211
else
131212
# All other return codes will be treated as critical errors. The script will exit.
132-
echo -e "\nGot unexpected return code ${SPLITSOURCES_RC} from ${SPLITSOURCES}. Aborting."
133-
echo -e "\n${OUTPUT}\n"
213+
printError "\n\nGot unexpected return code ${SPLITSOURCES_RC} from '${SPLITSOURCES} ${solfile}'. Aborting."
214+
printError "\n\n${OUTPUT}\n\n"
134215

135216
cd "$WORKINGDIR"
136217
# Delete temporary files
@@ -144,12 +225,11 @@ do
144225
rm -rf "$FILETMP"
145226
done
146227

147-
echo ""
228+
echo
148229

149-
if [ "$FAILED" = 0 ]
230+
if (( FAILED == 0 ))
150231
then
151-
echo "SUCCESS: $TESTED syntaxTests passed, $FAILED failed, $UNCOMPILABLE could not be compiled ($NSOURCES sources total)."
232+
echo "SUCCESS: ${TESTED} tests passed, ${FAILED} failed, ${UNCOMPILABLE} could not be compiled (${NSOURCES} sources total)."
152233
else
153-
echo "FAILURE: Out of $NSOURCES sources, $FAILED failed, ($UNCOMPILABLE could not be compiled)."
154-
exit 1
234+
fail "FAILURE: Out of ${NSOURCES} sources, ${FAILED} failed, (${UNCOMPILABLE} could not be compiled)."
155235
fi

0 commit comments

Comments
 (0)