Merge pull request #11 from json-api-dotnet/cibuild-enhancements

cibuild matrix, code coverage and other enhancements

Author: Bart Koelman

.config/dotnet-tools.json

@@ -13,6 +13,18 @@
       "commands": [
         "regitlint"
       ]
+    },
+    "codecov.tool": {
+      "version": "1.13.0",
+      "commands": [
+        "codecov"
+      ]
+    },
+    "dotnet-reportgenerator-globaltool": {
+      "version": "4.8.7",
+      "commands": [
+        "reportgenerator"
+      ]
     }
   }
 }

Build.ps1

@@ -1,25 +1,14 @@
-# Gets the version suffix from the repo tag
-# example: v1.0.0-preview1-final => preview1-final
-function Get-Version-Suffix-From-Tag {
-  $tag=$env:APPVEYOR_REPO_TAG_NAME
-  $split=$tag -split "-"
-  $suffix=$split[1..2]
-  $final=$suffix -join "-"
-  return $final
-}
-
 function CheckLastExitCode {
     param ([int[]]$SuccessCodes = @(0), [scriptblock]$CleanupScript=$null)
 
     if ($SuccessCodes -notcontains $LastExitCode) {
-        $msg = "EXE RETURNED EXIT CODE $LastExitCode"
-        throw $msg
+        throw "Executable returned exit code $LastExitCode"
     }
 }
 
 function RunInspectCode {
     $outputPath = [System.IO.Path]::Combine([System.IO.Path]::GetTempPath(), 'jetbrains-inspectcode-results.xml')
-    dotnet jb inspectcode JsonApiDotNetCore.MongoDb.sln --output="$outputPath" --profile=JsonApiDotNetCore-WarningSeverities.DotSettings --properties:Configuration=Release --severity=WARNING --verbosity=WARN -dsl=GlobalAll -dsl=SolutionPersonal -dsl=ProjectPersonal
+    dotnet jb inspectcode JsonApiDotNetCore.MongoDb.sln --output="$outputPath" --profile=WarningSeverities.DotSettings --properties:Configuration=Release --severity=WARNING --verbosity=WARN -dsl=GlobalAll -dsl=SolutionPersonal -dsl=ProjectPersonal
     CheckLastExitCode
 
     [xml]$xml = Get-Content "$outputPath"
@@ -50,21 +39,59 @@ function RunCleanupCode {
     # When running in cibuild for a pull request, this reformats only the files changed in the PR and fails if the reformat produces changes.
 
     if ($env:APPVEYOR_PULL_REQUEST_HEAD_COMMIT) {
-        Write-Output "Running code cleanup in cibuild for pull request"
+        Write-Output "Running code cleanup on changed files in pull request"
 
-        $sourceCommitHash = $env:APPVEYOR_PULL_REQUEST_HEAD_COMMIT
+        # In the past, we used $env:APPVEYOR_PULL_REQUEST_HEAD_COMMIT for the merge commit hash. That is the pinned hash at the time the build is enqueued.
+        # When a force-push happens after that, while the build hasn't yet started, this hash becomes invalid during the build, resulting in a lookup error.
+        # To prevent failing the build for unobvious reasons we use HEAD, which is always the latest version.
+        $mergeCommitHash = git rev-parse "HEAD"
         $targetCommitHash = git rev-parse "$env:APPVEYOR_REPO_BRANCH"
 
-        Write-Output "Source commit hash = $sourceCommitHash"
-        Write-Output "Target commit hash = $targetCommitHash"
-
-        dotnet regitlint -s JsonApiDotNetCore.MongoDb.sln --print-command --jb --profile --jb --profile='\"JADNC Full Cleanup\"' --jb --properties:Configuration=Release --jb --verbosity=WARN -f commits -a $sourceCommitHash -b $targetCommitHash --fail-on-diff --print-diff
+        dotnet regitlint -s JsonApiDotNetCore.MongoDb.sln --print-command --jb --profile --jb --profile='\"JADNC Full Cleanup\"' --jb --properties:Configuration=Release --jb --verbosity=WARN -f commits -a $mergeCommitHash -b $targetCommitHash --fail-on-diff --print-diff
         CheckLastExitCode
     }
 }
 
-$revision = @{ $true = $env:APPVEYOR_BUILD_NUMBER; $false = 1 }[$env:APPVEYOR_BUILD_NUMBER -ne $NULL];
-$revision = "{0:D4}" -f [convert]::ToInt32($revision, 10)
+function ReportCodeCoverage {
+    if ($env:APPVEYOR) {
+        if ($IsWindows) {
+            dotnet codecov -f "**\coverage.cobertura.xml"
+        }
+    }
+    else {
+        dotnet reportgenerator -reports:**\coverage.cobertura.xml -targetdir:artifacts\coverage
+    }
+
+    CheckLastExitCode
+}
+
+function CreateNuGetPackage {
+    if ($env:APPVEYOR_REPO_TAG -eq $true) {
+        # Get the version suffix from the repo tag. Example: v1.0.0-preview1-final => preview1-final
+        $segments = $env:APPVEYOR_REPO_TAG_NAME -split "-"
+        $suffixSegments = $segments[1..2]
+        $versionSuffix = $suffixSegments -join "-"
+    }
+    else {
+        # Get the version suffix from the auto-incrementing build number. Example: "123" => "pre-0123".
+        if ($env:APPVEYOR_BUILD_NUMBER) {
+            $revision = "{0:D4}" -f [convert]::ToInt32($env:APPVEYOR_BUILD_NUMBER, 10)
+            $versionSuffix = "pre-$revision"
+        }
+        else {
+            $versionSuffix = "pre-0001"
+        }
+    }
+
+    if ([string]::IsNullOrWhitespace($versionSuffix)) {
+        dotnet pack .\src\JsonApiDotNetCore.MongoDb -c Release -o .\artifacts
+    }
+    else {
+        dotnet pack .\src\JsonApiDotNetCore.MongoDb -c Release -o .\artifacts --version-suffix=$versionSuffix
+    }
+
+    CheckLastExitCode
+}
 
 dotnet tool restore
 CheckLastExitCode
@@ -75,30 +102,9 @@ CheckLastExitCode
 RunInspectCode
 RunCleanupCode
 
-dotnet test -c Release --no-build
+dotnet test -c Release --no-build --collect:"XPlat Code Coverage"
 CheckLastExitCode
 
-Write-Output "APPVEYOR_REPO_TAG: $env:APPVEYOR_REPO_TAG"
-
-if ($env:APPVEYOR_REPO_TAG -eq $true) {
-    $revision = Get-Version-Suffix-From-Tag
-    Write-Output "VERSION-SUFFIX: $revision"
+ReportCodeCoverage
 
-    if ([string]::IsNullOrWhitespace($revision)) {
-        Write-Output "RUNNING dotnet pack .\src\JsonApiDotNetCore.MongoDb -c Release -o .\artifacts"
-                              dotnet pack .\src\JsonApiDotNetCore.MongoDb -c Release -o .\artifacts
-        CheckLastExitCode
-    }
-    else {
-        Write-Output "RUNNING dotnet pack .\src\JsonApiDotNetCore.MongoDb -c Release -o .\artifacts --version-suffix=$revision"
-                              dotnet pack .\src\JsonApiDotNetCore.MongoDb -c Release -o .\artifacts --version-suffix=$revision
-        CheckLastExitCode
-    }
-}
-else {
-    $packageVersionSuffix="pre-$revision"
-    Write-Output "VERSION-SUFFIX: $packageVersionSuffix"
-    Write-Output "RUNNING dotnet pack .\src\JsonApiDotNetCore.MongoDb -c Release -o .\artifacts --version-suffix=$packageVersionSuffix"
-                          dotnet pack .\src\JsonApiDotNetCore.MongoDb -c Release -o .\artifacts --version-suffix=$packageVersionSuffix
-    CheckLastExitCode
-}
+CreateNuGetPackage

Directory.Build.props

@@ -21,9 +21,10 @@
 
   <!-- Test Project Dependencies -->
   <PropertyGroup>
-    <XUnitVersion>2.4.1</XUnitVersion>
-    <FluentAssertionsVersion>5.10.3</FluentAssertionsVersion>
     <BogusVersion>33.0.2</BogusVersion>
+    <CoverletVersion>3.0.3</CoverletVersion>
+    <FluentAssertionsVersion>5.10.3</FluentAssertionsVersion>
     <MoqVersion>4.16.1</MoqVersion>
+    <XUnitVersion>2.4.1</XUnitVersion>
   </PropertyGroup>
 </Project>

JsonApiDotNetCore.MongoDb.sln

@@ -1,5 +1,4 @@
-
-Microsoft Visual Studio Solution File, Format Version 12.00
+Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio Version 16
 VisualStudioVersion = 16.0.30804.86
 MinimumVisualStudioVersion = 15.0.26124.0

README.md

@@ -2,7 +2,8 @@
 
 Plug-n-play implementation of `IResourceRepository<TResource, TId>` allowing you to use [MongoDB](https://www.mongodb.com/) with your [JsonApiDotNetCore](https://github.com/json-api-dotnet/JsonApiDotNetCore) APIs.
 
-[![Build status](https://ci.appveyor.com/api/projects/status/dadm2kr2y0353mji/branch/master?svg=true)](https://ci.appveyor.com/project/json-api-dotnet/jsonapidotnetcore-mongodb/branch/master)
+[![Build](https://ci.appveyor.com/api/projects/status/dadm2kr2y0353mji/branch/master?svg=true)](https://ci.appveyor.com/project/json-api-dotnet/jsonapidotnetcore-mongodb/branch/master)
+[![Coverage](https://codecov.io/gh/json-api-dotnet/JsonApiDotNetCore.MongoDb/branch/master/graph/badge.svg?token=QPVf8rii7l)](https://codecov.io/gh/json-api-dotnet/JsonApiDotNetCore.MongoDb)
 [![NuGet](https://img.shields.io/nuget/v/JsonApiDotNetCore.MongoDb.svg)](https://www.nuget.org/packages/JsonApiDotNetCore.MongoDb/)
 
 ## Installation and Usage
@@ -13,8 +14,8 @@ dotnet add package JsonApiDotNetCore.MongoDb
 
 ### Models
 
-```cs
-public sealed class Book : MongoIdentifiable
+```c#
+public class Book : MongoIdentifiable
 {
     [Attr]
     public string Name { get; set; }
@@ -23,10 +24,11 @@ public sealed class Book : MongoIdentifiable
 
 ### Controllers
 
-```cs
-public sealed class BooksController : JsonApiController<Book, string>
+```c#
+public class BooksController : JsonApiController<Book, string>
 {
-    public BooksController(IJsonApiOptions options, ILoggerFactory loggerFactory, IResourceService<Book, string> resourceService)
+    public BooksController(IJsonApiOptions options, ILoggerFactory loggerFactory,
+        IResourceService<Book, string> resourceService)
         : base(options, loggerFactory, resourceService)
     {
     }
@@ -35,15 +37,15 @@ public sealed class BooksController : JsonApiController<Book, string>
 
 ### Middleware
 
-```cs
+```c#
 public class Startup
 {
     public IServiceProvider ConfigureServices(IServiceCollection services)
     {
-        services.AddSingleton<IMongoDatabase>(sp =>
+        services.AddSingleton<IMongoDatabase>(_ =>
         {
-            var client = new MongoClient(Configuration.GetSection("DatabaseSettings:ConnectionString").Value);
-            return client.GetDatabase(Configuration.GetSection("DatabaseSettings:Database").Value);
+            var client = new MongoClient("mongodb://localhost:27017");
+            return client.GetDatabase("ExampleDbName");
         });
 
         services.AddJsonApi(resources: builder =>
@@ -65,7 +67,7 @@ public class Startup
 ```
 Note: If your API project uses only MongoDB (not in combination with EF Core), then instead of
 registering all MongoDB resources and repositories individually, you can use:
-```cs
+```c#
 public class Startup
 {
     public IServiceProvider ConfigureServices(IServiceCollection services)
@@ -85,17 +87,35 @@ public class Startup
 }
 ```
 
+## Limitations
+
+- JSON:API relationships are currently not supported. You can use complex object graphs though, which are stored in a single document.
+
+## Contributing
+
+Have a question, found a bug or want to submit code changes? See our [contributing guidelines](https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/.github/CONTRIBUTING.md).
+
+## Trying out the latest build
+
+After each commit to the master branch, a new prerelease NuGet package is automatically published to AppVeyor at https://ci.appveyor.com/nuget/jsonapidotnetcore. To try it out, follow the next steps:
+
+* In Visual Studio: **Tools**, **NuGet Package Manager**, **Package Manager Settings**, **Package Sources**
+    * Click **+**
+    * Name: **AppVeyor JADNC MongoDb**, Source: **https://ci.appveyor.com/nuget/jsonapidotnetcore-mongodb**
+    * Click **Update**, **Ok**
+* Open the NuGet package manager console (**Tools**, **NuGet Package Manager**, **Package Manager Console**)
+    * Select **AppVeyor JADNC MongoDb** as package source
+    * Run command: `Install-Package JonApiDotNetCore -pre`
+
 ## Development
 
-Restore all NuGet packages with:
+To build the code from this repository locally, run:
 
 ```bash
-dotnet restore
+dotnet build
 ```
 
-### Testing
-
-You don't need to have a running instance of MongoDB on your machine. To run the tests just type the following command in your terminal:
+You don't need to have a running instance of MongoDB on your machine to run tests. Just type the following command in your terminal:
 
 ```bash
 dotnet test
@@ -104,15 +124,17 @@ dotnet test
 If you want to run the examples and explore them on your own **you are** going to need that running instance of MongoDB. If you have docker installed you can launch it like this:
 
 ```bash
-docker run -p 27017:27017 -d mongo:latest
+run-docker-mongodb.ps1
 ```
 
 And then to run the API:
 
 ```bash
-dotnet run
+dotnet run --project src/Examples/GettingStarted
 ```
 
-## Limitations
+Alternatively, to build and validate the code, run all tests, generate code coverage and produce the NuGet package:
 
-- Relationships are not supported
+```bash
+Build.ps1
+```

JsonApiDotNetCore-WarningSeverities.DotSettings renamed to WarningSeverities.DotSettings

@@ -1,41 +1,51 @@
-version: '{build}'
-os: Visual Studio 2019
+image:
+  - Ubuntu
+  - Visual Studio 2019
 
-pull_requests:
-  do_not_increment_build_number: true
+version: '{build}'
 
 branches:
   only:
   - master
+  - develop
+  - unstable
   - /release\/.+/
 
+pull_requests:
+  do_not_increment_build_number: true
+
 nuget:
   disable_publish_on_pr: true
 
+matrix:
+  fast_finish: true
+
+for:
+-
+  matrix:
+    only:
+    - image: Visual Studio 2019
+  artifacts:
+  - path: .\**\artifacts\**\*.nupkg
+    name: NuGet
+  deploy:
+  - provider: NuGet
+    skip_symbols: false
+    api_key:
+      secure: OBYPCgp3WCuwkDRMuZ9a4QcBdTja/lqlUwZ+Yl5VHqooSJRVTYKP5y15XK0fuHsZ
+    on:
+      branch: master
+      appveyor_repo_tag: true
+  - provider: NuGet
+    skip_symbols: false
+    api_key:
+      secure: OBYPCgp3WCuwkDRMuZ9a4QcBdTja/lqlUwZ+Yl5VHqooSJRVTYKP5y15XK0fuHsZ
+    on:
+      branch: /release\/.+/
+      appveyor_repo_tag: true
+
 build_script:
 - pwsh: dotnet --version
 - pwsh: .\Build.ps1
 
-test: off
-
-artifacts:
-- path: .\**\artifacts\**\*.nupkg
-  name: NuGet
-
-deploy:
-- provider: NuGet
-  name: production
-  skip_symbols: false
-  api_key:
-    secure: ogA5YOVPy9v1Vd623/Jf79dzYlCb5NrXb1e7uHolnyVYTWVz7MporZ+KTVFpAQci
-  on:
-    branch: master
-    appveyor_repo_tag: true
-
-- provider: NuGet
-  skip_symbols: false
-  api_key:
-    secure: ogA5YOVPy9v1Vd623/Jf79dzYlCb5NrXb1e7uHolnyVYTWVz7MporZ+KTVFpAQci
-  on:
-    branch: /release\/.+/
-    appveyor_repo_tag: true
+test: off

appveyor.yml

@@ -16,7 +16,7 @@ if ($LASTEXITCODE -ne 0) {
 
 $outputPath = [System.IO.Path]::Combine([System.IO.Path]::GetTempPath(), 'jetbrains-inspectcode-results.xml')
 $resultPath = [System.IO.Path]::Combine([System.IO.Path]::GetTempPath(), 'jetbrains-inspectcode-results.html')
-dotnet jb inspectcode JsonApiDotNetCore.MongoDb.sln --output="$outputPath" --profile=JsonApiDotNetCore-WarningSeverities.DotSettings --properties:Configuration=Release --severity=WARNING --verbosity=WARN -dsl=GlobalAll -dsl=SolutionPersonal -dsl=ProjectPersonal
+dotnet jb inspectcode JsonApiDotNetCore.MongoDb.sln --output="$outputPath" --profile=WarningSeverities.DotSettings --properties:Configuration=Release --severity=WARNING --verbosity=WARN -dsl=GlobalAll -dsl=SolutionPersonal -dsl=ProjectPersonal
 
 if ($LASTEXITCODE -ne 0) {
     throw "Code inspection failed with exit code $LASTEXITCODE"