Git। पायथन का उपयोग करके स्वचालित रूप से सर्वर साइड मेसेज की जांच करना

लक्ष्य श्रोता, प्रेरणा

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

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

Git Interceptors

Git सिस्टम हुक का एक समृद्ध सेट प्रदान करता है, जिससे आप सही समय पर, सर्वर साइड पर और क्लाइंट साइड दोनों पर उपयोगकर्ता स्क्रिप्ट चला सकते हैं। यदि हम उस क्षण के बारे में बात करते हैं जो सर्वर पर push कमांड निष्पादित होता है, तो रिपॉजिटरी डायरेक्टरी के hooks उपनिर्देशिका में update फाइल इसके लिए जिम्मेदार है। यह फ़ाइल सिस्टम द्वारा सर्वर पर धकेल दी गई प्रत्येक शाखा के लिए लॉन्च की गई है।

update इंटरसेप्टर इनपुट के रूप में पैरामीटर लेता है:

• उस शाखा से लिंक करें जिस पर push होता है।
• push शाखा में अंतिम प्रतिबद्ध के लिए लिंक;
• शाखा को भेजे गए अंतिम वचन के लिए लिंक।

आउटपुट पर, इंटरसेप्टर को एक पूर्ण कोड वापस करना चाहिए: 0 - push सक्षम करें, 1 - अक्षम push । इस स्थिति में, मानक आउटपुट स्ट्रीम के लिए सभी स्क्रिप्ट आउटपुट क्लाइंट को दिया जाता है।

समस्या का बयान

संदेश प्रारूप के लिए आवश्यकताएँ वेब पर उचित राय और कंपनी द्वारा अपनाई गई विकास प्रक्रिया के आधार पर बनाई जाती हैं।

वे निम्नलिखित टेम्पलेट द्वारा वर्णित हैं:

 projectName-taskId action annotation detailsString1 detailsString2 ... detailsStringN 

स्पष्टीकरण:

• projectName-taskId - जीरा में जारी करने के लिए लिंक;
• action - वैध विकल्पों की सूची से शब्दों का उपयोग करते हुए वचन का सार का एक छोटा पदनाम: सुविधा, फिक्स, स्टाइल, रिफ्लेक्टर, आदि। यदि प्रतिबद्ध के लिए दो या अधिक विकल्प उपयुक्त हैं, तो शब्दों को एक स्लैश द्वारा अलग किया जाता है (उदाहरण के लिए, फिक्स / रिफ्लेक्टर);
• annotation - प्रतिबद्ध के लिए परिवर्तनों का एक संक्षिप्त विवरण;
• पहली पंक्ति की अधिकतम लंबाई 100 वर्ण है;
• details - वैकल्पिक अनुभाग। यह प्रतिबद्धताओं में बदलाव का एक विस्तृत वर्णन है (अधिकतम लाइन की लंबाई 80 वर्ण है)। संदेश के इस खंड को ब्लॉकों में विभाजित किया जा सकता है, जिसके बीच एक खाली लाइन रखी गई है;
• annotation और details बीच एक खाली रेखा होनी चाहिए।

प्रारूप आवश्यकताओं के आधार पर, एक सरल एल्गोरिथ्म उभरता है:

• उन सभी कमिट्स की एक सूची प्राप्त करना जो push कमांड द्वारा भेजे गए थे (यह git rev-list कमांड का उपयोग करके किया जा सकता है);
• प्रत्येक वचन के लिए, एक संदेश प्राप्त करना ( git cat-file और sed स्ट्रीमिंग टेक्स्ट एडिटर का उपयोग करना) और प्रारूप की जांच करना (नियमित अभिव्यक्ति का उपयोग करना और लाइनों की लंबाई की जांच करना);
• एक पूर्णता कोड वापस करना और, यदि आवश्यक हो, तो एक संदेश जो यह समझाता है कि push क्यों अस्वीकार किया गया था।

पायथन स्टैंडर्ड लाइब्रेरी, कोडिंग

यह खंड मानक भाषा पुस्तकालय और Git कमांड के उपयोग को स्पष्ट करने के लिए केवल संक्षिप्त कोड स्निपेट प्रदान करता है। पाठ के अंत में स्क्रिप्ट के पूर्ण संस्करण का लिंक पाया जा सकता है।

स्क्रिप्ट की मुख्य लाइनें:

 import sys ... if __name__ == "__main__": sys.exit(main()) 

प्रत्येक .py फ़ाइल एक मॉड्यूल है - डेटा, उपयोगकर्ता प्रकार और कार्यों का एक सेट। __name__ की एक अंतर्निहित विशेषता है, कमांड लाइन से स्क्रिप्ट चलाने के मामले में, यह विशेषता विशेष मान __main__ सेट है। मॉड्यूल को किसी अन्य मॉड्यूल द्वारा आयात करने के मामले में, __name__ में आयातित फ़ाइल का नाम होगा। उपरोक्त सशर्त अभिव्यक्ति के लिए धन्यवाद, फ़ाइल को मॉड्यूल के रूप में और स्वतंत्र स्क्रिप्ट के रूप में उपयोग करना संभव है। sys.exit() स्क्रिप्ट sys.exit() कोड लौटाता है, जो बदले में main() फ़ंक्शन द्वारा वापस किया जाता है, जिसमें मुख्य तर्क होता है।

इसके अलावा, कंसोल कमांड को निष्पादित करने के लिए फ़ंक्शन का कार्यान्वयन:

 import subprocess ... def runBash(commandLine): process = subprocess.Popen(commandLine, shell=True, stdout=subprocess.PIPE) out = process.stdout.read().strip() return out 

subprocess.Popen() एक चाइल्ड प्रोसेस बनाता है, प्रोग्राम लॉन्च करता है, जिसके बारे में जानकारी तर्कों में दी जाती है। इस मामले में, मानक कमांड शेल लॉन्च किया गया है (यूनिक्स सिस्टम के लिए डिफ़ॉल्ट रूप से बैश), commandLine स्ट्रिंग इसे commandLine , कमांड का पाठ परिणाम चाइल्ड प्रक्रिया द्वारा खोले गए चैनल को भेजा जाता है, जिसकी सामग्री फ़ंक्शन द्वारा वापस कर दी जाती है। strip() व्हाट्सएप के प्रमुख और अनुगामी के बिना स्ट्रिंग की एक प्रति लौटाता है।

अब, runBash() फ़ंक्शन का उपयोग करते हुए, यह runBash() की सूची प्राप्त करने के लिए पर्याप्त सरल है:

 import sys ... COMMAND_LIST = "git rev-list {}..{}" ... def main(): refOld = sys.argv[2] revNew = sys.argv[3] commits = runBash(COMMAND_LIST.format(refOld, revNew)).split("\n") ... for commit in commits: ... 

sys.argv सरणी में Git को पास की गई कमांड लाइन की दलीलें हैं। इस मामले में शक्तिशाली फ़ंक्शन format() का उपयोग करके, तर्कों को स्ट्रिंग में प्रतिस्थापित किया जाता है।

गिट सेटिंग्स में प्रोजेक्ट नाम को स्टोर करना सुविधाजनक है, क्योंकि कई प्रोजेक्ट (क्रमशः, गिट रिपॉजिटरी) हो सकते हैं, और स्क्रिप्ट कोड में एक स्थिर के रूप में नाम लिखना विफल हो जाएगा। रिपॉजिटरी के लिए प्रोजेक्ट का नाम सेट करने के लिए, बस git config --add project.name HABR

तब प्रोजेक्ट नाम पाने के लिए फ़ंक्शन इस तरह दिखाई देगा:

 COMMAND_PROJECT_NAME = "git config project.name" ... def getProjectName(): return runBash('git config project.name') 

एकल प्रतिबद्ध जाँच के लिए कार्य:

 COMMAND_COMMIT_MESSAGE = "git cat-file commit {} | sed '1,/^$/d'" ... def checkCommit(hash): commitMessage = runBash(COMMAND_COMMIT_MESSAGE.format(hash)) return checkMessage(commitMessage) 

एक नियमित अभिव्यक्ति के साथ एक प्रतिबद्ध संदेश की पहली पंक्ति की जाँच:

 import re ... def checkFirstLine(line): ... expression = r"^({0}\-\d+ )?({1})(\/({1}))* .*".format( getProjectName(), AVAILABLE_ACTIONS ) if not re.match(expression, line): ... 

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

 #!/usr/local/bin/python # -*- coding: utf-8 -*- 

और स्ट्रिंग लंबाई को decode() का उपयोग करके जांचा जाता है:

 if len(line.decode("utf-8")) > LENGTH_MAX: ... 

परीक्षण, सुधार

एक push करने के प्रयासों के दौरान कार्यान्वित इंटरसेप्टर को चलाने के पहले ही दिन, निम्न त्रुटि संदेश प्राप्त हुआ था:

 fatal: Invalid revision range 0000000000000000000000000000000000000000..b12e460740edf4ea41984a676834bee71479aa52 

कमिट सही ढंग से जारी किए गए थे, ख़ासियत यह थी कि एक नई शाखा सर्वर पर धकेल दी गई थी। git rev-list कमांड को इसके लिए डिज़ाइन नहीं किया गया है; मुझे एक विशेष तरीके से स्थिति को संभालना था:

 import sys ... COMMAND_LIST = "git rev-list {}..{}" COMMAND_FOR_EACH = "git for-each-ref --format='%(objectname)' 'refs/heads/*'" COMMAND_LOG = "git log {} --pretty=%H --not {}" ... ref = sys.argv[1] refOld = sys.argv[2] revNew = sys.argv[3] if refOld == REF_EMPTY: headList = runBash(COMMAND_FOR_EACH) heads = headList.replace(ref + "\n", "").replace("\n", " ") commits = runBash(COMMAND_LOG.format(revNew, heads)).split("\n") else: commits = runBash(COMMAND_LIST.format(refOld, revNew)).split("\n") 

हालांकि, यह तब पर्याप्त नहीं था जब एक नई शाखा को बिना हंगामे के धकेल दिया गया था। इस स्थिति में, त्रुटि संदेश इस तरह देखा गया:

 usage: git cat-file (-t|-s|-e|-p|<type>|--textconv) <object> or: git cat-file (--batch|--batch-check) < <list_of_objects> 

इसे ठीक करने के लिए, आपको कमिट्स की अनुपस्थिति में स्क्रिप्ट को एक सफल समापन कोड के साथ पूरा करना होगा:

 for commit in commits: if len(commit) == 0: sys.exit(0) 

निष्कर्ष

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

सॉफ्टवेयर वातावरण जिसमें स्क्रिप्ट चलती है:

• फ्रीबीएसडी 9.1 amd64
• अजगर 2.7.3
• १. G.२

संदर्भ

• जीथब पर पूर्ण स्क्रिप्ट कोड ;
• प्रो गिट बुक, अध्याय 8 ;
• प्रतिबद्ध होने पर एक राय ;
• StackOverflow पर एक खाली शाखा को आगे बढ़ाने के बारे में ;
• पाइथन में नियमित अभिव्यक्तियों को सबसे पहले हैबे पर पढ़ा जा सकता है, फिर आधिकारिक प्रलेखन में ;
• पायथन मानक पुस्तकालय ।

पुनश्च

शुरुआत करने वाले लेखक हमेशा हीराबे पर पहली पोस्ट के तथ्य के बारे में आरक्षण करते हैं और पीएम के पाठ के डिजाइन में खामियों के बारे में संदेश भेजने के लिए कहते हैं। मैंने भी किया। :)

टिप्पणियों में, मुझे कोड पर टिप्पणियां सुनने में खुशी होगी, साथ ही पायथन 3 को स्क्रिप्ट को कैसे पोर्ट करना है, इस बारे में जानकारी (क्या मुझे हटाने के लिए कुछ और की आवश्यकता है # -*- coding: utf-8 -*- और decode() कॉल)?)।