Bazel, bazel coverage
ile test edilebilecek depolar hakkında kod kapsamı raporları oluşturmak için bir coverage
alt komutu içerir. Farklı dil ekosistemlerinin kendine özgü özellikleri nedeniyle, belirli bir projede bu işi yapmak her zaman sıradan değildir.
Bu sayfada, kapsam raporu oluşturma ve görüntülemeyle ilgili genel süreç anlatılmakta ve ayrıca yapılandırması iyi bilinen diller için dile özgü bazı notlar yer almaktadır. Bu belgeyi, önce genel bölümü, ardından belirli bir dil için gereksinimleri okumanız önerilir. Bazı ek hususlar gerektiren uzaktan yürütme bölümünü de unutmayın.
Birçok özelleştirme mümkün olsa da bu belge, şu anda en iyi desteklenen rota olan lcov
raporlarının üretilmesine ve kullanılmasına odaklanmaktadır.
Kapsam raporu oluşturma
Hazırlık
Kapsam raporları oluşturmaya ilişkin temel iş akışı şunları gerektirir:
- Test hedefleri içeren temel bir depo
- Dile özgü kod kapsamı araçlarının yüklü olduğu bir araç zinciri
- Doğru bir "araç" yapılandırması
İlk ikisi dile özgüdür ve genelde basittir. Ancak ikinci seçenek, karmaşık projelerde daha zor olabilir.
Bu durumda "araç", belirli bir hedef için kullanılan kapsam araçlarını ifade eder. Bazel, araçlar etkinleştirildiğinde test edilen hedefler için bir filtre belirten --instrumentation_filter
işaretini kullanarak bu ayarın belirli bir dosya alt kümesi için etkinleştirilmesini sağlar. Araçları testlerde etkinleştirmek için --instrument_test_targets
işareti gereklidir.
Varsayılan olarak, bazel hedef paketleri eşleştirmeye çalışır ve ilgili filtreyi INFO
mesajı olarak yazdırır.
Geçerli yayın
Kapsam raporu oluşturmak için bazel coverage
--combined_report=lcov
[target]
işlevini kullanın. Bu işlem, hedef için testleri çalıştırır ve her dosya için lcov biçiminde kapsam raporları oluşturur.
İşlem tamamlandıktan sonra bazel, üretilen tüm kapsam dosyalarını toplayan ve bunları tek bir dosyada birleştiren bir işlem çalıştırır. Bu işlem son olarak $(bazel info
output_path)/_coverage/_coverage_report.dat
altında oluşturulur.
Kapsam raporları, testler başarısız olduğunda da oluşturulur. Ancak bu durumun başarısız testler için geçerli olmadığını, yalnızca geçen testlerin raporlandığını unutmayın.
Kapsamı görüntüleme
Kapsam raporunun çıktısı yalnızca insanlar tarafından okunamayan lcov
biçiminde olur. Bundan sonra, web tarayıcısında görüntülenebilecek bir rapor oluşturmak için genhtml
yardımcı programını (lcov projesinin bir parçası) kullanabiliriz:
genhtml --output genhtml "$(bazel info output_path)/_coverage/_coverage_report.dat"
genhtml
işlevinin, bu dosyalardaki eksik kapsamı belirtmek için kaynak kodu da okuduğunu unutmayın. Bunun çalışması için genhtml
komutunun bazel projesinin kökünde yürütülmesi beklenir.
Sonucu görüntülemek için genhtml
dizininde oluşturulan index.html
dosyasını herhangi bir web tarayıcısında açmanız yeterlidir.
genhtml
aracı veya lcov
kapsam biçimi hakkında daha fazla yardım ve bilgi için lcov projesine göz atın.
Uzaktan yürütme
Uzaktan test yürütme ile çalıştırmanın şu anda birkaç uyarı vardır:
- Rapor kombinasyonu işlemi henüz uzaktan çalıştırılamaz. Bunun nedeni, Bazel'in kapsam çıkış dosyalarını grafiğinin bir parçası olarak kabul etmemesi (bu soruna bakın) ve dolayısıyla bunları kombinasyon işlemine yönelik girişler olarak doğru şekilde değerlendirememesidir. Bu sorunu çözmek için
--strategy=CoverageReport=local
uygulamasını kullanın.- Not: Bazel, stratejileri çözümleme şeklinden dolayı Bazel
local,remote
özelliğini denemek üzere ayarlanmışsa bunun yerine--strategy=CoverageReport=local,remote
gibi bir değer belirtmeniz gerekebilir.
- Not: Bazel, stratejileri çözümleme şeklinden dolayı Bazel
--remote_download_minimal
ve benzer işaretler de ilkinin sonucu olarak kullanılamaz.- Testler önceden önbelleğe alınmışsa Bazel şu anda kapsam bilgileri oluşturamaz. Bu sorunu çözmek için
--nocache_test_results
, test süreleri açısından yüksek bir maliyete sahip olsa da kapsam çalıştırmaları için özel olarak ayarlanabilir. --experimental_split_coverage_postprocessing
ve--experimental_fetch_all_coverage_outputs
- Kapsam genellikle test işleminin bir parçası olarak çalıştırılır. Bu nedenle varsayılan olarak, tüm kapsamı varsayılan olarak uzaktan yürütmenin çıktısı olarak geri almayız. Bu işaretler, varsayılanı geçersiz kılar ve kapsam verilerini alır. Daha fazla ayrıntı için bu soruna bakın.
Dile özel yapılandırma
Java
Java, varsayılan yapılandırmayla kullanıma hazır bir şekilde çalışmalıdır. bazel araç zincirleri, JUnit de dahil olmak üzere uzaktan yürütme için gereken her şeyi içerir.
Python
Python'da kapsam desteğini etkinleştirmek için gereken ek adımlar için rules_python
kapsam belgelerine bakın.