solidity/test/TestCaseReader.cpp at develop · argotorg/solidity · GitHub

History

213 lines (184 loc) · 7.65 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

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

#include <test/TestCaseReader.h>

#include <libsolutil/CommonIO.h>

#include <boost/algorithm/string.hpp>

#include <boost/filesystem.hpp>

using namespace solidity::frontend::test;

namespace fs = boost::filesystem;

TestCaseReader::TestCaseReader(std::string const& _filename): m_fileStream(_filename), m_fileName(_filename)

{

if (!m_fileStream)

BOOST_THROW_EXCEPTION(std::runtime_error("Cannot open file: \"" + _filename + "\"."));

m_fileStream.exceptions(std::ios::badbit);

std::tie(m_sources, m_lineNumber) = parseSourcesAndSettingsWithLineNumber(m_fileStream);

m_unreadSettings = m_settings;

}

TestCaseReader::TestCaseReader(std::istringstream const& _str)

{

std::tie(m_sources, m_lineNumber) = parseSourcesAndSettingsWithLineNumber(

static_cast<std::istream&>(const_cast<std::istringstream&>(_str))

);

}

std::string const& TestCaseReader::source() const

{

if (m_sources.sources.size() != 1)

BOOST_THROW_EXCEPTION(std::runtime_error("Expected single source definition, but got multiple sources."));

return m_sources.sources.at(m_sources.mainSourceFile);

}

std::string TestCaseReader::simpleExpectations()

{

return parseSimpleExpectations(m_fileStream);

}

bool TestCaseReader::boolSetting(std::string const& _name, bool _defaultValue)

{

if (m_settings.count(_name) == 0)

return _defaultValue;

m_unreadSettings.erase(_name);

std::string value = m_settings.at(_name);

if (value == "false")

return false;

if (value == "true")

return true;

BOOST_THROW_EXCEPTION(std::runtime_error("Invalid Boolean value: " + value + "."));

}

size_t TestCaseReader::sizetSetting(std::string const& _name, size_t _defaultValue)

{

if (m_settings.count(_name) == 0)

return _defaultValue;

m_unreadSettings.erase(_name);

static_assert(sizeof(unsigned long) <= sizeof(size_t));

return stoul(m_settings.at(_name));

}

std::string TestCaseReader::stringSetting(std::string const& _name, std::string const& _defaultValue)

{

if (m_settings.count(_name) == 0)

return _defaultValue;

m_unreadSettings.erase(_name);

return m_settings.at(_name);

}

void TestCaseReader::ensureAllSettingsRead() const

{

if (!m_unreadSettings.empty())

BOOST_THROW_EXCEPTION(std::runtime_error(

"Unknown setting(s): " +

util::joinHumanReadable(m_unreadSettings | ranges::views::keys)

));

}

std::pair<SourceMap, size_t> TestCaseReader::parseSourcesAndSettingsWithLineNumber(std::istream& _stream)

{

std::map<std::string, std::string> sources;

std::map<std::string, boost::filesystem::path> externalSources;

std::string currentSourceName;

std::string currentSource;

std::string line;

size_t lineNumber = 1;

static std::string const externalSourceDelimiterStart("==== ExternalSource:");

static std::string const sourceDelimiterStart("==== Source:");

static std::string const sourceDelimiterEnd("====");

static std::string const comment("// ");

static std::string const settingsDelimiter("// ====");

static std::string const expectationsDelimiter("// ----");

bool sourcePart = true;

while (getline(_stream, line))

{

lineNumber++;

// Anything below the delimiter is left up to the test case to process in a custom way.

if (boost::algorithm::starts_with(line, expectationsDelimiter))

break;

if (boost::algorithm::starts_with(line, settingsDelimiter))

sourcePart = false;

else if (sourcePart)

{

if (boost::algorithm::starts_with(line, sourceDelimiterStart) && boost::algorithm::ends_with(line, sourceDelimiterEnd))

{

if (!(currentSourceName.empty() && currentSource.empty()))

sources[currentSourceName] = std::move(currentSource);

currentSource = {};

currentSourceName = boost::trim_copy(line.substr(

sourceDelimiterStart.size(),

line.size() - sourceDelimiterEnd.size() - sourceDelimiterStart.size()

));

if (sources.count(currentSourceName))

BOOST_THROW_EXCEPTION(std::runtime_error("Multiple definitions of test source \"" + currentSourceName + "\"."));

}

else if (boost::algorithm::starts_with(line, externalSourceDelimiterStart) && boost::algorithm::ends_with(line, sourceDelimiterEnd))

{

std::string externalSourceString = boost::trim_copy(line.substr(

externalSourceDelimiterStart.size(),

line.size() - sourceDelimiterEnd.size() - externalSourceDelimiterStart.size()

));

std::string externalSourceName;

size_t remappingPos = externalSourceString.find('=');

// Does the external source define a remapping?

if (remappingPos != std::string::npos)

{

externalSourceName = boost::trim_copy(externalSourceString.substr(0, remappingPos));

externalSourceString = boost::trim_copy(externalSourceString.substr(remappingPos + 1));

}

else

externalSourceName = externalSourceString;

soltestAssert(!externalSourceName.empty(), "");

fs::path externalSourceTarget(externalSourceString);

fs::path testCaseParentDir = m_fileName.parent_path();

if (!externalSourceTarget.is_relative() || !externalSourceTarget.root_path().empty())

// NOTE: UNC paths (ones starting with // or \\) are considered relative by Boost

// since they have an empty root directory (but non-empty root name).

BOOST_THROW_EXCEPTION(std::runtime_error("External Source paths need to be relative to the location of the test case."));

fs::path externalSourceFullPath = testCaseParentDir / externalSourceTarget;

std::string externalSourceContent;

if (!fs::exists(externalSourceFullPath))

BOOST_THROW_EXCEPTION(std::runtime_error("External Source '" + externalSourceTarget.string() + "' not found."));

else

externalSourceContent = util::readFileAsString(externalSourceFullPath);

if (sources.count(externalSourceName))

BOOST_THROW_EXCEPTION(std::runtime_error("Multiple definitions of test source \"" + externalSourceName + "\"."));

sources[externalSourceName] = externalSourceContent;

externalSources[externalSourceName] = externalSourceTarget;

}

else

currentSource += line + "\n";

}

else if (boost::algorithm::starts_with(line, comment))

{

size_t colon = line.find(':');

if (colon == std::string::npos)

BOOST_THROW_EXCEPTION(std::runtime_error(std::string("Expected \":\" inside setting.")));

std::string key = line.substr(comment.size(), colon - comment.size());

std::string value = line.substr(colon + 1);

boost::algorithm::trim(key);

boost::algorithm::trim(value);

m_settings[key] = value;

}

else

BOOST_THROW_EXCEPTION(std::runtime_error(std::string("Expected \"//\" or \"// ---\" to terminate settings and source.")));

}

// Register the last source as the main one

sources[currentSourceName] = currentSource;

return {{std::move(sources), std::move(externalSources), std::move(currentSourceName)}, lineNumber};

}

std::string TestCaseReader::parseSimpleExpectations(std::istream& _file)

{

std::string result;

std::string line;

while (std::getline(_file, line))

if (boost::algorithm::starts_with(line, "// "))

result += line.substr(3) + "\n";

else if (line == "//")

result += "\n";

else

BOOST_THROW_EXCEPTION(std::runtime_error("Test expectations must start with \"// \"."));

return result;

}

solidity/test/TestCaseReader.cpp at develop · argotorg/solidity · GitHub

Uh oh!

Expand file tree

Breadcrumbs

TestCaseReader.cpp

Latest commit

History

Breadcrumbs

TestCaseReader.cpp

File metadata and controls