Bulut İşlevlerinin birim testi

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

• firebase-functions tarafından ihtiyaç duyulan ortam değişkenlerini ayarlamak ve ayarını kaldırmak gibi testleriniz için uygun kurulum ve sökme ile ilgilenir.
• Yalnızca testinizle ilgili alanları belirtmeniz yeterli olacak şekilde örnek veriler ve olay bağlamı oluşturur.

Test kurulumu

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

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

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

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

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

Testleri yazdıktan sonra, bunları functions.php dizininde npm test çalıştırarak çalıştırabilirsiniz.

Cloud Functions için Firebase Test SDK'sı başlatılıyor

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

1. Çevrimiçi mod (önerilir): Veritabanı yazma, kullanıcı oluşturma vb. işlemlerin gerçekleşmesi ve test kodunuz sonuçları inceleyebilmesi için, test etmeye ayrılmış bir Firebase projesiyle etkileşime giren testler yazın. Bu aynı zamanda işlevlerinizde kullanılan diğer Google SDK'larının da çalışacağı anlamına gelir.
2. Çevrimdışı mod: Silo ve çevrimdışı birim testlerini hiçbir yan etkisi olmadan yazın. Bu, bir Firebase ürünüyle etkileşime giren (ör. veritabanına yazma veya bir kullanıcı oluşturma) tüm yöntem çağrılarının engellenmesi 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 (önerilen)

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

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

1. Proje ayarlarınızı Firebase konsolunda açın.
2. Uygulamalarınız bölümünde 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 üzere 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 sağdaki seçenekler menüsünü kullanarak Anahtar oluştur öğesini seçin.
3. İstendiğinde, anahtar türü olarak JSON'u seçin ve Oluştur'a 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 isterseniz, 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 kodunuzda functions.config() 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 alay 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 aktarmak için require kullanın. Bunu yalnızca firebase-functions-test başlattı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');
test.offline.js

Arka plan (HTTP olmayan) işlevleri test etme

HTTP dışı 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. Sarmalanmış işlevi, oluşturduğunuz test verileri ve belirtmek istediğiniz herhangi bir olay bağlamı alanıyla birlikte ç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 işleviniz var. Aşağıdakileri functions/test/index.test.js içine yazın

// "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şleyiciye 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ı): belirtmek istediğiniz olay bağlamı alanları. Olay bağlamı, yazdığınız işlev işleyicisine gönderilen ikinci parametredir. wrapped çağrılırken bir eventContextOptions parametresi eklemezseniz, yine de mantıklı alanlarla bir olay bağlamı oluşturulur. Oluşturulan bazı alanları burada belirterek geçersiz kılabilirsiniz. Yalnızca geçersiz kılmak istediğiniz alanları dahil etmeniz 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, altta yatan işlevi birlikte ç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şturmak için 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 veridir ve ikinci bağımsız değişken tam referans yoludur ve anlık görüntünün diğer özellikleri için belirtebileceğiniz isteğe bağlı üçüncü bir 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 öncesi durumu için, diğeri sonrası durumu 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 işlev türü için örnek veri üretme yöntemleri 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.

Saplanmış 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 taslakları olan düz bir nesne kullanmalısınız.

Diyelim ki aşağıdaki işlev için bir birim testi yazıyorsunuz:

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

İş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);
test.offline.js

iddialarda bulunmak

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

Çevrimiçi modda iddialarda bulunmak

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

Aşağıdaki örnek, 'GİRİŞ'in test projesinin veri tabanına yazıldığını iddia etmektedir.

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

Çevrimdışı modda iddialarda bulunmak

İşlevin beklenen dönüş 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);
test.offline.js

Sinon casuslarını, belirli yöntemlerin çağrıldığını iddia etmek için ve beklediğiniz parametrelerle de 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, şu durumlarda firebase-functions-test kullanmalısınız:

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

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() ç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 bulunmanıza yardımcı olması için chai.assert'i 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.offline.js

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 veritabanı DataSnapshot veya Firestore DocumentSnapshot oluşturmak için kullandıysanız oluşturulmuş olabilecek Firebase uygulamalarını siler.

test.cleanup();

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

Tüm örnekleri Firebase GitHub deposunda inceleyebilirsiniz.

• Çevrimiçi Modda Gerçek Zamanlı Veritabanı ve HTTP İşlevlerini Test Etme
• Gerçek Zamanlı Veritabanı ve HTTP İşlevlerini Çevrimdışı Modda Test Etme

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