Создание отчетов об испытаниях

Cloud Firestore и Realtime Database используют мощные и лаконичные языки правил, специально разработанные для управления информационной безопасностью и контролем доступа. Однако по мере того, как правила становятся длиннее и сложнее, вам может потребоваться помощь в отладке ошибок в их работе.

Эмуляторы Firebase позволяют создавать отчёты о покрытии правил, чтобы вы могли точно увидеть, к какому результату привело каждое подвыражение при воспроизведении ошибки. Отчёты также содержат информацию о частоте использования правила в каждом тестовом случае, подобно традиционным методам «покрытия строк».

Создать отчет

После запуска набора тестов вы можете получить доступ к отчетам о покрытии тестами, в которых показано, как оценивалось каждое из ваших правил безопасности.

Чтобы получить отчёты, отправьте запрос к открытой конечной точке эмулятора во время его работы. Для браузерной версии используйте следующий URL:

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

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

Это разобьёт ваши правила на выражения и подвыражения, на которые можно навести курсор, чтобы получить дополнительную информацию, включая количество вычислений и возвращаемых значений. Чтобы получить необработанную версию этих данных в формате JSON, включите в запрос следующий URL:

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

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

Примеры правил отладки

Чтобы легко создать отчёт о тестировании, воспользуйтесь краткими руководствами по эмуляторам Cloud Firestore и Realtime Database , доступными на GitHub. Эти руководства помогут вам правильно установить и инициализировать эмуляторы, а затем сгенерировать примеры тестов на основе примерного набора правил.

Рассмотрим пример приложения, использующего Cloud Firestore , которое подсчитывает количество нажатий кнопки пользователями. Приложение использует следующие правила:

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

Для отладки ошибок в правилах, показанных выше, используйте следующий пример теста JavaScript:

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

Эмулятор генерирует отчет, доступный по указанному выше URL-адресу:

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

В отчете показаны следующие неопределенные и нулевые ошибки:

Проблема в этом конкретном примере заключается в том, что правила не различают создание документа и его обновление. Следовательно, запись не допускается, если документ не существует, а документ не может быть создан, поскольку его не существует. Разделение «записи» на две более конкретные операции — «создание» и «обновление» — решает проблему.

 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;
     }
   }
 }
 

Сгенерированный отчет показывает, как часто использовалось каждое правило и что было возвращено.