contracts_testing.html
1 <!DOCTYPE html> 2 <html lang="en" dir="ltr"> 3 <head prefix="og: http://ogp.me/ns#"> 4 <meta charset="utf-8"> 5 <title>Testing Smart Contracts | Embark</title> 6 <meta http-equiv="X-UA-Compatible" content="IE=Edge,chrome=1"> 7 <meta name="viewport" content="width=device-width, initial-scale=1"> 8 <!-- Canonical links --> 9 <link rel="canonical" href="https://framework.embarklabs.io/docs/contracts_testing.html"> 10 <!-- Alternative links --> 11 12 13 <!-- Icon --> 14 <meta name="msapplication-TileColor" content="#080E1A"> 15 <link rel="icon" type="image/png" href="/assets/images/favicon-16.png" sizes="16x16" /> 16 <link rel="icon" type="image/png" href="/assets/images/favicon-32.png" sizes="32x32" /> 17 18 <link rel="apple-touch-icon" sizes="76x76" href="/assets/images/apple-touch-icon-60x60-precomposed.png"> 19 <link rel="apple-touch-icon" sizes="76x76" href="/assets/images/apple-touch-icon-76x76-precomposed.png"> 20 <link rel="apple-touch-icon" sizes="120x120" href="/assets/images/apple-touch-icon-120x120-precomposed.png"> 21 <link rel="apple-touch-icon" sizes="152x152" href="/assets/images/apple-touch-icon-152x152-precomposed.png"> 22 <link rel="apple-touch-icon" sizes="180x180" href="/assets/images/apple-touch-icon-precomposed.png"> 23 <link rel="apple-touch-icon" href="/assets/images/apple-touch-icon-precomposed.png"> 24 <!-- CSS --> 25 26 <link rel="stylesheet" href="/css/embark.css"> 27 28 <!-- endbuild --> 29 30 <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css"> 31 <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" /> 32 33 <!-- RSS --> 34 <link rel="alternate" href="/atom.xml" title="Embark"> 35 <meta property="og:image" content="/img/share.png?v=0.0.5" /> 36 <link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.4/styles/dracula.min.css"> 37 38 <script async defer src="https://buttons.github.io/buttons.js"></script> 39 40 41 <script> 42 !function(root, factory) { 43 "function" == typeof define && define.amd ? // AMD. Register as an anonymous module unless amdModuleId is set 44 define([], function() { 45 return root.svg4everybody = factory(); 46 }) : "object" == typeof module && module.exports ? // Node. Does not work with strict CommonJS, but 47 // only CommonJS-like environments that support module.exports, 48 // like Node. 49 module.exports = factory() : root.svg4everybody = factory(); 50 }(this, function() { 51 /*! svg4everybody v2.1.9 | github.com/jonathantneal/svg4everybody */ 52 function embed(parent, svg, target) { 53 // if the target exists 54 if (target) { 55 // create a document fragment to hold the contents of the target 56 var fragment = document.createDocumentFragment(), viewBox = !svg.hasAttribute("viewBox") && target.getAttribute("viewBox"); 57 // conditionally set the viewBox on the svg 58 viewBox && svg.setAttribute("viewBox", viewBox); 59 // copy the contents of the clone into the fragment 60 for (// clone the target 61 var clone = target.cloneNode(!0); clone.childNodes.length; ) { 62 fragment.appendChild(clone.firstChild); 63 } 64 // append the fragment into the svg 65 parent.appendChild(fragment); 66 } 67 } 68 function loadreadystatechange(xhr) { 69 // listen to changes in the request 70 xhr.onreadystatechange = function() { 71 // if the request is ready 72 if (4 === xhr.readyState) { 73 // get the cached html document 74 var cachedDocument = xhr._cachedDocument; 75 // ensure the cached html document based on the xhr response 76 cachedDocument || (cachedDocument = xhr._cachedDocument = document.implementation.createHTMLDocument(""), 77 cachedDocument.body.innerHTML = xhr.responseText, xhr._cachedTarget = {}), // clear the xhr embeds list and embed each item 78 xhr._embeds.splice(0).map(function(item) { 79 // get the cached target 80 var target = xhr._cachedTarget[item.id]; 81 // ensure the cached target 82 target || (target = xhr._cachedTarget[item.id] = cachedDocument.getElementById(item.id)), 83 // embed the target into the svg 84 embed(item.parent, item.svg, target); 85 }); 86 } 87 }, // test the ready state change immediately 88 xhr.onreadystatechange(); 89 } 90 function svg4everybody(rawopts) { 91 function oninterval() { 92 // while the index exists in the live <use> collection 93 for (// get the cached <use> index 94 var index = 0; index < uses.length; ) { 95 // get the current <use> 96 var use = uses[index], parent = use.parentNode, svg = getSVGAncestor(parent), src = use.getAttribute("xlink:href") || use.getAttribute("href"); 97 if (!src && opts.attributeName && (src = use.getAttribute(opts.attributeName)), 98 svg && src) { 99 if (polyfill) { 100 if (!opts.validate || opts.validate(src, svg, use)) { 101 // remove the <use> element 102 parent.removeChild(use); 103 // parse the src and get the url and id 104 var srcSplit = src.split("#"), url = srcSplit.shift(), id = srcSplit.join("#"); 105 // if the link is external 106 if (url.length) { 107 // get the cached xhr request 108 var xhr = requests[url]; 109 // ensure the xhr request exists 110 xhr || (xhr = requests[url] = new XMLHttpRequest(), xhr.open("GET", url), xhr.send(), 111 xhr._embeds = []), // add the svg and id as an item to the xhr embeds list 112 xhr._embeds.push({ 113 parent: parent, 114 svg: svg, 115 id: id 116 }), // prepare the xhr ready state change event 117 loadreadystatechange(xhr); 118 } else { 119 // embed the local id into the svg 120 embed(parent, svg, document.getElementById(id)); 121 } 122 } else { 123 // increase the index when the previous value was not "valid" 124 ++index, ++numberOfSvgUseElementsToBypass; 125 } 126 } 127 } else { 128 // increase the index when the previous value was not "valid" 129 ++index; 130 } 131 } 132 // continue the interval 133 (!uses.length || uses.length - numberOfSvgUseElementsToBypass > 0) && requestAnimationFrame(oninterval, 67); 134 } 135 var polyfill, opts = Object(rawopts), newerIEUA = /\bTrident\/[567]\b|\bMSIE (?:9|10)\.0\b/, webkitUA = /\bAppleWebKit\/(\d+)\b/, olderEdgeUA = /\bEdge\/12\.(\d+)\b/, edgeUA = /\bEdge\/.(\d+)\b/, inIframe = window.top !== window.self; 136 polyfill = "polyfill" in opts ? opts.polyfill : newerIEUA.test(navigator.userAgent) || (navigator.userAgent.match(olderEdgeUA) || [])[1] < 10547 || (navigator.userAgent.match(webkitUA) || [])[1] < 537 || edgeUA.test(navigator.userAgent) && inIframe; 137 // create xhr requests object 138 var requests = {}, requestAnimationFrame = window.requestAnimationFrame || setTimeout, uses = document.getElementsByTagName("use"), numberOfSvgUseElementsToBypass = 0; 139 // conditionally start the interval if the polyfill is active 140 polyfill && oninterval(); 141 } 142 function getSVGAncestor(node) { 143 for (var svg = node; "svg" !== svg.nodeName.toLowerCase() && (svg = svg.parentNode); ) {} 144 return svg; 145 } 146 return svg4everybody; 147 }); 148 149 svg4everybody(); 150 </script> 151 </head> 152 153 <body> 154 <header role="banner" class="c-header c-header--compact"> 155 <span class="c-header__background"></span> 156 <div class="o-container c-header__content"> 157 <div class="c-header__top"> 158 <a href="/" title="Embark" class="c-logo c-logo--negative">Embark</a> 159 <nav role="navigation" class="c-navigation"> 160 <div class="c-navigation__header"> 161 <a href="/" title="Embark" class="c-logo">Embark</a> 162 <button class="c-navigation__close u-text-light" title="Close menu"> 163 <svg class="c-icon c-icon--xs"><use xlink:href="/../assets/icons/symbols.svg#icon-close"></use></svg> 164 </button> 165 </div> 166 <div class="c-navigation__body"> 167 <ul class="c-navigation__list"> 168 <li class="c-navigation__item"> 169 <a href="/docs/quick_start.html" class="c-navigation__anchor " title="Quick Start">Quick Start</a> 170 </li> 171 <li class="c-navigation__item"> 172 <a href="/docs" class="c-navigation__anchor is-active" title="Learn">Learn</a> 173 </li> 174 <li class="c-navigation__item"> 175 <a href="/plugins" class="c-navigation__anchor " title="Plugins">Plugins</a> 176 </li> 177 <li class="c-navigation__item"> 178 <a href="/community" class="c-navigation__anchor " title="Community">Community</a> 179 </li> 180 <li class="c-navigation__item"> 181 <a href="https://blog.embarklabs.io" target="_blank" rel="noopener" class="c-navigation__anchor " title="Blog">Blog</a> 182 </li> 183 </ul> 184 </div> 185 </nav> 186 <div class="o-flex o-flex-center"> 187 <form action="" class="o-flex__item u-hidden-until-large"> 188 <input type="search" placeholder="Search" id="search-input"> 189 </form> 190 <div class="o-flex__item"> 191 <ul class="o-flex o-flex-center"> 192 <li class="o-flex__item"> 193 <a href="https://github.com/embarklabs/embark" title="Github" target="_blank" class="u-link-ghost"> 194 <svg class="c-icon"><use xlink:href="/../assets/icons/symbols.svg#icon-github"></use></svg> 195 </a> 196 </li> 197 <li class="o-flex__item"> 198 <a href="https://twitter.com/EmbarkProject" title="Twitter" target="_blank"> 199 <svg class="c-icon"><use xlink:href="/../assets/icons/symbols.svg#icon-twitter"></use></svg> 200 </a> 201 </li> 202 <li class="o-flex__item u-hidden-large-up"> 203 <button type="button"class="c-navigation__trigger u-link-ghost" title="Open menu"> 204 <svg class="c-icon"><use xlink:href="/../assets/icons/symbols.svg#icon-navigation-menu"></use></svg> 205 </button> 206 </li> 207 </ul> 208 </div> 209 </div> 210 </div> 211 <div class="c-quick-search o-distance-m u-hidden-large-up"> 212 <input type="search" id="inp-search" placeholder="Search"> 213 </div> 214 <div class="c-header__body"> 215 <h1 class="c-title u-text-ghost">Documentation</h1> 216 217 218 219 220 221 </div> 222 </div> 223 </header> 224 225 226 <main role="main"> 227 <section class="o-guided-content o-distance"> 228 <div class="o-guided-content__wrapper"> 229 <button title="Open docs menu" id="guides-trigger" class="c-button c-button--minion u-hidden-large-up"> 230 <svg class="c-icon c-icon--xs"><use xlink:href="/../../assets/icons/symbols.svg#icon-navigation-menu"></use></svg> 231 <span>Guides</span> 232 </button> 233 <div class="c-guide o-guided-content__guide" id="guide-navigation"> 234 <div class="c-guide__header u-hidden-large-up"> 235 <a href="" title="Guides"> 236 Guides 237 </a> 238 <button type="button" title="Close menu" id="guides-close"> 239 <svg class="c-icon c-icon--xs"><use xlink:href="/../../assets/icons/symbols.svg#icon-close"></use></svg> 240 </button> 241 </div> 242 <div class="c-guide__body"> 243 <nav role="navigation"> 244 245 <div class=""> 246 <h3 class="c-category-title">Getting Started</h3> 247 <ul class="o-list-bare"> 248 249 <li class="o-list-bare__item"> 250 <a href="/docs/overview.html" title="Overview" class="u-link-uniform ">Overview</a> 251 <!-- <div class="o-distance-m"> 252 <ul class="o-list-bare c-navigation__subnav"> 253 <li class="o-list-bare__item"> 254 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 255 </li> 256 </ul> 257 </div> --> 258 </li> 259 260 <li class="o-list-bare__item"> 261 <a href="/docs/installation.html" title="Installation" class="u-link-uniform ">Installation</a> 262 <!-- <div class="o-distance-m"> 263 <ul class="o-list-bare c-navigation__subnav"> 264 <li class="o-list-bare__item"> 265 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 266 </li> 267 </ul> 268 </div> --> 269 </li> 270 271 <li class="o-list-bare__item"> 272 <a href="/docs/faq.html" title="FAQ" class="u-link-uniform ">FAQ</a> 273 <!-- <div class="o-distance-m"> 274 <ul class="o-list-bare c-navigation__subnav"> 275 <li class="o-list-bare__item"> 276 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 277 </li> 278 </ul> 279 </div> --> 280 </li> 281 282 </ul> 283 284 285 <div class="o-distance-xl"> 286 <h3 class="c-category-title">General Usage</h3> 287 <ul class="o-list-bare"> 288 289 <li class="o-list-bare__item"> 290 <a href="/docs/create_project.html" title="Creating apps" class="u-link-uniform ">Creating apps</a> 291 <!-- <div class="o-distance-m"> 292 <ul class="o-list-bare c-navigation__subnav"> 293 <li class="o-list-bare__item"> 294 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 295 </li> 296 </ul> 297 </div> --> 298 </li> 299 300 <li class="o-list-bare__item"> 301 <a href="/docs/structure.html" title="App structure" class="u-link-uniform ">App structure</a> 302 <!-- <div class="o-distance-m"> 303 <ul class="o-list-bare c-navigation__subnav"> 304 <li class="o-list-bare__item"> 305 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 306 </li> 307 </ul> 308 </div> --> 309 </li> 310 311 <li class="o-list-bare__item"> 312 <a href="/docs/running_apps.html" title="Running apps" class="u-link-uniform ">Running apps</a> 313 <!-- <div class="o-distance-m"> 314 <ul class="o-list-bare c-navigation__subnav"> 315 <li class="o-list-bare__item"> 316 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 317 </li> 318 </ul> 319 </div> --> 320 </li> 321 322 <li class="o-list-bare__item"> 323 <a href="/docs/dashboard.html" title="Using the dashboard" class="u-link-uniform ">Using the dashboard</a> 324 <!-- <div class="o-distance-m"> 325 <ul class="o-list-bare c-navigation__subnav"> 326 <li class="o-list-bare__item"> 327 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 328 </li> 329 </ul> 330 </div> --> 331 </li> 332 333 <li class="o-list-bare__item"> 334 <a href="/docs/using_the_console.html" title="Using the console" class="u-link-uniform ">Using the console</a> 335 <!-- <div class="o-distance-m"> 336 <ul class="o-list-bare c-navigation__subnav"> 337 <li class="o-list-bare__item"> 338 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 339 </li> 340 </ul> 341 </div> --> 342 </li> 343 344 <li class="o-list-bare__item"> 345 <a href="/docs/environments.html" title="Environments" class="u-link-uniform ">Environments</a> 346 <!-- <div class="o-distance-m"> 347 <ul class="o-list-bare c-navigation__subnav"> 348 <li class="o-list-bare__item"> 349 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 350 </li> 351 </ul> 352 </div> --> 353 </li> 354 355 <li class="o-list-bare__item"> 356 <a href="/docs/configuration.html" title="Configuration" class="u-link-uniform ">Configuration</a> 357 <!-- <div class="o-distance-m"> 358 <ul class="o-list-bare c-navigation__subnav"> 359 <li class="o-list-bare__item"> 360 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 361 </li> 362 </ul> 363 </div> --> 364 </li> 365 366 <li class="o-list-bare__item"> 367 <a href="/docs/pipeline_and_webpack.html" title="Building & Compiling" class="u-link-uniform ">Building & Compiling</a> 368 <!-- <div class="o-distance-m"> 369 <ul class="o-list-bare c-navigation__subnav"> 370 <li class="o-list-bare__item"> 371 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 372 </li> 373 </ul> 374 </div> --> 375 </li> 376 377 <li class="o-list-bare__item"> 378 <a href="/docs/executing_scripts.html" title="Executing Scripts" class="u-link-uniform ">Executing Scripts</a> 379 <!-- <div class="o-distance-m"> 380 <ul class="o-list-bare c-navigation__subnav"> 381 <li class="o-list-bare__item"> 382 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 383 </li> 384 </ul> 385 </div> --> 386 </li> 387 388 <li class="o-list-bare__item"> 389 <a href="/docs/javascript_usage.html" title="Using EmbarkJS" class="u-link-uniform ">Using EmbarkJS</a> 390 <!-- <div class="o-distance-m"> 391 <ul class="o-list-bare c-navigation__subnav"> 392 <li class="o-list-bare__item"> 393 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 394 </li> 395 </ul> 396 </div> --> 397 </li> 398 399 </ul> 400 </div> 401 402 <div class="o-distance-xl"> 403 <h3 class="c-category-title">Smart Contract Development</h3> 404 <ul class="o-list-bare"> 405 406 <li class="o-list-bare__item"> 407 <a href="/docs/contracts_configuration.html" title="Configuration" class="u-link-uniform ">Configuration</a> 408 <!-- <div class="o-distance-m"> 409 <ul class="o-list-bare c-navigation__subnav"> 410 <li class="o-list-bare__item"> 411 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 412 </li> 413 </ul> 414 </div> --> 415 </li> 416 417 <li class="o-list-bare__item"> 418 <a href="/docs/contracts_deployment.html" title="Accounts & Deployment" class="u-link-uniform ">Accounts & Deployment</a> 419 <!-- <div class="o-distance-m"> 420 <ul class="o-list-bare c-navigation__subnav"> 421 <li class="o-list-bare__item"> 422 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 423 </li> 424 </ul> 425 </div> --> 426 </li> 427 428 <li class="o-list-bare__item"> 429 <a href="/docs/contracts_imports.html" title="Special Imports" class="u-link-uniform ">Special Imports</a> 430 <!-- <div class="o-distance-m"> 431 <ul class="o-list-bare c-navigation__subnav"> 432 <li class="o-list-bare__item"> 433 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 434 </li> 435 </ul> 436 </div> --> 437 </li> 438 439 <li class="o-list-bare__item"> 440 <a href="/docs/contracts_testing.html" title="Testing" class="u-link-uniform is-active">Testing</a> 441 <!-- <div class="o-distance-m"> 442 <ul class="o-list-bare c-navigation__subnav"> 443 <li class="o-list-bare__item"> 444 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 445 </li> 446 </ul> 447 </div> --> 448 </li> 449 450 <li class="o-list-bare__item"> 451 <a href="/docs/contracts_javascript.html" title="Smart Contracts in JavaScript" class="u-link-uniform ">Smart Contracts in JavaScript</a> 452 <!-- <div class="o-distance-m"> 453 <ul class="o-list-bare c-navigation__subnav"> 454 <li class="o-list-bare__item"> 455 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 456 </li> 457 </ul> 458 </div> --> 459 </li> 460 461 </ul> 462 </div> 463 464 <div class="o-distance-xl"> 465 <h3 class="c-category-title">Blockchain Client</h3> 466 <ul class="o-list-bare"> 467 468 <li class="o-list-bare__item"> 469 <a href="/docs/blockchain_configuration.html" title="Configuration" class="u-link-uniform ">Configuration</a> 470 <!-- <div class="o-distance-m"> 471 <ul class="o-list-bare c-navigation__subnav"> 472 <li class="o-list-bare__item"> 473 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 474 </li> 475 </ul> 476 </div> --> 477 </li> 478 479 <li class="o-list-bare__item"> 480 <a href="/docs/blockchain_accounts_configuration.html" title="Managing Accounts" class="u-link-uniform ">Managing Accounts</a> 481 <!-- <div class="o-distance-m"> 482 <ul class="o-list-bare c-navigation__subnav"> 483 <li class="o-list-bare__item"> 484 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 485 </li> 486 </ul> 487 </div> --> 488 </li> 489 490 </ul> 491 </div> 492 493 <div class="o-distance-xl"> 494 <h3 class="c-category-title">Storage (IPFS/Swarm)</h3> 495 <ul class="o-list-bare"> 496 497 <li class="o-list-bare__item"> 498 <a href="/docs/storage_configuration.html" title="Configuration" class="u-link-uniform ">Configuration</a> 499 <!-- <div class="o-distance-m"> 500 <ul class="o-list-bare c-navigation__subnav"> 501 <li class="o-list-bare__item"> 502 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 503 </li> 504 </ul> 505 </div> --> 506 </li> 507 508 <li class="o-list-bare__item"> 509 <a href="/docs/storage_deployment.html" title="Deploying apps" class="u-link-uniform ">Deploying apps</a> 510 <!-- <div class="o-distance-m"> 511 <ul class="o-list-bare c-navigation__subnav"> 512 <li class="o-list-bare__item"> 513 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 514 </li> 515 </ul> 516 </div> --> 517 </li> 518 519 <li class="o-list-bare__item"> 520 <a href="/docs/storage_javascript.html" title="Storage APIs in JavaScript" class="u-link-uniform ">Storage APIs in JavaScript</a> 521 <!-- <div class="o-distance-m"> 522 <ul class="o-list-bare c-navigation__subnav"> 523 <li class="o-list-bare__item"> 524 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 525 </li> 526 </ul> 527 </div> --> 528 </li> 529 530 </ul> 531 </div> 532 533 <div class="o-distance-xl"> 534 <h3 class="c-category-title">Messages (Whisper)</h3> 535 <ul class="o-list-bare"> 536 537 <li class="o-list-bare__item"> 538 <a href="/docs/messages_configuration.html" title="Configuration" class="u-link-uniform ">Configuration</a> 539 <!-- <div class="o-distance-m"> 540 <ul class="o-list-bare c-navigation__subnav"> 541 <li class="o-list-bare__item"> 542 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 543 </li> 544 </ul> 545 </div> --> 546 </li> 547 548 <li class="o-list-bare__item"> 549 <a href="/docs/messages_javascript.html" title="Messages in JavaScript" class="u-link-uniform ">Messages in JavaScript</a> 550 <!-- <div class="o-distance-m"> 551 <ul class="o-list-bare c-navigation__subnav"> 552 <li class="o-list-bare__item"> 553 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 554 </li> 555 </ul> 556 </div> --> 557 </li> 558 559 </ul> 560 </div> 561 562 <div class="o-distance-xl"> 563 <h3 class="c-category-title">Naming Systems (ENS)</h3> 564 <ul class="o-list-bare"> 565 566 <li class="o-list-bare__item"> 567 <a href="/docs/naming_configuration.html" title="Configuration" class="u-link-uniform ">Configuration</a> 568 <!-- <div class="o-distance-m"> 569 <ul class="o-list-bare c-navigation__subnav"> 570 <li class="o-list-bare__item"> 571 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 572 </li> 573 </ul> 574 </div> --> 575 </li> 576 577 <li class="o-list-bare__item"> 578 <a href="/docs/naming_javascript.html" title="Naming Systems in JavaScript" class="u-link-uniform ">Naming Systems in JavaScript</a> 579 <!-- <div class="o-distance-m"> 580 <ul class="o-list-bare c-navigation__subnav"> 581 <li class="o-list-bare__item"> 582 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 583 </li> 584 </ul> 585 </div> --> 586 </li> 587 588 </ul> 589 </div> 590 591 <div class="o-distance-xl"> 592 <h3 class="c-category-title">Plugins</h3> 593 <ul class="o-list-bare"> 594 595 <li class="o-list-bare__item"> 596 <a href="/docs/installing_plugins.html" title="Installing plugins" class="u-link-uniform ">Installing plugins</a> 597 <!-- <div class="o-distance-m"> 598 <ul class="o-list-bare c-navigation__subnav"> 599 <li class="o-list-bare__item"> 600 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 601 </li> 602 </ul> 603 </div> --> 604 </li> 605 606 <li class="o-list-bare__item"> 607 <a href="/docs/creating_plugins.html" title="Creating plugins" class="u-link-uniform ">Creating plugins</a> 608 <!-- <div class="o-distance-m"> 609 <ul class="o-list-bare c-navigation__subnav"> 610 <li class="o-list-bare__item"> 611 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 612 </li> 613 </ul> 614 </div> --> 615 </li> 616 617 <li class="o-list-bare__item"> 618 <a href="/docs/plugin_reference.html" title="Plugin APIs" class="u-link-uniform ">Plugin APIs</a> 619 <!-- <div class="o-distance-m"> 620 <ul class="o-list-bare c-navigation__subnav"> 621 <li class="o-list-bare__item"> 622 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 623 </li> 624 </ul> 625 </div> --> 626 </li> 627 628 </ul> 629 </div> 630 631 <div class="o-distance-xl"> 632 <h3 class="c-category-title">Cockpit Guides</h3> 633 <ul class="o-list-bare"> 634 635 <li class="o-list-bare__item"> 636 <a href="/docs/cockpit_introduction.html" title="Introduction" class="u-link-uniform ">Introduction</a> 637 <!-- <div class="o-distance-m"> 638 <ul class="o-list-bare c-navigation__subnav"> 639 <li class="o-list-bare__item"> 640 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 641 </li> 642 </ul> 643 </div> --> 644 </li> 645 646 <li class="o-list-bare__item"> 647 <a href="/docs/cockpit_dashboard.html" title="Using the Dashboard" class="u-link-uniform ">Using the Dashboard</a> 648 <!-- <div class="o-distance-m"> 649 <ul class="o-list-bare c-navigation__subnav"> 650 <li class="o-list-bare__item"> 651 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 652 </li> 653 </ul> 654 </div> --> 655 </li> 656 657 <li class="o-list-bare__item"> 658 <a href="/docs/cockpit_deployment.html" title="Deployment" class="u-link-uniform ">Deployment</a> 659 <!-- <div class="o-distance-m"> 660 <ul class="o-list-bare c-navigation__subnav"> 661 <li class="o-list-bare__item"> 662 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 663 </li> 664 </ul> 665 </div> --> 666 </li> 667 668 <li class="o-list-bare__item"> 669 <a href="/docs/cockpit_explorer.html" title="Explorer View" class="u-link-uniform ">Explorer View</a> 670 <!-- <div class="o-distance-m"> 671 <ul class="o-list-bare c-navigation__subnav"> 672 <li class="o-list-bare__item"> 673 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 674 </li> 675 </ul> 676 </div> --> 677 </li> 678 679 <li class="o-list-bare__item"> 680 <a href="/docs/cockpit_editor.html" title="Code Editor" class="u-link-uniform ">Code Editor</a> 681 <!-- <div class="o-distance-m"> 682 <ul class="o-list-bare c-navigation__subnav"> 683 <li class="o-list-bare__item"> 684 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 685 </li> 686 </ul> 687 </div> --> 688 </li> 689 690 <li class="o-list-bare__item"> 691 <a href="/docs/cockpit_debugger.html" title="Using the Debugger" class="u-link-uniform ">Using the Debugger</a> 692 <!-- <div class="o-distance-m"> 693 <ul class="o-list-bare c-navigation__subnav"> 694 <li class="o-list-bare__item"> 695 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 696 </li> 697 </ul> 698 </div> --> 699 </li> 700 701 </ul> 702 </div> 703 704 <div class="o-distance-xl"> 705 <h3 class="c-category-title">Reference</h3> 706 <ul class="o-list-bare"> 707 708 <li class="o-list-bare__item"> 709 <a href="/docs/embark_commands.html" title="CLI Commands" class="u-link-uniform ">CLI Commands</a> 710 <!-- <div class="o-distance-m"> 711 <ul class="o-list-bare c-navigation__subnav"> 712 <li class="o-list-bare__item"> 713 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 714 </li> 715 </ul> 716 </div> --> 717 </li> 718 719 </ul> 720 </div> 721 722 <div class="o-distance-xl"> 723 <h3 class="c-category-title">Miscellaneous</h3> 724 <ul class="o-list-bare"> 725 726 <li class="o-list-bare__item"> 727 <a href="/docs/migrating_from_3.x.html" title="Migrating from Embark 3.x" class="u-link-uniform ">Migrating from Embark 3.x</a> 728 <!-- <div class="o-distance-m"> 729 <ul class="o-list-bare c-navigation__subnav"> 730 <li class="o-list-bare__item"> 731 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 732 </li> 733 </ul> 734 </div> --> 735 </li> 736 737 <li class="o-list-bare__item"> 738 <a href="/docs/troubleshooting.html" title="Troubleshooting" class="u-link-uniform ">Troubleshooting</a> 739 <!-- <div class="o-distance-m"> 740 <ul class="o-list-bare c-navigation__subnav"> 741 <li class="o-list-bare__item"> 742 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 743 </li> 744 </ul> 745 </div> --> 746 </li> 747 748 <li class="o-list-bare__item"> 749 <a href="/docs/contributing.html" title="Contributing" class="u-link-uniform ">Contributing</a> 750 <!-- <div class="o-distance-m"> 751 <ul class="o-list-bare c-navigation__subnav"> 752 <li class="o-list-bare__item"> 753 <a href="#" title="What is Embark?" class="u-link-uniform">What is Embark?</a> 754 </li> 755 </ul> 756 </div> --> 757 </li> 758 759 </ul> 760 </div> 761 762 </nav> 763 </div> 764 </div> 765 <div class="o-guided-content__content"> 766 <p class="c-meta">Last updated: February 18th 2020 767 (<a href="https://github.com/embarklabs/embark/edit/master/site/source/docs/contracts_testing.md" target="_blank"> 768 Improve this guide <svg class="c-icon c-icon--xs"><use xlink:href="/../../assets/icons/symbols.svg#icon-pen-write-paper"></use></svg> 769 </a>) 770 </p> 771 <div class="o-standard-page"> 772 <h1>Testing Smart Contracts</h1> 773 <p>Testing is a crucial part of developing robust and high-quality software. That’s why Embark aims to make testing our Smart Contract as easy as possible. In this guide we’ll explore Embark specific testing APIs and how to write tests for our Smart Contracts.</p> 774 <h2 id="Creating-tests"><a href="#Creating-tests" class="headerlink" title="Creating tests"></a>Creating tests</h2><p>Test files resides in a project’s <code>test</code> folder. Any JavaScript file within <code>test/</code> is considered a spec file and will be executed by Embark as such. A spec file contains test specs which are grouped in <code>contract()</code> functions. A single spec is written using <code>it()</code> blocks.</p> 775 <p>Here’s what such a test could look like:</p> 776 <figure class="highlight plain"><table><tr><td class="code"><pre><span class="line">contract('SomeContract', () => {</span><br><span class="line"> it('should pass', () => {</span><br><span class="line"> assert.ok(true);</span><br><span class="line"> });</span><br><span class="line">});</span><br></pre></td></tr></table></figure> 777 778 <p>This is a single test spec which will always pass. We’re using a globally available <code>assert</code> object to make assertions in our specs. If you’re familiar with the <a href="https://mochajs.org" target="_blank" rel="noopener">Mocha testing framework</a>, this syntax might be familiar. In fact, Embark uses Mocha as a test runner behind the scenes.</p> 779 <p><code>contract()</code> is just an alias for Mocha’s <code>describe()</code> function and is globally available. In general, global functions and objects are:</p> 780 <ul> 781 <li><code>contract()</code>: Same as Mocha’s <code>describe</code></li> 782 <li><code>config()</code>: Function to configure Embark and deploy contracts</li> 783 <li><code>web3</code>: Web3 object</li> 784 <li><code>assert</code>: Node’s assert</li> 785 <li>Mocha functions: <code>describe()</code>, <code>it()</code>, <code>before()</code>, etc.</li> 786 </ul> 787 <h3 id="Importing-EmbarkJS"><a href="#Importing-EmbarkJS" class="headerlink" title="Importing EmbarkJS"></a>Importing EmbarkJS</h3><p>If we want to use any of EmbarkJS’ APIs, we can require it as expected:</p> 788 <figure class="highlight plain"><table><tr><td class="code"><pre><span class="line">const EmbarkJS = require('Embark/EmbarkJS');</span><br></pre></td></tr></table></figure> 789 790 <p>For more information on EmbarkJS’s APIs, head over to <a href="/docs/javascript_usage.html">this guide</a>.</p> 791 <h2 id="Running-tests"><a href="#Running-tests" class="headerlink" title="Running tests"></a>Running tests</h2><p>Once we’ve written our tests, we can execute them using Embark’s <code>test</code> command:</p> 792 <figure class="highlight plain"><table><tr><td class="code"><pre><span class="line">$ embark test</span><br></pre></td></tr></table></figure> 793 794 <p>As mentioned earlier, this will pick up all files inside the <code>test/</code> folder and run them as test files.</p> 795 <h3 id="Running-test-subsets"><a href="#Running-test-subsets" class="headerlink" title="Running test subsets"></a>Running test subsets</h3><p>If we aren’t interested in running all tests but only a specific subset, we can specify a test file as part of the <code>test</code> command like this:</p> 796 <figure class="highlight plain"><table><tr><td class="code"><pre><span class="line">$ embark test test/SomeContract_spec.js</span><br></pre></td></tr></table></figure> 797 798 <h3 id="Running-tests-against-a-different-node"><a href="#Running-tests-against-a-different-node" class="headerlink" title="Running tests against a different node"></a>Running tests against a different node</h3><p>By default, tests are run using an Ethereum simulator (<a href="https://www.truffleframework.com/ganache" target="_blank" rel="noopener">Ganache</a>). We can use the <code>--node</code> option to change that behavior. Passing <code>--node embark</code> to <code>embark test</code> will use the Ethereum node associated with an already running embark process. We can also specify a custom endpoint, for example:</p> 799 <figure class="highlight plain"><table><tr><td class="code"><pre><span class="line">$ embark test --node ws://localhost:8556</span><br></pre></td></tr></table></figure> 800 801 <h3 id="Outputting-gas-cost-details"><a href="#Outputting-gas-cost-details" class="headerlink" title="Outputting gas cost details"></a>Outputting gas cost details</h3><p>When running tests, we can even get an idea of what the gas costs of our Smart Contract deployments are. Embark comes with a <code>--gasDetails</code> option that makes this possible.</p> 802 <figure class="highlight plain"><table><tr><td class="code"><pre><span class="line">$ embark test --gasDetails</span><br></pre></td></tr></table></figure> 803 804 <h2 id="Test-environment"><a href="#Test-environment" class="headerlink" title="Test environment"></a>Test environment</h2><p>When running tests, the default [environment}(/docs/environments.html) is <code>test</code>. You can obviously change this using the <code>--env</code> flag.</p> 805 <p>The special thing with the <code>test</code> environment is that if you do not have a <code>test</code> section in your module configuration, that module with be disabled (<code>enabled: false</code>). This is done to speed up the test as if you don’t need a module, it is disabled.</p> 806 <h2 id="Configuring-Smart-Contracts-for-tests"><a href="#Configuring-Smart-Contracts-for-tests" class="headerlink" title="Configuring Smart Contracts for tests"></a>Configuring Smart Contracts for tests</h2><p>Very similar to how we <a href="/docs/contracts_configuration.html">configure our Smart Contracts</a> for deployment, we have to configure them for our tests as well. This is important, so that our Smart Contracts get deployed with the correct testing data.</p> 807 <p>To do that, Embark adds a global <code>config()</code> function to the execution context, which uses the same API as the configuration object for our application’s Smart Contracts. So if we had a <code>SomeContract</code> that should be picked up for deployment, this is what the configuration would look like:</p> 808 <figure class="highlight plain"><table><tr><td class="code"><pre><span class="line">config({</span><br><span class="line"> contracts: {</span><br><span class="line"> deploy: {</span><br><span class="line"> SomeContract: {} // options as discussed in Smart Contract configuration guide</span><br><span class="line"> }</span><br><span class="line"> }</span><br><span class="line">});</span><br><span class="line"></span><br><span class="line">contract('SomContract', () => {</span><br><span class="line"> ...</span><br><span class="line">});</span><br></pre></td></tr></table></figure> 809 810 <p>One thing that’s important to note here is that, behind the scenes, Embark has to run <code>config()</code> first to deploy the Smart Contracts and only <strong>then</strong> starts running tests. This will have an impact on the developer experience when importing Smart Contract instances within spec files. But more on that later.</p> 811 <div class="c-notification c-notification--info"> 812 <p><strong>A note on config()</strong></p> 813 <p><p>The global <code>config()</code> function is used for Smart Contract deployment and therefore delays the execution of tests until deployment is done.</p> 814 </p> 815 </div> 816 817 818 819 <h2 id="Accessing-Smart-Contract-instances"><a href="#Accessing-Smart-Contract-instances" class="headerlink" title="Accessing Smart Contract instances"></a>Accessing Smart Contract instances</h2><p>To write meaningful tests, we obviously want to interact with our Smart Contracts. As we know, <a href="/docs/javascript_usage.html#Embark-Artifacts">Embark generates Smart Contract instances</a> for us. All we have to do is importing and using them accordingly.</p> 820 <p>The following code imports <code>SomeContract</code> and calls an imaginary method on it inside a spec:</p> 821 <figure class="highlight plain"><table><tr><td class="code"><pre><span class="line">const SomeContract = require('EmbarkJS/contracts/SomeContract');</span><br><span class="line"></span><br><span class="line">config({</span><br><span class="line"> contracts: {</span><br><span class="line"> deploy: {</span><br><span class="line"> SomeContract: {}</span><br><span class="line"> }</span><br><span class="line"> }</span><br><span class="line">});</span><br><span class="line"></span><br><span class="line">contract('SomeContract', () => {</span><br><span class="line"></span><br><span class="line"> it('should do something', async () => {</span><br><span class="line"> const result = await SomeContract.methods.doSomething.call();</span><br><span class="line"> assert.equal(result, 'foo');</span><br><span class="line"> });</span><br><span class="line">});</span><br></pre></td></tr></table></figure> 822 823 <p>There’s one gotcha to keep in mind though. Looking at the snippet above, it seems like we can use <code>SmartContract</code> right away once it is imported. However, this is not actually true. As mentioned earlier, Embark first has to actually deploy our Smart Contracts and until that happens, all imported Smart Contract references are empty objects.</p> 824 <p>This is not a problem anymore when using Smart Contract instances inside spec blocks, because we know that tests are executed after all Smart Contracts have been deployed. Embark will hydrate the imported references with actual data before the tests are run.</p> 825 <div class="c-notification c-notification--info"> 826 <p><strong>Smart Contract reference hydration</strong></p> 827 <p><p>Smart Contract references imported from EmbarkJS are empty until the Smart Contract are actually deployed. This means Smart Contract references can only be used inside <code>contract()</code> blocks.</p> 828 </p> 829 </div> 830 831 832 833 <h2 id="Configuring-accounts"><a href="#Configuring-accounts" class="headerlink" title="Configuring accounts"></a>Configuring accounts</h2><p>Accounts within the testing environment can be configured <a href="/docs/contracts_deployment.html">just like we’re used to</a>. The same rules apply here, and <a href="/docs/contracts_deployment.html#Configuring-account-balance-for-development">configuring an Ether balance</a> is supported as well. Configuring custom accounts in tests is especially useful if we want to use a specific account for our tests.</p> 834 <figure class="highlight plain"><table><tr><td class="code"><pre><span class="line">config({</span><br><span class="line"> blockchain: {</span><br><span class="line"> accounts: [</span><br><span class="line"> {</span><br><span class="line"> privateKeyFile: 'path/to/file',</span><br><span class="line"> balance: '42 shannon'</span><br><span class="line"> }</span><br><span class="line"> ]</span><br><span class="line"> }</span><br><span class="line">});</span><br></pre></td></tr></table></figure> 835 836 <h2 id="Accessing-Accounts"><a href="#Accessing-Accounts" class="headerlink" title="Accessing Accounts"></a>Accessing Accounts</h2><p>Obviously, we want to access all configured accounts as well. Sometimes we want to test functions or methods that require us to specify a <code>from</code> address to send transactions from. For those cases we very likely want to access any of our our available accounts.</p> 837 <p>All available accounts are emitted by <code>config()</code> and can be accessed using a callback parameter like this:</p> 838 <figure class="highlight plain"><table><tr><td class="code"><pre><span class="line">let accounts = [];</span><br><span class="line"></span><br><span class="line">config({</span><br><span class="line"> ...</span><br><span class="line">}, (err, accounts) => {</span><br><span class="line"> accounts = accounts;</span><br><span class="line">});</span><br></pre></td></tr></table></figure> 839 840 <p>You can also grab the accounts from the callback of the <code>contract()</code> function (<code>describe</code> alias):</p> 841 <figure class="highlight plain"><table><tr><td class="code"><pre><span class="line">contract('SomeContract', (accounts) => {</span><br><span class="line"> const myAccounts = accounts[0];</span><br><span class="line"></span><br><span class="line"> it('should do something', async () => {</span><br><span class="line"> ...</span><br><span class="line"> });</span><br><span class="line">});</span><br></pre></td></tr></table></figure> 842 843 <h2 id="Connecting-to-a-different-node"><a href="#Connecting-to-a-different-node" class="headerlink" title="Connecting to a different node"></a>Connecting to a different node</h2><p>By default, Embark will use an internal VM to run the tests. However we can also specify a node to connect to and run the tests there, using the <code>host</code>, <code>port</code> and <code>type</code> options as shown below:</p> 844 <figure class="highlight plain"><table><tr><td class="code"><pre><span class="line">config({</span><br><span class="line"> blockchain: {</span><br><span class="line"> "endpoint": "http://localhost:8545"</span><br><span class="line"> }</span><br><span class="line">});</span><br></pre></td></tr></table></figure> 845 846 <h2 id="Configuring-modules"><a href="#Configuring-modules" class="headerlink" title="Configuring modules"></a>Configuring modules</h2><p>You can configure the different Embark modules directly in your test file. The available modules are: <a href="/docs/storage_configuration.html">storage</a>, <a href="/docs/naming_configuration.html">namesystem</a> and <a href="/docs/messages_configuration.html">communication</a>.</p> 847 <p>All configuration options for the respective modules are available. Also, the configurations you put inside the <code>config</code> function are merged inside the ones that are in the configuration file (meaning that you don’t have to put all the provider options if they are already in the default configs).</p> 848 <figure class="highlight plain"><table><tr><td class="code"><pre><span class="line">config({</span><br><span class="line"> storage: {</span><br><span class="line"> enabled: true</span><br><span class="line"> },</span><br><span class="line"> communication: {</span><br><span class="line"> enabled: true</span><br><span class="line"> },</span><br><span class="line"> namesystem: {</span><br><span class="line"> enabled: true,</span><br><span class="line"> register: {</span><br><span class="line"> rootDomain: "test.eth"</span><br><span class="line"> }</span><br><span class="line"> }</span><br><span class="line">});</span><br></pre></td></tr></table></figure> 849 850 <p>If the module is not started (eg. IPFS), Embark will start it for you.</p> 851 <h2 id="Manually-deploying-Smart-Contracts"><a href="#Manually-deploying-Smart-Contracts" class="headerlink" title="Manually deploying Smart Contracts"></a>Manually deploying Smart Contracts</h2><p>As mentioned earlier, Embark handles the deployment of our Smart Contracts using the function <code>config()</code> function. If we wish to deploy particular Smart Contracts manually, we can do so using an imported Smart Contract reference. We just need to make sure that we’re doing this inside a <code>contract()</code> block as discussed earlier:</p> 852 <figure class="highlight plain"><table><tr><td class="code"><pre><span class="line">const SimpleStorage = require('Embark/contracts/SimpleStorage');</span><br><span class="line"></span><br><span class="line">contract('SimpleStorage Deploy', () => {</span><br><span class="line"> let SimpleStorageInstance;</span><br><span class="line"></span><br><span class="line"> before(async function() {</span><br><span class="line"> SimpleStorageInstance = await SimpleStorage.deploy({ arguments: [150] }).send();</span><br><span class="line"> });</span><br><span class="line"></span><br><span class="line"> it('should set constructor value', async () => {</span><br><span class="line"> let result = await SimpleStorageInstance.methods.storedData().call();</span><br><span class="line"> assert.strictEqual(parseInt(result, 10), 150);</span><br><span class="line"> });</span><br><span class="line">});</span><br></pre></td></tr></table></figure> 853 854 <h2 id="Util-functions"><a href="#Util-functions" class="headerlink" title="Util functions"></a>Util functions</h2><h3 id="assert-reverts"><a href="#assert-reverts" class="headerlink" title="assert.reverts"></a>assert.reverts</h3><p>Using <code>assert.reverts</code>, you can easily assert that your transaction reverts.</p> 855 <figure class="highlight javascript"><table><tr><td class="code"><pre><span class="line"><span class="keyword">await</span> assert.reverts(contractMethodAndArguments[, options][, message]);</span><br></pre></td></tr></table></figure> 856 857 <ul> 858 <li><code>contractMethodAndArguments</code>: [Function] Contract method to call <code>send</code> on, including the arguments</li> 859 <li><code>options</code>: [Object] Optional options to pass to the <code>send</code> function</li> 860 <li><code>message</code>: [String] Optional string to match the revert message</li> 861 </ul> 862 <p>Returns a promise that you can wait for with <code>await</code>.</p> 863 <figure class="highlight javascript"><table><tr><td class="code"><pre><span class="line">it(<span class="string">"should revert with a value lower than 5"</span>, <span class="keyword">async</span> <span class="function"><span class="keyword">function</span>(<span class="params"></span>) </span>{</span><br><span class="line"> <span class="keyword">await</span> assert.reverts(SimpleStorage.methods.setHigher5(<span class="number">2</span>), {<span class="attr">from</span>: web3.eth.defaultAccount},</span><br><span class="line"> <span class="string">'Returned error: VM Exception while processing transaction: revert Value needs to be higher than 5'</span>);</span><br><span class="line">});</span><br></pre></td></tr></table></figure> 864 865 <h3 id="assert-eventEmitted"><a href="#assert-eventEmitted" class="headerlink" title="assert.eventEmitted"></a>assert.eventEmitted</h3><p>Using <code>eventEmitted</code>, you can assert that a transaction has emitted an event. You can also check for the returned values.</p> 866 <figure class="highlight javascript"><table><tr><td class="code"><pre><span class="line">assert.eventEmitted(transaction, event[, values]);</span><br></pre></td></tr></table></figure> 867 868 <ul> 869 <li><code>transaction</code>: [Object] Transaction object returned by a <code>send</code> call</li> 870 <li><code>event</code>: [String] Name of the event being emitted</li> 871 <li><code>values</code>: [Array or Object] Optional array or object of the returned values of the event.<ul> 872 <li>Using array: The order of the values put in the array need to match the order in which the values are returned by the event</li> 873 <li>Using object: The object needs to have the right key/value pair(s)</li> 874 </ul> 875 </li> 876 </ul> 877 <figure class="highlight javascript"><table><tr><td class="code"><pre><span class="line">it(<span class="string">'asserts that the event was triggered'</span>, <span class="keyword">async</span> <span class="function"><span class="keyword">function</span>(<span class="params"></span>) </span>{</span><br><span class="line"> <span class="keyword">const</span> transaction = <span class="keyword">await</span> SimpleStorage.methods.set(<span class="number">100</span>).send();</span><br><span class="line"> assert.eventEmitted(transaction, <span class="string">'EventOnSet'</span>, {<span class="attr">value</span>: <span class="string">"100"</span>, <span class="attr">success</span>: <span class="literal">true</span>});</span><br><span class="line">});</span><br></pre></td></tr></table></figure> 878 879 <h3 id="increaseTime"><a href="#increaseTime" class="headerlink" title="increaseTime"></a>increaseTime</h3><p>This function lets you increase the time of the EVM. It is useful in the case where you want to test expiration times for example.</p> 880 <figure class="highlight javascript"><table><tr><td class="code"><pre><span class="line"><span class="keyword">await</span> increaseTime(amount);</span><br></pre></td></tr></table></figure> 881 882 <p><code>amount</code>: [Number] Number of seconds to increase</p> 883 <figure class="highlight javascript"><table><tr><td class="code"><pre><span class="line">it(<span class="string">"should have expired after increasing time"</span>, <span class="keyword">async</span> <span class="function"><span class="keyword">function</span> (<span class="params"></span>) </span>{</span><br><span class="line"> <span class="keyword">await</span> increaseTime(<span class="number">5001</span>);</span><br><span class="line"> <span class="keyword">const</span> isExpired = <span class="keyword">await</span> Expiration.methods.isExpired().call();</span><br><span class="line"> assert.strictEqual(isExpired, <span class="literal">true</span>);</span><br><span class="line">});</span><br></pre></td></tr></table></figure> 884 885 <h3 id="mineAtTimestamp"><a href="#mineAtTimestamp" class="headerlink" title="mineAtTimestamp"></a>mineAtTimestamp</h3><p>This function mines a block and sets its <code>block.timestamp</code> accordingly. It let’s you mine in the future.</p> 886 <figure class="highlight javascript"><table><tr><td class="code"><pre><span class="line"><span class="keyword">await</span> mineAtTimestamp(timestamp);</span><br></pre></td></tr></table></figure> 887 888 <p><code>timestamp</code>: [Number] Timestamp when to mine the block</p> 889 <h3 id="getEvmVersion"><a href="#getEvmVersion" class="headerlink" title="getEvmVersion"></a>getEvmVersion</h3><p><code>getEvmVersion</code> returns the version and type of EVM.</p> 890 <p>It is useful if you want to make sure the EVM has the sufficient version to support an RPC call or if you want to make sure that you are using a VM like Ganache-CLI before making a call that only a VM supports.</p> 891 <figure class="highlight javascript"><table><tr><td class="code"><pre><span class="line"><span class="keyword">await</span> getEvmVersion();</span><br></pre></td></tr></table></figure> 892 893 <p>Returns a string, eg: <code>EthereumJS TestRPC/v2.9.2/ethereum-js</code></p> 894 <h2 id="Code-coverage"><a href="#Code-coverage" class="headerlink" title="Code coverage"></a>Code coverage</h2><p>Embark allows you to generate a coverage report for your Solidity Smart Contracts by passing the <code>--coverage</code> option on the <code>embark test</code> command.</p> 895 <figure class="highlight plain"><table><tr><td class="code"><pre><span class="line">$ embark test --coverage</span><br></pre></td></tr></table></figure> 896 897 <p>The generated report looks something like this:</p> 898 <p><img src="/coverage-files.png" alt="Coverage Report: Files"></p> 899 <p>This gives us a birds-eye view on the state of the coverage of our Smart Contracts: how many of the functions were called, how many lines were hit, even whether all the branch cases were executed. When selecting a file, a more detailed report is produced. Here’s what it looks like:</p> 900 <p><img src="/coverage-report.png" alt="Coverage Report: Detailed"></p> 901 902 </div> 903 <div class="o-container-medium o-distance-l"> 904 <div class="o-flex o-flex-space-between"> 905 906 <div class="o-flex__item"> 907 <a href="/docs/contracts_imports.html" class="c-button c-button--quite" title="Previous article">Previous</a> 908 </div> 909 910 911 <div class="o-flex__item"> 912 <a href="/docs/contracts_javascript.html" class="c-button c-button--quite" title="Next article">Next</a> 913 </div> 914 915 </div> 916 917 918 </div> 919 </div> 920 <div class="o-guided-content__addition"> 921 <h3 class="c-category-title">Contents</h3> 922 <ol class="o-list-bare"><li class="o-list-bare__item o-list-bare-level-2 o-ellipsis"><a href="#Creating-tests" class="u-link-uniform">Creating tests</a><ol class="o-list-bare__child"><li class="o-list-bare__item o-list-bare-level-3 o-ellipsis"><a href="#Importing-EmbarkJS" class="u-link-uniform">Importing EmbarkJS</a></li></ol></li><li class="o-list-bare__item o-list-bare-level-2 o-ellipsis"><a href="#Running-tests" class="u-link-uniform">Running tests</a><ol class="o-list-bare__child"><li class="o-list-bare__item o-list-bare-level-3 o-ellipsis"><a href="#Running-test-subsets" class="u-link-uniform">Running test subsets</a></li><li class="o-list-bare__item o-list-bare-level-3 o-ellipsis"><a href="#Running-tests-against-a-different-node" class="u-link-uniform">Running tests against a different node</a></li><li class="o-list-bare__item o-list-bare-level-3 o-ellipsis"><a href="#Outputting-gas-cost-details" class="u-link-uniform">Outputting gas cost details</a></li></ol></li><li class="o-list-bare__item o-list-bare-level-2 o-ellipsis"><a href="#Test-environment" class="u-link-uniform">Test environment</a></li><li class="o-list-bare__item o-list-bare-level-2 o-ellipsis"><a href="#Configuring-Smart-Contracts-for-tests" class="u-link-uniform">Configuring Smart Contracts for tests</a></li><li class="o-list-bare__item o-list-bare-level-2 o-ellipsis"><a href="#Accessing-Smart-Contract-instances" class="u-link-uniform">Accessing Smart Contract instances</a></li><li class="o-list-bare__item o-list-bare-level-2 o-ellipsis"><a href="#Configuring-accounts" class="u-link-uniform">Configuring accounts</a></li><li class="o-list-bare__item o-list-bare-level-2 o-ellipsis"><a href="#Accessing-Accounts" class="u-link-uniform">Accessing Accounts</a></li><li class="o-list-bare__item o-list-bare-level-2 o-ellipsis"><a href="#Connecting-to-a-different-node" class="u-link-uniform">Connecting to a different node</a></li><li class="o-list-bare__item o-list-bare-level-2 o-ellipsis"><a href="#Configuring-modules" class="u-link-uniform">Configuring modules</a></li><li class="o-list-bare__item o-list-bare-level-2 o-ellipsis"><a href="#Manually-deploying-Smart-Contracts" class="u-link-uniform">Manually deploying Smart Contracts</a></li><li class="o-list-bare__item o-list-bare-level-2 o-ellipsis"><a href="#Util-functions" class="u-link-uniform">Util functions</a><ol class="o-list-bare__child"><li class="o-list-bare__item o-list-bare-level-3 o-ellipsis"><a href="#assert-reverts" class="u-link-uniform">assert.reverts</a></li><li class="o-list-bare__item o-list-bare-level-3 o-ellipsis"><a href="#assert-eventEmitted" class="u-link-uniform">assert.eventEmitted</a></li><li class="o-list-bare__item o-list-bare-level-3 o-ellipsis"><a href="#increaseTime" class="u-link-uniform">increaseTime</a></li><li class="o-list-bare__item o-list-bare-level-3 o-ellipsis"><a href="#mineAtTimestamp" class="u-link-uniform">mineAtTimestamp</a></li><li class="o-list-bare__item o-list-bare-level-3 o-ellipsis"><a href="#getEvmVersion" class="u-link-uniform">getEvmVersion</a></li></ol></li><li class="o-list-bare__item o-list-bare-level-2 o-ellipsis"><a href="#Code-coverage" class="u-link-uniform">Code coverage</a></li></ol> 923 </div> 924 </div> 925 </section> 926 </main> 927 928 <script src="/js/linkjuice/dist/linkjuice.min.js"></script> 929 930 <footer role="contentinfo" class="c-footer o-distance-xxl"> 931 <div class="o-container"> 932 <div class="c-footer__top"> 933 <p class="c-category-title c-footer__top__title u-text-light"> 934 <a href="/" class="c-logo c-logo--negative" title="Embark">Embark</a> 935 </p> 936 </div> 937 <div class="c-footer__body"> 938 <div class="o-grid"> 939 <div class="o-grid__column--1-1 o-grid__column--medium-1-2 o-grid__column--large-1-5"> 940 <p class="c-category-title u-text-light">Resources</p> 941 <ul class="o-list-bare"> 942 <li class="o-list-bare__item"> 943 <a href="/docs/quick_start.html" class="u-link-ghost" title="Quick Start">Quick Start</a> 944 </li> 945 <li class="o-list-bare__item"> 946 <a href="/docs" class="u-link-ghost" title="Documentation">Documentation</a> 947 </li> 948 <li class="o-list-bare__item"> 949 <a href="https://blog.embarklabs.io" target="_blank" rel="noopener" class="u-link-ghost" title="Blog">Blog</a> 950 </li> 951 <li class="o-list-bare__item"> 952 <a href="/docs/faq.html" class="u-link-ghost" title="FAQ">FAQ</a> 953 </li> 954 <li class="o-list-bare__item"> 955 <a href="/docs/troubleshooting.html" class="u-link-ghost" title="Troubleshooting">Troubleshooting</a> 956 </li> 957 </ul> 958 </div> 959 <div class="o-grid__column--1-1 o-grid__column--medium-1-2 o-grid__column--large-1-5"> 960 <p class="c-category-title u-text-light">Help</p> 961 <ul class="o-list-bare"> 962 <li class="o-list-bare__item"> 963 <a href="https://stackoverflow.com/questions/tagged/embark" target="_blank" rel="noopener" class="u-link-ghost" title="Embark Questions">Stack Overflow</a> 964 </li> 965 <li class="o-list-bare__item"> 966 <a href="https://gitter.im/embark-framework/Lobby" target="_blank" rel="noopener" class="u-link-ghost" title="Gitter">Gitter</a> 967 </li> 968 <li class="o-list-bare__item"> 969 <a href="https://github.com/embarklabs/embark/issues" target="_blank" rel="noopener" class="u-link-ghost" title="Report issues">Report issues</a> 970 </li> 971 <li class="o-list-bare__item"> 972 <a href="https://github.com/embarklabs/embark/blob/master/CODE_OF_CONDUCT.md" target="_blank" rel="noopener" class="u-link-ghost" title="Code of Conduct">Code of Conduct</a> 973 </li> 974 </ul> 975 </div> 976 <div class="o-grid__column--1-1 o-grid__column--medium-1-2 o-grid__column--large-1-5"> 977 <p class="c-category-title u-text-light">Community</p> 978 <ul class="o-list-bare"> 979 <li class="o-list-bare__item"> 980 <a href="https://github.com/embarklabs" target="_blank" rel="noopener" class="u-link-ghost" title="Github">Github</a> 981 </li> 982 <li class="o-list-bare__item"> 983 <a href="https://twitter.com/EmbarkProject" target="_blank" rel="noopener" class="u-link-ghost" title="Twitter">Twitter</a> 984 </li> 985 <li class="o-list-bare__item"> 986 <a href="/docs/contributing.html" class="u-link-ghost" title="Contribute">Contribute</a> 987 </li> 988 <li class="o-list-bare__item"> 989 <a href="/community/#team" class="u-link-ghost" title="Team">Team</a> 990 </li> 991 </ul> 992 </div> 993 994 <div class="o-grid__column--1-1 o-grid__column--medium-1-2 o-grid__column--large-1-4"> 995 <p class="c-category-title u-text-light">The Status Network</p> 996 <ul class="o-list-bare two-columns"> 997 <li class="o-list-bare__item"><a class="u-link-ghost" href="https://status.im/" target="_blank">Status</a></li> 998 <li class="o-list-bare__item"><a class="u-link-ghost" href="https://keycard.tech/" target="_blank">Keycard</a></li> 999 <li class="o-list-bare__item"><a class="u-link-ghost" href="https://dap.ps/" target="_blank">dap.ps</a></li> 1000 <li class="o-list-bare__item"><a class="u-link-ghost" href="https://teller.exchange/" target="_blank">Teller</a></li> 1001 <li class="o-list-bare__item"><a class="u-link-ghost" href="https://assemble.fund/" target="_blank">Assemble</a></li> 1002 <li class="o-list-bare__item"><a class="u-link-ghost" href="https://subspace.embarklabs.io/" target="_blank">Subspace</a></li> 1003 <li class="o-list-bare__item"><a class="u-link-ghost" href="https://vac.dev/" target="_blank">Vac</a></li> 1004 <li class="o-list-bare__item"><a class="u-link-ghost" href="https://nimbus.team/" target="_blank">Nimbus</a></li> 1005 </ul> 1006 </div> 1007 </div> 1008 </div> 1009 <div class="c-footer__bottom"> 1010 <p class="u-text-light"> 1011 <a href="https://status.im/privacy-policy.html" title="Privacy Policy" target="_blank" class="u-text-light">Privacy Policy</a> 1012 / © 2019-2020 Embark 1013 </p> 1014 </div> 1015 </div> 1016 </footer> 1017 1018 1019 1020 1021 <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.4/highlight.min.js"></script> 1022 <script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script> 1023 <script> 1024 const EMBARK_DOC_VERSIONS = { 1025 'latest': 'https://framework.embarklabs.io/docs','3.2': 'https://5ca4e0fdb29712000adde37f--embark-site-versions.netlify.com/docs/' 1026 }; 1027 </script> 1028 1029 1030 <!-- Fathom - simple website analytics - https://github.com/usefathom/fathom --> 1031 <script> 1032 (function(f, a, t, h, o, m){ 1033 a[h]=a[h]||function(){(a[h].q=a[h].q||[]).push(arguments)}; 1034 o=f.createElement('script'), 1035 m=f.getElementsByTagName('script')[0]; 1036 o.async=1; o.src=t; o.id='fathom-script'; 1037 m.parentNode.insertBefore(o,m) 1038 })(document, window, '//fathom.status.im/tracker.js', 'fathom'); 1039 fathom('set', 'siteId', 'YDUQQ'); 1040 fathom('trackPageview'); 1041 </script> 1042 <!-- / Fathom --> 1043 1044 1045 <script src="/js/index.js"></script> 1046 1047 1048 <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script> 1049 <script type="text/javascript"> 1050 docsearch({ 1051 apiKey: '439d8dc2add18007a2f31be4a9c0ed70', 1052 indexName: 'embark', 1053 inputSelector: '#search-input' 1054 }); 1055 </script> 1056 1057 </body> 1058 </html> 1059