🎏 🛄 🥔 K प्रोजेक्ट का टेस्ट इतिहास: कोटलिन और स्पेक 🕣 👨🏽‍🎨 🔕

नमस्कार, हेब्र!

इस लेख में हम कई क्यूआईडब्ल्यूआई परियोजनाओं में से एक पर स्वचालित परीक्षण के बारे में बात करेंगे, जिसका नाम "के" कोड है।

जब हमने इस परियोजना का परीक्षण आयोजित किया, तो हमने व्यावहारिक और प्रचार कोटलिन के साथ-साथ स्पेक को चुनने का फैसला किया, जो कहता है कि "आप उन्हें परीक्षण कहते हैं, हम उन्हें विनिर्देशन कहते हैं" (आप उन्हें परीक्षण कहते हैं, हम उन्हें विनिर्देशों कहते हैं)। यदि आप इसी तरह के कार्यों का सामना कर रहे हैं तो शायद यह दृष्टिकोण आपके लिए उपयुक्त है।

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

आधिकारिक दस्तावेज हमें बताता है कि "स्पेक कोटलिन में लिखा गया है, और आपके द्वारा लिखे गए विनिर्देशों को कोटलिन में लिखा जाएगा" - यह बहुत स्पष्ट रूप से प्रश्न का उत्तर देता है: "इसकी आवश्यकता क्यों है?"

इसलिए ...

यह क्या है और इसकी आवश्यकता क्यों है?

परियोजना अपने साथी को सॉफ्टवेयर प्रदान करती है, जो Android के लिए एक एप्लीकेशन है। शेर का परीक्षण का हिस्सा बैक-एंड पर पड़ता है, इसलिए हम REST API के परीक्षण पर ध्यान केंद्रित करेंगे।

एक गुच्छा के लिए जो आपको परीक्षण लिखने और परिणाम प्राप्त करने की अनुमति देता है, सब कुछ स्पष्ट है: आपको एक प्रोग्रामिंग भाषा, परीक्षण रूपरेखा, HTTP क्लाइंट और रिपोर्ट की आवश्यकता है। लेकिन हमारे परीक्षण ब्रह्मांड में प्रवेश बिंदु के बारे में क्या?

आवश्यकताएँ, वे विनिर्देश हैं, परियोजना डेवलपर्स ने परीक्षण के रूप में लिखने का फैसला किया। परिणाम एक दिलचस्प तस्वीर थी - बीडीडी। इस प्रकार, कोटलिन, स्पेक और खटप अखाड़े में दिखाई दिए।
चौकस पाठक पूछेगा - ठीक है, लेकिन परीक्षक कहां हैं?

परीक्षकों

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

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

शुरुआत हो रही है

सेवा विभाग में IntelliJ IDEA सेवा है, और चूंकि कोटलिन JVM के शीर्ष पर चलता है और JetBrains द्वारा विकसित किया गया था, इसलिए कोड लिखने के लिए कुछ भी अतिरिक्त स्थापित करने की आवश्यकता नहीं थी।

स्पष्ट कारणों से, हम स्वयं भाषा सीखने की प्रक्रिया को छोड़ देंगे।

पहली चीज जिसके साथ शुरू किया गया था, रिपॉजिटरी को क्लोन कर रहा था:
git clone https://gerrit.project.com/k/autotests

तब परियोजना को खोला गया था और ग्रेडल सेटिंग्स आयात की गई थीं:

पूर्ण संतुष्टि और आराम के लिए (* वास्तव में, यह बहुत जरूरी है), स्पेक प्लगइन स्थापित किया गया था:

उन्होंने विकास के माहौल में परीक्षणों की शुरूआत सुनिश्चित की:

पहला चरण पूरा हो गया था, और यह समय था कि वे स्वयं परीक्षण लिखना शुरू कर दें।

परीक्षण

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

और जब से परीक्षण विभाग की आंतरिक टीमों की बातचीत एक समान तरीके से आयोजित की जाती है, तब सेवा विभाग कम से कम प्रवेश करने की सुविधा के लिए आवश्यकताओं को "पूछता है"।

ऐसा लग सकता है कि यह "के" के मामले में एक मृत अंत है। लेकिन वहाँ यह था:

उस रिपॉजिटरी तक पहुंच पढ़ें जहां प्रोजेक्ट स्रोत संग्रहीत किए गए थे;
भंडार का क्लोन;
उन्होंने जावा में लिखे सोर्स कोड्स को पढ़कर उत्पाद की कार्यक्षमता का पता लगाना शुरू किया।

आपने क्या पढ़ा?

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

वेब के मामले में:

उत्पादों को जोड़ने के लिए, एक POST अनुरोध का उपयोग किया जाता है, जिसके शरीर में डेटा के साथ JSON है।
उत्पादों को अपडेट या संपादित करने के लिए, एक पीयूटी अनुरोध का उपयोग किया जाता है, जिसके शरीर में परिवर्तित डेटा के साथ JSON होता है।
माल हटाने के लिए, एक DELETE अनुरोध का उपयोग किया जाता है, जिसका शरीर खाली है।

मोबाइल के मामले में:

उत्पादों को जोड़ने, अद्यतन करने और हटाने के लिए, एक POST अनुरोध का उपयोग किया जाता है, जिसके शरीर में निर्दिष्ट ऑपरेशन के लिए डेटा के साथ JSON होता है।

यानी JSON में तीन नोड हैं:

"जोड़ा गया: जोड़ा उत्पादों की सूची,
"निकाला गया": हटाए गए आइटमों की एक सूची,
"अद्यतित": अद्यतन उत्पादों की एक सूची।

आपने क्या लिखा?

परीक्षण विनिर्देशों वाले एक परीक्षण वर्ग को पहले से ही बनाया गया था और इसमें परीक्षण विधियाँ (* स्पेक में थोड़ी नहीं) थीं, इसलिए इसका विस्तार करना आवश्यक था।

वेब के लिए

सफल उत्पाद जोड़ के लिए परीक्षण:

आइटम जोड़ें
जाँच लें कि आइटम जोड़ दिया गया है।
बनाए गए उत्पाद को हटाएं (पोस्टकंडिशन)

कोड:

 on("get changed since when goods added") { val goodsUpdateName: String = RandomStringUtils.randomAlphabetic(8) val date = Date.from(Instant.now()).time - 1 val goodsAdded = post(baseUrl + "goods/${user.storeId}", authHeader, json = dataToMap(goods.copy(name = goodsUpdateName))) it("should return the status code OK") { goodsAdded.statusCode.should.be.equal(OK) } val goodId = goodsAdded.jsonObject?.optLong("id") val goodsUpdates = get(baseUrl + "updates/goods/since/" + date, authHeader.plus("AppUID" to user.AppUID)) it("should return the status code OK") { goodsUpdates.statusCode.should.be.equal(OK) } val goodsInsert = goodsUpdates.jsonObject.getJSONArray("updated").toList() .map { it as JSONObject } .find { it.optLong("goodId") == goodId } it("should contain goods insert") { goodsInsert.should.be.not.`null` goodsInsert?.optString("name").should.be.equal(goodsUpdateName) } delete(baseUrl + "goods/${user.storeId}/$goodId", authHeader) }

माल को हटाने के लिए सफल परीक्षण:

उत्पाद जोड़ें (पूर्व शर्त)
हम माल हटाते हैं
हम जांचते हैं कि उत्पाद हटा दिया गया है

कोड:

 on("get changed since when goods deleted") { val goodsUpdateName: String = RandomStringUtils.randomAlphabetic(8) val date = Date.from(Instant.now()).time - 1 val goodsAdded = post(baseUrl + "goods/${user.storeId}", authHeader, json = dataToMap(goods.copy(name = goodsUpdateName))) it("should return the status code OK") { goodsAdded.statusCode.should.be.equal(OK) } val goodId = goodsAdded.jsonObject?.optLong("id") val responseDelete = delete(baseUrl + "goods/${user.storeId}/$goodId", authHeader) it("should return the status code NO_CONTENT") { responseDelete.statusCode.should.be.equal(NO_CONTENT) } val goodsUpdates = get(baseUrl + "updates/goods/since/" + date, authHeader.plus("AppUID" to user.AppUID)) it("should contain goods deletes") { goodsUpdates.statusCode.should.be.equal(OK) goodsUpdates.jsonObject.getJSONArray("removed").toList() .map { it as Int } .find { it == goodId.toInt() } .should.be.not.`null` } }

अनधिकृत उपयोगकर्ता द्वारा क्वेरी निष्पादन के लिए नकारात्मक परीक्षण

आइटम जोड़ें
प्रतिक्रिया की स्थिति की जाँच करें
एक उत्पाद जोड़ने का अनुरोध एक प्राधिकरण हेडर के बिना भेजा जाता है। उत्तर 401 अनधिकृत स्थिति के साथ आता है।

कोड:

  on("get changed since when goods added without authorization") { val response = post(baseUrl + "goods/${user.storeId}", json = dataToMap(goods)) it("should contain an Unauthorized response status and an empty body") { response.statusCode.should.be.equal(UNAUTHORIZED) response.text.should.be.equal("") } }

मोबाइल के लिए

प्रतिक्रिया शरीर और अनुरोध निकाय के गठन से नोड प्राप्त करने के लिए हेल्पर फ़ंक्शन लिखे गए थे।

कोड:

 package com.qiwi.k.tests import com.fasterxml.jackson.databind.ObjectMapper import khttp.responses.Response import org.json.JSONObject val mapper = ObjectMapper() fun arrayAdded(n: Int): Array<GoodsUpdate> { return Array(n) { i -> GoodsUpdate() } } fun getGoodsIds(list: List<GoodsUpdate>): List<Long> { return Array(list.size) { i -> list[i].goodId }.toList() } fun getResult(response: Response): List<GoodsUpdate> { return mapper.readValue( response.jsonObject.getJSONArray("result").toString(), Array<GoodsUpdate>::class.java ).toList() } fun getCountryIdFromTheResult(response: Response): List<Int> { val listGoods = mapper.readValue( response.jsonObject.getJSONArray("result").toString(), Array<GoodsUpdate>::class.java ).toList() return Array(listGoods.size) { i -> listGoods[i].countryId }.toList() } fun getBody(added: Array<GoodsUpdate> = emptyArray(), removed: List<Long> = emptyList(), updated: List<GoodsUpdate> = emptyList()): JSONObject { return JSONObject( mapOf( "added" to added, "removed" to removed, "updated" to updated ) ) }

सफल उत्पाद जोड़ के लिए परीक्षण

आइटम जोड़ें
जाँच लें कि आइटम जोड़ दिया गया है।
हम माल हटाते हैं (पोस्टकांडिशन)

कोड:

 on("adding goods") { val respAdd = post(urlGoodsUpdate, authHeaderWithAppUID, json = getBody(added = arrayAdded(count))) val resultOfAdding = getResult(respAdd) it("should return the status code OK") { respAdd.statusCode.should.be.equal(OK) } it("should be equal to the size of the variable count") { resultOfAdding.should.be.size.equal(count) } post(urlGoodsUpdate, authHeaderWithAppUID, json = getBody(removed = getGoodsIds(resultOfAdding))) }

सफल उत्पाद अद्यतन के लिए परीक्षण करें

उत्पाद जोड़ें (पूर्व शर्त)
हम माल अद्यतन करते हैं
जाँचें कि जोड़ा गया आइटम अद्यतन किया गया है।
हम माल हटाते हैं (पोस्टकांडिशन)

कोड:

 on("updating goods") { val respAdd = post(urlGoodsUpdate, authHeaderWithAppUID, json = getBody(added = arrayAdded(count))) val resultOfAdding = getResult(respAdd) it("should return the status code respAdd OK") { respAdd.statusCode.should.be.equal(OK) } it("should be equal to the size of the variable count (resultOfAdding)") { resultOfAdding.should.be.size.equal(count) } val respUpdate = post(urlGoodsUpdate, authHeaderWithAppUID, json = getBody(updated = resultOfAdding.map { it.copy(countryId = REGION_77) }) ) it("should return the status code respUpdate OK") { respUpdate.statusCode.should.be.equal(OK) } it("should be equal to the size of the variable count (respUpdate)") { getResult(respUpdate).should.be.size.equal(count) } it("should be all elements are 77") { getCountryIdFromTheResult(respUpdate).should.be.all.elements(REGION_77) } post(urlGoodsUpdate, authHeaderWithAppUID, json = getBody(removed = getGoodsIds(resultOfAdding))) }

माल को हटाने के लिए सफल परीक्षण:

उत्पाद जोड़ें (पूर्व शर्त)
हम माल हटाते हैं
हम सत्यापित करते हैं कि जोड़ा गया उत्पाद हटा दिया गया है

कोड:

 on("deleting goods") { val respAdd = post(urlGoodsUpdate, authHeaderWithAppUID, json = getBody(added = arrayAdded(count))) val resultOfAdding = getResult(respAdd) it("should return the status code respAdd OK") { respAdd.statusCode.should.be.equal(OK) } it("should be equal to the size of the variable count") { resultOfAdding.should.be.size.equal(count) } val respRemoved = post(urlGoodsUpdate, authHeaderWithAppUID, json = getBody(removed = getGoodsIds(resultOfAdding)) ) it("should return the status code respRemoved OK") { respRemoved.statusCode.should.be.equal(OK) } it("should be empty") { getResult(respRemoved).should.be.empty } }

परीक्षणों को लिखने के बाद, कोड की समीक्षा के माध्यम से जाना आवश्यक था।

समीक्षा

एक दर्जन से अधिक कमिट, देव के साथ बहुत से पत्राचार, मंचों पर जाकर, Google के साथ संवाद करते हुए। और यहाँ परिणाम है।

कोड:

 package com.qiwi.k.tests.catalog import … class GoodsUpdatesControllerSpec : WebSpek({ given("GoodsUpdatesController") { val OK = HttpResponseStatus.OK.code() val NO_CONTENT = HttpResponseStatus.NO_CONTENT.code() val UNAUTHORIZED = HttpResponseStatus.UNAUTHORIZED.code() val REGION_77 = 77 val auth = login(user) val accessToken = auth.tokenHead + auth.tokenTail val authHeader = mapOf("Authorization" to "Bearer $accessToken") val baseUrl = "http://test.qiwi.com/catalog/" val count = 2 val authHeaderWithAppUID = mapOf("Authorization" to "Bearer $accessToken", "AppUID" to user.AppUID) val urlGoodsUpdate = "http://test.qiwi.com/catalog/updates/goods/" on("get changes since") { val goodsName: String = goodsForUpdate.name + Random().nextInt(1000) val date = Date.from(Instant.now()).time - 1 put(baseUrl + "goods/${user.storeId}", authHeader, json = dataToMap(goodsForUpdate.copy(name = goodsName))) val goodsUpdates = get(baseUrl + "updates/goods/since/" + date, authHeader.plus("AppUID" to user.AppUID)) it("should contain goods updates") { val updates = goodsUpdates.jsonObject.getJSONArray("updated").toList() .map { it as JSONObject } .find { it.optLong("goodId") == goodsForUpdate.id } updates.should.be.not.`null` updates?.optString("name").should.be.equal(goodsName) } } on("get changed since when goods added") { val goodsUpdateName: String = RandomStringUtils.randomAlphabetic(8) val date = Date.from(Instant.now()).time - 1 val goodsAdded = post(baseUrl + "goods/${user.storeId}", authHeader, json = dataToMap(goods.copy(name = goodsUpdateName))) it("should return the status code OK") { goodsAdded.statusCode.should.be.equal(OK) } val goodId = goodsAdded.jsonObject?.optLong("id") val goodsUpdates = get(baseUrl + "updates/goods/since/" + date, authHeader.plus("AppUID" to user.AppUID)) it("should return the status code OK") { goodsUpdates.statusCode.should.be.equal(OK) } val goodsInsert = goodsUpdates.jsonObject.getJSONArray("updated").toList() .map { it as JSONObject } .find { it.optLong("goodId") == goodId } it("should contain goods insert") { goodsInsert.should.be.not.`null` goodsInsert?.optString("name").should.be.equal(goodsUpdateName) } delete(baseUrl + "goods/${user.storeId}/$goodId", authHeader) } on("get changed since when goods deleted") { val goodsUpdateName: String = RandomStringUtils.randomAlphabetic(8) val date = Date.from(Instant.now()).time - 1 val goodsAdded = post(baseUrl + "goods/${user.storeId}", authHeader, json = dataToMap(goods.copy(name = goodsUpdateName))) it("should return the status code OK") { goodsAdded.statusCode.should.be.equal(OK) } val goodId = goodsAdded.jsonObject?.optLong("id") val responseDelete = delete(baseUrl + "goods/${user.storeId}/$goodId", authHeader) it("should return the status code NO_CONTENT") { responseDelete.statusCode.should.be.equal(NO_CONTENT) } val goodsUpdates = get(baseUrl + "updates/goods/since/" + date, authHeader.plus("AppUID" to user.AppUID)) it("should contain goods deletes") { goodsUpdates.statusCode.should.be.equal(OK) goodsUpdates.jsonObject.getJSONArray("removed").toList() .map { it as Int } .find { it == goodId.toInt() } .should.be.not.`null` } } on("get changed since when goods added without authorization") { val response = post(baseUrl + "goods/${user.storeId}", json = dataToMap(goods)) it("should contain an Unauthorized response status and an empty body") { response.statusCode.should.be.equal(UNAUTHORIZED) response.text.should.be.equal("") } } on("adding goods") { val respAdd = post(urlGoodsUpdate, authHeaderWithAppUID, json = getBody(added = arrayAdded(count))) val resultOfAdding = getResult(respAdd) it("should return the status code OK") { respAdd.statusCode.should.be.equal(OK) } it("should be equal to the size of the variable count") { resultOfAdding.should.be.size.equal(count) } post(urlGoodsUpdate, authHeaderWithAppUID, json = getBody(removed = getGoodsIds(resultOfAdding))) } on("updating goods") { val respAdd = post(urlGoodsUpdate, authHeaderWithAppUID, json = getBody(added = arrayAdded(count))) val resultOfAdding = getResult(respAdd) it("should return the status code respAdd OK") { respAdd.statusCode.should.be.equal(OK) } it("should be equal to the size of the variable count (resultOfAdding)") { resultOfAdding.should.be.size.equal(count) } val respUpdate = post(urlGoodsUpdate, authHeaderWithAppUID, json = getBody(updated = resultOfAdding.map { it.copy(countryId = REGION_77) }) ) it("should return the status code respUpdate OK") { respUpdate.statusCode.should.be.equal(OK) } it("should be equal to the size of the variable count (respUpdate)") { getResult(respUpdate).should.be.size.equal(count) } it("should be all elements are 77") { getCountryIdFromTheResult(respUpdate).should.be.all.elements(REGION_77) } post(urlGoodsUpdate, authHeaderWithAppUID, json = getBody(removed = getGoodsIds(resultOfAdding))) } on("deleting goods") { val respAdd = post(urlGoodsUpdate, authHeaderWithAppUID, json = getBody(added = arrayAdded(count))) val resultOfAdding = getResult(respAdd) it("should return the status code respAdd OK") { respAdd.statusCode.should.be.equal(OK) } it("should be equal to the size of the variable count") { resultOfAdding.should.be.size.equal(count) } val respRemoved = post(urlGoodsUpdate, authHeaderWithAppUID, json = getBody(removed = getGoodsIds(resultOfAdding)) ) it("should return the status code respRemoved OK") { respRemoved.statusCode.should.be.equal(OK) } it("should be empty") { getResult(respRemoved).should.be.empty } } } })

परिणाम

कोड ही, भाषा कौशल और ढांचे का ज्ञान एकदम सही है, लेकिन शुरुआत आमतौर पर खराब नहीं होती है।

जब मैं कोटलिन से मिला, तो मुझे लग रहा था कि वह जावा में सिंटैक्टिक चीनी है। और आत्मा के सभी तंतुओं के साथ कोड लिखते समय, मैं शब्दों को महसूस करने में कामयाब रहा: "जावा के साथ पूरी तरह से संगत"।

स्पेक, जो विनिर्देशों का वर्णन करने के लिए सरल भाषा निर्माण का उपयोग करता है, परीक्षण विधियों का एक पूरा पूल प्रदान करता है। यानी टेस्ट फ्रेमवर्क से वे उससे जो चाहते हैं, देते हैं।

कुल - मास्टर में सभी परीक्षण। सब कुछ काम कर गया, और सेवा विभाग अब यह सुनिश्चित करने के लिए जानता है कि यह मुश्किल समय में के से सहयोगियों का समर्थन करने में सक्षम होगा।

K प्रोजेक्ट का टेस्ट इतिहास: कोटलिन और स्पेक

यह क्या है और इसकी आवश्यकता क्यों है?

परीक्षकों

शुरुआत हो रही है

परीक्षण

आपने क्या पढ़ा?

आपने क्या लिखा?

समीक्षा

परिणाम

More articles: