Testing commandline seemed to be not working

[khmarbaise]

I have implemented a simple command which uses acceptsValueWithoutName = true:

package com.soebes.kotlin.commands

import com.github.ajalt.clikt.core.CliktCommand
import com.github.ajalt.clikt.parameters.options.option
import com.github.ajalt.clikt.parameters.types.int
import org.kodein.di.Kodein
import org.kodein.di.generic.bind
import org.kodein.di.generic.inSet
import org.kodein.di.generic.provider

class Log : CliktCommand(printHelpOnEmptyArgs = true, help = """
    Log information from the repository
    """) {

    val numberOfEntries by option("-n", metavar = "number", help = "Number of entries which will be shown.")
        .int(acceptsValueWithoutName = true)

    override fun run() {
        echo("Logging with $numberOfEntries")
    }
}

val logModule = Kodein.Module("log") {
    bind<CliktCommand>().inSet() with provider { Log() }
}

my Main.kt looks like this:

package com.soebes.kotlin.git

import com.github.ajalt.clikt.core.CliktCommand
import com.github.ajalt.clikt.core.subcommands
import com.github.ajalt.clikt.parameters.options.versionOption
import com.soebes.kotlin.commands.cloneModule
import com.soebes.kotlin.commands.logModule
import com.soebes.kotlin.commands.statusModule
import org.kodein.di.Kodein
import org.kodein.di.generic.bind
import org.kodein.di.generic.instance
import org.kodein.di.generic.setBinding

class KGitter : CliktCommand(name = "KGitter", help = """
    Repo is a command line tool that showcases how to build complex
    command line interfaces with Clikt.

    This tool is supposed to look like a distributed version control
    system to show how something like this can be structured.
    """) {

    init {
        versionOption("7.8.9")
    }

    override fun run() {}
}

fun main(args: Array<String>) {
    val kodein = Kodein {
        bind() from setBinding<CliktCommand>()
        import(cloneModule)
        import(statusModule)
        import(logModule)
    }

    val commands: Set<CliktCommand> by kodein.instance()

    KGitter().subcommands(commands).main(args)
}

and now I want to check via test if this works as I expect it to workexpected for me:

class LogTest {

    @Test
    fun logWithNamedOption() {
        val logCommand = Log()
        val result = logCommand.test(listOf("log -n2"))
        println("result: $result")
        assertEquals("Logging with 2 ", result.stdout)
    }

    @Test
    fun logWithNamedOptionsSeparatedArgEntry() {
        val logCommand = Log()
        val result = logCommand.test(listOf("log", "-n2"))
        println("result: $result")
        assertEquals("Logging with 2 ", result.stdout)
    }

    @Test
    fun logWithoutNamedOption() {
        val logCommand = Log()
        val result = logCommand.test(listOf("log", "-2"))
        println("result: $result")
        assertEquals("Logging with 2 ", result.stdout)
    }

}

but unfortunately every time those test fails (the print helped me) ... with:

result: CliktCommandTestResult(stdout=, stderr=Usage: log [<options>]

Error: got unexpected extra argument (log -n2)
, output=Usage: log [<options>]

Error: got unexpected extra argument (log -n2)
, statusCode=1)

Expected :Logging with 2 
Actual   :
<Click to see difference>

org.opentest4j.AssertionFailedError: expected: <Logging with 2 > but was: <>
	at org.junit.jupiter.api.AssertionFailureBuilder.build(AssertionFailureBuilder.java:151)
	at org.junit.jupiter.api.AssertionFailureBuilder.buildAndThrow(AssertionFailureBuilder.java:132)
	at org.junit.jupiter.api.AssertEquals.failNotEqual(AssertEquals.java:197)
	at org.junit.jupiter.api.AssertEquals.assertEquals(AssertEquals.java:182)
	at org.junit.jupiter.api.Assertions.assertEquals(Assertions.java:1156)

Interestingly if I use the resulting jar file and execute it on plain command line the options are working as expected...

./gradlew build 
..
$> java -jar  build/libs/first-1.0-SNAPSHOT-standalone.jar log  -10 
Logging with 10
$> java -jar  build/libs/first-1.0-SNAPSHOT-standalone.jar log  -n 200
Logging with 200
$>  

Also the help output looks correct:

$> java -jar  build/libs/first-1.0-SNAPSHOT-standalone.jar log  --help
Usage: KGitter log [<options>]


  ╭───────────────────────────────────╮
  │Log information from the repository│
  ╰───────────────────────────────────╯

Options:
  -<number>, -n=<number>  Number of entries which will be shown.
  -h, --help              Show this message and exit

Does someone has an idea/hint where to look for?
BTW: I haven taken https://github.com/ajalt/clikt/tree/master/samples/plugins/src/main/kotlin/com/github/ajalt/clikt/samples/plugins as starting point...

[ajalt]

You're testing the Log command directly in your tests, so you should only call it with listOf("-2"). On the CLI, log is a subcommand of your root KGitter.

[khmarbaise]

Outch... that makes sense... Oh my gosh... damn... Thank you...

[ajalt]

You're welcome. BTW you might want to add a trimIndent() call to your help strings, since the leading indent they have now will get parsed as a markdown code block (unless you like the code block formatting).

[khmarbaise]

Oh very good thanks for that hint... I started very simple....