Merge pull request #15 from pspete/issue-14

Get-AIMCredential

CHANGELOG.md

@@ -1,5 +1,10 @@
 # CredentialRetriever Changelog
 
+## 3.5.22 (April 10th 2020)
+
+- Fix `Get-AIMCredential`
+  - Resolves error when returning passwords containing a comma character.
+
 ## 3.4.19 (March 27th 2020)
 
 - Changed minimum required PowerShell version to 5.1

CredentialRetriever/Functions/Get-AIMCredential.ps1

@@ -195,6 +195,10 @@ Function Get-AIMCredential {
 		[array]$ReturnProps = @()
 		#Hashtable to hold the Results to Output
 		[hashtable]$Output = @{ }
+		#Delimiter for separating the output fields
+		$Separator = "#_-_#"
+		#Set StringSplitOption
+		$RemoveEmptyEntries = [System.StringSplitOptions]::RemoveEmptyEntries
 
 	}
 
@@ -203,8 +207,6 @@ Function Get-AIMCredential {
 		#Initial Command String
 		$Command = "/p AppDescs.AppID=`"$AppID`""
 
-		Write-Debug $Command
-
 		#Build array of query string properties
 		$PSBoundParameters.Add("Query", @())
 		$QueryParameters | ForEach-Object {
@@ -265,8 +267,7 @@ Function Get-AIMCredential {
 		$ReturnProps = $ReturnProps -join ","
 
 		#Build Command String
-		$Command = "$Command /o $ReturnProps"
-		Write-Debug $Command
+		$Command = "$Command /o $ReturnProps /d $Separator"
 
 		#Add Required CommandParameters to $PSBoundParameters for Splat against Invoke-AIMClient
 		$PSBoundParameters.Add("CommandParameters", "$Command")
@@ -278,13 +279,13 @@ Function Get-AIMCredential {
 		#Output on StdOut
 		If ($Result.StdOut) {
 
-			#split returned results
-			$Results = ($Result.StdOut).Split(",")
+			#split returned results at Separator
+			$Results = ($Result.StdOut).Split($Separator, $RemoveEmptyEntries)
 
 			#use $returnProps to determine propertynames
 			$ReturnProps = $ReturnProps.Split(",")
 
-			For ($i = 0 ; $i -lt $Results.length ; $i++) {
+			For ($i = 0 ; $i -lt $ReturnProps.length ; $i++) {
 
 				#PropertyName=PropertyValue
 				$Output[$(($ReturnProps[$i]) -replace "PassProps.", "")] = ($Results[$i]).trim()

CredentialRetriever/Private/Invoke-AIMClient.ps1

@@ -66,9 +66,6 @@
 
 	Begin {
 
-		$CallStack = $((Get-PSCallStack).Command)[1]
-		Write-Debug "Origin: $CallStack"
-
 		Try {
 
 			Get-Variable -Name AIM -ErrorAction Stop

appveyor.yml

@@ -1,5 +1,5 @@
 # version format
-version: 3.4.{build}
+version: 3.5.{build}
 
 environment:
   #GIT_TRACE: 1

tests/Get-AIMCredential.Tests.ps1

@@ -30,7 +30,7 @@ InModuleScope $ModuleName {
 			Mock Invoke-AIMClient -MockWith {
 				[pscustomobject]@{
 					"ExitCode" = 0
-					"StdOut"   = "SomeUser,value2,value3,value4,SomePassword,true"
+					"StdOut"   = "SomeUser#_-_#value2#_-_#value3#_-_#value4#_-_#SomePassword#_-_#true"
 					"StdErr"   = $null
 				}
 			}
@@ -82,6 +82,18 @@ InModuleScope $ModuleName {
 			($result.ToCredential()).GetNetworkCredential().Password | Should Be "SomePassword"
 		}
 
+		It "outputs expected password containing comma" {
+			Mock Invoke-AIMClient -MockWith {
+				[pscustomobject]@{
+					"ExitCode" = 0
+					"StdOut"   = "SomeUser#_-_#value2#_-_#value3#_-_#value4#_-_#Some,Password#_-_#true"
+					"StdErr"   = $null
+				}
+			}
+			$result = $InputObj | Get-AIMCredential
+			$result.Password | Should Be "Some,Password"
+		}
+
 	}
 
 }