Cloud Functions-এর ইউনিট টেস্টিং

এই পৃষ্ঠায় আপনার ফাংশনের জন্য ইউনিট টেস্ট লেখার পেশাদার পদ্ধতি ও টুল সম্পর্কে বর্ণনা করা হয়েছে, যেমন টেস্ট যা কন্টিনিউয়াস ইন্টিগ্রেশন (CI) সিস্টেমের অংশ হবে। টেস্টিং আরও সহজ করতে, Firebase Cloud Functions-এর জন্য Firebase Test SDK প্রদান করে। এটি npm-এ firebase-functions-test হিসেবে ডিস্ট্রিবিউট করা হয় এবং এটি firebase-functions-এর একটি কম্প্যানিয়ন টেস্ট SDK। Cloud Functions-এর জন্য Firebase Test SDK:

• আপনার টেস্টের জন্য উপযুক্ত সেট-আপ ও টিয়ারডাউনের যত্ন নেয়, যেমন firebase-functions-এর জন্য প্রয়োজনীয় এনভায়রনমেন্ট ভেরিয়েবল সেট ও আনসেট করা।
• স্যাম্পেল ডেটা এবং ইভেন্ট কনটেক্সট তৈরি করে, যাতে আপনাকে শুধুমাত্র আপনার পরীক্ষার জন্য প্রাসঙ্গিক ফিল্ডগুলি নির্দিষ্ট করতে হয়।

টেস্ট সেট-আপ

আপনার ফাংশন ফোল্ডারে নিম্নলিখিত কমান্ড রান করে firebase-functions-test এবং Jest, একটি টেস্টিং ফ্রেমওয়ার্ক, দুটিই ইনস্টল করুন:

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

এরপর, functions ফোল্ডারের মধ্যে একটি test ফোল্ডার তৈরি করুন, আপনার টেস্ট কোডের জন্য এর মধ্যে একটি নতুন ফাইল তৈরি করুন এবং এটির নাম index.test.js-এর মতো কিছু দিন।

সবশেষে, নিম্নলিখিতগুলি যোগ করতে functions/package.json পরিবর্তন করুন:

"scripts": {
  "test": "jest"
}

টেস্ট লেখা হয়ে গেলে, আপনার ফাংশন ডিরেক্টরির মধ্যে npm test রান করে আপনি সেগুলি রান করতে পারবেন।

Cloud Functions-এর জন্য Firebase Test SDK শুরু করা হচ্ছে

firebase-functions-test ব্যবহার করার দুটি উপায় আছে:

1. অনলাইন মোড (সাজেস্ট করা): এমন টেস্ট লিখুন যা টেস্টিংয়ের জন্য নির্দিষ্ট করা Firebase প্রোজেক্টের সাথে ইন্টার‍্যাক্ট করে, যাতে ডেটাবেস রাইট, ইউজার ক্রিয়েট ইত্যাদি আসলে ঘটে এবং আপনার টেস্ট কোড ফলাফলগুলি পরীক্ষা করতে পারে। এর অর্থ হল, আপনার ফাংশনে ব্যবহৃত অন্যান্য Google SDK-ও কাজ করবে।
2. অফলাইন মোড: কোনও পার্শ্বপ্রতিক্রিয়া ছাড়াই সাইলোড ও অফলাইন ইউনিট টেস্ট লিখুন। এর অর্থ হল, Firebase প্রোডাক্টের সাথে ইন্টার‍্যাক্ট করে এমন যেকোনও মেথড কল (যেমন, ডেটাবেসে লেখা বা ব্যবহারকারী তৈরি করা) স্টাব করতে হবে। আপনার Cloud Firestore বা Realtime Database ফাংশন থাকলে, অফলাইন মোড ব্যবহার করার সাজেশন সাধারণত দেওয়া হয় না, কারণ এটি আপনার টেস্ট কোডের জটিলতা অনেক বাড়িয়ে দেয়।

অনলাইন মোডে SDK ইনিশিয়ালাইজ করুন (সাজেস্ট করা হয়েছে)

আপনি যদি টেস্ট প্রোজেক্টের সাথে ইন্টার‍্যাক্ট করে এমন টেস্ট লিখতে চান, তাহলে আপনাকে Firebase কনফিগারেশন ভ্যালু দিতে হবে যা firebase-admin-এর মাধ্যমে অ্যাপ শুরু করার জন্য প্রয়োজন এবং সার্ভিস অ্যাকাউন্ট কী ফাইলের পাথ দিতে হবে।

আপনার Firebase কনফিগারেশন ভ্যালু পেতে:

1. Firebase কনসোলে, settings সেটিংস > সাধারণ পৃষ্ঠায় যান।

2. স্ক্রল করে আপনার অ্যাপ কার্ডে যান এবং যে অ্যাপটি ব্যবহার করতে চান সেটি বেছে নিন।

3. আপনার Firebase কনফিগারেশন পান:

   • Apple ও Android অ্যাপের জন্য, কনফিগারেশন ফাইল ডাউনলোড করার বিকল্প বেছে নিন।

   • ওয়েব অ্যাপের জন্য, কনফিগারেশন ভ্যালু দেখতে কনফিগার করুন বিকল্প বেছে নিন।

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

1. Google Cloud কনসোলে, পরিষেবা অ্যাকাউন্ট প্যানে যান।

2. App Engine ডিফল্ট পরিষেবা অ্যাকাউন্ট বেছে নিন এবং ডানদিকে বিকল্পের মেনু ব্যবহার করে কী তৈরি করুন বিকল্প বেছে নিন।

3. প্রম্পট করা হলে, 'কী'-এর ধরন হিসেবে JSON বেছে নিন এবং তৈরি করুন বিকল্পে ক্লিক করুন।

কী ফাইল সেভ করার পরে, 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() থাকে, তাহলে আপনার ফাংশন ইমপোর্ট করার আগে আপনাকে এটি স্টাব করতে হবে। আপনার টেস্ট ফাইলে, firebase-admin-কে admin হিসেবে প্রয়োজন, তারপর initializeApp()-কে Jest মক দিয়ে রিপ্লেস করুন:

// If initializeApp() is called in index.js, we mock it out before requiring index.js
adminInitStub = jest.spyOn(admin, 'initializeApp').mockImplementation(() => {});
// Now we can require index.js and save the exports inside a namespace called myFunctions.
myFunctions = require('../index');
offline.test.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 ২টি প্যারামিটার নেয়:

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

অন্যান্য সব ধরনের ডেটার জন্য একই ধরনের ফাংশন সম্পর্কে জানতে 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)

টেস্ট কোডে, একটি প্লেন অবজেক্ট তৈরি করুন যেখানে এই দুটি কোড পাথই কাজ করবে, এবং পদ্ধতিগুলি স্টাব করতে Jest মক ফাংশন ব্যবহার করুন।

// The following lines create 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,
    }
  }
};
offline.test.js

দাবি করা

SDK শুরু করা, ফাংশন র‍্যাপ করা এবং ডেটা তৈরি করার পরে, আপনি তৈরি করা ডেটার সাথে র‍্যাপ করা ফাংশনগুলি চালু করতে পারেন এবং আচরণ সম্পর্কে অ্যাসারশন করতে পারেন। এইসব অ্যাসারশন করতে আপনি Jest-এর expect ব্যবহার করতে পারেন।

অনলাইন মোডে অ্যাসার্শন করা

আপনি যদি অনলাইন মোডে 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.
  return admin.database().ref('messages/11111/uppercase').once('value').then((createdSnap) => {
    // Assert that the value is the uppercased version of our input.
    expect(createdSnap.val()).toBe('INPUT');
  });
});
online.test.js

অফলাইন মোডে অ্যাসার্শন করা

আপনি ফাংশনের প্রত্যাশিত রিটার্ন ভ্যালু সম্পর্কে অ্যাসার্শন করতে পারেন:

const childParam = 'uppercase';
const setParam = 'INPUT';
// Spies/mocks 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 setStub = jest.fn().mockImplementation((val) => val === setParam ? true : undefined);
const childStub = jest.fn().mockImplementation((path) => path === childParam ? { set: setStub } : undefined);
// The following lines create 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,
    }
  }
};
// Wrap the makeUppercase function.
const wrapped = test.wrap(myFunctions.makeUppercase);
// Since we've mocked 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 => {
  expect(makeUppercaseResult).toBe(true);
});
offline.test.js

এছাড়াও, আপনি Jest মক ফাংশন ব্যবহার করে নির্দিষ্ট পদ্ধতি কল করা হয়েছে কিনা এবং আপনার প্রত্যাশিত প্যারামিটার সহ তা নিশ্চিত করতে পারেন।

HTTP ফাংশন পরীক্ষা করা

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

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

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

একটি HTTP onRequest ফাংশন দুটি প্যারামিটার নেয়: একটি অনুরোধ অবজেক্ট এবং একটি প্রতিক্রিয়া অবজেক্ট। আপনি কীভাবে addMessage() উদাহরণ ফাংশন পরীক্ষা করতে পারেন তা এখানে দেওয়া হল:

• স্টাব admin.database(), কারণ addMessage() রিয়েল-টাইম ডেটাবেসে পুশ করে। অফলাইন মোডে আপনি initializeApp() স্টাব করেছেন, তাই Admin SDK-এর ব্যবহার করার জন্য কোনও Firebase অ্যাপ নেই এবং আসল admin.database() The default Firebase app does not exist-এর সাথে ব্যর্থ হয়:

  const pushStub = jest.fn().mockResolvedValue({ ref: 'new_ref' });
  const refStub = jest.fn().mockReturnValue({ push: pushStub });
  Object.defineProperty(admin, 'database', {
    configurable: true,
    writable: true,
    value: jest.fn().mockReturnValue({ ref: refStub }),
  });
  

• রেসপন্স অবজেক্টে রিডাইরেক্ট ফাংশন ওভাররাইড করুন, কারণ addMessage() এটি কল করে।

• রিডাইরেক্ট ফাংশনের মধ্যে, কোন প্যারামিটার সহ রিডাইরেক্ট ফাংশন কল করা উচিত সেই সম্পর্কে অ্যাসার্শন করতে Jest-এর expect ব্যবহার করুন:

// 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) => {
    expect(code).toBe(303);
    expect(url).toBe('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);
offline.test.js

টেস্ট ক্লিনআপ

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

test.cleanup();

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

আপনি Firebase GitHub রিপোজিটরিতে সম্পূর্ণ উদাহরণ পর্যালোচনা করতে পারবেন।

• অনলাইন মোডে Realtime Database এবং HTTP ফাংশন টেস্ট করা
• অফলাইন মোডে Realtime Database এবং HTTP ফাংশন টেস্ট করা

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