Fix/test key separator

[titouanmathis]

Q	A
Bug fix?	yes
New feature?	no
Fixed tickets	#307

This PR introduces a more specific separator for the tests keys to avoid matching a potential folder name. The separator is changed from @ to @@@@ as it has more chance to not match anything in the test file absolute path. Maybe this value could be more complex?

[owenvoke]

Could probably do something like @@pest@@ as the separator. Although, it's unlikely @@@@ would be taken anyway. Interesting use of @ in your directories, not seen that before. 👍🏻

[lukeraymonddowning]

I agree with @owenvoke that if we're making it specific, we might as well make it really specific.

[lukeraymonddowning]

@nunomaduro @owenvoke

This raises another interesting point.

Note that the runner doesn't include the @ symbol. This makes sense, because it is removed in the TestCaseFactory on line 188 so that it can be a valid namespace. Do we include an 'escaped' replacement value for certain valid path symbols, such as '@' to 'AtSymbol'?

I'm not saying that we necessarily should, but its definitely a point worth raising.

[lukeraymonddowning]

For the separator, how about using >>>? > is a reserved symbol on Windows computers, so it is pretty much guaranteed that there will not be a directory including that symbol, but it also still conveys the idea of relationship between the test case and the individual test.

This then also solves the unlikely but possible situation of a folder with 4 '@' symbols.

[titouanmathis]

>>> should work and its connotation of the relationship is definitely a plus. I tested a line break as a separator, it seems to work as well, but I am not sure of its compatibility.

Let me know what you prefer, I will update my PR.

[lukeraymonddowning]

Let's go with >>>. If Nuno or Owen disagree, its not a major thing to alter 👍

[lukeraymonddowning]

This TestCase is no longer needed and will actually fail completely after the change to >>>

[titouanmathis]

I just updated the tests to include >>> in the folder name, as it seems to work on macOS. I think that keeping the test can help people having the same issue when they have some strange folder names as I had.

[lukeraymonddowning]

Out of interest, what would happen if you attempted to pull this repo on a Windows machine? Seen as > is a forbidden character.

[owenvoke]

Using >>> sounds fine to me. 👍🏻 Ah, as we checkout the tests on Windows, it will fail to checkout that directory (see the failing CI runs). I think we probably should use @@pest@@ then (or something), as long as that's supported in Windows names.

[lukeraymonddowning]

@owenvoke I don't think it needs that, we just don't need the test class with >>> in the title. No developer can ever use > in a directory if they ever plan on supporting windows platforms, which is why I suggested it. That makes the test case unnecessary. Hope that makes some sort of sense.

[owenvoke]

@lukeraymonddowning I guess that could be removed, same with the one ending in >, just wasn't sure if we needed at least one test with the separator in. 🤔 Probably not, as you said.

[titouanmathis]

I removed the tests, this PR will keep the history of the bug in case anyone has some >>> in their folder path.

[lukeraymonddowning]

Lol, sorry @titouanmathis

It would make sense to me to keep the first test, but have the @ symbol in the directory, which was the original issue. But there is no need to have a test case with the > symbol in a directory because if they have that in their project, Pest is going to be the least of their problems.

[titouanmathis]

Haha, my bad, I will re-add the first test 👍

[nunomaduro]

@lukeraymonddowning Tests are not passing. But once tests are passing, feel free to merge and to release.

A release requires changes on the changelog + 9133b88.

[titouanmathis]

I added the output of the 2 new tests to the success.txt snapshot, the integration tests should pass now.