Birim testlerinde dosya içeriğini / kodlamasını kontrol etmek 'kötü uygulama' olarak değerlendiriliyor mu?

Bağlamın bir kısmı: Bugün erken saatlerde, başka bir meslektaşımın sağladığı bazı SQL kodlarını güncellemem gerekiyordu ve oldukça büyük bir komut dosyası olduğundan, ayrı bir dosya olarak depolanıyordu (çalışma zamanında okunup çalıştırılıyor). Bunu yaparken yanlışlıkla birkaç ay önce sahip olduğumuz iki hatayı tekrar ortaya koydum, yani:

• Hangi nedenle olursa olsun ASCII dosyası UTF-16'da kodlanmıştır (meslektaşım bana neden olan dosyayı e-posta ile göndermiştir).
• Komut dosyası ilk SETifadeleri eksikti (üretimdeki bazı sürücü olayları nedeniyle zorunlu, ancak yerel olarak temiz bir kurulum için gerekli değil).

Yaklaşık bir saat boyunca bu hata ayıklama işleminden sonra (tekrar) Bunun bir daha yaşanmayacağından emin olmak için bazı ünite testleri yazmaya karar verdim (ve gelecekteki geliştiriciler için kolay bir düzeltme sağlamak için iddia mesajına düzeltmenin hızlı bir yolunu dahil ettim).

Ancak bu kodu bastığımda başka bir meslektaşım (aynı zamanda ekibimizin lideri olan) bana doğru yürür ve bunları tekrar yapmamam gerektiğini söyledi çünkü:

"Bu şeyler birim testlerine ait değil"

"Birim testleri yalnızca kodunuzun akışını kontrol etmek için kullanılmalıdır"

Yaptığım şeyin yanlış olmadığını düşündüğüm için şimdi oldukça çekiciyim, çünkü bu hata gelecekte tekrar ortaya çıkmayacak, ancak bu meslektaşım kıdemli olarak çalışıyor ve günün sonunda neye karar verecek zamanımızı harcıyoruz. Ne yapmalıyım? Bu şekilde yaptığım için yanlış mıyım? Kötü uygulama olarak mı kabul edilir?

Büyük olasılıkla yazdığınız testler, entegrasyon veya regresyon testlerine birim testlerinden daha yakındır. Her ne kadar çizgi çok bulanık olabilir ve bazen birim testinin ne olduğu veya ne olmadığı konusunda titremeye dönüşürken, meslektaşınıza geri döneceğim ve kodun doğruluğunu sağlamak için değer kattığı için yazdığınız testlerin nerede olması gerektiğini sordum.

Bir testin ne olduğuna veya ne olmadığına çok fazla odaklanmam ve bir entegrasyon testi olsa bile testte hala değer olabileceğini anlayamadım.

Teknik olarak, bu bir ünite testi değil ve bir doğrulama adımından daha fazlası. Doğru yaklaşım gerçekten iş akışınızın ne olması gerektiğine bağlıdır. Ekip lideriniz, birim testlerinin amacının ne olduğu konusunda haklıdır. Benim düşüncem, bu hala yapılması gereken bir iş için yanlış aracı kullanma durumudur. Öyleyse şununla başla:

Çözmeye çalıştığım sorun nedir?

Açıklamaya göre, herhangi bir veritabanı komut dosyasının bazı standartlara uygun olduğunu doğrulamanız gerekir.

Sorunu çözmek için hangi araçlar / işlemler mevcut?

Kaynak kod kalitesi genellikle statik analiz araçları ile kontrol edilir . SQL'inizi doğrulamak için statik bir analiz aracınız yoksa , kendisine iletilen herhangi bir SQL dosyasında denetimi yapan hızlı ve kirli bir araç oluşturabilirsiniz . Bahsettiğiniz sorunları halledebilecek statik analiz araçları olup olmadığını kontrol etmekten zarar gelmez.

Yapı altyapınızın bu kısmını, örneğin Jenkins'e dahil etmek gibi bir parçası haline getirirseniz, projenizdeki tüm SQL dosyalarına uygulanabilir.

Birim testleri, yalnızca mevcut dosyanız için sorunu çözer.

Araca olan ihtiyacı nasıl iletebilirim?

Bu oldukça kolay, takım liderinizle konuşun. Ürün sahibiyle birlikte çalışabilir ve takımlara yatırım yapma riskini / ödülünü siz belirleyebilirsiniz. Bu muhtemelen bir kereye mahsus olmak üzere bir sorun ise, takım muhtemelen fazladan olacaktır. En büyük sorunları yakalamak için gereken araç kolay ise, sadece akıl sağlığı kontrolü için buna değer olabilir.

Takım lideriniz sizin (veya benim) düşünmediğiniz, sorunu daha doğru çözebilecek bazı fikirlere sahip olabilir.

"Unit Tests" dosyalarına erişen testleri çağırmak kötü bir uygulamadır.

O: "Bu şeyler birim testlerine ait değil"

Siz: "Mantıklı, ama onları koymak için daha iyi bir yer bulamadım. Nereye aitler?"

Ne yazık ki, ne tür testler yapıldığı ve nasıl organize edildikleri tamamen şirkete özgüdür. Dolayısıyla, şirketinizin bu testleri nasıl yürüttüğünü öğrenmeniz gerekir.

Ünite Testleri haricinde otomatik testler yapmak için henüz bir yolunuz yoksa, pratik yaklaşım, Ünite Testleri olmayan bir Ünite Testini önekle işaretlemektir; Gerçekte sahip olduğunuz / ihtiyaç duyduğunuz testleri. Bundan sonra örgütlenmeye başlayabilirsiniz.

Michael Feathers, kitabında, Eski Kodla Etkili Çalışma:

Endüstride, insanlar sıklıkla belirli testlerin birim testi olup olmadığı konusunda ileri geri giderler. [...] İki niteliğe geri dönüyorum: Test hızlı mı çalışıyor? Hataları hızlı bir şekilde yerelleştirmemize yardımcı olabilir mi?

Testiniz hataları hızlı bir şekilde yerelleştirmenize ve hızlı çalışmanıza yardımcı olur mu? Eğer öyleyse, o zaman yap! Eğer değilse, o zaman yapma! Bu kadar basit!

Olduğu söyleniyor, diğer insanlarla bir ortamda çalışıyoruz ve onlarla iyi geçinmek zorunda. Özel olarak aynı fikirde olmasanız bile, onun yolunda gitmeniz gerekebilir.

Bazı durumlarda, kaynak kod dosyalarına, yapılandırma dosyalarına ve benzerlerine karşı benzer testler yazdım. Onlara birim sınaması demem çünkü (a) dosya sistemine erişiyorlar ve ultra hızlı olmayabilirler (b) Her check-in sırasında yürütülmeleri umrumda değil (gecelik olarak CI sunucusu).

Onlara entegrasyon testleri diyebilirsiniz; şüphesiz, bu perspektife ünite testlerinden daha yakındırlar.

Onlar için kendi terimim kaynak testleri . IMHO, bir CI sunucusunda her gece çalıştırılırsa tamamen haklı çıkarlar: asgari maliyet var ve makul şekilde kullanıldığında net bir şekilde değer katıyorlar. Mantıklı bir tanım : Test, soruna neden olan bir sorunu (eğer bahsettiğiniz kodlama gibi) kontrol ediyorsa.

Bir birim testi, bir yöntem kodunu veya 'birim kodunu' sınamakla ilgilidir. Yazılımınızdaki en küçük mantık ve kod grubunu test ediyorsunuz.

Daha sonra, diğer birimlerle buna katıldığınızda, entegrasyon testi yapacaksınız.

Umarım takım lideriniz inisiyatifinizi destekledi ve alternatif önerilerde bulunmalıydı. Kesinlikle doğru fikrin var.

SQL'iniz, C # veya Java gibi herhangi bir düşük nesil dilde olduğu gibi koddur ve bu şekilde test edilmelidir. Doğrulama ve onaylama tüm test seviyelerine aittir. Bu nedenle kodlama ve SET ifadeleri dahil edilmiştir, ancak yalnızca özel olarak test edilmeleri gerekmez. Satır sonları veya kuşatmak gibi genel şeyler genellikle sadece bir SCM kancası veya özelliği kullanabilir.

En iyi uygulama, eski böceklerin tekrar ortaya çıkmamasını sağlamak için regresyon testlerinin yapılmasıdır. Genellikle, testler hatanın herhangi bir çözümü ile birlikte oluşturulur. Bu hatalar ünite / entegrasyon veya sistem düzeyinde regresyon testleri ile kapsanmamış ve daha sonra yeniden tanıtılmışsa, bu bir takım problemidir, bireysel problem değil, proses problemidir.

Mesele şu ki ... bir ünite içindeki sözdizimi hataları, eksik ifadeler veya mantık blokları tipik olarak test edilmez. Ünitenin giriş ve çıkışlarını farklı kombinasyonlarda test ediyor, üretilebilecek birçok olasılığı test ediyor.

Eksik SET ifadelerine geri dönersek - test etmek için birçok girdi ve çıktı olasılığını bildirmeye yardımcı olurlar. Herhangi bir seçilmiş SET'i kaçırmamış olsaydınız, BAŞARILACAK hangi testi yazardınız?

Ürününüzün bir parçası olan dosyalarınız varsa, içeriklerinin doğru olması gerekir. Bunu doğrulamaman için bir sebep yok. Örneğin, bir klasörde altı 1024 x 1024 görüntüye ihtiyacınız varsa, o zaman elbette tam olarak elinizde olduğunu kontrol eden bir birim testi yazın.

Fakat muhtemelen sadece dosyalarınız yoktur, ayrıca dosyaları okuyan bazı kodlarınız da vardır. Bu kod için bir birim testi yazabilirsiniz. Yukarıdaki örnekte, altı görüntüden birini okuma işlevi bellekte 1024 x 1024 görüntü döndürür (veya neyi üretmesi gerekiyorsa).

Her neyse, bu bir birim testi olmayabilir, ancak yararlı bir testtir. Ve yararlı bir test yapmanıza izin veren bir birim test çerçevesi kullanıyorsanız (bu birim test değildir), neden birim test çerçevesini kullanmıyorsunuz?

Belki de sorununuzu yanlış anlıyorum, ama bana bu herhangi bir özel test tarafından değil, sadece sürüm kontrol sistemi tarafından yakalanması gerekmeyen bir problem gibi geliyor . Bir kod tabanında yapılacak herhangi bir değişiklik, taahhütte bulunmadan önce yama bazında gözden geçirilmelidir. Git'te bunu yapmanın basit bir yolu ile değişiklikleri eklemektir

git add -p

Bu, bir metin dosyasındaki her değişiklik için çalışma dizini size gerçekten tutmak isteyip istemediğinizi soracaktır. Bu, örneğin, bu “ilk SETifadelerin” silinmesini görmenize izin verir .

Dosyanın tamamının kodlanması değiştiyse, farklı bir şey olur: algoritma eski ve yeni dosyayı değiştiremez ve bu nedenle git add -phiçbir şey eklemez. Bu daha sonra herhangi bir taahhütte bulunmadan önce yaptığım diğer komutta görülebilir, yani

git status

İşte orada belirten kırmızı renkte vurgulanır dosyayı görürdük olan değişiklikler. Bunların neden bunu başaramadığını araştırmak git add -psorunu hızlı bir şekilde açıklayacaktır .

Dikkate alınması gereken bir başka açı: Bu iki koşul, programınızın çalışması için gereklilikler olduğundan, mantığı yürütme mantığına yakın bir yere yerleştirmemelisiniz? Demek istediğim: Bir dosyayı okumadan önce varlığını test ediyor ve / veya içeriğini doğrulıyorsun, değil mi? Peki bu nasıl farklı? Bunun bir kod harici kaynağı olduğundan, gerçekte kullanılmadan önce çalışma zamanında doğrulanması gerektiğini düşünüyorum. Sonuç: Daha güçlü bir uygulama, ek testler yazmaya gerek yok.

Testler diğerleriyle aynı koddur ve eğer yeterince karmaşıksa, birim testinden de faydalanır. Bu tür önkoşul kontrollerini doğrudan teste eklemek çok kolay görünüyor.

Testlerin çoğu bunu gerektirmeyecek kadar basit, ancak bazıları yeterince karmaşıksa, bu ön koşul kontrollerinde temel olarak yanlış bir şey göremiyorum. Tabii ki, test onlarsız da başarısız olmalıdır, ancak iyi bir birim testi ayrıca hangi birimin başarısız olduğunu da söyler .

Testin bir parçası olarak kullanılan ve belirli bir içeriğe ve kodlamaya sahip olması gereken bir komut dosyası muhtemelen bir birimdir. Testin geri kalanından çok daha fazla kod ve mantık içerebilir. Böyle bir betiği olan bir test, şimdiye kadarki en iyi tasarım değildir ve mümkünse, daha doğrudan bir şeye yeniden yansıtılmalıdır (eğer entegrasyon testi değilse).

Birincisi - testlerin amaçlarından biri sorunların kodunuzda tekrar etmesini önlemektir - bu nedenle kesinlikle bu tür testler yazmaya devam etmelisiniz .

İkincisi - adlandırma zordur. Evet, bunlar açıkça "birim testleri" değildir, ancak yapım sürecinin arzu edilen ve gerekli parçaları olabilirler, çünkü sizi bariz hatalardan korurlar ve hatalar hakkında size geri bildirimde bulundukları için (özellikle siz görmüyorsanız, dev kutusu üzerindeki sonuçlar).

Bu nedenle, soru aslında bu (sizin bağlamınızda olmalıdır), bu testlerin ne olduklarından ve ne zaman yapıldıklarından daha fazla olduğu ile ilgilidir.

Bu tür testleri geçmişte yoğun bir şekilde kullandım - bizi oldukça acı çekti.

Birim testleri, doğru girdi için doğru sonucu ürettiğini doğrulamak için bir birim kodunu yalıtımlı olarak yürütmekle ilgilidir. İzolasyon, hem test edilen birimi hem de testin kendisini tekrarlanabilir kılmalı, yani yan etkilere dayanmamalı veya yan etkilere neden olmamalıdır.

SQL tam olarak yalıtılmış bir şekilde test edilebilecek bir şey değildir, bu nedenle herhangi bir SQL testi tam olarak bir birim testi değildir ve SELECT ifadeleri dışında, bir yan etkiye sahip olacağı kesindir. Buna ünite testi yerine entegrasyon testi diyebiliriz.

Geliştirilebilecek herhangi bir hatanın, geliştirme döngüsünde mümkün olan en erken zamanda tespit edilebildiğinden ve hızlı bir şekilde olabilmesi için kusurun kaynağının tanımlanmasını kolaylaştıracak bir şekilde yapılmasının sağlanması her zaman akıllıca olacaktır. düzeltildi.

Söz konusu testler, “birim testler” in gövdesinden daha uygun bir şekilde yerleştirilebilir ve başka bir yere yerleştirilebilir, ancak izlemek için saatlerce sürebilecek bir kusurun olası girişine karşı koruma gibi yararlı bir şey yapıyorlarsa, tamamen kaldırılmamalıdır. aşağı.