├── .gitignore ├── .travis.yml ├── LICENSE ├── README.md ├── index.js ├── mockContext.js ├── mockEvent.js ├── package.json └── test ├── mockContext.test.js └── mockEvent.test.js /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | 6 | # Runtime data 7 | pids 8 | *.pid 9 | *.seed 10 | 11 | # Directory for instrumented libs generated by jscoverage/JSCover 12 | lib-cov 13 | 14 | # Coverage directory used by tools like istanbul 15 | coverage 16 | 17 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 18 | .grunt 19 | 20 | # node-waf configuration 21 | .lock-wscript 22 | 23 | # Compiled binary addons (http://nodejs.org/api/addons.html) 24 | build/Release 25 | 26 | # Dependency directory 27 | node_modules 28 | 29 | # Optional npm cache directory 30 | .npm 31 | 32 | # Optional REPL history 33 | .node_repl_history 34 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: node_js 2 | node_js: 3 | - 0.10.36 # http://docs.aws.amazon.com/lambda/latest/dg/current-supported-versions.html 4 | - 4.2.6 5 | before_install: 6 | - pip install --user codecov 7 | after_success: 8 | - codecov --file coverage/lcov.info --disable search 9 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | {description} 294 | Copyright (C) {year} {fullname} 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | {signature of Ty Coon}, 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # aws-lambda-test-utils 2 | 3 | Testing your AWS Lambda Functions does not need to be difficult or complex. 4 | 5 | [![Build Status](https://travis-ci.org/dwyl/aws-lambda-test-utils.svg?branch=master)](https://travis-ci.org/dwyl/aws-lambda-test-utils) 6 | [![codecov.io](https://codecov.io/github/dwyl/aws-lambda-test-utils/coverage.svg?branch=master)](https://codecov.io/github/dwyl/aws-lambda-test-utils?branch=master) 7 | [![Dependency Status](https://david-dm.org/dwyl/aws-lambda-test-utils.svg)](https://david-dm.org/dwyl/aws-lambda-test-utils) 8 | [![devDependency Status](https://david-dm.org/dwyl/aws-lambda-test-utils/dev-status.svg)](https://david-dm.org/dwyl/aws-lambda-test-utils#info=devDependencies) 9 | 10 | [![NPM](https://nodei.co/npm-dl/aws-lambda-test-utils.png?months=3)](https://nodei.co/npm/aws-lambda-test-utils/) 11 | 12 | If you are *new* to Amazon WebServices Lambda 13 | (*or need a refresher*), 14 | please checkout our our 15 | ***Beginners Guide to AWS Lambda***: 16 | https://github.com/dwyl/learn-aws-lambda 17 | 18 | ## Why? 19 | 20 | Testing your code is *essential* everywhere you need *reliability*. 21 | 22 | AWS Lambda has a **Testing _Console_** which is a *web-based* 23 | way of invoking your function(s) with a given input and 24 | monitoring the result. But this quite slow and *cannot be automated* (*yet*). 25 | 26 | ## What? 27 | 28 | The simplest *possilbe* way we could think of for Testing 29 | our AWS Lambda functions. 30 | 31 | ## *How*? (*Usage*) 32 | 33 | ### *install* `aws-lambda-test-utils` from NPM 34 | 35 | ```sh 36 | npm install aws-lambda-test-utils --save-dev 37 | ``` 38 | 39 | ### Use in your Tests 40 | 41 | ### Mock Context 42 | 43 | An example of using the `mockContextCreator` in an example test. 44 | 45 | ```js 46 | 'use strict'; 47 | var test = require('tape'); 48 | var utils = require('aws-lambda-test-utils') 49 | var mockContextCreator = utils.mockContextCreator; 50 | var index = require('./index.js'); // lambda function 51 | 52 | var ctxOpts = { 53 | functionName: 'LambdaTest', 54 | functionVersion: '1', 55 | invokedFunctionArn: 'arn:aws:lambda:eu-west-1:655240711487:function:LambdaTest:ci' 56 | }; 57 | var testEvent = { key1: 'value1' }; 58 | 59 | test('LambdaTest', function(t){ 60 | t.test("LambdaTest: returns value when given event with key1 property", function(st) { 61 | function test(result){ 62 | st.equals(result, "value1") 63 | st.end(); 64 | }; 65 | var context = mockContextCreator({}, test); // no options and test as the callback 66 | index.handler(testEvent, context); 67 | }); 68 | t.test("LambdaTest: returns value when given event with key1 property", function(st) { 69 | function test(result){ 70 | st.equals(result, "value1") 71 | st.end(); 72 | }; 73 | var context = mockContextCreator(ctxOpts, test); // context options specified and test as the callback 74 | index.handler(testEvent, context); 75 | }); 76 | t.end(); 77 | }); 78 | ``` 79 | 80 | ### Mock Events 81 | This helper can be used to mock event objects created by AWS services like S3, SNS, or DynamoDB. 82 | 83 | ```js 84 | var utils = require('aws-lambda-test-utils'); 85 | 86 | // has 3 methods on it: createDynamoDBEvent, createSNSEvent, createS3Event 87 | var mockEventCreator = utils.mockEventCreator; 88 | ``` 89 | 90 | 91 | 92 | #### `createDynamoDBEvent(options)` 93 | 94 | Creates a mock DynamoDB event. 95 | ```js 96 | var utils = require('aws-lambda-test-utils'); 97 | var dynamoEvent = utils.mockEventCreator.createDynamoDBEvent(); 98 | 99 | // Default options (which can be overridden): 100 | { 101 | awsRegion: "eu-west-1", 102 | eventSourceARN: "arn:aws:dynamodb:us-west-2:account-id:table/ExampleTableWithStream/stream/2015-06-27T00:48:05.899", 103 | events: [{type: "INSERT", number: 1}] 104 | }; 105 | 106 | ``` 107 | 108 | #### `createSNSEvent(options)` 109 | 110 | ```js 111 | var utils = require('aws-lambda-test-utils'); 112 | var dynamoEvent = utils.mockEventCreator.createSNSEvent(); 113 | 114 | // Default options (which can be overridden): 115 | { 116 | message: "default test message" 117 | }; 118 | 119 | ``` 120 | 121 | #### `createS3Event()` 122 | 123 | ```js 124 | var utils = require('aws-lambda-test-utils'); 125 | var dynamoEvent = utils.mockEventCreator.createS3Event(); 126 | 127 | ``` 128 | #### `createAPIGatewayEvent(options)` 129 | 130 | ```js 131 | var utils = require('aws-lambda-test-utils'); 132 | var APIGatewayEvent = utils.mockEventCreator.createAPIGatewayEvent(); 133 | 134 | // Default options (which can be overridden): 135 | { 136 | path: "default/path", 137 | method: "GET", 138 | headers: { 139 | "default-header": 'default' 140 | }, 141 | queryStringParameters: { 142 | query: "default" 143 | }, 144 | pathParameters: { 145 | uuid: '1234' 146 | }, 147 | stageVariables: { 148 | ENV: "test" 149 | }, 150 | body: "default body" 151 | } 152 | 153 | ``` 154 | 155 | 156 | ## Documentation 157 | 158 | ### Lambda Function `event` & `context` 159 | 160 | Every AWS Lambda function take two parameters `event` & `context` 161 | 162 | ### `context` 163 | 164 | The 'context' object has the following form: 165 | 166 | ```js 167 | { 168 | //methods 169 | success, 170 | done, 171 | fail, 172 | getRemainingTimeInMillis, 173 | 174 | //properties 175 | functionName, 176 | functionVersion, 177 | invokedFunctionArn, 178 | memoryLimitInMB, 179 | awsRequestId, 180 | logGroupName, 181 | logStreamName, 182 | identity: { 183 | cognito_identity_id, 184 | cognito_identity_pool_id 185 | }, 186 | clientContext: { 187 | client: { 188 | installation_id, 189 | app_title, 190 | app_version_name, 191 | app_version_code, 192 | app_package_name, 193 | Custom, 194 | }, 195 | env: { 196 | platform_version 197 | platform, 198 | make, 199 | model, 200 | locale, 201 | } 202 | } 203 | } 204 | ``` 205 | 206 | The properties of the context object can be specified in an options parameter to the `mockContextCreator` function. 207 | 208 | ## Background Reading 209 | 210 | + 211 | 212 | ## TODO 213 | 214 | * Add stubs for AWS SDK methods 215 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | /** 3 | * Helper functions for creating context and event objects 4 | * 5 | */ 6 | 7 | var mockContextCreator = require('./mockContext.js'); 8 | var mockEventCreator = require('./mockEvent') 9 | 10 | module.exports = { 11 | mockContextCreator: mockContextCreator, 12 | mockEventCreator: mockEventCreator 13 | }; 14 | -------------------------------------------------------------------------------- /mockContext.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | /** 3 | * Function that returns a mock context object for testing AWS Lambda functions 4 | * 5 | * @param {object} - options: object with context properties 6 | * @param {function} - callback function to be called with the value passed into any of the context methods. 7 | * - the callback should contain the test assertions. 8 | * 9 | **/ 10 | 11 | module.exports = function (options, cb) { 12 | return { 13 | succeed: function (result) { 14 | if (result === undefined) { 15 | return cb(null); 16 | } else { 17 | if (typeof result !== 'string'){ 18 | return cb(JSON.stringify(result)); 19 | } else { 20 | return cb(result); 21 | } 22 | } 23 | }, 24 | fail: function (error) { 25 | if (error === undefined) { 26 | return cb(null); 27 | } else { 28 | return cb(error); 29 | } 30 | }, 31 | done: function (err, result) { 32 | if (err) { 33 | return this.fail(err); 34 | } else { 35 | return this.succeed(result); 36 | } 37 | }, 38 | getRemainingTimeInMillis: function() { 39 | if (typeof this.timeInMillis !== 'number') { 40 | return 0; 41 | } else { 42 | return this.timeInMillis; 43 | } 44 | }, 45 | functionName: options.functionName || "", 46 | functionVersion: options.functionVersion || "", 47 | invokedFunctionArn: options.invokedFunctionArn || "", 48 | memoryLimitInMB: options.memoryLimitInMB || "", 49 | awsRequestId: options.awsRequestId || "", 50 | logGroupName: options.logGroupName || "", 51 | logStreamName: options.logStreamName || "", 52 | identity: options.identity || {}, 53 | clientContext: options.clientContext || {}, 54 | timeInMillis: options.timeInMillis || 0 55 | }; 56 | }; 57 | -------------------------------------------------------------------------------- /mockEvent.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | /** 3 | * Functions that return mock AWS event object for testing AWS Lambda functions; 4 | **/ 5 | 6 | module.exports = { 7 | createS3Event: createS3Event, 8 | createDynamoDBEvent: createDynamoDBEvent, 9 | createSNSEvent: createSNSEvent, 10 | createAPIGatewayEvent: createAPIGatewayEvent 11 | } 12 | 13 | function createDynamoDBEvent(options){ 14 | var options = setDefaults(options, "dynamo"); 15 | var dynamoEvent = options.events.reduce(function(obj, curr) { 16 | for (var i = 0; i < curr.number; i++) { 17 | obj.Records.push(createDynamoDBRecord(curr.type, options)); 18 | }; 19 | return obj; 20 | }, {"Records": []}); 21 | 22 | return dynamoEvent; 23 | } 24 | 25 | function createDynamoDBRecord(type, options) { 26 | return { 27 | "eventID": "1", 28 | "eventVersion": "1.0", 29 | "dynamodb": { 30 | "Keys": { 31 | "Id": { 32 | "N": "101" 33 | } 34 | }, 35 | "NewImage": { 36 | "Message": { 37 | "S": "New item!" 38 | }, 39 | "Id": { 40 | "N": "101" 41 | } 42 | }, 43 | "StreamViewType": "NEW_AND_OLD_IMAGES", 44 | "SequenceNumber": "111", 45 | "SizeBytes": 26 46 | }, 47 | "awsRegion": options.awsRegion, 48 | "eventName": type, 49 | "eventSourceARN": options.eventSourceARN, 50 | "eventSource": "aws:dynamodb" 51 | } 52 | } 53 | 54 | function setDefaults(options, type) { 55 | var defaultOptions = { 56 | dynamo: { 57 | awsRegion: "eu-west-1", 58 | eventSourceARN: "arn:aws:dynamodb:us-west-2:account-id:table/ExampleTableWithStream/stream/2015-06-27T00:48:05.899", 59 | events: [{type: "INSERT", number: 1}] 60 | }, 61 | sns: { 62 | message: "default test message" 63 | }, 64 | "api-gateway": { 65 | path: "default/path", 66 | method: "GET", 67 | headers: { 68 | "default-header": 'default' 69 | }, 70 | queryStringParameters: { 71 | query: "default" 72 | }, 73 | pathParameters: { 74 | uuid: '1234' 75 | }, 76 | stageVariables: { 77 | ENV: "test" 78 | }, 79 | body: "default body" 80 | } 81 | }; 82 | 83 | if (typeof options !== "object") { 84 | return defaultOptions[type]; 85 | } 86 | return Object.keys(defaultOptions[type]).reduce(function(options, curr) { 87 | options[curr] = options[curr] ? options[curr] : defaultOptions[type][curr] 88 | return options; 89 | }, options); 90 | } 91 | 92 | function createSNSEvent (options) { 93 | var options = setDefaults(options, "sns"); 94 | options.message = typeof options.message === "string" ? options.message : JSON.stringify(options.message); 95 | 96 | return { 97 | "Records": [ 98 | { 99 | "EventVersion": "1.0", 100 | "EventSubscriptionArn": "arn:aws:sns:EXAMPLE", 101 | "EventSource": "aws:sns", 102 | "Sns": { 103 | "SignatureVersion": "1", 104 | "Timestamp": "1970-01-01T00:00:00.000Z", 105 | "Signature": "EXAMPLE", 106 | "SigningCertUrl": "EXAMPLE", 107 | "MessageId": "95df01b4-ee98-5cb9-9903-4c221d41eb5e", 108 | "Message": options.message, 109 | "MessageAttributes": { 110 | "Test": { 111 | "Type": "String", 112 | "Value": "TestString" 113 | }, 114 | "TestBinary": { 115 | "Type": "Binary", 116 | "Value": "TestBinary" 117 | } 118 | }, 119 | "Type": "Notification", 120 | "UnsubscribeUrl": "EXAMPLE", 121 | "TopicArn": "arn:aws:sns:EXAMPLE", 122 | "Subject": "TestInvoke" 123 | } 124 | } 125 | ] 126 | } 127 | } 128 | 129 | function createS3Event() { 130 | return { 131 | "Records": [ 132 | { 133 | "eventVersion": "2.0", 134 | "eventTime": "1970-01-01T00:00:00.000Z", 135 | "requestParameters": { 136 | "sourceIPAddress": "127.0.0.1" 137 | }, 138 | "s3": { 139 | "configurationId": "testConfigRule", 140 | "object": { 141 | "eTag": "0123456789abcdef0123456789abcdef", 142 | "sequencer": "0A1B2C3D4E5F678901", 143 | "key": "HappyFace.jpg", 144 | "size": 1024 145 | }, 146 | "bucket": { 147 | "arn": "arn:aws:s3:::mybucket", 148 | "name": "sourcebucket", 149 | "ownerIdentity": { 150 | "principalId": "EXAMPLE" 151 | } 152 | }, 153 | "s3SchemaVersion": "1.0" 154 | }, 155 | "responseElements": { 156 | "x-amz-id-2": "EXAMPLE123/5678abcdefghijklambdaisawesome/mnopqrstuvwxyzABCDEFGH", 157 | "x-amz-request-id": "EXAMPLE123456789" 158 | }, 159 | "awsRegion": "eu-west-1", 160 | "eventName": "ObjectCreated:Put", 161 | "userIdentity": { 162 | "principalId": "EXAMPLE" 163 | }, 164 | "eventSource": "aws:s3" 165 | } 166 | ] 167 | } 168 | } 169 | 170 | function createAPIGatewayEvent(options) { 171 | var options = setDefaults(options, "api-gateway"); 172 | 173 | return { 174 | "resource": "/assets", 175 | "path": options.path, 176 | "httpMethod": options.method, 177 | "headers": options.headers, 178 | "queryStringParameters": options.queryStringParameters, 179 | "pathParameters": options.pathParameters, 180 | "stageVariables": options.stageVariables, 181 | "requestContext": { 182 | "accountId": "1234", 183 | "resourceId": "snmm5d", 184 | "stage": "test-invoke-stage", 185 | "requestId": "test-invoke-request", 186 | "identity": { 187 | "cognitoIdentityPoolId": null, 188 | "accountId": "1234", 189 | "cognitoIdentityId": null, 190 | "caller": "1234", 191 | "apiKey": "test-invoke-api-key", 192 | "sourceIp": "test-invoke-source-ip", 193 | "accessKey": "1234", 194 | "cognitoAuthenticationType": null, 195 | "cognitoAuthenticationProvider": null, 196 | "userArn": "arn:aws:iam::1234:user/test_user", 197 | "userAgent": "Apache-HttpClient/4.5.x (Java/1.8.0)", 198 | "user": "1234" 199 | }, 200 | "resourcePath": options.path, 201 | "httpMethod": options.method, 202 | "apiId": "1234" 203 | }, 204 | "body": options.body, 205 | "isBase64Encoded": false 206 | } 207 | }; 208 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "aws-lambda-test-utils", 3 | "version": "1.3.0", 4 | "description": "Test your AWS Lambda Functions for reals!", 5 | "main": "index.js", 6 | "scripts": { 7 | "dev": "tape test/*.js", 8 | "test": "istanbul cover ./node_modules/tape/bin/tape ./test/*.js", 9 | "coverage": "istanbul cover ./node_modules/tape/bin/tape ./test/*.js && istanbul check-coverage --statements 100 --functions 100 --lines 100 --branches 100" 10 | }, 11 | "repository": { 12 | "type": "git", 13 | "url": "git+https://github.com/dwyl/aws-lambda-test-utils.git" 14 | }, 15 | "keywords": [ 16 | "lambda", 17 | "testing", 18 | "mock", 19 | "context", 20 | "event", 21 | "aws" 22 | ], 23 | "author": "Nikhi & Nelson :-)", 24 | "license": "GPL-2.0", 25 | "bugs": { 26 | "url": "https://github.com/dwyl/aws-lambda-test-utils/issues" 27 | }, 28 | "homepage": "https://github.com/dwyl/aws-lambda-test-utils#readme", 29 | "devDependencies": { 30 | "istanbul": "^0.4.2", 31 | "tape": "^4.4.0" 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /test/mockContext.test.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | var test = require('tape'); 4 | 5 | var mockContextCreator = require('../mockContext.js'); 6 | 7 | var ctxOpts = { 8 | functionName: 'LambdaTest', 9 | functionVersion: 1, 10 | invokedFunctionArn: 'arn:aws:lambda:eu-west-1:655240711487:function:LambdaTest:ci' 11 | }; 12 | var contextObjectKeys = [ 'succeed', 'fail', 'done', 'getRemainingTimeInMillis', 'functionName', 'functionVersion', 'invokedFunctionArn', 'memoryLimitInMB', 'awsRequestId', 'logGroupName', 'logStreamName', 'identity', 'clientContext', 'timeInMillis']; 13 | 14 | 15 | test('mockContextCreator:', function(t) { 16 | t.test('no opts: returns an object with done, succeed and fail methods and all other keys set to empty strings or empty objects', function(st) { 17 | var context = mockContextCreator({}, test); 18 | st.deepEquals(Object.keys(context), contextObjectKeys); 19 | st.equals(typeof context.done, 'function'); 20 | st.equals(typeof context.succeed, 'function'); 21 | st.equals(typeof context.fail, 'function'); 22 | st.equals(context.functionName, ""); 23 | st.equals(context.functionVersion, ""); 24 | st.equals(context.invokedFunctionArn, ""); 25 | st.equals(context.memoryLimitInMB, ""); 26 | st.equals(context.awsRequestId, ""); 27 | st.equals(context.logGroupName, ""); 28 | st.equals(context.logStreamName, ""); 29 | st.deepEquals(context.identity, {}); 30 | st.deepEquals(context.clientContext, {}); 31 | st.end(); 32 | }); 33 | t.test('opts: properties in options object are assigned to corresponding property in the context', function(st) { 34 | var context = mockContextCreator(ctxOpts, test); 35 | st.equals(context.functionName, ctxOpts.functionName); 36 | st.equals(context.functionVersion, ctxOpts.functionVersion); 37 | st.equals(context.invokedFunctionArn, ctxOpts.invokedFunctionArn); 38 | st.end(); 39 | }); 40 | t.end(); 41 | }); 42 | 43 | test('Context methods', function(t) { 44 | t.test('context.succeed: calls callback with the result', function(st) { 45 | function test(result) { 46 | st.equals(result, "test passed"); 47 | st.end(); 48 | }; 49 | var context = mockContextCreator(ctxOpts, test); 50 | context.succeed("test passed"); 51 | }); 52 | t.test('context.succeed: stringifies the result if it is an object', function(st) { 53 | function test(result) { 54 | st.deepEquals(result, '{"result":"test passed"}'); 55 | st.end(); 56 | }; 57 | var context = mockContextCreator(ctxOpts, test); 58 | context.succeed({ result: "test passed" }); 59 | }); 60 | t.test('context.succeed: calls callback null if no result', function(st) { 61 | function test(result) { 62 | st.equals(result, null); 63 | st.end(); 64 | }; 65 | var context = mockContextCreator(ctxOpts, test); 66 | context.succeed(); 67 | }); 68 | t.test('context.fail: calls callback with the error', function(st) { 69 | function test(error) { 70 | st.equals(error, "test failed"); 71 | st.end(); 72 | }; 73 | var context = mockContextCreator(ctxOpts, test); 74 | context.fail("test failed"); 75 | }); 76 | t.test('context.fail: calls callback with null if no error', function(st) { 77 | function test(error) { 78 | st.equals(error, null); 79 | st.end(); 80 | }; 81 | var context = mockContextCreator(ctxOpts, test); 82 | context.fail(); 83 | }); 84 | t.test('context.done: calls callback with result if error is null', function(st) { 85 | function test(result) { 86 | st.equals(result, "test passed"); 87 | st.end(); 88 | }; 89 | var context = mockContextCreator(ctxOpts, test); 90 | context.done(null, "test passed"); 91 | }); 92 | t.test('context.done: calls callback with error if error is not null', function(st) { 93 | function test(error, result) { 94 | st.equals(error, "Error") 95 | st.end(); 96 | }; 97 | var context = mockContextCreator(ctxOpts, test); 98 | context.done("Error"); 99 | }); 100 | t.test('context.getRemainingTimeInMillis: return the correct time', function(st) { 101 | function callBack() {}; 102 | ctxOpts.timeInMillis = 100; 103 | var context = mockContextCreator(ctxOpts, callBack); 104 | st.equal(context.getRemainingTimeInMillis(), 100); 105 | st.end() 106 | }); 107 | t.test('context.getRemainingTimeInMillis: returns 0 when timeInMillis is not sepcified', function(st) { 108 | function callBack() {}; 109 | ctxOpts.timeInMillis = '0'; 110 | var context = mockContextCreator(ctxOpts, callBack); 111 | st.equal(context.getRemainingTimeInMillis(), 0); 112 | st.end(); 113 | }) 114 | t.end(); 115 | }) 116 | -------------------------------------------------------------------------------- /test/mockEvent.test.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | var test = require('tape'); 4 | 5 | var mockEventCreator = require('../mockEvent.js'); 6 | 7 | 8 | test('mockEventCreator - createDynamoDBEvent', function(t) { 9 | t.test('no options: returns an object with 1 dynamo "INSERT" event, with the default eventSourceARN and an awsRegion of "eu-west-1"', function(st) { 10 | var dynamoEvent = mockEventCreator.createDynamoDBEvent(); 11 | st.equals(dynamoEvent.Records.length, 1, "event should contain 1 Record"); 12 | st.equals(dynamoEvent.Records[0].eventName, "INSERT", "event Record should be an 'INSERT'"); 13 | st.equals( 14 | dynamoEvent.Records[0].eventSourceARN, 15 | "arn:aws:dynamodb:us-west-2:account-id:table/ExampleTableWithStream/stream/2015-06-27T00:48:05.899", 16 | "event should have the default eventSourceARN as the eventSourceARN" 17 | ); 18 | st.equals(dynamoEvent.Records[0].awsRegion, "eu-west-1", "event should have eu-west-1 as the region"); 19 | st.end(); 20 | }); 21 | t.test('partially filled object for options: returns an object with 2 dynamo Records, with the default eventSourceARN and awsRegion', function(st) { 22 | var dynamoEvent = mockEventCreator.createDynamoDBEvent({events: [{type: "REMOVE", number: 1}, {type: "INSERT", number: 1}]}); 23 | st.equals(dynamoEvent.Records.length, 2, "event should contain 2 Records"); 24 | st.equals(dynamoEvent.Records[0].eventName, "REMOVE", "first event Record should be an 'REMOVE'"); 25 | st.equals(dynamoEvent.Records[1].eventName, "INSERT", "second event Record should be an 'INSERT'"); 26 | st.equals( 27 | dynamoEvent.Records[0].eventSourceARN, 28 | "arn:aws:dynamodb:us-west-2:account-id:table/ExampleTableWithStream/stream/2015-06-27T00:48:05.899", 29 | "event should have the default eventSourceARN as the eventSourceARN" 30 | ); 31 | st.equals(dynamoEvent.Records[0].awsRegion, "eu-west-1", "event should have eu-west-1 as the region"); 32 | st.end(); 33 | }); 34 | t.end(); 35 | }); 36 | 37 | test('mockEventCreator - createSNSEvent', function(t) { 38 | t.test('no options: returns an object with 1 SNS Record, with the default TopicArn and Message', function(st) { 39 | var SNSEvent = mockEventCreator.createSNSEvent(); 40 | st.equals(SNSEvent.Records.length, 1, "event should contain 1 Record"); 41 | st.equals(SNSEvent.Records[0].Sns.TopicArn, "arn:aws:sns:EXAMPLE"); 42 | st.equals(SNSEvent.Records[0].Sns.Message, "default test message"); 43 | st.end(); 44 | }); 45 | t.end(); 46 | }); 47 | 48 | test('mockEventCreator - createSNSEvent', function(t) { 49 | t.test('options with string message: returns an object with 1 SNS Record, with the custom Message', function(st) { 50 | var SNSEvent = mockEventCreator.createSNSEvent({message: "custom message"}); 51 | st.equals(SNSEvent.Records.length, 1, "event should contain 1 Record"); 52 | st.equals(SNSEvent.Records[0].Sns.TopicArn, "arn:aws:sns:EXAMPLE"); 53 | st.equals(SNSEvent.Records[0].Sns.Message, "custom message"); 54 | st.end(); 55 | }); 56 | t.end(); 57 | }); 58 | test('mockEventCreator - createSNSEvent', function(t) { 59 | var message = { 60 | nested: { 61 | object: "test string" 62 | } 63 | }; 64 | 65 | t.test('options with object message: returns an object with 1 SNS Record, with the custom Message', function(st) { 66 | var SNSEvent = mockEventCreator.createSNSEvent({message: message}); 67 | st.equals(SNSEvent.Records.length, 1, "event should contain 1 Record"); 68 | st.equals(SNSEvent.Records[0].Sns.TopicArn, "arn:aws:sns:EXAMPLE"); 69 | st.equals(SNSEvent.Records[0].Sns.Message, JSON.stringify(message)); 70 | st.end(); 71 | }); 72 | t.end(); 73 | }); 74 | 75 | test('mockEventCreator - createS3Event', function(t) { 76 | t.test('no options: returns an object with 1 S3 Record, with the default awsRegion and bucket arn', function(st) { 77 | var S3Event = mockEventCreator.createS3Event(); 78 | st.equals(S3Event.Records.length, 1, "event should contain 1 Record"); 79 | st.equals(S3Event.Records[0].awsRegion, "eu-west-1"); 80 | st.equals(S3Event.Records[0].s3.bucket.arn, "arn:aws:s3:::mybucket"); 81 | st.end(); 82 | }); 83 | t.end(); 84 | }); 85 | 86 | test('mockEventCreator - createAPIGatewayEvent', function(t) { 87 | t.test('no options: returns an object with default api gateway values', function(st) { 88 | var APIGatewayEvent = mockEventCreator.createAPIGatewayEvent(); 89 | st.equals(APIGatewayEvent.httpMethod, "GET", "event method should be GET"); 90 | st.equals(APIGatewayEvent.body, "default body", "event body should be 'default body'"); 91 | st.end() 92 | }); 93 | t.test('options with body and stageVariables: returns an object with custom body and stageVariables', function(st) { 94 | var options = { 95 | stageVariables: { ENV: "DEV", API_URL: 'http://api.url'}, 96 | body: "i am a custom body" 97 | } 98 | var APIGatewayEvent = mockEventCreator.createAPIGatewayEvent(options); 99 | 100 | st.deepEquals(APIGatewayEvent.stageVariables, options.stageVariables, "event stageVariables should be custom stageVariables "); 101 | st.equals(APIGatewayEvent.body, options.body, "event body should be custom body"); 102 | st.end() 103 | }); 104 | t.end(); 105 | }); 106 | --------------------------------------------------------------------------------