Package Exports
- firebase-functions-test
- firebase-functions-test/lib/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (firebase-functions-test) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Firebase Test SDK for Cloud Functions
The firebase-functions-test is unit testing library for Cloud Functions for Firebase. It is a companion to firebase-functions.
NOTE: This library can only be used with firebase-functions v3.20.1 or above.
Usage
- Write some Firebase Functions
- With your testing framework of choice, write a unit-test that imports your Firebase Functions.
wrapyour Firebase Functions. You can invoke the Firebase Function's handler by invoking thewrapcall.
Eg.
import {myFirebaseFunction} from "../index"; // Your Firebase Functions
import firebaseFunctionsTest from "firebase-functions-test";
// Extracting `wrap` out of the lazy-loaded features
const {wrap} = firebaseFunctionsTest();
// `jest-ts` example
test('my unit test', () => {
const wrappedFirebaseFunction = wrap(myFirebaseFunction);
// Invoke the firebase function
wrappedFirebaseFunction();
// Invoke the firebase function with CloudEvent overrides
wrappedFirebaseFunction({data: {arbitrary: 'values'}});
});Examples
- Unit Testing Gen-1 Cloud Functions using Mocha
- Unit Testing Gen-2 Cloud Functions using Mocha
- Unit Testing Gen-2 Cloud Functions using Jest
- Unit Testing Gen-2 Cloud Functions using Jest-Ts
Learn more
Learn more about unit testing Cloud Functions here.
Contributing
To contribute a change, check out the contributing guide.
License
© Google, 2018. Licensed under The MIT License.