aboutsummaryrefslogtreecommitdiffstats
path: root/test/libsolidity/SMTCheckerJSONTest.cpp
blob: 6e1329a965c2b4f9efcf08f0300be37f4fe4cf66 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
/*
    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/>.
*/

#include <test/libsolidity/SMTCheckerJSONTest.h>
#include <test/Options.h>
#include <libsolidity/interface/StandardCompiler.h>
#include <libdevcore/JSON.h>
#include <boost/algorithm/string.hpp>
#include <boost/algorithm/string/join.hpp>
#include <boost/algorithm/string/predicate.hpp>
#include <boost/throw_exception.hpp>
#include <fstream>
#include <memory>
#include <stdexcept>
#include <sstream>

using namespace dev;
using namespace solidity;
using namespace dev::solidity::test;
using namespace dev::solidity::test::formatting;
using namespace std;
using namespace boost::unit_test;

SMTCheckerTest::SMTCheckerTest(string const& _filename)
: SyntaxTest(_filename)
{
    BOOST_REQUIRE_MESSAGE(boost::algorithm::ends_with(_filename, ".sol"), "Invalid test contract file name: \"" + _filename + "\".");

    string jsonFilename = _filename.substr(0, _filename.size() - 4) + ".json";
    BOOST_CHECK(jsonParseFile(jsonFilename, m_smtResponses));
    BOOST_CHECK(m_smtResponses.isObject());
}

bool SMTCheckerTest::run(ostream& _stream, string const& _linePrefix, bool const _formatted)
{
    StandardCompiler compiler;

    // Run the compiler and retrieve the smtlib2queries (1st run)
    string versionPragma = "pragma solidity >=0.0;\n";
    Json::Value input = buildJson(versionPragma);
    Json::Value result = compiler.compile(input);

    // This is the list of query hashes requested by the 1st run
    vector<string> outHashes = hashesFromJson(result, "auxiliaryInputRequested", "smtlib2queries");

    // This is the list of responses provided in the test
    string auxInput("auxiliaryInput");
    BOOST_CHECK(m_smtResponses.isMember(auxInput));
    vector<string> inHashes = hashesFromJson(m_smtResponses, auxInput, "smtlib2responses");

    // Ensure that the provided list matches the requested one
    BOOST_CHECK_MESSAGE(
        outHashes == inHashes,
        "SMT query hashes differ: " + boost::algorithm::join(outHashes, ", ") + " x " + boost::algorithm::join(inHashes, ", ")
    );

    // Rerun the compiler with the provided hashed (2nd run)
    input[auxInput] = m_smtResponses[auxInput];
    Json::Value endResult = compiler.compile(input);

    BOOST_CHECK(endResult.isMember("errors"));
    Json::Value const& errors = endResult["errors"];
    for (auto const& error: errors)
    {
        BOOST_CHECK(error.isMember("type") && error["type"].isString());
        BOOST_CHECK(error.isMember("message") && error["message"].isString());
        if (!error.isMember("sourceLocation"))
            continue;
        Json::Value const& location = error["sourceLocation"];
        BOOST_CHECK(location.isMember("start") && location["start"].isInt());
        BOOST_CHECK(location.isMember("end") && location["end"].isInt());
        int start = location["start"].asInt();
        int end = location["end"].asInt();
        if (start >= static_cast<int>(versionPragma.size()))
            start -= versionPragma.size();
        if (end >= static_cast<int>(versionPragma.size()))
            end -= versionPragma.size();
        m_errorList.emplace_back(SyntaxTestError{
            error["type"].asString(),
            error["message"].asString(),
            start,
            end
        });
    }

    return printExpectationAndError(_stream, _linePrefix, _formatted);
}

vector<string> SMTCheckerTest::hashesFromJson(Json::Value const& _jsonObj, string const& _auxInput, string const& _smtlib)
{
    vector<string> hashes;
    Json::Value const& auxInputs = _jsonObj[_auxInput];
    if (!!auxInputs)
    {
        Json::Value const& smtlib = auxInputs[_smtlib];
        if (!!smtlib)
            for (auto const& hashString: smtlib.getMemberNames())
                hashes.push_back(hashString);
    }
    return hashes;
}

Json::Value SMTCheckerTest::buildJson(string const& _extra)
{
    string language = "\"language\": \"Solidity\"";
    string sourceName = "\"A\"";
    string sourceContent = "\"" + _extra + m_source + "\"";
    string sourceObj = "{ \"content\": " + sourceContent + "}";
    string sources = " \"sources\": { " + sourceName + ": " + sourceObj + "}";
    string input = "{" + language + ", " + sources + "}";
    Json::Value source;
    BOOST_REQUIRE(jsonParse(input, source));
    return source;
}