🤞🏿 🌓 🤷🏽 टेलीग्राम के साथ स्वचालित परीक्षण प्रबंधन 🏯 🕵️ 🛎️

क्यूए इंजीनियर के रूप में, मैंने एक आत्म-परीक्षण प्रणाली विकसित की। कई समस्याओं का सामना करना पड़ा:

प्रत्येक प्रकार के परीक्षण के लिए, मुझे CI में अपनी नौकरियां बनानी थीं और उन्हें हाथ से चलाना था।
डेवलपर्स ने स्व-परीक्षण मामलों को चलाने से इनकार कर दिया।
डिवाइस पर कहीं से भी ऑटोटेस्ट चलाने में असमर्थता।
क्यूए मैनुअल टेस्ट इंजीनियर खुद ऑटोटेस्ट नहीं चला सकते थे।

इसलिए, मैंने स्वचालित परीक्षणों को चलाने के लिए बॉट का एक छोटा प्रोटोटाइप बनाने का फैसला किया, जो ऊपर वर्णित अधिकांश समस्याओं को कवर करेगा।

विचार का विवरण:

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

उपकरण:

उपकरण

प्रोग्रामिंग भाषा - पायथन
टेस्ट फ्रेमवर्क - पाइस्टेस्ट
HTTP क्लाइंट - अनुरोध
DataBase - SQLite3
ORM - Peewee
CI सिस्टम - ट्रैविस CI

सामग्री

बॉट पंजीकरण

सबसे पहले, हमें बॉट के टेलीग्राम को पंजीकृत करने और इसकी अनूठी आईडी प्राप्त करने की आवश्यकता है, जो एक टोकन है। ऐसा करने के लिए, संदेश लिखें / @BotFather bot पर प्रारंभ करें।
हमारी मुख्य टीम / न्यूबॉट है, जिसमें प्रवेश करके हमें बॉट के नाम के साथ आने के लिए कहा जाएगा।
लेकिन एक नियम है - नाम बॉट में समाप्त होना चाहिए। बोटफ़ादर बॉट का नाम लेता है और आपका टोकन लौटाता है। चैटिंग शुरू करके बॉट को सक्रिय करें। इसके बाद, आपको गेटअप विधि के लिए एपीआई अनुरोध भेजने की आवश्यकता है।

https://api.telegram.org/bot{_}/getUpdates

प्राप्त hat_id याद रखें।

एक परीक्षण भंडार तैयार करना

अगला, आपको परीक्षणों के साथ एक भंडार को व्यवस्थित करने की आवश्यकता है, या पहले से तैयार लेख का उपयोग करना चाहिए।

टेस्ट और लॉगिंग

परीक्षण कार्य बनाएं और उन्हें पाइस्टेस्ट मार्क के साथ चिह्नित करें - पूर्ण, धूम्रपान और पक्षी।

Pytest.ini फ़ाइल बनाकर और परीक्षण कार्यों में लॉगिंग लाइब्रेरी से जानकारी विधि में कॉल जोड़कर हमारे परीक्षणों में लॉगिंग जोड़ना महत्वपूर्ण है।
Pytest.ini फ़ाइल में लाइव लॉग और लॉग फ़ाइल के लिए टेम्पलेट हैं।

उदाहरण का परीक्षण करें

 import pytest import requests import logging @pytest.mark.full @pytest.mark.smoke def test_cat_facts(): query = {"animal_type": "cat", "amount": "2"} response = requests.get("https://cat-fact.herokuapp.com/facts/random", params=query) logging.info(f"Request url: {response.request.url}, body: {response.request.body}") logging.info(f"Request status: {response.status_code}, body: {response.text}") assert response.status_code == 200 @pytest.mark.full @pytest.mark.smoke def test_dog_facts(): query = {"animal_type": "dog", "amount": "2"} response = requests.get("https://cat-fact.herokuapp.com/facts/random", params=query) logging.info(f"Request url: {response.request.url}, body: {response.request.body}") logging.info(f"Request status: {response.status_code}, body: {response.text}") assert response.status_code == 200 @pytest.mark.full def test_horse_facts(): query = {"animal_type": "horse", "amount": "2"} response = requests.get("https://cat-fact.herokuapp.com/facts/random", params=query) logging.info(f"Request url: {response.request.url}, body: {response.request.body}") logging.info(f"Request status: {response.status_code}, body: {response.text}") assert response.status_code == 200 @pytest.mark.bird def test_bird_facts(): query = {"animal_type": "bird", "amount": "2"} response = requests.get("https://cat-fact.herokuapp.com/facts/random", params=query) logging.info(f"Request url: {response.request.url}, body: {response.request.body}") logging.info(f"Request status: {response.status_code}, body: {response.text}") assert response.status_code == 200

pytest.ini

 [pytest] markers = smoke: for smoking testing full: for regression testing bird: facts only bird log_cli = 1 log_cli_level=INFO log_cli_format = %(asctime)s [%(levelname)8s] %(message)s log_cli_date_format='%Y-%m-%d %H:%M:%S' log_file = test_log.log log_file_level=INFO log_file_format= %(asctime)s [%(levelname)8s] %(message)s log_file_date_format='%Y-%m-%d %H:%M:%S'

रिपोर्ट जनरेशन

हम एक स्क्रिप्ट बनाते हैं, जो असेंबली पूरी होने के बाद, CI सिस्टम से जानकारी एकत्र करता है और उन्हें लॉग के साथ टेलीग्राम चैट में भेज देता है।
स्क्रिप्ट के अंदर, आपको पहले प्राप्त किए गए TELEGRAM_BOT और CHAT_ID मानों को बदलने की आवश्यकता है।

स्क्रिप्ट कोड

 import requests import os TRAVIS_TEST_RESULT = os.environ.get("TRAVIS_TEST_RESULT") TRAVIS_REPO_SLUG = os.environ.get("TRAVIS_REPO_SLUG") TRAVIS_BRANCH = os.environ.get("TRAVIS_BRANCH") TRAVIS_JOB_WEB_URL = os.environ.get("TRAVIS_JOB_WEB_URL") TRAVIS_COMMIT_MESSAGE = os.environ.get("TRAVIS_COMMIT_MESSAGE") TELEGRAM_TOKEN = "808619876:GHrtj9zs-KvKhhtWyu1YoxjtIikUYMGVjD8g" CHAT_ID = "272560060" if TRAVIS_TEST_RESULT != 0: build_status = "" else: build_status = "" TEXT = f" : {build_status} \n : {TRAVIS_REPO_SLUG} \n : {TRAVIS_BRANCH} \n Commit : {TRAVIS_COMMIT_MESSAGE} \n -: {TRAVIS_JOB_WEB_URL}" def send_message(): URL = f"https://api.telegram.org/bot{TELEGRAM_TOKEN}/sendMessage" body = {'chat_id': CHAT_ID, 'text': TEXT} response = requests.post(url=URL, json=body) return response def send_file(): URL = f"https://api.telegram.org/bot{TELEGRAM_TOKEN}/sendDocument" body = {'chat_id': CHAT_ID} file = {"document": open("test_log.log")} response = requests.post(url=URL, data=body, files=file) return response send_message() send_file()

स्क्रिप्ट सिस्टम चर का उपयोग करती है और ट्रैविस सीआई से मान प्राप्त करती है।

यदि TRAVIS_TEST_RESULT का मान शून्य के बराबर नहीं है, तो मान "सफलतापूर्वक" पर सेट है, Send_message फ़ंक्शन को पहले निष्पादित किया जाता है, जो असेंबली की जानकारी चैट (रिपॉजिटरी नाम, चयनित शाखा, उपयोग किए गए कमिट का नाम, वेब लॉग का लिंक) को भेजता है, फिर send_file फ़ंक्शन भेजता है। लॉग फ़ाइल।

परीक्षण रिपॉजिटरी में, कॉन्फ़िगरेशन फ़ाइल - travis.yml जोड़ें। अंदर हम पाइपलाइन का वर्णन करते हैं जिसके माध्यम से विधानसभा काम करेगी।

travis.yml

 language: python python: - "3.7" install: - pip install -r requirements.txt script: pytest -m smoke after_script: - python tg_command.py

इसके बाद, हमें ट्रैविस सीआई में इसे जोड़ने के लिए GitHub पर रिपॉजिटरी को तैनात करने की आवश्यकता है।

TRAVIS_CI की स्थापना

हम साइट पर जाते हैं ।
अपने GitHub खाते का उपयोग करके लॉग इन करें। डैशबोर्ड टैब पर जाएं। पहले से खोले गए DevTools (Network), परीक्षण रिपॉजिटरी के सामने वाली साइट पर Repositories सब-टैब में, स्लाइडर को स्थानांतरित करें - इसकी असेंबली को सक्रिय करें। नेटवर्क टैब (DevTools) में, एक सक्रिय अनुरोध आता है, जिसके पूर्वावलोकन में रिपॉजिटरी की आईडी के बारे में जानकारी होती है, संख्या को याद रखना चाहिए (कॉपी / लिखना)। सेटिंग टैब में साइट पर स्विच करना। हम टोकन को कॉपी या याद करते हैं - हमें इसकी आवश्यकता है।

बॉट सेटअप

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

भंडार के अंदर फाइलें हैं:

main.py - bot script;
मॉडल-एएमडी - ओआरएम के लिए मॉडल के साथ फ़ाइल;
conf.ini - कॉन्फ़िगरेशन चर के साथ फ़ाइल;
runtime.txt - ट्रैविस सीआई के लिए निश्चित पायथन संस्करण मान;
procfile - gunicorn के लिए सेटिंग;
wsgi.py - gunicorn के साथ एप्लिकेशन लॉन्च फ़ाइल।

अपने बॉट को काम करने के लिए, आपको डेटा को conf.ini में बदलना होगा, अर्थात्:

travis_token - ट्रैविस सीआई को प्राप्त टोकन इंगित करें;
travis_base_url - ट्रैविस CI एपीआई का पता निर्दिष्ट करें;
travis_repository_id - ट्रैविस CI के अंदर ऑटोटेस्ट के साथ रिपॉजिटरी की आईडी निर्दिष्ट करें;
telegram_chat_id - टेलीग्राम की चैट आईडी निर्दिष्ट करें जहां बॉट से संदेश भेजे जाएंगे;
telegram_bot_url - bot को url निर्दिष्ट करें।

Conf.ini उदाहरण

 [travis] travis_token = token HkjhkjgGKJhjgFGfdgd travis_base_url = https://api.travis-ci.org travis_repository_id = 10898384 [telegram] telegram_chat_id = 24234234 telegram_bot_url = https://api.telegram.org/bot87543366:AAHtj9zs-Kv4zGWyu1eTXegikUYMGVjD8g/

बॉट के सिद्धांत

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

बॉट में कमांड का एक सेट है:

सीमांकक को छोड़कर कोई भी विशेष वर्ण हो सकता है।

add_m - एक परीक्षण किट (अजगर के निशान) जोड़ें।
साँचा: * कमांड * {किट विवरण} {सीमांकक} {नाम चिह्न}।
उदाहरण: add_m परीक्षण पक्षी / पक्षी।
add_b - परीक्षण के लिए एक शाखा जोड़ें।
साँचा: * कमांड * {शाखा का विवरण} {परिसीमन} {गिट से शाखा का नाम}।
उदाहरण: add_b मास्टर।
चयन करें - आप डिफ़ॉल्ट रूप से परीक्षण के लिए एक शाखा का चयन करने की अनुमति देता है।
साँचा: * कमांड *।
उदाहरण: सेलेक्ट कमांड दर्ज करने के बाद, बटन उन शाखाओं को चुनने के लिए दिखाई देते हैं जो add_b कमांड के साथ डेटाबेस में जोड़े गए थे।
रन - असेंबली शुरू करने का आदेश।
साँचा: * कमांड *।
उदाहरण: रन कमांड में प्रवेश करने के बाद, add_m कमांड के साथ डेटाबेस में जोड़े गए ऑटोटेस्ट के सेट को चुनने के लिए बटन दिखाई देते हैं। स्टार्टअप पर, चयनित कमांड द्वारा निर्दिष्ट शाखा स्वचालित रूप से चुनी जाती है।
del_m - परीक्षणों का एक सेट निकालता है।
साँचा: * कमांड * {नाम निशान}।
उदाहरण: del_m पक्षी।
del_b - डेटाबेस में दर्ज शाखाओं को हटाता है।
साँचा: * कमांड * {git से शाखा}।
उदाहरण: del_b मास्टर।

बॉट कैसे काम करता है?

1. उपयोगकर्ता एक परीक्षण सूट जोड़ता है (add_m):
कमांड उपयोगकर्ता डेटा को 2 भागों में विभाजित करता है - गिट में शाखा का विवरण और नाम। नाम डेटाबेस के अंदर mark_name कॉलम में और mark_description कॉलम में विवरण लिखा जाता है।

2. उपयोगकर्ता शाखाएं जोड़ता है (add_b):
कमांड उपयोगकर्ता डेटा को 2 भागों में विभाजित करता है - गिट में शाखा का विवरण और नाम। नाम को डेटाबेस के अंदर Branch_name कॉलम में लिखा गया है और इसका विवरण Branch_description कॉलम में है।

3. उपयोगकर्ता डिफ़ॉल्ट शाखा का चयन करता है (चुनें):
उपयोगकर्ता चैट में बटन प्राप्त करता है, जो टेबल ब्रांच_डिस्क्रिप्शन और ब्रांच_नाम के डेटा के अनुसार बनता है। उपयोगकर्ता वांछित शाखा के साथ एक बटन का चयन करता है। यह पसंदीदा_ब्रंच तालिका के लिए लिखा गया है।

4. उपयोगकर्ता बिल्ड इनिशियलाइज़ेशन (रन) शुरू करता है:
उपयोगकर्ता चैट में बटन प्राप्त करता है, तालिकाओं से डेटा के अनुसार बनता है
mark_description और mark_name। उपयोगकर्ता ऑटोटेस्ट चलाने के लिए किट के साथ एक बटन का चयन करता है।

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

HEROKU पर तैनाती

बॉट को काम करने के लिए, इसे होस्टिंग पर तैनात करना होगा। मैं हेरोकू का उपयोग करने की सलाह देता हूं, क्योंकि इस प्लेटफॉर्म में एक मुफ्त टैरिफ है, जो बॉट को काम करने के लिए आवश्यक शक्ति प्रदान करता है।

बॉट की तैनाती कैसे करें?

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

यदि आप GUI के माध्यम से हरोकू के साथ काम करना चाहते हैं, तो Github पर कोड भरें। आपको हरोकू वेब इंटरफ़ेस के माध्यम से पंजीकरण करने की आवश्यकता है। पंजीकरण के बाद, नया -> नया एप्लिकेशन बनाएं -> एप्लिकेशन का नाम दर्ज करें और एक क्षेत्र चुनें। परिनियोजन टैब पर जाएँ और परिनियोजन विधि में Github के साथ एकीकरण का चयन करें।

इससे पहले कि हम रिपॉजिटरी की खोज के लिए एक ब्लॉक प्रकट करें। रिपॉजिटरी का नाम दर्ज करें और खोज बटन पर क्लिक करें। खोज परिणामों में, रिपॉजिटरी नाम के विपरीत, कनेक्ट बटन पर क्लिक करें। मैन्युअल नियोजित ब्लॉक में, शाखा का चयन करें और "तैनात करें" पर क्लिक करें।

अंतिम क्षण - आपको एक GET अनुरोध का उपयोग करके webhooks को सक्रिय करने की आवश्यकता है:

 https://api.telegram.org/bot{id_}/setWebhook?url=https://{_}.herokuapp.com/bot

बॉट का इस्तेमाल किया जा सकता है। हम जाँचते हैं कि सब कुछ हमारे लिए काम कर रहा है:

टेलीग्राम के साथ स्वचालित परीक्षण प्रबंधन

बॉट पंजीकरण

एक परीक्षण भंडार तैयार करना

TRAVIS_CI की स्थापना

बॉट सेटअप

HEROKU पर तैनाती

More articles: