M

MLOG

Türkçe

Supertest kullanarak API testine odaklanan, kurulum, en iyi uygulamalar ve sağlam uygulama testleri için gelişmiş teknikleri kapsayan kapsamlı bir entegrasyon testi kılavuzu.

Entegrasyon Testi: Supertest ile API Testlerinde Uzmanlaşma

Yazılım geliştirme dünyasında, tekil bileşenlerin izole bir şekilde doğru çalıştığından emin olmak (birim testi) çok önemlidir. Ancak, bu bileşenlerin birlikte sorunsuz çalıştığını doğrulamak da aynı derecede önemlidir. İşte bu noktada entegrasyon testi devreye girer. Entegrasyon testi, bir uygulama içindeki farklı modüller veya servisler arasındaki etkileşimi doğrulamaya odaklanır. Bu makale, Node.js'de HTTP iddialarını test etmek için güçlü ve kullanıcı dostu bir kütüphane olan Supertest ile API testine özel olarak odaklanarak entegrasyon testini derinlemesine inceliyor.

Entegrasyon Testi Nedir?

Entegrasyon testi, tekil yazılım modüllerini birleştiren ve bunları bir grup olarak test eden bir yazılım testi türüdür. Entegre birimler arasındaki etkileşimlerdeki kusurları ortaya çıkarmayı amaçlar. Tekil bileşenlere odaklanan birim testinin aksine, entegrasyon testi modüller arasındaki veri akışını ve kontrol akışını doğrular. Yaygın entegrasyon testi yaklaşımları şunları içerir:

API'ler bağlamında entegrasyon testi, farklı API'lerin birlikte doğru çalışıp çalışmadığını, aralarında aktarılan verilerin tutarlı olup olmadığını ve genel sistemin beklendiği gibi çalışıp çalışmadığını doğrulamayı içerir. Örneğin, ürün yönetimi, kullanıcı kimlik doğrulaması ve ödeme işleme için ayrı API'lere sahip bir e-ticaret uygulaması düşünün. Entegrasyon testi, bu API'lerin doğru bir şekilde iletişim kurmasını sağlayarak kullanıcıların ürünlere göz atmasına, güvenli bir şekilde giriş yapmasına ve satın alma işlemlerini tamamlamasına olanak tanır.

API Entegrasyon Testi Neden Önemlidir?

API entegrasyon testi birkaç nedenden dolayı kritiktir:

Küresel bir seyahat rezervasyon platformu düşünün. API entegrasyon testi, çeşitli ülkelerden uçuş rezervasyonlarını, otel rezervasyonlarını ve ödeme ağ geçitlerini yöneten API'ler arasında sorunsuz iletişim sağlamak için çok önemlidir. Bu API'lerin düzgün bir şekilde entegre edilememesi, yanlış rezervasyonlara, ödeme hatalarına ve kötü bir kullanıcı deneyimine yol açarak platformun itibarını ve gelirini olumsuz etkileyebilir.

Supertest'e Giriş: API Testi İçin Güçlü Bir Araç

Supertest, HTTP isteklerini test etmek için üst düzey bir soyutlamadır. Uygulamanıza istek göndermek ve yanıtlara ilişkin iddialarda bulunmak için kullanışlı ve akıcı bir API sağlar. Node.js üzerine inşa edilen Supertest, özellikle Node.js HTTP sunucularını test etmek için tasarlanmıştır. Jest ve Mocha gibi popüler test çerçeveleriyle son derece iyi çalışır.

Supertest'in Temel Özellikleri:

Test Ortamınızı Kurma

Başlamadan önce, temel bir test ortamı kuralım. Node.js ve npm'in (veya yarn'ın) kurulu olduğunu varsayacağız. Test çerçevemiz olarak Jest'i ve API testi için Supertest'i kullanacağız.

  1. Bir Node.js projesi oluşturun:
mkdir api-testing-example
cd api-testing-example
npm init -y
  1. Bağımlılıkları yükleyin:
npm install --save-dev jest supertest
npm install express  # Veya API'yi oluşturmak için tercih ettiğiniz çerçeve
  1. Jest'i yapılandırın: Aşağıdakini package.json dosyanıza ekleyin:
{
  "scripts": {
    "test": "jest"
  }
}
  1. Basit bir API uç noktası oluşturun: Aşağıdaki kodla app.js (veya benzeri) adında bir dosya oluşturun:
const express = require('express');
const app = express();
const port = 3000;

app.get('/hello', (req, res) => {
  res.send('Hello, World!');
});

app.listen(port, () => {
  console.log(`Example app listening at http://localhost:${port}`);
});

module.exports = app; // Test için dışa aktar

İlk Supertest Testinizi Yazma

Artık ortamımız kurulduğuna göre, API uç noktamızı doğrulamak için basit bir Supertest testi yazalım. Projenizin kök dizininde app.test.js (veya benzeri) adında bir dosya oluşturun:

const request = require('supertest');
const app = require('./app');

describe('GET /hello', () => {
  it('responds with 200 OK and returns "Hello, World!"', async () => {
    const response = await request(app).get('/hello');
    expect(response.statusCode).toBe(200);
    expect(response.text).toBe('Hello, World!');
  });
});

Açıklama:

Testi çalıştırmak için terminalinizde aşağıdaki komutu yürütün:

npm test

Her şey doğru ayarlanmışsa, testin geçtiğini görmelisiniz.

Gelişmiş Supertest Teknikleri

Supertest, gelişmiş API testi için geniş bir özellik yelpazesi sunar. Bunlardan bazılarını inceleyelim.

1. İstek Gövdeleri Gönderme

İstek gövdesinde veri göndermek için .send() yöntemini kullanabilirsiniz. Örneğin, JSON verisi kabul eden bir uç nokta oluşturalım:

app.post('/users', express.json(), (req, res) => {
  const { name, email } = req.body;
  // Veritabanında bir kullanıcı oluşturmayı simüle et
  const user = { id: Date.now(), name, email };
  res.status(201).json(user);
});

İşte bu uç noktayı Supertest kullanarak nasıl test edebileceğiniz:

describe('POST /users', () => {
  it('creates a new user', async () => {
    const userData = {
      name: 'John Doe',
      email: 'john.doe@example.com',
    };

    const response = await request(app)
      .post('/users')
      .send(userData)
      .expect(201);

    expect(response.body).toHaveProperty('id');
    expect(response.body.name).toBe(userData.name);
    expect(response.body.email).toBe(userData.email);
  });
});

Açıklama:

2. Başlıkları Ayarlama

İsteklerinizde özel başlıklar ayarlamak için .set() yöntemini kullanabilirsiniz. Bu, kimlik doğrulama belirteçlerini, içerik türlerini veya diğer özel başlıkları ayarlamak için kullanışlıdır.

describe('GET /protected', () => {
  it('requires authentication', async () => {
    const response = await request(app).get('/protected').expect(401);
  });

  it('returns 200 OK with a valid token', async () => {
    // Geçerli bir belirteç almayı simüle et
    const token = 'valid-token';

    const response = await request(app)
      .get('/protected')
      .set('Authorization', `Bearer ${token}`)
      .expect(200);

    expect(response.text).toBe('Protected Resource');
  });
});

Açıklama:

3. Çerezleri Yönetme

Supertest çerezleri de yönetebilir. .set('Cookie', ...) yöntemini kullanarak çerezleri ayarlayabilir veya çerezlere erişmek ve onları değiştirmek için .cookies özelliğini kullanabilirsiniz.

4. Dosya Yüklemelerini Test Etme

Supertest, dosya yüklemelerini yöneten API uç noktalarını test etmek için kullanılabilir. İsteğe dosya eklemek için .attach() yöntemini kullanabilirsiniz.

5. İddia Kütüphanelerini Kullanma (Chai)

Jest'in yerleşik iddia kütüphanesi birçok durum için yeterli olsa da, Supertest ile Chai gibi daha güçlü iddia kütüphanelerini de kullanabilirsiniz. Chai, daha ifade edici ve esnek bir iddia sözdizimi sağlar. Chai'yi kullanmak için onu yüklemeniz gerekir:

npm install --save-dev chai

Ardından, Chai'yi test dosyanıza import edebilir ve iddialarını kullanabilirsiniz:

const request = require('supertest');
const app = require('./app');
const chai = require('chai');
const expect = chai.expect;

describe('GET /hello', () => {
  it('responds with 200 OK and returns "Hello, World!"', async () => {
    const response = await request(app).get('/hello');
    expect(response.statusCode).to.equal(200);
    expect(response.text).to.equal('Hello, World!');
  });
});

Not: Jest'in Chai ile doğru çalışması için yapılandırmanız gerekebilir. Bu genellikle Chai'yi import eden ve onu Jest'in global expect'i ile çalışacak şekilde yapılandıran bir kurulum dosyası eklemeyi içerir.

6. Ajanları Yeniden Kullanma

Belirli bir ortamın (örneğin, kimlik doğrulama) kurulmasını gerektiren testler için, bir Supertest ajanını yeniden kullanmak genellikle faydalıdır. Bu, her test senaryosunda gereksiz kurulum kodunu önler.

describe('Authenticated API Tests', () => {
  let agent;

  beforeAll(() => {
    agent = request.agent(app); // Kalıcı bir ajan oluştur
    // Kimlik doğrulamayı simüle et
    return agent
      .post('/login')
      .send({ username: 'testuser', password: 'password123' });
  });

  it('can access a protected resource', async () => {
    const response = await agent.get('/protected').expect(200);
    expect(response.text).toBe('Protected Resource');
  });

  it('can perform other actions that require authentication', async () => {
    // Burada kimlik doğrulaması gerektiren diğer eylemleri gerçekleştir
  });
});

Bu örnekte, beforeAll kancasında bir Supertest ajanı oluşturuyor ve ajanın kimliğini doğruluyoruz. describe bloğu içindeki sonraki testler, her test için yeniden kimlik doğrulaması yapmak zorunda kalmadan bu kimliği doğrulanmış ajanı yeniden kullanabilir.

Supertest ile API Entegrasyon Testi İçin En İyi Uygulamalar

Etkili API entegrasyon testi sağlamak için aşağıdaki en iyi uygulamaları göz önünde bulundurun:

Kaçınılması Gereken Yaygın Hatalar

Sonuç

API entegrasyon testi, yazılım geliştirme sürecinin önemli bir parçasıdır. Supertest'i kullanarak, uygulamanızın kalitesini ve kararlılığını sağlamaya yardımcı olan kapsamlı ve güvenilir API entegrasyon testleri kolayca yazabilirsiniz. Uçtan uca iş akışlarını test etmeye, gerçekçi veriler kullanmaya, testlerinizi izole etmeye ve test sürecinizi otomatikleştirmeye odaklanmayı unutmayın. Bu en iyi uygulamaları izleyerek, entegrasyon sorunları riskini önemli ölçüde azaltabilir ve daha sağlam ve güvenilir bir ürün sunabilirsiniz.

API'ler modern uygulamaları ve mikro hizmet mimarilerini yönlendirmeye devam ettikçe, sağlam API testinin ve özellikle entegrasyon testinin önemi daha da artacaktır. Supertest, dünya çapındaki geliştiricilerin API etkileşimlerinin güvenilirliğini ve kalitesini sağlamaları için güçlü ve erişilebilir bir araç seti sunar.