├── index.js ├── .gitignore ├── .npmignore ├── gulpfile.js ├── .jshintrc ├── .jscs.json ├── lib └── mochawait.js ├── package.json ├── README.md ├── test └── mochawait-specs.js └── LICENSE /index.js: -------------------------------------------------------------------------------- 1 | import './lib/mochawait'; 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | build 3 | *.log 4 | -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | *.log 3 | _vimrc_local.vim 4 | *.un~ 5 | *.swp 6 | -------------------------------------------------------------------------------- /gulpfile.js: -------------------------------------------------------------------------------- 1 | "use strict"; 2 | 3 | var gulp = require('gulp') 4 | , boilerplate = require('appium-gulp-plugins').boilerplate.use(gulp); 5 | 6 | boilerplate({build: "Mochawait", jscs: false}); 7 | -------------------------------------------------------------------------------- /.jshintrc: -------------------------------------------------------------------------------- 1 | { 2 | "laxcomma": true, 3 | "undef": true, 4 | "unused": true, 5 | "node": true, 6 | "eqeqeq": true, 7 | "trailing": true, 8 | "indent": 2, 9 | "esnext": true, 10 | "experimental": ["asyncawait"] 11 | } 12 | -------------------------------------------------------------------------------- /.jscs.json: -------------------------------------------------------------------------------- 1 | { 2 | "excludeFiles": ["submodules/**", "node_modules/**", 3 | "./lib/server/static/**", "./lib/devices/firefoxos/atoms/*.js", 4 | "./test/harmony/**/*.js", "./sample-code/**", 5 | "./sample-code/apps/**", "./sample-code/examples/php/vendor/**"], 6 | "requireCurlyBraces": ["for", "while", "do", "try", "catch"], 7 | "requireSpaceAfterKeywords": ["if", "else", "for", "while", "do", "switch", 8 | "return", "try", "catch", "function"], 9 | "disallowMixedSpacesAndTabs": true, 10 | "disallowTrailingWhitespace": true, 11 | "requireSpacesInFunctionExpression": { 12 | "beforeOpeningCurlyBrace": true 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /lib/mochawait.js: -------------------------------------------------------------------------------- 1 | let mochawait = {} 2 | , mochaIt = GLOBAL.it 3 | , mochaBefore = GLOBAL.before 4 | , mochaBeforeEach = GLOBAL.beforeEach 5 | , mochaAfter = GLOBAL.after 6 | , mochaAfterEach = GLOBAL.afterEach; 7 | 8 | mochawait.it = (desc, asyncFn) => { 9 | mochaIt(desc, async function (done) { 10 | try { 11 | await asyncFn.call(this); 12 | done(); 13 | } catch (e) { 14 | done(e); 15 | } 16 | }); 17 | }; 18 | 19 | let mochaHooks = new Map(); 20 | mochaHooks.set('before', mochaBefore); 21 | mochaHooks.set('after', mochaAfter); 22 | mochaHooks.set('beforeEach', mochaBeforeEach); 23 | mochaHooks.set('afterEach', mochaAfterEach); 24 | 25 | for (let [name, hook] of mochaHooks) { 26 | GLOBAL[name] = (asyncFn) => { 27 | hook(async function (done) { 28 | try { 29 | await asyncFn.call(this); 30 | done(); 31 | } catch (e) { 32 | done(e); 33 | } 34 | }); 35 | }; 36 | } 37 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "mochawait", 3 | "description": "Mocha with ES7 await/async", 4 | "tags": [ 5 | "mocha", 6 | "testing", 7 | "es7", 8 | "async" 9 | ], 10 | "version": "2.1.0", 11 | "author": "jlipps@gmail.com", 12 | "licenses": [ 13 | { 14 | "type": "apache-2.0", 15 | "url": "https://raw.github.com/jlipps/mochawait/master/LICENSE" 16 | } 17 | ], 18 | "repository": { 19 | "type": "git", 20 | "url": "https://github.com/jlipps/mochawait.git" 21 | }, 22 | "bugs": { 23 | "url": "https://github.com/jlipps/mochawait/issues" 24 | }, 25 | "engines": [ 26 | "node" 27 | ], 28 | "main": "./build/index.js", 29 | "bin": {}, 30 | "directories": { 31 | "lib": "./lib" 32 | }, 33 | "dependencies": { 34 | "appium-gulp-plugins": "^1.0.3", 35 | "babel-runtime": "5.5.5", 36 | "lodash": "^3.6.0", 37 | "mocha": "^2.2.4", 38 | "source-map-support": "^0.3.1" 39 | }, 40 | "scripts": { 41 | "test": "$(npm bin)/gulp once", 42 | "prepublish": "$(npm bin)/gulp prepublish", 43 | "watch": "$(npm bin)/gulp" 44 | }, 45 | "devDependencies": { 46 | "gulp": "^3.8.11", 47 | "should": "^6.0.3" 48 | } 49 | } 50 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | MochAwait 2 | ========= 3 | 4 | # DEPRECATED 5 | 6 | Mocha supports this functionality natively now, so there's no need to use this package 7 | 8 | # Old README 9 | 10 | A [Mocha](https://github.com/visionmedia/mocha) wrapper that provides an 11 | interface for ES7 async/await. Now you can do async test blocks without 12 | having to worry about passing "done" everywhere! 13 | 14 | Install: 15 | 16 | ``` 17 | npm install mochawait 18 | ``` 19 | 20 | Then: 21 | 22 | ```js 23 | import 'mochawait'; 24 | import 'should'; 25 | 26 | describe('My sweet project', () => { 27 | before(async () => { 28 | await doSomeTestSetup(); 29 | }); 30 | 31 | it('should work as expected', async () => { 32 | let res = await myAsyncMethod(); 33 | res.should.equal('foo'); 34 | }); 35 | }); 36 | ``` 37 | 38 | (Where in the example above, `doSomeTestSetup` and `myAsyncMethod` are [ES7 39 | async function](http://jakearchibald.com/2014/es7-async-functions/) or 40 | promises) 41 | 42 | Running tests written this way is easy: simply transpile your ES6/7 code 43 | using [Traceur](https://github.com/google/traceur-compiler), make sure to 44 | include the Traceur runtime (`require('traceur/bin/traceur-runtime')`), and 45 | run with `mocha` as per usual: 46 | 47 | ``` 48 | mocha my-specs.js 49 | ``` 50 | 51 | ## Run tests for this project: 52 | 53 | ``` 54 | npm test 55 | ``` 56 | -------------------------------------------------------------------------------- /test/mochawait-specs.js: -------------------------------------------------------------------------------- 1 | /* global describe:true, before:true, beforeEach:true, afterEach:true, it:true, after:true */ 2 | // transpile:mocha 3 | 4 | import '../index'; 5 | import 'should'; 6 | import {Context} from 'mocha'; 7 | 8 | async function sleep (ms) { 9 | let start = Date.now(); 10 | var p = new Promise((resolve) => { 11 | setTimeout(function () { 12 | let end = Date.now(); 13 | if ((end - start) < ms) { 14 | setTimeout(function () { 15 | resolve(); 16 | }, end - start); 17 | } else { 18 | resolve(); 19 | } 20 | }, ms); 21 | }); 22 | await p; 23 | } 24 | 25 | async function slowDouble (x) { 26 | await sleep(10); 27 | return x * 2; 28 | } 29 | 30 | async function slowConcat (str, extra) { 31 | await sleep(20); 32 | return str + extra; 33 | } 34 | 35 | describe('mochawait tests', function () { 36 | let myInt = 2 37 | , myStr = '' 38 | , testsRun = 0; 39 | 40 | before(async function () { 41 | this.should.be.instanceOf(Context); 42 | this.should.have.a.property('timeout'); 43 | let start = Date.now(); 44 | myStr.should.equal(''); 45 | myStr = await slowConcat(myStr, 'foo'); 46 | (Date.now() - start).should.be.above(19); 47 | }); 48 | 49 | beforeEach(async function () { 50 | this.should.be.instanceOf(Context); 51 | this.should.have.a.property('timeout'); 52 | let start = Date.now(); 53 | myInt = await slowDouble(myInt); 54 | (Date.now() - start).should.be.above(9); 55 | }); 56 | 57 | after(async function () { 58 | this.should.be.instanceOf(Context); 59 | this.should.have.a.property('timeout'); 60 | let start = Date.now(); 61 | myInt = await slowDouble(myInt); 62 | (Date.now() - start).should.be.above(9); 63 | myInt.should.equal(32); 64 | }); 65 | 66 | afterEach(async function () { 67 | this.should.be.instanceOf(Context); 68 | this.should.have.a.property('timeout'); 69 | let start = Date.now(); 70 | for (let i = 0; i < 5; i++) { 71 | await sleep(10); 72 | } 73 | if (testsRun === 1) { 74 | myStr.should.equal('foobar'); 75 | } else { 76 | myStr.should.equal('foobarbaz'); 77 | } 78 | (Date.now() - start).should.be.above(49); 79 | }); 80 | 81 | it('should work like mocha', async function () { 82 | this.should.be.instanceOf(Context); 83 | this.should.have.a.property('timeout'); 84 | myStr.should.equal('foo'); 85 | myInt.should.equal(4); 86 | let start = Date.now(); 87 | myInt = await slowDouble(myInt); 88 | let then = Date.now(); 89 | (then - start).should.be.above(9); 90 | myStr = await slowConcat(myStr, 'bar'); 91 | (Date.now() - start).should.be.above(19); 92 | testsRun++; 93 | }); 94 | 95 | it('should work like mocha some more', async function () { 96 | this.should.be.instanceOf(Context); 97 | this.should.have.a.property('timeout'); 98 | myStr.should.equal('foobar'); 99 | myInt.should.equal(16); 100 | let start = Date.now(); 101 | myStr = await slowConcat(myStr, 'baz'); 102 | (Date.now() - start).should.be.above(19); 103 | testsRun++; 104 | }); 105 | }); 106 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | --------------------------------------------------------------------------------