Enhance integration test script with detailed logging

- Added environment information output including OS and PowerShell version.
- Improved directory comparison logging to show normalized paths and contents.
- Enhanced error handling with detailed messages during test execution.
- Updated test execution logging for better clarity on test progress.

These changes improve the visibility and traceability of the integration tests, making it easier to diagnose issues and understand the test flow.

Author: andrzej-janczak

integration-tests/run.ps1

@@ -5,8 +5,13 @@ $ErrorActionPreference = "Stop"
 $SCRIPT_DIR = Split-Path -Parent $MyInvocation.MyCommand.Path
 $CLI_PATH = Join-Path (Get-Location) "cli-v2.exe"
 
+Write-Host "=== Environment Information ==="
 Write-Host "Script directory: $SCRIPT_DIR"
 Write-Host "Current working directory: $(Get-Location)"
+Write-Host "CLI Path: $CLI_PATH"
+Write-Host "OS: $([System.Environment]::OSVersion.Platform)"
+Write-Host "PowerShell Version: $($PSVersionTable.PSVersion)"
+Write-Host "==============================`n"
 
 # Check if API token is provided for token-based test
 if (-not $env:CODACY_API_TOKEN) {
@@ -17,6 +22,7 @@ if (-not $env:CODACY_API_TOKEN) {
 function Normalize-Config {
     param ([string]$file)
 
+    Write-Host "Normalizing config file: $file"
     $ext = [System.IO.Path]::GetExtension($file).TrimStart('.')
 
     switch ($ext) {
@@ -79,16 +85,50 @@ function Compare-Files {
         [string]$label
     )
 
+    Write-Host "`n=== Starting Directory Comparison ==="
+    Write-Host "Comparing directories:"
+    Write-Host "Expected dir: $expectedDir"
+    Write-Host "Actual dir: $actualDir"
+    Write-Host "Label: $label"
+    
+    # Normalize paths to use the current OS's path separator
+    $expectedDir = $expectedDir.Replace('/', [System.IO.Path]::DirectorySeparatorChar).Replace('\', [System.IO.Path]::DirectorySeparatorChar)
+    $actualDir = $actualDir.Replace('/', [System.IO.Path]::DirectorySeparatorChar).Replace('\', [System.IO.Path]::DirectorySeparatorChar)
+    
+    Write-Host "Normalized paths:"
+    Write-Host "Expected dir (normalized): $expectedDir"
+    Write-Host "Actual dir (normalized): $actualDir"
+    
+    # List directory contents before comparison
+    Write-Host "`nExpected directory contents:"
+    Get-ChildItem -Path $expectedDir -Recurse | ForEach-Object {
+        Write-Host "  $($_.FullName.Replace($expectedDir, ''))"
+    }
+    
+    Write-Host "`nActual directory contents:"
+    Get-ChildItem -Path $actualDir -Recurse | ForEach-Object {
+        Write-Host "  $($_.FullName.Replace($actualDir, ''))"
+    }
+    
     # Compare files
     Get-ChildItem -Path $expectedDir -File | ForEach-Object {
         $actualFile = Join-Path $actualDir $_.Name
+        Write-Host "`nChecking file: $($_.Name)"
+        Write-Host "Expected file: $($_.FullName)"
+        Write-Host "Actual file: $actualFile"
+        
         if (-not (Test-Path $actualFile)) {
             Write-Host "❌ $label/$($_.Name) does not exist in actual output"
             Write-Host "Expected: $($_.FullName)"
             Write-Host "Actual should be: $actualFile"
+            Write-Host "Current directory structure:"
+            Get-ChildItem -Path $actualDir -Recurse | ForEach-Object {
+                Write-Host "  $($_.FullName)"
+            }
             exit 1
         }
 
+        Write-Host "Comparing file contents..."
         $expectedContent = Normalize-Config $_.FullName
         $actualContent = Normalize-Config $actualFile
 
@@ -111,15 +151,24 @@ function Compare-Files {
     # Compare subdirectories
     Get-ChildItem -Path $expectedDir -Directory | Where-Object { $_.Name -ne "logs" } | ForEach-Object {
         $actualSubDir = Join-Path $actualDir $_.Name
+        Write-Host "`nChecking subdirectory: $($_.Name)"
+        Write-Host "Expected dir: $($_.FullName)"
+        Write-Host "Actual dir: $actualSubDir"
 
         if (-not (Test-Path $actualSubDir)) {
             Write-Host "❌ Directory $label/$($_.Name) does not exist in actual output"
             Write-Host "Expected: $($_.FullName)"
             Write-Host "Actual should be: $actualSubDir"
+            Write-Host "Current directory structure:"
+            Get-ChildItem -Path $actualDir -Recurse | ForEach-Object {
+                Write-Host "  $($_.FullName)"
+            }
             exit 1
         }
         Compare-Files $_.FullName $actualSubDir "$label/$($_.Name)"
     }
+    
+    Write-Host "`n=== Directory Comparison Complete ==="
 }
 
 function Run-InitTest {
@@ -129,41 +178,64 @@ function Run-InitTest {
         [bool]$useToken
     )
 
-    Write-Host "Running test: $testName"
+    Write-Host "`n=== Running Test: $testName ==="
+    Write-Host "Test directory: $testDir"
+    Write-Host "Using token: $useToken"
+    
     if (-not (Test-Path $testDir)) {
         Write-Host "❌ Test directory does not exist: $testDir"
         exit 1
     }
 
     $originalLocation = Get-Location
     try {
+        Write-Host "Changing to test directory: $testDir"
         Set-Location $testDir
-        if (Test-Path ".codacy") { Remove-Item -Recurse -Force ".codacy" }
+        Write-Host "Current location: $(Get-Location)"
+        
+        if (Test-Path ".codacy") {
+            Write-Host "Removing existing .codacy directory"
+            Remove-Item -Recurse -Force ".codacy"
+        }
 
         if ($useToken) {
             if (-not $env:CODACY_API_TOKEN) {
                 Write-Host "❌ Skipping token-based test: CODACY_API_TOKEN not set"
                 return
             }
+            Write-Host "Running CLI with token..."
             & $CLI_PATH init --api-token $env:CODACY_API_TOKEN --organization troubleshoot-codacy-dev --provider gh --repository codacy-cli-test
         } else {
+            Write-Host "Running CLI without token..."
             & $CLI_PATH init
         }
 
+        Write-Host "`nVerifying directory structure after CLI execution:"
+        Get-ChildItem -Recurse | ForEach-Object {
+            Write-Host "  $($_.FullName)"
+        }
+        
         Compare-Files "expected" ".codacy" "Test $testName"
         Write-Host "✅ Test $testName completed successfully"
         Write-Host "----------------------------------------"
     }
+    catch {
+        Write-Host "❌ Error during test execution:"
+        Write-Host $_.Exception.Message
+        Write-Host $_.ScriptStackTrace
+        exit 1
+    }
     finally {
+        Write-Host "Returning to original location: $originalLocation"
         Set-Location $originalLocation
     }
 }
 
 # Run tests
-Write-Host "Starting integration tests..."
+Write-Host "`n=== Starting Integration Tests ==="
 Write-Host "----------------------------------------"
 
 Run-InitTest (Join-Path $SCRIPT_DIR "init-without-token") "init-without-token" $false
 Run-InitTest (Join-Path $SCRIPT_DIR "init-with-token") "init-with-token" $true
 
-Write-Host "All tests completed successfully! 🎉" 
+Write-Host "`nAll tests completed successfully! 🎉"