[BATS] Changing current directory results in no coverage

[jakub-bochenski]

If I have a bats setup_suite.bats file like this

#!/bin/bash

setup_suite() {

  cd "$(dirname "$BATS_TEST_FILENAME")" || return 1

}

it will result in empty coverage report.

If I comment that line with cd I get an expected coverage report.

[SimonKagstrom]

I know far too little about bats (or bash) to know what this might be. Can the issue @KlfJoat reported the other day be related to this?

[jakub-bochenski]

I don't think it is. I can try to prepare a MRE if it would be useful, but I don't have the skills to investigate this further

[jakub-bochenski]

BTW this is not a blocker to me, as I can do without the cd. It's a useful "gotcha" to know about though..

[KlfJoat]

It is not related to my issue, I'm pretty sure.

#!/bin/bash
setup_suite() {
  cd "$(dirname "$BATS_TEST_FILENAME")" || return 1
}

Bats is full of subshells and redirections and TRAPs that can be difficult to follow. So that cd, and even the return 1 from this function, might not do what you assume it does because of when and how Bats suite setup happens compared to actually executing your tests.

Also, dirname may return a relative directory reference. I prefer to be explicit about filenames in Bats because of all that trickery I mentioned. Therefore, I'd first suggest trying to cd "$BATS_TEST_DIRNAME" || exit 1. Or do what I do and use $BATS_TEST_DIRNAME in setup_file() or in front of each file you reference in each of your tests.

[jakub-bochenski]

Point take about BATS_TEST_DIRNAME, but I think it's just changing to any directory that causes the issue