- Ana sayfa
- Öğrenme merkezi
- Kalite kapıları nedir?
Kalite kapıları nedir?
Son güncelleme
Kalite kapısı, bir değişikliğin merge veya dağıtımdan önce geçmesi gereken geçti/kaldı kararıdır. Kapıların neyi kontrol ettiği, kontrollerden farkı ve nasıl tasarlanacağı.
Bu sayfada
Kalite kapısı, bir kod değişikliğinin merge edilmek veya dağıtılmak gibi bir sonraki aşamaya geçmeden önce geçmesi gereken bir geçti/kaldı kararıdır. Değişikliğe dair kanıtı (test sonuçları, inceleme bulguları, onaylar, politika kararları) önceden üzerinde uzlaşılmış kurallarla karşılaştırır ve kanıt yetersiz kaldığında değişikliği otomatik olarak engeller. Onu bir rapor değil bir kapı yapan, uygulanmasıdır: başarısız bir kapı değişikliği durdurur.
Kalite kapıları nereden gelir
Fikir sürekli entegrasyondan daha eskidir. Proje yönetimi uzun zamandır aşama kapıları kullanır: bir proje bir aşamadan diğerine ancak belirli kriterlere göre yapılan bir incelemeden sonra geçer. İmalatta, montaja devam edilmeden önce bir parçanın geçmesi gereken muayene noktaları vardır.
Yazılımda terim, ekiplerin yeni kodda hiç yeni kritik sorun olmaması veya asgari bir test kapsamı gibi eşikler tanımlamasına ve projeyi bunları geçiyor ya da geçemiyor olarak raporlamasına olanak tanıyan statik analiz araçları sayesinde yaygınlaştı. Git platformları aynı fikri branch korumasıyla pull request'lere taşıdı: bir branch, bir merge'e izin verilmeden önce belirli durum kontrollerinin geçmesini ve belirli sayıda onayı zorunlu kılabilir.
Bugün kalite kapısı genellikle bunların bir birleşimi anlamına gelir: CI'dan gelen otomatik kanıt, kod inceleme araçlarından gelen bulgular ve insan onayları; teslimat pipeline'ının belirli bir noktasında birlikte değerlendirilir.
Bir kalite kapısı neyi kontrol eder
Kapılar kanıttan oluşur. Yaygın türler şunlardır:
- Build. Kod derlenir ve yapıt üretilebilir.
- Testler. Test paketi, değişikliğin tam bu sürümü üzerinde geçmiştir.
- Kapsam. Test kapsamı, çoğu zaman yalnızca yeni veya değişen kodda, bir alt sınırı karşılar.
- İnceleme bulguları. Statik analizden, yapay zekâ incelemesinden veya güvenlik araçlarından gelen, belirli bir önem derecesi eşiğinin üzerinde açık sorun yoktur.
- Bağımlılıklar ve lisanslar. Yasaklı lisans ve bir eşiğin üzerinde bilinen güvenlik açığı içeren bileşen yoktur.
- Onaylar. Yazardan başka bir veya daha fazla kişi değişikliği onaylamıştır.
- Politika. Değişiklik korumalı yollara dokunmaz veya bu yolların gerektirdiği ek onaya sahiptir.
- Terfi. Değişiklik, canlı ortamdan önce staging gibi daha önceki bir ortama dağıtılmıştır.
Her kapının bunların hepsine ihtiyacı yoktur. Merge'den önceki bir kapı genellikle testlere, incelemeye ve onaya odaklanır. Canlı ortamdan önceki bir kapı ise terfi ve yayın kontrollerini ekler.
Kalite kapıları ve kontroller
Bu sözcükler çoğu zaman gevşek kullanılır. Ayrımı korumaya değer, çünkü kötü bir değişikliği gerçekte neyin durduracağına o karar verir.
| Boyut | Kontrol | Kalite kapısı |
|---|---|---|
| Ne ürettiği | Bir sonuç: geçti, kaldı, bir sorunlar listesi | Bir karar: gerekçeleriyle izin verildi veya reddedildi |
| Girdiler | Tek bir aracın çıktısı | Birleştirilmiş birkaç kanıt parçası |
| Eşik | Çoğu zaman örtük veya aracın içinde belirlenmiş | Açık ve üzerinde uzlaşılmış: hangi önem dereceleri ve sonuçlar engeller |
| Başarısızlığın etkisi | Pull request'te gösterilir; yok sayılabilir | Kanıt değişene kadar değişiklik ilerleyemez |
| Hata durumunda | Çoğu zaman nötr veya atlandı olarak gösterilir | Reddetmelidir: karar yokluğu geçiş değildir |
| Bulunduğu yer | Onu çalıştıran araçta | Canlı ortama giden her yolun geçmek zorunda olduğu bir noktada |
| Denetim izi | Tutuluyorsa aracın günlüğü | Karar, gerekçeleri ve her geçersiz kılma; değişiklikle birlikte saklanır |
Bir kontrol, sonucu nedeniyle bir şey ilerlemeyi reddettiğinde bir kapının parçası olur.
İyi bir kalite kapısının özellikleri
Hata durumunda kapalı kalır. Bir test çalıştırıcısı çökerse, bir inceleme zaman aşımına uğrarsa veya kapı servisine ulaşılamazsa değişiklik reddedilir. Hata durumunda değişiklikleri geçiren bir kapı, ona en çok ihtiyaç duyduğunuzda sessizce kapalıdır.
Kanıt yokluğu, geçti anlamına gelmez. Test çalıştırması, incelemesi veya SBOM'u olmayan bir değişiklik bu kontrollerden geçmemiştir. Kapı ya onu engeller ya da boşluğu açıkça gösterir. Eksik bir sonucu asla yeşil göstermez.
Kanıt sürümle örtüşür. Önceki bir commit üzerindeki test çalıştırması güncel commit hakkında hiçbir şey söylemez. Değişiklik testleri çalıştıktan veya onaylandıktan sonra düzenlenirse bu sonuçlar artık sayılmamalıdır.
Gerekçeler okunabilir. "Reddedildi" yeterli değildir. Kapı, değişikliği hangi bulgunun, hangi testin veya hangi kuralın durdurduğunu söylemelidir; böylece yazar buna göre hareket edebilir.
Her yol aynı kapıyı kullanır. Konsoldan yapılan bir merge kapıdan geçiriliyor ama Git platformunda yapılan bir merge geçirilmiyorsa, kapının bir yan kapısı vardır. Aynı değerlendirme CI'dan çağrılabilmelidir.
Geçersiz kılmalar nadirdir ve kaydedilir. Bazen bir ekibin bir bulguya rağmen yayına çıkması gerekir. Bu, kapatılmış bir kontrol değil; yetkili bir kişinin verdiği, değişiklikle birlikte saklanan açık bir triyaj kararı olmalıdır.
Eşikler cırcır gibi sıkılaşır. Kod tabanının bugün karşılayabileceği kurallarla başlayın, sonra onları sıkılaştırın. Her değişiklikte başarısız olan bir kapı kısa sürede atlanır.
Yapay zekânın yazdığı kod için kalite kapıları
Yapay zekâ ajanları incelemenin ekonomisini değiştirir. Bir ekibin satır satır okuyabileceğinden daha fazla değişiklik üretebilirler ve her değişiklik ince bir şekilde yanlışken makul görünebilir. Bu ortamda kapılar üç nedenle daha önemlidir.
Birincisi, yazarın özgüveni kanıt değildir. Testlerin geçmesi gerektiğini bildiren bir ajan bir iddiada bulunuyordur; tam değişiklik üzerinde kaydedilmiş bir test çalıştırması ise kanıttır. Kapılar, ajanın özetini değil, bir şeyleri çalıştırarak üretilmiş kayıtları okumalıdır.
İkincisi, incelemenin gerçekten yapılmış olması gerekir. Yapay zekâ incelemesi, zaman aşımına uğrayarak veya kullanılabilir bir sonuç olmayan metin döndürerek sessizce başarısız olabilir. Bir kapı "incelendi, hiçbir şey bulunamadı" ile "incelenmedi" arasındaki farkı ayırt edebilmelidir.
Üçüncüsü, görevler ayrılığı. Ajandan bir değişiklik isteyen kişi fiilen onun yazarıdır. Başka biri onaylayabiliyorken onu onaylayan tek kişi olmamalıdır. Bu onayın nereye ait olduğu için bkz. Yapay zekâ ajanları yazılım yaşam döngüsünde nereye oturur?
Kalite kapıları nasıl tasarlanır
- Canlı ortama giden yolu haritalayın. Bir değişikliğin ana branch'inize ve canlı ortamınıza ulaşabileceği her yolu listeleyin: konsol merge'leri, Git platformu merge'leri, doğrudan push'lar, yayın script'leri. Bir kapı yalnızca ondan geçen yolları korur.
- Kapı noktalarını seçin. Çoğu ekibin en az bir merge öncesi ve bir canlı ortam öncesi kapıya ihtiyacı vardır.
- Her nokta için kanıtı listeleyin. Güncel sürüm üzerinde testler, inceleme bulguları, onaylar, lisanslar, önceki dağıtım. Her parçanın nereden geldiğini yazın.
- Açık eşikler belirleyin. Örneğin: yüksek ve kritik bulgularda, başarısız herhangi bir testte ve eksik bir incelemede engelleyin. Kuralları ekibin okuyabileceği bir yere yazın.
- Eksik kanıt durumlarına karar verin. Test yoksa, SBOM yoksa veya inceleme yoksa ne olur? Bunu bilinçli olarak kararlaştırın ve eksik kanıtı asla geçiş olarak göstermeyin.
- Hata durumunda kapalı kalmasını sağlayın. Kapıdaki hatalar değişikliği reddeder ve bunu söyler.
- CI'a açın. Aynı kararı pipeline'ınıza sunun; böylece araçlarınızın dışındaki merge'ler de ona tabi tutulabilir.
- Triyajı ve geçersiz kılmaları tanımlayın. Bir bulguyu kimin reddedebileceği ve bunun nasıl kaydedileceği.
- Kapının kendisini inceleyin. Neyi engellediğine ve neyin gözden kaçtığına bakın. Kod tabanı iyileştikçe eşikleri sıkılaştırın.
AI CodeOps bunu nasıl yapar
AI CodeOps'ta her yapay zekâ değişikliği, pull request'e dönüşmeden önce ve konsol onu merge etmeden önce yeniden bir kalite kapısından geçer. Yapay zekâ bulgu incelemesi tamamlanmadıysa, yüksek (high) veya kritik (critical) önem derecesindeki bir bulgu hâlâ open, acknowledged veya in progress durumundaysa veya projenin testleri sandbox'ta başarısız oluyorsa değişiklik bekletilir. Bir test sonucu yalnızca üzerinde çalıştığı sürüm için geçerlidir. Bir kişinin onaylaması gerekir ve çalışma alanında başka bir onaylayıcı varken oturumu başlatan kişi onay oyunu kullanamaz. Çalışma alanı politikaları pull request'i reddedebilir veya hassas yollar için bu onayı zorunlu kılabilir. Kapılar, belgelenmiş birkaç istisna dışında hata durumunda kapalı kalacak şekilde kurulmuştur.
CI'ınız, bir çalışma alanı API anahtarıyla aynı kapıdan bir pull request veya commit için karar isteyebilir ve çağrı başına daha katı kurallar ekleyebilir:
curl -s -X POST "https://<your-console>/api/release/check" \
-H "Authorization: Bearer $WORKSPACE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"pullRequestURL":"https://github.com/acme/checkout/pull/42","blockingSeverity":"medium","requireDeployedTo":"staging"}'
Ana alanlara kısaltılmış, reddedilen bir yanıt:
{
"allowed": false,
"evidenceComplete": true,
"summary": "HIGH security: Coupon code is passed to the pricing query without validation",
"reasons": [
"HIGH security: Coupon code is passed to the pricing query without validation",
"Not yet deployed to \"staging\" — promote there before releasing"
],
"testFailures": [],
"coverageShortfall": null,
"priorEnvironmentMissing": { "required": "staging" },
"requiredGatesPassed": true,
"missingRequiredWorkflows": []
}
Uç nokta her iki sonuç için de HTTP 200 döndürür; bu yüzden allowed değerini okuyun. Eşleşen oturumu olmayan bir değişiklik reddedilir ve bir değerlendirme hatası allowed: false döndürür. Diğer seçenekler arasında minCoveragePct, requiredWorkflows, blockOnInFlight ve projenin kaydedilen en son SBOM'unu kontrol eden disallowedLicenses bulunur. Kontrol, kanıt eksik olduğunda da reddeder: sayılar içeren bir test sonucu olmayan bir kod değişikliği, kapsam raporlanmamışken belirlenmiş bir kapsam alt sınırı ve SBOM olmadan bir lisans kuralı. Test paketi olmayan bir proje, ayarlarındaki Don't run tests for this project ile bunun dışında kalır.
Genel bakış için Yapay zekâ kod kalite kapıları, triyaj ve sonuçların nerede göründüğü için Kalite kapıları ve her alan için API referansı sayfasına bakın.
Daha derine inin
- Hata durumunda açık kalma ve kapalı kalma: kapıların nasıl hata durumunda geçiş verir hâle geldiği, eksik kanıt durumlarına nasıl karar verileceği ve yayınları durdurmadan hata durumunda nasıl kapalı kalınacağı.
- Test kapsamı kapıları: proje alt sınırları, yeni kod kapsamı ve cırcırlar, kapsamın neyi kanıtlayamayacağı ve onu neyle eşleştirmek gerektiği.
Sık sorulan sorular
Kalite kapısı ile CI kontrolü arasındaki fark nedir?
Bir kontrol bir sonuç bildirir. Bir kapı ise bir veya daha fazla sonucu, değişikliğin ilerlemesini durduran ve uygulanan bir karara dönüştürür. Bir kontrol, ancak başarısız olduğunda bir şey ilerlemeyi reddettiğinde kapıya dönüşür.
Bir kalite kapısı hata durumunda açık mı kalmalı, kapalı mı?
Kapalı. Bir araç çöktüğü veya kanıt eksik olduğu için kapı bir karara varamıyorsa değişikliği reddetmelidir. Hata durumunda geçiş veren bir kapı, tam da bir şeyler yanlışken çalışmayı bırakır.
İnsan onayı bir kalite kapısı mıdır?
Olabilir. Onay, bir test sonucu gibi bir kanıttır ve bir kapı onu zorunlu kılabilir. Çoğu ekip otomatik kanıtı, yazardan başka birinin en az bir onayıyla birleştirir.
Bir projenin hiç testi yoksa ne olur?
Bunu açıkça kararlaştırın. Bazı kapılar eksik testlerde, bazıları yalnızca başarısız testlerde engeller. Her iki durumda da eksik bir sonuç asla geçti olarak gösterilmemeli veya sayılmamalıdır.
Bir kapıyı kimler geçersiz kılabilmeli?
Pratik olarak mümkün olduğunca az kişi ve her geçersiz kılma bir gerekçeyle kaydedilmelidir. Kapıyı atlamak yerine kanıtı düzeltmeyi veya triyajdan geçirmeyi tercih edin.