Teamcity styling

[lukeraymonddowning]

Q	A
Bug fix?	no
New feature?	yes

This PR aims to add Pest styling to the PhpStorm TeamCity Logger. Here are some output examples:

[olivernybroe]

Looks really great!

It's not possible for us to share the output with the normal console so we don't have to maintain the output in two places?

[lukeraymonddowning]

Looks really great!

It's not possible for us to share the output with the normal console so we don't have to maintain the output in two places?

Hadn't really thought about that but will look at the possibility of unifying the two 👍

[lukeraymonddowning]

@olivernybroe we now defer to Collision's adapter for output. However, there seems to be a little issue with test failures showing the error output:

I imagine this is to do with test listeners and the output helpers. Any ideas?

[olivernybroe]

Nice!

I think the code looks great and really nice cleanup. I haven't tested it out locally yet, hopefully I get time to do that soon or someone else does it 👍

[olivernybroe]

I might be a bit blind, but what replaced the part which did this? 🤔

[lukeraymonddowning]

Basically nothing. We're firing all of the events that team city were firing manually, and now that we don't share their output at all, it became redundant. Can you see an issue with it?

[lukeraymonddowning]

I've gone through and manually implemented some of the events. We have to do it manually so as not to give PHPStorm too much information (because then it writes to the console) but just enough to get it to display the correct icon. If we decorate the base TeamCity logger it writes out too much to the console.

[lukeraymonddowning]

@nunomaduro @olivernybroe I'm pretty happy with this PR now. Could do with somebody who has PhpStorm seeing if I've missed anything. The only quirk is on skipped tests:

In order to get the skip indicators in PhpStorm, it has to output the "Test ignored." text. I can get it to go to the bottom using ob_start and ob_flush around the event printer, but I can't get the text to disappear completely. Thoughts?

[lukeraymonddowning]

Follow-up: We can pass a space for the message on skipped tests, which is cleaner, and combined with ob_start results in just a bunch of new lines at the bottom of the console output:

[olivernybroe]

Hey @lukeraymonddowning, there is unfortunately something wrong 😢

When I have a failing test, it does not report the error message of it as part of the specific test case.


I have to go to all output to be able to see why it failed. However before you could see this on each specific test, which is really helpful when having multiple failing tests.

It also looks like the print of the status from the file is getting outputted the wrong place.
For example, when looking at the result of the first test of the next test group, it contains the output of how what passed and failed in the previous group.

Another issue found. When using the goto feature (pressing the file) it does not work on phpunit files anymore. This is because it now uses the pest_qn for location hint instead of php_qn when using phpunit tests

So after looking further into what the results showing in the wrong grouping is about, it seems like all the output from the collision printer is not being wrapped in TeamCity format. This is needed so phpstorm knows how to categorise stuff.
For example, if we take a look at the following teamcity message when a test fails that was comparing data.

##teamcity[testFailed name='it can get null as gold if no spies' message='Failed asserting that two strings are identical.' details=' /Users/olivernybroe/Code/nightlands-api/vendor/pestphp/pest/src/Expectation.php:183|n /Users/olivernybroe/Code/nightlands-api/tests/Feature/GraphQL/Queries/ProfileByIdTest.php:61|n /Users/olivernybroe/Code/nightlands-api/vendor/pestphp/pest/src/Factories/TestCaseFactory.php:151|n /Users/olivernybroe/Code/nightlands-api/vendor/pestphp/pest/src/Concerns/Testable.php:285|n /Users/olivernybroe/Code/nightlands-api/vendor/pestphp/pest/src/Support/ExceptionTrace.php:28|n /Users/olivernybroe/Code/nightlands-api/vendor/pestphp/pest/src/Concerns/Testable.php:286|n /Users/olivernybroe/Code/nightlands-api/vendor/pestphp/pest/src/Concerns/Testable.php:274|n /Users/olivernybroe/Code/nightlands-api/vendor/pestphp/pest/src/Console/Command.php:130|n ' duration='483' type='comparisonFailure' actual='|'monkey|'' expected='|'cat|'']

This contains a type=comparisonFailure which lets phpstorm show the beloved diff between the two results. It also contains the details argument, which gives us all the extra information needed and then the name, so we know which test to connect this to and a message to show the user. However with the changes here, it is not wrapped in the teamcity event and the types and so on is also not here.

I hope this feedback helps, sorry for the wall of text

[lukeraymonddowning]

Thanks @olivernybroe! That's super helpful. Do you know how we could support the full teamcity events without having it print to the console?

[olivernybroe]

@lukeraymonddowning not completely no 🙁

We might be able to do a wrapper around the out object given to collision, so we can get the output from it and wrap it in a team city format? 🤔

[nunomaduro]

@lukeraymonddowning @olivernybroe Once this is ready, fell free to merge and release.

[lukeraymonddowning]

@olivernybroe I've just gone and refactored all of the work here to clean it up nicely. Ready for another review whenever you get chance.

[olivernybroe]

I am done testing this out now and it works really well! Amazingly done ❤️

Implemented