Unittests für Cloud Functions

Auf dieser Seite werden Best Practices und Tools zum Erstellen von Unit-Tests für Ihre Funktionen beschrieben, z. B. Tests, die Teil eines CI-Systems (Continuous Integration) sind. Um das Testen zu vereinfachen, stellt Firebase die Firebase Test SDK für Cloud Functions bereit. Es wird auf npm als firebase-functions-test bereitgestellt und ist ein begleitendes Test-SDK für firebase-functions. Firebase Test SDK für Cloud Functions:

  • Kümmert sich um das entsprechende Einrichten und Herunterfahren für Ihre Tests, z. B. das Festlegen und Aufheben der Festlegung von Umgebungsvariablen, die von firebase-functions benötigt werden.
  • Generiert Beispieldaten und Ereigniskontext, sodass Sie nur die Felder angeben müssen, die für Ihren Test relevant sind.

Testeinrichtung

Installieren Sie sowohl firebase-functions-test als auch Mocha, ein Testframework. Führen Sie dazu die folgenden Befehle im Funktionsverzeichnis aus:

npm install --save-dev firebase-functions-test
npm install --save-dev mocha

Erstellen Sie als Nächstes einen test-Ordner im Ordner „Functions“ (Funktionen) und erstellen Sie darin eine neue Datei für den Testcode. Geben Sie ihr einen Namen wie index.test.js.

Ändern Sie abschließend functions/package.json und fügen Sie Folgendes hinzu:

"scripts": {
  "test": "mocha --reporter spec"
}

Nachdem Sie die Tests geschrieben haben, können Sie sie ausführen, indem Sie npm test in Ihrem Funktionsverzeichnis ausführen.

Firebase Test SDK wird für Cloud Functions initialisiert

Es gibt zwei Möglichkeiten, firebase-functions-test zu verwenden:

  1. Onlinemodus (empfohlen): Schreiben Sie Tests, die mit einem Firebase-Testprojekt interagieren, damit Datenbankeinträge, Nutzererstellungen usw. tatsächlich stattfinden und die Ergebnisse mit Ihrem Testcode geprüft werden können. Das bedeutet auch, dass andere Google SDKs, die in Ihren Funktionen verwendet werden, auch funktionieren werden.
  2. Offlinemodus:Sie können isolierte und Offline-Unit-Tests ohne Nebenwirkungen schreiben. Das bedeutet, dass alle Methodenaufrufe, die mit einem Firebase-Produkt interagieren (z. B. Schreiben in die Datenbank oder Erstellen eines Nutzers), gestubbt werden müssen. Die Verwendung des Offlinemodus wird in der Regel nicht empfohlen, wenn Sie Cloud Firestore- oder Realtime Database-Funktionen haben, da dies die Komplexität Ihres Testcodes erheblich erhöht.

SDK im Onlinemodus initialisieren (empfohlen)

Wenn Sie Tests schreiben möchten, die mit einem Testprojekt interagieren, müssen Sie die Projektkonfigurationswerte angeben, die zum Initialisieren der App über firebase-admin erforderlich sind, sowie den Pfad zu einer Dienstkontoschlüsseldatei.

So rufen Sie die Konfigurationswerte Ihres Firebase-Projekts ab:

  1. Öffnen Sie die Projekteinstellungen in der Firebase-Konsole.
  2. Wählen Sie unter Meine Apps die gewünschte App aus.

  3. Wählen Sie im rechten Bereich die Option zum Herunterladen einer Konfigurationsdatei für Apple- und Android-Apps aus.

    Wählen Sie für Webanwendungen Config aus, um Konfigurationswerte anzuzeigen.

So erstellen Sie eine Schlüsseldatei:

  1. Öffnen Sie in der Google Cloud-Konsole den Bereich Dienstkonten.
  2. Wählen Sie das Standarddienstkonto App Engine und dann im Optionsmenü rechts die Option Create key (Schlüssel erstellen) aus.
  3. Wählen Sie auf der nächsten Seite als Schlüsseltyp „JSON“ aus und klicken Sie auf Erstellen.

Nachdem Sie die Schlüsseldatei gespeichert haben, initialisieren Sie das SDK:

// At the top of test/index.test.js
const test = require('firebase-functions-test')({
  databaseURL: 'https://my-project.firebaseio.com',
  storageBucket: 'my-project.appspot.com',
  projectId: 'my-project',
}, 'path/to/serviceAccountKey.json');

SDK im Offlinemodus initialisieren

Wenn Sie vollständige Offlinetests schreiben möchten, können Sie das SDK ohne Parameter initialisieren:

// At the top of test/index.test.js
const test = require('firebase-functions-test')();

Konfigurationswerte für Mockups

Wenn Sie functions.config() in Ihrem Funktionscode verwenden, können Sie die Konfigurationswerte simulieren. Angenommen, functions/index.js enthält den folgenden Code:

const functions = require('firebase-functions/v1');
const key = functions.config().stripe.key;

Dann können Sie den Wert in Ihrer Testdatei wie folgt simulieren:

// Mock functions config values
test.mockConfig({ stripe: { key: '23wr42ewr34' }});

Funktionen importieren

Verwenden Sie require, um Ihre Hauptfunktionsdatei als Modul zu importieren. Tu dies erst, nachdem du firebase-functions-test initialisiert und Konfigurationswerte gemockt hast.

// after firebase-functions-test has been initialized
const myFunctions = require('../index.js'); // relative path to functions code

Wenn Sie firebase-functions-test im Offlinemodus initialisiert haben und admin.initializeApp() in Ihrem Funktionscode enthalten ist, müssen Sie einen Stub erstellen, bevor Sie Ihre Funktionen importieren:

// If index.js calls admin.initializeApp at the top of the file,
// we need to stub it out before requiring index.js. This is because the
// functions will be executed as a part of the require process.
// Here we stub admin.initializeApp to be a dummy function that doesn't do anything.
adminInitStub = sinon.stub(admin, 'initializeApp');
// Now we can require index.js and save the exports inside a namespace called myFunctions.
myFunctions = require('../index');
test.offline.js

Hintergrundfunktionen (nicht HTTP) testen

Das Testen nicht HTTP-basierter Funktionen umfasst die folgenden Schritte:

  1. Umschließen Sie die Funktion, die Sie testen möchten, in der Methode test.wrap.
  2. Testdaten erstellen
  3. Rufen Sie die gewrappte Funktion mit den von Ihnen erstellten Testdaten und allen Ereigniskontextfeldern auf, die Sie angeben möchten.
  4. Aussagen zum Verhalten treffen

Umschließen Sie zuerst die Funktion, die Sie testen möchten. Angenommen, Sie haben in functions/index.js eine Funktion namens makeUppercase, die Sie testen möchten. Fügen Sie Folgendes in functions/test/index.test.js ein:

// "Wrap" the makeUpperCase function from index.js
const myFunctions = require('../index.js');
const wrapped = test.wrap(myFunctions.makeUppercase);

wrapped ist eine Funktion, die makeUppercase aufruft, wenn sie aufgerufen wird. wrapped benötigt zwei Parameter:

  1. data (erforderlich): die Daten, die an makeUppercase gesendet werden sollen. Dies entspricht direkt dem ersten Parameter, der an den von Ihnen geschriebenen Funktions-Handler gesendet wird. firebase-functions-test bietet Methoden zum Erstellen benutzerdefinierter Daten oder Beispieldaten.
  2. eventContextOptions (optional): Felder des Ereigniskontexts, die Sie angeben möchten. Der Ereigniskontext ist der zweite Parameter, der an den von Ihnen geschriebenen Funktions-Handler gesendet wird. Wenn Sie beim Aufrufen von wrapped keinen eventContextOptions-Parameter angeben, wird trotzdem ein Ereigniskontext mit sensiblen Feldern generiert. Sie können einige der generierten Felder überschreiben, indem Sie sie hier angeben. Sie müssen nur die Felder angeben, die Sie überschreiben möchten. Alle Felder, die Sie nicht überschrieben haben, werden generiert.
const data = … // See next section for constructing test data

// Invoke the wrapped function without specifying the event context.
wrapped(data);

// Invoke the function, and specify params
wrapped(data, {
  params: {
    pushId: '234234'
  }
});

// Invoke the function, and specify auth and auth Type (for real time database functions only)
wrapped(data, {
  auth: {
    uid: 'jckS2Q0'
  },
  authType: 'USER'
});

// Invoke the function, and specify all the fields that can be specified
wrapped(data, {
  eventId: 'abc',
  timestamp: '2018-03-23T17:27:17.099Z',
  params: {
    pushId: '234234'
  },
  auth: {
    uid: 'jckS2Q0' // only for real time database functions
  },
  authType: 'USER' // only for real time database functions
});

Testdaten erstellen

Der erste Parameter einer verpackten Funktion sind die Testdaten, mit denen die zugrunde liegende Funktion aufgerufen werden soll. Es gibt mehrere Möglichkeiten, Testdaten zu erstellen.

Benutzerdefinierte Daten verwenden

firebase-functions-test bietet eine Reihe von Funktionen zum Erstellen von Daten, die zum Testen Ihrer Funktionen erforderlich sind. Verwenden Sie beispielsweise test.firestore.makeDocumentSnapshot, um eine Firestore-DocumentSnapshot zu erstellen. Das erste Argument sind die Daten und das zweite Argument der vollständige Referenzpfad. Es gibt ein optionales drittes Argument für andere Attribute des Snapshots, die Sie angeben können.

// Make snapshot
const snap = test.firestore.makeDocumentSnapshot({foo: 'bar'}, 'document/path');
// Call wrapped function with the snapshot
const wrapped = test.wrap(myFunctions.myFirestoreDeleteFunction);
wrapped(snap);

Wenn Sie eine onUpdate- oder onWrite-Funktion testen, müssen Sie zwei Snapshots erstellen: einen für den Vorher-Zustand und einen für den Nachher-Zustand. Anschließend können Sie mit der Methode makeChange ein Change-Objekt mit diesen Snapshots erstellen.

// Make snapshot for state of database beforehand
const beforeSnap = test.firestore.makeDocumentSnapshot({foo: 'bar'}, 'document/path');
// Make snapshot for state of database after the change
const afterSnap = test.firestore.makeDocumentSnapshot({foo: 'faz'}, 'document/path');
const change = test.makeChange(beforeSnap, afterSnap);
// Call wrapped function with the Change object
const wrapped = test.wrap(myFunctions.myFirestoreUpdateFunction);
wrapped(change);

In der API-Referenz finden Sie ähnliche Funktionen für alle anderen Datentypen.

Beispieldaten verwenden

Wenn Sie die in Ihren Tests verwendeten Daten nicht anpassen müssen, bietet firebase-functions-test Methoden zum Generieren von Beispieldaten für jeden Funktionstyp.

// For Firestore onCreate or onDelete functions
const snap = test.firestore.exampleDocumentSnapshot();
// For Firestore onUpdate or onWrite functions
const change = test.firestore.exampleDocumentSnapshotChange();

In der API-Referenz finden Sie Methoden zum Abrufen von Beispieldaten für jeden Funktionstyp.

Verwenden von Daten-Stubs (für den Offline-Modus)

Wenn Sie das SDK im Offlinemodus initialisiert haben und eine Cloud Firestore- oder Realtime Database-Funktion testen, sollten Sie ein einfaches Objekt mit Stubs verwenden, anstatt einen tatsächlichen DocumentSnapshot oder DataSnapshot zu erstellen.

Angenommen, Sie schreiben einen Unittest für die folgende Funktion:

// Listens for new messages added to /messages/:pushId/original and creates an
// uppercase version of the message to /messages/:pushId/uppercase
exports.makeUppercase = functions.database.ref('/messages/{pushId}/original')
    .onCreate((snapshot, context) => {
      // Grab the current value of what was written to the Realtime Database.
      const original = snapshot.val();
      functions.logger.log('Uppercasing', context.params.pushId, original);
      const uppercase = original.toUpperCase();
      // You must return a Promise when performing asynchronous tasks inside a Functions such as
      // writing to the Firebase Realtime Database.
      // Setting an "uppercase" sibling in the Realtime Database returns a Promise.
      return snapshot.ref.parent.child('uppercase').set(uppercase);
    });
index.js

Innerhalb der Funktion wird snap zweimal verwendet:

  • snap.val()
  • snap.ref.parent.child('uppercase').set(uppercase)

Erstellen Sie im Testcode ein einfaches Objekt, in dem beide Codepfade funktionieren, und verwenden Sie Sinon, um einen Stub für die Methoden auszuführen.

// The following lines creates a fake snapshot, 'snap', which returns 'input' when snap.val() is called,
// and returns true when snap.ref.parent.child('uppercase').set('INPUT') is called.
const snap = {
  val: () => 'input',
  ref: {
    parent: {
      child: childStub,
    }
  }
};
childStub.withArgs(childParam).returns({ set: setStub });
setStub.withArgs(setParam).returns(true);
test.offline.js

Assertions erstellen

Nachdem Sie das SDK initialisiert, die Funktionen verpackt und die Daten erstellt haben, können Sie die zusammengefassten Funktionen mit den erstellten Daten aufrufen und Assertions zum Verhalten treffen. Sie können eine Bibliothek wie Chai verwenden, um diese Behauptungen zu machen.

Behauptungen im Onlinemodus machen

Wenn Sie die Firebase Test SDK für Cloud Functions im Onlinemodus initialisiert haben, können Sie mithilfe des firebase-admin SDK prüfen, ob die gewünschten Aktionen (z. B. eine Datenbankeinschreibung) ausgeführt wurden.

Im folgenden Beispiel wird behauptet, dass „INPUT“ in die Datenbank des Testprojekts geschrieben wurde.

// Create a DataSnapshot with the value 'input' and the reference path 'messages/11111/original'.
const snap = test.database.makeDataSnapshot('input', 'messages/11111/original');

// Wrap the makeUppercase function
const wrapped = test.wrap(myFunctions.makeUppercase);
// Call the wrapped function with the snapshot you constructed.
return wrapped(snap).then(() => {
  // Read the value of the data at messages/11111/uppercase. Because `admin.initializeApp()` is
  // called in functions/index.js, there's already a Firebase app initialized. Otherwise, add
  // `admin.initializeApp()` before this line.
  return admin.database().ref('messages/11111/uppercase').once('value').then((createdSnap) => {
    // Assert that the value is the uppercased version of our input.
    assert.equal(createdSnap.val(), 'INPUT');
  });
});
test.online.js

Behauptungen im Offlinemodus aufstellen

Sie können Annahmen über den erwarteten Rückgabewert der Funktion treffen:

const childParam = 'uppercase';
const setParam = 'INPUT';
// Stubs are objects that fake and/or record function calls.
// These are excellent for verifying that functions have been called and to validate the
// parameters passed to those functions.
const childStub = sinon.stub();
const setStub = sinon.stub();
// The following lines creates a fake snapshot, 'snap', which returns 'input' when snap.val() is called,
// and returns true when snap.ref.parent.child('uppercase').set('INPUT') is called.
const snap = {
  val: () => 'input',
  ref: {
    parent: {
      child: childStub,
    }
  }
};
childStub.withArgs(childParam).returns({ set: setStub });
setStub.withArgs(setParam).returns(true);
// Wrap the makeUppercase function.
const wrapped = test.wrap(myFunctions.makeUppercase);
// Since we've stubbed snap.ref.parent.child(childParam).set(setParam) to return true if it was
// called with the parameters we expect, we assert that it indeed returned true.
return assert.equal(wrapped(snap), true);
test.offline.js

Sie können auch Sinon-Spione verwenden, um zu prüfen, ob bestimmte Methoden mit den erwarteten Parametern aufgerufen wurden.

HTTP-Funktionen testen

Verwenden Sie zum Testen von HTTP-onCall-Funktionen denselben Ansatz wie beim Testen von Hintergrundfunktionen.

Wenn Sie HTTP-onRequest-Funktionen testen, sollten Sie firebase-functions-test verwenden, wenn:

  • Du verwendest functions.config()
  • Ihre Funktion interagiert mit einem Firebase-Projekt oder anderen Google APIs und Sie möchten ein echtes Firebase-Projekt und die zugehörigen Anmeldedaten für Ihre Tests verwenden.

Eine HTTP-onRequest-Funktion nimmt zwei Parameter an: ein Anfrageobjekt und ein Antwortobjekt. So können Sie die addMessage()-Beispielfunktion testen:

  • Überschreiben Sie die Weiterleitungsfunktion im Antwortobjekt, da sendMessage() sie aufruft.
  • Verwenden Sie in der Weiterleitungsfunktion chai.assert, um zu prüfen, mit welchen Parametern die Weiterleitungsfunktion aufgerufen werden soll:
// A fake request object, with req.query.text set to 'input'
const req = { query: {text: 'input'} };
// A fake response object, with a stubbed redirect function which asserts that it is called
// with parameters 303, 'new_ref'.
const res = {
  redirect: (code, url) => {
    assert.equal(code, 303);
    assert.equal(url, 'new_ref');
    done();
  }
};

// Invoke addMessage with our fake request and response objects. This will cause the
// assertions in the response object to be evaluated.
myFunctions.addMessage(req, res);
test.offline.js

Testbereinigung

Rufen Sie die Bereinigungsfunktion ganz am Ende Ihres Testcodes auf. Dadurch werden Umgebungsvariablen zurückgesetzt, die das SDK bei der Initialisierung festgelegt hat, und Firebase-Apps gelöscht, die möglicherweise erstellt wurden, wenn Sie mit dem SDK eine Echtzeitdatenbank DataSnapshot oder Firestore DocumentSnapshot erstellt haben.

test.cleanup();

Vollständige Beispiele ansehen und mehr erfahren

Die vollständigen Beispiele finden Sie im Firebase GitHub-Repository.

Weitere Informationen finden Sie in der API-Referenz für firebase-functions-test.