Antes de conectar seu aplicativo ao emulador do Realtime Database, certifique-se de entender o fluxo de trabalho geral do Firebase Local Emulator Suite e de instalar e configurar o Local Emulator Suite e revisar seus comandos CLI .
Escolha um projeto do Firebase
O Firebase Local Emulator Suite emula produtos para um único projeto do Firebase.
Para selecionar o projeto a ser usado, antes de iniciar os emuladores, na CLI, execute firebase use em seu diretório de trabalho. Ou você pode passar o sinalizador --project para cada comando do emulador.
O Local Emulator Suite oferece suporte à emulação de projetos reais do Firebase e projetos de demonstração .
| Tipo de projeto | Características | Use com emuladores |
|---|---|---|
| Real | Um projeto real do Firebase é aquele que você criou e configurou (provavelmente por meio do console do Firebase). Projetos reais têm recursos ativos, como instâncias de banco de dados, intervalos de armazenamento, funções ou qualquer outro recurso configurado para esse projeto do Firebase. | Ao trabalhar com projetos reais do Firebase, você pode executar emuladores para qualquer um ou todos os produtos compatíveis. Para quaisquer produtos que você não esteja emulando, seus aplicativos e código interagirão com o recurso ativo (instância de banco de dados, depósito de armazenamento, função, etc.). |
| Demonstração | Um projeto de demonstração do Firebase não tem configuração real do Firebase nem recursos ativos. Esses projetos geralmente são acessados por meio de codelabs ou outros tutoriais. Os IDs de projeto para projetos de demonstração têm o prefixo | Ao trabalhar com projetos de demonstração do Firebase, seus aplicativos e códigos interagem apenas com emuladores . Se o seu aplicativo tentar interagir com um recurso para o qual um emulador não está em execução, esse código falhará. |
Recomendamos que você use projetos de demonstração sempre que possível. Os benefícios incluem:
- Configuração mais fácil, pois você pode executar os emuladores sem nunca criar um projeto Firebase
- Maior segurança, pois se o seu código invocar acidentalmente recursos não emulados (de produção), não há chance de alteração de dados, utilização e cobrança
- Melhor suporte offline, já que não há necessidade de acesso à internet para baixar a configuração do seu SDK.
Instrumente seu aplicativo para conversar com os emuladores
Android, plataformas Apple e SDKs da Web
Defina sua configuração no aplicativo ou classes de teste para interagir com o Realtime Database da seguinte maneira.
Kotlin+KTX
// 10.0.2.2 is the special IP address to connect to the 'localhost' of
// the host computer from an Android emulator.
val database = Firebase.database
database.useEmulator("10.0.2.2", 9000)
Java
// 10.0.2.2 is the special IP address to connect to the 'localhost' of
// the host computer from an Android emulator.
FirebaseDatabase database = FirebaseDatabase.getInstance();
database.useEmulator("10.0.2.2", 9000);
Rápido
// In almost all cases the ns (namespace) is your project ID.
let db = Database.database(url:"http://127.0.0.1:9000?ns=YOUR_DATABASE_NAMESPACE")
Web modular API
import { getDatabase, connectDatabaseEmulator } from "firebase/database";
const db = getDatabase();
if (location.hostname === "localhost") {
// Point to the RTDB emulator running on localhost.
connectDatabaseEmulator(db, "127.0.0.1", 9000);
} Web namespaced API
var db = firebase.database();
if (location.hostname === "localhost") {
// Point to the RTDB emulator running on localhost.
db.useEmulator("127.0.0.1", 9000);
} Nenhuma configuração adicional é necessária para testar o Cloud Functions acionado por eventos do Realtime Database usando o emulador. Quando os emuladores do Realtime Database e do Cloud Functions estão em execução, eles trabalham juntos automaticamente.
SDKs de administração
Os SDKs Admin do Firebase se conectam automaticamente ao emulador do Realtime Database quando a variável de ambiente FIREBASE_DATABASE_EMULATOR_HOST é definida:
export FIREBASE_DATABASE_EMULATOR_HOST="127.0.0.1:9000"
Se o código estiver em execução dentro do emulador do Cloud Functions, o ID do projeto e outras configurações serão definidos automaticamente ao chamar initializeApp .
Se quiser que o código do SDK Admin se conecte a um emulador compartilhado em execução em outro ambiente, você precisará especificar o mesmo ID do projeto definido usando a CLI do Firebase . Você pode passar um ID de projeto diretamente para initializeApp ou definir a variável de ambiente GCLOUD_PROJECT .
SDK administrativo do Node.js
admin.initializeApp({ projectId: "your-project-id" });
Variável de ambiente
export GCLOUD_PROJECT="your-project-id"
Limpe seu banco de dados entre testes
Para liberar o Realtime Database entre atividades, você pode limpar a referência do banco de dados. Você pode usar essa abordagem como uma alternativa a simplesmente encerrar o processo do emulador.
Kotlin+KTX
// With a DatabaseReference, write null to clear the database. database.reference.setValue(null)
Java
// With a DatabaseReference, write null to clear the database. database.getReference().setValue(null);
Rápido
// With a DatabaseReference, write nil to clear the database.
Database.database().reference().setValue(nil);
Web modular API
import { getDatabase, ref, set } from "firebase/database";
// With a database Reference, write null to clear the database.
const db = getDatabase();
set(ref(db), null);Web namespaced API
// With a database Reference, write null to clear the database. firebase.database().ref().set(null);
Naturalmente, seu código deve aguardar a confirmação de que a liberação foi concluída ou falhou usando os recursos de manipulação de eventos assíncronos da sua plataforma.
Tendo implementado uma etapa como essa, você pode sequenciar seus testes e acionar suas funções com a confiança de que os dados antigos serão eliminados entre as execuções e você estará usando uma nova configuração de teste de linha de base.
Importar e exportar dados
O banco de dados e os emuladores do Cloud Storage para Firebase permitem exportar dados de uma instância do emulador em execução. Defina um conjunto básico de dados para usar em seus testes de unidade ou fluxos de trabalho de integração contínua e, em seguida, exporte-os para serem compartilhados entre a equipe.
firebase emulators:export ./dir
Nos testes, na inicialização do emulador, importe os dados da linha de base.
firebase emulators:start --import=./dir
Você pode instruir o emulador a exportar dados no desligamento, especificando um caminho de exportação ou simplesmente usando o caminho passado para o sinalizador --import .
firebase emulators:start --import=./dir --export-on-exit
Essas opções de importação e exportação de dados também funcionam com o comando firebase emulators:exec . Para obter mais informações, consulte a referência do comando do emulador .
Visualize a atividade das regras de segurança
À medida que você trabalha nos protótipos e nos loops de teste, você pode usar ferramentas de visualização e relatórios fornecidos pelo Local Emulator Suite.
Visualizar avaliações de regras
Ao adicionar regras de segurança ao seu protótipo, você pode depurá-las com as ferramentas do Local Emulator Suite.
Depois de executar um conjunto de testes, você poderá acessar relatórios de cobertura de testes que mostram como cada uma de suas regras foi avaliada. Para obter os relatórios, consulte um ponto de extremidade exposto no emulador enquanto ele estiver em execução. Para uma versão amigável ao navegador, use o seguinte URL:
http://localhost:9000/.inspect/coverage?ns=<database_name>
Isso divide suas regras em expressões e subexpressões que você pode passar o mouse para obter mais informações, incluindo o número de execuções e valores retornados. Para a versão JSON bruta desses dados, inclua o seguinte URL na sua consulta:
http://localhost:9000/.inspect/coverage.json?ns=<database_name>
Qual o proximo?
- Para ver um conjunto selecionado de vídeos e exemplos detalhados de instruções, siga a lista de reprodução de treinamento do Firebase Emulators .
- Investigue casos de uso avançados envolvendo testes de regras de segurança e o Firebase Test SDK: Test Security Rules (Realtime Database) .
- Como as funções acionadas são uma integração típica com o Realtime Database, saiba mais sobre o emulador do Cloud Functions para Firebase em Executar funções localmente .