Lua için Dallanma Kapsamı: cluacov ile En Yüksek Hassasiyetli Testler

Lua projelerinde test kapsamını ölçmek, genellikle satır bazlı bir soruya yanıt aramak anlamına gelir: "Bu satır çalıştı mı?" Ancak gerçek test kalitesi, farklı dallanma yollarının da gerçekten test edilip edilmediğini sorgulamaktır. Örneğin aşağıdaki Lua kodu parçasına bakalım:

if a or b or c then
    do_something()
end

Geleneksel satır bazlı kapsama araçları, yalnızca if satırının çalıştığını tespit edebilir. Oysa derleyici, bu kısa devreleme zincirini üç bağımsız TEST kararına dönüştürür. Bu da üç farklı dallanma noktasının varlığı anlamına gelir. cluacov aracı, Lua projelerinizde bu hassasiyeti elde etmenizi sağlayan çözümlerden biri olarak öne çıkıyor.

Neden Satır Kapsamı Yeterli Olmuyor?

Satır kapsamı, kodunuzun hangi satırlarının çalıştırıldığını gösterir, ancak dallanmaların tam olarak test edilip edilmediği konusunda yetersiz kalır. Örneğin, bir if-else bloğu düşünelim:

if condition then
    -- true yolu
else
    -- false yolu
end

Eğer condition hep true olursa, else bloğu asla test edilmeyecektir. cluacov, Lua’nın derleyici düzeyindeki bu hassasiyeti yakalayan bir araç olarak geliştirildi. Hem satır bazlı hem de komut düzeyinde dallanma kapsamını destekliyor.

cluacov’un Temel Bileşenleri ve Nasıl Çalışıyor?

cluacov, Lua’nın C API’sine dayanan bir araçtır ve hem Lua 5.4+ hem de LuaJIT dahil eski sürümlerle uyumlu çalışır. Araç, iki farklı dal kapsama stratejisi sunar:

• Satır Kanca Yaklaşımı: Lua 5.1-5.5 ve LuaJIT ile uyumlu. LUA_MASKLINE kullanılarak satır geçişlerini izler.
• Komut Düzeyinde Hassasiyet: Lua 5.4+ için LUA_MASKCOUNT ile count = 1 ayarı kullanarak her komutun çalıştırılmasını izler.

Lua’nın Derleyici ve Sanal Makinesi Temelleri

Lua, kaynak kodunu önce baytkoda derler ve ardından bu baytkodu bir kaydedici tabanlı sanal makinede çalıştırır. Her Lua fonksiyonu, Proto adı verilen bir yapıya karşılık gelir. Bu yapı, çalıştırma sırasında gerekli olan statik meta verileri içerir:

• code[]: Baytkod komut dizisi
• lineinfo[]: Hata ayıklama için kaynak satır eşlemesi
• source: Kaynak dosya adı (ör. @test.lua)
• linedefined: Fonksiyonun tanımlandığı ilk satır
• sizecode: Baytkod komut sayısı
• p[]: İç içe fonksiyon Protoları
• k[]: Sabitler tablosu

cluacov, dallanma noktalarını tespit etmek için Proto.code[] dizisini tarar.

Hata Ayıklama Kancaları ve cluacov’un Rolü

Lua, C düzeyinde hata ayıklama kancaları sunar:

lua_sethook(L, callback, mask, count);

mask parametresi, kancanın ne zaman tetikleneceğini belirler:

• LUA_MASKCALL: Fonksiyon çağrıldığında
• LUA_MASKRET: Fonksiyon döndüğünde
• LUA_MASKLINE: Yeni bir kaynak satırına geçildiğinde
• LUA_MASKCOUNT: Belirli sayıda komut çalıştırıldıktan sonra

cluacov, kapsama verilerini toplamak için bu kancaları kullanır. Satır bazlı yaklaşım LUA_MASKLINE kullanırken, hassas yaklaşım count = 1 ayarıyla her komutu izler.

Bellek Yönetimi ve Sonlandırma Tehlikeleri

Lua, __gc nihai temizleyicilerini destekler. Bu özellik, kapsama verilerinin proses kapandığında otomatik olarak kaydedilmesini sağlar. Ancak, lua_close sırasında nesnelerin serbest bırakılma sırası öngörülemez. Bu nedenle, cluacov hassas yaklaşımda, verilerin kapanıştan önce kopyalanmasını gerektiren bir tasarım benimser.

cluacov’u Kullanmaya Başlamak

Lua 5.4+ için Hassas Dallanma Kapsamı

Hassas komut düzeyinde kapsama için cluacov.runner modülünü kullanabilirsiniz:

lua -lcluacov.runner your_program.lua

Çalıştırma tamamlandığında, cluacov aşağıdaki dosyaları oluşturur:

• luacov.stats.out: LuaCov uyumlu satır geçiş verileri
• lcov.info: Hem satır hem de dallanma verilerini içeren LCOV formatı

Bu verileri HTML raporuna dönüştürmek için:

genhtml lcov.info --output-directory html --branch-coverage

Tam kontrol sahibi olmak istiyorsanız, aşağıdaki gibi bir yaklaşım kullanabilirsiniz:

local pchook = require("cluacov.pchook")
local branchcov = require("cluacov.branchcov")

pchook.start()
local func = loadfile("module_under_test.lua")
local mod = func()
mod.run_tests()
pchook.stop()

local result = branchcov.analyze(func)
for _, branch in ipairs(result.branches) do
    print(string.format("Satır %d [%s]: %s", branch.line, branch.kind, branch.status))
end

Eski Sürümler için Yaklaşık Dallanma Kapsamı

Eğer Lua 5.4+ kullanmıyorsanız, satır kapsamı ile statik baytkod analizi kombinasyonunu kullanabilirsiniz:

lua -lluacov your_program.lua

Ardından, deepbranches.get(func) fonksiyonunu kullanarak dallanma noktalarını tespit edin ve bu verileri satır geçiş verileriyle karşılaştırın. Bu yaklaşım, branchfilter.lua dosyasını gerektirir ve bazı dallanma noktalarının güvenilir bir şekilde ayırt edilememesi nedeniyle kısıtlamalar içerir.

Statik Analiz ve Dallanma Kategorileri

cluacov’un her iki yaklaşımı da, dallanma noktalarını statik olarak baytkoddan tespit etmeye dayanır. deepbranches.get(func) fonksiyonu, bir fonksiyonun Proto zincirini tarar ve dört farklı dallanma kategorisini tanımlar:

• Test: OP_TEST, OP_TESTSET, OP_EQ, OP_LT gibi komutlar. Kaynak kodunda if, elseif, and, or gibi yapıları temsil eder.
• Döngü: OP_FORPREP, OP_FORLOOP gibi komutlar. Kaynak kodunda for, while gibi yapıları temsil eder.
• Kısa Devreleme: Mantıksal operatörler (and, or) tarafından oluşturulan dallanmalar.
• Diğer: Yukarıdaki kategorilere girmeyen özel durumlar.

Bu kategorizasyon, hangi dallanmaların test edildiğini ve hangilerinin ihmal edildiğini net bir şekilde görmenizi sağlar.

cluacov’un Geleceği ve Geliştirme Yolları

cluacov, Lua topluluğu için oldukça değerli bir araç olmaya devam edecek. Gelecekte, hem performans hem de kullanım kolaylığı açısından daha da geliştirilmesi mümkün. Özellikle, farklı Lua sürümleri arasındaki uyumluluğun artırılması ve kullanıcı dostu arayüzlerin eklenmesi, araç için önemli adımlar olabilir. cluacov’u projelerinizde kullanarak, test kapsamınızı daha derinlemesine analiz edebilir ve yazılım kalitenizi önemli ölçüde artırabilirsiniz.