aboutsummaryrefslogtreecommitdiffstats
path: root/SolidityScanner.cpp
blob: 355ea9e2267266130b03af16f761761c8e09e8f0 (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
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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
/*
    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/>.
*/
/**
 * @author Christian <c@ethdev.com>
 * @date 2014
 * Unit tests for the solidity scanner.
 */

#include <libsolidity/Scanner.h>
#include <boost/test/unit_test.hpp>

namespace dev
{
namespace solidity
{
namespace test
{

BOOST_AUTO_TEST_SUITE(SolidityScanner)

BOOST_AUTO_TEST_CASE(test_empty)
{
    Scanner scanner(CharStream(""));
    BOOST_CHECK_EQUAL(scanner.getCurrentToken(), Token::EOS);
}

BOOST_AUTO_TEST_CASE(smoke_test)
{
    Scanner scanner(CharStream("function break;765  \t  \"string1\",'string2'\nidentifier1"));
    BOOST_CHECK_EQUAL(scanner.getCurrentToken(), Token::FUNCTION);
    BOOST_CHECK_EQUAL(scanner.next(), Token::BREAK);
    BOOST_CHECK_EQUAL(scanner.next(), Token::SEMICOLON);
    BOOST_CHECK_EQUAL(scanner.next(), Token::NUMBER);
    BOOST_CHECK_EQUAL(scanner.getCurrentLiteral(), "765");
    BOOST_CHECK_EQUAL(scanner.next(), Token::STRING_LITERAL);
    BOOST_CHECK_EQUAL(scanner.getCurrentLiteral(), "string1");
    BOOST_CHECK_EQUAL(scanner.next(), Token::COMMA);
    BOOST_CHECK_EQUAL(scanner.next(), Token::STRING_LITERAL);
    BOOST_CHECK_EQUAL(scanner.getCurrentLiteral(), "string2");
    BOOST_CHECK_EQUAL(scanner.next(), Token::IDENTIFIER);
    BOOST_CHECK_EQUAL(scanner.getCurrentLiteral(), "identifier1");
    BOOST_CHECK_EQUAL(scanner.next(), Token::EOS);
}

BOOST_AUTO_TEST_CASE(string_escapes)
{
    Scanner scanner(CharStream("  { \"a\\x61\""));
    BOOST_CHECK_EQUAL(scanner.getCurrentToken(), Token::LBRACE);
    BOOST_CHECK_EQUAL(scanner.next(), Token::STRING_LITERAL);
    BOOST_CHECK_EQUAL(scanner.getCurrentLiteral(), "aa");
}

BOOST_AUTO_TEST_CASE(string_escapes_with_zero)
{
    Scanner scanner(CharStream("  { \"a\\x61\\x00abc\""));
    BOOST_CHECK_EQUAL(scanner.getCurrentToken(), Token::LBRACE);
    BOOST_CHECK_EQUAL(scanner.next(), Token::STRING_LITERAL);
    BOOST_CHECK_EQUAL(scanner.getCurrentLiteral(), std::string("aa\0abc", 6));
}

BOOST_AUTO_TEST_CASE(string_escape_illegal)
{
    Scanner scanner(CharStream(" bla \"\\x6rf\" (illegalescape)"));
    BOOST_CHECK_EQUAL(scanner.getCurrentToken(), Token::IDENTIFIER);
    BOOST_CHECK_EQUAL(scanner.next(), Token::ILLEGAL);
    BOOST_CHECK_EQUAL(scanner.getCurrentLiteral(), "");
    // TODO recovery from illegal tokens should be improved
    BOOST_CHECK_EQUAL(scanner.next(), Token::ILLEGAL);
    BOOST_CHECK_EQUAL(scanner.next(), Token::IDENTIFIER);
    BOOST_CHECK_EQUAL(scanner.next(), Token::ILLEGAL);
    BOOST_CHECK_EQUAL(scanner.next(), Token::EOS);
}

BOOST_AUTO_TEST_CASE(hex_numbers)
{
    Scanner scanner(CharStream("var x = 0x765432536763762734623472346;"));
    BOOST_CHECK_EQUAL(scanner.getCurrentToken(), Token::VAR);
    BOOST_CHECK_EQUAL(scanner.next(), Token::IDENTIFIER);
    BOOST_CHECK_EQUAL(scanner.next(), Token::ASSIGN);
    BOOST_CHECK_EQUAL(scanner.next(), Token::NUMBER);
    BOOST_CHECK_EQUAL(scanner.getCurrentLiteral(), "0x765432536763762734623472346");
    BOOST_CHECK_EQUAL(scanner.next(), Token::SEMICOLON);
    BOOST_CHECK_EQUAL(scanner.next(), Token::EOS);
}

BOOST_AUTO_TEST_CASE(negative_numbers)
{
    Scanner scanner(CharStream("var x = -.2 + -0x78 + -7.3 + 8.9;"));
    BOOST_CHECK_EQUAL(scanner.getCurrentToken(), Token::VAR);
    BOOST_CHECK_EQUAL(scanner.next(), Token::IDENTIFIER);
    BOOST_CHECK_EQUAL(scanner.next(), Token::ASSIGN);
    BOOST_CHECK_EQUAL(scanner.next(), Token::NUMBER);
    BOOST_CHECK_EQUAL(scanner.getCurrentLiteral(), "-.2");
    BOOST_CHECK_EQUAL(scanner.next(), Token::ADD);
    BOOST_CHECK_EQUAL(scanner.next(), Token::NUMBER);
    BOOST_CHECK_EQUAL(scanner.getCurrentLiteral(), "-0x78");
    BOOST_CHECK_EQUAL(scanner.next(), Token::ADD);
    BOOST_CHECK_EQUAL(scanner.next(), Token::NUMBER);
    BOOST_CHECK_EQUAL(scanner.getCurrentLiteral(), "-7.3");
    BOOST_CHECK_EQUAL(scanner.next(), Token::ADD);
    BOOST_CHECK_EQUAL(scanner.next(), Token::NUMBER);
    BOOST_CHECK_EQUAL(scanner.getCurrentLiteral(), "8.9");
    BOOST_CHECK_EQUAL(scanner.next(), Token::SEMICOLON);
    BOOST_CHECK_EQUAL(scanner.next(), Token::EOS);
}

BOOST_AUTO_TEST_CASE(locations)
{
    Scanner scanner(CharStream("function_identifier has ; -0x743/*comment*/\n ident //comment"));
    BOOST_CHECK_EQUAL(scanner.getCurrentToken(), Token::IDENTIFIER);
    BOOST_CHECK_EQUAL(scanner.getCurrentLocation().start, 0);
    BOOST_CHECK_EQUAL(scanner.getCurrentLocation().end, 19);
    BOOST_CHECK_EQUAL(scanner.next(), Token::IDENTIFIER);
    BOOST_CHECK_EQUAL(scanner.getCurrentLocation().start, 20);
    BOOST_CHECK_EQUAL(scanner.getCurrentLocation().end, 23);
    BOOST_CHECK_EQUAL(scanner.next(), Token::SEMICOLON);
    BOOST_CHECK_EQUAL(scanner.getCurrentLocation().start, 24);
    BOOST_CHECK_EQUAL(scanner.getCurrentLocation().end, 25);
    BOOST_CHECK_EQUAL(scanner.next(), Token::NUMBER);
    BOOST_CHECK_EQUAL(scanner.getCurrentLocation().start, 26);
    BOOST_CHECK_EQUAL(scanner.getCurrentLocation().end, 32);
    BOOST_CHECK_EQUAL(scanner.next(), Token::IDENTIFIER);
    BOOST_CHECK_EQUAL(scanner.getCurrentLocation().start, 45);
    BOOST_CHECK_EQUAL(scanner.getCurrentLocation().end, 50);
    BOOST_CHECK_EQUAL(scanner.next(), Token::EOS);
}

BOOST_AUTO_TEST_CASE(ambiguities)
{
    // test scanning of some operators which need look-ahead
    Scanner scanner(CharStream("<=""<""+ +=a++ =>""<<"));
    BOOST_CHECK_EQUAL(scanner.getCurrentToken(), Token::LTE);
    BOOST_CHECK_EQUAL(scanner.next(), Token::LT);
    BOOST_CHECK_EQUAL(scanner.next(), Token::ADD);
    BOOST_CHECK_EQUAL(scanner.next(), Token::ASSIGN_ADD);
    BOOST_CHECK_EQUAL(scanner.next(), Token::IDENTIFIER);
    BOOST_CHECK_EQUAL(scanner.next(), Token::INC);
    BOOST_CHECK_EQUAL(scanner.next(), Token::ARROW);
    BOOST_CHECK_EQUAL(scanner.next(), Token::SHL);
}

BOOST_AUTO_TEST_CASE(documentation_comments_parsed_begin)
{
    Scanner scanner(CharStream("/// Send $(value / 1000) chocolates to the user"));
    BOOST_CHECK_EQUAL(scanner.getCurrentToken(), Token::EOS);
    BOOST_CHECK_EQUAL(scanner.getCurrentCommentLiteral(), "Send $(value / 1000) chocolates to the user");
}

BOOST_AUTO_TEST_CASE(multiline_documentation_comments_parsed_begin)
{
    Scanner scanner(CharStream("/** Send $(value / 1000) chocolates to the user*/"));
    BOOST_CHECK_EQUAL(scanner.getCurrentToken(), Token::EOS);
    BOOST_CHECK_EQUAL(scanner.getCurrentCommentLiteral(), "Send $(value / 1000) chocolates to the user");
}

BOOST_AUTO_TEST_CASE(documentation_comments_parsed)
{
    Scanner scanner(CharStream("some other tokens /// Send $(value / 1000) chocolates to the user"));
    BOOST_CHECK_EQUAL(scanner.getCurrentToken(), Token::IDENTIFIER);
    BOOST_CHECK_EQUAL(scanner.next(), Token::IDENTIFIER);
    BOOST_CHECK_EQUAL(scanner.next(), Token::IDENTIFIER);
    BOOST_CHECK_EQUAL(scanner.next(), Token::EOS);
    BOOST_CHECK_EQUAL(scanner.getCurrentCommentLiteral(), "Send $(value / 1000) chocolates to the user");
}

BOOST_AUTO_TEST_CASE(multiline_documentation_comments_parsed)
{
    Scanner scanner(CharStream("some other tokens /**\n"
                               "* Send $(value / 1000) chocolates to the user\n"
                               "*/"));
    BOOST_CHECK_EQUAL(scanner.getCurrentToken(), Token::IDENTIFIER);
    BOOST_CHECK_EQUAL(scanner.next(), Token::IDENTIFIER);
    BOOST_CHECK_EQUAL(scanner.next(), Token::IDENTIFIER);
    BOOST_CHECK_EQUAL(scanner.next(), Token::EOS);
    BOOST_CHECK_EQUAL(scanner.getCurrentCommentLiteral(), "Send $(value / 1000) chocolates to the user");
}

BOOST_AUTO_TEST_CASE(multiline_documentation_no_stars)
{
    Scanner scanner(CharStream("some other tokens /**\n"
                               " Send $(value / 1000) chocolates to the user\n"
                               "*/"));
    BOOST_CHECK_EQUAL(scanner.getCurrentToken(), Token::IDENTIFIER);
    BOOST_CHECK_EQUAL(scanner.next(), Token::IDENTIFIER);
    BOOST_CHECK_EQUAL(scanner.next(), Token::IDENTIFIER);
    BOOST_CHECK_EQUAL(scanner.next(), Token::EOS);
    BOOST_CHECK_EQUAL(scanner.getCurrentCommentLiteral(), "Send $(value / 1000) chocolates to the user");
}

BOOST_AUTO_TEST_CASE(multiline_documentation_whitespace_hell)
{
    Scanner scanner(CharStream("some other tokens /** \t \r \n"
                               "\t \r  * Send $(value / 1000) chocolates to the user\n"
                               "*/"));
    BOOST_CHECK_EQUAL(scanner.getCurrentToken(), Token::IDENTIFIER);
    BOOST_CHECK_EQUAL(scanner.next(), Token::IDENTIFIER);
    BOOST_CHECK_EQUAL(scanner.next(), Token::IDENTIFIER);
    BOOST_CHECK_EQUAL(scanner.next(), Token::EOS);
    BOOST_CHECK_EQUAL(scanner.getCurrentCommentLiteral(), "Send $(value / 1000) chocolates to the user");
}

BOOST_AUTO_TEST_CASE(comment_before_eos)
{
    Scanner scanner(CharStream("//"));
    BOOST_CHECK_EQUAL(scanner.getCurrentToken(), Token::EOS);
    BOOST_CHECK_EQUAL(scanner.getCurrentCommentLiteral(), "");
}

BOOST_AUTO_TEST_CASE(documentation_comment_before_eos)
{
    Scanner scanner(CharStream("///"));
    BOOST_CHECK_EQUAL(scanner.getCurrentToken(), Token::EOS);
    BOOST_CHECK_EQUAL(scanner.getCurrentCommentLiteral(), "");
}

BOOST_AUTO_TEST_CASE(empty_multiline_documentation_comment_before_eos)
{
    Scanner scanner(CharStream("/***/"));
    BOOST_CHECK_EQUAL(scanner.getCurrentToken(), Token::EOS);
    BOOST_CHECK_EQUAL(scanner.getCurrentCommentLiteral(), "");
}

BOOST_AUTO_TEST_CASE(comments_mixed_in_sequence)
{
    Scanner scanner(CharStream("hello_world ///documentation comment \n"
                               "//simple comment \n"
                               "<<"));
    BOOST_CHECK_EQUAL(scanner.getCurrentToken(), Token::IDENTIFIER);
    BOOST_CHECK_EQUAL(scanner.next(), Token::SHL);
    BOOST_CHECK_EQUAL(scanner.getCurrentCommentLiteral(), "documentation comment ");
}

BOOST_AUTO_TEST_SUITE_END()

}
}
} // end namespaces