firebase-mock icon indicating copy to clipboard operation
firebase-mock copied to clipboard

Firebase mock library for writing unit tests

Firebase Mock Build Status

Firebase Mock extends mockfirebase to provide support for the following Firebase Javascript SDKS:

Setup

npm install firebase-mock --save-dev

Follow the steps in the Setup Tutorial to create a mock SDK to be used in your tests. Then follow one of the tutorials below based on your testing framework:

  • Proxyquire
  • Jest
  • Window Override

API

Firebase Mock supports the client-side JavaScript API and server-side Admin API plus a small set of utility methods documented fully in the API Reference. Rather than make a server call that is actually asynchronous, Firebase Mock allows you to either trigger callbacks synchronously or asynchronously with a specified delay (ref.flush).

Tutorials

Client (firebase)

  • Authentication
    • Basic
    • JWT Tokens
  • Realtime Database
    • Basic
    • Simulating Errors
    • Ordering
  • Firestore
  • Storage

Admin (firebase-admin)

  • Authentication
    • Basic
    • JWT Tokens
  • Realtime Database
  • Firestore
  • Storage

Functions (firebase-functions)

  • Realtime Database
  • Firestore
  • HTTP

Alternatives