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

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

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

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

• ทริกเกอร์ Cloud Firestore และ Realtime Database มีข้อมูลเข้าสู่ระบบเพียงพออยู่แล้วและไม่ต้องมีการตั้งค่าเพิ่มเติม
• API อื่นๆ ทั้งหมด รวมถึง Firebase API เช่น การตรวจสอบสิทธิ์และ FCM หรือ Google API เช่น Cloud Translation หรือ Cloud Speech ต้องมีขั้นตอนการตั้งค่าตามที่อธิบายไว้ในส่วนนี้ ซึ่งจะมีผลไม่ว่าคุณจะใช้ Cloud Functions Shell หรือ 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 ได้ เช่น เมื่อทดสอบทริกเกอร์การตรวจสอบสิทธิ์ ฟังก์ชันที่จำลองอาจเรียกใช้ admin.auth().getUserByEmail(email)

แสดงฟังก์ชันโดยใช้ Shell ของ Cloud Functions

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

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 การใช้งานจะเหมือนกับของโมดูล NPM request แต่แทนที่ 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 ในเครื่อง คุณจะต้องให้ข้อมูลการทดสอบที่เหมาะสม โดยทั่วไปจะหมายถึงการให้ข้อมูลการทดสอบใหม่สำหรับการดำเนินการ 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);

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

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

• สำหรับ Cloud Storage: ObjectMetadata
• สำหรับการตรวจสอบสิทธิ์: UserRecord

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