solidity/test/externalTests/prb-math.sh

117 lines
5.0 KiB
Bash
Executable File

#!/usr/bin/env bash
# ------------------------------------------------------------------------------
# This file is part of solidity.
#
# solidity is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# solidity is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with solidity. If not, see <http://www.gnu.org/licenses/>
#
# (c) 2022 solidity contributors.
#------------------------------------------------------------------------------
set -e
source scripts/common.sh
source scripts/externalTests/common.sh
REPO_ROOT=$(realpath "$(dirname "$0")/../..")
verify_input "$@"
BINARY_TYPE="$1"
BINARY_PATH="$(realpath "$2")"
SELECTED_PRESETS="$3"
function compile_fn { yarn compile; }
# NOTE: `yarn test` runs `mocha` which seems to disable the gas reporter.
function test_fn { npx --no hardhat --no-compile test; }
function prb_math_test
{
local repo="https://github.com/paulrberg/prb-math"
local ref_type=branch
# We currently pin the prb-math version to the latest version that support hardhat
# Please see here for details: https://github.com/ethereum/solidity/issues/13767
local ref=v2.5.0
local config_file="hardhat.config.ts"
local config_var="config"
local compile_only_presets=(
ir-no-optimize # Tests fail with "Error: Transaction reverted: trying to deploy a contract whose code is too large"
)
local settings_presets=(
"${compile_only_presets[@]}"
ir-optimize-evm-only
ir-optimize-evm+yul
legacy-optimize-evm-only
legacy-optimize-evm+yul
legacy-no-optimize
)
[[ $SELECTED_PRESETS != "" ]] || SELECTED_PRESETS=$(circleci_select_steps_multiarg "${settings_presets[@]}")
print_presets_or_exit "$SELECTED_PRESETS"
setup_solc "$DIR" "$BINARY_TYPE" "$BINARY_PATH"
download_project "$repo" "$ref_type" "$ref" "$DIR"
cp .env.example .env
# The project has yarn 3.1.0 binary stored in the repo and yarnrc forces the yarn 1.x binary
# installed system-wide to use it. Unfortunately Yarn 3 fails in weird ways when we remove
# yarn.lock. Remove the config to restore Yarn 1.x.
rm .yarnrc.yml
# Disable tests that won't pass on the ir presets due to Hardhat heuristics. Note that this also disables
# them for other presets but that's fine - we want same code run for benchmarks to be comparable.
# TODO: Remove this when Hardhat adjusts heuristics for IR (https://github.com/nomiclabs/hardhat/issues/3365).
pushd test/contracts/prbMathUd60x18/pure/
sed -i 's|context(\("when the sum overflows"\)|context.skip(\1|g' add.test.ts
sed -i 's|context(\("when the sum does not overflow"\)|context.skip(\1|g' add.test.ts
sed -i 's|context(\("when both operands are zero"\)|context.skip(\1|g' avg.test.ts
sed -i 's|context(\("when one operand is zero and the other is not zero"\)|context.skip(\1|g' avg.test.ts
sed -i 's|context(\("when the denominator is zero"\)|context.skip(\1|g' div.test.ts
sed -i 's|context(\("when x is zero"\)|context.skip(\1|g' inv.test.ts
popd
pushd test/contracts/prbMathSd59x18/pure/
sed -i 's|context(\("when the sum overflows"\)|context.skip(\1|g' add.test.ts
sed -i 's|context(\("when the sum underflows"\)|context.skip(\1|g' add.test.ts
sed -i 's|context(\("when the denominator is zero"\)|context.skip(\1|g' div.test.ts
sed -i 's|context(\("when x is zero"\)|context.skip(\1|g' inv.test.ts
sed -i 's|context(\("when the difference underflows"\)|context.skip(\1|g' sub.test.ts
sed -i 's|context(\("when the difference overflows"\)|context.skip(\1|g' sub.test.ts
popd
neutralize_package_lock
neutralize_package_json_hooks
force_hardhat_compiler_binary "$config_file" "$BINARY_TYPE" "$BINARY_PATH"
force_hardhat_compiler_settings "$config_file" "$(first_word "$SELECTED_PRESETS")" "$config_var"
yarn install --no-lock-file
yarn add hardhat-gas-reporter
# Workaround for error caused by the last release of hardhat-waffle@2.0.6 that bumps ethereum-waffle
# to version 4.0.10 and breaks prb-math build with the following error:
#
# Cannot find module 'ethereum-waffle/dist/cjs/src/deployContract'
#
# See: https://github.com/NomicFoundation/hardhat-waffle/commit/83ee9cb36ee59d0bedacbbd00043f030af104ad0
yarn add '@nomiclabs/hardhat-waffle@2.0.5'
replace_version_pragmas
for preset in $SELECTED_PRESETS; do
hardhat_run_test "$config_file" "$preset" "${compile_only_presets[*]}" compile_fn test_fn "$config_var"
store_benchmark_report hardhat prb-math "$repo" "$preset"
done
}
external_test PRBMath prb_math_test