Include the output $stderr and $stdout in JUnit formatted XML

[rtyler]

This is useful for Jenkins users who might have valuable information getting pumped into $stderr or $stdout..

In my case, I need to put data into the <system-out/> for some plugin integration in Jenkins, but I can see it useful for the general case.

I tried to make the Interceptor::Pipe class as re-usable as possible, but also low impact. This is my first pull request, so be gentle :)

Willing to accept free BDD coaching if @mattwynee is up for it ;)

[mattwynne]

I think this is great. Nice specs, easy to read code.

[rtyler]

I'm not aware of any way to know what global pipe was passed in originally (being a reference and all), so I've cleaned up as best I could.

In the case of #unwrap! it also does the added bonus of disabling the interception if for some unforeseen reason the caller of Interceptor::Pipe doesn't properly reset the pipe.

[mattwynne]

Nice!

How about just taking a symbol to represent which global pipe it should wrap, then doing the interception in that method:

@wrappedstderr = Interceptor::Pipe.wrap(:stderr)

WDYT? It would keep the formatter itself cleaner, even if the interceptor has to get a little bit more ugly.

[rtyler]

How symmetrical should the #wrap/#unwrap! API be? The way you use/reference #wrap there says to me it should be a class method.

Should #unwrap! then be used as such?:

Interceptor::Pipe.unwrap!(@wrappedstderr)

[rtyler]

I hope this finally meets your satisfaction :) 🍰

[mattwynne]

Thanks! I'll take a look shortly.

[mattwynne]

Beautiful!

[penberg]

So does this feature actually work? I'm running Cucumber 1.2.0 on Linux and don't seem to get anything to "system-err" or "system-out".

I tried adding a

puts "HELLO"

line to fixtures/junit/features/step_definitions/steps.rb for the "passing scenario" but didn't see any test breakage. Shouldn't legacy_features/junit_formatter.feature pick that up?

[mattwynne]

Thanks for the feedback @penberg. Any comments @rtyler?

[rtyler]

@penberg is correct, it looks like I overlooked the fact that "puts" inside of a step-definition is something else that doesn't seem to print to stdout/stderr at all.

A raw:

  $stdout.write("HELLO!\n")

in a step-definition will be placed in the right XML tags though.

Guess this isn't over just yet ;)

[mattwynne]

Ah I forgot. This is a feature which @aslakhellesoy implemented a while back. We used to call this method #announce.

What do you guys think would be the least surprising behaviour to implement here?

[rtyler]

It does take me a little by surprise that Kernel methods are being overwritten by the default World.

What this means is that puts calls in my step definitions will not hit $stdout and in turn the Interceptor code, but puts calls in other methods/modules that I invoke will.

It is a little bonkers IMHO.

[mattwynne]

So @penberg can you try using Kernel.puts instead?

@rtyler now you know the lay of the land, what do you think it should do? Maybe we should start using the pipe interceptor everywhere and push all stdout / stderror output to the formatters as events? That way we'd still get the current behaviour (puts statements in your step defs are rendered all pretty by the formatter) and that would also work for puts statements elsewhere in the codebase.

[rtyler]

FWIW, Kernel#puts will work properly in the same way that $stdout#write will.

Anything you're up for @mattwynne I can take a crack at if you want to file an issue, I'm still sufficiently fresh to Cucumber's codebase that I'm not comfortable making these kinds of decisions just yet.

[penberg]

@rtyler $stderr.write() indeed works just fine. Thanks!

[mattwynne]

I can't get my head around it. Let's leave it until it pops back up.

[luvs]

Hello. Its possible to print stdout/stderr into tag, now all stdout writes to level and Jenkins doesn't print output in test results?

---

My workaround, maybe it will be useful for somebody:
Modify lib/cucumber/formatter/json.rb

1. Add this string to before_steps
   @interceptedout_steps = Interceptor::Pipe.wrap(:stdout)
   @interceptederr_steps = Interceptor::Pipe.wrap(:stderr)
2. Modify build_testcase - add 2 param and output them into system-out/system-err
   def build_testcase(duration, status, sys_output, sys_err, exception = nil, suffix = "")
   ....
   @builder.tag!('system-out') do
   @builder.cdata! sys_output.buffer.join
   end
   @builder.tag!('system-err') do
   @builder.cdata! sys_err.buffer.join
   end
   ....
3. Modify call build_testcase in 2 place
   build_testcase(duration, steps.status, @interceptedout_steps, @interceptederr_steps, steps.exception)
   build_testcase(duration, table_row.status, @interceptedout_steps, @interceptederr_steps, table_row.exception, name_suffix)

[lock]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.