ทดสอบฟังก์ชันแบบอินเทอร์แอกทีฟ

เชลล์ Cloud Functions มี Shell แบบอินเทอร์แอกทีฟสำหรับการเรียกใช้ ทำงานกับข้อมูลทดสอบ Shell รองรับทริกเกอร์ทุกประเภท

ตั้งค่าข้อมูลเข้าสู่ระบบของผู้ดูแลระบบ (ไม่บังคับ)

หากต้องการให้การทดสอบฟังก์ชันโต้ตอบกับ Google APIs หรือ Firebase อื่นๆ คุณอาจต้องตั้งค่า API ผ่านทาง Firebase Admin SDK ข้อมูลเข้าสู่ระบบของผู้ดูแลระบบ

  • ทริกเกอร์ Cloud Firestore และ Realtime Database มีข้อมูลเข้าสู่ระบบเพียงพออยู่แล้ว และไม่ต้องมีการตั้งค่าเพิ่มเติม
  • API อื่นๆ ทั้งหมด รวมถึง Firebase API เช่น Authentication และ FCM หรือ Google API เช่น Cloud Translation หรือ Cloud Speech ต้องมีขั้นตอนการตั้งค่าตามที่อธิบายไว้ในส่วนนี้ ซึ่งจะมีผลไม่ว่าคุณจะใช้ Shell ของ Cloud Functions หรือ firebase emulators:start

วิธีตั้งค่าข้อมูลเข้าสู่ระบบของผู้ดูแลระบบสำหรับฟังก์ชันจำลอง

  1. เปิด แผงบัญชีบริการ ของคอนโซล Google Cloud
  2. ตรวจสอบว่าได้เลือกบัญชีบริการเริ่มต้น App Engine และใช้ เมนูตัวเลือกทางด้านขวาเพื่อเลือกสร้างคีย์
  3. เมื่อมีข้อความแจ้ง ให้เลือก JSON สำหรับประเภทคีย์ แล้วคลิกสร้าง

  4. ตั้งค่าข้อมูลเข้าสู่ระบบเริ่มต้นของ 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 และ Google APIs ที่ใช้ Admin SDK เช่น เมื่อทำการทดสอบ ทริกเกอร์ Authentication ฟังก์ชันที่จำลองอาจเรียก admin.auth().getUserByEmail(email)

แสดงฟังก์ชันโดยใช้ Shell ฟังก์ชันระบบคลาวด์

เชลล์ Cloud Functions จะจำลองทริกเกอร์ฟังก์ชันทุกประเภทโดยใช้ เชลล์แบบอินเทอร์แอกทีฟสำหรับเรียกใช้ฟังก์ชันที่มีข้อมูลทดสอบ ตัวเลือกจะแตกต่างกันไป ตามประเภทฟังก์ชัน แต่รูปแบบการใช้งานพื้นฐานมีดังนี้

myFunctionName(data, options)

ต้องระบุพารามิเตอร์ data สำหรับ Realtime Database, Cloud Firestore และทริกเกอร์ PubSub และไม่บังคับสำหรับฟังก์ชันประเภทอื่นๆ ทั้งหมด นอกจากนี้ พารามิเตอร์ options ที่ไม่บังคับใช้ได้เฉพาะกับ Realtime Database เท่านั้น และ Cloud Firestore

(ไม่บังคับ) คุณสามารถโหลดข้อมูลทดสอบจาก โดยการบันทึกไฟล์เป็นตัวแปรและเรียกใช้ฟังก์ชันด้วยตัวแปรต่อไปนี้

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

ติดตั้งและกำหนดค่า Shell Cloud Functions

หากต้องการใช้ฟีเจอร์นี้ firebase-tools ต้องมีเวอร์ชัน 3.11.0 ขึ้นไป และ SDK firebase-functions ต้องมีเวอร์ชัน 0.6.2 ขึ้นไป หากต้องการอัปเดตทั้ง 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

สำหรับการเรียกใช้ฟังก์ชัน HTTPS ใน Shell การใช้งานจะเหมือนกับ 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 เป็นพารามิเตอร์ที่ 2 ก็ได้ ค่านี้ต้องเป็นสตริง

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

การจำลอง context.auth ไม่พร้อมใช้งานในขณะนี้

เรียกใช้ฟังก์ชัน Realtime Database

เมื่อเรียกใช้ฟังก์ชัน Realtime Database ในเครื่อง คุณจะต้องให้ข้อมูลต่อไปนี้ ข้อมูลการทดสอบที่เหมาะสม ซึ่งหมายถึงการให้ข้อมูลทดสอบใหม่สำหรับ การดำเนินการ onCreate รายการ ข้อมูลเก่า/ที่นำออกสำหรับการดำเนินการ onDelete รายการ และทั้ง 2 รายการสำหรับ ฟังก์ชัน 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 แล้ว Shell ยังมี params เพื่อจำลองไวลด์การ์ดในเส้นทาง

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

โดยค่าเริ่มต้น Shell จะเรียกใช้ฟังก์ชัน Realtime Database พร้อมกับผู้ดูแลระบบ (บัญชีบริการ) สิทธิ์ ใช้ตัวเลือก auth เพื่อเรียกใช้ฟังก์ชันเฉพาะ ผู้ใช้ปลายทางหรือในฐานะผู้ใช้ที่ไม่ผ่านการตรวจสอบสิทธิ์:

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

เรียกใช้ฟังก์ชัน Firestore

เมื่อเรียกใช้ฟังก์ชัน Firestore ภายในเครื่อง คุณจะต้องใส่ข้อมูลต่อไปนี้ ข้อมูลการทดสอบที่เหมาะสม ซึ่งหมายถึงการให้ข้อมูลทดสอบใหม่สำหรับ การดำเนินการ onCreate รายการ ข้อมูลเก่า/ที่นำออกสำหรับการดำเนินการ onDelete รายการ และทั้ง 2 รายการสำหรับ 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’} })

นอกเหนือจากช่อง before/after ของออบเจ็กต์ data แล้ว คุณสามารถใช้ช่อง params บนออบเจ็กต์ options เพื่อจำลอง ไวลด์การ์ดในชื่อเอกสาร:

# 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'}})

เรียกใช้ฟังก์ชัน Analytics

คุณสามารถเรียกใช้ฟังก์ชัน Analytics ที่ไม่มีข้อมูลได้โดยวิธีต่อไปนี้ ซึ่งเรียกใช้ myAnalyticsFunction() ใน Shell หากต้องการเรียกใช้ฟังก์ชันพร้อมข้อมูลทดสอบ ขอแนะนำให้กำหนดตัวแปรสำหรับ ฟิลด์ข้อมูลเหตุการณ์ที่เฉพาะเจาะจงที่ฟังก์ชันต้องการ ดังนี้

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

เรียกใช้ฟังก์ชันพื้นที่เก็บข้อมูลและการตรวจสอบสิทธิ์

สำหรับฟังก์ชันพื้นที่เก็บข้อมูลและการตรวจสอบสิทธิ์ ให้เรียกใช้ฟังก์ชันภายในด้วยฟังก์ชัน ข้อมูลที่คุณต้องการดูภายในฟังก์ชัน ข้อมูลทดสอบของคุณต้อง มีรูปแบบข้อมูลดังนี้

ระบุเฉพาะฟิลด์ที่โค้ดของคุณอ้างอิง หรือไม่ระบุเลยหากคุณ ที่ต้องการเรียกใช้ฟังก์ชัน