交互式測試功能

Cloud Functions shell 提供了一個交互式 shell,用於使用測試數據調用函數。 shell 支持所有觸發器類型。

設置管理員憑據(可選)

如果您希望您的函數測試通過Firebase Admin SDK與 Google API 或其他 Firebase API 交互,您可能需要設置管理員憑據。

  • Cloud Firestore 和實時數據庫觸發器已經有足夠的憑據,不需要額外設置。
  • 所有其他 API,包括 Firebase API(例如身份驗證和 FCM)或 Google API(例如 Cloud Translation 或 Cloud Speech)都需要本節中描述的設置步驟。無論您使用的是函數 shell 還是firebase emulators:start ,這都適用。

要為模擬函數設置管理員憑據:

  1. 打開 Google Cloud Console 的服務帳戶窗格
  2. 確保選擇App Engine 默認服務帳戶,並使用右側的選項菜單選擇Create key
  3. 出現提示時,選擇JSON作為密鑰類型,然後單擊Create
  4. 將您的 Google 默認憑據設置為指向下載的密鑰:

    Unix

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

    視窗

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

完成這些步驟後,您的函數測試可以使用Admin SDK訪問 Firebase 和 Google API。例如,在測試身份驗證觸發器時,模擬函數可以調用admin.auth().getUserByEmail(email)

使用 Cloud Functions shell 提供函數

Cloud Functions shell 使用交互式 shell 模擬所有類型的函數觸發器,以使用測試數據調用函數。選項因函數類型而異,但基本使用格式為:

myFunctionName(data, options)

data參數對於實時數據庫、Cloud Firestore 和 PubSub 觸發器是必需的,對於所有其他函數類型是可選的。此外,可選的options參數僅對實時數據庫和 Cloud Firestore 函數有效。

或者,您可以通過將文件保存為變量並使用它調用函數來從本地文件加載測試數據:

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

安裝和配置 Cloud Functions shell

要使用此功能, firebase-tools必須具有最低版本 3.11.0,firebase 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

最後,使用以下命令運行 shell:

firebase functions:shell

調用 HTTPS 函數

在 shell 中調用 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操作提供舊的/刪除的數據,以及為onUpdateonWrite函數提供:

# 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選項之外,shell 還提供了params選項來模擬路徑中的通配符:

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

默認情況下,shell 以管理員(服務帳戶)權限運行實時數據庫函數。使用auth選項以特定最終用戶或未經身份驗證的用戶身份運行函數:

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

調用 Firestore 函數

在本地運行 Firestore 函數時,您需要提供適當的測試數據。這通常意味著為onCreate操作提供新的測試數據,為onDelete操作提供舊的/刪除的數據,以及為onUpdateonWrite函數提供。請注意,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}})

Shell 始終以管理權限運行 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'}})

調用分析函數

您可以通過在 shell 中運行myAnalyticsFunction()來調用沒有任何數據的 Analytics 函數。要使用測試數據運行函數,建議為函數所需的特定事件數據字段定義一個變量:

var data = {
  eventDim: [{
    // populates event.data.params
    params:{foo:'bar'},
    // 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);

調用 Storage 和 Auth 函數

對於 Storage 和 Auth 函數,使用您希望在函數內部看到的測試數據調用本地函數。您的測試數據必須遵循相應的數據格式:

僅指定您的代碼所依賴的字段,或者如果您只想運行該函數,則根本不指定。