X
18Mar

Code Analysis & Code Metrics Integration in Azure Pipelines

This documentation shows the tutorial on how to integrate Visual Studio Code Analysis and Code Metrics in Azure Pipelines using YAML. Follow the steps:

  1. Open Visual Studio 2019 and open project or solution and select your project.1b
  2. Now you have to add a NuGet package named “Microsoft.CodeAnalysis.Metrics” to your solution. For this right click on the solution in Solution Explorer and click on Manage NuGet Packages for Solution.

2b

3. Browse for Microsoft.CodeAnalysis.Metrics in the search bar. Click on the package. Select all your projects in the solution and click on Install.

3b4. In the next 2 windows click on OK then Accept. Wait until the package gets added to all your projects.

5. Now save all your changes. Then in team explorer commit your changes with a commit message.

4b

6.  Sync the changes with the server in Azure Repos.

5b

 

7. Navigate to your project in Azure DevOps and go to Build section of Pipelines.

8. Click on New Pipeline to setup a pipeline in YAML. If you have a n existing YAML pipeline you can add the stage to it.

9. Click on Azure Repos Git and then select your repository.

6b

10. Click on Starter Pipeline for a new pipeline.

7b

 

11. Add the following stage to your existing pipeline for Code Analysis and Code Metrics .

 - stage: CodeScan
   dependsOn: []
   jobs:
     - job: CodeScan
       pool:
        vmImage: 'vs2017-win2016'
       steps:
       - task: NuGetCommand@2
	   displayName: NuGetRestore
         inputs:
           restoreSolution: '$(solution)'
       - task: VSBuild@1
         displayName: CodeAnalysis
         inputs:
           solution: '$(solution)'
           msbuildArgs: '/p:RunCodeAnalysis=true'
           platform: '$(buildPlatform)'
           configuration: '$(buildConfiguration)'
       - task: VSBuild@1
         displayName: CodeMetrics
         inputs:
           solution: '$(solution)'
           msbuildArgs: '/t:Metrics /p:MetricsOutputFile=$(Build.ArtifactStagingDirectory)/PartsUnlimitted.Metrics.xml' # Modify xml file name according to project
           platform: '$(buildPlatform)'
           configuration: '$(buildConfiguration)'
       - task: PublishBuildArtifacts@1
         displayName: 'Publish Metrics'
         inputs:
           PathtoPublish: '$(Build.ArtifactStagingDirectory)'
           ArtifactName: 'MetricsReport'
           publishLocation: 'Container'

Note: Add solution, buildPlatform and buildConfiguration in the variables section of the pipeline.

variables:
  solution: '**/*.sln' # Provide path of .sln file here
  buildPlatform: 'Any CPU'
  buildConfiguration: 'Release'

12. Add other stages and dependencies for build, deploy or any other functionality according to the needs of the project. If you only want the pipeline for Code Metrics and Code Analysis, you can go for the single stage complete script provided below. Remove everything in your Starter Pipeline and add the following script. 

trigger:
  - master
  
  variables:
    solution: '**/*.sln' # Provide path of .sln file here
    buildPlatform: 'Any CPU'
    buildConfiguration: 'Release'
  
  pool:
    vmImage: 'vs2017-win2016'
  
  steps:
  - task: NuGetCommand@2
    displayName: NuGetRestore
    inputs:
      restoreSolution: '$(solution)'
  - task: VSBuild@1
    displayName: CodeAnalysis
    inputs:
      solution: '$(solution)'
      msbuildArgs: '/p:RunCodeAnalysis=true'
      platform: '$(buildPlatform)'
      configuration: '$(buildConfiguration)'
  - task: VSBuild@1
    displayName: CodeMetrics
    inputs:
      solution: '$(solution)'
      msbuildArgs: '/t:Metrics /p:MetricsOutputFile=$(Build.ArtifactStagingDirectory)/PartsUnlimitted.Metrics.xml'
      platform: '$(buildPlatform)'
      configuration: '$(buildConfiguration)'
  - task: PublishBuildArtifacts@1
    displayName: 'Publish Metrics'
    inputs:
      PathtoPublish: '$(Build.ArtifactStagingDirectory)'
      ArtifactName: 'MetricsReport'
      publishLocation: 'Container'

13. Click on Save and run to run the pipeline.

save&run

14. Enter a commit message and click Save and run.

15. View the live logs of the pipeline to see Code Analysis. You can also download the logs if required.

codeAnalysis

16. The Code Metrics report will be published as an XML file inside the Artifact generated after the pipeline. For this navigate to the Runs tab of your pipeline, click on any Run you want.

CodeScan

17. You can find the report by clicking Artifacts button.

Artifacts

18. Download the XML file to view the Code Metrics report.

code

19. Congrats!!!!! You are Done.

 

Related

The Best Practices and Advantages of Designing Effective Test Cases

The Best Practices and Advantages of Designing Effective Test Cases OverviewTest case is a &ldq...

Read More >

Join Techno Feast 2014

You can choose any of the location near to you out of these 7 major cities       &nbs...

Read More >

Rapid Start Services in Microsoft Dynamics NAV 2013

RapidStart Services is an integrated tool that helps you to speed up the implementation process and ...

Read More >

Building a RESTful API using python and Django

What you Need? Python 2.6+ Django 1.5+ django-tastypie  Sqllite3Django is Free and Open Source ...

Read More >

How to print TransHeader and TransFooter in Microsoft Dynamics NAV RDLC reports

We know that TransHeader and TransFooter section types were available in NAV 2009 version but there ...

Read More >

How to use JQuery with Visual Studio .Net

What does JQuery mean?It is simply a light weight javascript library through which we can perform ac...

Read More >

Continuous Integration/ Continuous Deployment VSTS

Following the below steps you can build and deploy your ASP.NET  app to Azure from either Visua...

Read More >

Introduction to Amazon S3 (Simple Storage Service) and EC2 (Elastic Cloud Computing) in Asp.Net

S3 is an Internet storage engine which has to be designed to make job easier for developers.Develope...

Read More >

Share

Post a Comment

  • Recent
  • Popular
  • Tag
Monthly Archive
Subscribe
Name

Contact Us
  • *
  • *