PHPUnit / DbUnit के साथ काम करने के अभ्यास के बारे में बहुत सारा पाठ

शुभ दिन, दोस्तों!
मैं MySQL के साथ संयोजन के रूप में PHPUnit / DbUnit से निपटने में अपना अनुभव साझा करना चाहता हूं। इसके अलावा, एक छोटी पृष्ठभूमि।

संक्षिप्त पृष्ठभूमि

एक एकल वेब एप्लिकेशन लिखने की प्रक्रिया में, PHP कोड का परीक्षण करना आवश्यक हो गया जो MySQL डेटाबेस के साथ गहनता से इंटरैक्ट करता है। इकाई परीक्षण ढांचे के रूप में परियोजना ने xUnit पोर्ट, PHPUnit का उपयोग किया। परिणामस्वरूप, मॉड्यूल के लिए परीक्षण लिखने का निर्णय लिया गया, जो सीधे डेटाबेस के साथ बातचीत करता है, PHPUnit / DbUnit प्लगइन उठाता है। आगे मैं उन कठिनाइयों के बारे में बात करूंगा जो परीक्षण लिखते समय उत्पन्न हुई थीं और मैंने उन्हें कैसे काबू किया। जवाब में, मैं अपने निर्णयों की शुद्धता के बारे में जानकार लोगों की टिप्पणियों को प्राप्त करना चाहूंगा।

कैसे DbUnit काम करता है

यह उपखंड उन लोगों के लिए है जो PHPUnit और / या DbUnit का उपयोग करके परीक्षण पद्धति से परिचित नहीं हैं। जिसे कोई दिलचस्पी नहीं है, वह सुरक्षित रूप से अगले पर जा सकता है ।

पाठ में आगे:

• परीक्षण वर्ग - एक इकाई जिसमें इकाई परीक्षण का कोड होता है, किसी भी PHPUnit का उत्तराधिकारी :: TestCase कार्यान्वयन;
• परीक्षण किया गया वर्ग - परीक्षण किया जाने वाला वर्ग।

चूंकि सबटेम शुरुआती के लिए है, एक शुरुआत के लिए, हम साधारण पीएचपी कक्षाओं के लिए यूनिट परीक्षण प्रक्रिया पर विचार करेंगे, और फिर डेटाबेस के साथ इंटरेक्ट करने वाले कोड का परीक्षण करते समय अंतरों का वर्णन करेंगे।

नियमित PHP कक्षाओं का परीक्षण

PHPUnit फ्रेमवर्क का उपयोग करके PHP में लिखे गए वर्ग का परीक्षण करने के लिए, आपको एक परीक्षण वर्ग बनाना होगा जो बेस क्लास PHPUnit_Framework_TestCase का विस्तार करता है। फिर इस वर्ग में सार्वजनिक तरीके बनाएं, शब्द परीक्षण से शुरू करें (यदि आप एक ऐसी विधि बनाते हैं जिसे अलग-अलग कहा जाएगा, तो यह स्वचालित रूप से नहीं कहा जाएगा जब परीक्षण चलाए जाते हैं), और उन में कोड रखें जो परीक्षण किए गए वर्ग की वस्तुओं के साथ क्रिया करते हैं और परिणाम की जांच करते हैं। आप परिणामी phpunit वर्ग को समाप्त और खिला सकते हैं, जो बदले में, क्रम में सभी परीक्षण विधियों को लागू करेगा और कृपया उनके काम पर एक रिपोर्ट प्रदान करेगा। हालांकि, ज्यादातर मामलों में, परीक्षण विधियों में से प्रत्येक में कोड दोहराया जाएगा जो परीक्षण ऑब्जेक्ट के साथ काम करने के लिए सिस्टम तैयार करता है। कोड डुप्लिकेट से बचने के लिए, PHPUnit_Framework_TestCase क्लास में सेटअप और टियरडाउन संरक्षित तरीके बनाए गए हैं, जिनके पास खाली कार्यान्वयन है। इन तरीकों को क्रमशः अगले परीक्षण विधि की शुरुआत से पहले और बाद में बुलाया जाता है, और परीक्षण कार्यों के निष्पादन के लिए प्रणाली तैयार करने और प्रत्येक परीक्षण के पूरा होने के बाद इसे साफ करने के लिए काम करते हैं। PHPUnit_Framework_TestCase को विस्तारित करने वाले परीक्षण वर्ग में, आप इन विधियों को ओवरराइड कर सकते हैं और प्रत्येक परीक्षण विधि में दोहराए गए कोड को उनमें पहले से रख सकते हैं। नतीजतन, परीक्षण निष्पादन के दौरान विधि कॉल का क्रम निम्नानुसार होगा:

1.   setUp () {/ * सिस्टम को वांछित राज्य में सेट करें * /} 

2.   testMethod1 () {/ * परीक्षण कक्षा विधि 1 * /} 

3.   अश्रु () {/ * सिस्टम को मंजूरी दे दी * /} 

1.   setUp () {/ * सिस्टम को वांछित राज्य में सेट करें * /} 

2.   testMethod2 () {/ * परीक्षित वर्ग विधि 2 * /} 

3.   अश्रु () {/ * सिस्टम को मंजूरी दे दी * /} 

...

1.   setUp () {/ * सिस्टम को वांछित राज्य में सेट करें * /} 

2.   testMethodN () {/ * ने कक्षा N पद्धति का परीक्षण किया * /} 

3.   अश्रु () {/ * सिस्टम को मंजूरी दे दी * /} 

डेटाबेस के साथ इंटरेक्टिंग PHP कोड का परीक्षण करना

डेटाबेस के साथ बातचीत करने वाले कोड के लिए परीक्षण लिखने की प्रक्रिया व्यावहारिक रूप से सामान्य PHP कक्षाओं के लिए परीक्षण प्रक्रिया के समान है। सबसे पहले आपको एक परीक्षण वर्ग बनाने की आवश्यकता है जो PHPUnit_Extensions_Database_TestCase (PHPUnit_Extensions_Database_TestCase वर्ग खुद को PHPUnit_Framat_TestCase विरासत में मिला है), जिसमें परीक्षण किए गए वर्ग के तरीकों के परीक्षण शामिल होंगे। फिर परीक्षण उपसर्ग के साथ शुरू होने वाले परीक्षण के तरीकों का निर्माण करें, और फिर परीक्षण वर्ग के नाम के साथ इस phpunit कोड को खिलाएं। केवल अंतर यह है कि परीक्षण वर्ग में दो सार्वजनिक विधियों - getConnection () और getDataSet () को लागू करना आवश्यक है। डेटाबेस के साथ काम करने के लिए DbUnit को सिखाने के लिए पहली विधि आवश्यक है (आपको पीडीओ का उपयोग करना है), और दूसरा यह बताने के लिए कि अगले परीक्षण से पहले डेटाबेस में क्या स्थिति होनी चाहिए। DbUnit शब्दावली में एक DataSet एक या अधिक तालिकाओं के समूह को संदर्भित करता है।

जैसा कि ऊपर उल्लेख किया गया है, अगले परीक्षण को निष्पादित करने से पहले (परीक्षण वर्ग में विधि द्वारा दर्शाया गया है), PHPUnit परीक्षण वर्ग की वस्तु के लिए रनटाइम का अनुकरण करने के लिए विशेष सेटअप () विधि कहता है। DbUnit के मामले में, setUp () विधि का डिफ़ॉल्ट कार्यान्वयन अब खाली नहीं है। आम तौर पर, एक डेटाबेसटेस्टर ऑब्जेक्ट सेटअप () विधि के अंदर बनाया जाएगा, जो हमारे द्वारा परिभाषित getConnection () विधि का उपयोग करके, डेटाबेस में प्राप्त होने वाले टेबल सेट (डेटासेट) द्वारा प्रस्तुत डेटाबेस को प्राप्त करेगा जब गेटटासेट () विधि कहा जाता है। यदि आप सावधान थे, तो getDataSet () पद्धति का कार्यान्वयन परीक्षण वर्ग द्वारा प्रदान किया जाना चाहिए, अर्थात। हमारे द्वारा। नतीजतन, हमें कॉल का एक समान अनुक्रम मिलता है

1.   setUp () {/ * डेटाबेस से प्राप्त आंकड़ों के अनुसार सेट करें
                      विधि getDataSet () * /} 

2.   testMethod1 () {/ * परीक्षण कक्षा विधि 1 * /} 

3.   अश्रु () {/ * सिस्टम को मंजूरी दे दी * /} 

1.   setUp () {/ * डेटाबेस से प्राप्त आंकड़ों के अनुसार सेट करें
                      विधि getDataSet () * /} 

2.   testMethod2 () {/ * परीक्षित वर्ग विधि 2 * /} 

3.   अश्रु () {/ * सिस्टम को मंजूरी दे दी * /} 

...

1.   setUp () {/ * डेटाबेस से प्राप्त आंकड़ों के अनुसार सेट करें
                      विधि getDataSet () * /} 

2.   testMethodN () {/ * ने कक्षा N पद्धति का परीक्षण किया * /} 

3.   अश्रु () {/ * सिस्टम को मंजूरी दे दी * /} 

थोड़ी परेशानी

परिचालन वातावरण: परियोजना में उपयोग किए जाने वाले डेटाबेस में कई दर्जन टेबल हैं, MySQL InnoDB इंजन। डेटाबेस स्तर पर डेटा स्थिरता बनाए रखने के लिए विदेशी कुंजी तंत्र का सक्रिय रूप से उपयोग किया जाता है।

1. आधार आरंभीकरण

पहला उपद्रव जो मेरे लिए परीक्षण प्रक्रिया को ओवरशैडो करने के लिए शुरू हुआ था, मैंने डेटाबेस को शुरुआती तालिकाओं के सेट से शुरू किया था जो मैंने बनाया था।

DbUnit आपको विभिन्न स्रोतों से डेटा प्राप्त करते हुए, डेटासेट बनाने की अनुमति देता है:

• फ्लैट Xml एक xml फ़ाइल में डेटाबेस की स्थिति का वर्णन करने के लिए एक सरल तरीका है, मुख्य रूप से मैन्युअल फ़ाइल पीढ़ी के लिए डिज़ाइन किया गया है।
• Xml राज्य को स्थापित करने के लिए एक पूर्ण स्वरूप है, बहुत अधिक bukaf, लेकिन अधिक विशेषताएं (आप शून्य मान सेट कर सकते हैं, अधिक सटीक रूप से डेटाबेस की संरचना का वर्णन कर सकते हैं, आदि)
• MySQL Xml पिछले प्रारूप का एक भिन्नरूप है, कृपया DbUnit के डेवलपर्स द्वारा प्रदान किया गया है, जो आपको mysqldump उपयोगिता का उपयोग करके डेटाबेस डेटा के निर्यात के आधार पर डेटासेट ऑब्जेक्ट बनाने की अनुमति देता है।
• डेटाबेस की वर्तमान स्थिति के आधार पर डेटासेट ऑब्जेक्ट बनाना।

तालिका सेट बनाने के लिए उपरोक्त प्रत्येक विधि PHPUnit_Extension_Database_TestCase वर्ग की एक अलग विधि द्वारा कार्यान्वित की जाती है।

मैंने अपने सहायक के रूप में mysqldump को चुना और हमले के लिए रवाना हुआ: डेटाबेस की आवश्यक स्थिति का गठन किया, इसे xml में उतार दिया और getDataSet () कार्यान्वयन में कुछ इस तरह लिखा:

public function getDataSet() { return $this->createMySQLXMLDataSet('db_init.xml'); // ,  mysqldump. } 

... और पहला टेस्ट चलाने का फैसला किया। हालांकि, उन्होंने तुरंत एक अपवाद प्राप्त किया, जिसमें स्पष्ट रूप से कहा गया था कि इसमें विदेशी कुंजी पर प्रतिबंधों की उपस्थिति के कारण डेटाबेस को निर्दिष्ट स्थिति में नहीं लाया जा सकता है।

DbUnit स्रोतों में खुदाई के कुछ मिनटों से पता चला कि PHPUnit_Extensions_Database_TestCase :: setUp () विधि, डेटाबेस को उस डेटासेट के अनुसार राज्य में सेट कर रहा है जो निर्दिष्ट किया गया है, जो PHPUnit_Extensions_Database_Operation_Factory_Factory_IN_LE_INSIT का उपयोग करके किया जाता है। CLEAN_INSERT ऑपरेशन, बदले में, कारखाने द्वारा निर्मित एक मैक्रो है और इसमें दो ऑपरेशन शामिल हैं: PHPUnit_Extensions_Database_Operation_Factory :: TRUNCATE और PHPUnit_Eatension_Database_Operation_Factory :: INSERT। जाहिर है, सब कुछ यहाँ जगह में गिर गया - एक डेटाबेस के लिए TRUNCATE बनाना संभव नहीं है, जिसके पास FOREIGN KEY विदेशी कुंजियों पर सक्रिय प्रतिबंध हैं।

तय करने की जरूरत है। दो तरीके हैं: या तो अस्थायी रूप से परीक्षण (अंधेरे पथ) के दौरान FOREIGN कुंजी को अक्षम करें, या Dbnit स्रोत कोड (प्रकाश लेकिन लंबा पथ) को धूम्रपान करते समय मिले नए PHPUnit_Extensions_Database_Operation_Factory :: DELETE_ALL आदेश का उपयोग करें। एक मिनट के बाद, अंधेरे पक्ष ने मुझ पर काबू पा लिया, और मैंने कनेक्शन के निर्माण के दौरान विदेशी कुंजियों पर अखंडता प्रतिबंधों को अक्षम करने के लिए और सरल तरीके से जाने का फैसला किया। सौभाग्य से, निर्माण कोड अभी भी मेरे द्वारा getConnection () पद्धति के कार्यान्वयन में लिखा गया था।

GetConnection () का एक विशिष्ट कार्यान्वयन कुछ इस तरह दिखता है:

 public function getConnection() { if (is_null($this->m_oConn)) { $oPdo = new PDO('mysql:dbname=db1;host=localhost', 'root', 'qwerty'); $this->m_oConn = $this->createDefaultDBConnection($oPdo, 'db1'); } return $this->m_oConn; } 

$ m_oConn परीक्षण वर्ग का एक सदस्य चर है, जो पीडीओ के आसपास किसी प्रकार का आवरण है। और सटीक होने के लिए, यह वर्ग PHPUnit_Extensions_Database_DB_DefaultDatabaseConnection का एक उदाहरण है। PDO ऑब्जेक्ट बनाने के तुरंत बाद लाइन $ oPdo-> एक्जीक्यूट ('SET Foreign_key_checks = 0') जोड़कर, मैंने थोड़ी देर के लिए इनिशियलाइज़ेशन की समस्या हल कर दी।

दरअसल, जैसा कि एक उम्मीद थी, थोड़ी देर बाद मैं डेटाबेस में डेटा असंगति के साथ एक रेक में भाग गया और विदेशी कुंजियों को अक्षम करने और DELETE_ALL के साथ TRUNCATE को बदलने से इनकार करने के लिए, अर्थात् उज्ज्वल पथ पर लौटना पड़ा।

सूत्रों की एक और समीक्षा से पता चला कि आपको PHPUnit_Extensions_Database_TestCase :: setUp () के कार्यान्वयन की दिशा में खुदाई करने की आवश्यकता है। यहाँ उसका कोड है:

 protected function setUp() { parent::setUp(); // PHPUnit_Framework_TestCase::setUp() -   $this->databaseTester = NULL; $this->getDatabaseTester()->setSetUpOperation($this->getSetUpOperation()); $this->getDatabaseTester()->setDataSet($this->getDataSet()); $this->getDatabaseTester()->onSetUp(); } 

और यहाँ getSetUpOperation () विधि है:

 protected function getSetUpOperation() { return PHPUnit_Extensions_Database_Operation_Factory::CLEAN_INSERT(); } 

इसके परीक्षण वर्ग में getSetUpOperation () विधि को ओवरराइड करने के लिए:

 protected function getSetUpOperation() { return PHPUnit_Extensions_Database_Operation_Factory::INSERT(); } 

मैंने TRUNCATE से छुटकारा पा लिया, लेकिन डेटाबेस क्लीनअप को लागू करने की आवश्यकता से खुद को जोड़ा। चूँकि हमारे डेटाबेस में कई विचार हैं, PHPUnit_Extensions_Database_Operation_Factory :: DELETE_ALL () सभी डेटाबेस तालिकाओं के डेटासेट के लिए एक विचारहीन कॉल में कुछ भी अच्छा नहीं होगा। इसके अलावा, मैंने सोचा कि न केवल परीक्षण को शुरू करने के समय डेटाबेस की सफाई की कार्यक्षमता काफी उपयोगी हो सकती है, इसलिए मैंने इसे एक स्वतंत्र विधि के रूप में डिजाइन करने का निर्णय लिया:

 protected function clearDb() { $aTableNames = $this->getConnection()->createDataSet()->getTableNames(); foreach ($aTableNames as $i => $sTableName) { if (false === strpos($sTableName, 'view_')) continue; unset($aTableNames[$i]); } $aTableNames = array_values($aTableNames); $op = \PHPUnit_Extensions_Database_Operation_Factory::DELETE_ALL(); $op->execute($this->getConnection(), $this->getConnection()->createDataSet($aTableNames)); } 

कोड मानता है कि डेटाबेस में मौजूद सभी दृश्य उपसर्ग view_ से शुरू होते हैं।
यह केवल सेटअप () विधि को फिर से परिभाषित करने के लिए बना हुआ है ताकि यह डेटा में भरने के लिए डेटाबेसटेस्टर को देने से पहले डेटाबेस को अपने आप साफ कर दे।

 protected function setUp() { $this->clearDb(); parent::setUp(); } 

2. टेबल सेट की तुलना

अगली समस्या तब हुई जब दो डेटासेट की तुलना करने की कोशिश की गई - एक डेटाबेस से सीधे प्राप्त किया गया (परीक्षण कोड के परिणामस्वरूप उत्पन्न), और दूसरा - हाथ से अग्रिम में और वांछित परिणाम का प्रतिनिधित्व करते हुए बनाया गया।

डेटाबेस की वर्तमान स्थिति निम्न प्रकार से प्राप्त की जा सकती है:

 $oActualDataSet = $this->getConnection()->createDataSet(); 

PHPUnit_Extensions_Database_TestCase :: assertDataSetsEqual विधि को देखकर, मैं मानस में तालिकाओं के दो सेटों की तुलना कर रहा था, मुझे बहुत खुशी हुई। जैसा कि यह बहुत जल्दी निकला। तुलना परिणाम बहुत अप्रत्याशित थे। तुलना करने के दौरान तालिकाओं के दो समान दिखने वाले सेटों के दुर्घटनाग्रस्त होने का कारण बनता है।

डिबगर ने बदले में दिखाया कि यह परेशानी डेटाबेस से प्राप्त डेटासेट में है। अनुकूलन उद्देश्यों के लिए, जब $ यह-> getConnection () -> createDataSet () को परीक्षण वर्ग में कहा जाता है, तो केवल टेबल का एक आंशिक सेट लोड किया जाता है, और सटीक होने के लिए, केवल डेटासेट का मेटाडेटा (डेटाबेस और कुछ अन्य पतियों का नाम) ।

PHPUnit_Extensions_Database_TestCase :: assertDataSetsEqual का स्रोत कोड इस प्रकार है:

 public static function assertDataSetsEqual(PHPUnit_Extensions_Database_DataSet_IDataSet $expected, PHPUnit_Extensions_Database_DataSet_IDataSet $actual, $message = '') { $constraint = new PHPUnit_Extensions_Database_Constraint_DataSetIsEqual($expected); self::assertThat($actual, $constraint, $message); } 

यदि आप कॉल की श्रृंखला को और विस्तारित करते हैं, तो प्रत्यक्ष तुलना ऑपरेशन के कई प्रतिनिधिमंडल के बाद, यह PHPUnit_Extensions_Database_DataSet_AbstractTable :: मैचों (PHPUnit_Extra_Database_DataSet_ITable $ अन्य) में आएगा, जिसमें दो तालिकाओं की तुलना की जाएगी। इस पद्धति में, तालिकाओं की तुलना करते समय, उनमें से डेटा आवश्यक रूप से डेटाबेस से खींच लिया जाएगा। लेकिन यह है अगर यह इस विधि की बात आती है। क्योंकि दो DataSets की तालिकाओं को एक दूसरे के साथ तुलना करने से पहले, DataSets की तुलना की जाती है। नतीजतन, कुछ जगह पर मुखर काम नहीं करता है। यह बग github पर PHPUnit / DbUnit के मुद्दों में है, यह पहले ही कई महीने पुराना हो चुका है।

इस त्रुटि के सुधार की प्रत्याशा में, मैंने जल्दी से तालिका सेट की तुलना करने के लिए एक विधि का सुझाव दिया। DbUnit की भावना में काफी नहीं, जहां सब कुछ मूल्यांकन के लिए कॉल के एक सार्वभौमिक अनुक्रम द्वारा किया जाता है -> तुलना की गई वस्तुओं के विशिष्ट कार्यान्वयन के मैच, लेकिन यह काम कर रहा है:

 public function compareDataSets(PHPUnit_Extensions_Database_DataSet_IDataSet $expected, PHPUnit_Extensions_Database_DataSet_IDataSet $actual, $message = '') { $aExpectedNames = $expected->getTableNames(); $aActualNames = $actual->getTableNames(); sort($aActualNames); sort($aExpectedNames); $this->assertEquals($aExpectedNames, $aActualNames, $message); foreach ($aActualNames as $sTableName) { $atable = $actual->getTable($sTableName); $etable = $expected->getTable($sTableName); if (0 == $atable->getRowCount()) { $this->assertEquals(0, $etable->getRowCount(), $message); } else { $this->assertTablesEqual($etable, $atable, $message); } } } 

निष्कर्ष

आलेख में वर्णित DbUnit का व्यवहार DbUnit 1.1.2, PHPUnit 3.6.10 और MySQL 5.1 का उपयोग करके प्राप्त किया गया था। ऊपर वर्णित सभी बैसाखियों को जोड़ने के परिणामस्वरूप, एक आधार वर्ग बनाया गया था जो PHPUnit_Extensions_Database_TestCase को विस्तारित करता है और इन सभी विधियों को समाहित करता है। आधार के साथ काम करने वाले प्रोजेक्ट के शेष परीक्षण वर्गों को इस बेस क्लास से विरासत में मिला है।

एक अच्छे व्यक्ति को खुश करने के लिए - मुझे नहीं पता कि कैसे परीक्षण करना है, लेकिन मैं इसे बहुत पसंद करता हूं। इसलिए मैं लेख में प्रस्तुत तरीकों के बारे में टिप्पणी सुनना चाहूंगा।