mirror of
https://github.com/ethereum/solidity
synced 2023-10-03 13:03:40 +00:00
408 lines
13 KiB
Bash
408 lines
13 KiB
Bash
#!/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) 2019 solidity contributors.
|
|
#------------------------------------------------------------------------------
|
|
set -e
|
|
|
|
# Requires "${REPO_ROOT}/scripts/common.sh" to be included before.
|
|
|
|
CURRENT_EVM_VERSION=london
|
|
|
|
function print_optimizer_presets_or_exit
|
|
{
|
|
local selected_presets="$1"
|
|
|
|
[[ $selected_presets != "" ]] || { printWarning "No presets to run. Exiting."; exit 0; }
|
|
|
|
printLog "Selected settings presets: ${selected_presets}"
|
|
}
|
|
|
|
function verify_input
|
|
{
|
|
local binary_type="$1"
|
|
local binary_path="$2"
|
|
|
|
(( $# == 2 )) || fail "Usage: $0 native|solcjs <path to solc or soljson.js>"
|
|
[[ $binary_type == native || $binary_type == solcjs ]] || fail "Invalid binary type: '${binary_type}'. Must be either 'native' or 'solcjs'."
|
|
[[ -f "$binary_path" ]] || fail "The compiler binary does not exist at '${binary_path}'"
|
|
}
|
|
|
|
function setup_solc
|
|
{
|
|
local test_dir="$1"
|
|
local binary_type="$2"
|
|
local binary_path="$3"
|
|
local solcjs_branch="${4:-master}"
|
|
local install_dir="${5:-solc/}"
|
|
|
|
[[ $binary_type == native || $binary_type == solcjs ]] || assertFail
|
|
|
|
cd "$test_dir"
|
|
|
|
if [[ $binary_type == solcjs ]]
|
|
then
|
|
printLog "Setting up solc-js..."
|
|
git clone --depth 1 -b "$solcjs_branch" https://github.com/ethereum/solc-js.git "$install_dir"
|
|
|
|
pushd "$install_dir"
|
|
npm install
|
|
cp "$binary_path" soljson.js
|
|
SOLCVERSION=$(./solcjs --version)
|
|
popd
|
|
else
|
|
printLog "Setting up solc..."
|
|
SOLCVERSION=$("$binary_path" --version | tail -n 1 | sed -n -E 's/^Version: (.*)$/\1/p')
|
|
fi
|
|
|
|
SOLCVERSION_SHORT=$(echo "$SOLCVERSION" | sed -En 's/^([0-9.]+).*\+commit\.[0-9a-f]+.*$/\1/p')
|
|
printLog "Using compiler version $SOLCVERSION"
|
|
}
|
|
|
|
function download_project
|
|
{
|
|
local repo="$1"
|
|
local solcjs_branch="$2"
|
|
local test_dir="$3"
|
|
|
|
printLog "Cloning $solcjs_branch of $repo..."
|
|
git clone --depth 1 "$repo" -b "$solcjs_branch" "$test_dir/ext"
|
|
cd ext
|
|
echo "Current commit hash: $(git rev-parse HEAD)"
|
|
}
|
|
|
|
function force_truffle_version
|
|
{
|
|
local version="$1"
|
|
|
|
sed -i 's/"truffle":\s*".*"/"truffle": "'"$version"'"/g' package.json
|
|
}
|
|
|
|
function replace_version_pragmas
|
|
{
|
|
# Replace fixed-version pragmas (part of Consensys best practice).
|
|
# Include all directories to also cover node dependencies.
|
|
printLog "Replacing fixed-version pragmas..."
|
|
find . test -name '*.sol' -type f -print0 | xargs -0 sed -i -E -e 's/pragma solidity [^;]+;/pragma solidity >=0.0;/'
|
|
}
|
|
|
|
function neutralize_package_lock
|
|
{
|
|
# Remove lock files (if they exist) to prevent them from overriding our changes in package.json
|
|
printLog "Removing package lock files..."
|
|
rm --force --verbose yarn.lock
|
|
rm --force --verbose package-lock.json
|
|
}
|
|
|
|
function neutralize_package_json_hooks
|
|
{
|
|
printLog "Disabling package.json hooks..."
|
|
[[ -f package.json ]] || fail "package.json not found"
|
|
sed -i 's|"prepublish": *".*"|"prepublish": ""|g' package.json
|
|
sed -i 's|"prepare": *".*"|"prepare": ""|g' package.json
|
|
}
|
|
|
|
function neutralize_packaged_contracts
|
|
{
|
|
# Frameworks will build contracts from any package that contains a configuration file.
|
|
# This is both unnecessary (any files imported from these packages will get compiled again as a
|
|
# part of the main project anyway) and trips up our version check because it won't use our
|
|
# custom compiler binary.
|
|
printLog "Removing framework config and artifacts from npm packages..."
|
|
find node_modules/ -type f '(' -name 'hardhat.config.*' -o -name 'truffle-config.*' ')' -delete
|
|
|
|
# Some npm packages also come packaged with pre-built artifacts.
|
|
find node_modules/ -path '*artifacts/build-info/*.json' -delete
|
|
}
|
|
|
|
function force_solc_modules
|
|
{
|
|
local custom_solcjs_path="${1:-solc/}"
|
|
|
|
[[ -d node_modules/ ]] || assertFail
|
|
|
|
printLog "Replacing all installed solc-js with a link to the latest version..."
|
|
soljson_binaries=$(find node_modules -type f -path "*/solc/soljson.js")
|
|
for soljson_binary in $soljson_binaries
|
|
do
|
|
local solc_module_path
|
|
solc_module_path=$(dirname "$soljson_binary")
|
|
|
|
printLog "Found and replaced solc-js in $solc_module_path"
|
|
rm -r "$solc_module_path"
|
|
ln -s "$custom_solcjs_path" "$solc_module_path"
|
|
done
|
|
}
|
|
|
|
function force_truffle_compiler_settings
|
|
{
|
|
local config_file="$1"
|
|
local binary_type="$2"
|
|
local solc_path="$3"
|
|
local preset="$4"
|
|
local evm_version="${5:-"$CURRENT_EVM_VERSION"}"
|
|
|
|
[[ $binary_type == native || $binary_type == solcjs ]] || assertFail
|
|
|
|
[[ $binary_type == native ]] && local solc_path="native"
|
|
|
|
printLog "Forcing Truffle compiler settings..."
|
|
echo "-------------------------------------"
|
|
echo "Config file: $config_file"
|
|
echo "Binary type: $binary_type"
|
|
echo "Compiler path: $solc_path"
|
|
echo "Settings preset: ${preset}"
|
|
echo "Settings: $(settings_from_preset "$preset" "$evm_version")"
|
|
echo "EVM version: $evm_version"
|
|
echo "Compiler version: ${SOLCVERSION_SHORT}"
|
|
echo "Compiler version (full): ${SOLCVERSION}"
|
|
echo "-------------------------------------"
|
|
|
|
# Forcing the settings should always work by just overwriting the solc object. Forcing them by using a
|
|
# dedicated settings objects should only be the fallback.
|
|
echo "module.exports['compilers'] = $(truffle_compiler_settings "$solc_path" "$preset" "$evm_version");" >> "$config_file"
|
|
}
|
|
|
|
function force_hardhat_compiler_binary
|
|
{
|
|
local config_file="$1"
|
|
local binary_type="$2"
|
|
local solc_path="$3"
|
|
|
|
printLog "Configuring Hardhat..."
|
|
echo "-------------------------------------"
|
|
echo "Config file: ${config_file}"
|
|
echo "Binary type: ${binary_type}"
|
|
echo "Compiler path: ${solc_path}"
|
|
hardhat_solc_build_subtask "$SOLCVERSION_SHORT" "$SOLCVERSION" "$binary_type" "$solc_path" >> "$config_file"
|
|
}
|
|
|
|
function force_hardhat_compiler_settings
|
|
{
|
|
local config_file="$1"
|
|
local preset="$2"
|
|
local evm_version="${3:-"$CURRENT_EVM_VERSION"}"
|
|
|
|
printLog "Configuring Hardhat..."
|
|
echo "-------------------------------------"
|
|
echo "Config file: ${config_file}"
|
|
echo "Settings preset: ${preset}"
|
|
echo "Settings: $(settings_from_preset "$preset" "$evm_version")"
|
|
echo "EVM version: ${evm_version}"
|
|
echo "Compiler version: ${SOLCVERSION_SHORT}"
|
|
echo "Compiler version (full): ${SOLCVERSION}"
|
|
echo "-------------------------------------"
|
|
|
|
{
|
|
echo -n 'module.exports["solidity"] = '
|
|
hardhat_compiler_settings "$SOLCVERSION_SHORT" "$preset" "$evm_version"
|
|
} >> "$config_file"
|
|
}
|
|
|
|
function truffle_verify_compiler_version
|
|
{
|
|
local solc_version="$1"
|
|
local full_solc_version="$2"
|
|
|
|
printLog "Verify that the correct version (${solc_version}/${full_solc_version}) of the compiler was used to compile the contracts..."
|
|
grep "$full_solc_version" --with-filename --recursive build/contracts || fail "Wrong compiler version detected."
|
|
}
|
|
|
|
function hardhat_verify_compiler_version
|
|
{
|
|
local solc_version="$1"
|
|
local full_solc_version="$2"
|
|
|
|
printLog "Verify that the correct version (${solc_version}/${full_solc_version}) of the compiler was used to compile the contracts..."
|
|
local build_info_files
|
|
build_info_files=$(find . -path '*artifacts/build-info/*.json')
|
|
for build_info_file in $build_info_files; do
|
|
grep '"solcVersion": "'"${solc_version}"'"' --with-filename "$build_info_file" || fail "Wrong compiler version detected in ${build_info_file}."
|
|
grep '"solcLongVersion": "'"${full_solc_version}"'"' --with-filename "$build_info_file" || fail "Wrong compiler version detected in ${build_info_file}."
|
|
done
|
|
}
|
|
|
|
function truffle_clean
|
|
{
|
|
rm -rf build/
|
|
}
|
|
|
|
function hardhat_clean
|
|
{
|
|
rm -rf artifacts/ cache/
|
|
}
|
|
|
|
function run_test
|
|
{
|
|
local compile_fn="$1"
|
|
local test_fn="$2"
|
|
|
|
replace_version_pragmas
|
|
|
|
printLog "Running compile function..."
|
|
time $compile_fn
|
|
|
|
printLog "Running test function..."
|
|
$test_fn
|
|
}
|
|
|
|
function settings_from_preset
|
|
{
|
|
local preset="$1"
|
|
local evm_version="$2"
|
|
|
|
case "$preset" in
|
|
# NOTE: Remember to update `parallelism` of `t_ems_ext` job in CI config if you add/remove presets
|
|
legacy-no-optimize) echo "{evmVersion: '${evm_version}', viaIR: false, optimizer: {enabled: false}}" ;;
|
|
ir-no-optimize) echo "{evmVersion: '${evm_version}', viaIR: true, optimizer: {enabled: false}}" ;;
|
|
legacy-optimize-evm-only) echo "{evmVersion: '${evm_version}', viaIR: false, optimizer: {enabled: true, details: {yul: false}}}" ;;
|
|
ir-optimize-evm-only) echo "{evmVersion: '${evm_version}', viaIR: true, optimizer: {enabled: true, details: {yul: false}}}" ;;
|
|
legacy-optimize-evm+yul) echo "{evmVersion: '${evm_version}', viaIR: false, optimizer: {enabled: true, details: {yul: true}}}" ;;
|
|
ir-optimize-evm+yul) echo "{evmVersion: '${evm_version}', viaIR: true, optimizer: {enabled: true, details: {yul: true}}}" ;;
|
|
*)
|
|
fail "Unknown settings preset: '${preset}'."
|
|
;;
|
|
esac
|
|
}
|
|
|
|
function replace_global_solc
|
|
{
|
|
local solc_path="$1"
|
|
|
|
[[ ! -e solc ]] || fail "A file named 'solc' already exists in '${PWD}'."
|
|
|
|
ln -s "$solc_path" solc
|
|
export PATH="$PWD:$PATH"
|
|
}
|
|
|
|
function truffle_compiler_settings
|
|
{
|
|
local solc_path="$1"
|
|
local preset="$2"
|
|
local evm_version="$3"
|
|
|
|
echo "{"
|
|
echo " solc: {"
|
|
echo " version: \"${solc_path}\","
|
|
echo " settings: $(settings_from_preset "$preset" "$evm_version")"
|
|
echo " }"
|
|
echo "}"
|
|
}
|
|
|
|
function hardhat_solc_build_subtask {
|
|
local solc_version="$1"
|
|
local full_solc_version="$2"
|
|
local binary_type="$3"
|
|
local solc_path="$4"
|
|
|
|
[[ $binary_type == native || $binary_type == solcjs ]] || assertFail
|
|
|
|
[[ $binary_type == native ]] && local is_solcjs=false
|
|
[[ $binary_type == solcjs ]] && local is_solcjs=true
|
|
|
|
echo "const {TASK_COMPILE_SOLIDITY_GET_SOLC_BUILD} = require('hardhat/builtin-tasks/task-names');"
|
|
echo "const assert = require('assert');"
|
|
echo
|
|
echo "subtask(TASK_COMPILE_SOLIDITY_GET_SOLC_BUILD, async (args, hre, runSuper) => {"
|
|
echo " assert(args.solcVersion == '${solc_version}', 'Unexpected solc version: ' + args.solcVersion)"
|
|
echo " return {"
|
|
echo " compilerPath: '$(realpath "$solc_path")',"
|
|
echo " isSolcJs: ${is_solcjs},"
|
|
echo " version: args.solcVersion,"
|
|
echo " longVersion: '${full_solc_version}'"
|
|
echo " }"
|
|
echo "})"
|
|
}
|
|
|
|
function hardhat_compiler_settings {
|
|
local solc_version="$1"
|
|
local preset="$2"
|
|
local evm_version="$3"
|
|
|
|
echo "{"
|
|
echo " version: '${solc_version}',"
|
|
echo " settings: $(settings_from_preset "$preset" "$evm_version")"
|
|
echo "}"
|
|
}
|
|
|
|
function compile_and_run_test
|
|
{
|
|
local compile_fn="$1"
|
|
local test_fn="$2"
|
|
local verify_fn="$3"
|
|
local preset="$4"
|
|
local compile_only_presets="$5"
|
|
|
|
[[ $preset != *" "* ]] || assertFail "Preset names must not contain spaces."
|
|
|
|
printLog "Running compile function..."
|
|
time $compile_fn
|
|
$verify_fn "$SOLCVERSION_SHORT" "$SOLCVERSION"
|
|
|
|
if [[ "$COMPILE_ONLY" == 1 || " $compile_only_presets " == *" $preset "* ]]; then
|
|
printLog "Skipping test function..."
|
|
else
|
|
printLog "Running test function..."
|
|
$test_fn
|
|
fi
|
|
}
|
|
|
|
function truffle_run_test
|
|
{
|
|
local config_file="$1"
|
|
local binary_type="$2"
|
|
local solc_path="$3"
|
|
local preset="$4"
|
|
local compile_only_presets="$5"
|
|
local compile_fn="$6"
|
|
local test_fn="$7"
|
|
|
|
truffle_clean
|
|
force_truffle_compiler_settings "$config_file" "$binary_type" "$solc_path" "$preset"
|
|
compile_and_run_test compile_fn test_fn truffle_verify_compiler_version "$preset" "$compile_only_presets"
|
|
}
|
|
|
|
function hardhat_run_test
|
|
{
|
|
local config_file="$1"
|
|
local preset="$2"
|
|
local compile_only_presets="$3"
|
|
local compile_fn="$4"
|
|
local test_fn="$5"
|
|
|
|
hardhat_clean
|
|
force_hardhat_compiler_settings "$config_file" "$preset"
|
|
compile_and_run_test compile_fn test_fn hardhat_verify_compiler_version "$preset" "$compile_only_presets"
|
|
}
|
|
|
|
function external_test
|
|
{
|
|
local name="$1"
|
|
local main_fn="$2"
|
|
|
|
printTask "Testing $name..."
|
|
echo "==========================="
|
|
DIR=$(mktemp -d -t "ext-test-${name}-XXXXXX")
|
|
(
|
|
[[ "$main_fn" != "" ]] || fail "Test main function not defined."
|
|
$main_fn
|
|
)
|
|
rm -rf "$DIR"
|
|
echo "Done."
|
|
}
|