aboutsummaryrefslogtreecommitdiffstats
path: root/test/libsolidity/SolidityNatspecJSON.cpp
blob: 73c080f70e027747a90c8660294744d8c97922f4 (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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
/*
    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 Lefteris Karapetsas <lefteris@ethdev.com>
 * @date 2014
 * Unit tests for the solidity compiler JSON Interface output.
 */

#include "../TestHelper.h"
#include <string>
#include <json/json.h>
#include <libsolidity/CompilerStack.h>
#include <libsolidity/Exceptions.h>
#include <libdevcore/Exceptions.h>

namespace dev
{
namespace solidity
{
namespace test
{

class DocumentationChecker
{
public:
    DocumentationChecker(): m_compilerStack(false) {}

    void checkNatspec(
        std::string const& _code,
        std::string const& _expectedDocumentationString,
        bool _userDocumentation
    )
    {
        std::string generatedDocumentationString;
        ETH_TEST_REQUIRE_NO_THROW(m_compilerStack.parse(_code), "Parsing failed");

        if (_userDocumentation)
            generatedDocumentationString = m_compilerStack.getMetadata("", DocumentationType::NatspecUser);
        else
            generatedDocumentationString = m_compilerStack.getMetadata("", DocumentationType::NatspecDev);
        Json::Value generatedDocumentation;
        m_reader.parse(generatedDocumentationString, generatedDocumentation);
        Json::Value expectedDocumentation;
        m_reader.parse(_expectedDocumentationString, expectedDocumentation);
        BOOST_CHECK_MESSAGE(
            expectedDocumentation == generatedDocumentation,
            "Expected " << _expectedDocumentationString <<
            "\n but got:\n" << generatedDocumentationString
        );
    }

private:
    CompilerStack m_compilerStack;
    Json::Reader m_reader;
};

BOOST_FIXTURE_TEST_SUITE(SolidityNatspecJSON, DocumentationChecker)

BOOST_AUTO_TEST_CASE(user_basic_test)
{
    char const* sourceCode = "contract test {\n"
    "  /// @notice Multiplies `a` by 7\n"
    "  function mul(uint a) returns(uint d) { return a * 7; }\n"
    "}\n";

    char const* natspec = "{"
    "\"methods\":{"
    "    \"mul(uint256)\":{ \"notice\": \"Multiplies `a` by 7\"}"
    "}}";

    checkNatspec(sourceCode, natspec, true);
}

BOOST_AUTO_TEST_CASE(dev_and_user_basic_test)
{
    char const* sourceCode = "contract test {\n"
    "  /// @notice Multiplies `a` by 7\n"
    "  /// @dev Multiplies a number by 7\n"
    "  function mul(uint a) returns(uint d) { return a * 7; }\n"
    "}\n";

    char const* devNatspec = "{"
    "\"methods\":{"
    "    \"mul(uint256)\":{ \n"
    "        \"details\": \"Multiplies a number by 7\"\n"
    "        }\n"
    "    }\n"
    "}}";

    char const* userNatspec = "{"
    "\"methods\":{"
    "    \"mul(uint256)\":{ \"notice\": \"Multiplies `a` by 7\"}"
    "}}";

    checkNatspec(sourceCode, devNatspec, false);
    checkNatspec(sourceCode, userNatspec, true);
}

BOOST_AUTO_TEST_CASE(user_multiline_comment)
{
    char const* sourceCode = "contract test {\n"
    "  /// @notice Multiplies `a` by 7\n"
    "  /// and then adds `b`\n"
    "  function mul_and_add(uint a, uint256 b) returns(uint256 d)\n"
    "  {\n"
    "      return (a * 7) + b;\n"
    "  }\n"
    "}\n";

    char const* natspec = "{"
    "\"methods\":{"
    "    \"mul_and_add(uint256,uint256)\":{ \"notice\": \"Multiplies `a` by 7 and then adds `b`\"}"
    "}}";

    checkNatspec(sourceCode, natspec, true);
}

BOOST_AUTO_TEST_CASE(user_multiple_functions)
{
    char const* sourceCode = "contract test {\n"
    "  /// @notice Multiplies `a` by 7 and then adds `b`\n"
    "  function mul_and_add(uint a, uint256 b) returns(uint256 d)\n"
    "  {\n"
    "      return (a * 7) + b;\n"
    "  }\n"
    "\n"
    "  /// @notice Divides `input` by `div`\n"
    "  function divide(uint input, uint div) returns(uint d)\n"
    "  {\n"
    "      return input / div;\n"
    "  }\n"
    "  /// @notice Subtracts 3 from `input`\n"
    "  function sub(int input) returns(int d)\n"
    "  {\n"
    "      return input - 3;\n"
    "  }\n"
    "}\n";

    char const* natspec = "{"
    "\"methods\":{"
    "    \"mul_and_add(uint256,uint256)\":{ \"notice\": \"Multiplies `a` by 7 and then adds `b`\"},"
    "    \"divide(uint256,uint256)\":{ \"notice\": \"Divides `input` by `div`\"},"
    "    \"sub(int256)\":{ \"notice\": \"Subtracts 3 from `input`\"}"
    "}}";

    checkNatspec(sourceCode, natspec, true);
}

BOOST_AUTO_TEST_CASE(user_empty_contract)
{
    char const* sourceCode = "contract test {\n"
    "}\n";

    char const* natspec = "{\"methods\":{} }";

    checkNatspec(sourceCode, natspec, true);
}

BOOST_AUTO_TEST_CASE(dev_and_user_no_doc)
{
    char const* sourceCode = "contract test {\n"
    "  function mul(uint a) returns(uint d) { return a * 7; }\n"
    "  function sub(int input) returns(int d)\n"
    "  {\n"
    "      return input - 3;\n"
    "  }\n"
    "}\n";

    char const* devNatspec = "{\"methods\":{}}";
    char const* userNatspec = "{\"methods\":{}}";

    checkNatspec(sourceCode, devNatspec, false);
    checkNatspec(sourceCode, userNatspec, true);
}

BOOST_AUTO_TEST_CASE(dev_desc_after_nl)
{
    char const* sourceCode = "contract test {\n"
    "  /// @dev\n"
    "  /// Multiplies a number by 7 and adds second parameter\n"
    "  /// @param a Documentation for the first parameter\n"
    "  /// @param second Documentation for the second parameter\n"
    "  function mul(uint a, uint second) returns(uint d) { return a * 7 + second; }\n"
    "}\n";

    char const* natspec = "{"
    "\"methods\":{"
    "    \"mul(uint256,uint256)\":{ \n"
    "        \"details\": \" Multiplies a number by 7 and adds second parameter\",\n"
    "        \"params\": {\n"
    "            \"a\": \"Documentation for the first parameter\",\n"
    "            \"second\": \"Documentation for the second parameter\"\n"
    "        }\n"
    "    }\n"
    "}}";

    checkNatspec(sourceCode, natspec, false);
}

BOOST_AUTO_TEST_CASE(dev_multiple_params)
{
    char const* sourceCode = "contract test {\n"
    "  /// @dev Multiplies a number by 7 and adds second parameter\n"
    "  /// @param a Documentation for the first parameter\n"
    "  /// @param second Documentation for the second parameter\n"
    "  function mul(uint a, uint second) returns(uint d) { return a * 7 + second; }\n"
    "}\n";

    char const* natspec = "{"
    "\"methods\":{"
    "    \"mul(uint256,uint256)\":{ \n"
    "        \"details\": \"Multiplies a number by 7 and adds second parameter\",\n"
    "        \"params\": {\n"
    "            \"a\": \"Documentation for the first parameter\",\n"
    "            \"second\": \"Documentation for the second parameter\"\n"
    "        }\n"
    "    }\n"
    "}}";

    checkNatspec(sourceCode, natspec, false);
}

BOOST_AUTO_TEST_CASE(dev_mutiline_param_description)
{
    char const* sourceCode = "contract test {\n"
    "  /// @dev Multiplies a number by 7 and adds second parameter\n"
    "  /// @param a Documentation for the first parameter starts here.\n"
    "  /// Since it's a really complicated parameter we need 2 lines\n"
    "  /// @param second Documentation for the second parameter\n"
    "  function mul(uint a, uint second) returns(uint d) { return a * 7 + second; }\n"
    "}\n";

    char const* natspec = "{"
    "\"methods\":{"
    "    \"mul(uint256,uint256)\":{ \n"
    "        \"details\": \"Multiplies a number by 7 and adds second parameter\",\n"
    "        \"params\": {\n"
    "            \"a\": \"Documentation for the first parameter starts here. Since it's a really complicated parameter we need 2 lines\",\n"
    "            \"second\": \"Documentation for the second parameter\"\n"
    "        }\n"
    "    }\n"
    "}}";

    checkNatspec(sourceCode, natspec, false);
}

BOOST_AUTO_TEST_CASE(dev_multiple_functions)
{
    char const* sourceCode = "contract test {\n"
    "  /// @dev Multiplies a number by 7 and adds second parameter\n"
    "  /// @param a Documentation for the first parameter\n"
    "  /// @param second Documentation for the second parameter\n"
    "  function mul(uint a, uint second) returns(uint d) { return a * 7 + second; }\n"
    "  \n"
    "  /// @dev Divides 2 numbers\n"
    "  /// @param input Documentation for the input parameter\n"
    "  /// @param div Documentation for the div parameter\n"
    "  function divide(uint input, uint div) returns(uint d)\n"
    "  {\n"
    "      return input / div;\n"
    "  }\n"
    "  /// @dev Subtracts 3 from `input`\n"
    "  /// @param input Documentation for the input parameter\n"
    "  function sub(int input) returns(int d)\n"
    "  {\n"
    "      return input - 3;\n"
    "  }\n"
    "}\n";

    char const* natspec = "{"
    "\"methods\":{"
    "    \"mul(uint256,uint256)\":{ \n"
    "        \"details\": \"Multiplies a number by 7 and adds second parameter\",\n"
    "        \"params\": {\n"
    "            \"a\": \"Documentation for the first parameter\",\n"
    "            \"second\": \"Documentation for the second parameter\"\n"
    "        }\n"
    "    },\n"
    "    \"divide(uint256,uint256)\":{ \n"
    "        \"details\": \"Divides 2 numbers\",\n"
    "        \"params\": {\n"
    "            \"input\": \"Documentation for the input parameter\",\n"
    "            \"div\": \"Documentation for the div parameter\"\n"
    "        }\n"
    "    },\n"
    "    \"sub(int256)\":{ \n"
    "        \"details\": \"Subtracts 3 from `input`\",\n"
    "        \"params\": {\n"
    "            \"input\": \"Documentation for the input parameter\"\n"
    "        }\n"
    "    }\n"
    "}}";

    checkNatspec(sourceCode, natspec, false);
}

BOOST_AUTO_TEST_CASE(dev_return)
{
    char const* sourceCode = "contract test {\n"
    "  /// @dev Multiplies a number by 7 and adds second parameter\n"
    "  /// @param a Documentation for the first parameter starts here.\n"
    "  /// Since it's a really complicated parameter we need 2 lines\n"
    "  /// @param second Documentation for the second parameter\n"
    "  /// @return The result of the multiplication\n"
    "  function mul(uint a, uint second) returns(uint d) { return a * 7 + second; }\n"
    "}\n";

    char const* natspec = "{"
    "\"methods\":{"
    "    \"mul(uint256,uint256)\":{ \n"
    "        \"details\": \"Multiplies a number by 7 and adds second parameter\",\n"
    "        \"params\": {\n"
    "            \"a\": \"Documentation for the first parameter starts here. Since it's a really complicated parameter we need 2 lines\",\n"
    "            \"second\": \"Documentation for the second parameter\"\n"
    "        },\n"
    "        \"return\": \"The result of the multiplication\"\n"
    "    }\n"
    "}}";

    checkNatspec(sourceCode, natspec, false);
}
BOOST_AUTO_TEST_CASE(dev_return_desc_after_nl)
{
    char const* sourceCode = "contract test {\n"
    "  /// @dev Multiplies a number by 7 and adds second parameter\n"
    "  /// @param a Documentation for the first parameter starts here.\n"
    "  /// Since it's a really complicated parameter we need 2 lines\n"
    "  /// @param second Documentation for the second parameter\n"
    "  /// @return\n"
    "  /// The result of the multiplication\n"
    "  function mul(uint a, uint second) returns(uint d) { return a * 7 + second; }\n"
    "}\n";

    char const* natspec = "{"
    "\"methods\":{"
    "    \"mul(uint256,uint256)\":{ \n"
    "        \"details\": \"Multiplies a number by 7 and adds second parameter\",\n"
    "        \"params\": {\n"
    "            \"a\": \"Documentation for the first parameter starts here. Since it's a really complicated parameter we need 2 lines\",\n"
    "            \"second\": \"Documentation for the second parameter\"\n"
    "        },\n"
    "        \"return\": \" The result of the multiplication\"\n"
    "    }\n"
    "}}";

    checkNatspec(sourceCode, natspec, false);
}


BOOST_AUTO_TEST_CASE(dev_multiline_return)
{
    char const* sourceCode = "contract test {\n"
    "  /// @dev Multiplies a number by 7 and adds second parameter\n"
    "  /// @param a Documentation for the first parameter starts here.\n"
    "  /// Since it's a really complicated parameter we need 2 lines\n"
    "  /// @param second Documentation for the second parameter\n"
    "  /// @return The result of the multiplication\n"
    "  /// and cookies with nutella\n"
    "  function mul(uint a, uint second) returns(uint d) { return a * 7 + second; }\n"
    "}\n";

    char const* natspec = "{"
    "\"methods\":{"
    "    \"mul(uint256,uint256)\":{ \n"
    "        \"details\": \"Multiplies a number by 7 and adds second parameter\",\n"
    "        \"params\": {\n"
    "            \"a\": \"Documentation for the first parameter starts here. Since it's a really complicated parameter we need 2 lines\",\n"
    "            \"second\": \"Documentation for the second parameter\"\n"
    "        },\n"
    "        \"return\": \"The result of the multiplication and cookies with nutella\"\n"
    "    }\n"
    "}}";

    checkNatspec(sourceCode, natspec, false);
}

BOOST_AUTO_TEST_CASE(dev_multiline_comment)
{
    char const* sourceCode = "contract test {\n"
    "  /**\n"
    "   * @dev Multiplies a number by 7 and adds second parameter\n"
    "   * @param a Documentation for the first parameter starts here.\n"
    "   * Since it's a really complicated parameter we need 2 lines\n"
    "   * @param second Documentation for the second parameter\n"
    "   * @return The result of the multiplication\n"
    "   * and cookies with nutella\n"
    "   */"
    "  function mul(uint a, uint second) returns(uint d) { return a * 7 + second; }\n"
    "}\n";

    char const* natspec = "{"
    "\"methods\":{"
    "    \"mul(uint256,uint256)\":{ \n"
    "        \"details\": \"Multiplies a number by 7 and adds second parameter\",\n"
    "        \"params\": {\n"
    "            \"a\": \"Documentation for the first parameter starts here. Since it's a really complicated parameter we need 2 lines\",\n"
    "            \"second\": \"Documentation for the second parameter\"\n"
    "        },\n"
    "        \"return\": \"The result of the multiplication and cookies with nutella\"\n"
    "    }\n"
    "}}";

    checkNatspec(sourceCode, natspec, false);
}

BOOST_AUTO_TEST_CASE(dev_contract_no_doc)
{
    char const* sourceCode = "contract test {\n"
    "  /// @dev Mul function\n"
    "  function mul(uint a, uint second) returns(uint d) { return a * 7 + second; }\n"
    "}\n";

    char const* natspec = "{"
    "    \"methods\":{"
    "        \"mul(uint256,uint256)\":{ \n"
    "            \"details\": \"Mul function\"\n"
    "        }\n"
    "    }\n"
    "}";

    checkNatspec(sourceCode, natspec, false);
}

BOOST_AUTO_TEST_CASE(dev_contract_doc)
{
    char const* sourceCode = " /// @author Lefteris\n"
    " /// @title Just a test contract\n"
    "contract test {\n"
    "  /// @dev Mul function\n"
    "  function mul(uint a, uint second) returns(uint d) { return a * 7 + second; }\n"
    "}\n";

    char const* natspec = "{"
    "    \"author\": \"Lefteris\","
    "    \"title\": \"Just a test contract\","
    "    \"methods\":{"
    "        \"mul(uint256,uint256)\":{ \n"
    "            \"details\": \"Mul function\"\n"
    "        }\n"
    "    }\n"
    "}";

    checkNatspec(sourceCode, natspec, false);
}

BOOST_AUTO_TEST_CASE(dev_author_at_function)
{
    char const* sourceCode = " /// @author Lefteris\n"
    " /// @title Just a test contract\n"
    "contract test {\n"
    "  /// @dev Mul function\n"
    "  /// @author John Doe\n"
    "  function mul(uint a, uint second) returns(uint d) { return a * 7 + second; }\n"
    "}\n";

    char const* natspec = "{"
    "    \"author\": \"Lefteris\","
    "    \"title\": \"Just a test contract\","
    "    \"methods\":{"
    "        \"mul(uint256,uint256)\":{ \n"
    "            \"details\": \"Mul function\",\n"
    "            \"author\": \"John Doe\",\n"
    "        }\n"
    "    }\n"
    "}";

    checkNatspec(sourceCode, natspec, false);
}

BOOST_AUTO_TEST_CASE(natspec_notice_without_tag)
{
    char const* sourceCode = R"(
        contract test {
            /// I do something awesome
            function mul(uint a) returns(uint d) { return a * 7; }
        }
    )";


    char const* natspec = R"ABCDEF(
    {
       "methods" : {
          "mul(uint256)" : {
             "notice" : "I do something awesome"
          }
       }
    }
    )ABCDEF";

    checkNatspec(sourceCode, natspec, true);
}

BOOST_AUTO_TEST_CASE(natspec_multiline_notice_without_tag)
{
    char const* sourceCode = R"(
        contract test {
            /// I do something awesome
            /// which requires two lines to explain
            function mul(uint a) returns(uint d) { return a * 7; }
        }
    )";

    char const* natspec = R"ABCDEF(
    {
       "methods" : {
          "mul(uint256)" : {
             "notice" : "I do something awesome which requires two lines to explain"
          }
       }
    }
    )ABCDEF";

    checkNatspec(sourceCode, natspec, true);
}

BOOST_AUTO_TEST_SUITE_END()

}
}
}