├── .gitignore ├── .gitmodules ├── COPYING ├── History.md ├── README.md ├── bin ├── cucumis └── cucumis.js ├── examples ├── addition.feature ├── google.feature ├── step_definitions │ ├── addition.js │ └── google.js └── subtract.feature ├── features ├── basic-feature.feature └── step_definitions │ └── basic-feature.js ├── lib ├── cucumis.js ├── formatters │ ├── json.formatter.js │ └── pretty.formatter.js ├── support │ ├── colorize.js │ └── indent.js └── templates │ └── stepdef.js.tpl ├── package.json └── test ├── fixtures └── test.js.tpl └── template.test.js /.gitignore: -------------------------------------------------------------------------------- 1 | *.swp 2 | .DS_Store 3 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "deps/kyuri"] 2 | path = deps/kyuri 3 | url = git@github.com:noblesamurai/kyuri.git 4 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /History.md: -------------------------------------------------------------------------------- 1 | 2 | v1.0.17 / 2011-02-17 3 | ================== 4 | 5 | * Fixed up scenario outline formatting 6 | * Fixed background order bug 7 | 8 | v1.0.16 / 2011-02-16 9 | ================== 10 | 11 | * Added more property assertions 12 | * Corrected bug with backgrounds only running once for Scenario outlines 13 | * got passedScenarioCount to match 14 | * fixed scenario count 15 | * Asserting basic functionality 16 | * tabify for easy copy and paste 17 | 18 | v1.0.15 / 2011-02-16 19 | ================== 20 | 21 | * Start using cucumis to test cucumis 22 | * Move examples to examples folder 23 | * fixed reference bug 24 | 25 | v1.0.14 / 2011-02-16 26 | ================== 27 | 28 | * JSON formatter 29 | * print out errors if the formatter fails 30 | * Moved error message creation into formatter 31 | * can now choose formatter via command line option 32 | * Move formatter into an external file 33 | * refactoring counters into formatter object 34 | 35 | v1.0.13 / 2011-02-16 36 | ================== 37 | 38 | * can override async step timeout with a commandline option 39 | * Release v1.0.12 40 | * command line parameters to run a directory or a file 41 | 42 | v1.0.12 / 2011-02-16 43 | ================== 44 | 45 | * command line parameters to run a directory or a file 46 | * updating readme 47 | 48 | v1.0.11 / 2011-02-16 49 | ================== 50 | 51 | * Added support for 'But' 52 | * Release v1.0.10 53 | * Stopped backgrounds running twice, and also fixed background printing 54 | * Background scenario support 55 | * Adding 'Background' Suport 56 | * using our forked version of kyuri 57 | * removing original kyuri repository 58 | * Updated readme to reflect new API 59 | 60 | v1.0.10 / 2011-02-16 61 | ================== 62 | 63 | * Stopped backgrounds running twice, and also fixed background printing 64 | * Background scenario support 65 | * Adding 'Background' Suport 66 | * using our forked version of kyuri 67 | * removing original kyuri repository 68 | * Updated readme to reflect new API 69 | 70 | v1.0.9 / 2011-02-15 71 | ================== 72 | 73 | * correct calculation of undefined and pending scenarios 74 | * printing for pending scenarios 75 | * Support for skipped and pending scenarios 76 | 77 | v1.0.8 / 2011-02-14 78 | ================== 79 | 80 | * More robust error handling of before/after unhandledExceptions 81 | 82 | v1.0.7 / 2011-02-14 83 | ================== 84 | 85 | * add dependencies to glob and underscore 86 | * recursively find features files 87 | * support for env.js 88 | * Added more event callbacks: before/afer step, before/after scenario 89 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # cucumis 2 | 3 | Cucumis is a basic implementation of [cucumber's](http://cukes.info) [gherkin](https://github.com/aslakhellesoy/cucumber/wiki/gherkin) BDD plain-english testing language in node.js. 4 | 5 | It was designed to meet the following criteria: 6 | 7 | - Run in node.js (cucumber only supports v8 currently and not the node.js commonjs package system) 8 | - Support asynchronous tests (cucumber only supports a synchronous system currently) 9 | 10 | It was built upon the gherkin parser [kyuri](https://github.com/nodejitsu/kyuri). 11 | 12 | ## Installation 13 | 14 | The easiest way to install cucumis is via the npm package manager: 15 | 16 | npm install cucumis 17 | 18 | ## Screencasts 19 | 20 | - see cucumis in action with some [web browser testing](http://screencast.com/t/AepofsIZ) 21 | 22 | ## Writing tests 23 | 24 | Tests are written in cucumber's [gherkin](https://github.com/aslakhellesoy/cucumber/wiki/gherkin) language. 25 | 26 | Create a folder called 'features' under your current directory which contains your .feature files. 27 | 28 | For example (addition.feature): 29 | 30 | Feature: Addition 31 | In order to avoid silly mistakes 32 | As a math idiot 33 | I want to be able to add up numbers 34 | 35 | Scenario: Add two numbers 36 | Given I have a calculator 37 | And I have entered 50 into the calculator 38 | And I have entered 70 into the calculator 39 | When I press add 40 | Then the result should be 120 on the screen 41 | 42 | Then run cucumis: 43 | 44 | $ cucumis 45 | 46 | You'll get the test results and a list of code snippets you'll need to implement to make the tests actually pass: 47 | 48 | Feature: Addition 49 | In order to avoid silly mistakes 50 | As a math idiot 51 | I want to be able to add up numbers 52 | 53 | Scenario: Add two numbers 54 | Given I have a calculator 55 | And I have entered 50 into the calculator 56 | And I have entered 70 into the calculator 57 | When I press add 58 | Then the result should be 120 on the screen 59 | 60 | 1 scenarios (1 passed, 1 undefined) 61 | 5 steps (5 undefined) 62 | 0m0.005s 63 | 64 | You can implement step definitions for undefined steps with these snippets: 65 | 66 | var Steps = require('cucumis').Steps; 67 | 68 | Steps.Given(/^I have a calculator$/, function (ctx) { 69 | ctx.pending(); 70 | }); 71 | 72 | Steps.Given(/^I have entered (\d+) into the calculator$/, function (ctx, arg1) { 73 | ctx.pending(); 74 | }); 75 | 76 | Steps.When(/^I press add$/, function (ctx) { 77 | ctx.pending(); 78 | }); 79 | 80 | Steps.Then(/^the result should be (\d+) on the screen$/, function (ctx, arg1) { 81 | ctx.pending(); 82 | }); 83 | 84 | Steps.export(module); 85 | 86 | Simply add the code snippets to a .js file (eg. addition.js) in the step_definitions folder beneath the features folder. For example: 87 | 88 | var Steps = require('kyuri').Steps; 89 | var assert = require('assert'); 90 | 91 | var Calculator = function() { 92 | this._stack = []; 93 | }; 94 | 95 | Calculator.prototype = { 96 | enter: function (value) { 97 | this._stack.push(value); 98 | }, 99 | 100 | add: function() { 101 | this._stack.push(this._stack.pop() + this._stack.pop()); 102 | }, 103 | 104 | subtract: function() { 105 | this._stack.push(-(this._stack.pop() - this._stack.pop())); 106 | }, 107 | 108 | result: function() { 109 | return this._stack[this._stack.length - 1]; 110 | }, 111 | }; 112 | 113 | var calc; 114 | 115 | Steps.Given(/^I have a calculator$/, function(ctx) { 116 | calc = new Calculator(); 117 | setTimeout(function() { 118 | ctx.done(); 119 | }, 10); 120 | }); 121 | 122 | Steps.Given(/^I have entered (\d+) into the calculator$/, function (ctx, value) { 123 | calc.enter(parseInt(value)); 124 | ctx.done(); 125 | }); 126 | 127 | Steps.When(/^I press add$/, function (ctx) { 128 | calc.add(); 129 | ctx.done(); 130 | }); 131 | 132 | Steps.Then(/^the result should be (\d+) on the screen$/, function (ctx, value) { 133 | assert.equal(calc.result(), parseInt(value)); 134 | ctx.done(); 135 | }); 136 | 137 | Steps.export(module); 138 | 139 | Then run cucumis again: 140 | 141 | Feature: Addition 142 | In order to avoid silly mistakes 143 | As a math idiot 144 | I want to be able to add up numbers 145 | 146 | Scenario: Add two numbers 147 | Given I have a calculator 148 | And I have entered 50 into the calculator 149 | And I have entered 70 into the calculator 150 | When I press add 151 | Then the result should be 120 on the screen 152 | 153 | 1 scenarios (1 passed) 154 | 5 steps (5 passed) 155 | 0m0.017s 156 | 157 | You can perform asynchronous tests like: 158 | 159 | Steps.Given(/^I have a calculator$/, function(ctx) { 160 | calc = new Calculator(); 161 | setTimeout(function() { 162 | ctx.done(); 163 | }, 10); 164 | }); 165 | 166 | And by default, each step will need to complete in under 2 seconds otherwise a timeout error will be thrown. 167 | 168 | ## contributors 169 | - [Eugene Ware](http://eugeneware.com) 170 | - [kyuri](https://github.com/nodejitsu/kyuri) 171 | - You? 172 | 173 | ## license 174 | 175 | Copyright 2010-2011 Noble Samurai 176 | 177 | cucumis 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. 178 | 179 | cucumis 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. 180 | 181 | You should have received a copy of the GNU General Public License along with cucumis. If not, see http://www.gnu.org/licenses/. 182 | 183 | -------------------------------------------------------------------------------- /bin/cucumis: -------------------------------------------------------------------------------- 1 | ./cucumis.js -------------------------------------------------------------------------------- /bin/cucumis.js: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | 3 | var cucumis = require('../lib/cucumis'), 4 | path = require('path'), 5 | should = require('should'), 6 | fs = require('fs'), 7 | _ = require('underscore'), 8 | globSync = require('glob').globSync, 9 | colorizelib = require('../lib/support/colorize'), 10 | colorize = colorizelib.colorize, 11 | indent = require('../lib/support/indent'); 12 | 13 | // test timeout 14 | var timeout = 5000; 15 | 16 | // Prefer mustache style templates 17 | _.templateSettings = { 18 | interpolate : /\{\{(.+?)\}\}/g 19 | }; 20 | 21 | // template for undefined steps 22 | var undefinedStepTemplate = _.template(fs.readFileSync(path.join(__dirname, '../lib/templates/stepdef.js.tpl')).toString()); 23 | 24 | // escapes regexs 25 | RegExp.escape = function(str) 26 | { 27 | var specials = new RegExp("[.*+?|()\\[\\]{}\\\\]", "g"); // .*+?|()[]{}\ 28 | return str.replace(specials, "\\$&"); 29 | } 30 | 31 | function processCmdLine() { 32 | var usage = colorize('' 33 | + '[bold]{Usage}: cucumis [options] [path]\n' 34 | + '\n' 35 | + '[bold]{Exmample}\n' 36 | + 'cucumis examples/features\n' 37 | + '\n' 38 | + '[bold]{Options}:\n' 39 | + ' -h, --help Output help information\n' 40 | + ' -f, --format FORMAT How to format features (Default: pretty). Available formats:\n' 41 | + ' pretty : Prints the feature as is - in colours\n' 42 | + ' json : Prints the feature as JSON\n' 43 | + ' -b, --boring Suppress ansi-escape colors\n' 44 | + ' -t, --timeout MS Async step timeout in milliseconds, defaults to 5000\n' 45 | ); 46 | 47 | // Parse arguments 48 | var args = process.argv.slice(2) 49 | , path = null; 50 | 51 | while (args.length) { 52 | var arg = args.shift(); 53 | switch (arg) { 54 | case '-h': 55 | case '--help': 56 | abort(usage); 57 | break; 58 | 59 | case '-t': 60 | case '--timeout': 61 | timeout = parseInt(args.shift()); 62 | break; 63 | 64 | case '-b': 65 | case '--boring': 66 | colorizelib.boring = true; 67 | break; 68 | 69 | case '-f': 70 | case '--format': 71 | format = args.shift(); 72 | break; 73 | 74 | default: 75 | path = arg; 76 | } 77 | } 78 | 79 | return path; 80 | } 81 | 82 | var format = 'pretty'; 83 | var runPath = processCmdLine(); 84 | 85 | var Formatter = require('../lib/formatters/' + format + '.formatter').Formatter; 86 | var formatter = new Formatter(); 87 | 88 | // uncaught expception handling 89 | var _stepError = { 90 | id: 0, 91 | handler: function(id, err) { 92 | throw err; 93 | }, 94 | }; 95 | 96 | process.on('uncaughtException', function (err) { 97 | if (_stepError.id) { 98 | _stepError.handler(_stepError.id, err); 99 | } else if (formatter) { 100 | formatter.generalUncaughtException(err); 101 | } else { 102 | console.error(str); 103 | process.exit(1); 104 | } 105 | }); 106 | 107 | if (runPath === null) { 108 | runPath = 'features'; 109 | } 110 | 111 | var runPattern = '\.feature$'; 112 | 113 | var stat = fs.statSync(path.resolve(process.cwd(), runPath)); 114 | if (stat.isFile()) { 115 | var filePath = path.resolve(process.cwd(), runPath); 116 | runPattern = RegExp.escape('^' + filePath + '$'); 117 | runPath = path.dirname(filePath); 118 | } 119 | 120 | // Load up env.js 121 | globSync(path.resolve(process.cwd(), runPath, '**/env.js')).forEach(function (env) { 122 | require(env); 123 | }); 124 | 125 | // Load up step definitions 126 | var stepDefs = []; 127 | try { 128 | globSync(path.resolve(process.cwd(), runPath, '**/*.js')) 129 | .filter(function(value) { 130 | return !value.match(/\/env.js$/); 131 | }) 132 | .forEach(function(file) { 133 | var mod = require(file); 134 | if (mod instanceof Array) { 135 | var newDefs = mod.filter(function (item) { 136 | return (item.operator) && (item.pattern instanceof RegExp) && (item.generator instanceof Function); 137 | }); 138 | stepDefs = stepDefs.concat(newDefs); 139 | } 140 | }); 141 | } catch (err) {} 142 | 143 | runFeatures(runPath, runPattern); 144 | 145 | function runFeatures(runPath, runPattern) { 146 | var paths = [path.resolve(process.cwd(), runPath), path.resolve(process.cwd(), runPath, 'features')]; 147 | var p; 148 | 149 | var features = []; 150 | var reRunPattern = new RegExp(runPattern); 151 | 152 | while (p = paths.shift()) { 153 | 154 | try { 155 | var files = fs.readdirSync(p); 156 | // find features 157 | files 158 | .filter(function(f) { return path.join(p, f).match(reRunPattern) }) 159 | .filter(function(f) { return fs.statSync(path.join(p, f)).isFile() }) 160 | .forEach(function(f) { features.push(path.join(p, f)) }); 161 | 162 | // find more directories to traverse 163 | files 164 | .filter(function(f) { return fs.statSync(path.join(p, f)).isDirectory() }) 165 | .forEach(function(f) { paths.push(path.join(p, f)) }); 166 | } catch (err) { 167 | // ignore files that don't exist 168 | } 169 | } 170 | 171 | features = _(features).uniq(); 172 | 173 | notifyListeners('beforeTest', function() { 174 | (function next(){ 175 | if (features.length) { 176 | runFeature(features.shift(), next); 177 | } else { 178 | notifyListeners('afterTest', function() { 179 | formatter.afterTest(); 180 | }); 181 | } 182 | })(); 183 | }); 184 | } 185 | 186 | function notifyListeners(eventName, cb, level) { 187 | level = level || 1; 188 | var listeners = _.clone(cucumis.Steps.Runner.listeners(eventName)); 189 | (function next() { 190 | if (listeners.length) { 191 | var listener = listeners.shift(); 192 | 193 | var responseOk = true; 194 | 195 | var id = setTimeout(function() { 196 | responseOk = false; 197 | formatter.asyncStepTimeoutError(eventName, level); 198 | next(); 199 | }, 100); 200 | 201 | _stepError.id = id; 202 | _stepError.handler = function(id, err) { 203 | responseOk = false; 204 | clearTimeout(id); 205 | formatter.asyncStepTimeoutError(eventName, level, err); 206 | 207 | next(); 208 | }; 209 | 210 | listener(function() { 211 | if (responseOk) { 212 | clearTimeout(id); 213 | next(); 214 | } 215 | }); 216 | } else { 217 | cb(); 218 | } 219 | })(); 220 | } 221 | 222 | function runFeature(featureFile, cb) { 223 | var data = fs.readFileSync(featureFile); 224 | var ast = cucumis.parse(data.toString()); 225 | 226 | // Feature 227 | for (var index in ast) { 228 | 229 | if (ast[index]) { 230 | // Extract background 231 | var background = function(cb) { 232 | cb(); 233 | }; 234 | 235 | var _background = background; 236 | 237 | if (ast[index].background) { 238 | ast[index].background.background = true; 239 | background = function(cb) { 240 | formatter.beforeBackground(ast[index].background); 241 | notifyListeners('beforeBackground', function() { 242 | runScenario(_background, ast[index].background, function () { 243 | ast[index].background.backgroundPrinted = true; 244 | formatter.afterBackground(ast[index].background); 245 | notifyListeners('afterBackground', cb); 246 | }); 247 | }); 248 | } 249 | } 250 | 251 | var feature = ast[index]; 252 | 253 | formatter.beforeFeature(feature); 254 | 255 | notifyListeners('beforeFeature', function() { 256 | if (feature.scenarios && feature.scenarios.length) { 257 | // Scenarios 258 | var scenarios = feature.scenarios; 259 | 260 | (function next(){ 261 | if (scenarios.length) { 262 | runScenario(background, scenarios.shift(), next); 263 | } else { 264 | notifyListeners('afterFeature', function() { 265 | formatter.afterFeature(feature); 266 | cb(); 267 | }); 268 | } 269 | })(); 270 | } 271 | }); 272 | } 273 | } 274 | } 275 | 276 | function runScenario(background, scenario, cb) { 277 | var testState = { 278 | scenarioState: 'passed', 279 | scenarioUndefined: false, 280 | lastStepType: 'GIVEN', 281 | skip: false, 282 | }; 283 | 284 | if (scenario.outline && !scenario.background) { 285 | formatter.beforeScenarioOutline(scenario); 286 | } 287 | 288 | if (scenario.breakdown && scenario.breakdown.length) { 289 | testState.lastStepType = 'GIVEN'; 290 | 291 | var exampleSets = [{}]; 292 | 293 | // Parse examples data 294 | if (scenario.hasExamples) { 295 | var examples = scenario.examples; 296 | for (var exampleVar in examples) { 297 | examples[exampleVar].forEach(function(exampleValue, index) { 298 | if (!exampleSets[index]) { 299 | exampleSets[index] = {}; 300 | } 301 | 302 | exampleSets[index][exampleVar] = exampleValue; 303 | }); 304 | } 305 | } 306 | 307 | // Examples 308 | (function next(){ 309 | testState.skip = false; 310 | 311 | if (exampleSets.length) { 312 | background(function() { 313 | if (!scenario.background) { 314 | formatter.beforeScenario(scenario); 315 | notifyListeners('beforeScenario', function() { 316 | runExampleSet(scenario, exampleSets.shift(), testState, next); 317 | }); 318 | } else { 319 | runExampleSet(scenario, exampleSets.shift(), testState, next); 320 | } 321 | }); 322 | } else { 323 | if (testState.scenarioUndefined) { 324 | formatter.undefinedScenarioCount++; 325 | } 326 | 327 | if (!scenario.background) { 328 | formatter.afterScenario(scenario); 329 | notifyListeners('afterScenario', cb); 330 | } else { 331 | cb(); 332 | } 333 | } 334 | })(); 335 | } 336 | } 337 | 338 | function runExampleSet(scenario, exampleSet, testState, cb) { 339 | testState.scenarioState = 'passed'; 340 | 341 | if (!scenario.background) { 342 | formatter.scenarioCount++; 343 | } 344 | 345 | // Steps 346 | var steps = []; 347 | scenario.breakdown.forEach(function(breakdown) { 348 | // Step 349 | for (var i in breakdown) { 350 | var step = breakdown[i]; 351 | steps.push(step); 352 | } 353 | }); 354 | 355 | (function next(){ 356 | if (steps.length) { 357 | var step = steps.shift(); 358 | formatter.beforeStep(step); 359 | 360 | notifyListeners('beforeStep', function() { 361 | runStep(scenario, step, exampleSet, testState, function() { 362 | formatter.stepCount++; 363 | notifyListeners('afterStep', function() { 364 | formatter.afterStep(step); 365 | next(); 366 | }); 367 | }); 368 | }); 369 | } else { 370 | if (!scenario.background) { 371 | switch (testState.scenarioState) { 372 | case 'failed': 373 | formatter.failedScenarioCount++; 374 | break; 375 | 376 | case 'pending': 377 | formatter.pendingScenarioCount++; 378 | break; 379 | 380 | case 'passed': 381 | formatter.passedScenarioCount++; 382 | break; 383 | 384 | } 385 | } 386 | 387 | notifyListeners('afterSteps', function() { 388 | formatter.afterSteps(scenario); 389 | cb(); 390 | }); 391 | } 392 | })(); 393 | } 394 | 395 | function runStep(scenario, step, exampleSet, testState, cb) { 396 | var stepType = step[0]; 397 | if (step[0] == 'AND' || step[0] == 'BUT') { 398 | stepType = testState.lastStepType; 399 | } 400 | testState.lastStepType = stepType; 401 | 402 | function capitalize(str) { 403 | return str.charAt(0).toUpperCase() + str.slice(1).toLowerCase(); 404 | } 405 | 406 | stepType = capitalize(stepType); 407 | 408 | var stepText = step[1]; 409 | for (var exampleVar in exampleSet) { 410 | stepText = stepText.replace(new RegExp('<' + exampleVar + '>', 'g'), exampleSet[exampleVar]); 411 | } 412 | 413 | var stepLine = capitalize(step[0]) + ' ' + stepText; 414 | 415 | testState.foundStepDef = false; 416 | testState.result = 'pass'; 417 | testState.msg = ''; 418 | testState.err = null; 419 | 420 | var myStepDefs = _.clone(stepDefs); 421 | 422 | // Match step definitions against current step 423 | (function next(){ 424 | if (myStepDefs.length) { 425 | runStepDef(myStepDefs.shift(), stepType, stepText, testState, next); 426 | } else { 427 | if (!testState.foundStepDef) { // Undefined step 428 | formatter.undefinedStepCount++; 429 | testState.scenarioUndefined = true; 430 | 431 | testState.result = 'undefined'; 432 | testState.skip = true; 433 | 434 | // smart parametrization of numbers and strings 435 | var re = RegExp.escape(stepText).replace(/\//g, '\\/'); 436 | var args = []; 437 | 438 | re = re.replace(/(\s|^)(\d+)(\s|$)/, function(str, m1, m2, m3) { 439 | args.push('arg' + (args.length + 1)); 440 | return m1 + '(\\d+)' + m3; 441 | }); 442 | 443 | re = re.replace(/("[^"]*?")/g, function(str, m1) { 444 | args.push('arg' + (args.length + 1)); 445 | return '"([^"]*?)"'; 446 | }); 447 | 448 | var snippet = undefinedStepTemplate({type: stepType, title: re, args: [''].concat(args).join(', ')}); 449 | formatter.undefinedSteps[snippet] = true; 450 | } 451 | 452 | formatter.afterStepResult(scenario, stepLine, testState.result, testState.msg, testState.err); 453 | 454 | cb(); 455 | } 456 | })(); 457 | } 458 | 459 | function runStepDef(stepDef, stepType, stepText, testState, cb) { 460 | var matches; 461 | if (!testState.foundStepDef && stepDef.operator.toUpperCase() == stepType.toUpperCase()) { 462 | if (matches = stepDef.pattern.exec(stepText)) { 463 | testState.foundStepDef = true; 464 | 465 | if (!testState.skip) { 466 | // Run step 467 | var id; 468 | var runTest = true; 469 | try { 470 | 471 | id = setTimeout(function(){ 472 | runTest = false; 473 | stepError(id, new Error('Test timed out (' + timeout + 'ms)')); 474 | }, timeout); 475 | 476 | _stepError.handler = stepError; 477 | _stepError.id = id; 478 | 479 | var ctx = { 480 | done: function() { 481 | if (runTest) { 482 | clearTimeout(id); 483 | testState.result = 'pass'; 484 | formatter.passedStepCount ++; 485 | 486 | cb(); 487 | } 488 | }, 489 | 490 | pending: function() { 491 | if (runTest) { 492 | clearTimeout(id); 493 | testState.result = 'pending'; 494 | formatter.pendingStepCount ++; 495 | 496 | testState.msg = 'TODO: Pending'; 497 | testState.skip = true; 498 | 499 | testState.scenarioState = 'pending'; 500 | 501 | cb(); 502 | } 503 | }, 504 | }; 505 | 506 | stepDef.generator.apply({}, [ctx].concat(matches.slice(1))); 507 | } catch (err) { 508 | stepError(id, err); 509 | } 510 | } else { 511 | testState.result = 'skipped'; 512 | formatter.skippedStepCount ++; 513 | cb(); 514 | } 515 | 516 | return; 517 | } 518 | } 519 | 520 | function stepError(id, err) { 521 | clearTimeout(id); 522 | 523 | testState.err = err; 524 | 525 | testState.result = 'fail'; 526 | formatter.failedStepCount ++; 527 | testState.scenarioState = 'failed'; 528 | testState.skip = true; 529 | 530 | cb(); 531 | } 532 | 533 | cb(); 534 | } 535 | 536 | /** 537 | * Exit with the given `str`. 538 | * 539 | * @param {String} str 540 | */ 541 | 542 | function abort(str) { 543 | console.error(str); 544 | process.exit(1); 545 | } 546 | 547 | -------------------------------------------------------------------------------- /examples/addition.feature: -------------------------------------------------------------------------------- 1 | Feature: Addition 2 | In order to avoid silly mistakes 3 | As a math idiot 4 | I want to be able to add up numbers 5 | 6 | Background: 7 | Given I have a calculator 8 | 9 | Scenario: Add two numbers 10 | Given I have entered 50 into the calculator 11 | And I have entered 70 into the calculator 12 | When I press add 13 | Then the result should be 120 on the screen 14 | 15 | Scenario: Add three numbers 16 | Given I have entered 1 into the calculator 17 | And I have entered 2 into the calculator 18 | And I have entered 3 into the calculator 19 | 20 | When I press add 21 | Then the result should be 5 on the screen 22 | 23 | When I press add 24 | Then the result should be 6 on the screen 25 | 26 | Scenario: Return a single number 27 | Given I have entered 42 into the calculator 28 | Then the result should be 42 on the screen 29 | 30 | Scenario Outline: Add some numbers 31 | Given I have entered into the calculator 32 | And I have entered into the calculator 33 | When I press add 34 | Then the result should be on the screen 35 | 36 | Examples: 37 | | num1 | num2 | result | 38 | | 1 | 2 | 3 | 39 | | 2 | 3 | 5 | 40 | -------------------------------------------------------------------------------- /examples/google.feature: -------------------------------------------------------------------------------- 1 | Feature: Search Google 2 | As a web searcher 3 | I want to search google 4 | So that I can find information about stuff 5 | 6 | Background: 7 | Given I am using the "safari" browser 8 | 9 | Scenario: Search for basic keyword 10 | Given I am on the "Google" "Home" page 11 | 12 | When I enter "Hello World" into the "Search Query" text field 13 | And I click the "Google" "Search" button 14 | 15 | Then my title should contain "Hello World" 16 | But my title shouldn't contain "Pygmies" 17 | -------------------------------------------------------------------------------- /examples/step_definitions/addition.js: -------------------------------------------------------------------------------- 1 | var Steps = require('cucumis').Steps; 2 | 3 | var Calculator = function() { 4 | this._stack = []; 5 | }; 6 | 7 | Calculator.prototype = { 8 | enter: function (value) { 9 | this._stack.push(value); 10 | }, 11 | 12 | get stack() { 13 | return this._stack; 14 | }, 15 | 16 | add: function() { 17 | this._stack.push(this._stack.pop() + this._stack.pop()); 18 | }, 19 | 20 | subtract: function() { 21 | this._stack.push(-(this._stack.pop() - this._stack.pop())); 22 | }, 23 | 24 | result: function() { 25 | return this._stack[this._stack.length - 1]; 26 | }, 27 | }; 28 | 29 | var calc; 30 | 31 | Steps.Given(/^I have a calculator$/, function(ctx) { 32 | calc = new Calculator(); 33 | setTimeout(function() { 34 | ctx.done(); 35 | }, 10); 36 | }); 37 | 38 | Steps.Given(/^I have entered (\d+) into the calculator$/, function (ctx, value) { 39 | calc.enter(parseInt(value)); 40 | ctx.done(); 41 | }); 42 | 43 | Steps.When(/^I press add$/, function (ctx) { 44 | calc.add(); 45 | ctx.done(); 46 | }); 47 | 48 | Steps.Then(/^the result should be (\d+) on the screen$/, function (ctx, value) { 49 | calc.result().should.eql(parseInt(value)); 50 | ctx.done(); 51 | }); 52 | 53 | Steps.When(/^I press subtract$/, function (ctx) { 54 | calc.subtract(); 55 | ctx.done(); 56 | }); 57 | 58 | Steps.export(module); 59 | -------------------------------------------------------------------------------- /examples/step_definitions/google.js: -------------------------------------------------------------------------------- 1 | var Steps = require('cucumis').Steps, 2 | assert = require('assert'), 3 | should = require('should'), 4 | soda = require('soda'); 5 | 6 | var browserType = 'firefox'; 7 | var browser; 8 | 9 | var baseUrl = 'http://www.google.com.au'; 10 | 11 | var pageMap = { 12 | 'Google': { 13 | 'Home': '/', 14 | }, 15 | }; 16 | 17 | var fieldMap = { 18 | 'Google': { 19 | 'Search Query': 'q', 20 | 'Search': 'btnG', 21 | }, 22 | }; 23 | 24 | var lastSite; 25 | 26 | Steps.Runner.on('afterTest', function(done) { 27 | if (browser) { 28 | browser 29 | .chain 30 | .testComplete() 31 | .end(function (err) { 32 | if (err) throw err; 33 | done(); 34 | }); 35 | } else { 36 | done(); 37 | } 38 | }); 39 | 40 | Steps.Given(/^I am using the "([^"]*)" browser$/, function (ctx, bt) { 41 | browserType = bt; 42 | browser = soda.createClient({ 43 | host: 'localhost' 44 | , port: 4444 45 | , url: baseUrl 46 | , browser: browserType 47 | }); 48 | 49 | browser 50 | .chain 51 | .session() 52 | .end(function(err) { 53 | if (err) throw err; 54 | ctx.done(); 55 | }); 56 | }); 57 | 58 | Steps.Given(/^I am on the "([^"]*?)" "([^"]*?)" page$/, function (ctx, site, page) { 59 | lastSite = site; 60 | var url = pageMap[site][page]; 61 | 62 | browser 63 | .chain 64 | .open(url) 65 | .end(function(err) { 66 | if (err) throw err; 67 | ctx.done(); 68 | }); 69 | }); 70 | 71 | Steps.When(/^I enter "([^"]*?)" into the "([^"]*?)" text field$/, function (ctx, text, field) { 72 | browser 73 | .chain 74 | .type(fieldMap[lastSite][field], text) 75 | .end(function(err) { 76 | if (err) throw err; 77 | ctx.done(); 78 | }); 79 | }); 80 | 81 | Steps.When(/^I click the "([^"]*?)" "([^"]*?)" button$/, function (ctx, site, field) { 82 | lastSite = site; 83 | browser 84 | .chain 85 | .click(fieldMap[site][field]) 86 | .waitForPageToLoad(2000) 87 | .end(function(err) { 88 | if (err) throw err; 89 | ctx.done(); 90 | }); 91 | }); 92 | 93 | Steps.Then(/^my title should contain "([^"]*?)"$/, function (ctx, needle) { 94 | browser 95 | .chain 96 | .getTitle(function(title){ 97 | title.should.include.string(needle); 98 | }) 99 | .end(function(err) { 100 | if (err) throw err; 101 | ctx.done(); 102 | }); 103 | }); 104 | 105 | Steps.Then(/^my title shouldn't contain "([^"]*?)"$/, function (ctx, needle) { 106 | browser 107 | .chain 108 | .getTitle(function(title){ 109 | title.should.not.include.string(needle); 110 | }) 111 | .end(function(err) { 112 | if (err) throw err; 113 | ctx.done(); 114 | }); 115 | }); 116 | 117 | Steps.export(module); 118 | -------------------------------------------------------------------------------- /examples/subtract.feature: -------------------------------------------------------------------------------- 1 | Feature: Subtraction 2 | In order to avoid silly mistakes 3 | As a math idiot 4 | I want to be able to subtract numbers 5 | Scenario: Subtract two numbers 6 | Given I have a calculator 7 | And I have entered 70 into the calculator 8 | And I have entered 50 into the calculator 9 | When I press subtract 10 | Then the result should be 20 on the screen 11 | -------------------------------------------------------------------------------- /features/basic-feature.feature: -------------------------------------------------------------------------------- 1 | Feature: Run basic features 2 | As a cucumis user 3 | I want to run a simple feature 4 | So that I can reduce defects in my code 5 | 6 | Scenario: Run basic feature 7 | When I run cucumis against the file "examples/addition.feature" 8 | Then there should be no executable errors 9 | And the "Total Errors" should be 0 10 | And the "Number of Features" should be 1 11 | 12 | And the "Scenario Count" should be 5 13 | And the "Passed Scenario Count" should be 5 14 | And the "Failed Scenario Count" should be 0 15 | And the "Pending Scenario Count" should be 0 16 | And the "Undefined Scenario Count" should be 0 17 | 18 | And the "Step Count" should be 26 19 | And the "Passed Step Count" should be 26 20 | And the "Failed Step Count" should be 0 21 | And the "Skipped Step Count" should be 0 22 | And the "Pending Step Count" should be 0 23 | And the "Undefined Step Count" should be 0 24 | 25 | And the "Elapsed Time" should be greater than 0 26 | 27 | When I select the Feature "Addition" 28 | Then the feature's "name" should be "Addition" 29 | And the feature's "description" should be "In order to avoid silly mistakes\nAs a math idiot\nI want to be able to add up numbers\n" 30 | Then the feature should have a background 31 | And the feature should have 5 scenarios 32 | 33 | When I select the Scenario "Add three numbers" 34 | Then the scenario should have 7 steps 35 | 36 | When I select the Step "Then the result should be 5 on the screen" 37 | Then the step's "result" should be "pass" 38 | -------------------------------------------------------------------------------- /features/step_definitions/basic-feature.js: -------------------------------------------------------------------------------- 1 | var Steps = require('cucumis').Steps, 2 | spawn = require('child_process').spawn, 3 | _ = require('underscore'); 4 | 5 | function runCucumis(file, cb) { 6 | var ret = { 7 | returnCode: 0, 8 | stdOut: '', 9 | stdErr: '', 10 | }; 11 | 12 | var ls = spawn('cucumis', ['-f', 'json', file]); 13 | 14 | ls.stdout.on('data', function (data) { 15 | ret.stdOut = data; 16 | }); 17 | 18 | ls.stderr.on('data', function (data) { 19 | ret.stdErr = data; 20 | }); 21 | 22 | ls.on('exit', function (code) { 23 | ret.returnCode = code; 24 | cb(ret); 25 | }); 26 | } 27 | 28 | var executableResults; 29 | var testResults; 30 | var currentFeature; 31 | var currentScenario; 32 | var currentStep; 33 | 34 | var testMap = { 35 | 'Total Errors': function() { 36 | return testResults.allErrors.length; 37 | }, 38 | 'Number of Features': function() { 39 | return testResults.features.length; 40 | }, 41 | 'Scenario Count': function() { 42 | return testResults.stats.scenarioCount; 43 | }, 44 | 'Passed Scenario Count': function() { 45 | return testResults.stats.passedScenarioCount; 46 | }, 47 | 'Failed Scenario Count': function() { 48 | return testResults.stats.failedScenarioCount; 49 | }, 50 | 'Undefined Scenario Count': function() { 51 | return testResults.stats.undefinedScenarioCount; 52 | }, 53 | 'Pending Scenario Count': function() { 54 | return testResults.stats.pendingScenarioCount; 55 | }, 56 | 'Step Count': function() { 57 | return testResults.stats.stepCount; 58 | }, 59 | 'Passed Step Count': function() { 60 | return testResults.stats.passedStepCount; 61 | }, 62 | 'Failed Step Count': function() { 63 | return testResults.stats.failedStepCount; 64 | }, 65 | 'Skipped Step Count': function() { 66 | return testResults.stats.skippedStepCount; 67 | }, 68 | 'Pending Step Count': function() { 69 | return testResults.stats.pendingStepCount; 70 | }, 71 | 'Undefined Step Count': function() { 72 | return testResults.stats.undefinedStepCount; 73 | }, 74 | 'Elapsed Time': function() { 75 | return testResults.stats.elapsedTime; 76 | }, 77 | }; 78 | 79 | var featureMap = { 80 | 'a background': function() { 81 | return currentFeature.background; 82 | }, 83 | 'scenarios': function() { 84 | return currentFeature.scenarios; 85 | }, 86 | 'name': function() { 87 | return currentFeature.name; 88 | }, 89 | 'description': function() { 90 | return currentFeature.description; 91 | }, 92 | }; 93 | 94 | var scenarioMap = { 95 | 'steps': function() { 96 | return currentScenario.steps; 97 | }, 98 | }; 99 | 100 | var stepMap = { 101 | 'result': function() { 102 | return currentStep.result; 103 | }, 104 | }; 105 | 106 | var opMap = { 107 | 'greater than': function() { 108 | return Object.prototype.should.above; 109 | }, 110 | 'less than': function() { 111 | return Object.prototype.should.below; 112 | }, 113 | 'equal to': function() { 114 | return Object.prototype.should.eql; 115 | }, 116 | }; 117 | 118 | Steps.When(/^I run cucumis against the file "([^"]*?)"$/, function (ctx, file) { 119 | runCucumis(file, function(results) { 120 | executableResults = results; 121 | testResults = JSON.parse(executableResults.stdOut); 122 | ctx.done(); 123 | }); 124 | }); 125 | 126 | Steps.Then(/^the "([^"]*?)" should be (\d+)$/, function (ctx, attr, value) { 127 | testMap[attr]().should.eql(parseInt(value)); 128 | ctx.done(); 129 | }); 130 | 131 | Steps.Then(/^the "([^"]*?)" should be (greater than|less than|equal to) (\d+)$/, function (ctx, attr, op, value) { 132 | var fn = opMap[op](); 133 | var subject = testMap[attr]().should; 134 | fn.call(subject, parseInt(value)); 135 | ctx.done(); 136 | }); 137 | 138 | Steps.Then(/^there should be no executable errors$/, function (ctx) { 139 | executableResults.returnCode.should.eql(0); 140 | executableResults.stdErr.should.eql(''); 141 | ctx.done(); 142 | }); 143 | 144 | Steps.When(/^I select the Feature "([^"]*?)"$/, function (ctx, name) { 145 | var feature = testResults.features 146 | .filter(function(feature) { 147 | return feature.name == name; 148 | }); 149 | 150 | feature.length.should.eql(1); 151 | 152 | currentFeature = feature[0]; 153 | 154 | ctx.done(); 155 | }); 156 | 157 | Steps.Then(/^the feature should have (\d+) (.*)$/, function (ctx, count, attr) { 158 | featureMap[attr]().length.should.eql(parseInt(count)); 159 | 160 | ctx.done(); 161 | }); 162 | 163 | Steps.Then(/^the feature should have (.*)$/, function (ctx, attr) { 164 | featureMap[attr]().should.be.ok; 165 | 166 | ctx.done(); 167 | }); 168 | 169 | Steps.Then(/^the feature's "([^"]*?)" should be "([^"]*?)"$/, function (ctx, attr, value) { 170 | featureMap[attr]().should.eql(_(value).isString() ? value.replace(/\\n/g, '\n') : value); 171 | ctx.done(); 172 | }); 173 | 174 | Steps.When(/^I select the Scenario "([^"]*?)"$/, function (ctx, name) { 175 | var scenario = currentFeature.scenarios 176 | .filter(function(scenario) { 177 | return scenario.name == name; 178 | }); 179 | 180 | scenario.length.should.eql(1); 181 | 182 | currentScenario = scenario[0]; 183 | 184 | ctx.done(); 185 | }); 186 | 187 | Steps.Then(/^the scenario should have (\d+) (.*)$/, function (ctx, count, attr) { 188 | scenarioMap[attr]().length.should.eql(parseInt(count)); 189 | 190 | ctx.done(); 191 | }); 192 | 193 | Steps.When(/^I select the Step "([^"]*?)"$/, function (ctx, name) { 194 | var step = currentScenario.steps 195 | .filter(function(step) { 196 | return step.line == name; 197 | }); 198 | 199 | step.length.should.eql(1); 200 | 201 | currentStep = step[0]; 202 | 203 | ctx.done(); 204 | }); 205 | 206 | 207 | Steps.Then(/^the step's "([^"]*?)" should be "([^"]*?)"$/, function (ctx, attr, value) { 208 | stepMap[attr]().should.eql(value); 209 | ctx.done(); 210 | }); 211 | 212 | Steps.export(module); 213 | -------------------------------------------------------------------------------- /lib/cucumis.js: -------------------------------------------------------------------------------- 1 | module.exports = require('../deps/kyuri/lib/kyuri'); 2 | 3 | var events = require('events'), 4 | util = require('util'); 5 | 6 | function Runner() { 7 | events.EventEmitter.call(this); 8 | } 9 | 10 | util.inherits(Runner, events.EventEmitter); 11 | 12 | module.exports.Steps.Runner = new Runner(); 13 | -------------------------------------------------------------------------------- /lib/formatters/json.formatter.js: -------------------------------------------------------------------------------- 1 | // Format printing object 2 | var _ = require('underscore'); 3 | 4 | module.exports.Formatter = function() { 5 | this.undefinedSteps = {}; 6 | 7 | this.scenarioCount = 0; 8 | 9 | this.stepCount = 0; 10 | 11 | this.undefinedStepCount = 0; 12 | this.undefinedScenarioCount = 0; 13 | 14 | this.passedStepCount = 0; 15 | this.passedScenarioCount = 0; 16 | 17 | this.pendingStepCount = 0; 18 | this.pendingScenarioCount = 0; 19 | 20 | this.skippedStepCount = 0; 21 | 22 | this.failedStepCount = 0; 23 | this.failedScenarioCount = 0; 24 | this.startTime = Date.now(); 25 | 26 | this.results = { 27 | allErrors: [], 28 | features: [], 29 | stats: { 30 | undefinedSteps: [], 31 | scenarioCount: 0, 32 | stepCount: 0, 33 | undefinedStepCount: 0, 34 | undefinedScenarioCount: 0, 35 | passedStepCount: 0, 36 | passedScenarioCount: 0, 37 | pendingStepCount: 0, 38 | pendingScenarioCount: 0, 39 | failedStepCount: 0, 40 | failedScenarioCount: 0, 41 | elapsedTime: 0, 42 | }, 43 | }; 44 | } 45 | 46 | module.exports.Formatter.prototype = { 47 | 48 | lastFeature: function() { 49 | return this.results.features[this.results.features.length-1]; 50 | }, 51 | 52 | lastScenario: function() { 53 | var feature = this.lastFeature(); 54 | return feature.scenarios[feature.scenarios.length-1]; 55 | }, 56 | 57 | background: function() { 58 | var feature = this.lastFeature(); 59 | return feature.background; 60 | }, 61 | 62 | lastStep: function() { 63 | var scenario = this.lastScenario(); 64 | return scenario.steps[scenario.steps.length-1]; 65 | }, 66 | 67 | generalUncaughtException: function(err) { 68 | this.results.allErrors.push(err); 69 | }, 70 | 71 | asyncStepTimeoutError: function(eventName, level, err) { 72 | if (err) { 73 | this.results.allErrors.push(err); 74 | } 75 | 76 | var step = this.lastStep(); 77 | if (err) { 78 | step.err = err; 79 | } else { 80 | step.err = new Error('Timeout waiting for response on event: ' + eventName); 81 | } 82 | }, 83 | 84 | beforeFeature: function(feature) { 85 | this.results.features.push({name: feature.name, description: feature.description, background: null, scenarios: []}); 86 | }, 87 | 88 | afterFeature: function(feature) { 89 | }, 90 | 91 | beforeScenarioOutline: function(scenarioOutline) { 92 | }, 93 | 94 | afterScenarioOutline: function(scenarioOutline) { 95 | }, 96 | 97 | beforeScenario: function(scenario) { 98 | var feature = this.lastFeature(); 99 | feature.scenarios.push({name: scenario.name, outline: scenario.outline, steps: []}); 100 | }, 101 | 102 | afterScenario: function(scenario) { 103 | }, 104 | 105 | beforeBackground: function(scenario) { 106 | var feature = this.lastFeature(); 107 | feature.background = {steps: []}; 108 | }, 109 | 110 | afterBackground: function(scenario) { 111 | }, 112 | 113 | beforeStep: function(step) { 114 | }, 115 | 116 | afterStep: function(step) { 117 | }, 118 | 119 | afterSteps: function(scenario) { 120 | }, 121 | 122 | afterStepResult: function(scenario, stepLine, result, msg, err) { 123 | if (err) { 124 | this.results.allErrors.push(err); 125 | } 126 | 127 | var _scenario; 128 | if (!scenario.background) { 129 | _scenario = this.lastScenario(); 130 | } 131 | 132 | if (scenario.background && !scenario.backgroundPrinted) { 133 | _scenario = this.background(); 134 | } 135 | 136 | if (_scenario) { 137 | _scenario.steps.push({ 138 | line: stepLine, 139 | result: result, 140 | err: err, 141 | msg: msg, 142 | }); 143 | } 144 | }, 145 | 146 | afterTest: function() { 147 | for (var undefinedStep in this.undefinedSteps) { 148 | this.results.stats.undefinedSteps.push(undefinedStep); 149 | } 150 | this.results.stats.scenarioCount = this.scenarioCount; 151 | 152 | this.results.stats.stepCount = this.stepCount; 153 | 154 | this.results.stats.undefinedStepCount = this.undefinedStepCount; 155 | this.results.stats.undefinedScenarioCount = this.undefinedScenarioCount; 156 | 157 | this.results.stats.passedStepCount = this.passedStepCount; 158 | this.results.stats.passedScenarioCount = this.passedScenarioCount; 159 | 160 | this.results.stats.pendingStepCount = this.pendingStepCount; 161 | this.results.stats.pendingScenarioCount = this.pendingScenarioCount; 162 | 163 | this.results.stats.skippedStepCount = this.skippedStepCount; 164 | 165 | this.results.stats.failedStepCount = this.failedStepCount; 166 | this.results.stats.failedScenarioCount = this.failedScenarioCount; 167 | 168 | this.results.stats.elapsedTime = (Date.now() - this.startTime)/1000; 169 | 170 | console.log(JSON.stringify(this.results, null, ' ')); 171 | }, 172 | }; 173 | -------------------------------------------------------------------------------- /lib/formatters/pretty.formatter.js: -------------------------------------------------------------------------------- 1 | // Format printing object 2 | var colorize = require('../support/colorize').colorize, 3 | indent = require('../support/indent'), 4 | _ = require('underscore'); 5 | 6 | function strJoin() { 7 | return _.compact(arguments).join(', ');; 8 | } 9 | 10 | module.exports.Formatter = function() { 11 | this.undefinedSteps = {}; 12 | 13 | this.scenarioCount = 0; 14 | 15 | this.stepCount = 0; 16 | 17 | this.undefinedStepCount = 0; 18 | this.undefinedScenarioCount = 0; 19 | 20 | this.passedStepCount = 0; 21 | this.passedScenarioCount = 0; 22 | 23 | this.pendingStepCount = 0; 24 | this.pendingScenarioCount = 0; 25 | 26 | this.skippedStepCount = 0; 27 | 28 | this.failedStepCount = 0; 29 | this.failedScenarioCount = 0; 30 | this.startTime = Date.now(); 31 | } 32 | 33 | module.exports.Formatter.prototype = { 34 | 35 | generalUncaughtException: function(err) { 36 | var errors = []; 37 | errors.push(err.name ? 'name: ' + err.name : ''); 38 | errors.push(err.message ? 'message: ' + err.message : ''); 39 | errors.push(err.stack ? indent(err.stack, 1) : ''); 40 | 41 | console.log(indent(colorize('red', 'Error caught:'))); 42 | console.log(indent(colorize('red', errors.join('\n')), 2)); 43 | }, 44 | 45 | asyncStepTimeoutError: function(eventName, level, err) { 46 | if (err) { 47 | var errors = []; 48 | errors.push(err.name ? 'name: ' + err.name : ''); 49 | errors.push(err.message ? 'message: ' + err.message : ''); 50 | errors.push(err.stack ? indent(err.stack, 1) : ''); 51 | 52 | console.log(indent(colorize('red', 'Error while processing event: ' + eventName), level)); 53 | console.log(indent(colorize('red', errors.join('\n')), level + 1)); 54 | } else { 55 | console.log(indent(colorize('red', 'Timeout waiting for response on event: ' + eventName + '\n'), level)); 56 | } 57 | }, 58 | 59 | beforeFeature: function(feature) { 60 | console.log('Feature: ' + feature.name); 61 | console.log(indent(feature.description, 1)); 62 | }, 63 | 64 | afterFeature: function(feature) { 65 | }, 66 | 67 | beforeScenarioOutline: function(scenarioOutline) { 68 | console.log(indent('Scenario Outline: ' + scenarioOutline.name, 1)); 69 | }, 70 | 71 | afterScenarioOutline: function(scenarioOutline) { 72 | }, 73 | 74 | beforeScenario: function(scenario) { 75 | if (!scenario.outline) { 76 | console.log(indent('Scenario: ' + scenario.name, 1)); 77 | } 78 | }, 79 | 80 | afterScenario: function(scenario) { 81 | }, 82 | 83 | beforeBackground: function(scenario) { 84 | if (!scenario.backgroundPrinted) { 85 | console.log(indent('Background:', 1)); 86 | } 87 | }, 88 | 89 | afterBackground: function(scenario) { 90 | }, 91 | 92 | beforeStep: function(step) { 93 | }, 94 | 95 | afterStep: function(step) { 96 | }, 97 | 98 | afterSteps: function(scenario) { 99 | if (!scenario.background || (scenario.background && !scenario.backgroundPrinted)) { 100 | console.log(''); 101 | } 102 | }, 103 | 104 | afterStepResult: function(scenario, stepLine, result, msg, err) { 105 | var colorMap = { 106 | 'pass': 'green', 107 | 'fail': 'red', 108 | 'pending': 'yellow', 109 | 'skipped': 'cyan', 110 | 'undefined': 'yellow', 111 | }; 112 | 113 | if (!scenario.background || (scenario.background && !scenario.backgroundPrinted)) { 114 | console.log(indent(colorize(colorMap[result], stepLine), 2)); 115 | } 116 | 117 | if (msg) { 118 | console.log(indent(colorize(colorMap[result], msg), 3)); 119 | } 120 | 121 | if (err) { 122 | var errors = []; 123 | errors.push(err.name ? 'name: ' + err.name : ''); 124 | errors.push(err.message ? 'message: ' + err.message : ''); 125 | errors.push(err.stack ? indent(err.stack, 2) : ''); 126 | console.log(indent(colorize(colorMap[result], errors.join('\n')), 3)); 127 | } 128 | }, 129 | 130 | afterTest: function() { 131 | var undefinedScenariosStr = this.undefinedScenarioCount ? colorize('[yellow]{' + this.undefinedScenarioCount + ' undefined}') : ''; 132 | var undefinedStepsStr = this.undefinedStepCount ? colorize('[yellow]{' + this.undefinedStepCount + ' undefined}') : ''; 133 | 134 | var passedScenariosStr = this.passedScenarioCount ? colorize('[green]{' + this.passedScenarioCount + ' passed}') : ''; 135 | var passedStepsStr = this.passedStepCount ? colorize('[green]{' + this.passedStepCount + ' passed}') : ''; 136 | 137 | var pendingScenariosStr = this.pendingScenarioCount ? colorize('[yellow]{' + this.pendingScenarioCount + ' pending}') : ''; 138 | var pendingStepsStr = this.pendingStepCount ? colorize('[yellow]{' + this.pendingStepCount + ' pending}') : ''; 139 | 140 | var skippedStepsStr = this.skippedStepCount ? colorize('[cyan]{' + this.skippedStepCount + ' skipped}') : ''; 141 | 142 | var failedScenariosStr = this.failedScenarioCount ? colorize('[red]{' + this.failedScenarioCount + ' failed}') : ''; 143 | var failedStepsStr = this.failedStepCount ? colorize('[red]{' + this.failedStepCount + ' failed}') : ''; 144 | 145 | console.log(this.scenarioCount + ' scenarios (' + strJoin(passedScenariosStr, failedScenariosStr, undefinedScenariosStr, pendingScenariosStr) + ')'); 146 | console.log(this.stepCount + ' steps (' + strJoin(passedStepsStr, failedStepsStr, skippedStepsStr, undefinedStepsStr, pendingStepsStr) + ')'); 147 | 148 | var timeElapsed = (Date.now() - this.startTime)/1000; 149 | 150 | var minutes = Math.floor(timeElapsed / 60); 151 | var seconds = timeElapsed - minutes*60; 152 | 153 | console.log(minutes + 'm' + seconds.toFixed(3) + 's'); 154 | console.log(); 155 | 156 | if (_.keys(this.undefinedSteps).length) { 157 | console.log(colorize('[yellow]{You can implement step definitions for undefined steps with these snippets:\n}')); 158 | console.log(colorize('yellow', 'var Steps = require(\'cucumis\').Steps;\n')); 159 | 160 | for (var undefinedStep in this.undefinedSteps) { 161 | console.log(colorize('yellow', undefinedStep)); 162 | } 163 | 164 | console.log(colorize('yellow', 'Steps.export(module);\n')); 165 | } 166 | }, 167 | }; 168 | -------------------------------------------------------------------------------- /lib/support/colorize.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Colorize the given string using ansi-escape sequences. 3 | * Disabled when --boring is set. 4 | * 5 | * @param {String} str 6 | * @return {String} 7 | */ 8 | 9 | module.exports.boring = false; 10 | 11 | function colorize(color, str){ 12 | var colors = { bold: 1, red: 31, green: 32, yellow: 33, blue: 34, magenta: 35, cyan: 36 }; 13 | if (arguments.length == 1) { 14 | str = color; 15 | return str.replace(/\[(\w+)\]\{([^]*?)\}/g, function(_, color, str){ 16 | return module.exports.boring 17 | ? str 18 | : '\x1B[' + colors[color] + 'm' + str + '\x1B[0m'; 19 | }); 20 | } else { 21 | return module.exports.boring 22 | ? str 23 | : '\x1B[' + colors[color] + 'm' + str + '\x1B[0m'; 24 | } 25 | } 26 | 27 | module.exports.colorize = colorize; 28 | -------------------------------------------------------------------------------- /lib/support/indent.js: -------------------------------------------------------------------------------- 1 | var _ = require('underscore'); 2 | 3 | function indent (text, level) { 4 | level = level || 0; 5 | 6 | var lines = text.split('\n'); 7 | 8 | var indents = ''; 9 | _.range(level).forEach(function() { 10 | indents += ' '; 11 | }); 12 | 13 | for (var i = 0; i < lines.length; i++) { 14 | lines[i] = indents + lines[i]; 15 | } 16 | 17 | return lines.join('\n'); 18 | } 19 | 20 | module.exports = indent; 21 | -------------------------------------------------------------------------------- /lib/templates/stepdef.js.tpl: -------------------------------------------------------------------------------- 1 | Steps.{{type}}(/^{{title}}$/, function (ctx{{args}}) { 2 | ctx.pending(); 3 | }); 4 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "cucumis", 3 | "version": "v1.0.17", 4 | "description": "BDD Cucumber Style Asynchronous Testing Framework for node.js", 5 | "homepage": "https://github.com/noblesamurai/cucumis", 6 | "keywords": ["testing", "bdd", "cucumber", "gherkin", "tests"], 7 | "author": "Eugene Ware ", 8 | "maintainers": ["Eugene Ware "], 9 | "licenses": ["MIT"], 10 | "dependencies": {"should": ">=0.2.1", "underscore": ">=1.1.4", "glob": ">=1.1.0", "vows": ">=0.5.8"}, 11 | "main": "./lib/cucumis", 12 | "bin": "./bin/cucumis", 13 | "repository": { "type": "git", "url": "http://github.com/noblesamurai/cucumis.git" } 14 | } 15 | -------------------------------------------------------------------------------- /test/fixtures/test.js.tpl: -------------------------------------------------------------------------------- 1 | Hello {{name}}, 2 | 3 | This is a cool template 4 | -------------------------------------------------------------------------------- /test/template.test.js: -------------------------------------------------------------------------------- 1 | _ = require('underscore'); 2 | var fs = require('fs'), 3 | path = require('path'); 4 | 5 | _.templateSettings = { 6 | interpolate : /\{\{(.+?)\}\}/g 7 | }; 8 | 9 | module.exports = require('expressobdd')({ 10 | 'templating': { 11 | 'it should be able to use underscore': function() { 12 | _.should.not.equal(undefined); 13 | }, 14 | 'it should be able to use a simple template': function() { 15 | var out = _.template('Hello {{name}}', {name: 'Fred'}); 16 | out.should.eql('Hello Fred'); 17 | }, 18 | 'it should be able to read a template from a file': function() { 19 | fs.readFile(path.join(__dirname, 'fixtures/test.js.tpl'), function(err, data) { 20 | if (err) throw err; 21 | 22 | var out = _.template(data.toString(), {name: 'Fred'}); 23 | out.should.eql('Hello Fred,\n\nThis is a cool template\n'); 24 | }); 25 | }, 26 | 'it shoud be able to compile a template': function() { 27 | var tpl = _.template('Hello {{name}}'); 28 | var out = tpl({name: 'Fred'}); 29 | out.should.eql('Hello Fred'); 30 | }, 31 | }, 32 | }); 33 | --------------------------------------------------------------------------------