[Build, IGS] Specify the used value in the case of a property override

#KTI-1223 In Progress

repo/gradle-settings-conventions/internal-gradle-setup/src/main/kotlin/LocalPropertiesModifier.kt

@@ -53,7 +53,14 @@ internal class LocalPropertiesModifier(private val localProperties: File) {
                 load(it)
             }
         }
-        val propertiesToSetup = setupFile.properties.mapValues { PropertyValue(it.value, manuallyConfiguredProperties.containsKey(it.key)) }
+        val propertiesToSetup = setupFile.properties.mapValues {
+            val overridingValue = manuallyConfiguredProperties[it.key]
+            if (overridingValue != null) {
+                PropertyValue.Overridden(it.value, overridingValue.toString())
+            } else {
+                PropertyValue.Configured(it.value)
+            }
+        }
         localProperties.writeText(
             """
             |${content.addSuffix("\n")}
@@ -75,17 +82,18 @@ private fun String.addSuffix(suffix: String): String {
     return "$this$suffix"
 }
 
-internal data class PropertyValue(
+internal sealed class PropertyValue(
     val value: String,
-    val isOverridden: Boolean = false,
+) {
-)
+    class Configured(value: String) : PropertyValue(value)
+
+    class Overridden(value: String, val overridingValue: String) : PropertyValue(value)
+}
 
 internal val Map<String, PropertyValue>.asPropertiesLines: String
-    get() = map { (key, value) ->
+    get() = map { (key, valueWrapper) ->
-        when (value.isOverridden) {
+        when (valueWrapper) {
-            true -> """
+            is PropertyValue.Overridden -> "#$key=${valueWrapper.value} the property is overridden by '${valueWrapper.overridingValue}'"
-                #$key=${value.value} the property is overridden
+            is PropertyValue.Configured -> "$key=${valueWrapper.value}"
-            """.trimIndent()
-            false -> "$key=${value.value}"
         }
     }.joinToString("\n")

repo/gradle-settings-conventions/internal-gradle-setup/src/test/kotlin/LocalPropertiesModifierTest.kt

@@ -87,8 +87,8 @@ class LocalPropertiesModifierTest {
     @DisplayName("sync shouldn't remove any existing properties not managed by the sync")
     fun testSyncingIntoNonEmptyFile() {
         val initialContent = mapOf(
-            "oldProperty1" to PropertyValue("oldValue1"),
+            "oldProperty1" to PropertyValue.Configured("oldValue1"),
-            "oldProperty2" to PropertyValue("oldValue2"),
+            "oldProperty2" to PropertyValue.Configured("oldValue2"),
         )
         fillInitialLocalPropertiesFile(initialContent)
 
@@ -125,9 +125,9 @@ class LocalPropertiesModifierTest {
     @DisplayName("sync shouldn't override properties if they already manually set")
     fun testSyncingDoesNotOverrideValues() {
         val initialContent = mapOf(
-            "oldProperty1" to PropertyValue("oldValue1"),
+            "oldProperty1" to PropertyValue.Configured("oldValue1"),
-            "oldProperty2" to PropertyValue("oldValue2"),
+            "oldProperty2" to PropertyValue.Configured("oldValue2"),
-            "alreadySetProperty" to PropertyValue("oldValue3"),
+            "alreadySetProperty" to PropertyValue.Configured("oldValue3"),
         )
         fillInitialLocalPropertiesFile(initialContent)
 
@@ -140,6 +140,7 @@ class LocalPropertiesModifierTest {
             for ((key, value) in expectedProperties) {
                 assertEquals(value, properties[key])
             }
+            assertContainsExactTimes(fileContents, "#alreadySetProperty=newValue the property is overridden by 'oldValue3'", 1)
         }
     }
 
@@ -169,17 +170,17 @@ class LocalPropertiesModifierTest {
     @DisplayName("sync should override automatically set properties")
     fun testSyncingOverrideAutomaticallySetValues() {
         val initialContent = mapOf(
-            "oldProperty1" to PropertyValue("oldValue1"),
+            "oldProperty1" to PropertyValue.Configured("oldValue1"),
-            "oldProperty2" to PropertyValue("oldValue2"),
+            "oldProperty2" to PropertyValue.Configured("oldValue2"),
-            "alreadySetProperty" to PropertyValue("oldValue3"),
+            "alreadySetProperty" to PropertyValue.Configured("oldValue3"),
         )
         fillInitialLocalPropertiesFile(initialContent)
 
         modifier.applySetup(setupFile)
 
         val newProperties = mapOf(
-            "newManualProperty" to PropertyValue("5"),
+            "newManualProperty" to PropertyValue.Configured("5"),
-            "otherAlreadySetProperty" to PropertyValue("5"),
+            "otherAlreadySetProperty" to PropertyValue.Configured("5"),
         )
         fillInitialLocalPropertiesFile(newProperties)