aboutsummaryrefslogtreecommitdiffstats
path: root/TestHelper.h
blob: 37c90add5c479b5c9e62f3a92f5cab1fb72c2334 (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
129
130
131
132
133
134
135
136
/*
    This file is part of cpp-ethereum.

    cpp-ethereum 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.

    cpp-ethereum 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 cpp-ethereum.  If not, see <http://www.gnu.org/licenses/>.
*/
/** @file TestHelper.h
 * @author Marko Simovic <markobarko@gmail.com>
 * @date 2014
 */

#pragma once

#include <functional>

#include <boost/test/unit_test.hpp>

#include "JsonSpiritHeaders.h"
#include <libethereum/State.h>
#include <libevm/ExtVMFace.h>

namespace dev
{
namespace eth
{

class Client;

void mine(Client& c, int numBlocks);
void connectClients(Client& c1, Client& c2);

}

namespace test
{

/// Make sure that no Exception is thrown during testing. If one is thrown show its info and fail the test.
/// Our version of BOOST_REQUIRE_NO_THROW()
/// @param _expression    The expression for which to make sure no exceptions are thrown
/// @param _message       A message to act as a prefix to the expression's error information
#define ETH_TEST_REQUIRE_NO_THROW(_expression, _message)                \
    do {                                                                \
        try                                                         \
        {                                                               \
            _expression;                                                \
        }                                                               \
        catch (boost::exception const& _e)                              \
        {                                                               \
            auto msg = std::string(_message) + boost::diagnostic_information(_e); \
            BOOST_FAIL(msg);                                            \
        }                                                               \
    }while (0)

/// Check if an Exception is thrown during testing. If one is thrown show its info and continue the test
/// Our version of BOOST_CHECK_NO_THROW()
/// @param _expression    The expression for which to make sure no exceptions are thrown
/// @param _message       A message to act as a prefix to the expression's error information
#define ETH_TEST_CHECK_NO_THROW(_expression, _message)                  \
    do {                                                                \
        try                                                         \
        {                                                               \
            _expression;                                                \
        }                                                               \
        catch (boost::exception const& _e)                              \
        {                                                               \
            auto msg = std::string(_message) + boost::diagnostic_information(_e); \
            BOOST_MESSAGE(msg);                                     \
        }                                                               \
    }while (0)


class ImportTest
{
public:
    ImportTest(json_spirit::mObject& _o) : m_statePre(Address(), OverlayDB(), eth::BaseState::Empty),  m_statePost(Address(), OverlayDB(), eth::BaseState::Empty), m_TestObject(_o) {}
    ImportTest(json_spirit::mObject& _o, bool isFiller);
    // imports
    void importEnv(json_spirit::mObject& _o);
    void importState(json_spirit::mObject& _o, eth::State& _state);
    void importTransaction(json_spirit::mObject& _o);
    void exportTest(bytes const& _output, eth::State const& _statePost);

    eth::State m_statePre;
    eth::State m_statePost;
    eth::ExtVMFace m_environment;
    eth::Transaction m_transaction;

private:
    json_spirit::mObject& m_TestObject;
};

// helping functions
u256 toInt(json_spirit::mValue const& _v);
byte toByte(json_spirit::mValue const& _v);
bytes importCode(json_spirit::mObject& _o);
bytes importData(json_spirit::mObject& _o);
bytes importByteArray(std::string const& _str);
eth::LogEntries importLog(json_spirit::mArray& _o);
json_spirit::mArray exportLog(eth::LogEntries _logs);
void checkOutput(bytes const& _output, json_spirit::mObject& _o);
void checkStorage(std::map<u256, u256> _expectedStore, std::map<u256, u256> _resultStore, Address _expectedAddr);
void checkLog(eth::LogEntries _resultLogs, eth::LogEntries _expectedLogs);
void checkCallCreates(eth::Transactions _resultCallCreates, eth::Transactions _expectedCallCreates);

void executeTests(const std::string& _name, const std::string& _testPathAppendix, std::function<void(json_spirit::mValue&, bool)> doTests);
std::string getTestPath();
void userDefinedTest(std::string testTypeFlag, std::function<void(json_spirit::mValue&, bool)> doTests);
RLPStream createRLPStreamFromTransactionFields(json_spirit::mObject& _tObj);
void processCommandLineOptions();
eth::LastHashes lastHashes(u256 _currentBlockNumber);

template<typename mapType>
void checkAddresses(mapType& _expectedAddrs, mapType& _resultAddrs)
{
    for (auto& resultPair : _resultAddrs)
    {
        auto& resultAddr = resultPair.first;
        auto expectedAddrIt = _expectedAddrs.find(resultAddr);
        if (expectedAddrIt == _expectedAddrs.end())
            BOOST_ERROR("Missing result address " << resultAddr);
    }
    BOOST_CHECK(_expectedAddrs == _resultAddrs);
}

}
}