mirror of
https://github.com/ethereum/solidity
synced 2023-10-03 13:03:40 +00:00
9a7c364c71
- This makes `-` for stdin work. - `--ignore-missing` now works with `--standard-json`, though it's not very useful because there can be at most one input file. - Separate errors for situations where there are no input files on the command line (this can be detected in the parser) and where they are not present on disk.
347 lines
11 KiB
C++
347 lines
11 KiB
C++
/*
|
|
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/>.
|
|
*/
|
|
// SPDX-License-Identifier: GPL-3.0
|
|
|
|
/// Unit tests for solc/CommandLineInterface.h
|
|
|
|
#include <solc/CommandLineInterface.h>
|
|
|
|
#include <test/solc/Common.h>
|
|
|
|
#include <test/Common.h>
|
|
#include <test/libsolidity/util/SoltestErrors.h>
|
|
#include <test/FilesystemUtils.h>
|
|
#include <test/TemporaryDirectory.h>
|
|
|
|
#include <range/v3/view/transform.hpp>
|
|
|
|
#include <map>
|
|
#include <ostream>
|
|
#include <set>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
using namespace std;
|
|
using namespace solidity::frontend;
|
|
using namespace solidity::test;
|
|
|
|
using PathSet = set<boost::filesystem::path>;
|
|
|
|
#define TEST_CASE_NAME (boost::unit_test::framework::current_test_case().p_name)
|
|
|
|
namespace
|
|
{
|
|
|
|
ostream& operator<<(ostream& _out, vector<ImportRemapper::Remapping> const& _remappings)
|
|
{
|
|
static auto remappingToString = [](auto const& _remapping)
|
|
{
|
|
return _remapping.context + ":" + _remapping.prefix + "=" + _remapping.target;
|
|
};
|
|
|
|
_out << "[" << joinHumanReadable(_remappings | ranges::views::transform(remappingToString)) << "]";
|
|
return _out;
|
|
}
|
|
|
|
ostream& operator<<(ostream& _out, map<string, string> const& _map)
|
|
{
|
|
_out << "{" << endl;
|
|
for (auto const& [key, value]: _map)
|
|
_out << "" << key << ": " << value << "," << endl;
|
|
_out << "}";
|
|
|
|
return _out;
|
|
}
|
|
|
|
ostream& operator<<(ostream& _out, PathSet const& _paths)
|
|
{
|
|
static auto pathString = [](auto const& _path) { return _path.string(); };
|
|
|
|
_out << "{" << joinHumanReadable(_paths | ranges::views::transform(pathString)) << "}";
|
|
return _out;
|
|
}
|
|
|
|
} // namespace
|
|
|
|
namespace boost::test_tools::tt_detail
|
|
{
|
|
|
|
// Boost won't find the << operator unless we put it in the std namespace which is illegal.
|
|
// The recommended solution is to overload print_log_value<> struct and make it use our operator.
|
|
|
|
template<>
|
|
struct print_log_value<vector<ImportRemapper::Remapping>>
|
|
{
|
|
void operator()(std::ostream& _out, vector<ImportRemapper::Remapping> const& _value) { ::operator<<(_out, _value); }
|
|
};
|
|
|
|
template<>
|
|
struct print_log_value<map<string, string>>
|
|
{
|
|
void operator()(std::ostream& _out, map<string, string> const& _value) { ::operator<<(_out, _value); }
|
|
};
|
|
|
|
template<>
|
|
struct print_log_value<PathSet>
|
|
{
|
|
void operator()(std::ostream& _out, PathSet const& _value) { ::operator<<(_out, _value); }
|
|
};
|
|
|
|
} // namespace boost::test_tools::tt_detail
|
|
|
|
namespace solidity::frontend::test
|
|
{
|
|
|
|
BOOST_AUTO_TEST_SUITE(CommandLineInterfaceTest)
|
|
|
|
BOOST_AUTO_TEST_CASE(multiple_input_modes)
|
|
{
|
|
array<string, 6> inputModeOptions = {
|
|
"--standard-json",
|
|
"--link",
|
|
"--assemble",
|
|
"--strict-assembly",
|
|
"--yul",
|
|
"--import-ast",
|
|
};
|
|
string expectedMessage =
|
|
"The following options are mutually exclusive: "
|
|
"--standard-json, --link, --assemble, --strict-assembly, --yul, --import-ast. "
|
|
"Select at most one.\n";
|
|
|
|
for (string const& mode1: inputModeOptions)
|
|
for (string const& mode2: inputModeOptions)
|
|
if (mode1 != mode2)
|
|
{
|
|
vector<string> commandLine = {"solc", mode1, mode2};
|
|
OptionsReaderAndMessages result = parseCommandLineAndReadInputFiles(commandLine);
|
|
BOOST_TEST(!result.success);
|
|
BOOST_TEST(result.stderrContent == expectedMessage);
|
|
}
|
|
}
|
|
|
|
BOOST_AUTO_TEST_CASE(cli_input)
|
|
{
|
|
TemporaryDirectory tempDir1(TEST_CASE_NAME);
|
|
TemporaryDirectory tempDir2(TEST_CASE_NAME);
|
|
createFilesWithParentDirs({tempDir1.path() / "input1.sol"});
|
|
createFilesWithParentDirs({tempDir2.path() / "input2.sol"});
|
|
|
|
vector<ImportRemapper::Remapping> expectedRemappings = {
|
|
{"", "a", "b/c/d"},
|
|
{"a", "b", "c/d/e/"},
|
|
};
|
|
map<string, string> expectedSources = {
|
|
{"<stdin>", "\n"},
|
|
{(tempDir1.path() / "input1.sol").generic_string(), ""},
|
|
{(tempDir2.path() / "input2.sol").generic_string(), ""},
|
|
};
|
|
PathSet expectedAllowedPaths = {
|
|
boost::filesystem::canonical(tempDir1.path()),
|
|
boost::filesystem::canonical(tempDir2.path()),
|
|
"b/c",
|
|
"c/d/e",
|
|
};
|
|
|
|
OptionsReaderAndMessages result = parseCommandLineAndReadInputFiles({
|
|
"solc",
|
|
"a=b/c/d",
|
|
(tempDir1.path() / "input1.sol").string(),
|
|
(tempDir2.path() / "input2.sol").string(),
|
|
"a:b=c/d/e/",
|
|
"-",
|
|
});
|
|
|
|
BOOST_TEST(result.success);
|
|
BOOST_TEST(result.stderrContent == "");
|
|
BOOST_TEST(result.options.input.mode == InputMode::Compiler);
|
|
BOOST_TEST(result.options.input.addStdin);
|
|
BOOST_CHECK_EQUAL(result.options.input.remappings, expectedRemappings);
|
|
BOOST_CHECK_EQUAL(result.reader.sourceCodes(), expectedSources);
|
|
BOOST_CHECK_EQUAL(result.reader.allowedDirectories(), expectedAllowedPaths);
|
|
}
|
|
|
|
BOOST_AUTO_TEST_CASE(cli_ignore_missing_some_files_exist)
|
|
{
|
|
TemporaryDirectory tempDir1(TEST_CASE_NAME);
|
|
TemporaryDirectory tempDir2(TEST_CASE_NAME);
|
|
createFilesWithParentDirs({tempDir1.path() / "input1.sol"});
|
|
|
|
// NOTE: Allowed paths should not be added for skipped files.
|
|
map<string, string> expectedSources = {{(tempDir1.path() / "input1.sol").generic_string(), ""}};
|
|
PathSet expectedAllowedPaths = {boost::filesystem::canonical(tempDir1.path())};
|
|
|
|
OptionsReaderAndMessages result = parseCommandLineAndReadInputFiles({
|
|
"solc",
|
|
(tempDir1.path() / "input1.sol").string(),
|
|
(tempDir2.path() / "input2.sol").string(),
|
|
"--ignore-missing",
|
|
});
|
|
BOOST_TEST(result.success);
|
|
BOOST_TEST(result.stderrContent == "\"" + (tempDir2.path() / "input2.sol").string() + "\" is not found. Skipping.\n");
|
|
BOOST_TEST(result.options.input.mode == InputMode::Compiler);
|
|
BOOST_TEST(!result.options.input.addStdin);
|
|
BOOST_CHECK_EQUAL(result.reader.sourceCodes(), expectedSources);
|
|
BOOST_CHECK_EQUAL(result.reader.allowedDirectories(), expectedAllowedPaths);
|
|
}
|
|
|
|
BOOST_AUTO_TEST_CASE(cli_ignore_missing_no_files_exist)
|
|
{
|
|
TemporaryDirectory tempDir(TEST_CASE_NAME);
|
|
|
|
string expectedMessage =
|
|
"\"" + (tempDir.path() / "input1.sol").string() + "\" is not found. Skipping.\n"
|
|
"\"" + (tempDir.path() / "input2.sol").string() + "\" is not found. Skipping.\n"
|
|
"All specified input files either do not exist or are not regular files.\n";
|
|
|
|
OptionsReaderAndMessages result = parseCommandLineAndReadInputFiles({
|
|
"solc",
|
|
(tempDir.path() / "input1.sol").string(),
|
|
(tempDir.path() / "input2.sol").string(),
|
|
"--ignore-missing",
|
|
});
|
|
BOOST_TEST(!result.success);
|
|
BOOST_TEST(result.stderrContent == expectedMessage);
|
|
}
|
|
|
|
BOOST_AUTO_TEST_CASE(cli_not_a_file)
|
|
{
|
|
TemporaryDirectory tempDir(TEST_CASE_NAME);
|
|
|
|
string expectedMessage = "\"" + tempDir.path().string() + "\" is not a valid file.\n";
|
|
|
|
OptionsReaderAndMessages result = parseCommandLineAndReadInputFiles({"solc", tempDir.path().string()});
|
|
BOOST_TEST(!result.success);
|
|
BOOST_TEST(result.stderrContent == expectedMessage);
|
|
}
|
|
|
|
BOOST_AUTO_TEST_CASE(standard_json_base_path)
|
|
{
|
|
TemporaryDirectory tempDir(TEST_CASE_NAME);
|
|
|
|
OptionsReaderAndMessages result = parseCommandLineAndReadInputFiles({
|
|
"solc",
|
|
"--standard-json",
|
|
"--base-path=" + tempDir.path().string(),
|
|
});
|
|
BOOST_TEST(result.success);
|
|
BOOST_TEST(result.stderrContent == "");
|
|
BOOST_TEST(result.options.input.mode == InputMode::StandardJson);
|
|
BOOST_TEST(result.options.input.addStdin);
|
|
BOOST_TEST(result.options.input.paths.empty());
|
|
BOOST_TEST(result.reader.sourceCodes().empty());
|
|
BOOST_TEST(result.reader.allowedDirectories().empty());
|
|
BOOST_TEST(result.reader.basePath() == tempDir.path());
|
|
}
|
|
|
|
BOOST_AUTO_TEST_CASE(standard_json_no_input_file)
|
|
{
|
|
OptionsReaderAndMessages result = parseCommandLineAndReadInputFiles({"solc", "--standard-json"});
|
|
BOOST_TEST(result.success);
|
|
BOOST_TEST(result.stderrContent == "");
|
|
BOOST_TEST(result.options.input.mode == InputMode::StandardJson);
|
|
BOOST_TEST(result.options.input.addStdin);
|
|
BOOST_TEST(result.options.input.paths.empty());
|
|
BOOST_TEST(result.reader.sourceCodes().empty());
|
|
BOOST_TEST(result.reader.allowedDirectories().empty());
|
|
}
|
|
|
|
BOOST_AUTO_TEST_CASE(standard_json_dash)
|
|
{
|
|
OptionsReaderAndMessages result = parseCommandLineAndReadInputFiles({"solc", "--standard-json", "-"});
|
|
BOOST_TEST(result.success);
|
|
BOOST_TEST(result.stderrContent == "");
|
|
BOOST_TEST(result.options.input.mode == InputMode::StandardJson);
|
|
BOOST_TEST(result.options.input.addStdin);
|
|
BOOST_TEST(result.reader.sourceCodes().empty());
|
|
BOOST_TEST(result.reader.allowedDirectories().empty());
|
|
}
|
|
|
|
BOOST_AUTO_TEST_CASE(standard_json_one_input_file)
|
|
{
|
|
TemporaryDirectory tempDir(TEST_CASE_NAME);
|
|
createFilesWithParentDirs({tempDir.path() / "input.json"});
|
|
|
|
vector<string> commandLine = {"solc", "--standard-json", (tempDir.path() / "input.json").string()};
|
|
OptionsReaderAndMessages result = parseCommandLineAndReadInputFiles(commandLine);
|
|
BOOST_TEST(result.success);
|
|
BOOST_TEST(result.stderrContent == "");
|
|
BOOST_TEST(result.options.input.mode == InputMode::StandardJson);
|
|
BOOST_TEST(!result.options.input.addStdin);
|
|
BOOST_TEST(result.options.input.paths == PathSet{tempDir.path() / "input.json"});
|
|
BOOST_TEST(result.reader.allowedDirectories().empty());
|
|
}
|
|
|
|
BOOST_AUTO_TEST_CASE(standard_json_two_input_files)
|
|
{
|
|
string expectedMessage =
|
|
"Too many input files for --standard-json.\n"
|
|
"Please either specify a single file name or provide its content on standard input.\n";
|
|
|
|
vector<string> commandLine = {"solc", "--standard-json", "input1.json", "input2.json"};
|
|
OptionsReaderAndMessages result = parseCommandLineAndReadInputFiles(commandLine);
|
|
BOOST_TEST(!result.success);
|
|
BOOST_TEST(result.stderrContent == expectedMessage);
|
|
}
|
|
|
|
BOOST_AUTO_TEST_CASE(standard_json_one_input_file_and_stdin)
|
|
{
|
|
string expectedMessage =
|
|
"Too many input files for --standard-json.\n"
|
|
"Please either specify a single file name or provide its content on standard input.\n";
|
|
|
|
vector<string> commandLine = {"solc", "--standard-json", "input1.json", "-"};
|
|
OptionsReaderAndMessages result = parseCommandLineAndReadInputFiles(commandLine);
|
|
BOOST_TEST(!result.success);
|
|
BOOST_TEST(result.stderrContent == expectedMessage);
|
|
}
|
|
|
|
BOOST_AUTO_TEST_CASE(standard_json_ignore_missing)
|
|
{
|
|
TemporaryDirectory tempDir(TEST_CASE_NAME);
|
|
|
|
// This option is pretty much useless Standard JSON mode.
|
|
string expectedMessage =
|
|
"\"" + (tempDir.path() / "input.json").string() + "\" is not found. Skipping.\n"
|
|
"All specified input files either do not exist or are not regular files.\n";
|
|
|
|
OptionsReaderAndMessages result = parseCommandLineAndReadInputFiles({
|
|
"solc",
|
|
"--standard-json",
|
|
(tempDir.path() / "input.json").string(),
|
|
"--ignore-missing",
|
|
});
|
|
BOOST_TEST(!result.success);
|
|
BOOST_TEST(result.stderrContent == expectedMessage);
|
|
}
|
|
|
|
BOOST_AUTO_TEST_CASE(standard_json_remapping)
|
|
{
|
|
string expectedMessage =
|
|
"Import remappings are not accepted on the command line in Standard JSON mode.\n"
|
|
"Please put them under 'settings.remappings' in the JSON input.\n";
|
|
|
|
vector<string> commandLine = {"solc", "--standard-json", "a=b"};
|
|
OptionsReaderAndMessages result = parseCommandLineAndReadInputFiles(commandLine);
|
|
BOOST_TEST(!result.success);
|
|
BOOST_TEST(result.stderrContent == expectedMessage);
|
|
}
|
|
|
|
BOOST_AUTO_TEST_SUITE_END()
|
|
|
|
} // namespace solidity::frontend::test
|