Join us for Firebase Summit on November 10, 2021. Tune in to learn how Firebase can help you accelerate app development, release with confidence, and scale with ease. Register

क्लाउड फ़ंक्शंस का यूनिट परीक्षण

यह पृष्ठ आपके कार्यों के लिए इकाई परीक्षण लिखने के लिए सर्वोत्तम प्रथाओं और उपकरणों का वर्णन करता है, जैसे परीक्षण जो एक सतत एकीकरण (सीआई) प्रणाली का एक हिस्सा होगा। परीक्षण को आसान बनाने के लिए, फायरबेस क्लाउड फ़ंक्शंस के लिए फायरबेस टेस्ट एसडीके प्रदान करता है। यह रूप में NPM पर वितरित किया जाता है firebase-functions-test , और करने के लिए एक साथी परीक्षण एसडीके है firebase-functions । क्लाउड फ़ंक्शंस के लिए फायरबेस टेस्ट एसडीके:

  • इस तरह की जरूरत सेटिंग और unsetting वातावरण चर के रूप में अपने परीक्षण, के लिए और उचित सेटअप का ख्याल टियरडाउन ले जाता है firebase-functions
  • नमूना डेटा और घटना संदर्भ उत्पन्न करता है, ताकि आपको केवल वही फ़ील्ड निर्दिष्ट करनी पड़े जो आपके परीक्षण के लिए प्रासंगिक हैं।

परीक्षण व्यवस्था

दोनों स्थापित firebase-functions-test और मोचा , एक परीक्षण ढांचे, फ़ोल्डर अपने कार्यों में निम्न कमांड चलाकर:

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 अपने कार्यों निर्देशिका के अंदर।

क्लाउड फ़ंक्शंस के लिए फायरबेस टेस्ट एसडीके शुरू करना

वहाँ का उपयोग करने के दो तरीके हैं firebase-functions-test :

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

एसडीके को ऑनलाइन मोड में प्रारंभ करें (अनुशंसित)

आप लिखने परीक्षण करना चाहते हैं कि एक परीक्षण परियोजना से बातचीत करें, आप परियोजना config मानों के माध्यम से एप्लिकेशन को प्रारंभ करने के लिए आवश्यक हैं आपूर्ति की जरूरत firebase-admin और किसी सेवा खाते कुंजी फ़ाइल का पथ,।

अपने फायरबेस प्रोजेक्ट के कॉन्फ़िगरेशन मान प्राप्त करने के लिए:

  1. में अपनी परियोजना सेटिंग खोलें Firebase कंसोल
  2. आपके एप्लिकेशन में, इच्छित ऐप चुनें।
  3. दाएँ फलक में, iOS और Android ऐप्स के लिए कॉन्फ़िगरेशन फ़ाइल डाउनलोड करने के विकल्प का चयन करें।

    वेब एप्लिकेशन के लिए, विन्यास मूल्यों को प्रदर्शित करने कॉन्फ़िग का चयन करें।

एक कुंजी फ़ाइल बनाने के लिए:

  1. खोलें सेवा खाते फलक Google क्लाउड कंसोल की।
  2. App इंजन डिफ़ॉल्ट सेवा खाते का चयन करें, और कुंजी बनाएँ का चयन करने के लिए सही पर विकल्प मेनू का उपयोग करें।
  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 को प्रारंभ कर सकते हैं:

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

मॉकिंग कॉन्फ़िगरेशन मान

आप का उपयोग करते हैं functions.config() अपने कार्यों कोड में, आप config मान नकली कर सकते हैं। उदाहरण के लिए, यदि functions/index.js निम्नलिखित कोड शामिल हैं:

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

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

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

अपने कार्यों को आयात करना

अपने कार्यों आयात करने के लिए उपयोग require एक मॉड्यूल के रूप में अपने मुख्य कार्य फ़ाइल आयात करने। सुनिश्चित करें कि करने के लिए हो सकता है केवल आरंभ के बाद ऐसा करने firebase-functions-test , और config मान मजाक।

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

परीक्षण पृष्ठभूमि (गैर-HTTP) कार्य

गैर-HTTP फ़ंक्शन के परीक्षण की प्रक्रिया में निम्नलिखित चरण शामिल हैं:

  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 2 पैरामीटर लेता है:

  1. डेटा (आवश्यक): डेटा को भेजने के लिए makeUppercase । यह सीधे आपके द्वारा लिखे गए फ़ंक्शन हैंडलर को भेजे गए पहले पैरामीटर से मेल खाता है। firebase-functions-test कस्टम डेटा या उदाहरण डेटा के निर्माण के लिए तरीकों प्रदान करता है।
  2. eventContextOptions (वैकल्पिक): घटना संदर्भ के क्षेत्र आपके द्वारा निर्दिष्ट करना चाहते हैं। ईवेंट संदर्भ आपके द्वारा लिखे गए फ़ंक्शन हैंडलर को भेजा गया दूसरा पैरामीटर है। आप एक नहीं लगाते हैं तो eventContextOptions जब कॉल पैरामीटर wrapped , एक घटना के संदर्भ में अभी भी समझदार क्षेत्रों के साथ उत्पन्न होता है। आप कुछ जेनरेट किए गए फ़ील्ड को यहां निर्दिष्ट करके ओवरराइड कर सकते हैं। ध्यान दें कि आपको केवल उन फ़ील्ड्स को शामिल करना है जिन्हें आप ओवरराइड करना चाहते हैं। कोई भी फ़ील्ड जिसे आपने ओवरराइड नहीं किया है वह जनरेट हो जाती है।
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 अपने कार्यों का परीक्षण करने के लिए आवश्यक डेटा के निर्माण के लिए काम करता है की एक संख्या है। उदाहरण के लिए, का उपयोग test.firestore.makeDocumentSnapshot एक firestore बनाने के लिए DocumentSnapshot । पहला तर्क डेटा है, और दूसरा तर्क पूर्ण संदर्भ मार्ग है, और वहाँ एक है वैकल्पिक तीसरा तर्क स्नैपशॉट आप निर्दिष्ट कर सकते की अन्य संपत्तियों के लिए।

// 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 समारोह, आप दो स्नैपशॉट बनाने के लिए की आवश्यकता होगी: राज्य के बाद के लिए राज्य से पहले के लिए और दूसरा। उसके बाद, आप का उपयोग कर सकते makeChange एक बनाने के लिए विधि Change इन स्नैपशॉट के साथ वस्तु।

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

देखें API संदर्भ अन्य सभी डेटा प्रकार के लिए समान कार्य के लिए।

उदाहरण डेटा का उपयोग करना

आप अपने परीक्षण में इस्तेमाल किया डेटा, तो अनुकूलित करने के लिए की जरूरत नहीं है 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();

देखें API संदर्भ हर कार्य प्रकार के लिए उदाहरण डेटा प्राप्त करने के लिए तरीकों के लिए।

स्टब्ड डेटा का उपयोग करना (ऑफ़लाइन मोड के लिए)

आप ऑफ़लाइन मोड में एसडीके प्रारंभ, और एक बादल Firestore या रीयलटाइम डाटाबेस समारोह का परीक्षण कर रहे हैं, तो आप के बजाय एक वास्तविक बनाने के स्टब्स के साथ एक सादे वस्तु का उपयोग करना चाहिए 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);
    });

समारोह के अंदर, snap दो बार प्रयोग किया जाता है:

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

परीक्षण कोड में, एक सादे वस्तु जहां इन कोड रास्तों के दोनों काम करेंगे बनाते हैं, और का उपयोग सिनोन तरीकों ठूंठ।

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

दावे करना

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

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

आप में बादल कार्य के लिए Firebase टेस्ट एसडीके प्रारंभ तो ऑनलाइन मोड , तो आपको यह स्पष्ट कर सकते हैं कि (जैसे एक डेटाबेस लिखने के रूप में) वांछित कार्रवाई का उपयोग करके हुआ है firebase-admin एसडीके।

नीचे दिया गया उदाहरण बताता है कि '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');
  });
});

ऑफ़लाइन मोड में अभिकथन करना

आप फ़ंक्शन के अपेक्षित रिटर्न मान के बारे में दावा कर सकते हैं:

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

तुम भी इस्तेमाल किया जा सकता सिनोन जासूस कहने देगी कि कुछ तरीकों बुलाया गया है, और मानकों के साथ आप की उम्मीद है।

HTTP कार्यों का परीक्षण

HTTP onCall कार्यों की जांच के लिए के रूप में ही दृष्टिकोण का उपयोग पृष्ठभूमि कार्यों का परीक्षण

आप HTTP onRequest कार्यों का परीक्षण कर रहे हैं, तो आप का उपयोग करना चाहिए firebase-functions-test करता है, तो:

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

एक HTTP 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);

परीक्षण सफाई

अपने परीक्षण कोड के अंत में, क्लीनअप फ़ंक्शन को कॉल करें। यह unsets वातावरण चर कि एसडीके सेट जब यह प्रारंभ किया गया था, और यदि आप एक वास्तविक समय डेटाबेस बनाने के लिए एसडीके इस्तेमाल किया सृजन किया गया है हो सकता है कि Firebase क्षुधा को हटा देता है DataSnapshot या Firestore DocumentSnapshot

test.cleanup();

संपूर्ण उदाहरणों की समीक्षा करें और अधिक जानें

आप Firebase GitHub रिपॉजिटरी पर संपूर्ण उदाहरणों की समीक्षा कर सकते हैं।

अधिक जानकारी के लिए का उल्लेख API संदर्भ के लिए firebase-functions-test