.Net और git-हुक के साथ Sql कोड को मान्य करें

हेलो हब्र!

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

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

गिट हुक

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

• उस शाखा का नाम जिसे अद्यतन किया जा रहा है
• शाखा को अपडेट करने से पहले प्रतिबद्ध करने के लिए लिंक
• शाखा को अद्यतन करने के बाद प्रतिबद्ध करने के लिए लिंक

ऐसे मापदंडों का एक सेट होने से, शुरुआत के लिए, आप उन फ़ाइलों की सूची प्राप्त कर सकते हैं जिन्हें हमारे स्क्रिप्ट के दूसरे और तीसरे मापदंडों का उपयोग करके बदला गया है:

git diff --name-only --diff-filter=[AMCR] $2 $3 

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

 #!/bin/sh ex=0 okResult="OK" originalPath='/git/test.git/' #   git printf "---- 'Sql checker' hook ----" listOfFiles=$(git diff --name-only --diff-filter=[AMCR] $2 $3) #   for changedFile in $listOfFiles do printf "checking:$changedFile" fullFilePath="$3:$changedFile" git-show $fullFilePath >tmp_sql result=$($originalPath/hooks/check-sql tmp_sql) #  if [ "$result" != $okResult ] then res=${result//|/\\n } printf " $res\n" #  ex=1 else printf "ok!\n" fi done printf "---- Done ----" exit $ex 

चेक-एसक्यूएल स्क्रिप्ट बाहरी संसाधन के लिए अनुरोध करता है ताकि एसक्यूएल कोड के साथ फ़ाइल की जांच की जा सके, और साबुन के रूप में प्राप्त परिणाम को भी पार्स करता है:

 #!/bin/sh soap-template $1 tmp_soap wget -qO- --post-file=tmp_soap --header="Content-type: text/xml; charset=utf-8" 127.0.0.1/check-sql.asmx | gawk -v re="<CheckFileResult.*>(.*)/CheckFileResult>" '{match($0,re,RMATCH); print RMATCH[1]}' 

और साबुन-टेम्पलेट स्क्रिप्ट के बाद, जो एसक्यूएल-कोड एक साबुन अनुरोध बनाता है:

 #!/bin/sh encodedFile=$(base64 $1) echo '<?xml version="1.0" encoding="utf-8"?>' >$2 echo '<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSc ma" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">' >> $2 echo ' <soap:Body>' >>$2 echo ' <CheckFile xmlns="http://tempuri.org/">' >>$2 echo " <base64>$encodedFile</base64>" >>$2 echo ' </CheckFile>' >>$2 echo ' </soap:Body>' >>$2 echo '</soap:Envelope>' >>$2 

इसलिए, मैं bash स्क्रिप्ट में इतना मजबूत नहीं हूं कि उन पर एक sql कोड चेक करूं; इसलिए, मैंने अपने पसंदीदा .Net वातावरण में डालने का फैसला किया।

.Net हिस्सा

Git-hook और .Net के बीच संचार पुल के साथ, मैंने .net वेब सेवा को चुना, इसलिए यह हमारी git-हुक स्क्रिप्ट में "चेक-एसक्यूएल" स्क्रिप्ट है जो इस सेवा के लिए एक अनुरोध के साथ एक पैरामीटर है जिसमें sql फ़ाइल की सामग्री शामिल है।

 [WebMethod] public string CheckFile(string base64) { var errors = new List<SqlCheckError>(); string result = OkResult; try { //  sql- string sqlScript = Encoding.Default.GetString(Convert.FromBase64String(base64)); //    ISqlCheck var containerProvider = new SqlCheckUnityProvider(); //    var checker = new SqlCheckProcess(containerProvider); errors.AddRange(checker.CheckSql(sqlScript)); } catch (Exception e) { Log(e); // return OkResult; //      ,       . } //  ( )     git-hook if (errors.Count > 0) { result = string.Join("|", errors.Select(error => string.Format("{1}: {0}", error.Message, error.Type))); } return result; } 

पहले से ही .net पर्यावरण होने और हमें सत्यापन के लिए sql-code प्रदान करने के बाद, आप बहुत सी चीजों के साथ आ सकते हैं। मैंने इस तरह के सत्यापन के लिए एक छोटा ढांचा बनाया है, लेकिन मुझे लगता है कि इसके सभी कोड को यहां सूचीबद्ध करना बहुत उचित नहीं है। निकट भविष्य में मैं इसे गीथूब पर पोस्ट करूंगा। संक्षेप में, सब कुछ इस तरह के एक सरल इंटरफ़ेस पर आधारित है:

 public interface ISqlCheck { bool CheckSql(string sqlCode); SqlCheckError GetError(string sqlCode); } 

यह इंटरफ़ेस एक सत्यापन नियम है। एकता कंटेनर के साथ संयोजन में इस इंटरफ़ेस के बहुत सारे कार्यान्वयन होने के बाद , हम सामान्य रूप से सत्यापन के लिए लागू नियमों के सेट को नियंत्रित कर सकते हैं। साथ ही, एक sql parser ( TSql100Parser ) को .net में बनाया गया है, आप लगभग किसी भी नियम के सत्यापन को लागू कर सकते हैं।

अभ्यास

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

 $ git push origin master Counting objects: 7, done. Delta compression using up to 8 threads. Compressing objects: 100% (3/3), done. Writing objects: 100% (4/4), 347 bytes, done. Total 4 (delta 2), reused 0 (delta 0) remote: remote: ---- 'Sql checker' hook ---- remote: remote: checking: test/create_sp.sql remote: Error: Missed 'GO' statement after stored procedure. remote: remote: ---- Done ---- remote: remote: error: hook declined to update refs/heads/master To ssh://user@git.local/git/test.git ! [remote rejected] master -> master (hook declined) error: failed to push some refs to 'ssh://user@git.local/git/test.git' 

जैसा कि आप penultimate लाइन से देख सकते हैं, इस प्रणाली को उत्परिवर्तित sql स्क्रिप्ट में त्रुटियों के कारण अस्वीकार कर दिया गया था।

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