Cloud Functions की यूनिट टेस्टिंग

इस पेज पर आपके फ़ंक्शन के लिए, यूनिट टेस्ट लिखने के सबसे सही तरीकों और टूल के बारे में बताया गया है. उदाहरण के लिए, ऐसे टेस्ट जो कंटिन्यूअस इंटिग्रेशन (सीआई) सिस्टम का हिस्सा होंगे. टेस्टिंग को आसान बनाने के लिए, Firebase Cloud Functions के लिए Firebase Test SDK उपलब्ध कराता है. इसे npm पर firebase-functions-test के तौर पर डिस्ट्रिब्यूट किया जाता है. यह firebase-functions के लिए एक साथ काम करने वाला टेस्ट SDK टूल है. Cloud Functions के लिए Firebase Test SDK:

  • यह आपके टेस्ट के लिए, सही सेटअप और टियरडाउन का ध्यान रखता है. जैसे, firebase-functions के लिए ज़रूरी एनवायरमेंट वैरिएबल को सेट करना और अनसेट करना.
  • सैंपल डेटा और इवेंट कॉन्टेक्स्ट जनरेट करता है, ताकि आपको सिर्फ़ उन फ़ील्ड की जानकारी देनी पड़े जो आपके टेस्ट के लिए काम के हैं.

सेटअप की जांच करें

अपने फ़ंक्शन फ़ोल्डर में ये निर्देश चलाकर, firebase-functions-test और जांच के लिए इस्तेमाल होने वाले फ़्रेमवर्क Mocha, दोनों को इंस्टॉल करें:

npm install --save-dev firebase-functions-test
npm install --save-dev mocha

इसके बाद, फ़ंक्शन फ़ोल्डर में test फ़ोल्डर बनाएं. इसके बाद, अपने टेस्ट कोड के लिए उसमें एक नई फ़ाइल बनाएं और उसे index.test.js जैसा कोई नाम दें.

आखिर में, इन्हें जोड़ने के लिए functions/package.json में बदलाव करें:

"scripts": {
  "test": "mocha --reporter spec"
}

टेस्ट लिखने के बाद, उन्हें चलाया जा सकता है. इसके लिए, अपनी फ़ंक्शन डायरेक्ट्री में npm test चलाएं.

Cloud Functions के लिए Firebase Test SDK शुरू किया जा रहा है

firebase-functions-test को इस्तेमाल करने के दो तरीके हैं:

  1. ऑनलाइन मोड (इसका सुझाव दिया जाता है): ऐसे टेस्ट लिखें जो टेस्टिंग के लिए बने Firebase प्रोजेक्ट के साथ इंटरैक्ट करें, ताकि डेटाबेस में डेटा लिखा जाए, उपयोगकर्ता बनाया जाए वगैरह. साथ ही, आपका टेस्ट कोड नतीजों की जांच कर सके. इसका मतलब यह भी है कि आपके फ़ंक्शन में इस्तेमाल किए गए अन्य Google SDK टूल भी काम करेंगे.
  2. ऑफ़लाइन मोड: बिना किसी खराब असर के, सिलो और ऑफ़लाइन यूनिट टेस्ट लिखें. इसका मतलब है कि Firebase प्रॉडक्ट (उदाहरण के लिए, डेटाबेस में लिखना या उपयोगकर्ता बनाना) के साथ इंटरैक्ट करने वाले किसी भी तरीके को स्टब किया जाना चाहिए. आम तौर पर, Cloud Firestore या Realtime Database फ़ंक्शन होने पर, ऑफ़लाइन मोड का इस्तेमाल करने का सुझाव नहीं दिया जाता. इसकी वजह यह है कि इससे आपके टेस्ट कोड की जटिलता बहुत बढ़ जाती है.

ऑनलाइन मोड में SDK टूल शुरू करें (सुझाया गया)

अगर आपको किसी टेस्ट प्रोजेक्ट के साथ इंटरैक्ट करने वाले टेस्ट लिखने हैं, तो आपको प्रोजेक्ट कॉन्फ़िगरेशन की वे वैल्यू देनी होंगी जो firebase-admin की मदद से ऐप्लिकेशन को शुरू करने के लिए ज़रूरी हैं. साथ ही, आपको सेवा खाते की कुंजी वाली फ़ाइल का पाथ भी उपलब्ध कराना होगा.

अपने Firebase प्रोजेक्ट की कॉन्फ़िगरेशन वैल्यू पाने के लिए:

  1. Firebase कंसोल में जाकर, अपने प्रोजेक्ट की सेटिंग खोलें.
  2. आपके ऐप्लिकेशन में जाकर, अपनी पसंद का ऐप्लिकेशन चुनें.

  3. दाएं पैनल में, Apple और Android ऐप्लिकेशन के लिए कॉन्फ़िगरेशन फ़ाइल डाउनलोड करने का विकल्प चुनें.

    वेब ऐप्लिकेशन की कॉन्फ़िगरेशन वैल्यू दिखाने के लिए, कॉन्फ़िगरेशन चुनें.

पासकोड फ़ाइल बनाने के लिए:

  1. Google Cloud कंसोल का सेवा खाते वाला पैनल खोलें.
  2. App Engine डिफ़ॉल्ट सेवा खाता चुनें. इसके बाद, दाईं ओर मौजूद विकल्प मेन्यू का इस्तेमाल करके, पासकोड बनाएं को चुनें.
  3. जब कहा जाए, तब कुंजी के टाइप के लिए JSON चुनें और बनाएं पर क्लिक करें.

कुंजी फ़ाइल सेव करने के बाद, SDK टूल शुरू करें:

// At the top of test/index.test.js
const test = require('firebase-functions-test')({
  databaseURL: 'https://my-project.firebaseio.com',
  storageBucket: 'my-project.appspot.com',
  projectId: 'my-project',
}, 'path/to/serviceAccountKey.json');

SDK टूल को ऑफ़लाइन मोड में शुरू करना

अगर आपको पूरी तरह से ऑफ़लाइन टेस्ट लिखने हैं, तो किसी भी पैरामीटर के बिना SDK को शुरू किया जा सकता है:

// At the top of test/index.test.js
const test = require('firebase-functions-test')();

कॉन्फ़िगरेशन वैल्यू को मॉक करना

अपने फ़ंक्शन कोड में functions.config() का इस्तेमाल करने पर, कॉन्फ़िगरेशन वैल्यू का मॉक किया जा सकता है. उदाहरण के लिए, अगर functions/index.js में यह कोड शामिल है:

const functions = require('firebase-functions/v1');
const key = functions.config().stripe.key;

फिर आप अपनी टेस्ट फ़ाइल के अंदर मौजूद वैल्यू की नकल कर सकते हैं, जैसे:

// Mock functions config values
test.mockConfig({ stripe: { key: '23wr42ewr34' }});

फ़ंक्शन इंपोर्ट करना

फ़ंक्शन इंपोर्ट करने के लिए, require का इस्तेमाल करके मुख्य फ़ंक्शन फ़ाइल को मॉड्यूल के तौर पर इंपोर्ट करें. firebase-functions-test को शुरू करने और कॉन्फ़िगरेशन वैल्यू को मॉक करने के बाद ही ऐसा करें.

// after firebase-functions-test has been initialized
const myFunctions = require('../index.js'); // relative path to functions code

अगर आपने firebase-functions-test को ऑफ़लाइन मोड में शुरू किया है और आपके फ़ंक्शन कोड में admin.initializeApp() है, तो आपको अपने फ़ंक्शन इंपोर्ट करने से पहले, उसे स्टब करना होगा:

// If index.js calls admin.initializeApp at the top of the file,
// we need to stub it out before requiring index.js. This is because the
// functions will be executed as a part of the require process.
// Here we stub admin.initializeApp to be a dummy function that doesn't do anything.
adminInitStub = sinon.stub(admin, 'initializeApp');
// Now we can require index.js and save the exports inside a namespace called myFunctions.
myFunctions = require('../index');
test.offline.js

बैकग्राउंड (नॉन-एचटीटीपी) फ़ंक्शन की जांच करना

बिना एचटीटीपी फ़ंक्शन की जांच करने के लिए, ये चरण अपनाएं:

  1. उस फ़ंक्शन को रैप करें जिसकी आपको test.wrap तरीके से जांच करनी है
  2. टेस्ट डेटा बनाना
  3. अपने बनाए गए टेस्ट डेटा और उन सभी इवेंट कॉन्टेक्स्ट फ़ील्ड के साथ रैप किए गए फ़ंक्शन को लागू करें जिन्हें आपको बताना है.
  4. व्यवहार के बारे में दावे करें.

सबसे पहले, उस फ़ंक्शन को रैप करें जिसकी आपको जांच करनी है. मान लें कि आपके पास functions/index.js में makeUppercase नाम का एक फ़ंक्शन है, जिसे टेस्ट करना है. यह जानकारी functions/test/index.test.js में लिखें

// "Wrap" the makeUpperCase function from index.js
const myFunctions = require('../index.js');
const wrapped = test.wrap(myFunctions.makeUppercase);

wrapped एक ऐसा फ़ंक्शन है जो कॉल किए जाने पर makeUppercase को शुरू करता है. wrapped दो पैरामीटर लेता है:

  1. data (ज़रूरी है): makeUppercase को भेजा जाने वाला डेटा. यह सीधे तौर पर, आपके लिखे गए फ़ंक्शन हैंडलर में भेजे गए पहले पैरामीटर से जुड़ा होता है. firebase-functions-test कस्टम डेटा या उदाहरण डेटा बनाने के तरीके उपलब्ध कराता है.
  2. eventContextOptions (ज़रूरी नहीं): इवेंट कॉन्टेक्स्ट के ऐसे फ़ील्ड जिनके बारे में आपको बताना है. इवेंट कॉन्टेक्स्ट, आपके लिखे गए फ़ंक्शन हैंडलर को भेजा जाने वाला दूसरा पैरामीटर होता है. अगर wrapped को कॉल करते समय कोई eventContextOptions पैरामीटर शामिल नहीं किया जाता है, तो भी काम के फ़ील्ड के साथ इवेंट कॉन्टेक्स्ट जनरेट होता है. जनरेट किए गए कुछ फ़ील्ड को बदला जा सकता है. इसके लिए, यहां उन फ़ील्ड की जानकारी दें. ध्यान दें कि आपको सिर्फ़ वे फ़ील्ड शामिल करने हैं जिन्हें आपको बदलना है. आपने जिन फ़ील्ड को बदला नहीं है वे जनरेट हो जाते हैं.
const data = … // See next section for constructing test data

// Invoke the wrapped function without specifying the event context.
wrapped(data);

// Invoke the function, and specify params
wrapped(data, {
  params: {
    pushId: '234234'
  }
});

// Invoke the function, and specify auth and auth Type (for real time database functions only)
wrapped(data, {
  auth: {
    uid: 'jckS2Q0'
  },
  authType: 'USER'
});

// Invoke the function, and specify all the fields that can be specified
wrapped(data, {
  eventId: 'abc',
  timestamp: '2018-03-23T17:27:17.099Z',
  params: {
    pushId: '234234'
  },
  auth: {
    uid: 'jckS2Q0' // only for real time database functions
  },
  authType: 'USER' // only for real time database functions
});

टेस्ट डेटा बनाना

रैप किए गए फ़ंक्शन का पहला पैरामीटर, टेस्ट डेटा होता है. इसका इस्तेमाल, बुनियादी फ़ंक्शन को कॉल करने के लिए किया जाता है. टेस्ट डेटा बनाने के कई तरीके हैं.

कस्टम डेटा का इस्तेमाल करना

firebase-functions-test में ऐसे कई फ़ंक्शन हैं जिनका इस्तेमाल करके, अपने फ़ंक्शन की जांच के लिए ज़रूरी डेटा बनाया जा सकता है. उदाहरण के लिए, Firestore DocumentSnapshot बनाने के लिए test.firestore.makeDocumentSnapshot का इस्तेमाल करें. पहला आर्ग्युमेंट डेटा होता है और दूसरा आर्ग्युमेंट पूरा रेफ़रंस पाथ होता है. साथ ही, स्नैपशॉट की अन्य प्रॉपर्टी के लिए, तीसरा आर्ग्युमेंट भी दिया जा सकता है. हालांकि, यह आर्ग्युमेंट देना ज़रूरी नहीं है.

// Make snapshot
const snap = test.firestore.makeDocumentSnapshot({foo: 'bar'}, 'document/path');
// Call wrapped function with the snapshot
const wrapped = test.wrap(myFunctions.myFirestoreDeleteFunction);
wrapped(snap);

अगर onUpdate या onWrite फ़ंक्शन की जांच की जा रही है, तो आपको दो स्नैपशॉट बनाने होंगे: एक, पहले की स्थिति के लिए और दूसरा, बाद की स्थिति के लिए. इसके बाद, इन स्नैपशॉट की मदद से Change ऑब्जेक्ट बनाने के लिए, makeChange तरीके का इस्तेमाल किया जा सकता है.

// Make snapshot for state of database beforehand
const beforeSnap = test.firestore.makeDocumentSnapshot({foo: 'bar'}, 'document/path');
// Make snapshot for state of database after the change
const afterSnap = test.firestore.makeDocumentSnapshot({foo: 'faz'}, 'document/path');
const change = test.makeChange(beforeSnap, afterSnap);
// Call wrapped function with the Change object
const wrapped = test.wrap(myFunctions.myFirestoreUpdateFunction);
wrapped(change);

अन्य सभी डेटा टाइप के लिए मिलते-जुलते फ़ंक्शन के बारे में जानने के लिए, एपीआई रेफ़रंस देखें.

उदाहरण के तौर पर दिए गए डेटा का इस्तेमाल करना

अगर आपको अपने टेस्ट में इस्तेमाल किए गए डेटा में बदलाव करने की ज़रूरत नहीं है, तो firebase-functions-test में हर फ़ंक्शन टाइप के लिए उदाहरण के तौर पर डेटा जनरेट करने के तरीके दिए गए हैं.

// For Firestore onCreate or onDelete functions
const snap = test.firestore.exampleDocumentSnapshot();
// For Firestore onUpdate or onWrite functions
const change = test.firestore.exampleDocumentSnapshotChange();

हर फ़ंक्शन टाइप के लिए डेटा के उदाहरण पाने के तरीकों के बारे में जानने के लिए, एपीआई का संदर्भ देखें.

ऑफ़लाइन मोड के लिए, स्टब किए गए डेटा का इस्तेमाल करना

अगर आपने SDK टूल को ऑफ़लाइन मोड में शुरू किया है और Cloud Firestore या Realtime Database फ़ंक्शन की जांच की जा रही है, तो आपको असल DocumentSnapshot या DataSnapshot बनाने के बजाय, स्टब के साथ एक साधारण ऑब्जेक्ट का इस्तेमाल करना चाहिए.

मान लें कि आपको इस फ़ंक्शन के लिए यूनिट टेस्ट लिखना है:

// Listens for new messages added to /messages/:pushId/original and creates an
// uppercase version of the message to /messages/:pushId/uppercase
exports.makeUppercase = functions.database.ref('/messages/{pushId}/original')
    .onCreate((snapshot, context) => {
      // Grab the current value of what was written to the Realtime Database.
      const original = snapshot.val();
      functions.logger.log('Uppercasing', context.params.pushId, original);
      const uppercase = original.toUpperCase();
      // You must return a Promise when performing asynchronous tasks inside a Functions such as
      // writing to the Firebase Realtime Database.
      // Setting an "uppercase" sibling in the Realtime Database returns a Promise.
      return snapshot.ref.parent.child('uppercase').set(uppercase);
    });
index.js

फ़ंक्शन के अंदर, snap का इस्तेमाल दो बार किया गया है:

  • snap.val()
  • snap.ref.parent.child('uppercase').set(uppercase)

टेस्ट कोड में, एक प्लेन ऑब्जेक्ट बनाएं जहां ये दोनों कोड पाथ काम करेंगे. साथ ही, तरीकों को स्टब करने के लिए Sinon का इस्तेमाल करें.

// The following lines creates a fake snapshot, 'snap', which returns 'input' when snap.val() is called,
// and returns true when snap.ref.parent.child('uppercase').set('INPUT') is called.
const snap = {
  val: () => 'input',
  ref: {
    parent: {
      child: childStub,
    }
  }
};
childStub.withArgs(childParam).returns({ set: setStub });
setStub.withArgs(setParam).returns(true);
test.offline.js

दावे करना

SDK टूल को शुरू करने, फ़ंक्शन को रैप करने, और डेटा बनाने के बाद, रैप किए गए फ़ंक्शन को बनाए गए डेटा के साथ शुरू किया जा सकता है और उनके व्यवहार के बारे में जानकारी दी जा सकती है. ये दावे करने के लिए, Chai जैसी लाइब्रेरी का इस्तेमाल किया जा सकता है.

ऑनलाइन मोड में दावे करना

अगर आपने Cloud Functions के लिए Firebase Test SDK को ऑनलाइन मोड में शुरू किया है, तो firebase-admin SDK टूल का इस्तेमाल करके यह दावा किया जा सकता है कि डेटाबेस में लिखने जैसी ज़रूरी कार्रवाइयां की गई हैं.

नीचे दिए गए उदाहरण से पता चलता है कि 'INPUT' को टेस्ट प्रोजेक्ट के डेटाबेस में लिखा गया है.

// Create a DataSnapshot with the value 'input' and the reference path 'messages/11111/original'.
const snap = test.database.makeDataSnapshot('input', 'messages/11111/original');

// Wrap the makeUppercase function
const wrapped = test.wrap(myFunctions.makeUppercase);
// Call the wrapped function with the snapshot you constructed.
return wrapped(snap).then(() => {
  // Read the value of the data at messages/11111/uppercase. Because `admin.initializeApp()` is
  // called in functions/index.js, there's already a Firebase app initialized. Otherwise, add
  // `admin.initializeApp()` before this line.
  return admin.database().ref('messages/11111/uppercase').once('value').then((createdSnap) => {
    // Assert that the value is the uppercased version of our input.
    assert.equal(createdSnap.val(), 'INPUT');
  });
});
test.online.js

ऑफ़लाइन मोड में दावे करना

फ़ंक्शन की रिटर्न वैल्यू के बारे में ये बातें कही जा सकती हैं:

const childParam = 'uppercase';
const setParam = 'INPUT';
// Stubs are objects that fake and/or record function calls.
// These are excellent for verifying that functions have been called and to validate the
// parameters passed to those functions.
const childStub = sinon.stub();
const setStub = sinon.stub();
// The following lines creates a fake snapshot, 'snap', which returns 'input' when snap.val() is called,
// and returns true when snap.ref.parent.child('uppercase').set('INPUT') is called.
const snap = {
  val: () => 'input',
  ref: {
    parent: {
      child: childStub,
    }
  }
};
childStub.withArgs(childParam).returns({ set: setStub });
setStub.withArgs(setParam).returns(true);
// Wrap the makeUppercase function.
const wrapped = test.wrap(myFunctions.makeUppercase);
// Since we've stubbed snap.ref.parent.child(childParam).set(setParam) to return true if it was
// called with the parameters we expect, we assert that it indeed returned true.
return assert.equal(wrapped(snap), true);
test.offline.js

Sinon spies का इस्तेमाल करके भी यह पुष्टि की जा सकती है कि कुछ खास तरीके, आपके उम्मीद के मुताबिक पैरामीटर के साथ इस्तेमाल किए गए हैं.

एचटीटीपी फ़ंक्शन की जांच करना

एचटीटीपी onCall फ़ंक्शन की जांच करने के लिए, वही तरीका इस्तेमाल करें जो बैकग्राउंड फ़ंक्शन की जांच करने के लिए किया जाता है.

अगर एचटीटीपी onRequest फ़ंक्शन की जांच की जा रही है, तो आपको firebase-functions-test का इस्तेमाल तब करना चाहिए, जब:

  • आपने functions.config() का इस्तेमाल किया है
  • आपका फ़ंक्शन किसी Firebase प्रोजेक्ट या अन्य Google API के साथ इंटरैक्ट करता है और आपको जांच के लिए किसी असली Firebase प्रोजेक्ट और उसके क्रेडेंशियल का इस्तेमाल करना है.

एचटीटीपी onRequest फ़ंक्शन में दो पैरामीटर होते हैं: अनुरोध ऑब्जेक्ट और रिस्पॉन्स ऑब्जेक्ट. addMessage() उदाहरण फ़ंक्शन की जांच करने का तरीका यहां बताया गया है:

  • रिस्पॉन्स ऑब्जेक्ट में रीडायरेक्ट फ़ंक्शन को बदलें, क्योंकि sendMessage() इसे कॉल करता है.
  • रीडायरेक्ट फ़ंक्शन में, chai.assert का इस्तेमाल करके यह बताएं कि रीडायरेक्ट फ़ंक्शन को किन पैरामीटर के साथ कॉल किया जाना चाहिए:
// A fake request object, with req.query.text set to 'input'
const req = { query: {text: 'input'} };
// A fake response object, with a stubbed redirect function which asserts that it is called
// with parameters 303, 'new_ref'.
const res = {
  redirect: (code, url) => {
    assert.equal(code, 303);
    assert.equal(url, 'new_ref');
    done();
  }
};

// Invoke addMessage with our fake request and response objects. This will cause the
// assertions in the response object to be evaluated.
myFunctions.addMessage(req, res);
test.offline.js

टेस्ट क्लीनअप

अपने टेस्ट कोड के आखिर में, क्लीनअप फ़ंक्शन को कॉल करें. इससे, SDK टूल के शुरू होने पर सेट किए गए एनवायरमेंट वैरिएबल अनसेट हो जाते हैं. साथ ही, रीयल टाइम डेटाबेस DataSnapshot या Firestore DocumentSnapshot बनाने के लिए SDK टूल का इस्तेमाल करने पर, ऐसे Firebase ऐप्लिकेशन मिट जाते हैं जो शायद बनाए गए हों.

test.cleanup();

पूरे उदाहरण देखें और ज़्यादा जानें

Firebase के GitHub डेटा स्टोर करने की जगह पर, सभी उदाहरण देखे जा सकते हैं.

ज़्यादा जानने के लिए, firebase-functions-test के लिए एपीआई रेफ़रंस देखें.