## はじめに
先日実務でGoとfirebaseエミュレータを使ったテストを実装しようとしたのですが、Goが組み合わさるとあまり記事が見当たりませんでした。そこで今回はGoでfirebaseエミュレータを実装する方法をご紹介します。

## この記事でわかること
- firebaseエミュレータのセットアップ方法
- Goでfirebaseエミュレータを利用する方法
  - firebaseエミュレータはUI、Authentication、Firestoreに接続する

## セットアップ
firebaseを利用しているので[Firebase CLI](https://firebase.google.com/docs/cli?hl=ja#setup_update_cli)はインストール済みである前提とします。次にエミュレータをインストールします。[公式](https://firebase.google.com/docs/emulator-suite/install_and_configure?hl=ja#install_the_local_emulator_suite)に手順が記載されています。

**バージョン確認**
インストールにはCLI バージョン 8.14.0以降が必要なため確認。

![img](/mosaic-code.jpg)


**初期化**
エミュレータを利用するように指定して現在の作業ディレクトリを Firebase プロジェクトとして初期化します。
![img](/mosaic-code.jpg)
今回はAuthenticationとFirestoreを利用するのでこんな感じになります。
![img](/mosaic-code.jpg)

`firebase.json`は手動で編集しても問題ないので、portを変更したくなったら直接編集しても構いません。

ちなみに[デフォルト](https://firebase.google.com/docs/emulator-suite/install_and_configure?hl=ja#port_configuration)で提供されているエミュレータのportは以下です。
![](https://storage.googleapis.com/zenn-user-upload/3ec79de5754f-20220314.png)

今回は詳しく扱いませんが、セキュリティルールの設定も`firebase.json`で設定することが可能です。詳しくは詳しくは[セキュリティ ルールの構成](https://firebase.google.com/docs/emulator-suite/install_and_configure?hl=ja#security_rules_configuration)でご確認ください。

## エミュレータ起動

それでは実際にエミュレータを起動してみましょう！下記コマンドを入力してください。
以下のように起動すれば成功です！

**ターミナル1**
![img](/mosaic-code.jpg)

### log系のファイルはgitignoreする
エミュレータ起動時にロギングされるファイルはGithubなどにあげる必要はないので、`.gitignore`ファイルに追加しておきましょう。
![img](/mosaic-code.jpg)

### uiの確認
port4000で指定しているので`http://localhost:4000/`でアクセスできます。

**エミュレータ一覧画面**
どのエミュレータが起動しているのか確認できます。
![](https://storage.googleapis.com/zenn-user-upload/f5aaefee9065-20220314.png)

**Authentication emulator**
![](https://storage.googleapis.com/zenn-user-upload/99b487b541fe-20220314.png)

**Firestore emulator**
![](https://storage.googleapis.com/zenn-user-upload/816620fe64ef-20220314.png)

## Goテストの実行
adminSDKを利用している場合、エミュレータへfitebaseの参照先をエミュレータに変えるにはそれぞれのサービスごとの**環境変数**を指定する必要があります。各サービスとエミュレータに接続するために指定すべき変数は下記になります。

**Authエミュレータを使うにはGo admin SDKを`v4`にあげる必要があります**
Goのadmin SDKライブラリである[firebase-admin-go](https://github.com/firebase/firebase-admin-go)ではAuthenticationエミュレータの接続先環境変数の`FIREBASE_AUTH_EMULATOR_HOST`が[V4.2.0](https://github.com/firebase/firebase-admin-go/releases/tag/v4.2.0)で認識されるようになりました。上げていない方は`firebase-admin-go`のバージョンを事前にv4に上げておきましょう。
|                   | 環境変数                        | 
| ----------------- | :----------------------------- | 
| Authentication    | FIREBASE_AUTH_EMULATOR_HOST✅     | 
| Realtime Database | FIREBASE_DATABASE_EMULATOR_HOST | 
| Cloud Firestore   | FIRESTORE_EMULATOR_HOST✅         | 
| Cloud Storage     | FIREBASE_STORAGE_EMULATOR_HOST  | 

今回はAuthとFirestoreのエミュレータに接続したいので✅ 部分をテストを実行するディレクトリで指定します。

**ターミナル2**
ターミナル1ではエミュレータを起動しているのでターミナル2で環境変数の設定を行います。
![img](/mosaic-code.jpg)

**ターミナル2**
向き先を変えたら、あとはいつも通りGoのテストを実行してみましょう！作成・削除・更新などの処理が反映されると思います🎉
![img](/mosaic-code.jpg)

## 終わりに
今回はGoでfirebaseでエミュレータを利用する方法を書きました。今後はエミュレータをStorageやFunctionsに接続した記事も実装してまたご紹介できればと思います。


## トラブルシューティング
- エミュレータの起動やシャットダウンはやや時間がかかり、プロセスが彷徨うことがあります。その場合は@cotaponさんの書いた[記事](https://zenn.dev/cotapon/scraps/032866ce34abc0#comment-c26332cf3e1115)のようにプロセスをkillしてみましょう。

## はじめに
先日実務でGoとfirebaseエミュレータを使ったテストを実装しようとしたのですが、Goが組み合わさるとあまり記事が見当たりませんでした。そこで今回はGoでfirebaseエミュレータを実装する方法をご紹介します。

## この記事でわかること
- firebaseエミュレータのセットアップ方法
- Goでfirebaseエミュレータを利用する方法
  - firebaseエミュレータはUI、Authentication、Firestoreに接続する

## セットアップ
firebaseを利用しているので[Firebase CLI](https://firebase.google.com/docs/cli?hl=ja#setup_update_cli)はインストール済みである前提とします。次にエミュレータをインストールします。[公式](https://firebase.google.com/docs/emulator-suite/install_and_configure?hl=ja#install_the_local_emulator_suite)に手順が記載されています。

**バージョン確認**
インストールにはCLI バージョン 8.14.0以降が必要なため確認。

```shell
firebase --version
```


**初期化**
エミュレータを利用するように指定して現在の作業ディレクトリを Firebase プロジェクトとして初期化します。
```shell
firebase init
```
今回はAuthenticationとFirestoreを利用するのでこんな感じになります。
```shell
=== Emulators Setup
? Which Firebase emulators do you want to set up? Press Space to select emulators, then Enter to confirm your choices. (Press <space> to select, <a> to toggle all, <i> to in
vert selection)
❯◉ Authentication Emulator  
 ◯ Functions Emulator
 ◉ Firestore Emulator
 ◯ Database Emulator
 ◯ Hosting Emulator
 ◯ Pub/Sub Emulator
 ◯ Storage Emulator

// ↓選択し終わるとportなどの設置に移ります↓ // 

// portはデフォルト値で問題ありません。
? Which Firebase emulators do you want to set up? Press Space to select emulators, then Enter to confirm your choices. Authentication Emulator, Firestore Emulator
? Which port do you want to use for the auth emulator? 9099
? Which port do you want to use for the firestore emulator? 8080
? Would you like to enable the Emulator UI? Yes
? Which port do you want to use for the Emulator UI (leave empty to use any available port)?
? Would you like to download the emulators now? (y/N)  // y(yes)と答えてエミュレータをインストールします


// ↓設定内容が作業ディレクトリにダウンロードされます↓ //

i  Writing configuration info to firebase.json...  // firebase.jsonに設定した接続情報が記載されます。
i  Writing project information to .firebaserc...

✔  Firebase initialization complete!

```

`firebase.json`は手動で編集しても問題ないので、portを変更したくなったら直接編集しても構いません。

ちなみに[デフォルト](https://firebase.google.com/docs/emulator-suite/install_and_configure?hl=ja#port_configuration)で提供されているエミュレータのportは以下です。
![](https://storage.googleapis.com/zenn-user-upload/3ec79de5754f-20220314.png)

今回は詳しく扱いませんが、セキュリティルールの設定も`firebase.json`で設定することが可能です。詳しくは詳しくは[セキュリティ ルールの構成](https://firebase.google.com/docs/emulator-suite/install_and_configure?hl=ja#security_rules_configuration)でご確認ください。

## エミュレータ起動

それでは実際にエミュレータを起動してみましょう！下記コマンドを入力してください。
以下のように起動すれば成功です！

**ターミナル1**
```shell
firebase emulators:start.

$ firebase emulators:start
i  emulators: Starting emulators: auth, firestore
⚠  firestore: Did not find a Cloud Firestore rules file specified in a firebase.json config file.
⚠  firestore: The emulator will default to allowing all reads and writes. Learn more about this option: https://firebase.google.com/docs/emulator-suite/install_and_configure#security_rules_configuration.
i  firestore: Firestore Emulator logging to firestore-debug.log
i  ui: Emulator UI logging to ui-debug.log

┌─────────────────────────────────────────────────────────────┐
│ ✔  All emulators ready! It is now safe to connect your app. │
│ i  View Emulator UI at http://localhost:4000                │
└─────────────────────────────────────────────────────────────┘

┌────────────────┬────────────────┬─────────────────────────────────┐
│ Emulator       │ Host:Port      │ View in Emulator UI             │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Authentication │ localhost:9099 │ http://localhost:4000/auth      │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Firestore      │ localhost:8080 │ http://localhost:4000/firestore │
└────────────────┴────────────────┴─────────────────────────────────┘
  Emulator Hub running at localhost:4400
  Other reserved ports: 4500

Issues? Report them at https://github.com/firebase/firebase-tools/issues and attach the *-debug.log files.
```

### log系のファイルはgitignoreする
エミュレータ起動時にロギングされるファイルはGithubなどにあげる必要はないので、`.gitignore`ファイルに追加しておきましょう。
```gitignore
### Firebase Emulator ###
firebase-debug.log
firestore-debug.log
ui-debug.log
```

### uiの確認
port4000で指定しているので`http://localhost:4000/`でアクセスできます。

**エミュレータ一覧画面**
どのエミュレータが起動しているのか確認できます。
![](https://storage.googleapis.com/zenn-user-upload/f5aaefee9065-20220314.png)

**Authentication emulator**
![](https://storage.googleapis.com/zenn-user-upload/99b487b541fe-20220314.png)

**Firestore emulator**
![](https://storage.googleapis.com/zenn-user-upload/816620fe64ef-20220314.png)

## Goテストの実行
adminSDKを利用している場合、エミュレータへfitebaseの参照先をエミュレータに変えるにはそれぞれのサービスごとの**環境変数**を指定する必要があります。各サービスとエミュレータに接続するために指定すべき変数は下記になります。

**Authエミュレータを使うにはGo admin SDKを`v4`にあげる必要があります**
Goのadmin SDKライブラリである[firebase-admin-go](https://github.com/firebase/firebase-admin-go)ではAuthenticationエミュレータの接続先環境変数の`FIREBASE_AUTH_EMULATOR_HOST`が[V4.2.0](https://github.com/firebase/firebase-admin-go/releases/tag/v4.2.0)で認識されるようになりました。上げていない方は`firebase-admin-go`のバージョンを事前にv4に上げておきましょう。
|                   | 環境変数                        | 
| ----------------- | :----------------------------- | 
| Authentication    | FIREBASE_AUTH_EMULATOR_HOST✅     | 
| Realtime Database | FIREBASE_DATABASE_EMULATOR_HOST | 
| Cloud Firestore   | FIRESTORE_EMULATOR_HOST✅         | 
| Cloud Storage     | FIREBASE_STORAGE_EMULATOR_HOST  | 

今回はAuthとFirestoreのエミュレータに接続したいので✅ 部分をテストを実行するディレクトリで指定します。

**ターミナル2**
ターミナル1ではエミュレータを起動しているのでターミナル2で環境変数の設定を行います。
```shell
export FIREBASE_AUTH_EMULATOR_HOST=localhost:9099  // Authenticationエミュレータが起動しているホスト
export FIRESTORE_EMULATOR_HOST=localhost:8099  // Firestoreエミュレータが起動しているホスト
```

**ターミナル2**
向き先を変えたら、あとはいつも通りGoのテストを実行してみましょう！作成・削除・更新などの処理が反映されると思います🎉
```shell
go test -v ./...
```

## 終わりに
今回はGoでfirebaseでエミュレータを利用する方法を書きました。今後はエミュレータをStorageやFunctionsに接続した記事も実装してまたご紹介できればと思います。


## トラブルシューティング
- エミュレータの起動やシャットダウンはやや時間がかかり、プロセスが彷徨うことがあります。その場合は@cotaponさんの書いた[記事](https://zenn.dev/cotapon/scraps/032866ce34abc0#comment-c26332cf3e1115)のようにプロセスをkillしてみましょう。

はじめに

この記事でわかること

続きを読むには単価診断を受けてください 30秒