M
Muhammet Kerem Öztürk
Misafir
Misafir
Eğer okumadıysanız bu içeriği okumadan önce "NodeJS ile API Testi Nasıl Yapılır?" başlıklı içeriği okuyabilirsiniz.
İlk olarak, projenin ana dizininde terminal açılmalı ve Mocha, Chai ve isteğe bağlı olarak diğer test araçları yüklenmelidir. Bu işlem aşağıdaki komut kullanılarak yapılabilir:
$ npm install --save-dev mocha chai
Bu komut, Node.js projesi için Mocha ve Chai paketlerini yükleyecektir. Ardından, test dosyalarınızı bir klasörde toplamanız gerekmektedir.
Test dosyalarınızı oluşturduktan sonra testlerinizi yazabilir ve Mocha'ya yürütmesi için terminalde mocha komutunu kullanabilirsiniz. Mocha, testlerinizi otomatik olarak tespit edecek ve çalıştıracaktır.
Test işlemeleri esnasında kullanmak amacıyla yeni bir veri tabanı oluşturmak ve konfigürasyon dosyasında test ortamı için yeni oluşturulan veri tabanı bilgilerini girmek daha sağlıklı olacaktır. Bu sayede geliştirme ortamında kullanılan veriler zarar görmeden testler gerçekleştirilebilir. Sequelize ORM paketi ile geliştirme yapılırken oluşturulan migration ve seeder'ları değiştirmeden test veri tabanını belirterek tekrardan çalıştırmak mümkündür. Aşağıda örnek kullanım gösterilmiştir.
$ NODE_ENV=test npx sequelize-cli db:migrate
$ NODE_ENV=test npx sequelize-cli seed:all
Komut çalıştırırken test ortamında işlem yapmak için komutun başına NODE_ENV=test yazmanız yeterli olacaktır.
Öncelikle oluşturulan yeni veri tabanı için config.json dosyası içerisine test objesi eklenir ve yeni veri tabanı için gerekli giriş bilgileri belirtilir.
Ardından Sequelize ile oluşturulan migration'lar ve seeder'lar test ortamında çalıştırılarak ilişkiler ve kayıtlar oluşturulur.
Daha sonra ana dizin altında test klasörü oluşturulur ve içerisinde kullanılacak test dosyaları oluşturulur.
Kod kısmında ilk olarak yukarıda bahsedildiği üzere HTTP sorgularını doğrulayacak olan chai ve chaiHttp kütüphaneleri dahil edilir. Ardından HTTP istekleri atarken kullanmak için server kodunun yazılı olduğu index dosyası dahil edilir. Yazım kolaylığı sağlamak amacıyla chai assertion'ı olan should, değişkene atanarak kullanıma hazır hale getirilir. Son olarak HTTP isteklerini gerçekleştirebilmek adına chai'nin chaiHttp kütüphanesini kullanması sağlanır.
Örneğimizde testler User modeli ve işlevleri için yapılacağından ilk olarak describe() fonksiyonu olarak bir Users alanı tanımlanır ve oturum yahut çerez kullanımı için bu alan içerisinde agent tanımlanır.
Kayıt işlemi için yapılan bu teste describe() fonskiyonu ile başlanır. Ardından it fonksiyonu fonksiyonun işlevi ve geri dönüş değeri belirtilerek kullanılır. Daha sonra beforeEach içerisinde tanımlanan agent ile API içerisinde belirlenen adrese post isteği atılır ve gerekli alanlar .send() fonksiyonu ile gönderilir. .end() içerisindeyse geri dönüş değerinin isterlerimizi karşılayıp karşılamadığı kontrol edilir. Örnekte response değerinin statüsünün 200 olması, dönen değerin br obje tipinde olması, type ve message adında iki property bulundurması ve type'ın true değerine sahip olması beklenmektedir.
Kayıt işlemine benzer şekilde login işlemi için de test yazılmış ve aynı şema kullanılmıştır. BeforeEach metodu içerisinde kullanılan kullanıcıdan farklı bir kullanıcı ile test yapılmış bu sayede isterler daha sağlıklı bir şekilde karşılaştırılmıştır.
Get isteği içinde benzer şekilde adımlar uygulanmış ve dönüş değerinin statüsü ve obje olup olmadığı test edilmiştir.
Son olarak delete isteği için de benzer şekilde adımlar uygulanmış ve silinecek kullanıcı id'si parametre olarak istek içerisine dahil edilmiştir. Örnekte bu id manuel olarak verilmiştir. İsteğe bağlı olarak farklı yöntemler uygulanabilir.
Testimizi yürütürken her seferinde komut satırına uzun uzadıya argümanları ve ayarları yazmak yerine package.json dosyası içerisine script alanı altına test değişkeni eklenerek örnekteki gibi başta test ortamı belirtilerek mocha çerçevesi ile testin çalıştırılması gerektiği belirtilir ve npm test komutu ile kolayca ulaşılabilir.
Test yürütüldüğü takdirde beklenen çıktı aşağıda gösterilen şekildedir.
Geliştirme yaparken eslint kullanılıyorsa varsayılan ayarlar chai assertionları ile uygun çalışmayabilir. Bu durumda aşağıda belirtilen komut yardımıyla eslint-plugin-chai-friendly paketi indirilir.
.eslintrc.js dosyası içerisine overrides alanı açılarak test dosyalarında kullanmak üzere gerekli konfigürasyonlar eklenebilir.
Kodun tamamına
NodeJS ile Test Ortamı İmpelementasyonu
İlk olarak, projenin ana dizininde terminal açılmalı ve Mocha, Chai ve isteğe bağlı olarak diğer test araçları yüklenmelidir. Bu işlem aşağıdaki komut kullanılarak yapılabilir:
$ npm install --save-dev mocha chai
Bu komut, Node.js projesi için Mocha ve Chai paketlerini yükleyecektir. Ardından, test dosyalarınızı bir klasörde toplamanız gerekmektedir.
Test dosyalarınızı oluşturduktan sonra testlerinizi yazabilir ve Mocha'ya yürütmesi için terminalde mocha komutunu kullanabilirsiniz. Mocha, testlerinizi otomatik olarak tespit edecek ve çalıştıracaktır.
Test işlemeleri esnasında kullanmak amacıyla yeni bir veri tabanı oluşturmak ve konfigürasyon dosyasında test ortamı için yeni oluşturulan veri tabanı bilgilerini girmek daha sağlıklı olacaktır. Bu sayede geliştirme ortamında kullanılan veriler zarar görmeden testler gerçekleştirilebilir. Sequelize ORM paketi ile geliştirme yapılırken oluşturulan migration ve seeder'ları değiştirmeden test veri tabanını belirterek tekrardan çalıştırmak mümkündür. Aşağıda örnek kullanım gösterilmiştir.
$ NODE_ENV=test npx sequelize-cli db:migrate
$ NODE_ENV=test npx sequelize-cli seed:all
Komut çalıştırırken test ortamında işlem yapmak için komutun başına NODE_ENV=test yazmanız yeterli olacaktır.
Örnek İmpelementasyon
Öncelikle oluşturulan yeni veri tabanı için config.json dosyası içerisine test objesi eklenir ve yeni veri tabanı için gerekli giriş bilgileri belirtilir.
Ardından Sequelize ile oluşturulan migration'lar ve seeder'lar test ortamında çalıştırılarak ilişkiler ve kayıtlar oluşturulur.
Daha sonra ana dizin altında test klasörü oluşturulur ve içerisinde kullanılacak test dosyaları oluşturulur.
Kod kısmında ilk olarak yukarıda bahsedildiği üzere HTTP sorgularını doğrulayacak olan chai ve chaiHttp kütüphaneleri dahil edilir. Ardından HTTP istekleri atarken kullanmak için server kodunun yazılı olduğu index dosyası dahil edilir. Yazım kolaylığı sağlamak amacıyla chai assertion'ı olan should, değişkene atanarak kullanıma hazır hale getirilir. Son olarak HTTP isteklerini gerçekleştirebilmek adına chai'nin chaiHttp kütüphanesini kullanması sağlanır.
Örneğimizde testler User modeli ve işlevleri için yapılacağından ilk olarak describe() fonksiyonu olarak bir Users alanı tanımlanır ve oturum yahut çerez kullanımı için bu alan içerisinde agent tanımlanır.
Bu bağlantıyı görüntüleyebilmek için kayıt olmalı zaten üyeyseniz üye girişi yapmalısınız.
bahsedildiği üzere bu sayede oturum kapanmadan isteklere devam edilebilir. Ardından beforeEach() hook'u içerisinde server'a giriş isteği atılır. Bu işlem esnasında veri tabanında kaydı bulunan bir kullanıcı adı ve şifre gönderilir. Bu sayede başarılı bir şekilde giriş işlemi gerçekleştirilir ve bu sayede oturumumuz başlamış olur. Should assertion'ı ile 200 değerinin döndüğüne emin olup done() komutu ile bu işlemi sonlandırırız. Bu sayede beforeEach() içerisinde her testten önce giriş yapılarak oturum başlatılmış olur ve diğer işlevlere erişim sağlanır.
Kayıt işlemi için yapılan bu teste describe() fonskiyonu ile başlanır. Ardından it fonksiyonu fonksiyonun işlevi ve geri dönüş değeri belirtilerek kullanılır. Daha sonra beforeEach içerisinde tanımlanan agent ile API içerisinde belirlenen adrese post isteği atılır ve gerekli alanlar .send() fonksiyonu ile gönderilir. .end() içerisindeyse geri dönüş değerinin isterlerimizi karşılayıp karşılamadığı kontrol edilir. Örnekte response değerinin statüsünün 200 olması, dönen değerin br obje tipinde olması, type ve message adında iki property bulundurması ve type'ın true değerine sahip olması beklenmektedir.
Kayıt işlemine benzer şekilde login işlemi için de test yazılmış ve aynı şema kullanılmıştır. BeforeEach metodu içerisinde kullanılan kullanıcıdan farklı bir kullanıcı ile test yapılmış bu sayede isterler daha sağlıklı bir şekilde karşılaştırılmıştır.
Get isteği içinde benzer şekilde adımlar uygulanmış ve dönüş değerinin statüsü ve obje olup olmadığı test edilmiştir.
Son olarak delete isteği için de benzer şekilde adımlar uygulanmış ve silinecek kullanıcı id'si parametre olarak istek içerisine dahil edilmiştir. Örnekte bu id manuel olarak verilmiştir. İsteğe bağlı olarak farklı yöntemler uygulanabilir.
Testimizi yürütürken her seferinde komut satırına uzun uzadıya argümanları ve ayarları yazmak yerine package.json dosyası içerisine script alanı altına test değişkeni eklenerek örnekteki gibi başta test ortamı belirtilerek mocha çerçevesi ile testin çalıştırılması gerektiği belirtilir ve npm test komutu ile kolayca ulaşılabilir.
Test yürütüldüğü takdirde beklenen çıktı aşağıda gösterilen şekildedir.
Geliştirme yaparken eslint kullanılıyorsa varsayılan ayarlar chai assertionları ile uygun çalışmayabilir. Bu durumda aşağıda belirtilen komut yardımıyla eslint-plugin-chai-friendly paketi indirilir.
.eslintrc.js dosyası içerisine overrides alanı açılarak test dosyalarında kullanmak üzere gerekli konfigürasyonlar eklenebilir.
Kodun tamamına
Bu bağlantıyı görüntüleyebilmek için kayıt olmalı zaten üyeyseniz üye girişi yapmalısınız.
adresinden ulaşılabilir.
Bu bağlantıyı görüntüleyebilmek için kayıt olmalı zaten üyeyseniz üye girişi yapmalısınız.