Postman ile RESTful API’lere Test Otomasyonu Hazırlamak Bölüm 5

Bölüm 5: Postman Runner, Newman Entegrasyonu ve Html Reporter İşlemleri

Sizlere aktaracağım serinin bu bölümünde yazmış olduğumuz herhangi bir collection için runner işlemini gerçekleştireceğiz.

Öncelikle headerbar üzerinde solda yer alan “Runner” adlı butona tıklamalıyız.

Açılan runner penceresinde sol üst tarafta liste şeklinde gelen klasörler bizim yapmış olduğumuz tüm collectionlardır.
Runner işlemi yapmak için bir “collection” seçimi yapılmak zorundadır. “Environment” alanında ise oluşturduğumuz environmentlardan hagisi ile mevcut runner işlemini başlatmak istediğimizi seçmeliyiz. “Iterations” alanında ise işlemlerin kaç kere iterasyona girmesini istediğimizi belirleriz. Üstteki ayarları yaptıktan sonra “Start Run” butonuna tıkladığımız zaman seçtiğimiz collection run edilecektir.
Üstteki görselde sağ tarafta bulunan liste daha önce run edilmiş collectionların raporlarını tutmaktadır. Bu run işlemlerinde işlem tarihleri, işleme alınmış collection, pass olmuş ve fail olmuş testler gösterilir. İstenildiğinde bu raporlar indirilebilir veya daha önce edinilmiş raporlar bu rapor listesine önceki raporlarla karşılaştırma amacı ile dahil edilebilir.

Hadi şimdi start run butonuna tıklayalım ve runner’ın nasıl çalıştığını inceleyelim.
Seçilen collection içerisindeki requestler runner içerisinde sırasıyla teker teker çalıştırılır ve isteklerin içerisinde bulunan testlerin sonuçları run result’a yansımaya başlar.

Üst görselde sol üst tarafta vurgulanan alanda run edilen collection’ a ait isteklerde bulunan testlerin kaç tanesinin pass olduğu ve kaç tanesinin fail olduğu görülmektedir.

Üst görselde, alt kısımda vurgulanan alanda görülen listede ise pass olan ve fail olan testlerin hangi istek(request)lere bağlı olduğunu, hangi istekte hangi testlerin çalışıp hangilerinin fail olup olmadığını, bu isteklerden dönen durum kodları ve açıklamalarını ve teker teker her isteğin çalışmasının ne kadar zaman aldığını detaylı olarak görüntüleyebiliriz.

Gene üst görselde sağ üst tarafta vurgulanan alanda “Export Result” butonuna tıklayarak bu sonuçları daha sonra karşılaştırmak üzere kayıt edebiliriz. “Retry” butonuna tıklayarak run işlemini tekrarlayabilir “New” butonuna tıklayarakta yeni bir runner penceresi açabiliriz.

Şimdi gelelim bu işlemlerin Newman ile entegrasyonuna….

Öncelikle sorulması gereken soru nedir bu Newman ?
Newman, Postman üzerindeki collection’larımızı Postman Runner üzerinden değil de doğrudan komut satırları kullanarak koşmamızı, test etmemizi ve raporlamamızı sağlayan bir Npm (Node Package Manager) teknolojisidir.
Collection’larımızı Newman ile komut satırından çalıştırabilmemiz için öncelikle node.js indirmemiz ve yüklememiz gerekmektedir. https://nodejs.org/en/ sitesi üzerinden node.js indirip yüklenilebilir.

Yüklememiz tamamlandıktan sonra komut satırını (cmd) açıp “npm install –g newman” komutunu yazıp çalıştırdığımızda Newman kurulumunu gerçekleştirmiş olacağız. Artık komut satırıyla Postman testlerimizi koşabiliriz.

Bu yüklemeden sonra yapılan testlerin raporunu çıkartabilmek için “npm install –g newman-reporter-html” ve “npm install –g newman-reporter-htmlextra” komutlarını yazıp çalıştırarak raporlama için ihtiyacımız olan eklentiyi kurmuş oluyoruz.

Şimdi Newman üzerinde hangi komutları kullanabileceğimizi “newman run –h” komutunu çalıştırarak öğrenelim.

Bu testleri koşmanın birden fazla yöntemi var ben collection ve environmentlarımızı export ederek komut satırıyla bu export edilen dosyaları koşturma yöntemini anlatacağım.

1. Adım : Aşağıdaki görselde görüldüğü gibi collection ve environmentlar ayrı ayrı export edilir. Bunu yaparken ikisini de aynı klasör içine export etmeniz en doğru seçim olacaktır.

2. Adım: Cmd açılır ve “cd” komutu kullanılarak collection ve environment’ larımızı export ettiğimiz location içine gidilir.
Örnek: cd desktop ve cd postman.

3. Adım: Komut satırımıza newman run collection adı ve uzatısı -e environment adı ve uzantısı şeklinde komut girip çalıştırdığımızda testlerimizi koştuğumuzu göreceğiz.

4. Adım: Komut satırımıza newman run collection adı ve uzatısı -e environment adı ve uzantısı -r htmlextra — reporter-htmlextra-export raporunuzu çıkartmak istediğiniz konum/raporunuza vermek istediğiniz isim.html şeklinde komut girip çalıştırdığımızda testlerimiz koşulacak ve koşulan testlerin html raporu komutumuzda verdiğimiz konuma eklenecektir.

İşlemimiz bittiğinde belirttiğimiz konumda beliren html raporunu çalıştırdığımızda aşağıdaki görselde görüldüğü gibi html raporumuzu görüntülemiş olacağız.

Bu rapor üzerinde başarılı ve başarısız testlerimizi kontrol edebilir ayrıca bu testlerde yolladığımız istekleri aldığımız cevapları da inceleyebiliriz.

Teşekkürler.

Ali Erhan Akyürek