Remove Cake Build (#94)

We no longer require Cake build nor we use it extensively!
Update Azure Pipelines (CI YAML) Script to be more modern and runnable across platforms.
Replaced the headers check with a PowerShell script mimicking the Cake script's `UpdateHeaders` task functionality.

Author: Nirmal4G

azure-pipelines.yml

@@ -18,66 +18,64 @@ jobs:
 
   # Install NuGet
   - task: NuGetToolInstaller@0
-    displayName: Install NuGet 5.6.0
+    displayName: Install NuGet 6.0
     inputs:
-      versionSpec: 5.6.0
+      versionSpec: 6.0.0
 
   # Install NerdBank GitVersioning
   - task: DotNetCoreCLI@2
     displayName: Install NBGV tool
     inputs:
       command: custom
       custom: tool
-      arguments: install --tool-path . nbgv
+      arguments: install -g nbgv
+
+  # Set Build Version
   - script: nbgv cloud
     displayName: Set NBGV version
 
   # Verify headers
-  - powershell: .\build\build.ps1 -Target Verify
+  - pwsh: build/Update-Headers.ps1 -Verify
     displayName: Verify headers
 
   # Build solution
-  - powershell: dotnet build -c Release
+  - script: dotnet build -c Release
     displayName: Build solution
 
   # Run .NET 6 tests
-  - powershell: dotnet test --logger "trx;LogFileName=VsTestResultsNet6.trx" --framework net6.0 --configuration Release
+  - script: dotnet test -c Release -f net6.0 -l "trx;LogFileName=VSTestResults_net6.0.trx"
     displayName: Run .NET 6 unit tests
 
   # Run .NET Core 3.1 tests
-  - powershell: dotnet test --logger "trx;LogFileName=VsTestResultsNetCore31.trx" --framework netcoreapp3.1 --configuration Release
+  - script: dotnet test -c Release -f netcoreapp3.1 -l "trx;LogFileName=VSTestResults_netcoreapp3.1.trx"
     displayName: Run .NET Core 3.1 unit tests
 
   # Run .NET Framework 4.7.2 tests
-  - powershell: dotnet test --logger "trx;LogFileName=VsTestResultsNet472.trx" --framework net472 --configuration Release
+  - script: dotnet test -c Release -f net472 -l "trx;LogFileName=VSTestResults_net472.trx"
     displayName: Run .NET Framework 4.7.2 unit tests
 
   # Publish test results
   - task: PublishTestResults@2
     displayName: Publish test results
     inputs:
       testResultsFormat: 'VSTest'
-      testResultsFiles: '**/VsTestResults*.trx'
+      testResultsFiles: '**/VSTestResults*.trx'
     condition: always()
 
   # Create the NuGet package(s)
-  - powershell: dotnet pack --configuration Release
+  - script: dotnet pack -c Release
     displayName: Create NuGet package(s)
 
   # Sign package(s)
-  - task: PowerShell@2
+  - pwsh: build/Sign-Package.ps1
     displayName: Authenticode sign packages
-    inputs:
-      filePath: build/Sign-Package.ps1
     env:
       SignClientUser: $(SignClientUser)
       SignClientSecret: $(SignClientSecret)
-      ArtifactDirectory: bin\nupkg
-    condition: and(succeeded(), not(eq(variables['build.reason'], 'PullRequest')), not(eq(variables['SignClientSecret'], '')), not(eq(variables['SignClientUser'], '')))
+      ArtifactDirectory: bin/nupkg
+    condition: and(succeeded(), not(eq(variables['Build.Reason'], 'PullRequest')), not(eq(variables['SignClientSecret'], '')), not(eq(variables['SignClientUser'], '')))
 
   # Publish build artifacts
-  - task: PublishPipelineArtifact@1
+  - publish: bin/nupkg
+    artifact: Packages
     displayName: Publish package artifacts
-    inputs:
-      targetPath: .\bin\nupkg
-      artifactName: Packages

build/Build.bat

@@ -0,0 +1,89 @@
+# Script to Update Header comment in C# sources within this repository.
+
+# This script duplicates the fuctionality provided by the 'UpdateHeaders' target in Cake script present previously.
+# Since, Cake build has been removed, this fuctionality has been implimented here in this PowerShell script.
+
+[CmdletBinding()]
+Param(
+    [Alias("Verify")]
+    [switch]$DryRun,
+    [switch]$Clean
+)
+
+function Clear-BuildArtifacts {
+    if (Get-Command dotnet) {
+        Write-Host "Starting 'dotnet msbuild -t:Clean' to clean-up build outputs"
+        dotnet msbuild -noLogo -noAutoRsp -v:m -t:Clean
+    }
+    elseif (Get-Command msbuild) {
+        Write-Host "Starting 'msbuild -t:Clean' to clean-up build outputs"
+        msbuild -noLogo -noAutoRsp -v:m -t:Clean
+    }
+    elseif (Get-Command git) {
+        Write-Host "Starting 'git clean -Xdf' to clean-up build outputs"
+        git clean -Xdf
+    }
+    else {
+        Write-Warning "Can't find dotnet/msbuild/git to clean-up build outputs"
+    }
+}
+
+function Get-SourceFiles ([string]$Path, [string]$Extension) {
+    $fileType = $Extension.TrimStart('.')
+    $fileFilter = "*.$fileType"
+    $fileExcludes = "*.g.$fileType", "*.i.$fileType", "*TemporaryGeneratedFile*.$fileType"
+    $sourceFiles = Get-ChildItem -Path $Path -File -Recurse -Filter $fileFilter -Exclude $fileExcludes
+    return $sourceFiles.Where({ !($_.FullName.Contains("\bin\") -or $_.FullName.Contains("\obj\")) })
+}
+
+# Set Repot Root
+$repoRoot = Split-Path -Path $PSScriptRoot -Parent
+Push-Location $repoRoot
+
+# Clean-up Repository build outputs
+if ($Clean) {
+    Clear-BuildArtifacts
+}
+
+# Get C# source files recursively
+$sourceFiles = Get-SourceFiles -Path $repoRoot -Extension ".cs"
+
+Write-Host "Checking $($sourceFiles.Count) C# file header(s)"
+
+$hasMissing = $false
+foreach ($sourceFile in $sourceFiles) {
+
+    $oldContent = Get-Content $sourceFile -Raw | Out-String -NoNewline
+
+    if ($oldContent.Contains("// <auto-generated/>") -or $oldContent.Contains("// <auto-generated>")) {
+        continue
+    }
+
+    $headerFilePath = Join-Path $PSScriptRoot "header.txt"
+    $headerContent = Get-Content $headerFilePath -Raw | Out-String
+    $regexHeader = "^(//.*\r?\n)*\r?\n"
+    $newContent = $oldContent -replace $regexHeader,$headerContent | Out-String -NoNewline
+
+    if (-not ($newContent -eq $oldContent)) {
+        $sourceFilePath = [System.IO.Path]::GetRelativePath($repoRoot, $sourceFile.FullName)
+
+        if ($DryRun) {
+            Write-Warning "Wrong/missing file header in '$sourceFilePath'"
+            $hasMissing = $true
+        }
+        else {
+            Write-Host "Updating '$sourceFilePath' file header..."
+            Set-Content -Path $sourceFile -Value $newContent -NoNewline
+        }
+    }
+}
+
+if ($DryRun -and $hasMissing) {
+    Write-Error "Please run 'Update-Headers.ps1' to verify and add missing headers ins source files before commiting your changes."
+}
+else {
+    Write-Host "All $($sourceFiles.Count) C# file header(s) are up to date."
+}
+
+# Pop out of Repo Root
+Pop-Location