7 Mart 2017 Salı

Kod Kapsamı ve Gcov ile Lcov Araçlarının Kullanımı

Herkese merhaba bu senenin ilk döneminde bitirme projemde Libreoffice'de birim testlerin geliştirilmesi üzerine çalışmalarım oldu. Şimdi ise Libreoffice'de kod kapsamı üzerinde çalışıyorum.

Bu yazımda;
    • Kod kapsamının ne olduğundan
    • Projelerin kod kapsamı açısından nasıl geliştirilebileceğinden
    • Kod kapsamıyla ilgili kullanılan araçlardan bahsedeceğim.

Kod Kapsamı: Tam olarak bir orandır. Projede var olan testlerin kontrol ettiği kodun, yazılan bütün koda oranına denir. Sonuç olarak bize bir % vermektedir ve bu oranın 100'e yakın olması amaçlanmaktadır. Projelerde kod kapsamını geliştirirken farklı parametreler değerlendirilir. Bunlara bakacak olursak;

• Yazdığımız testler bütün kod için yetersiz olabilir. Projede test edilmeyen kısımlar için ek olarak birim testler yazılmalıdır.

• Projede ölü kodlar bulunabilir bunlar projeden kaldırılmalıdır.

Gcov ve Lcov: Gcov projelerimizi kod kapsamı bakımından test edebileceğimiz bir araçtır, lcov ise bu test sonuçlarını tarayıcıda görmemizi sağlayan bir araçtır. Şimdi bir dosya üzerinde bu araçların kullanımına bakalım.

hello.cpp isimli dosyamızı kod kapsamı testini gcov ile yapalım.

$ g++ -fprofile-arcs -ftest-coverage hello.cpp -o hello 

komutunu çalıştırarak hello.gcno dosyasını oluşturmuş oluruz. Daha sonra

$ ./hello

komutunu çalıştırıp hello.gcda dosyasını oluştururuz. Şimdi

$ gcov hello.cpp

komutu ile dosyamızda kod kapsamı testi yapmış oluruz ve

çıktısını almış oluruz. Şimdi lcov kullanımına bakalım.

$ lcov --capture --directory . --output-file hello.info

komutunu çalıştırarak hello.info dosyasını oluşturduk.

$ genhtml hello.info --output-directory .

komutunu çalıştırdıktan sonra klasörümüzde index.html dosyası oluşacaktır. Bu dosyayı tarayıcımızda çalıştırdığımızda;


arayüzü karşımıza çıkacaktır buradan dosyaların kod kapsam oranlarına nerelerde hatalar olduğuna bakabiliriz.

Bir sonraki yazımda Libreoffice'de kod kapsamından, nasıl geliştirlebileceğinden ve benim katkılarımdan bahsedeceğim iyi çalışmalar.

15 Ocak 2017 Pazar

LibreOffice Çalışmalarım - 1

Herkese merhaba bu sene bitirme projemi LibreOffice ile ilgili yapıyorum. Bu yazımda ilk dönemde nasıl işler yaptığımdan bahsedeceğim.

Geçen senenin başından itibaren LibreOffice ile ilgili çalışıyorum. Geçen sene çalışmalarım projenin farklı kısımlarıyla ilgili oldu. Öncelikle süreci öğreten hata kayıtlarına kod göndermekle başladım daha sonra LibreOffice veritabanı aracı olan Base üzerinde çalıştım senenin sonunda 6 tane yama gönderdim.

Bu sene bitirme projemde ise LibreOffice'de birim testler üzerine çalışıyorum. Projede Java ile yazılmış birim testlerin Python ve C++ ortamlarına geçirilmesi isteniyor. Var olan testlerin ise yeni getirilen özellikler ile değiştirilmesi isteniyor.

Python testlerinde değiştirilmesi istenen özellikler vardı. 2 farklı modüldeki python testlerin büyük bir kısmına bu özellikleri kazandırdım ve 10 tane yama gönderdim.

C++ testlerinde ise kod kapsamayı olumsuz yönde etkileyen kod kapsama oranını düşüren kısımların düzeltilmesi ile ilgili çalıştım. LibreOffice'de yazılmış olan kodlardaki kod kapsama oranlarına şuradan ulaşabilirsiniz. Bu konuyla ilgili de 6 tane yama gönderdim.

Bu çalışmalarıma ek olarak LibreOffice projesinde Almanca kullanılan kelimelerin İngilizce'ye çevirilmesi isteniyor. Bu hata kaydını seviyorum doğrusu, çalışmaya ara verdiğim zamanlarda bununla ilgili çalışıyorum :) Bu konuyla ilgili de 3 tane yama gönderdim.

LibreOffice deposuna gönderdiğim yamaların linklerine şuradan ulaşabilirsiniz.
 
İyi çalışmalar.

17 Eylül 2016 Cumartesi

ODC İş Çözümleri Yaz Stajı

Herkese merhaba, ikinci stajımı bu yaz ODC'de yaptım ve bu süre içerisinde kazanmış olduğum deneyimlerimi paylaşmak istedim.

Stajım iki ay sürdü. İlk ayda Swagger üzerine çalıştım. Bir rest apinin nasıl Swagger uyumlu hale getirileceğini öğrendim. Diğer Swagger araçlarını (Swagger Codegen, Swagger UI, Swagger Core ) da öğrenip üzerinde çalıştığım projede uyguladım. Swagger çalışmalarıma ek olarak ilk ayda Bootstrap öğrendim. Uygulama olarak Bootstrap ile bir form oluşturdum, bu formdaki girilen bilgileri bir servise gönderdim. İkinci ayda ise JUnit üzerine çalışmalar yaptım. 1 ay boyunca birim test ile ilgilenmem çok faydalı oldu benim için. Büyük çaplı projelerdeki birim testin önemini anlamış oldum. Nelerin test edilmesi gerektiğini, hangi amaçla test edildiğini öğrenmiş oldum.

Staj maceramın :) neler yaptım kısmı böyleydi. Şimdi duygu ve düşüncelere geçmek istiyorum.

Staj çıkışında metrobüste eve dönerken; akşama hangi konulara bakmam gerektiğini ve o gün neler öğrendiğimi düşündüğümde doğru yolda olduğumu anladım :) Tam bunu anladığımda Eluveitie - Vianna şarkısı çalıyordu. Beni motive eden parçalardan birisidir dayanamadım sizle de paylaştım.

Kavacık ciddi anlamda çok güzel e-si-yor-du :) Öğle aralarımız çok eğlenceli geçiyordu.

Stajda aklıma gelen her soruyu sorduğumda göstermiş oldukları sabırdan dolayı :) +Serdar Yiğit +ibrahim halil altun , Sinan Dirlik ve Nevra Aşuk'a çok teşekkür ederim. Bana yapmış olduğunuz bütün tavsiyeleri ve uyarıları dikkate aldım. Çok güzel zamanlardı benim için özlüyor insan :( İlk defa bir yazımda bu kadar duygusal cümleler kuruyorum :)

Stajda olduğum süre içerisinde bana yardımcı olan herkese ve ODC'ye teşekkür etmek istiyorum.


Son olarak stajımla ilgili sevdiğim sloganım "More than an Internship :) "

16 Ağustos 2016 Salı

Birim Test ve JUnit Kullanımı

Herkese merhaba, bu yazımda Birim Test ve Java'nın bir kütüphanesi olan JUnit'den bahsedeceğim. Yazının içeriğine alt başlıklar halinde şöyle bir bakacak olursak;

Birim Test nedir?
Yazılım Projesinde Birim Test'in Önemi nedir?
JUnit nedir? - Junit'de kullanılan assertion / annotation kavramları nelerdir?
Eclips'de JUnit oluşturulması ve çalıştırılması nasıl olur?

    Birim Test
En basit anlamda projemizdeki fonksiyonların çalışıp çalışmadığını kontrol eder. Birden fazla birim testimiz olabilir fakat hepsi birbirinden bağımsız çalışmalıdır. Yani her test için odaklanılan tek nokta vardır. Testler sonuç olarak bize true / false döndürürler.
Birim Test hataları bulmak için kullanılmaz, bizim verdiğimiz girdiler ile fonksiyonun çalışırlığını kontrol eder.
Projemizde kaç tane fonksiyon varsa o kadar test olmalıdır.
Birim Test nedir? sorusuna cevap bulduktan sonra şimdi neden kullanılıra gelelim;

    Yazılım Projesinde Birim Test'in Önemi nedir?
Bize kaliteli kod yazmamızı sağlar. Projeyi geliştirme esnasında yanlışlarımızı görmemizi sağlar. Bütün bileşenleri birbirinden bağımsız bir biçimde tasarlamış oluruz. Böylelikle bakımı daha kolay ve kaliteli bir yazılım ortaya çıkar.
Şimdi Java'da test olayına bakalım;

    JUnit nedir? - Junit'de kullanılan assertion / annotation kavramları nelerdir?
Projemizde bulunan fonksiyonların doğru çıktı verip vermediğini kontrol etmemize yarayan Java kütüphanesidir. Testimizin çalışabilmesi için öncesinde ve sonrasında olması gereken işlemler olabilir. Örnek olarak test edeceğimiz fonksiyonun çalışabilmesi için bir veritabanı bağlantısı gerekiyorsa bunu testten önce sağlamamız gerekir. Böyle durumlarda annotation kullanırız. Testlerde kullanılan annotation'lara bakarsak;

@Test :  Metodun test edileceğini gösterir
@Test(expected = Exception.class) :  Metod hata fırlatmalıdır
@Before : Metodtan önce çalışır.
@After :  Metodtan sonra çalışır
@BeforeClass : Sınıf instance olduğunda bir defalığına çalışır
@AfterClass :  Metodları test ettikten sonra çalışır
@Ignore : Test edilmesini istemediğimiz metodları temsil eder

Test ettiğimiz fonksiyonların dönüş değerlerine göre durum karşılaştırmaları yaptığımız assertionlar vardır.
Bunların kullanımına bakacak olursak;

public class OrnekTest{
 
 @Test
 public void tabikiTest(){
  String name = "Kerem";
  assertEquals(name, OrnekSinif.getPersonName());
 }
}

OrnekSinif(nasıl bir sınıf ismiyse :D )'ın getPersonName() fonksiyonundan dönen isim ile bizim oluşturduğumuz ismi karşılaştırıyoruz.
assertEquals() metodu bu iki değer doğruysa test sonucunu true olarak döndürecektir.
Birçok assertion bulunmaktadır bunların tam listesi.

Şimdi artık Eclips'te bir JUnit oluşturup, çalıştırmaya bir bakalım:

✖ Öncelikle projemize JUnit bağımlılıklarını ekliyoruz.

<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.12</version>
</dependency>

✖  New → Other  JUnit → JUnit Test Case 
Daha sonra testimizin ismini belirleyip Finish diyoruz.

import org.junit.Test;


public class TestOrnek {

 @Test
 public void test() {
  fail("Not yet implemented");
 }
}

Oluşan testimizin içeriği böyle oluyor.
Burada @Test kısmına girdileri verip sonuçların doğruluğunun kontrolünü yaparız.

Şimdi bu testimize örnek bir uygulama yapalım.

import static org.junit.Assert.*;
import org.junit.Test;

public class TestOrnek {
 public int topla(int x, int y){
  int sonuc = 0;
  sonuc = x + y;
  return sonuc;
 }
 @Test
 public void test() {
  int sonuc=0;
  sonuc = topla(5, 10);
  assertEquals(15, sonuc);
 }
}

Burada eğer topla fonksiyonumuzun sonucu 15 ise testimiz true olarak dönüş yapacaktır.


Testimizin çalışırlığını böylece kontrol etmiş oluruz.
İyi çalışmalar.

4 Ağustos 2016 Perşembe

Bootstrap Kullanarak Form Oluşturmak

Herkese merhaba, web kütüphanelerinden biri olan Bootstrap ile girilen bir json formatını kullanarak form oluşturmaktan bahsedeceğim.

Öncelikle Bootstrap'in ne olduğu hakkında bir şeyler söyleyecek olursam;

Bootstrap; HTML, CSS ve JS'i bir arada bulunduran ve bunları kullanarak web arayüzü geliştirebildiğimiz bir kütüphanedir.
CSS'e ek olarak CSS önişlemcisi olan Less ve Sass'ı kullanır.

Bootstrap açık kaynaklı bir kütüphanedir. Github projesine buradan bakabilirsiniz.

Bootstrap sayfasında birçok uygulayabileceğimiz örnekler bulunmaktadır.

Şimdi bir json girdisine karşılık gelen formumuzu oluşturalım.

1-) İlk adım olarak formumuzda hangi alanların oluşmasını istiyorsak o alanları json formatında javascript kodumuzun içerisinde belirtiyoruz.
var fields, form;

fields = [ 
    {
        name: 'username',
        label: 'Username',
        type: 'text'
    }, {
        name: 'password',
        label: 'Password',
        type: 'password'
    }, {
        name: 'fruit',
        label: 'Fruit',
        choices: [
            ['apple', 'Apple'],
            ['pear', 'Pear'],
            ['orange', 'Orange']
        ],
        type: 'selectmultiple2' 
     }, {
        label: 'Submit',
        type: 'submit',
        class: 'btn-danger',
        icon: 'ok'
    }];

2-) Daha sonra bu json girdisini alıp alanlarıyla form oluşturabileceğimiz formata çeviriyoruz.

fields = JSON.stringify(fields);
        fields = formatter.formatjson(fields);
        demoInput = $('#form-demo-input');
        demoInput.val(fields);
          
        outputForm = $('#form-demo-output');
        outputForm.submit(function() {return false});
Bu işlemleri gerçekleştirdiğimizde formumuz şekildeki gibi oluşur;


Kodun tamamı ve uyguladığım örneğe linkten ulaşabilirsiniz.
İyi çalışmalar ve kolaylıklar dilerim.

1 Ağustos 2016 Pazartesi

Rest Api'yi Swagger Uyumlu Hale Getirmek

Herkese merhaba, bu yazımda bir Rest Apinin Swagger uyumlu hale getirilmesindeki adımlardan bahsedeceğim. Neleri eklememiz gerektiğinden, hangi özellikler için hangi metodları kullandığımızdan bahsedeceğim.

*Swagger-UI: 
Bir bağımlılığa sahip değildir, kendi yerel makinemizde çalıştırabiliriz. Apinin swagger uyumlu hale geldikten sonraki görüntüsüne örnek olarak petstore uygulaması verilebilir.

Şimdi apiyi swagger uyumlu hale getirmek için izlenecek adımları sırayla uygulamaya başlayalım.

1-)Öncelikle apimizde bulunan pom.xml dosyasının içine gereken bağımlılıkları ekliyoruz.

<dependency>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-jaxrs</artifactId>
    <version>${swagger-version}</version>
    <scope>compile</scope>
</dependency>
2-) Daha sonra buradan Swagger-ui paketini indiriyoruz.

-> Bu indirdiğimiz paketin içindeki dist klasörünün içindeki bütün dosyaları kopyalıyoruz.
-> Projemizin içinde src/main/webapp içine bir swagger klasörü oluşturalım. Kopyaladığımız bütün dosyaları bu klasörün içine yapıştıralım.

3-) Şimdi de webconfig.java dosyamızın içine port bilgisi, url bilgisi, uygulama adı gibi swaggerı servera tanımlayacak bilgileri giriyoruz.

4-) Şimdi ise apimizi swagger uyumlu hale getirebilmek için kod içeriklerinde değişiklikler yapıyoruz.

Bu kısımda birçok ek açıklamalar kullanıyoruz.

@Api: Başına getirilen sınıfı bir swagger kaynağı olarak işaretler.

@ApiModel: Swagger modelleri hakkında bilgiler eklememizi sağlar.

@ApiOperation: Özel olarak belirlediğimiz bir yola karşılık gelen bir tanımlama yapar.

@ApiParam: İşlemdeki parametreleri tanımlarız.

@ApiResponse: İşlem sırasında oluşabilecek hataları tanımlarız.

Tüm bunları gerçekleştirdikten sonra şekildeki gibi bir görüntü çıkar.

Burada petstore uygulamasının Pet, Store ve User modellerinden User'ın içindeki işlemler yer almaktadır.

Bu uygulamanın kaynak kodu şu adreste bulunmaktadır.
 İyi çalışmalar dilerim.

27 Temmuz 2016 Çarşamba

Swagger-Codegen ile Kod Oluşturma

Selamlar, bu yazımda Swagger araçlarından biri olan Swagger-Codegen ile var olan bir apiyi generate etmekten bahsedeceğim.

Öncelikle Kod Oluşturma nedir bunu açıklayacak olursam;
Var olan kodlara kod yazma yeteneği kazandırma işlemidir diyebiliriz. Örneğin elimizde herhangi bir dilde yazılmış bir api var. Biz bunu başka bir dile çevirmek istiyoruz. Bu noktada Kod Oluşturma yapmamız gerekmektedir. Birçok dilde bu işleme özel araçlar bulunmaktadır.

Ben bu yazımda bahsettiğim örneği açıklayacağım. Bir dilde yazılmış örnek bir apiyi Swagger-Codegen aracını kullanarak başka bir dile generate edilişinden bahsedeceğim.

*Swagger-Codegen

 Apiyi generate ederken Java kullanacağım.

-> Öncelikle Swagger-Codegen .jar dosyasını buradan indirmemiz gerekiyor.

-> Daha sonra aşağıdaki komutları sırasıyla uygulayarak elimizde bulunan apiyi istediğimiz bir dile çevirebiliriz.

$ git clone https://github.com/swagger-api/swagger-codegen

$ cd swagger-codegen

$ mvn clean package

$ java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar
        generate \
    -i  http://petstore.swagger.io/v2/swagger.json \
    -l  php \
    -o /var/tmp/php_api_client

Adımlarını takip ederek apiyi php dilindeki haline generate etmiş oluruz.

Buradaki parametrelere bakacak olursak;
i: Apinin .json linki
l: Generate etmek istediğimiz dil
o: Generate etmek istediğimiz yerin uzantısı

Hangi dillere generate edebileceğimizi öğrenmek için;

$ ls -1 modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/

Daha fazla bilgiyi Swagger-Codegen Github sayfasından edinebilirisiniz.
Umarım faydalı olmuştur iyi çalışmalar.