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.
- Write some Firebase Functions
- With your testing framework of choice, write a unit-test that imports your Firebase Functions.
wrap
your Firebase Functions. You can invoke the Firebase Function's handler by invoking thewrap
call.
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'}}); });
- 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 about unit testing Cloud Functions here.
To contribute a change, check out the contributing guide.
© Google, 2018. Licensed under The MIT License.