Add code coverage and sonarcloud to CI

* Add basic code coverage to pipeline.
* Enable sourcelink in nuget packages.
* Enable SonarScanner

Resolves #52

Author: dnperfors

.config/dotnet-tools.json

@@ -7,6 +7,18 @@
       "commands": [
         "dotnet-format"
       ]
+    },
+    "dotnet-sonarscanner": {
+      "version": "4.9.0",
+      "commands": [
+        "dotnet-sonarscanner"
+      ]
+    },
+    "gitversion.tool": {
+      "version": "5.3.6",
+      "commands": [
+        "dotnet-gitversion"
+      ]
     }
   }
 }

.editorconfig

@@ -3,22 +3,14 @@ root = true
 [*]
 insert_final_newline = true
 indent_style = space
-indent_size = 4
+indent_size = 2
 trim_trailing_whitespace = true
 
 [*.md]
 trim_trailing_whitespace = false
 
-[*.props]
-indent_size = 2
-
-[*.targets]
-indent_size = 2
-
-[*.csproj]
-indent_size = 2
-
 [*.cs]
+indent_size = 4
 dotnet_style_qualification_for_field = false:warning
 dotnet_style_qualification_for_property = false:warning
 dotnet_style_qualification_for_method = false:warning

.github/workflows/dotnetcore.yml

@@ -9,7 +9,6 @@ env:
 jobs:
   build:
     runs-on: ubuntu-latest
-    if: github.event_name == 'push'
     steps:
     - name: Dump GitHub context
       env:
@@ -22,36 +21,46 @@ jobs:
     - name: Setup .NET Core
       uses: actions/setup-dotnet@v1
       with:
-        dotnet-version: 3.1.300
+        dotnet-version: 3.1.301
     - name: Restore dotnet tools
       run: dotnet tool restore
+    - name: Prepare sonarqube
+      run: dotnet sonarscanner begin -d:sonar.host.url=https://sonarcloud.io -organization:dnperfors-github -key:dnperfors_TestableHttpClient -version:`dotnet gitversion -showvariable semver` -d:sonar.cs.opencover.reportsPaths=**/coverage.opencover.xml -d:sonar.login=${{secrets.SONARCLOUD_TOKEN}}
     - name: Restore dependencies
       run: dotnet restore
     - name: Build source code
       run: dotnet build --configuration Release --no-restore
     - name: Test with dotnet
-      run: dotnet test --configuration Release --no-build
+      run: dotnet test --configuration Release --no-build --collect="Code Coverage"
+    - name: Upload sonarqube results
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: dotnet sonarscanner end -d:sonar.login=${{secrets.SONARCLOUD_TOKEN}}
     - name: Check source file format
       run: dotnet format --folder . --check --dry-run # --folder is used to supress warnings: https://github.com/dotnet/format/issues/584
     - name: Pack
       run: dotnet pack --output ./artifacts --configuration Release --no-build
-    - uses: actions/upload-artifact@v1
+    - uses: actions/upload-artifact@v2
       with:
         name: artifacts
         path: ./artifacts
+    - uses: actions/upload-artifact@v2
+      with:
+        name: coverage
+        path: ./**/TestResults/**/coverage.opencover.xml
 
   publish:
     runs-on: ubuntu-latest
     needs: build
     if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
     steps:
     - name: Checkout
-      uses: actions/checkout@v1
+      uses: actions/checkout@v2
     - name: Setup .NET Core
       uses: actions/setup-dotnet@v1
       with:
-        dotnet-version: 3.1.300
-    - uses: actions/download-artifact@v1
+        dotnet-version: 3.1.301
+    - uses: actions/download-artifact@v2
       with:
         name: artifacts
         path: ./artifacts

.gitignore

@@ -348,3 +348,6 @@ MigrationBackup/
 
 # Ionide (cross platform F# VS Code tools) working folder
 .ionide/
+
+# SonarQube scans
+.sonarqube

Directory.Build.props

@@ -13,8 +13,12 @@
     <PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
     <DevelopmentDependency>false</DevelopmentDependency>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
+
+    <PublishRepositoryUrl>true</PublishRepositoryUrl>
+    <EmbedUntrackedSources>true</EmbedUntrackedSources>
     <IncludeSymbols>true</IncludeSymbols>
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
+    
     <IncludeSource>true</IncludeSource>
     <RepositoryUrl>https://github.com/dnperfors/TestableHttpClient</RepositoryUrl>
     <RepositoryType>git</RepositoryType>

Directory.Build.targets

@@ -1,8 +1,6 @@
 <Project>
   <ItemGroup>
-    <PackageReference Include="GitVersionTask" Version="5.3.6">
-      <PrivateAssets>all</PrivateAssets>
-      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
-    </PackageReference>
+    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="All"/>
+    <PackageReference Include="GitVersionTask" Version="5.3.6" PrivateAssets="All" />
   </ItemGroup>
 </Project>

test/Directory.Build.props

@@ -2,5 +2,6 @@
   <Import Project="$([MSBuild]::GetPathOfFileAbove('Directory.Build.props', '$(MSBuildThisFileDirectory)../'))" />
   <PropertyGroup>
     <IsPackable>false</IsPackable>
+    <RunSettingsFilePath>$(MSBuildThisFileDirectory)/coverlet.runsettings</RunSettingsFilePath>
   </PropertyGroup>
 </Project>

test/coverlet.runsettings

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<RunSettings>
+  <DataCollectionRunSettings>
+    <DataCollectors>
+      <DataCollector friendlyName="Code Coverage" uri="datacollector://Microsoft/CoverletCodeCoverage/1.0">
+        <Configuration>
+          <Format>opencover</Format>
+          <ExcludeByAttribute>GeneratedCodeAttribute,CompilerGeneratedAttribute</ExcludeByAttribute>
+          <UseSourceLink>false</UseSourceLink>
+        </Configuration>
+      </DataCollector>
+    </DataCollectors>
+  </DataCollectionRunSettings>
+</RunSettings>