Testberichte erstellen

Cloud Firestore und Realtime Database verwenden leistungsstarke, prägnante Regelsprachen die speziell für die Informationssicherheit und Zugriffssteuerung entwickelt wurden. Wenn Regeln jedoch länger und komplexer werden, benötigen Sie möglicherweise Hilfe beim Debuggen von Fehlern in ihrem Verhalten.

Die Firebase-Emulatoren bieten die Möglichkeit, Berichte zur Regelabdeckung zu generieren. So können Sie genau sehen, was jeder Teilausdruck ergeben hat, wenn Sie einen Fehler reproduzieren. Die Berichte enthalten auch Informationen dazu, wie oft jeder Testfall eine Regel verwendet hat, ähnlich wie bei herkömmlichen Techniken zur „Zeilenabdeckung“.

Bericht generieren

Nachdem Sie eine Reihe von Tests ausgeführt haben, können Sie auf Berichte zur Testabdeckung zugreifen, die Aufschluss darüber geben, wie die einzelnen Sicherheitsregeln bewertet wurden.

Um die Berichte abzurufen, fragen Sie einen bereitgestellten Endpunkt im Emulator ab, während er ausgeführt wird. Verwenden Sie für eine browserfreundliche Version die folgende URL:

http://localhost:8080/emulator/v1/projects/<database_name>:ruleCoverage.html
 

http://localhost:9000/.inspect/coverage?ns=<database_name>
 

Dadurch werden Ihre Regeln in Ausdrücke und Teilausdrücke aufgeteilt. Bewegen Sie die Maus auf einen Ausdruck oder Teilausdruck, um weitere Informationen zu erhalten, einschließlich der Anzahl der Bewertungen und der zurückgegebenen Werte. Fügen Sie für die JSON-Rohversion dieser Daten die folgende URL in Ihre Abfrage ein:

http://localhost:8080/emulator/v1/projects/<database_name>:ruleCoverage
 

http://localhost:9000/.inspect/coverage.json?ns=<database_name>
 

Beispielregeln debuggen

Um ganz einfach einen Testbericht zu generieren, verwenden Sie die Kurzanleitungen für den Emulator, die auf GitHub für Cloud Firestore und Realtime Database verfügbar sind. In diesen Kurzanleitungen wird beschrieben, wie Sie die Emulatoren richtig installieren und initialisieren und dann Beispieltests aus einem Beispielsatz von Regeln generieren.

Nehmen wir eine Beispiel-App an, die Cloud Firestore verwendet und zählt, wie oft Nutzer auf eine Schaltfläche klicken. Die App verwendet die folgenden Regeln:

 service cloud.firestore {
   match /databases/{database}/documents {
     match /counters/{counter} {
       allow read;
       allow write: if request.resource.data.value == resource.data.value +1;
     }
   }
 }
 

Verwenden Sie den folgenden JavaScript-Beispieltest, um die Fehler in den oben gezeigten Regeln zu beheben:

const counter0 = db.collection("counters").doc("0");
await firebase.assertSucceeds(counter0.set({value: 0}));

Der Emulator generiert einen Bericht, der unter der oben genannten URL verfügbar ist:

http://localhost:8080/emulator/v1/projects/<database_name>:ruleCoverage.html

Der Bericht enthält die folgenden Fehler für nicht definierte und Nullwerte:

Das Problem bei diesem Beispiel ist, dass die Regeln nicht zwischen dem Erstellen und dem Aktualisieren des Dokuments unterscheiden. Folglich ist das Schreiben nicht zulässig, wenn das Dokument nicht vorhanden ist, und das Dokument kann nicht erstellt werden, weil es nicht vorhanden ist. Wenn Sie das Schreiben in zwei spezifischere Vorgänge unterteilen – „Erstellen“ und „Aktualisieren“ – wird das Problem behoben.

 service cloud.firestore {
   match /databases/{database}/documents {
     match /counters/{counter} {
       allow read;
       allow create: if request.resource.data.value == 0;
       allow update: if request.resource.data.value == resource.data.value +1;
     }
   }
 }
 

Der generierte Bericht zeigt, wie oft jede Regel verwendet wurde und was zurückgegeben wurde.