"No Arguments" descriptor is annoying to use

[hanneskaeufler-bmw]

Since 447edb6
there is a visualization for "no arguments passed".

Some tests written against this library before this commit now fail with things like:

Making those tests pass again is annoying, because the descriptor that is to be pushed
into the verification is using a lot of escape sequences.

The only way I found to make those test pass is to

BACH_NO_ARGUMENTS_SIGN=$'\x1b\x5b31m\u2205\x1b\x5b0m'
pushd"  "$BACH_NO_ARGUMENTS_SIGN

Maybe I'm missing something, but this I don't find ergonomic. Copy&pasting the
sign from terminal into the editor did not work due to the "red" escape sequence
not being copied.

[chaifeng]

Hi, thank you for this issue.

Yes, the name can be a bit confusing, but it is mainly used within Bach. A better name for this sign would be "empty argument" or "empty string"

It happens when we pass an empty string to a command

test-pass-an-empty-string() {
    foobar ""
}
test-pass-an-empty-string-assert() {
    foobar
}

Another case is we want to assign output from a command to a variable, but we forgot to mock that command

test-forgot-to-mock-a-command() {
    foobar "$(forgot-to-mock-this-command param1 param2)"
}
test-forgot-to-mock-a-command-assert() {
    foobar
}

[hanneskaeufler-bmw]

Hi, thanks for your quick response. Your example is a perfect example of the issue, this happens if you run it:

but it is mainly used within Bach

So that's not true, it immediately bubbles to the end-user, who then has to find an ugly workaround.

Greetings!

[chaifeng]

I think I get your point. Yes, when people see this strange sign they have no idea what it is. It actually is just an empty string. Because there is no way to display an empty string on terminal, so I choose this sign to indicate an empty string. To pass the three failed tests, In addition to mock pipeline commands, just put an empty sting inside assert functions ``` test-pass-an-empty-string() { foobar "" } test-pass-an-empty-string-assert() { foobar "" # the only argument is an empty string } test-forgot-to-mock-a-pipeline-command() { @mock do-somting @mock forgot-to-mock-this-command param1 param2 # we must mock all pipeline commands foobar "$(do-something | forgot-to-mock-this-command param1 param2)" } test-forgot-to-mock-a-pipeline-command-assert() { do-something # Must explicitly verify all commands in the pipeline except for the last one foobar "" # The last command of the pipeline outputs nothing, just an empty string } test-forgot-to-mock-a-command() { @mock forgot-to-mock-this-command param1 param2 === @stdout "" foobar "$(forgot-to-mock-this-command param1 param2)" } test-forgot-to-mock-a-command-assert() { foobar "" } ``` If we forgot to use double quotes, the following test case will pass. But this may involve bugs unless we explicitly know why we don't use double quotes ``` test-forgot-to-mock-a-command-and-without-double-quotes() { foobar $(forgot-to-mock-this-command param1 param2) # WARNING: no double quotes here } test-forgot-to-mock-a-command-and-without-double-quotes-assert() { forgot-to-mock-this-command param1 param2 foobar } ```

…

On Apr 22, 2022, at 15:14, hanneskaeufler-bmw ***@***.***> wrote: Hi, thanks for your quick response. Your example is a perfect example of the issue, this happens if you run it: but it is mainly used within Bach So that's not true, it immediately bubbles to the end-user, who then has to find an ugly workaround. Greetings! — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you commented.

[hanneskaeufler-bmw]

Aahh thanks again, yeah, so the "" is needed to make the test pass, not the cryptic escape sequence. Works fine now 👍 I guess this is more of a documentation issue then.