From 66cafa2bab53d91fcf5f910ef9424ada1ac6a2a5 Mon Sep 17 00:00:00 2001
From: Matt Richardson <matt.richardson@octopus.com>
Date: Sat, 18 Apr 2020 08:21:47 +1000
Subject: [PATCH] Improve logging when resources dont match (#253)

---
 .../cTentacleAgent/cTentacleAgent.psm1        | 19 ++++++++++++-------
 1 file changed, 12 insertions(+), 7 deletions(-)

diff --git a/OctopusDSC/DSCResources/cTentacleAgent/cTentacleAgent.psm1 b/OctopusDSC/DSCResources/cTentacleAgent/cTentacleAgent.psm1
index 4fb6ee3c1..c0a6e8c7c 100644
--- a/OctopusDSC/DSCResources/cTentacleAgent/cTentacleAgent.psm1
+++ b/OctopusDSC/DSCResources/cTentacleAgent/cTentacleAgent.psm1
@@ -562,7 +562,7 @@ function Test-TargetResource {
 
         if ($null -ne $machine) {
             if ($Environments.Count -ne $machine.EnvironmentIds.Count) {
-                Write-Verbose "Environment counts do not match, not in desired state."
+                Write-Verbose "Environments: [$Environments] vs [$machine.EnvironmentIds]: $false"
                 return $false
             } else {
                 foreach ($environmentId in $machine.EnvironmentIds) {
@@ -572,7 +572,7 @@ function Test-TargetResource {
                     }
                     $environment = Get-APIResult -ServerUrl $OctopusServerUrl -ApiKey $ApiKey -API $environmentUrl
                     if ($Environments -notcontains $environment.Name) {
-                        Write-Verbose "Machine currently has environment $($environment.Name), which is not listed in the passed in Environment list.  Machine is not in desired state."
+                        Write-Verbose "Environments: Machine currently has environment $($environment.Name), which is not listed in the passed in list [$Environments].  Machine is not in desired state."
                         return $false
                     }
                 }
@@ -582,32 +582,37 @@ function Test-TargetResource {
             $workerPoolMembership = Get-WorkerPoolMembership -ServerUrl $OctopusServerUrl -ApiKey $ApiKey -Thumbprint $tentacleThumbprint -SpaceId $spaceRef.Id
 
             if ($WorkerPools.Count -ne $workerPoolMembership.Count) {
-                Write-Verbose "Worker pool counts do not match, not in desired state."
+                Write-Verbose "Worker pools [$WorkerPools] vs [$workerPoolMembership] = $false"
                 return $false
             } else {
                 foreach ($workerPool in $workerPoolMembership) {
                     if ($WorkerPools -notcontains $workerPool.Name) {
-                        Write-Verbose "Worker pool membership is not in desired state."
+                        Write-Verbose "Worker pools: [$WorkerPools] vs [$workerPoolMembership] = $false"
                         return $false
                     }
                 }
             }
 
             if ($Roles.Count -ne $machine.Roles.Count) {
-                Write-Verbose "Role counts do not match, not in desired state."
+                Write-Verbose "Roles: [$Roles] vs [$($machine.Roles)]: $false"
                 return $false
             } else {
                 $differences = Compare-Object -ReferenceObject $Roles -DifferenceObject $machine.Roles
                 if ($null -ne $differences) {
-                    Write-Verbose "Tentacle roles do not match specified roles, not in desired state."
+                    Write-Verbose "Roles: [$Roles] vs [$($machine.Roles)]: $false"
                     return $false
                 }
             }
         } else {
-            Write-Verbose "Machine '$Name' is not registered in Space '$Space'"
+            if ([string]::IsNullOrEmpty($Space)) {
+                Write-Verbose "Machine '$Name' is not registered"
+            } else {
+                Write-Verbose "Machine '$Name' is not registered in Space '$Space'"
+            }
         }
     }
 
+    Write-Verbose "Everything looks to be in working order"
     return $true
 }