test
test
est un espace de noms global qui sert de compagnon de test aux fonctions Firebase.
Utilisez test()
pour initialiser le SDK, en fournissant éventuellement ces paramètres pour les tests en ligne :
-
firebaseConfig
Valeurs de configuration Firebase pour initialiser une application Firebase avec laquelle votre code de test doit interagir (par exemple, effectuer des écritures dans la base de données). Il est recommandé d'utiliser un projet spécifiquement destiné aux tests. En cas d'omission, des valeurs de configuration fictives sont utilisées et vos tests n'interagissent pas avec une véritable application Firebase, et toutes les méthodes Firebase doivent être remplacées. -
pathToServiceAccountKey
Chemin d'accès à un fichier de clé de compte de service à utiliser lors de l'initialisation de l'application Firebase.
Par exemple:
const test = require('firebase-functions-test')(); // Offline mode
const test = require('firebase-functions-test')(firebaseConfigValues, path/to/key.json'); // Online mode
Interface
Options de contexte d'événement
Espaces de noms
analytique
authentification
crashlytiques
base de données
magasin de feu
pubsub
stockage
Méthodes
nettoyer
nettoyer()
Effectuer des tâches de nettoyage.
faireChange
makeChange (avant, après) renvoie un objet
Créez un objet Change
à utiliser comme données de test pour les fonctions Firestore et Realtime Database onWrite
et onUpdate
.
Paramètre | |
---|---|
avant | Objet Instantané avant l'écriture ou la mise à jour. La valeur ne doit pas être nulle. |
après | Objet Instantané après l'écriture ou la mise à jour. La valeur ne doit pas être nulle. |
- Retour
non-null Object
Un objetChange
à des fins de test.
mockConfig
mockConfig(config)
Valeurs fictives renvoyées par functions.config()
.
Paramètre | |
---|---|
configuration | Objet Paires clé-valeur représentant la configuration à moquer. La valeur ne doit pas être nulle. |
envelopper
wrap(cloudFunction) renvoie test.WrappedFunction
Prend une fonction à tester et renvoie une WrappedFunction
qui peut être appelée dans le code de test.
Paramètre | |
---|---|
fonction cloud | Objet Une CloudFunction est à la fois un objet qui exporte ses définitions de déclencheur vers __trigger et peut être appelé en tant que fonction à l'aide de l'API JavaScript pour Google Cloud Functions. La valeur ne doit pas être nulle. |
- Retour
non-null test.WrappedFunction
WrappedFunction
WrappedFunction (données, options)
Un type de fonction qui peut être appelé avec des données de test et des valeurs de remplacement facultatives pour le contexte de l'événement. Il invoquera ensuite la fonction qu'il encapsule avec les données de test fournies et un contexte d'événement généré.
Paramètre | |
---|---|
données | n'importe quel type Les données des tests. La valeur ne doit pas être nulle. |
choix | Objet Remplacez les valeurs du contexte de l'événement en tant qu'objet La valeur peut être nulle. |