ক্লাউড ফাংশন ইউনিট পরীক্ষা

এই পৃষ্ঠাটি আপনার ফাংশনের জন্য ইউনিট পরীক্ষা লেখার জন্য সর্বোত্তম অনুশীলন এবং সরঞ্জামগুলি বর্ণনা করে, যেমন পরীক্ষাগুলি যা একটি কন্টিনিউয়াস ইন্টিগ্রেশন (CI) সিস্টেমের অংশ হবে। পরীক্ষা সহজ করার জন্য, 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 এর মাধ্যমে অ্যাপটি শুরু করার জন্য প্রয়োজনীয় প্রকল্প কনফিগারেশন মান এবং একটি পরিষেবা অ্যাকাউন্ট কী ফাইলের পথ সরবরাহ করতে হবে।

আপনার ফায়ারবেস প্রকল্পের কনফিগারেশন মান পেতে:

  1. Firebase কনসোলে আপনার প্রকল্প সেটিংস খুলুন।
  2. আপনার অ্যাপস-এ, পছন্দসই অ্যাপটি নির্বাচন করুন।

  3. ডান দিকের ফলকে, অ্যাপল এবং অ্যান্ড্রয়েড অ্যাপের জন্য একটি কনফিগারেশন ফাইল ডাউনলোড করার বিকল্পটি নির্বাচন করুন।

    ওয়েব অ্যাপের জন্য, কনফিগারেশন মান প্রদর্শন করতে Config নির্বাচন করুন।

একটি কী ফাইল তৈরি করতে:

  1. Google Cloud কনসোলের সার্ভিস অ্যাকাউন্টস প্যানটি খুলুন।
  2. App Engine ডিফল্ট পরিষেবা অ্যাকাউন্ট নির্বাচন করুন এবং ডানদিকের বিকল্প মেনু ব্যবহার করে Create key নির্বাচন করুন।
  3. অনুরোধ করা হলে, কী টাইপের জন্য JSON নির্বাচন করুন এবং Create এ ক্লিক করুন।

কী ফাইলটি সংরক্ষণ করার পরে, SDK আরম্ভ করুন:

// At the top of test/index.test.js
// Make sure to use values from your actual Firebase configuration
const test = require('firebase-functions-test')({
  databaseURL: 'https://PROJECT_ID.firebaseio.com',
  storageBucket: 'PROJECT_ID.firebasestorage.app',
  projectId: 'PROJECT_ID',
}, '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

ব্যাকগ্রাউন্ড (নন-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 (ঐচ্ছিক): ইভেন্ট কনটেক্সটের ক্ষেত্র যা আপনি নির্দিষ্ট করতে চান। ইভেন্ট কনটেক্সট হল আপনার লেখা ফাংশন হ্যান্ডলারে পাঠানো দ্বিতীয় প্যারামিটার। 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 ফাংশন পরীক্ষা করেন, তাহলে আপনাকে দুটি স্ন্যাপশট তৈরি করতে হবে: একটি পূর্ববর্তী অবস্থার জন্য এবং একটি পরবর্তী অবস্থার জন্য। তারপর, আপনি 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 রেফারেন্সটি দেখুন।

স্টাবড ডেটা ব্যবহার করা (অফলাইন মোডের জন্য)

যদি আপনি অফলাইন মোডে 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 wrapped(snap).then(makeUppercaseResult => {
  return assert.equal(makeUppercaseResult, true);
});
test.offline.js

আপনি সিনন স্পাই ব্যবহার করে নিশ্চিত করতে পারেন যে নির্দিষ্ট পদ্ধতিগুলি বলা হয়েছে এবং আপনার প্রত্যাশিত পরামিতিগুলির সাথে।

HTTP ফাংশন পরীক্ষা করা হচ্ছে

HTTP onCall ফাংশন পরীক্ষা করার জন্য, ব্যাকগ্রাউন্ড ফাংশন পরীক্ষা করার মতো একই পদ্ধতি ব্যবহার করুন।

যদি আপনি HTTP onRequest ফাংশন পরীক্ষা করেন, তাহলে আপনার firebase-functions-test ব্যবহার করা উচিত যদি:

  • তুমি functions.config() ব্যবহার করো।
  • আপনার ফাংশনটি একটি Firebase প্রকল্প বা অন্যান্য Google API-এর সাথে ইন্টারঅ্যাক্ট করে এবং আপনি আপনার পরীক্ষার জন্য একটি আসল Firebase প্রকল্প এবং এর শংসাপত্র ব্যবহার করতে চান।

একটি HTTP onRequest ফাংশন দুটি প্যারামিটার ব্যবহার করে: একটি request object এবং একটি response object। এখানে আপনি 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

পরীক্ষামূলক পরিষ্কারকরণ

আপনার টেস্ট কোডের একেবারে শেষে, cleanup ফাংশনটি কল করুন। এটি SDK-এর দ্বারা সেট করা পরিবেশগত ভেরিয়েবলগুলিকে আনসেট করে এবং Firebase অ্যাপগুলি মুছে ফেলে যা আপনি যদি SDK ব্যবহার করে রিয়েল টাইম ডাটাবেস DataSnapshot বা Firestore DocumentSnapshot তৈরি করেন তবে তৈরি করা হতে পারে। 

test.cleanup();

সম্পূর্ণ উদাহরণগুলি পর্যালোচনা করুন এবং আরও জানুন

আপনি Firebase GitHub সংগ্রহস্থলে সম্পূর্ণ উদাহরণগুলি পর্যালোচনা করতে পারেন।

আরও জানতে, firebase-functions-test এর API রেফারেন্স দেখুন।