本頁面由 Cloud Translation API 翻譯而成。

以互動方式測試函式

Cloud Functions 殼層提供叫用的互動式殼層包含測試資料的函式殼層支援所有觸發條件類型。

設定管理員憑證 (選用)

如果您希望函式測試與 Google API 或其他 Firebase 互動 API (透過 Firebase Admin SDK) 可能需要設定管理員憑證

Cloud Firestore 和 Realtime Database 觸發條件已有足夠的憑證，且「不需要」進行額外設定。
至於其他所有 API (包括 Authentication 和 FCM 等 Firebase API)，或 Cloud Translation 或 Cloud Speech 等 Google API，都必須完成本節所述的設定步驟。無論使用 Cloud Functions 殼層還是 firebase emulators:start，都適用。

如何為模擬函式設定管理員憑證：

開啟服務帳戶窗格 Google Cloud控制台中就能保留這項資訊
確認已選取 App Engine 個預設服務帳戶，並使用從右側的選項選單選取「Create key」(建立金鑰)。
系統提示時，請選取「JSON」做為金鑰類型，然後按一下「建立」。

將 Google 預設憑證設為指向已下載的金鑰：

Unix

export GOOGLE_APPLICATION_CREDENTIALS="path/to/key.json"
firebase functions:shell

Windows

set GOOGLE_APPLICATION_CREDENTIALS=path\to\key.json
firebase functions:shell

完成這些步驟後，函式測試就能存取 Firebase 和使用 Admin SDK 的 Google API。舉例來說 Authentication 觸發條件，模擬函式可以呼叫 admin.auth().getUserByEmail(email)。

使用 Cloud Functions 殼層提供函式

Cloud Functions 殼層會使用互動式殼層，以使用測試資料叫用函式。可用選項各有不同不同函式類型，但基本使用格式為：

myFunctionName(data, options)

即時資料庫、Cloud Firestore 及data 和 Pub/Sub 觸發條件，對所有其他函式類型而言為選用項目。此外，選用的 options 參數只適用於即時資料庫和 Cloud Firestore 函式

您也可以選擇從本機載入測試資料檔案，方法是將檔案儲存為變數，然後使用檔案叫用函式：

var data = require('./path/to/testData.json');
myFunction(data);

安裝及設定 Cloud Functions 殼層

如要使用這項功能，firebase-tools 的最低版本需求為 3.11.0。以及 firebase-functions SDK 至少須為 0.6.2 版。如要同時更新兩者在專案的 functions/ 目錄中執行下列指令：

npm install --save firebase-functions@latest
npm install -g firebase-tools

如果您使用的是自訂函式設定變數，請先執行指令來取得自訂設定 (在 functions 目錄中執行) 在本機環境中執行：

firebase functions:config:get > .runtimeconfig.json
# If using Windows PowerShell, replace the above with:
# firebase functions:config:get | ac .runtimeconfig.json

最後，使用下列指令執行殼層：

firebase functions:shell

叫用 HTTPS 函式

如要在殼層中叫用 HTTPS 函式，使用方式會與 request NPM 模組，但要取代將 request 替換為您要模擬的函式名稱。例如：

# invoke
myHttpsFunction()
myHttpsFunction.get()
myHttpsFunction.post()

# invoke at sub-path
myHttpsFunction('/path')
myHttpsFunction.get('/path')
myHttpsFunction.post('/path')

# send POST request with form data
myHttpsFunction.post('/path').form( {foo: 'bar' })

叫用 HTTPS 呼叫函式

在本機叫用 HTTPS 呼叫函式時，您必須提供適當的測試資料。

# invoke
myCallableFunction('test data')
myCallableFunction({'foo': 'bar'})

您可以視需要傳入 Firebase-Instance-ID-token 做為第二個參數。必須為字串。

# invoke with FCM registration token
myCallableFunction('test data', {instanceIdToken: 'sample token'})

目前無法模擬「context.auth」。

叫用即時資料庫函式

如要在本機執行即時資料庫函式，您需要提供適當的測試資料這通常意味著您需要為 onCreate 作業、onDelete 作業的舊/移除資料，以及兩者 onUpdate 或 onWrite 函式：

# invoke onCreate function
myDatabaseFunction('new_data')

# invoke onDelete function
myDatabaseFunction('old_data')

# invoke onUpdate or onWrite function
myDatabaseFunction({before: 'old_data', after: 'new_data' })

除了 before/after 選項外，殼層還提供 params 用於模擬路徑中的萬用字元的選項：

# mock wildcards in path, for example: if the path was input/{group}/{id}
myDatabaseFunction('data', {params: {group: 'a', id: 123}})

根據預設，殼層會以管理員 (服務帳戶) 執行即時資料庫函式權限。使用 auth 選項，改為針對特定的函式執行函式或未經驗證的使用者：

# to mock unauthenticated user
myDatabaseFunction('data', {authMode: 'USER'})
# to mock end user
myDatabaseFunction('data', {auth: {uid: 'abcd'}})

叫用 Firestore 函式

如要在本機執行 Firestore 函式，您必須提供適當的測試資料這通常意味著您需要為 onCreate 作業、onDelete 作業的舊/移除資料，以及兩者 onUpdate 或 onWrite 函式。請注意，Firestore 資料鍵/值組合；請參閱支援的資料類型。

# invoke onCreate function
myFirestoreFunction({foo: ‘new’})

# invoke onDelete function
myFirestoreFunction({foo: ‘old’})

# invoke onUpdate or onWrite function
myFirestoreFunction({before: {foo: ‘old’}, after: {foo: ‘new’} })

除了 data 物件的 before/after 欄位外，您可以使用 options 物件的 params 欄位來模擬文件名稱中的萬用字元：

# mock wildcards in document name, for example: if the name was input/{group}/{id}
myFirestoreFunction({foo: ‘new’}, {params: {group: 'a', id: 123}})

殼層一律會執行具備管理員權限的 Firestore 函式，意味著它會模擬建立/更新/刪除事件的方式，就像具備管理員存取權的使用者

叫用 PubSub 函式

如要使用 PubSub 函式，請將訊息酬載插入 Buffer 執行個體，並新增選用資料屬性，如下所示：

// invokes a function with the JSON message { hello: 'world' } and attributes { foo: 'bar' }
myPubsubFunction({data: new Buffer('{"hello":"world"}'), attributes: {foo: 'bar'}})

叫用 Analytics 函式

您可以在沒有任何資料的情況下叫用 Analytics 函式，方法如下：在殼層中執行 myAnalyticsFunction()。如要使用測試資料執行函式，建議您為您的函式需要的特定事件資料欄位：

var data = {
  eventDim: [{
    // populates event.data.params
    params: {foo: {stringValue: 'bar'} },
    // Also valid:
    //   {intValue: '10'}, {floatValue: '1.0'}, {doubleValue: '1.0'}
    // populates event.data.name
    name: 'event_name',
    // populates event.data.logTime, specify in microseconds
    timestampMicros: Date.now() * 1000,
    // populates event.data.previousLogTime, specify in microseconds
    previousTimestampMicros: Date.now() * 1000,
    // populates event.data.reportingDate, specify in 'YYYYMMDD' format
    date: '20170930',
    // populates event.data.valueInUSD
    valueInUsd: 230
  }],
  userDim: userDim
};

myAnalyticsFunction(data);

叫用儲存和驗證函式

如果是儲存和驗證函式，請以並測試您想在函式中看到的資料。您的測試資料必須遵循對應的資料格式：

適用於 Cloud Storage：ObjectMetadata
適用於 Authentication：UserRecord

請只指定程式碼依附的欄位；如果只指定程式碼，則完全不指定執行這個函式