Move classes from PowerShell to C#

.build/CredScanTask.md

@@ -0,0 +1,71 @@
+# Credential Scanner (CredScan) in the Build
+
+This repository uses the so called [CredScan created by Microsoft](https://secdevtools.azurewebsites.net/helpcredscan.html#collapseOne) to prevent passwords being added to the master branch.
+
+To not even commit credentials to the repository you can download and install a [Visual Studio extension](https://marketplace.visualstudio.com/items?itemName=VSIDEDevOpsMSFT.ContinuousDeliveryToolsforVisualStudio&ssr=false#overview). Unfortunately, no VS Code extension is available yet.
+
+## Unit tests
+
+When writing unit tests fake passwords have to be used sometimes.
+To prevent CredScan to mix up fake passwords with real ones, a suppression file is used.
+
+There are several passwords defined, that can be used:
+
+If you write a unit test, which needs a fake password please include this in the suppression file for CredScan.
+
+**Note**: This only applies for unit tests and documentation, but not for the module itself.
+
+## How suppressions work
+
+The following documentation is taken from [the official CredScan](https://secdevtools.azurewebsites.net/helpcredscan.html) page.
+
+### Suppress all occurrences of a given secret within the specified path
+
+The hash key of the secret from the CredScan output file is required as shown in the sample below
+
+```json
+{
+  "tool": "Credential Scanner",
+  "suppressions": [
+    {
+      "hash": "CLgYxl2FcQE8XZgha9/UbKLTkJkUh3Vakkxh2CAdhtY=",
+      "_justification": "Secret used by MSDN sample, it is fake."
+    }
+  ]
+}
+```
+
+**Warning:** The hash key is generated by a portion of the matching value or file content. Any source code revision could change the hash key and disable the suppression rule.
+
+### To suppress all secrets in a specified file (or to suppress the secrets file itself)
+
+The file expression could be a file name or any postfix portion of the full file path/name. Wildcards are not supported.
+
+#### Example
+
+File to be suppressed: [InputPath]\src\JS\lib\angular.js
+Valid Suppression Rules:
+
+- [InputPath]\src\JS\lib\angular.js -- suppress the file in the specified path
+- \src\JS\lib\angular.js
+- \JS\lib\angular.js
+- \lib\angular.js
+- angular.js -- suppress any file with the same name
+
+```json
+{
+  "tool": "Credential Scanner",
+  "suppressions": [
+    {
+      "file": "\\files\\AdditonalSearcher.xml",
+      "_justification": "Additional CredScan searcher specific to my team"
+    },
+    {
+      "file": "\\files\\unittest.pfx",
+      "_justification": "Legitimate UT certificate file with private key"
+    }
+  ]
+}
+```
+
+**Warning:** All future secrets added to the file will also get suppressed automatically.

build/credscan-supression.json → .build/credscan-supression.json

@@ -28,6 +28,10 @@
       {
          "file": "buildDefyaml.json",
          "_justification": "Fake credentials only used for unit tests."
+      },
+      {
+         "file": "Get-BuildDefinition_AzD.json",
+         "_justification": "Redacted credentials only used for unit tests."
       }
    ]
 }

build/integrationTests.yml → .build/integrationTests.yml

@@ -24,6 +24,10 @@ jobs:
       runOnce:
         deploy:
           steps:
+            - download: current
+              displayName: 'Download tests'
+              artifact: test
+
             - task: AzureResourceGroupDeployment@2
               displayName: 'Start TFS 2017'
               inputs:
@@ -40,19 +44,20 @@ jobs:
                 resourceGroupName: WinBldBox
               condition: and(succeeded(), eq('${{ parameters.start2018 }}', 'true'))
 
+            - task: NuGetAuthenticate@0
+              inputs:
+                nuGetServiceConnections: 'Azure Artifacts'
+
             - task: PowerShell@2
               displayName: 'Register Private Repository'
               inputs:
                 targetType: 'inline'
                 script: |
                   $n = 'LoECDA'
-                  $e = "$(EMAIL)"
                   $url = "$(REPO_URL)"
-                  $pwd = ConvertTo-SecureString "$(PKG_PAT)" -AsPlainText -Force
-                  $creds = New-Object PSCredential($e, $pwd)
 
                   if(-not (Get-PSRepository | Where-Object Name -eq $n)) {
-                      Register-PSRepository -Credential $creds -Name $n -SourceLocation $url -InstallationPolicy Trusted -Verbose
+                      Register-PSRepository -Name $n -SourceLocation $url -InstallationPolicy Trusted -Verbose
                   }
 
                   Get-PSRepository
@@ -74,7 +79,7 @@ jobs:
                   Get-PSRepository
 
                   Install-Module -Name VSTeam -Repository $n -Credential $creds -MaximumVersion $b -MinimumVersion $b -Force -Scope CurrentUser -Verbose
-                workingDirectory: '$(Pipeline.Workspace)/Test'
+                workingDirectory: '$(Pipeline.Workspace)/test'
 
             - task: PowerShell@2
               displayName: 'Install Pester'
@@ -106,14 +111,14 @@ jobs:
 
                   Invoke-Pester -Configuration $pesterArgs
                 failOnStderr: true
-                workingDirectory: '$(Pipeline.Workspace)/Test/integration'
+                workingDirectory: '$(Pipeline.Workspace)/test/Tests'
 
             - task: PublishTestResults@2
               displayName: 'Publish Test Results'
               inputs:
                 testResultsFormat: NUnit
                 testResultsFiles: '**/test-results.xml'
-                searchFolder: '$(Pipeline.Workspace)/Test/integration'
+                searchFolder: '$(Pipeline.Workspace)/test'
                 testRunTitle: '${{ parameters.os }} Tests'
               continueOnError: true
               condition: succeededOrFailed()

build/unitTests.yml → .build/unitTests.yml

@@ -7,32 +7,48 @@ steps:
 - task: PowerShell@2
   displayName: 'Build Module'
   inputs:
+    pwsh: true
     targetType: 'inline'
     ${{ if eq(parameters.buildHelp, 'false') }}:
-      script: '.\Build-Module.ps1 -installDep'
+      script: '.\Build-Module.ps1 -installDep -configuration Release'
     ${{ if eq(parameters.buildHelp, 'true') }}:
-      script: '.\Build-Module.ps1 -installDep -buildHelp'
+      script: '.\Build-Module.ps1 -installDep -buildHelp -configuration Release'
+
+- ${{ if eq(parameters.os, 'Windows') }}:
+  - task: DotNetCoreCLI@2
+    displayName: 'Run C# Unit Tests with code coverage'
+    inputs:
+      command: 'test'
+      arguments: '--collect:"Code Coverage"'
+
+- ${{ if ne(parameters.os, 'Windows') }}:
+  - task: DotNetCoreCLI@2
+    displayName: 'Run C# Unit Tests'
+    inputs:
+      command: 'test'
 
 - task: PowerShell@2
   displayName: 'Install Pester'
   inputs:
+    pwsh: true
     targetType: 'inline'
     script: 'Install-Module -Name Pester -Repository PSGallery -Force -AllowPrerelease -MinimumVersion "$(PESTER_VERSION)" -Scope CurrentUser -AllowClobber -SkipPublisherCheck'
 
 - ${{ if eq(parameters.CodeCoverage, 'false') }}:
   - task: PowerShell@2
-    displayName: 'Run Unit Tests'
+    displayName: 'Run PowerShell Unit Tests'
     inputs:
+      pwsh: true
       targetType: 'inline'
       script: |
         Import-Module .\dist\*.psd1
         # This loads [PesterConfiguration] into scope
         Import-Module Pester
         $pesterArgs = [PesterConfiguration]::Default
         $pesterArgs.Run.Exit = $true
-        $pesterArgs.Run.Path = '.\unit'
+        $pesterArgs.Run.Path = './Tests/function'
         $pesterArgs.Run.PassThru = $false
-        $pesterArgs.Output.Verbosity = "Detailed"
+        $pesterArgs.Output.Verbosity = "Normal"
         $pesterArgs.TestResult.Enabled = $true
         $pesterArgs.TestResult.OutputPath = 'test-results.xml'
 
@@ -41,18 +57,19 @@ steps:
 
 - ${{ if eq(parameters.CodeCoverage, 'true') }}:
   - task: PowerShell@2
-    displayName: 'Run Unit Tests'
+    displayName: 'Run PowerShell Unit Tests'
     inputs:
+      pwsh: true
       targetType: 'inline'
       script: |
         Import-Module .\dist\*.psd1
         # This loads [PesterConfiguration] into scope
         Import-Module Pester
         $pesterArgs = [PesterConfiguration]::Default
         $pesterArgs.Run.Exit = $true
-        $pesterArgs.Run.Path = '.\unit'
+        $pesterArgs.Run.Path = './Tests/function'
         $pesterArgs.Run.PassThru = $false
-        $pesterArgs.Output.Verbosity = "Detailed"
+        $pesterArgs.Output.Verbosity = "Normal"
         $pesterArgs.TestResult.Enabled = $true
         $pesterArgs.TestResult.OutputPath = 'test-results.xml'
 
@@ -64,15 +81,16 @@ steps:
     displayName: 'Run Unit Tests with Code Coverage'
     inputs:
       targetType: 'inline'
+      pwsh: true
       script: |
         Import-Module .\dist\*.psd1
         # This loads [PesterConfiguration] into scope
         Import-Module Pester
         $pesterArgs = [PesterConfiguration]::Default
         $pesterArgs.Run.Exit = $true
-        $pesterArgs.Run.Path = '.\unit'
+        $pesterArgs.Run.Path = './Tests/function'
         $pesterArgs.Run.PassThru = $false
-        $pesterArgs.Output.Verbosity = "Detailed"
+        $pesterArgs.Output.Verbosity = "Normal"
         $pesterArgs.TestResult.Enabled = $true
         $pesterArgs.TestResult.OutputPath = 'test-results.xml'
         $pesterArgs.CodeCoverage.Enabled = $true
@@ -88,7 +106,7 @@ steps:
     displayName: 'Publish code coverage'
     inputs:
       summaryFileLocation: '**\coverage.xml'
-      failIfCoverageEmpty: true
+      failIfCoverageEmpty: false
     condition: and(succeededOrFailed(), eq(variables['System.PullRequest.IsFork'], false))
 
 - task: PublishTestResults@2

.docs/Add-VSTeam.md

@@ -14,19 +14,26 @@
 
 ## EXAMPLES
 
-## PARAMETERS
+### Example 1: Add a team
 
-<!-- #include "./params/projectName.md" -->
+```powershell
+Add-VSTeam -ProjectName Scrum -Name 'Testing'
+```
 
-### -Description
+This command adds a team named 'Testing' to the project named 'Scrum'.
 
-The description of the team.
+### Example 2: Add a team with description
 
-```yaml
-Type: String
-Position: 1
+```powershell
+Add-VSTeam 'Scrum' 'Testing2' 'Test team'
 ```
 
+This command adds a team named 'Testing2' with description 'Test team' to the project named 'Scrum'.
+
+## PARAMETERS
+
+<!-- #include "./params/projectName.md" -->
+
 ### -Name
 
 The name of the team
@@ -38,18 +45,31 @@ Required: True
 Position: 1
 ```
 
+### -Description
+
+The description of the team.
+
+```yaml
+Type: String
+Position: 2
+```
+
 ## INPUTS
 
 ## OUTPUTS
 
 ## NOTES
 
+<!-- #include "./common/prerequisites.md" -->
+
 ## RELATED LINKS
 
+<!-- #include "./common/related.md" -->
+
 [Get-VSTeam](Get-VSTeam.md)
 
 [Remove-VSTeam](Remove-VSTeam.md)
 
 [Show-VSTeam](Show-VSTeam.md)
 
-[Update-VSTeam](pda-VSTeam.md)
+[Update-VSTeam](Update-VSTeam.md)

.docs/Add-VSTeamAccessControlEntry.md

@@ -22,10 +22,11 @@
 
 ### -SecurityNamespace
 
-Security namespace identifier.
+Security namespace object.
 
 ```yaml
-Type: VSTeamSecurityNamespace
+Type: vsteam_lib.SecurityNamespace
+Parameter Sets: ByNamespace
 Required: True
 ```
 
@@ -35,6 +36,7 @@ Security namespace identifier.
 
 ```yaml
 Type: String
+Parameter Sets: ByNamespaceId
 Required: True
 ```
 
@@ -69,8 +71,14 @@ Required: True
 
 ## OUTPUTS
 
-### VSTeamAccessControlEntry
+### vsteam_lib.AccessControlEntry
 
 ## NOTES
 
+This is a low-level function. You should really use a high level function (Add-VSTeam...Permission / Set-VSTeam...Permission / Get-VSTeam...Permission) unless you know what you are doing.
+
+<!-- #include "./common/prerequisites.md" -->
+
 ## RELATED LINKS
+
+<!-- #include "./common/related.md" -->

.docs/Add-VSTeamArea.md

@@ -10,17 +10,17 @@
 
 ## EXAMPLES
 
-### -------------------------- EXAMPLE 1 --------------------------
+### Example 1
 
-```PowerShell
+```powershell
 PS C:\> Add-VSTeamArea -ProjectName Demo -Name "NewArea" -Path "MyArea/Path"
 ```
 
 This command adds a new area named NewArea to the Demo project under the area path MyArea/Path.
 
-### -------------------------- EXAMPLE 2 --------------------------
+### Example 2
 
-```PowerShell
+```powershell
 PS C:\> Add-VSTeamArea -ProjectName Demo -Name "NewArea"
 ```
 
@@ -60,8 +60,12 @@ Type: string
 
 This function is a wrapper of the base function Add-VSTeamClassificationNode.
 
+<!-- #include "./common/prerequisites.md" -->
+
 ## RELATED LINKS
 
+<!-- #include "./common/related.md" -->
+
 [Add-VSTeamClassificationNode](Add-VSTeamClassificationNode.md)
 
 [Add-VSTeamIteration](Add-VSTeamIteration.md)