जावा प्रोजेक्ट्स में XML डेटा को मान्य करना

हाय,% उपयोगकर्ता नाम%।

कई परियोजनाओं में, मुझे परीक्षणों में XML डेटा की तुलना करने की आवश्यकता थी।

दरअसल, ऐसा होता है कि आपके मॉड्यूल का परिणाम XML डेटा है। यदि ऐसा है, तो वे कैसे उत्पन्न होते हैं, यह टीडीडी के सिद्धांतों के अनुसार जाँच की जानी चाहिए। मैं, बदले में, विकास करते समय उनसे चिपके रहने की कोशिश करता हूं।

कट के तहत, मैं कोड में XML की पीढ़ी का परीक्षण करने के लिए, मेरी राय में, सबसे अच्छे तरीके से बात करने की कोशिश करूंगा। XML तुलना उपकरण के रूप में, मैंने XmlUnit का उपयोग किया।


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

यह सब कैसे शुरू हुआ

किसी तरह, अगली परियोजना पर काम करते हुए, मैंने एक सहयोगी के परीक्षण को तोड़ दिया। जब मैंने परीक्षण का अध्ययन करना शुरू किया, तो मुझे वहाँ कुछ इस तरह मिला:

@Test public void testSomeXmlGeneration() { //      String result = someModule.generateXML(); //     XML  File file = File.createTempFile("actial_data", ".xml"); FileWriter fileWriter = new FileWriter(file); fileWriter.write(result); fileWriter.close(); File fileExpect = new File(this.getClass().getResource("/expected_data.xml").getFile()); FileAssert.assertBinaryEquals(fileExpect, file); } 

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

यह कोड क्यों खराब है?

मैं बिंदुओं को सही ठहराने की कोशिश करूंगा।

1. दो फाइलों की तुलना करने के लिए बहुत से इशारे

वास्तव में, कई आंदोलन हैं, और यदि आपको अक्सर तुलना करना पड़ता है, तो इस कोड को एक रूप में या दूसरे को आगे और पीछे कॉपी किया जाता है, जो वास्तव में अक्सर होता है। इसके साथ कुछ करना समय की कमी से बाधा है।

2. उत्पन्न XML कोड का कोई सत्यापन नहीं है

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

3. टैग और विशेषताओं के अलग-अलग क्रम के कारण समान XML संरचनाएं और डेटा समान नहीं हो सकते हैं।

उदाहरण के लिए, इस तरह:

विकल्प 1	टैग्स को पुनः व्यवस्थित करें
<?xml version="1.0" encoding="UTF-8"?> <project> <name>some project</name> <description>desc</description> </project>	<?xml version="1.0" encoding="UTF-8"?> <project> <description>desc</description> <name>some project</name> </project>

या तो:

विकल्प 2	विशेषताओं का क्रम बदलें
<?xml version="1.0" encoding="UTF-8"?> <project name=”some project” description=”desc”/>	<?xml version="1.0" encoding="UTF-8"?> <project description=”desc” name=”some project”/>

4. मैं XML स्वरूपण परीक्षण चाहता हूं

लेख की शुरुआत में प्रस्तुत परीक्षण में, XML डेटा को बिना रिक्त स्थान या लाइन ब्रेक के प्रस्तुत किया गया था। फर्क महसूस करें:

विकल्प 3	रिक्त स्थान और लाइन विराम हटाएं
<?xml version="1.0" encoding="UTF-8"?> <project> <name>some project</name> <description>desc</description> </project>	<?xml version="1.0" encoding="UTF-8"?> <project><description>desc</description><name>some project</name></project>

5. डेटा के अंदर स्वचालित रूप से संसाधित स्थानान्तरण

विकल्प 3	डेटा के भीतर पंक्तियों को लपेटें
<?xml version="1.0" encoding="UTF-8"?> <project> <name>some project</name> <description>desc</description> </project>	<?xml version="1.0" encoding="UTF-8"?> <project> <name> some project </name> <description>desc</description> </project>

लेख की शुरुआत में विचार किए गए परीक्षण में, स्रोत डेटा एक पंक्ति में था, केवल टैग और विशेषताएँ थोड़े बड़े थे। एक त्रुटि डालना बहुत सरल है, और सही करना ताकि परीक्षण पास लंबा और दर्दनाक हो।

ऊपर वर्णित सभी समस्याएं मैंने समन्वय को ठीक करने का निर्णय लिया:

• XML की तुलना करने और इसकी वैधता की जांच करने के लिए कुछ लाइब्रेरी का उपयोग करें;
• सभी परीक्षणों को फिर से लिखें ताकि वे इस पुस्तकालय का उपयोग करें (अभी भी कुछ अच्छे हैं)।

एक छोटी खोज के बाद, मेरी पसंद XmlUnit पर गिर गई।

बेसिक XmlUnit कनेक्शन के तरीके

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

तो चलिए चलते हैं

अपनी परियोजनाओं के लिए मैं मावेन का उपयोग करता हूं। XmlUnit को मावेन में निर्भरता के रूप में कनेक्ट करें। ऐसा करने के लिए, pom.xml खोलें और निर्भरता में एक नई निर्भरता जोड़ें।

 <dependencies> <!-- ….-  ... --> <dependency> <groupId>xmlunit</groupId> <artifactId>xmlunit</artifactId> <version>1.3</version> </dependency> </dependencies> 

परीक्षण खोलें, वहां एक नई तुलना लिखें

 @Test public void testSomeXmlGeneration() { //      String result = someModule.generateXML(); Diff diff = new Diff(getResourceAsString("/expeced_data.xml"), result); assertTrue("XML   ", diff.similar()); } 

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

 @Before public void setUp() throws Exception { XMLUnit.setIgnoreComments(true); XMLUnit.setIgnoreWhitespace(true); } 

यह सब लगता है, आप परिणाम का आनंद ले सकते हैं। हालाँकि, मान लें कि हमने XML में कोई त्रुटि की है। फिर हमें यह जानना होगा कि कौन सा टैग समस्या है।
निम्नलिखित उदाहरण हमें इसे हल करने में मदद करेंगे:

 //    class TestXmls { @Before public void setUp() throws Exception { XMLUnit.setIgnoreComments(true); XMLUnit.setIgnoreWhitespace(true); } @Test public void testSomeXmlGeneration() { //      String result = someModule.generateXML(); Diff diff = new Diff(getResourceAsString("/expeced_data.xml"), result); Tools.showXmlDiff(diff); assertTrue("XML   ", diff.similar()); } } //    public final class Tools { public static void showXmlDiff(Diff diff) { DetailedDiff detDiff = new DetailedDiff(diff); List differences = detDiff.getAllDifferences(); for (Object object : differences) { Difference difference = (Difference) object; System.out.println("***********************"); System.out.println(difference); System.out.println("***********************"); } } } 

ShowXmlDiff विधि पर ध्यान दें। इसमें हम अंतरों की एक सूची प्राप्त करते हैं और इसे प्रदर्शित करते हैं।

आप और क्या अच्छा कर सकते हैं?

• XmlUnit, तुलना के अलावा, वैधता के लिए XML डेटा की जाँच के लिए फ़ंक्शंस प्रदान करता है।
• XSLT परिवर्तनों का परीक्षण करने के लिए आप XmlUnit का उपयोग कर सकते हैं।
• और इतने पर और आगे ...

साहित्य

जिन लिंक्स से मुझे जानकारी मिली।

• आधिकारिक XmlUnit प्रलेखन
• उपयोग के उदाहरण
• XmlUnit मैनुअल
• उपयोगी जवाब के टन के साथ Stackoverflow सवाल
• तुलनात्मक उपयोगिताओं और पुस्तकालयों की सूची
• UPD: अधिक XmlUnit उपयोग उदाहरण

UPD: Lure_of_Chaos के साथ एक चर्चा के बाद, मैंने संदर्भों की सूची में एक और लिंक जोड़ा। वहां आप XML सत्यापन और अन्य सुंदर विशेषताओं के बारे में पढ़ सकते हैं जो किसी कारण से आधिकारिक दस्तावेज में नहीं लिखे गए हैं।

एक बार फिर, XmlUnit आपको DTD और XSD योजनाओं के खिलाफ XML वैधता की जांच करने की अनुमति देता है।
जैसा कि XSD योजनाओं में Lure_of_Chaos सही ढंग से नोट किया गया है , आपको उन आदेशों की आवश्यकता हो सकती है जिनमें तत्व परिभाषित किए गए हैं । परीक्षण में यह परीक्षण महत्वपूर्ण है।

UPD2 : सत्यापन का अंतिम उदाहरण तय किया । धन्यवाद, कोलविन ।
यह सब, आपके ध्यान के लिए धन्यवाद।