Bulut İşlevlerinin birim testi

Bu sayfa, Sürekli Entegrasyon (CI) sisteminin bir parçası olacak testler gibi, işlevleriniz için birim testleri yazmaya yönelik en iyi uygulamaları ve araçları açıklar. Firebase, testi kolaylaştırmak için Cloud Functions için Firebase Test SDK'sını sağlar. npm'de firebase-functions-test olarak dağıtılır ve firebase-functions için eşlik eden bir test firebase-functions . Bulut İşlevleri için Firebase Test SDK'sı:

  • firebase-functions tarafından ihtiyaç duyulan ortam değişkenlerinin ayarlanması ve ayarlarının kaldırılması gibi testleriniz için uygun kurulum ve sökme işlemlerini gerçekleştirir.
  • Örnek veriler ve olay bağlamı oluşturur, böylece yalnızca testinizle ilgili alanları belirtmeniz gerekir.

Test kurulumu

İşlevler klasörünüzde aşağıdaki komutları çalıştırarak hem firebase-functions-test hem de bir test çerçevesi olan Mocha'yı yükleyin:

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

Ardından, işlevler klasörü içinde bir test klasörü oluşturun, test kodunuz için bunun içinde yeni bir dosya oluşturun ve buna index.test.js gibi bir ad verin.

Son olarak, aşağıdakileri eklemek için functions/package.json değiştirin:

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

Testleri yazdıktan sonra, function dizininizin içinde npm test çalıştırarak bunları çalıştırabilirsiniz.

Cloud Functions için Firebase Test SDK'sını Başlatma

firebase-functions-test kullanmanın iki yolu vardır:

  1. Çevrimiçi mod (önerilir): Teste ayrılmış bir Firebase projesiyle etkileşime giren testler yazın, böylece veritabanı yazma, kullanıcı oluşturma vb. işler gerçekten gerçekleşir ve test kodunuz sonuçları inceleyebilir. Bu aynı zamanda işlevlerinizde kullanılan diğer Google SDK'larının da çalışacağı anlamına gelir.
  2. Çevrimdışı mod: Yan etkisi olmayan silo ve çevrimdışı birim testleri yazın. Bu, bir Firebase ürünüyle etkileşime giren herhangi bir yöntem çağrılarının (örneğin, veritabanına yazma veya bir kullanıcı oluşturma) saplanması gerektiği anlamına gelir. Test kodunuzun karmaşıklığını büyük ölçüde artırdığından, Cloud Firestore veya Realtime Database işlevlerine sahipseniz çevrimdışı modun kullanılması genellikle önerilmez.

SDK'yı çevrimiçi modda başlat (önerilir)

Bir test projesiyle etkileşime giren testler yazmak istiyorsanız, uygulamayı firebase-admin aracılığıyla başlatmak için gereken proje yapılandırma değerlerini ve bir hizmet hesabı anahtar dosyasının yolunu sağlamanız gerekir.

Firebase projenizin yapılandırma değerlerini almak için:

  1. Firebase konsolunda proje ayarlarınızı açın.
  2. Uygulamalarınız'da istediğiniz uygulamayı seçin.
  3. Sağ bölmede, Apple ve Android uygulamaları için bir yapılandırma dosyası indirme seçeneğini belirleyin.

    Web uygulamaları için, yapılandırma değerlerini görüntülemek için Yapılandır'ı seçin.

Bir anahtar dosyası oluşturmak için:

  1. Google Cloud Console'un Hizmet Hesapları bölmesini açın.
  2. App Engine varsayılan hizmet hesabını seçin ve Anahtar oluştur 'u seçmek için sağdaki seçenekler menüsünü kullanın.
  3. İstendiğinde, anahtar türü olarak JSON'u seçin ve Oluştur 'u tıklayın.

Anahtar dosyasını kaydettikten sonra SDK'yı başlatın:

// 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'yı çevrimdışı modda başlat

Tamamen çevrimdışı testler yazmak istiyorsanız, SDK'yı herhangi bir parametre olmadan başlatabilirsiniz:

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

alaycı yapılandırma değerleri

functions.config() işlevini işlev kodunuzda kullanırsanız, yapılandırma değerleriyle alay edebilirsiniz. Örneğin, functions/index.js aşağıdaki kodu içeriyorsa:

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

Ardından, test dosyanızın içindeki değeri şu şekilde taklit edebilirsiniz:

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

İşlevlerinizi içe aktarma

İşlevlerinizi içe aktarmak için ana işlevler dosyanızı bir modül olarak içe aktarmayı require kılın. Bunu yalnızca firebase-functions-test başlatıldıktan ve yapılandırma değerleriyle alay ettikten sonra yaptığınızdan emin olun.

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

firebase-functions-test çevrimdışı modda başlattıysanız ve işlev kodunuzda admin.initializeApp() varsa, işlevlerinizi içe aktarmadan önce onu saplamanız gerekir:

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

Arka plan (HTTP olmayan) işlevlerini test etme

HTTP olmayan işlevleri test etme süreci aşağıdaki adımları içerir:

  1. Test etmek istediğiniz işlevi test.wrap yöntemiyle sarın
  2. Test verilerini oluştur
  3. Oluşturduğunuz test verileriyle ve belirtmek istediğiniz olay bağlamı alanlarıyla sarmalanmış işlevi çağırın.
  4. Davranış hakkında iddialarda bulunun.

Önce test etmek istediğiniz işlevi sarın. Diyelim ki functions/index.js içinde makeUppercase adında test etmek istediğiniz bir fonksiyonunuz var. Aşağıdakileri functions/test/index.test.js

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

wrapped , çağrıldığında makeUppercase çağıran bir işlevdir. wrapped 2 parametre alır:

  1. data (gerekli): makeUppercase gönderilecek veriler. Bu, doğrudan yazdığınız işlev işleyicisine gönderilen ilk parametreye karşılık gelir. firebase-functions-test , özel veriler veya örnek veriler oluşturmak için yöntemler sağlar.
  2. eventContextOptions (isteğe bağlı): olay bağlamının belirtmek istediğiniz alanları. Olay bağlamı, yazdığınız işlev işleyicisine gönderilen ikinci parametredir. wrapped öğesini çağırırken bir eventContextOptions parametresi eklemezseniz, yine de mantıklı alanlarla bir olay bağlamı oluşturulur. Oluşturulan alanların bazılarını burada belirterek geçersiz kılabilirsiniz. Yalnızca geçersiz kılmak istediğiniz alanları eklemeniz gerektiğini unutmayın. Geçersiz kılmadığınız tüm alanlar oluşturulur.
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
});

Test verilerinin oluşturulması

Sarılmış bir işlevin ilk parametresi, temel işlevi çağırmak için test verileridir. Test verilerini oluşturmanın birkaç yolu vardır.

Özel verileri kullanma

firebase-functions-test , işlevlerinizi test etmek için gereken verileri oluşturmaya yönelik bir dizi işleve sahiptir. Örneğin, bir Firestore DocumentSnapshot oluşturmak için test.firestore.makeDocumentSnapshot kullanın. İlk bağımsız değişken verilerdir ve ikinci bağımsız değişken tam başvuru yoludur ve anlık görüntünün belirtebileceğiniz diğer özellikleri için isteğe bağlı bir üçüncü bağımsız değişken vardır.

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

Bir onUpdate veya onWrite işlevini test ediyorsanız, iki anlık görüntü oluşturmanız gerekir: biri önceki durum için ve diğeri sonraki durum için. Ardından, bu anlık görüntülerle bir Change nesnesi oluşturmak için makeChange yöntemini kullanabilirsiniz.

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

Diğer tüm veri türleri için benzer işlevler için API başvurusuna bakın.

Örnek verileri kullanma

Testlerinizde kullanılan verileri özelleştirmeniz gerekmiyorsa, firebase-functions-test , her bir işlev türü için örnek veri oluşturmaya yönelik yöntemler sunar.

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

Her işlev türü için örnek veri alma yöntemleri için API başvurusuna bakın.

Stubbed verileri kullanma (çevrimdışı mod için)

SDK'yı çevrimdışı modda başlattıysanız ve bir Cloud Firestore veya Realtime Database işlevini test ediyorsanız, gerçek bir DocumentSnapshot veya DataSnapshot oluşturmak yerine saplamaları olan düz bir nesne kullanmalısınız.

Aşağıdaki işlev için bir birim testi yazdığınızı varsayalım:

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

İşlevin içinde snap iki kez kullanılır:

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

Test kodunda, bu kod yollarının her ikisinin de çalışacağı düz bir nesne oluşturun ve yöntemleri saplamak için Sinon'u kullanın.

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

iddialarda bulunmak

SDK'yı başlattıktan, işlevleri sardıktan ve verileri oluşturduktan sonra, oluşturulmuş verilerle sarılmış işlevleri çağırabilir ve davranış hakkında iddialarda bulunabilirsiniz. Bu iddiaları yapmak için Chai gibi bir kütüphane kullanabilirsiniz.

Çevrimiçi modda iddialarda bulunma

Cloud Functions için Firebase Test SDK'sını çevrimiçi modda başlattıysanız, firebase-admin SDK'sını kullanarak istenen eylemlerin (veritabanı yazma gibi) gerçekleştiğini iddia edebilirsiniz.

Aşağıdaki örnek, test projesinin veritabanına 'GİRDİ'nin yazıldığını ileri sürmektedir.

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

Çevrimdışı modda iddialarda bulunma

İşlevin beklenen getiri değeri hakkında iddialarda bulunabilirsiniz:

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

Ayrıca, belirli yöntemlerin çağrıldığını ve beklediğiniz parametrelerle Sinon casuslarını kullanabilirsiniz.

HTTP işlevlerini test etme

HTTP onCall işlevlerini test etmek için, arka plan işlevlerini test etmekle aynı yaklaşımı kullanın.

HTTP onRequest işlevlerini test ediyorsanız, aşağıdaki firebase-functions-test kullanmalısınız:

  • functions.config() kullanırsınız
  • İşleviniz bir Firebase projesi veya diğer Google API'leri ile etkileşime giriyor ve testleriniz için gerçek bir Firebase projesi ve kimlik bilgilerini kullanmak istiyorsunuz.

Bir HTTP onRequest işlevi iki parametre alır: bir istek nesnesi ve bir yanıt nesnesi. addMessage() örnek işlevini şu şekilde test edebilirsiniz:

  • sendMessage() onu çağırdığından, yanıt nesnesindeki yönlendirme işlevini geçersiz kılın.
  • Yönlendirme işlevi içinde, yönlendirme işlevinin hangi parametrelerle çağrılması gerektiği konusunda iddialarda bulunmaya yardımcı olması için chai.assert öğesini kullanın:
// 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 temizleme

Test kodunuzun en sonunda temizleme işlevini çağırın. Bu, SDK'nın başlatıldığında ayarladığı ortam değişkenlerinin ayarını kaldırır ve SDK'yı gerçek zamanlı bir DataSnapshot veya Firestore DocumentSnapshot veritabanı oluşturmak için kullandıysanız oluşturulmuş olabilecek Firebase uygulamalarını siler.

test.cleanup();

Eksiksiz örnekleri inceleyin ve daha fazlasını öğrenin

Tam örnekleri Firebase GitHub deposunda inceleyebilirsiniz.

Daha fazla bilgi edinmek için firebase-functions-test için API referansına bakın.