آزمون واحد Cloud Functions

این صفحه شیوه‌های مطلوب و ابزارهایی را برای نوشتن آزمون‌های واحد برای توابع شما، مثل آزمون‌هایی که بخشی از سیستم «ادغام پیوسته» (CI) هستند، توصیف می‌کند. برای آسان‌تر کردن آزمایش، Firebase Firebase Test SDK را برای Cloud Functions ارائه می‌دهد. این کیت توسعه نرم‌افزار در npm به‌عنوان firebase-functions-test توزیع می‌شود و کیت توسعه نرم‌افزار آزمایشی همراه firebase-functions است. ‫Firebase Test SDK برای Cloud Functions:

  • راه‌اندازی و برچیدن مناسب برای آزمایش‌هایتان را انجام می‌دهد، مثلاً متغیرهای محیطی موردنیاز firebase-functions را تنظیم و لغو تنظیم می‌کند.
  • داده‌های نمونه و بافت رویداد را تولید می‌کند، بنابراین فقط باید فیلدهایی را که به آزمون شما مربوط است مشخص کنید.

راه‌اندازی آزمایش

با اجرای فرمان‌های زیر در پوشه تابع‌ها، هم firebase-functions-test و هم Jest، چارچوب آزمایش، را نصب کنید:

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

سپس در پوشه توابع، پوشه test ایجاد کنید، فایل جدیدی در آن برای کد آزمایشی‌تان ایجاد کنید، و آن را با نامی مثل index.test.js نام‌گذاری کنید.

در آخر، functions/package.json را تغییر دهید تا موارد زیر را اضافه کنید:

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

پس‌از نوشتن آزمایش‌ها، می‌توانید آن‌ها را با اجرای npm test در دایرکتوری تابع اجرا کنید.

درحال مقداردهی اولیه Firebase Test SDK برای Cloud Functions

دو روش برای استفاده از firebase-functions-test وجود دارد:

  1. حالت آنلاین (توصیه می‌شود): آزمون‌هایی بنویسید که با پروژه Firebase اختصاص‌داده‌شده به آزمایش تعامل داشته باشد تا نوشتن پایگاه داده، ایجاد کاربر، و غیره واقعاً اتفاق بیفتد و کد آزمون شما بتواند نتایج را بررسی کند. این همچنین به این معنی است که دیگر کیت‌های توسعه نرم‌افزار Google که در عملکردهای شما استفاده می‌شوند نیز کار خواهند کرد.
  2. حالت آفلاین: آزمون‌های واحد آفلاین و مجزا را بدون عوارض جانبی بنویسید. این یعنی هرگونه فراخوانی روش که با محصول Firebase تعامل دارد (مثلاً نوشتن در پایگاه داده یا ایجاد کاربر) باید با کد جایگزین شود. اگر Cloud Firestore یا Realtime Database عملکرد دارید، استفاده از حالت آفلاین به‌طورکلی توصیه نمی‌شود، زیرا پیچیدگی کد آزمایشی شما را به‌شدت افزایش می‌دهد.

مقداردهی اولیه کیت توسعه نرم‌افزار در حالت آنلاین (توصیه‌شده)

اگر می‌خواهید آزمون‌هایی بنویسید که با پروژه آزمایشی تعامل داشته باشد، باید مقادیر پیکربندی Firebase را که برای مقداردهی اولیه برنامه ازطریق firebase-admin لازم است و مسیر فایل کلید حساب سرویس را ارائه دهید.

برای دریافت مقادیر پیکربندی Firebase:

  1. در کنسول Firebase، به صفحه تنظیمات > کلی بروید.

  2. به کارت برنامه‌های شما پیمایش کنید و برنامه موردنظر را انتخاب کنید.

  3. پیکربندی Firebase خود را دریافت کنید:

    • برای برنامه‌های Apple و Android، گزینه بارگیری فایل پیکربندی را انتخاب کنید.

    • برای برنامه‌های وب، پیکربندی را انتخاب کنید تا مقادیر پیکربندی نمایش داده شود.

برای ایجاد فایل کلید:

  1. در کنسول Google Cloud، به قاب «حساب‌های سرویس» بروید.

  2. حساب سرویس پیش‌فرض App Engine را انتخاب کنید و از منو گزینه‌ها در سمت چپ برای انتخاب ایجاد کلید استفاده کنید.

  3. وقتی درخواست شد، JSON را برای نوع کلید انتخاب کنید و روی ایجاد کلیک کنید.

پس‌از ذخیره کردن فایل کلید، کیت توسعه نرم‌افزار را مقداردهی اولیه کنید:

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

مقداردهی اولیه کیت توسعه نرم‌افزار در حالت آفلاین

اگر می‌خواهید آزمایش‌های کاملاً آفلاین بنویسید، می‌توانید «کیت توسعه نرم‌افزار» را بدون هیچ پارامتری مقداردهی اولیه کنید:

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

آزمایش توابع پس‌زمینه (غیر 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 دارای تعدادی تابع برای ساختن داده‌های موردنیاز برای آزمایش تابع‌های شما است. برای مثال، از test.firestore.makeDocumentSnapshot برای ایجاد DocumentSnapshot در Firestore استفاده کنید. اولین آرگومان داده‌ها است و دومین آرگومان مسیر مرجع کامل است و آرگومان سوم اختیاری برای دیگر دارایی‌های نمای فوری وجود دارد که می‌توانید مشخص کنید.

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

برای توابع مشابه برای همه انواع داده دیگر، مرجع میانای برنامه‌سازی کاربردی را ببینید.

استفاده از داده‌های نمونه

اگر نیازی به سفارشی‌سازی داده‌های استفاده‌شده در آزمایش‌هایتان ندارید، 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();

برای روش‌های دریافت داده‌های نمونه برای هر نوع تابع، مرجع میانای برنامه‌سازی کاربردی را ببینید.

درحال استفاده از داده‌های جای‌بان (برای حالت آفلاین)

اگر «کیت توسعه نرم‌افزار» را در حالت آفلاین مقداردهی اولیه کرده‌اید و درحال آزمایش تابع 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);
    });

درون تابع، 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,
    }
  }
};

ادعا کردن

پس‌از مقداردهی اولیه کیت توسعه نرم‌افزار، بسته‌بندی کردن توابع، و ساختن داده‌ها، می‌توانید توابع بسته‌بندی‌شده را با داده‌های ساخته‌شده فراخوانی کنید و درباره رفتار ادعا کنید. برای انجام این ادعاها می‌توانید از expectJest استفاده کنید.

اظهارات در حالت آنلاین

اگر Firebase Test SDK را برای Cloud Functions در حالت آنلاین مقداردهی اولیه کرده‌اید، می‌توانید بااستفاده از firebase-admin SDK تأیید کنید که اقدامات موردنظر (مثل نوشتن پایگاه داده) انجام شده است.

مثال زیر ادعا می‌کند که «ورودی» در پایگاه داده پروژه آزمایشی نوشته شده است.

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

ایجاد ادعا در حالت آفلاین

می‌توانید درباره مقدار برگشتی موردانتظار تابع ادعاهایی داشته باشید:

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

همچنین می‌توانید از توابع ساختگی Jest برای تأیید اینکه روش‌های خاصی فراخوانی شده‌اند و با پارامترهای موردانتظار شما استفاده کنید.

آزمایش توابع HTTP

برای آزمایش توابع HTTP onCall، از همان رویکرد آزمایش توابع پس‌زمینه‌ای استفاده کنید.

اگر درحال آزمایش توابع HTTP onRequest هستید، باید از firebase-functions-test در موارد زیر استفاده کنید:

  • از functions.config() استفاده می‌کنید
  • تابع شما با پروژه Firebase یا دیگر Google APIs تعامل دارد و می‌خواهید از پروژه Firebase واقعی و اطلاعات اعتباری آن برای آزمایش‌هایتان استفاده کنید.

تابع HTTP onRequest دو پارامتر می‌گیرد: یک شیء درخواست و یک شیء پاسخ. در اینجا نحوه آزمایش کردن تابع نمونه addMessage() آورده شده است:

  • ‫Stub admin.database()، زیرا addMessage() به Realtime Database فشار می‌آورد. در حالت آفلاین، initializeApp() را جایگزین کردید، بنابراین برنامه Firebase برای استفاده Admin SDK وجود ندارد و 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() آن را فرا می‌خواند.

  • در تابع هدایت مجدد، از expect در Jest برای ایجاد ادعا درباره پارامترهایی که تابع هدایت مجدد باید با آن‌ها فراخوانی شود استفاده کنید:

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

پاک‌سازی آزمایش

در انتهای کد آزمایشی خود، تابع پاک‌سازی را فراخوانی کنید. این کار متغیرهای محیطی را که کیت توسعه نرم‌افزار هنگام مقداردهی اولیه تنظیم کرده است لغو می‌کند و برنامه‌های Firebase را که ممکن است درصورت استفاده از کیت توسعه نرم‌افزار برای ایجاد پایگاه داده بی‌درنگ DataSnapshot یا Firestore DocumentSnapshot ایجاد شده باشند حذف می‌کند.

test.cleanup();

نمونه‌های کامل را مرور کنید و بیشتر بدانید

می‌توانید نمونه‌های کامل را در مخزن Firebase GitHub مرور کنید.

برای کسب اطلاعات بیشتر، به مرجع میانای برنامه‌سازی کاربردی برای firebase-functions-test مراجعه کنید.