2020-02-04 18:40:32 +00:00
|
|
|
/*
|
|
|
|
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/>.
|
|
|
|
*/
|
2020-07-17 14:54:12 +00:00
|
|
|
// SPDX-License-Identifier: GPL-3.0
|
2020-02-04 18:40:32 +00:00
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
|
|
|
#include <test/libsolidity/AnalysisFramework.h>
|
|
|
|
#include <test/TestCase.h>
|
2021-03-15 22:52:24 +00:00
|
|
|
#include <test/TestCaseReader.h>
|
2020-02-04 18:40:32 +00:00
|
|
|
#include <liblangutil/Exceptions.h>
|
|
|
|
#include <libsolutil/AnsiColorized.h>
|
|
|
|
|
|
|
|
#include <iosfwd>
|
|
|
|
#include <string>
|
|
|
|
#include <vector>
|
|
|
|
#include <utility>
|
|
|
|
|
|
|
|
namespace solidity::test
|
|
|
|
{
|
|
|
|
|
|
|
|
struct SyntaxTestError
|
|
|
|
{
|
2023-09-29 20:08:10 +00:00
|
|
|
langutil::Error::Type type;
|
2020-06-22 14:53:03 +00:00
|
|
|
std::optional<langutil::ErrorId> errorId;
|
2020-02-04 18:40:32 +00:00
|
|
|
std::string message;
|
|
|
|
std::string sourceName;
|
|
|
|
int locationStart = -1;
|
|
|
|
int locationEnd = -1;
|
|
|
|
bool operator==(SyntaxTestError const& _rhs) const
|
|
|
|
{
|
|
|
|
return type == _rhs.type &&
|
2020-06-22 14:53:03 +00:00
|
|
|
errorId == _rhs.errorId &&
|
2020-02-04 18:40:32 +00:00
|
|
|
message == _rhs.message &&
|
|
|
|
sourceName == _rhs.sourceName &&
|
|
|
|
locationStart == _rhs.locationStart &&
|
|
|
|
locationEnd == _rhs.locationEnd;
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
class CommonSyntaxTest: public frontend::test::EVMVersionRestrictedTestCase
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
CommonSyntaxTest(std::string const& _filename, langutil::EVMVersion _evmVersion);
|
|
|
|
|
|
|
|
TestResult run(std::ostream& _stream, std::string const& _linePrefix = "", bool _formatted = false) override;
|
|
|
|
|
|
|
|
void printSource(std::ostream& _stream, std::string const &_linePrefix = "", bool _formatted = false) const override;
|
|
|
|
void printUpdatedExpectations(std::ostream& _stream, std::string const& _linePrefix) const override
|
|
|
|
{
|
2023-08-18 13:44:13 +00:00
|
|
|
printObtainedResult(_stream, _linePrefix, false);
|
2020-02-04 18:40:32 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static std::string errorMessage(util::Exception const& _e);
|
|
|
|
protected:
|
2023-08-18 13:44:13 +00:00
|
|
|
/// Should be implemented by those derived test cases that want to allow extra expectations
|
|
|
|
/// after the error/warning expectations. The default implementation does not allow them and
|
|
|
|
/// fails instead.
|
|
|
|
/// @param _stream Input stream positioned at the beginning of the extra expectations.
|
|
|
|
virtual void parseCustomExpectations(std::istream& _stream);
|
|
|
|
|
2020-02-04 18:40:32 +00:00
|
|
|
virtual void parseAndAnalyze() = 0;
|
|
|
|
|
2023-08-18 13:44:13 +00:00
|
|
|
/// Should return true if obtained values match expectations.
|
|
|
|
/// The default implementation only compares the error list. Derived classes that support
|
|
|
|
/// custom expectations should override this to include them in the comparison.
|
|
|
|
virtual bool expectationsMatch();
|
|
|
|
|
|
|
|
virtual void printExpectedResult(std::ostream& _stream, std::string const& _linePrefix, bool _formatted) const;
|
|
|
|
virtual void printObtainedResult(std::ostream& _stream, std::string const& _linePrefix, bool _formatted) const;
|
|
|
|
|
2020-02-04 18:40:32 +00:00
|
|
|
static void printErrorList(
|
|
|
|
std::ostream& _stream,
|
|
|
|
std::vector<SyntaxTestError> const& _errors,
|
|
|
|
std::string const& _linePrefix,
|
|
|
|
bool _formatted = false
|
|
|
|
);
|
|
|
|
|
2020-03-07 00:18:42 +00:00
|
|
|
TestResult conclude(std::ostream& _stream, std::string const& _linePrefix = "", bool _formatted = false);
|
|
|
|
void printExpectationAndError(std::ostream& _stream, std::string const& _linePrefix = "", bool _formatted = false);
|
2020-02-04 18:40:32 +00:00
|
|
|
|
|
|
|
static std::vector<SyntaxTestError> parseExpectations(std::istream& _stream);
|
|
|
|
|
2021-03-15 22:52:24 +00:00
|
|
|
frontend::test::SourceMap m_sources;
|
2020-02-04 18:40:32 +00:00
|
|
|
std::vector<SyntaxTestError> m_expectations;
|
|
|
|
std::vector<SyntaxTestError> m_errorList;
|
|
|
|
langutil::EVMVersion const m_evmVersion;
|
|
|
|
};
|
|
|
|
|
|
|
|
}
|