6.7 KiB

Raw Blame History

Test Etme

Starlette sayesinde FastAPI uygulamalarını test etmek kolay ve keyiflidir.

Temelde HTTPX üzerine kuruludur; HTTPX de Requests’i temel alarak tasarlandığı için oldukça tanıdık ve sezgiseldir.

Bununla birlikte FastAPI ile pytest'i doğrudan kullanabilirsiniz.

`TestClient` Kullanımı

/// info | Bilgi

TestClient kullanmak için önce httpx'i kurun.

Bir Sanal Ortam{.internal-link target=_blank} oluşturduğunuzdan, onu aktifleştirdiğinizden ve sonra kurulumu yaptığınızdan emin olun; örneğin:

$ pip install httpx

///

TestClient'ı import edin.

FastAPI uygulamanızı ona vererek bir TestClient oluşturun.

Adı test_ ile başlayan fonksiyonlar oluşturun (bu, pytest'in standart konvansiyonudur).

TestClient nesnesini httpx ile kullandığınız şekilde kullanın.

Kontrol etmeniz gereken şeyler için standart Python ifadeleriyle basit assert satırları yazın (bu da pytest standardıdır).

{* ../../docs_src/app_testing/tutorial001_py310.py hl[2,12,15:18] *}

/// tip | İpucu

Test fonksiyonlarının async def değil, normal def olduğuna dikkat edin.

Client'a yapılan çağrılar da await kullanılmadan, normal çağrılardır.

Bu sayede pytest'i ek bir karmaşıklık olmadan doğrudan kullanabilirsiniz.

///

/// note | Teknik Detaylar

İsterseniz from starlette.testclient import TestClient da kullanabilirsiniz.

FastAPI, geliştirici olarak size kolaylık olsun diye starlette.testclient'ı fastapi.testclient üzerinden de sunar. Ancak asıl kaynak doğrudan Starlette'tır.

///

/// tip | İpucu

FastAPI uygulamanıza request göndermenin dışında testlerinizde async fonksiyonlar çağırmak istiyorsanız (örn. asenkron veritabanı fonksiyonları), ileri seviye bölümdeki Asenkron Testler{.internal-link target=_blank} dokümanına göz atın.

///

Testleri Ayırma

Gerçek bir uygulamada testlerinizi büyük ihtimalle farklı bir dosyada tutarsınız.

Ayrıca FastAPI uygulamanız birden fazla dosya/modül vb. ile de oluşturulmuş olabilir.

FastAPI Uygulama Dosyası

Daha Büyük Uygulamalar{.internal-link target=_blank}'te anlatılan şekilde bir dosya yapınız olduğunu varsayalım:

.
├── app
│   ├── __init__.py
│   └── main.py

main.py dosyasında FastAPI uygulamanız bulunuyor olsun:

{* ../../docs_src/app_testing/app_a_py310/main.py *}

Test Dosyası

Sonra testlerinizin olduğu bir test_main.py dosyanız olabilir. Bu dosya aynı Python package içinde (yani __init__.py dosyası olan aynı dizinde) durabilir:

.
├── app
│   ├── __init__.py
│   ├── main.py
│   └── test_main.py

Bu dosya aynı package içinde olduğu için, main modülünden (main.py) app nesnesini import etmek üzere relative import kullanabilirsiniz:

{* ../../docs_src/app_testing/app_a_py310/test_main.py hl[3] *}

...ve test kodunu da öncekiyle aynı şekilde yazabilirsiniz.

Test Etme: Genişletilmiş Örnek

Şimdi bu örneği genişletelim ve farklı parçaların nasıl test edildiğini görmek için daha fazla detay ekleyelim.

Genişletilmiş FastAPI Uygulama Dosyası

Aynı dosya yapısıyla devam edelim:

.
├── app
│   ├── __init__.py
│   ├── main.py
│   └── test_main.py

Diyelim ki FastAPI uygulamanızın bulunduğu main.py dosyasında artık başka path operations da var.

Hata döndürebilecek bir GET operation'ı var.

Birden fazla farklı hata döndürebilecek bir POST operation'ı var.

Her iki path operation da X-Token header'ını gerektiriyor.

{* ../../docs_src/app_testing/app_b_an_py310/main.py *}

Genişletilmiş Test Dosyası

Sonrasında test_main.py dosyanızı genişletilmiş testlerle güncelleyebilirsiniz:

{* ../../docs_src/app_testing/app_b_an_py310/test_main.py *}

Client'ın request içinde bir bilgi göndermesi gerektiğinde ve bunu nasıl yapacağınızı bilemediğinizde, httpx ile nasıl yapılacağını aratabilirsiniz (Google) ya da HTTPX’in tasarımı Requests’e dayandığı için requests ile nasıl yapıldığını da arayabilirsiniz.

Sonra testlerinizde aynısını uygularsınız.

Örn.:

Bir path veya query parametresi geçirmek için, URL’nin kendisine ekleyin.
JSON body göndermek için, json parametresine bir Python nesnesi (örn. bir dict) verin.
JSON yerine Form Data göndermeniz gerekiyorsa, bunun yerine data parametresini kullanın.
headers göndermek için, headers parametresine bir dict verin.
cookies için, cookies parametresine bir dict verin.

Backend'e veri geçme hakkında daha fazla bilgi için (httpx veya TestClient kullanarak) HTTPX dokümantasyonu'na bakın.

/// info | Bilgi

TestClient'ın Pydantic model'lerini değil, JSON'a dönüştürülebilen verileri aldığını unutmayın.

Testinizde bir Pydantic model'iniz varsa ve test sırasında verisini uygulamaya göndermek istiyorsanız, JSON Uyumlu Encoder{.internal-link target=_blank} içinde açıklanan jsonable_encoder'ı kullanabilirsiniz.

///

Çalıştırma

Bundan sonra yapmanız gereken tek şey pytest'i kurmaktır.