Merge pull request #3809 from vexx32/3802-fix-agent-config-read-loop

(#3802) Avoid unnecessary writes to the config file

Author: AdmiringWorm

src/chocolatey/infrastructure.app/builders/ConfigurationBuilder.cs

@@ -150,6 +150,23 @@ private static void AddOrRemoveLicensedSource(ChocolateyLicense license, ConfigF
                 var existingSource = configFileSettings.Sources?.FirstOrDefault(s => s.Id.IsEqualTo(ApplicationParameters.ChocolateyLicensedFeedSourceName));
                 if (existingSource != null)
                 {
+                    // Avoid making any changes since everything is correct and return.
+                    // This avoids making unnecessary updates to the chocolatey.config file.
+                    // A direct Equals isn't possible because we do want to allow users to change it being
+                    // Disabled or not, and we do have to check the decrypted password value, as the
+                    // encrypted strings are not the same every time they're generated.
+                    if (existingSource.Id == configSource.Id
+                        && existingSource.Value == configSource.Value
+                        && existingSource.UserName == configSource.UserName
+                        && NugetEncryptionUtility.DecryptString(existingSource.Password) == license.Id
+                        && existingSource.Priority == configSource.Priority
+                        && existingSource.BypassProxy == configSource.BypassProxy
+                        && existingSource.AllowSelfService == configSource.AllowSelfService
+                        && existingSource.VisibleToAdminsOnly == configSource.VisibleToAdminsOnly)
+                    {
+                        return;
+                    }
+
                     // Ensure we retain whether the licensed source is disabled.
                     configSource.Disabled = existingSource.Disabled;
 

tests/pester-tests/chocolatey.Tests.ps1

@@ -280,6 +280,30 @@ exit $error.count
         }
     }
 
+    # This is skipped when not run in CI because it requires a valid license
+    Context 'Config file updates when a valid license is present' -Tag License -Skip:(-not $env:TEST_KITCHEN) {
+        BeforeAll {
+            Restore-ChocolateyInstallSnapshot
+
+            Enable-ChocolateySource -Name hermes-setup
+
+            Invoke-Choco install chocolatey-license-business
+
+            # Run once post-license-install to ensure the config file is updated with the licensed source
+            $null = Invoke-Choco list
+        }
+
+        It 'does not overwrite the config file when nothing has changed' {
+            $originalHash = Get-FileHash -Path "$env:ChocolateyInstall/config/chocolatey.config"
+
+            $null = Invoke-Choco list
+
+            $newHash = Get-FileHash -Path "$env:ChocolateyInstall/config/chocolatey.config"
+
+            $originalHash.Hash | Should -BeExactly $newHash.Hash -Because 'the configuration file should not have changed between runs'
+        }
+    }
+
     # This is skipped when not run in CI because it requires a valid license
     Context 'Changing licenses after modifying the Chocolatey Licensed repository' -Tag License -Skip:(-not $env:TEST_KITCHEN) {
         BeforeAll {