🥇 C# को लागि PVS-स्टुडियो प्रयोग गरेर GitLab मा मर्ज अनुरोधहरूको विश्लेषण

GitLab लाई माया गर्नुहुन्छ र बगहरूलाई घृणा गर्नुहुन्छ? आफ्नो स्रोत कोड को गुणस्तर सुधार गर्न चाहनुहुन्छ? त्यसपछि तपाईं सही ठाउँमा आउनुभएको छ। आज हामी मर्ज अनुरोधहरू जाँच गर्न PVS-Studio C# विश्लेषक कसरी कन्फिगर गर्ने भनेर बताउनेछौं। एक युनिकर्न मूड र सबैलाई खुशी पढ्नुहोस्।

PVS- स्टूडियो C, C++, C# र Java मा लेखिएका प्रोग्रामहरूको स्रोत कोडमा त्रुटिहरू र सम्भावित कमजोरीहरू पहिचान गर्ने एउटा उपकरण हो। विन्डोज, लिनक्स र macOS मा 64-बिट प्रणालीहरूमा काम गर्दछ। 32-bit, 64-bit र एम्बेडेड ARM प्लेटफर्महरूको लागि डिजाइन गरिएको कोड विश्लेषण गर्न सक्छ।

वैसे, हामीले PVS-Studio 7.08 जारी गर्यौं, जसमा हामीले धेरै चीजहरू गर्यौं रोचक। उदाहरणका लागि:

लिनक्स र macOS को लागि C# विश्लेषक;
राइडरको लागि प्लगइन;
नयाँ फाइल सूची जाँच मोड।

फाइल सूची जाँच मोड

पहिले, केहि फाइलहरू जाँच गर्न, विश्लेषकमा फाइलहरूको सूचीको साथ एक .xml पास गर्न आवश्यक थियो। तर यो धेरै सुविधाजनक नभएकोले, हामीले .txt स्थानान्तरण गर्ने क्षमता थपेका छौं, जसले जीवनलाई धेरै सरल बनाउँछ।

विशेष फाइलहरू जाँच गर्नको लागि, तपाईंले झण्डा निर्दिष्ट गर्नुपर्छ -- स्रोत फाइलहरू (-f) र फाइलहरूको सूचीको साथ .txt स्थानान्तरण गर्नुहोस्। यो यस्तो देखिन्छ:

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

यदि तपाइँ कमिट जाँच वा पुल अनुरोधहरू सेटअप गर्न इच्छुक हुनुहुन्छ भने, तपाइँ यो मोड प्रयोग गरेर पनि गर्न सक्नुहुन्छ। भिन्नता विश्लेषण गर्न फाइलहरूको सूची प्राप्त गर्नमा हुनेछ र तपाइँ कुन प्रणालीहरू प्रयोग गरिरहनु भएकोमा निर्भर हुनेछ।

मर्ज अनुरोध जाँच गर्ने सिद्धान्त

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

यो एक स्थिर विश्लेषक लागू गर्नु अघि मर्ज अनुरोध जस्तो देखिन्छ:

अर्थात्, शाखामा भएका सबै त्रुटिहरू परिवर्तनहरू, मास्टर शाखामा सर्नेछ। किनकि हामी यो चाहँदैनौं, हामी विश्लेषण थप्छौं, र अब रेखाचित्र यस्तो देखिन्छ:

हामी विश्लेषण गर्छौं परिवर्तन २ र, यदि कुनै त्रुटिहरू छैनन् भने, हामी मर्ज अनुरोध स्वीकार गर्छौं, अन्यथा हामी यसलाई अस्वीकार गर्छौं।

वैसे, यदि तपाइँ C/C++ को लागि कमिटहरू र पुल अनुरोधहरू विश्लेषण गर्न रुचि राख्नुहुन्छ भने, तपाइँ यसको बारेमा पढ्न सक्नुहुन्छ यहाँ.

GitLab

GitLab एउटा खुला स्रोत वेब-आधारित DevOps लाइफसायकल उपकरण हो जसले Git को आफ्नै विकी, मुद्दा ट्र्याकिङ प्रणाली, CI/CD पाइपलाइन र अन्य सुविधाहरूको साथ कोड भण्डार व्यवस्थापन प्रणाली प्रदान गर्दछ।

तपाईंले मर्ज अनुरोधहरूको विश्लेषण सुरु गर्नु अघि, तपाईंले आफ्नो परियोजना दर्ता र अपलोड गर्न आवश्यक छ। यदि तपाइँ यो कसरी गर्ने थाहा छैन भने, म सुझाव दिन्छु लेख मेरो सहकर्मी।

भन्नु। तल वर्णन गरिएको वातावरण सेटअप गर्ने तरिका सम्भावित मध्ये एक हो। लक्ष्य विश्लेषणको लागि आवश्यक वातावरण सेटअप गर्न र विश्लेषक सुरू गर्न चरणहरू देखाउनु हो। सायद तपाईको मामलामा वातावरणीय तयारीका चरणहरू (भण्डारहरू थप्ने, विश्लेषक स्थापना गर्ने) र विश्लेषणहरू छुट्याउन अझ उत्तम हुनेछ: उदाहरणका लागि, आवश्यक वातावरणसँग डकर छविहरू तयार गर्ने र तिनीहरूलाई प्रयोग गर्ने, वा कुनै अन्य विधि।

अब के हुनेछ भनेर राम्रोसँग बुझ्नको लागि, म निम्न रेखाचित्र हेर्न सुझाव दिन्छु:

विश्लेषकलाई सञ्चालन गर्न .NET Core SDK 3 चाहिन्छ, त्यसैले विश्लेषक स्थापना गर्नु अघि तपाईंले Microsoft भण्डारहरू थप्नु पर्छ जसबाट विश्लेषकको लागि आवश्यक निर्भरताहरू स्थापना हुनेछन्। विभिन्न लिनक्स वितरणहरूको लागि 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

PVS-स्टुडियो भण्डार र विश्लेषक थप्दै:

  - 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 प्रयोग गरेर कमाण्ड लाइनबाट भिजुअल स्टुडियो / MSBuild / .NET कोर परियोजनाहरू जाँच गर्दै".

यस अवस्थामा, हामी सबै रिटर्न कोडहरूमा रुचि राख्छौं जहाँ 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-converter:

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

उपयोगिता plog-converter एक खुला स्रोत परियोजना हो जुन पार्सर त्रुटि रिपोर्टहरूलाई विभिन्न रूपहरूमा रूपान्तरण गर्न प्रयोग गरिन्छ, जस्तै HTML। उपयोगिताको थप विस्तृत विवरण उपखण्ड "प्लग कन्भर्टर उपयोगिता" मा दिइएको छ। कागजातको प्रासंगिक खण्ड.

वैसे, यदि तपाईं 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

एकचोटि तपाईंले फाइलमा सबै थपेपछि, क्लिक गर्नुहोस् परिवर्तनहरू प्रतिबद्ध गर्नुहोस्। सबै कुरा सही छ भनेर हेर्नको लागि, जानुहोस् CI / CD -> पाइपलाइनहरू -> दौडने। भर्चुअल मेसिन विन्डो खुल्नेछ, जसको अन्त्यमा निम्न हुनुपर्छ:

देखियो काम सफल भयो - सफलता, सबै ठीक छ। अब तपाईले के गर्नुभयो भनेर परीक्षण गर्न सक्नुहुन्छ।

काम उदाहरणहरू

कामको उदाहरणको लागि, एउटा साधारण परियोजना (in मास्टर) जसमा धेरै फाइलहरू हुनेछन्। त्यस पछि, अर्को शाखामा हामी केवल एउटा फाइल परिवर्तन गर्नेछौं र मर्ज अनुरोध गर्ने प्रयास गर्नेछौं।

दुईवटा केसहरू विचार गरौं: जब परिमार्जित फाइलमा त्रुटि हुन्छ र कहिले हुँदैन। पहिलो, त्रुटि संग एक उदाहरण।

मानौं मास्टर शाखामा फाइल छ Program.cs, जसले त्रुटिहरू समावेश गर्दैन, तर अर्को शाखामा विकासकर्ताले त्रुटिपूर्ण कोड थप्यो र मर्ज अनुरोध गर्न चाहन्छ। उसले कस्तो गल्ती गर्यो त्यो धेरै महत्त्वपूर्ण छैन, मुख्य कुरा यो अवस्थित छ। उदाहरणका लागि, अपरेटर बिर्सनुभयो फेंक (हो, धेरै गलत):

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-स्टुडियो प्रयोग गरेर GitLab मा मर्ज अनुरोधहरूको विश्लेषण.

स्रोत: www.habr.com

C# को लागि PVS-स्टुडियो प्रयोग गरेर GitLab मा मर्ज अनुरोधहरूको विश्लेषण

फाइल सूची जाँच मोड

मर्ज अनुरोध जाँच गर्ने सिद्धान्त

GitLab

काम उदाहरणहरू

निष्कर्षमा

एक टिप्पणी थप्न Отменить ответ