add location to MapValueSource invocations.

Author: RafeArnold

clikt/src/commonMain/kotlin/com/github/ajalt/clikt/sources/MapValueSource.kt

@@ -19,7 +19,8 @@ class MapValueSource(
     private val getKey: (Context, Option) -> String = ValueSource.getKey(joinSubcommands = "."),
 ) : ValueSource {
     override fun getValues(context: Context, option: Option): List<ValueSource.Invocation> {
-        return values[option.valueSourceKey ?: getKey(context, option)]
-            ?.let { ValueSource.Invocation.just(it) }.orEmpty()
+        val key = option.valueSourceKey ?: getKey(context, option)
+        return values[key]
+            ?.let { ValueSource.Invocation.just(value = it, location = key) }.orEmpty()
     }
 }

test/src/commonTest/kotlin/com/github/ajalt/clikt/sources/MapValueSourceTest.kt

@@ -7,9 +7,11 @@ import com.github.ajalt.clikt.core.subcommands
 import com.github.ajalt.clikt.parameters.options.Option
 import com.github.ajalt.clikt.parameters.options.flag
 import com.github.ajalt.clikt.parameters.options.option
+import com.github.ajalt.clikt.parameters.types.int
 import com.github.ajalt.clikt.sources.ValueSource.Invocation
 import com.github.ajalt.clikt.testing.TestCommand
 import com.github.ajalt.clikt.testing.defaultLocalization
+import com.github.ajalt.clikt.testing.formattedMessage
 import com.github.ajalt.clikt.testing.parse
 import io.kotest.assertions.throwables.shouldThrow
 import io.kotest.data.blocking.forAll
@@ -102,4 +104,34 @@ class MapValueSourceTest {
         }.message shouldBe defaultLocalization.invalidFlagValueInFile("")
     }
 
+    @Test
+    fun errorMessage() {
+        class C : TestCommand() {
+            @Suppress("unused")
+            val theInteger by option().int()
+
+            @Suppress("unused")
+            val theFlag by option(valueSourceKey = "that flag").flag()
+        }
+
+        shouldThrow<BadParameterValue> {
+            val valueSource = MapValueSource(mapOf("the-integer" to "foo"))
+            C().apply { configureContext { this.valueSource = valueSource } }.parse("")
+        }.formattedMessage shouldBe "invalid value for the-integer: foo is not a valid integer"
+
+        shouldThrow<BadParameterValue> {
+            val valueSource = MapValueSource(mapOf("that flag" to "foo"))
+            C().apply { configureContext { this.valueSource = valueSource } }.parse("")
+        }.formattedMessage shouldBe "invalid value for that flag: foo is not a valid boolean"
+
+        shouldThrow<BadParameterValue> {
+            val valueSource = MapValueSource(mapOf("A_THE_INTEGER" to "foo"), getKey = ValueSource.envvarKey())
+            C().apply {
+                configureContext {
+                    this.valueSource = valueSource
+                    this.autoEnvvarPrefix = "A"
+                }
+            }.parse("")
+        }.formattedMessage shouldBe "invalid value for A_THE_INTEGER: foo is not a valid integer"
+    }
 }

test/src/jvmTest/kotlin/com/github/ajalt/clikt/sources/PropertiesValueSourceTest.kt

@@ -1,5 +1,6 @@
 package com.github.ajalt.clikt.sources
 
+import com.github.ajalt.clikt.core.BadParameterValue
 import com.github.ajalt.clikt.core.InvalidFileFormat
 import com.github.ajalt.clikt.core.context
 import com.github.ajalt.clikt.core.subcommands
@@ -10,6 +11,7 @@ import com.github.ajalt.clikt.parameters.types.double
 import com.github.ajalt.clikt.parameters.types.float
 import com.github.ajalt.clikt.parameters.types.int
 import com.github.ajalt.clikt.testing.TestCommand
+import com.github.ajalt.clikt.testing.formattedMessage
 import com.github.ajalt.clikt.testing.parse
 import io.kotest.assertions.throwables.shouldThrow
 import io.kotest.data.blocking.forAll
@@ -19,6 +21,7 @@ import org.junit.Rule
 import org.junit.Test
 import org.junit.rules.TemporaryFolder
 import java.io.File
+import java.util.Properties
 
 class PropertiesValueSourceTest {
     @get:Rule
@@ -174,4 +177,36 @@ class PropertiesValueSourceTest {
 
         C().parse("")
     }
+
+    @Test
+    fun errorMessage() {
+        class C : TestCommand() {
+            @Suppress("unused")
+            val theInteger by option().int()
+
+            @Suppress("unused")
+            val theFlag by option(valueSourceKey = "that flag").flag()
+        }
+
+        shouldThrow<BadParameterValue> {
+            val valueSource = PropertiesValueSource.from(Properties().apply { setProperty("the-integer", "foo") })
+            C().apply { configureContext { this.valueSource = valueSource } }.parse("")
+        }.formattedMessage shouldBe "invalid value for the-integer: foo is not a valid integer"
+
+        shouldThrow<BadParameterValue> {
+            val valueSource = PropertiesValueSource.from(Properties().apply { setProperty("that flag", "foo") })
+            C().apply { configureContext { this.valueSource = valueSource } }.parse("")
+        }.formattedMessage shouldBe "invalid value for that flag: foo is not a valid boolean"
+
+        shouldThrow<BadParameterValue> {
+            val properties = Properties().apply { setProperty("A_THE_INTEGER", "foo") }
+            val valueSource = PropertiesValueSource.from(properties, getKey = ValueSource.envvarKey())
+            C().apply {
+                configureContext {
+                    this.valueSource = valueSource
+                    this.autoEnvvarPrefix = "A"
+                }
+            }.parse("")
+        }.formattedMessage shouldBe "invalid value for A_THE_INTEGER: foo is not a valid integer"
+    }
 }