teamcity reporter: output location of test failure

[dlipovetsky]

Fixes #623

[blgm]

Thank you @dlipovetsky. I don't have much context on the teamcity reporter, and it has only been changed once in the past few years - by @manosnoam. So I'll leave this a few days in case @manosnoam has any feedback, since sometimes changes to formats can sometimes break other teams.

[manosnoam]

Hi @dlipovetsky,
What's the difference between failure.ComponentCodeLocation.String() and failure.Location.String() ?

Can you also give an output (or screenshot) example from TeamCity ?

[dlipovetsky]

Hi @manosnoam!

Thanks for reviewing, and for implementing the TeamCity reporter 😄

Hi @dlipovetsky,
What's the difference between failure.ComponentCodeLocation.String() and failure.Location.String() ?

ComponentCodeLocation is the line of code that defines the Ginkgo "Component" (Ginko's internal name for what its docs refer to as blocks and specs, i.e., Describe/Context/It/BeforeSuite, etc). See here for some details; unfortunately, there aren't any comments.

Location is the line of code where the test failed, e..g, the line where an assertion failed. When a test fails, Location is an important piece of information. Without it, you need to search where precisely the test failed.

For comparison, the JUnit reporter outputs both locations when a test fails.

Can you also give an output (or screenshot) example from TeamCity ?

I'll try to get one that doesn't leak any internal information 😄 .

[dlipovetsky]

So I'll leave this a few days in case @manosnoam has any feedback, since sometimes changes to formats can sometimes break other teams.

Thanks for the review @blgm! You make a good point.

The TeamCity message contains two attributes, message and details. This PR adds a single line of information to details.

For example:

Before:

[testFailed name="some test" message=''/path/to/test.go:100 details="unlucky"]

After

[testFailed name="some test" message=''/path/to/test.go:100 details="unlucky|n/path/to/test.go:20"]

I only expect TeamCity itself to parse the service messages. I don't believe TeamCity parses the contents of details at all. While TeamCity collects test statistics based on the test name; the message and details are not relevant.

[dlipovetsky]

Rebased.

[dlipovetsky]

@manosnoam Your thoughts?

[manosnoam]

Looks good to me.

A side note:
The location of test failure in code is very helpful, but it is not always clear in Ginkgo output/stacktrace.

For example, it has happened to me that an assertion failed inside an It block:

ginkgo/reporters/junit_reporter_test.go

Line 192 in 3cfa02d

Ω(output.TestCases[0].ClassName).Should(Equal("My test suite"))

But then the stacktrace did not refer to that exact line of assertion, but only to the first line of the block:

ginkgo/reporters/junit_reporter_test.go

Line 183 in 3cfa02d

It("should record the test as having failed", func() {

In this case it is unknown what assertion actually broke the test...
This of-course should be opened as a different issue to fix.

[blgm]

@dlipovetsky thank you for this contribution!

@manosnoam thank you for reviewing!