Initial setup with Azure Pipelines CI (#107)

Adds CI validation via Azure Dev Ops Pipelines.

Validation includes both static analysis validation (via PSScriptAnalyzer) and UT validation (via Pester).

Builds will automatically run when changes are merged into master, but must be
kicked off manually for PR's after code inspection has occurred.

Two "hacks" were added to tests that were consistently failing without the hack in ADO.
A separate issue will be opened to track identifying the proper fix for those tests.

Author: HowardWolosky

CONTRIBUTING.md

@@ -285,8 +285,7 @@ Set-GitHubConfiguration -LogRequestBody
 ----------
 
 ### Testing
-[![Build status](https://ci.appveyor.com/api/projects/status/vsfq8kxo2et2dn7i?svg=true
-)](https://ci.appveyor.com/project/HowardWolosky/powershellforgithub)
+[![Build status](https://dev.azure.com/ms/PowerShellForGitHub/_apis/build/status/PowerShellForGitHub-CI?branchName=master)](https://dev.azure.com/ms/PowerShellForGitHub/_build/latest?definitionId=109&branchName=master)
 
 #### Installing Pester
 This module supports testing using the [Pester UT framework](https://github.com/pester/Pester).
@@ -348,8 +347,7 @@ There are many more nuances to code-coverage, see
 [its documentation](https://github.com/pester/Pester/wiki/Code-Coverage) for more details.
 
 #### Automated Tests
-[![Build status](https://ci.appveyor.com/api/projects/status/vsfq8kxo2et2dn7i?svg=true
-)](https://ci.appveyor.com/project/HowardWolosky/powershellforgithub)
+[![Build status](https://dev.azure.com/ms/PowerShellForGitHub/_apis/build/status/PowerShellForGitHub-CI?branchName=master)](https://dev.azure.com/ms/PowerShellForGitHub/_build/latest?definitionId=109&branchName=master)
 
 These test are configured to automatically execute upon any update to the `master` branch
 on the `HowardWolosky` fork of `PowerShellForGitHub`.  (At this time, we don't have the proper

README.md

@@ -1,8 +1,7 @@
 # PowerShellForGitHub PowerShell Module
 
 [![[GitHub version]](https://badge.fury.io/gh/PowerShell%2FPowerShellForGitHub.svg)](https://badge.fury.io/gh/PowerShell%2FPowerShellForGitHub)
-[![Build status](https://ci.appveyor.com/api/projects/status/vsfq8kxo2et2dn7i?svg=true
-)](https://ci.appveyor.com/project/HowardWolosky/powershellforgithub)
+[![Build status](https://dev.azure.com/ms/PowerShellForGitHub/_apis/build/status/PowerShellForGitHub-CI?branchName=master)](https://dev.azure.com/ms/PowerShellForGitHub/_build/latest?definitionId=109&branchName=master)
 
 #### Table of Contents
 

Tests/Common.ps1

@@ -32,11 +32,11 @@ function Initialize-CommonTestSetup
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingConvertToSecureStringWithPlainText", "", Justification="Needed to configure with the stored, encrypted string value in AppVeyor.")]
     param()
 
-    $moduleRootPath = Split-Path -Parent (Split-Path -Parent $Script:MyInvocation.MyCommand.Path)
+    $moduleRootPath = Split-Path -Path $PSScriptRoot -Parent
     . (Join-Path -Path $moduleRootPath -ChildPath 'Tests\Config\Settings.ps1')
     Import-Module -Name (Join-Path -Path $moduleRootPath -ChildPath 'PowerShellForGitHub.psd1') -Force
 
-    if ([string]::IsNullOrEmpty($env:avAccessToken))
+    if ([string]::IsNullOrEmpty($env:ciAccessToken))
     {
         $message = @(
             'The tests are using the configuration settings defined in Tests\Config\Settings.ps1.',
@@ -48,14 +48,14 @@ function Initialize-CommonTestSetup
     }
     else
     {
-        $secureString = $env:avAccessToken | ConvertTo-SecureString -AsPlainText -Force
+        $secureString = $env:ciAccessToken | ConvertTo-SecureString -AsPlainText -Force
         $cred = New-Object System.Management.Automation.PSCredential "<username is ignored>", $secureString
         Set-GitHubAuthentication -Credential $cred
 
-        $script:ownerName = $env:avOwnerName
-        $script:organizationName = $env:avOrganizationName
+        $script:ownerName = $env:ciOwnerName
+        $script:organizationName = $env:ciOrganizationName
 
-        Write-Warning -Message 'This run is being executed in the AppVeyor environment.'
+        Write-Warning -Message 'This run is being executed in the Azure Dev Ops environment.'
     }
 
     $script:accessTokenConfigured = Test-GitHubAuthenticationConfigured

Tests/GitHubAnalytics.tests.ps1

@@ -242,9 +242,10 @@ try
     }
 
     Describe 'Getting repositories from organization' {
+        <# Temporary hack due to issues with this test in ADO #> . (Join-Path -Path $moduleRootPath -ChildPath 'Tests\Config\Settings.ps1')
+
         $original = Get-GitHubRepository -OrganizationName $script:organizationName
 
-        $repositoryName = [guid]::NewGuid().Guid
         $repo = New-GitHubRepository -RepositoryName ([guid]::NewGuid().Guid) -OrganizationName $script:organizationName
         $current = Get-GitHubRepository -OrganizationName $script:organizationName
 

Tests/GitHubRepositoryForks.tests.ps1

@@ -35,6 +35,8 @@ try
         $originalForks = Get-GitHubRepositoryFork -OwnerName Microsoft -RepositoryName PowerShellForGitHub
 
         Context 'When a new fork is created' {
+            <# Temporary hack due to issues with this test in ADO #> . (Join-Path -Path $moduleRootPath -ChildPath 'Tests\Config\Settings.ps1')
+
             $repo = New-GitHubRepositoryFork -OwnerName Microsoft -RepositoryName PowerShellForGitHub -OrganizationName $script:organizationName
             $newForks = Get-GitHubRepositoryFork -OwnerName Microsoft -RepositoryName PowerShellForGitHub -Sort Newest
 

appveyor.yml

@@ -0,0 +1,55 @@
+#
+# Continuous Integration (CI)
+# This pipeline validates the module for StaticAnalysis and Unit Test issues.
+#
+
+trigger:
+- master
+
+# Intionally not having the PR trigger, as we want to kick off PR validation manually after code inspection
+#pr:
+#- master
+
+pool:
+  vmImage: 'vs2017-win2016'
+
+steps:
+  - powershell: |
+      Install-Module -Name PSScriptAnalyzer -Repository PSGallery -Scope CurrentUser -AllowClobber -SkipPublisherCheck -Force -Verbose
+    displayName: 'Install PSScriptAnalyzer'
+
+  - powershell: |
+       $results = Invoke-ScriptAnalyzer -Path ./ –Recurse
+       $results | ForEach-Object { Write-Host "##vso[task.logissue type=$($_.Severity);sourcepath=$($_.ScriptPath);linenumber=$($_.Line);columnnumber=$($_.Column);]$($_.Message)" }
+    displayName: 'Run Static Code Analysis (PSScriptAnalyzer)'
+
+  - powershell: |
+      Install-Module -Name Pester -Repository PSGallery -Scope CurrentUser -AllowClobber -SkipPublisherCheck -Force -Verbose
+    displayName: 'Install Pester'
+
+  - powershell: |
+       Invoke-Pester -CodeCoverage .\*.ps*1 -CodeCoverageOutputFile ./coverage.xml -CodeCoverageOutputFileFormat JaCoCo -EnableExit -Strict -OutputFile ./test-results.xml -OutputFormat NUnitXml
+    workingDirectory: '$(System.DefaultWorkingDirectory)'
+    displayName: 'Run Unit Tests via Pester'
+    env:
+      ciAccessToken: $(GitHubAccessToken)
+      ciOwnerName: $(GitHubOwnerName)
+      ciOrganizatioName: $(GitHubOrganizationName)
+
+  - task: PublishTestResults@2
+    displayName: 'Publish Test Results'
+    inputs:
+      testRunTitle: 'Windows Test Results for Pester'
+      buildPlatform: 'Windows'
+      testRunner: NUnit
+      testResultsFiles: './test-results.xml'
+      failTaskOnFailedTests: true # required to fail build when tests fail
+    condition: succeededOrFailed()
+
+  - task: PublishCodeCoverageResults@1
+    displayName: 'Publish code coverage'
+    inputs:
+      codeCoverageTool: 'JaCoCo'
+      summaryFileLocation: './coverage.xml'
+      failIfCoverageEmpty: true
+    condition: and(succeededOrFailed(), eq(variables['System.PullRequest.IsFork'], false))