👩🏼‍🤝‍👨🏻 🔲 🙍🏼 HowTo: टीमकोटी के साथ एक Django परियोजना का निरंतर एकीकरण 🚂 🧝 🕧

परिचय

विकास की प्रक्रिया के दौरान, नई कार्यक्षमता का निर्माण, अधिक से अधिक बार व्यापक स्ट्रोक के साथ अपने काम के तर्क को बर्बाद करने की तुलना में पुराने कोड को छूने लगा। इसने मुझे पुराने कोड के लिए यूनिट और एकीकरण परीक्षण लिखने और उनके लॉन्च को स्वचालित करने के लिए मजबूर किया, क्योंकि मेरे हाथों से सभी परीक्षणों का पीछा करना किसी तरह दुखी है। हाल ही में जेनकिन्स में हाल ही में CI Django ट्यूटोरियल और Django में बहुत पुराने वेबटेस्ट ट्यूटोरियल को याद किया । नतीजतन, जेनकिंस को उठाने का प्रयास किया गया था, लेकिन किसी तरह उन्होंने मेरी ubunt पर नहीं लिया और मैंने टीमकिट को एक पापी प्रसंग के रूप में याद किया। "जब से मैं PyCharm में लिख रहा हूं और मुझे इसका एक तरीका मिल गया है, मैं शायद TeamCity की कमान संभाल लूंगा, क्योंकि वहाँ केवल एक डेस्क है!" - मुझे लगा ... सामान्य तौर पर, मैं सही था, और जब कर्म मुझे अनुमति देता है, तो मैंने आपको एक अति-उपयोगी देने का फैसला किया। (और मेगा-विस्तृत), मेरे पिछले मैनुअल के विपरीत :)

कुल: जिसे टीमसिटी एकीकरण सर्वर को बढ़ाने के लिए मार्गदर्शन की आवश्यकता है, और अपने स्वचालित (पर्यावरण) अपडेट के साथ आभासी अजगर वातावरण में नाक और वेबटेस्ट परीक्षणों के साथ Django परियोजनाओं का परीक्षण करना - बिल्ली का स्वागत है।

चेतावनी! TeamCity को (प्रलेखन के अनुसार) JVM के सूर्य / ओरेकल संस्करण की आवश्यकता है ...

सिद्धांत

Virtualenv का उपयोग करते हुए पायथन आभासी वातावरण

मेरे विकास पीसी पर सिस्टम मेरी परियोजना की सभी आवश्यकताओं को पूरा करता है, लेकिन यह परीक्षण के लिए सर्वर पर मामला होने से बहुत दूर है (यहां तक कि अजगर 2.6 है, और मुझे अंततः 2.7 की आवश्यकता है), इसलिए मुझे पर्यावरण वर्चुअलाइजेशन की देखभाल करने के लिए शांति से स्थापित करने की आवश्यकता थी जो मुझे चाहिए, इसके अलावा, यह root प्राधिकरण या sudo एर होने की आवश्यकता को समाप्त करता है।

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

 python virtualenv.py -p python2.7 .env

यहाँ -p python2.7 अजगर के आवश्यक संस्करण को सेट करता है (सूक्ष्मता यह है कि अजगर के आवश्यक संस्करणों को सिस्टम में ही स्थापित किया जाना चाहिए, लेकिन "डिफ़ॉल्ट अजगर नहीं है," स्क्रिप्ट उन्हें खींचने और उन्हें स्थापित करने में सक्षम नहीं होगी) .env निर्देशिका जिसमें पर्यावरण रखा जाएगा। इसके अलावा, पर्यावरण से अजगर और मॉड्यूल का उपयोग करने के लिए, आपको उन्हें .env/bin/python माध्यम से कॉल करने की आवश्यकता है .env/bin/python यदि आप इसे बहुत आलसी लिखते हैं, तो आप निष्पादित कर सकते हैं।

 source .env/bin/activate

जो पाथ पर्यावरण चर की जगह लेता है।

कपड़े के माध्यम से स्वचालन

लक्ष्य प्रणाली पर स्थापित अजगर के अलावा, हमें कपड़े मॉड्यूल की भी आवश्यकता है। यही है, परीक्षण सर्वर पर, आपको sudo pip install fabric या sudo easy_install fabric pycrypto होगा, इंस्टॉलेशन के दौरान यह pycrypto जिसे python-dev से विधानसभा के लिए सॉर्ट की जरूरत है, इसलिए आपको इसे पहले इंस्टॉल करना होगा। फैब्रिक आपको एक स्थानीय या रिमोट (SSH के माध्यम से) सिस्टम पर क्रिया करने वाले अजगर में स्क्रिप्ट निष्पादित करने की अनुमति देता है। इंस्टॉलेशन के बाद, सिस्टम पर fab एप्लिकेशन दिखाई देगा, जो कॉल फ़ोल्डर में fabfile.py फ़ाइल की fabfile.py करेगा और निर्दिष्ट स्क्रिप्ट को निष्पादित करेगा।

उदाहरण के लिए:

 fab test

निष्पादित करेगा fabfile.py फ़ाइल से test फ़ंक्शन निष्पादित करेगा।

Django में नाक और वेबटेस्ट

अब परीक्षणों के बारे में थोड़ा। Django के अपने यूनिट परीक्षण और कार्यात्मक परीक्षण (टेस्ट क्लाइंट का उपयोग करके) हैं, लेकिन उनमें कमियां हैं जो एक से अधिक बार लिखी गई हैं। सामान्य तौर पर, मैंने कार्यात्मक के लिए यूनिट परीक्षण और वेबटेस्ट के लिए नाक का उपयोग करना शुरू कर दिया। परिचय में, मैंने वेबटेस्ट के बारे में एक लेख का लिंक दिया, यह अच्छी तरह से दिखाता है कि यह कैसे काम करता है। हमें परीक्षण के लिए निम्नलिखित मॉड्यूल की आवश्यकता होगी (तब हम इस सूची को फ़ाइल के साथ जोड़ देंगे जिसमें pip -r माध्यम से स्वचालित स्थापना के लिए मॉड्यूल की सूची है):

 coverage>=3.0 nose webtest django-nose django-webtest

इसके अलावा, django_nose को आपके django प्रोजेक्ट की INSTALLED_APPS settings.py , या उसी फ़ाइल में TEST_RUNNER = 'django_nose.NoseTestSuiteRunner' , TEST_RUNNER = 'django_nose.NoseTestSuiteRunner' निर्दिष्ट करें।

चेतावनी! यदि south उपयोग किया जाता है, तो django_nose बाद django_nose को django_nose होगा।

वास्तव में, अगर वहाँ पहले से ही Dzhangovsky परीक्षण प्रणाली में लिखा इकाई परीक्षण हैं - आप उन्हें छू नहीं सकते हैं, सब कुछ उसी तरह काम करेगा। कैसे वेबटेस्ट के माध्यम से कार्यात्मक परीक्षण लिखने के लिए उपरोक्त लेख में पाया जा सकता है।

परीक्षण हमेशा की तरह शुरू होता है:

 python manage.py test

यह कमांड नाक परीक्षण और वेबटेस्ट परीक्षण दोनों करेगा, यदि परीक्षणों के साथ फाइलों, कक्षाओं और कार्यों के नाम में "test" शब्द है - यह nose से एक बोनस है। इसके अलावा, nose परीक्षणों के लिए कोड कवरेज की गणना के लिए कवरेज का उपयोग कर सकता है (वह कार्यात्मक webtest परीक्षणों को नहीं समझता है, क्योंकि परीक्षण सीधे कोड के साथ काम करते हैं, लेकिन उत्पन्न पृष्ठों के माध्यम से नहीं)। Django-nose हमें नाक परीक्षण चलाने के लिए विकल्पों का उपयोग करने की अनुमति देता है। ऐसा करने के लिए, उन्हें प्रोजेक्ट की settings.py फ़ाइल में लिखा जा सकता है। उदाहरण के लिए:

 NOSE_ARGS = [ '--nocapture', '--with-coverage', '--cover-html', '--cover-html-dir=%s' % os.path.join(PROJECT_PATH, 'cover', 'unit'), '--cover-package=django_dir' ]

यह वर्तनी आपको HTML प्रारूप में एक परीक्षण कवरेज रिपोर्ट उत्पन्न करने और अपनी परियोजना के cover/unit उपनिर्देशिका में रखने की अनुमति देगा।

अभ्यास

परियोजना की संरचना

मेरी परियोजना में निम्नलिखित फ़ोल्डर संरचना है:

 . .. project_dir project_dir/django_dir project_dir/build project_dir/build/pipreq.txt project_dir/fabfile.py project_dir/virtualenv.py

जहां project_dir में सभी प्रकार की उपयोगी चीजें शामिल हैं जैसे कि वर्चुअल वातावरण के साथ निर्देशिका, फ़ैक्टरी फ़ाइल और अन्य उपयोगी चीज़ें, और पहले से ही django_dir उपनिर्देशिका में प्रोजेक्ट स्वयं django पर स्थित है। सब कुछ कुछ अपवादों के साथ project_dir से शुरू होता है, जैसे वर्चुअल वातावरण वाली निर्देशिका, संस्करण नियंत्रण प्रणाली में (मेरे मामले में यह GIT है )।

परीक्षण निष्पादन

दरअसल, हमारा लक्ष्य रिपॉजिटरी में बदलावों का पता लगाने के बाद टीमसीटी को सिखाना है (कि वह जानता है कि) हमारे अद्यतन किए गए डेजैंगो प्रोजेक्ट का परीक्षण करें (जिसे वह नहीं जानता कि कैसे) और हमें परिणामों के बारे में बताएं (यहां उन्हें थोड़ी मदद करने की भी जरूरत है)।

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

कोड project_dir/fabfile.py :

 # -*- coding: utf-8 -*- from fabric.api import local def test(): """  . """ local('python virtualenv.py -p python2.7 .env') #    local('./.env/bin/pip install -q -E .env -r build/pipreq.txt') #    #   build/pipreq.txt local('./.env/bin/python django_dir/manage.py test --noinput') #

कृपया ध्यान दें कि virtualenv.py परियोजना की जड़ में है, ताकि इसे सिस्टम पर स्थापित करने की आवश्यकता न हो।

project_dir/build/pipreq.txt की आवश्यक सामग्री:

 django coverage>=3.0 nose teamcity-nose webtest django-nose django-webtest ...      /...

कृपया ध्यान दें कि पहले से सूचीबद्ध टीमसिटी-नाक को फ़ाइल में सूचीबद्ध किया गया है, यह मॉड्यूल हमारे परीक्षण के परिणामों को टीमसिटी तक पहुंचाने में मदद करता है। इसे किसी भी कॉन्फ़िगरेशन और कनेक्शन की आवश्यकता नहीं है - यह स्वचालित रूप से तब शुरू होता है, जब यह TEAMCITY_PROJECT_NAME दौरान TEAMCITY_PROJECT_NAME पर्यावरण TEAMCITY_PROJECT_NAME पाता है।

दरअसल, ऑटोमैटिक टेस्टिंग के लिए सब कुछ तैयार है। इसे शुरू करने के लिए, बस कमांड चलाएँ:

 fab test

परियोजना की जड़ में।

टीमसिटी को स्थापित और कॉन्फ़िगर करें

मैंने बहुत परेशान नहीं किया, जो मैं आपको सलाह देता हूं - मैंने बस डाउनलोड पृष्ठ से tar.gz विकल्प डाउनलोड किया । इस सभी खुशी का वजन अशोभनीय 333MB है। लेकिन स्वयं एकीकरण सर्वर के अलावा, इसमें टॉमकैट भी शामिल है, जो हमें सर्वर सेटिंग्स और अन्य बकवास के साथ बवासीर से बचाएगा।

टीमसिटी के पास एक संपत्ति है (शुरुआत में उल्लिखित) जो किसी को पसंद नहीं हो सकती है - इसे काम करने के लिए जेवीएम की एक गरिमा / ओरेकल संस्करण की आवश्यकता होती है।

इसे उबंटू पर कैसे प्राप्त किया जा सकता है यहां उदाहरण के लिए पढ़ा जा सकता है ।

वास्तव में, डाउनलोड करने के बाद, हम इस सामान को अनपैक करते हैं, जहां यह काम करेगा (डिफ़ॉल्ट रूप से, डेटा स्वयं को .BuildServer होम डायरेक्टरी के .BuildServer उपनिर्देशिका में संग्रहीत किया जाएगा जिसके तहत सर्वर चल रहा है)। सर्वर कमांड bin/runAll.dh start , bin/runAll.dh stop तदनुसार मारा जाता है (यदि हम फ़ोल्डर में bin/runAll.dh stop संग्रह के साथ हैं)। डिफ़ॉल्ट रूप से सर्वर पोर्ट 8111 पर चलता है, लेकिन एक build agent भी है जो पोर्ट 9090 पर शुरू होता है। पहले को conf/server.xml , दूसरे में buildAgent/conf/buildAgent.dist.properties (नमूना) और buildAgent/conf/buildAgent.properties (विशिष्ट एजेंट) में बदला जा सकता है।

अन्य सभी सेटिंग्स (जिसके बारे में मैं बात करूंगा) वेब इंटरफेस के माध्यम से किया जाएगा। सामान्य तौर पर, हम टीमसिटी शुरू करते हैं और ब्राउज़र पर जाते हैं (http: // localhost: 8111 अगर इसे स्थानीय रूप से लॉन्च किया गया था)। सिस्टम की क्षमता के आधार पर, आप या तो लाइसेंस समझौता देखेंगे या संदेश:

और आपको तब तक इंतजार करना होगा जब तक कि इसे लाइसेंस एग्रीमेंट से बदल न दिया जाए।

इसके बाद, आपको एक व्यवस्थापक खाता बनाने के लिए प्रेरित किया जाएगा। जिसके बाद हम खुद TeamCity सिस्टम देखेंगे।

यहां हम एक परियोजना बनाने में रुचि रखते हैं। वहाँ सब कुछ सरल है - नाम और विवरण। प्रोजेक्ट सेटिंग्स पेज पर जाने के बाद।

VCS रूट्स टैब (VCS - संस्करण नियंत्रण प्रणाली) पर, आपको एक नया रिपॉजिटरी निर्दिष्ट करने की आवश्यकता है। अधिक सटीक रूप से संकेत मिलता है कि सिस्टम परीक्षण के लिए कोड कहां ले जाएगा। एक लंबा फुटक्लॉथ है जिसे आपके डेटा से भरा जाना चाहिए। सभी क्षेत्रों पर हस्ताक्षर किए गए हैं, पृष्ठों की मदद के लिए लिंक हैं, इसलिए वहां कुछ भी अलौकिक नहीं है। आप तुरंत कनेक्शन के स्वास्थ्य की जांच कर सकते हैं।

अगला, सामान्य टैब पर, आपको एक नया Buid कॉन्फ़िगरेशन बनाने की आवश्यकता है - हमारे परीक्षण की आधारशिला।

बिल्ड काउंटर - वह संख्या जहां से बिल्ड की संख्या शुरू होगी, या बल्कि, बिल्ड की संख्या जिसे अगले बिल्ड को सौंपा जाएगा। आप सुरक्षित रूप से 1 डाल सकते हैं, यहाँ सिर्फ एक स्क्रीनशॉट ताज़ा नहीं है :)

पहले पृष्ठ पर महत्वपूर्ण क्षेत्रों में, आर्टिफ़ैक्ट पथ हैं जो सिस्टम को बताते हैं कि असेंबली / परीक्षण से उत्पन्न फ़ाइलों को कैसे खोजना है। हमारे मामले में, ये परीक्षण कवरेज पर रिपोर्ट हैं। मेरे मामले में, बस यहाँ django_dir/cover/**/* । दूसरे पृष्ठ पर, हमारे पहले से परिभाषित भंडार का चयन करें।

ऐड बिल्ड स्टेप पर क्लिक करके , आपको पहला (और, हमारे मामले में, एकमात्र) बिल्ड स्टेप (हमारे मामले में, परीक्षण) बनाना होगा।

वास्तव में सेटिंग्स का आवश्यक सेट जो आप स्क्रीन पर देखते हैं। सहेजें।

इसके बाद, ऊर्ध्वाधर मेनू में दाईं ओर, बिल्ड ट्रिगर चुनें और रिपॉजिटरी में परिवर्तन होने पर हमारी असेंबली के लॉन्च को जोड़ें:

ठीक है, अंत में, परियोजना की सेटिंग में वापस, रिपोर्ट टैब टैब पर जाएं और एक नया टैब बनाएं:

यह TemCity को इसके इंटरफ़ेस में हमारी रिपोर्ट प्रदर्शित करने की अनुमति देगा।

निर्दिष्ट स्थान में निर्दिष्ट फ़ाइल होने पर टैब दिखाई देगा, इसलिए यदि यह वहां नहीं है, तो सेटिंग्स की जांच करें और देखें कि क्या रिपोर्ट वास्तव में हैं जहां उन्हें होना चाहिए।

यह सब, यह हमारी परियोजना पर जाने के लिए परियोजनाओं में शीर्ष मेनू में रहता है और पहले रन के लिए बिल्ड पर रन पर क्लिक करें।

अच्छा

सभी प्रबंधक ग्राफिक्स पसंद करते हैं, क्योंकि कुछ दिखाने के लिए आपके पास कुछ चित्र बनाने की आवश्यकता होती है। काश, इन चित्रों को सही मायने में प्रोग्रामर-एडमिन विधि द्वारा जोड़ा जाता है - XML कॉन्फ़िगरेशन में परिवर्तन करके। मैनुअल यहाँ पाया जा सकता है । एक को लगता है कि इस जगह पर डेवलपर्स ने बहुत आराम किया (वे शतरंज के रूप बना सकते थे) । क्योंकि मुझे buildTypeId के सबसे महत्वपूर्ण मापदंडों में से एक का पता लगाने का एक स्पष्ट तरीका नहीं मिला। सबसे आसान तरीका ब्राउज़र के एड्रेस बार में देखना है: localhost:8111/viewType.html?tab=buildTypeStatusDiv& buildTypeId=bt2 localhost:8111/viewType.html?tab=buildTypeStatusDiv& buildTypeId=bt2 ।

मैं अपने दो ग्राफ़ों का एक विन्यास दूंगा:

 <?xml version="1.0" encoding="UTF-8"?> <settings> <report-tabs> <report-tab title="Coverage" basePath="/unit/" buildTypeId="bt2"> <revisionRule name="lastFinished" revision="latest.lastFinished" /> </report-tab> </report-tabs> <custom-graphs> <graph title="Build Duration" defaultFilters="showFailed" seriesTitle="key"> <!--     --> <valueType key="BuildDuration" title="main test" buildTypeId="bt2"/> </graph> <graph title="Test Passes" defaultFilters="showFailed" seriesTitle="key"> <!--   --> <valueType key="FailedTestCount" title="fail" buildTypeId="bt2"/> <valueType key="PassedTestCount" title="pass" buildTypeId="bt2"/> </graph> </custom-graphs> </settings>

यह फ़ाइल है ~/.BuildServer/config/django_dir/plugin-settings.xml । फ़ाइल में परिवर्तन मक्खी पर उठाया जाता है।

यह कुछ इस तरह दिखता है:

और यहाँ कवरेज रिपोर्ट है:

विधानसभा सूची:

विधानसभा विवरण:

निष्कर्ष

मैं "बहु-पुस्तक" के लिए माफी माँगता हूँ, लेकिन ऐसा ही हुआ। मैं इसे उपलब्ध वर्णन करना चाहता था। नतीजतन, हमारे पास स्वचालित परीक्षण (मॉड्यूलर और एकीकरण) है, इसके अलावा, आवश्यक मॉड्यूल की उपस्थिति और परियोजना की "उठाने की क्षमता" की भी जांच की जाती है। TemaCity की विभिन्न विधानसभा परिणामों की प्रतिक्रिया से असंतुष्ट होकर मैं आपके विवेक पर छोड़ता हूं। इस भाग में, आनन्दित होने के लिए कुछ है - दोनों मानक साबुन अधिसूचना, और जैबर के माध्यम से अधिसूचना, और एक रिलीज पुश का निर्माण।

अच्छा विकास किया है!

HowTo: टीमकोटी के साथ एक Django परियोजना का निरंतर एकीकरण