C# साठी PVS-Studio वापरून GitLab मध्ये विलीनीकरणाच्या विनंतीचे विश्लेषण

GitLab आवडते आणि बग्सचा तिरस्कार करतात? तुमच्या सोर्स कोडची गुणवत्ता सुधारू इच्छिता? मग तुम्ही योग्य ठिकाणी आला आहात. आज आम्ही तुम्हाला मर्ज विनंत्या तपासण्यासाठी PVS-Studio C# विश्लेषक कसे कॉन्फिगर करायचे ते सांगू. युनिकॉर्न मूड आणि प्रत्येकासाठी आनंदी वाचन करा.

पीव्हीएस-स्टुडिओ C, C++, C# आणि Java मध्ये लिहिलेल्या प्रोग्राम्सच्या स्त्रोत कोडमधील त्रुटी आणि संभाव्य भेद्यता ओळखण्याचे साधन आहे. Windows, Linux आणि macOS वरील 64-बिट सिस्टमवर कार्य करते. 32-बिट, 64-बिट आणि एम्बेडेड एआरएम प्लॅटफॉर्मसाठी डिझाइन केलेल्या कोडचे विश्लेषण करू शकते.

तसे, आम्ही PVS-Studio 7.08 रिलीझ केले, ज्यामध्ये आम्ही बर्‍याच गोष्टी केल्या मनोरंजक. उदाहरणार्थः

• Linux आणि macOS साठी C# विश्लेषक;
• रायडरसाठी प्लगइन;
• नवीन फाइल सूची तपासणी मोड.

फाइल सूची तपासणी मोड

पूर्वी, काही फाइल्स तपासण्यासाठी, विश्लेषकाकडे फाइल्सच्या सूचीसह .xml पास करणे आवश्यक होते. परंतु हे फार सोयीचे नसल्यामुळे, आम्ही .txt हस्तांतरित करण्याची क्षमता जोडली आहे, ज्यामुळे जीवन खूप सोपे होते.

विशिष्ट फायली तपासण्यासाठी, आपण ध्वज निर्दिष्ट करणे आवश्यक आहे --sourceFiles (-f) आणि फाइल्सच्या सूचीसह .txt हस्तांतरित करा. हे असे दिसते:

pvs-studio-dotnet -t path/to/solution.sln -f fileList.txt -o project.json

तुम्हाला कमिट चेकिंग किंवा पुल विनंत्या सेट करण्यात स्वारस्य असल्यास, तुम्ही हे मोड वापरून देखील करू शकता. फरक विश्लेषणासाठी फाइल्सची सूची मिळवण्यात असेल आणि तुम्ही कोणती प्रणाली वापरत आहात यावर अवलंबून असेल.

विलीनीकरण विनंती तपासण्याचे तत्त्व

तपासणीचे मुख्य सार हे सुनिश्चित करणे आहे की विलीनीकरणादरम्यान विश्लेषकाने शोधलेल्या समस्यांमध्ये येत नाहीत. मास्टर शाखा आम्ही प्रत्येक वेळी संपूर्ण प्रकल्पाचे विश्लेषण करू इच्छित नाही. शिवाय, शाखांचे विलीनीकरण करताना, आमच्याकडे बदललेल्या फायलींची यादी असते. म्हणून, मी विलीन विनंती चेक जोडण्याचा सल्ला देतो.

स्थिर विश्लेषक लागू करण्यापूर्वी विलीनीकरण विनंती कशी दिसते:

म्हणजेच शाखेत ज्या त्रुटी होत्या बदल, मुख्य शाखेत जाईल. आम्हाला हे नको असल्याने, आम्ही विश्लेषण जोडतो आणि आता आकृती असे दिसते:

आम्ही विश्लेषण करतो बदल २ आणि, काही त्रुटी नसल्यास, आम्ही विलीनीकरण विनंती स्वीकारतो, अन्यथा आम्ही ती नाकारतो.

तसे, तुम्हाला कमिटचे विश्लेषण करण्यात आणि C/C++ साठी विनंत्या पुल करण्यात स्वारस्य असल्यास, तुम्ही त्याबद्दल वाचू शकता. येथे.

गिटॅब

गिटॅब हे ओपन सोर्स वेब-आधारित DevOps लाइफसायकल टूल आहे जे Git साठी कोड रिपॉझिटरी मॅनेजमेंट सिस्टम त्याच्या स्वतःच्या विकी, इश्यू ट्रॅकिंग सिस्टम, CI/CD पाइपलाइन आणि इतर वैशिष्ट्यांसह प्रदान करते.

तुम्ही विलीनीकरणाच्या विनंत्यांचे विश्लेषण सुरू करण्यापूर्वी, तुम्हाला तुमचा प्रकल्प नोंदणी करणे आणि अपलोड करणे आवश्यक आहे. हे कसे करायचे हे आपल्याला माहित नसल्यास, मी सुचवितो एक लेख माझे सहकारी.

शेरा. खाली वर्णन केलेले वातावरण सेट करण्याची पद्धत संभाव्यांपैकी एक आहे. विश्लेषणासाठी आवश्यक वातावरण सेट करण्यासाठी आणि विश्लेषक लाँच करण्यासाठी पायऱ्या दर्शविणे हे ध्येय आहे. कदाचित तुमच्या बाबतीत पर्यावरणाची तयारी (रेपॉजिटरीज जोडणे, विश्लेषक स्थापित करणे) आणि विश्लेषणाचे टप्पे वेगळे करणे अधिक इष्टतम असेल: उदाहरणार्थ, आवश्यक वातावरणासह डॉकर प्रतिमा तयार करणे आणि त्यांचा वापर करणे किंवा इतर काही पद्धती.

आता काय होईल हे चांगल्या प्रकारे समजून घेण्यासाठी, मी खालील आकृतीकडे पाहण्याचा सल्ला देतो:

विश्लेषकाला ऑपरेट करण्यासाठी .NET Core SDK 3 आवश्यक आहे, म्हणून विश्लेषक स्थापित करण्यापूर्वी तुम्हाला Microsoft रेपॉजिटरीज जोडणे आवश्यक आहे ज्यामधून विश्लेषकासाठी आवश्यक अवलंबित्व स्थापित केले जातील. विविध लिनक्स वितरणांसाठी मायक्रोसॉफ्ट रेपॉजिटरीज जोडणे संबंधित दस्तऐवजात वर्णन केले आहे.

पॅकेज मॅनेजरद्वारे PVS-Studio इंस्टॉल करण्यासाठी, तुम्हाला PVS-Studio रेपॉजिटरीज देखील जोडणे आवश्यक आहे. विविध वितरणासाठी भांडार जोडण्याचे अधिक तपशीलवार वर्णन केले आहे दस्तऐवजीकरणाचा संबंधित विभाग.

विश्लेषकाला ऑपरेट करण्यासाठी परवाना की आवश्यक आहे. येथे तुम्ही चाचणी परवाना मिळवू शकता विश्लेषक डाउनलोड पृष्ठ.

शेरा. कृपया लक्षात घ्या की वर्णन केलेल्या ऑपरेशन मोडसाठी (विलीनीकरण विनंतीचे विश्लेषण) एंटरप्राइझ परवाना आवश्यक आहे. म्हणून, जर तुम्हाला ऑपरेशनचा हा मोड वापरायचा असेल, तर तुम्हाला एंटरप्राइझ परवान्याची आवश्यकता आहे हे "संदेश" फील्डमध्ये सूचित करण्यास विसरू नका.

विलीनीकरणाची विनंती आढळल्यास, आम्हाला फक्त बदललेल्या फाइल्सच्या सूचीचे विश्लेषण करावे लागेल, अन्यथा आम्ही सर्व फाइल्सचे विश्लेषण करू. विश्लेषणानंतर, आम्हाला आवश्यक असलेल्या फॉरमॅटमध्ये लॉग रुपांतरित करावे लागतील.

आता, तुमच्या डोळ्यांसमोर कामाचा अल्गोरिदम असल्याने तुम्ही स्क्रिप्ट लिहिण्यास पुढे जाऊ शकता. हे करण्यासाठी, आपल्याला फाइल बदलण्याची आवश्यकता आहे .gitlab-ci.yml किंवा, ते अस्तित्वात नसल्यास, ते तयार करा. ते तयार करण्यासाठी, तुम्हाला तुमच्या प्रकल्पाच्या नावावर क्लिक करावे लागेल -> CI/CD सेट करा.

आता आम्ही स्क्रिप्ट लिहिण्यास तयार आहोत. चला प्रथम कोड लिहू जो विश्लेषक स्थापित करेल आणि परवाना प्रविष्ट करेल:

before_script:
  - apt-get update && apt-get -y install wget gnupg 

  - apt-get -y install git
  - wget https://packages.microsoft.com/config/debian/10/
packages-microsoft-prod.deb -O packages-microsoft-prod.deb
  - dpkg -i packages-microsoft-prod.deb
  - apt-get update
  - apt-get install apt-transport-https
  - apt-get update
  
  - wget -q -O - https://files.viva64.com/etc/pubkey.txt | apt-key add -
  - wget -O /etc/apt/sources.list.d/viva64.list
https://files.viva64.com/etc/viva64.list
  - apt-get update
  - apt-get -y install pvs-studio-dotnet

  - pvs-studio-analyzer credentials $PVS_NAME $PVS_KEY
  - dotnet restore "$CI_PROJECT_DIR"/Test/Test.sln

इतर सर्व स्क्रिप्ट्सच्या आधी इंस्टॉलेशन आणि सक्रिय करणे आवश्यक असल्याने, आम्ही एक विशेष लेबल वापरतो आधी_स्क्रिप्ट. मी या तुकड्याचे थोडे स्पष्टीकरण देतो.

विश्लेषक स्थापित करण्याची तयारी करत आहे:

  - wget https://packages.microsoft.com/config/debian/10/
packages-microsoft-prod.deb -O packages-microsoft-prod.deb
  - dpkg -i packages-microsoft-prod.deb
  - apt-get update
  - apt-get install apt-transport-https
  - apt-get update

पीव्हीएस-स्टुडिओ रेपॉजिटरीज आणि विश्लेषक जोडणे:

  - wget -q -O - https://files.viva64.com/etc/pubkey.txt | apt-key add -
  - wget -O /etc/apt/sources.list.d/viva64.list
https://files.viva64.com/etc/viva64.list
  - apt-get update
  - apt-get -y install pvs-studio-dotnet

परवाना सक्रिय करणे:

  - pvs-studio-analyzer credentials $PVS_NAME $PVS_KEY

$PVS_NAME - वापरकर्तानाव.

$PVS_KEY - उत्पादन की.

पुनर्प्राप्ती प्रकल्प अवलंबित्व जेथे $CI_PROJECT_DIR - प्रकल्प निर्देशिकेचा पूर्ण मार्ग:

  - dotnet restore "$CI_PROJECT_DIR"/Path/To/Solution.sln

योग्य विश्लेषणासाठी, प्रकल्प यशस्वीरित्या तयार करणे आवश्यक आहे आणि त्याची अवलंबित्व पुनर्संचयित करणे आवश्यक आहे (उदाहरणार्थ, आवश्यक NuGet पॅकेजेस डाउनलोड करणे आवश्यक आहे).

तुम्ही क्लिक करून परवाना माहिती असलेले पर्यावरण चल सेट करू शकता सेटिंग, आणि नंतर - चालू CI/CD.

उघडलेल्या विंडोमध्ये, आयटम शोधा व्हेरिएबल्स, उजवीकडील बटणावर क्लिक करा विस्तृत करा आणि व्हेरिएबल्स जोडा. परिणाम असे दिसले पाहिजे:

आता तुम्ही विश्लेषणाकडे जाऊ शकता. प्रथम, संपूर्ण विश्लेषणासाठी स्क्रिप्ट जोडूया. ध्वजाला -t आम्ही ध्वजाच्या निराकरणाचा मार्ग पास करतो -o फाइलचा मार्ग लिहा ज्यामध्ये विश्लेषण परिणाम लिहिले जातील. आम्हाला रिटर्न कोडमध्ये देखील रस आहे. या प्रकरणात, जेव्हा रिटर्न कोडमध्ये विश्लेषणादरम्यान इशारे जारी करण्यात आल्याची माहिती असते तेव्हा आम्हाला ऑपरेशन थांबविण्यात स्वारस्य आहे. हा तुकडा यासारखा दिसतो:

job:
  script:
  - exit_code=0
  - pvs-studio-dotnet -t "$CI_PROJECT_DIR"/Test/Test.sln -o 
PVS-Studio.json || exit_code=$?
  - exit_code=$((($exit_code & 8)/8))
  - if [[ $exit_code == 1 ]]; then exit 1; else exit 0; fi

रिटर्न कोड बिट मास्कच्या तत्त्वावर कार्य करतात. उदाहरणार्थ, जर विश्लेषणाच्या परिणामी चेतावणी जारी केली गेली, तर रिटर्न कोड 8 च्या बरोबरीचा असेल. जर परवाना एका महिन्याच्या आत कालबाह्य झाला, तर रिटर्न कोड 4 च्या बरोबरीचा असेल. विश्लेषणादरम्यान त्रुटी आढळल्यास, आणि परवाना एका महिन्याच्या आत कालबाह्य होईल, कोड परतावा, दोन्ही मूल्ये लिहिली जातील: संख्या एकत्र जोडा आणि अंतिम रिटर्न कोड मिळवा - 8+4=12. अशा प्रकारे, संबंधित बिट्स तपासून, विश्लेषणादरम्यान विविध राज्यांची माहिती मिळवता येते. दस्तऐवजाच्या "pvs-studio-dotnet (Linux / macOS) रिटर्न कोड" विभागात रिटर्न कोडचे अधिक तपशीलवार वर्णन केले आहे.PVS-Studio वापरून कमांड लाइनवरून व्हिज्युअल स्टुडिओ / एमएसबिल्ड / .नेट कोर प्रोजेक्ट तपासत आहे".

या प्रकरणात, आम्हाला सर्व रिटर्न कोडमध्ये स्वारस्य आहे जेथे 8 दिसतो.

  - exit_code=$((($exit_code & 8)/8))

रिटर्न कोडमध्ये आम्हाला स्वारस्य असलेल्या क्रमांकाचा थोडासा भाग असेल तेव्हा आम्हाला 1 प्राप्त होईल, अन्यथा आम्हाला 0 प्राप्त होईल.

विलीनीकरण विनंती विश्लेषण जोडण्याची वेळ आली आहे. आपण हे करण्यापूर्वी, स्क्रिप्टसाठी एक जागा तयार करूया. जेव्हा विलीनीकरण विनंती येते तेव्हाच आम्हाला ते कार्यान्वित करणे आवश्यक आहे. हे असे दिसते:

merge:
  script:
  only:
  - merge_requests

चला स्क्रिप्टवरच पुढे जाऊया. मला या वस्तुस्थितीचा सामना करावा लागला की आभासी मशीनला काहीही माहिती नाही मूळ/मास्टर. चला तर मग तिला थोडी मदत करूया:

  - git fetch origin

आता आम्हाला शाखांमधील फरक मिळतो आणि निकाल जतन करतो txt फाइल:

  - git diff --name-only origin/master $CI_COMMIT_SHA > pvs-fl.txt

कुठे $CI_COMMIT_SHA - शेवटच्या कमिटचा हॅश.

पुढे, आम्ही ध्वज वापरून फाइल्सच्या सूचीचे विश्लेषण करण्यास सुरवात करतो -f. आम्ही पूर्वी प्राप्त केलेली .txt फाईल त्यात हस्तांतरित करतो. बरं, संपूर्ण विश्लेषणाच्या सादृश्याने, आम्ही रिटर्न कोड पाहतो:

  - exit_code=0
  - pvs-studio-dotnet -t "$CI_PROJECT_DIR"/Test/Test.sln -f 
pvs-fl.txt -o PVS-Studio.json || exit_code=$?
  - exit_code=$((($exit_code & 8)/8))
  - if [[ $exit_code == 1 ]]; then exit 1; else exit 0; fi

विलीनीकरण विनंती तपासण्यासाठी संपूर्ण स्क्रिप्ट यासारखे दिसेल:

merge:
  script:
  - git fetch origin
  - git diff --name-only origin/master $CI_COMMIT_SHA > pvs-fl.txt
  - exit_code=0
  - pvs-studio-dotnet -t "$CI_PROJECT_DIR"/Test/Test.sln -f 
pvs-fl.txt -o PVS-Studio.json || exit_code=$?
  - exit_code=$((($exit_code & 8)/8))
  - if [[ $exit_code == 1 ]]; then exit 1; else exit 0; fi
  only:
  - merge_requests

सर्व स्क्रिप्ट्सवर प्रक्रिया केल्यानंतर लॉग रूपांतरण जोडणे बाकी आहे. आम्ही लेबल वापरतो after_script आणि उपयुक्तता plog-कन्व्हर्टर:

after_script:
  - plog-converter -t html -o eLog ./PVS-Studio.json

उपयुक्तता plog-कन्व्हर्टर हा एक ओपन सोर्स प्रोजेक्ट आहे ज्याचा वापर पार्सर एरर रिपोर्ट्सचे एचटीएमएल सारख्या विविध स्वरूपात रूपांतर करण्यासाठी केला जातो. युटिलिटीचे अधिक तपशीलवार वर्णन उपविभाग "प्लॉग कन्व्हर्टर युटिलिटी" मध्ये दिले आहे. दस्तऐवजीकरणाचा संबंधित विभाग.

तसे, जर तुम्हाला IDE वरून स्थानिक पातळीवर .json अहवालांसह सोयीस्करपणे काम करायचे असेल, तर मी आमच्या प्लगइन IDE रायडरसाठी. मध्ये त्याच्या वापराचे अधिक तपशीलवार वर्णन केले आहे संबंधित दस्तऐवज.

सोयीसाठी, ते येथे आहे .gitlab-ci.yml पूर्ण:

image: debian

before_script:
  - apt-get update && apt-get -y install wget gnupg 

  - apt-get -y install git
  - wget https://packages.microsoft.com/config/debian/10/
packages-microsoft-prod.deb -O packages-microsoft-prod.deb
  - dpkg -i packages-microsoft-prod.deb
  - apt-get update
  - apt-get install apt-transport-https
  - apt-get update
  
  - wget -q -O - https://files.viva64.com/etc/pubkey.txt | apt-key add -
  - wget -O /etc/apt/sources.list.d/viva64.list
https://files.viva64.com/etc/viva64.list
  - apt-get update
  - apt-get -y install pvs-studio-dotnet

  - pvs-studio-analyzer credentials $PVS_NAME $PVS_KEY
  - dotnet restore "$CI_PROJECT_DIR"/Test/Test.sln

merge:
  script:
  - git fetch origin
  - git diff --name-only origin/master $CI_COMMIT_SHA > pvs-fl.txt
  - exit_code=0
  - pvs-studio-dotnet -t "$CI_PROJECT_DIR"/Test/Test.sln -f 
pvs-fl.txt -o PVS-Studio.json || exit_code=$?
  - exit_code=$((($exit_code & 8)/8))
  - if [[ $exit_code == 1 ]]; then exit 1; else exit 0; fi
  only:
  - merge_requests

job:
  script:
  - exit_code=0
  - pvs-studio-dotnet -t "$CI_PROJECT_DIR"/Test/Test.sln -o 
PVS-Studio.json || exit_code=$?
  - exit_code=$((($exit_code & 8)/8))
  - if [[ $exit_code == 1 ]]; then exit 1; else exit 0; fi
  
after_script:
  - plog-converter -t html -o eLog ./PVS-Studio.json

एकदा आपण फाइलमध्ये सर्वकाही जोडल्यानंतर, वर क्लिक करा बदल वचनबद्ध करा. सर्वकाही योग्य आहे हे पाहण्यासाठी, वर जा सीआय / सीडी -> पाइपलाइन -> कार्यरत. व्हर्च्युअल मशीन विंडो उघडेल, ज्याच्या शेवटी खालील गोष्टी असाव्यात:

पाहिले नोकरी यशस्वी झाली - यश, सर्व काही ठीक आहे. आता तुम्ही काय केले याची चाचणी घेऊ शकता.

कामाची उदाहरणे

कामाच्या उदाहरणासाठी, एक साधा प्रकल्प तयार करूया (मध्ये मास्टर) ज्यामध्ये अनेक फाईल्स असतील. त्यानंतर, दुसर्‍या शाखेत आम्ही फक्त एक फाईल बदलू आणि विलीन करण्याची विनंती करण्याचा प्रयत्न करू.

चला दोन प्रकरणांचा विचार करूया: जेव्हा सुधारित फाइलमध्ये त्रुटी असते आणि केव्हा नसते. प्रथम, त्रुटीसह एक उदाहरण.

समजा मास्टर ब्रँचमध्ये एक फाईल आहे कार्यक्रम.सी.एस, ज्यामध्ये त्रुटी नाहीत, परंतु दुसर्‍या शाखेत विकसकाने चुकीचा कोड जोडला आहे आणि विलीन करण्याची विनंती करू इच्छित आहे. त्याने कोणत्या प्रकारची चूक केली हे इतके महत्त्वाचे नाही, मुख्य गोष्ट म्हणजे ती अस्तित्वात आहे. उदाहरणार्थ, ऑपरेटर विसरला फेकणे (होय, खूप चुकीचे):

void MyAwesomeMethod(String name)
{
  if (name == null)
    new ArgumentNullException(....);
  // do something
  ....
}

त्रुटीसह उदाहरणाचे विश्लेषण केल्याचे परिणाम पाहू. तसेच फक्त एक फाईल पार्स केली आहे याची खात्री करण्यासाठी, मी ध्वज जोडला -r pvs-studio-dotnet लाँच लाइनवर:

आम्ही पाहतो की विश्लेषकाला एक त्रुटी आढळली आणि त्याने शाखा विलीन करण्याची परवानगी दिली नाही.

त्रुटीशिवाय उदाहरण तपासूया. कोड दुरुस्त करणे:

void MyAwesomeMethod(String name)
{
  if (name == null)
    throw new ArgumentNullException(....);
  // do something
  ....
}

विलीन विनंती विश्लेषण परिणाम:

जसे आपण पाहू शकतो, कोणत्याही त्रुटी आढळल्या नाहीत आणि कार्य अंमलबजावणी यशस्वी झाली, जे आम्हाला तपासायचे होते.

निष्कर्ष

शाखा विलीन करण्यापूर्वी खराब कोड काढून टाकणे खूप सोयीचे आणि आनंददायी आहे. त्यामुळे तुम्ही CI/CD वापरत असल्यास, तपासण्यासाठी स्टॅटिक अॅनालायझर एम्बेड करण्याचा प्रयत्न करा. शिवाय, हे अगदी सोप्या पद्धतीने केले जाते.

आपल्या लक्ष दिल्याबद्दल धन्यवाद.

आपण हा लेख इंग्रजी भाषिक प्रेक्षकांसह सामायिक करू इच्छित असल्यास, कृपया भाषांतर दुवा वापरा: निकोले मिरोनोव. C# साठी PVS-Studio वापरून GitLab मध्ये विलीनीकरणाच्या विनंतीचे विश्लेषण.

स्त्रोत: www.habr.com