rspec_junit_formatter 0.4.0.pre2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7e45b452b3b1ddc9a5fe134c0f440b5c75f61ede
-  data.tar.gz: cb0b99afd6014613c513c98e52cdf7b7244e07a6
+SHA256:
+  metadata.gz: 615b543d4cbd284941621231bb5fbc4132a1991a9032d9f35e2d63dd1461a5e3
+  data.tar.gz: 5a62fe31f2292c2c80c152e3ecbdafaf5d960838d1e729574bf6479bc6fd7599
 SHA512:
-  metadata.gz: f49ef97111a63bb72f5b4b55eba04f1afa1e17e6f1a57a1d0f492b3030db8d810f3ba1dded5bfbae9b27f77284282148c51c763c974352f9abcb42bbde82284f
-  data.tar.gz: 5a3421440dec87320bd86e230a31e18fdd395ab41d6c105296b3cef80101f49c3bc2696e77762184a0d030e8634e2182922b1889449c55b9b3a6ca78c6c17649
+  metadata.gz: 79c1155ccd8b77d1dc9176bd6eb033cb4bc3a4d2b2452421180dae502f96ab98c36010db89d5bcee9f943fd5959b7241b12a12f14f60548de8034efe04a2af23
+  data.tar.gz: 249d53fef2a5a8e5f5abc0d38f803f9a628d075e53f5448e580265714b9d38c87f49cef98c3e91a0f047311f8ece77629a837229c6ecd4abe1765f93f1da3ce5

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Samuel Cochran
+Copyright (c) 2011-2018 Samuel Cochran
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -3,9 +3,12 @@
 [![Build results](http://img.shields.io/travis/sj26/rspec_junit_formatter/master.svg)](https://travis-ci.org/sj26/rspec_junit_formatter) 
 [![Gem version](http://img.shields.io/gem/v/rspec_junit_formatter.svg)](https://rubygems.org/gems/rspec_junit_formatter)
 
-[RSpec][rspec] 2 & 3 results that [Jenkins][jenkins] can read. Probably a few other CI services, too.
+[RSpec][rspec] 2 & 3 results that your CI can read. [Jenkins][jenkins-junit], [Buildkite][buildkite-junit], [CircleCI][circleci-junit], and probably more, too.
 
-Inspired by the work of [Diego Souza][dgvncsz0f] on [RSpec Formatters][dgvncsz0f/rspec_formatters] after frustration with [CI Reporter][ci_reporter].
+  [rspec]: http://rspec.info/
+  [jenkins-junit]: https://jenkins.io/doc/pipeline/steps/junit/
+  [buildkite-junit]: https://github.com/buildkite/rspec-junit-example
+  [circleci-junit]: https://circleci.com/docs/2.0/collect-test-data/
 
 ## Usage
 
@@ -29,6 +32,8 @@ You can use it in combination with other [formatters][rspec-formatters], too:
 rspec --format progress --format RspecJunitFormatter --out rspec.xml
 ```
 
+  [rspec-formatters]: https://relishapp.com/rspec/rspec-core/v/3-6/docs/formatters
+
 ### Using in your project with Bundler
 
 Add it to your Gemfile if you're using [Bundler][bundler]. Put it in the same groups as rspec.
@@ -46,6 +51,8 @@ Put the same arguments as the commands above in [your `.rspec`][rspec-file]:
 --format RspecJunitFormatter
 --out rspec.xml
 ```
+  [bundler]: https://bundler.io
+  [rspec-file]: https://relishapp.com/rspec/rspec-core/v/3-6/docs/configuration/read-command-line-configuration-options-from-files
 
 ### Parallel tests
 
@@ -58,17 +65,45 @@ For use with `parallel_tests`, add `$TEST_ENV_NUMBER` in the output file option
 
 The formatter includes `$TEST_ENV_NUMBER` in the test suite name within the XML, too.
 
+### Capturing output
+
+If you like, you can capture the standard output and error streams of each test into the `:stdout` and `:stderr` example metadata which will be added to the junit report, e.g.:
+
+```ruby
+# spec_helper.rb
+
+RSpec.configure do |config|
+  # register around filter that captures stdout and stderr
+  config.around(:each) do |example|
+    $stdout = StringIO.new
+    $stderr = StringIO.new
+
+    example.run
+
+    example.metadata[:stdout] = $stdout.string
+    example.metadata[:stderr] = $stderr.string
+
+    $stdout = STDOUT
+    $stderr = STDERR
+  end
+end
+```
+
 ## Caveats
 
  * XML can only represent a [limited subset of characters][xml-charsets] which excludes null bytes and most control characters. This gem will use character entities where possible and fall back to replacing invalid characters with Ruby-like escape codes otherwise. For example, the null byte becomes `\0`.
 
+  [xml-charsets]: https://www.w3.org/TR/xml/#charsets
+
 ## Roadmap
 
  * It would be nice to split things up into individual test suites, although would this correspond to example groups? The subject? The spec file? Not sure yet.
 
 ## Development
 
-Run the specs with `bundle exec rake spec`. Run the specs against a matrix of rspec versions using `bundle exec rake spec:all`.
+Run the specs with `bundle exec rake`, which uses [Appraisal][appraisal] to run the specs against all supported versions of rspec.
+
+  [appraisal]: https://github.com/thoughtbot/appraisal
 
 ## Releasing
 
@@ -76,16 +111,12 @@ Bump the gem version in the gemspec, and commit. Then `bundle exec rake build` t
 
 ## License
 
-The MIT License, see [LICENSE][license].
+The MIT License, see [LICENSE](./LICENSE).
+
+## Thanks
+
+Inspired by the work of [Diego Souza][dgvncsz0f] on [RSpec Formatters][dgvncsz0f/rspec_formatters] after frustration with [CI Reporter][ci_reporter].
 
-  [rspec]: http://rspec.info/
-  [rspec-formatters]: https://relishapp.com/rspec/rspec-core/v/3-6/docs/formatters
-  [rspec-file]: https://relishapp.com/rspec/rspec-core/v/3-6/docs/configuration/read-command-line-configuration-options-from-files
-  [jenkins]: http://jenkins-ci.org/
   [dgvncsz0f]: https://github.com/dgvncsz0f
   [dgvncsz0f/rspec_formatters]: https://github.com/dgvncsz0f/rspec_formatters
   [ci_reporter]: https://github.com/nicksieger/ci_reporter
-  [bundler]: http://gembundler.com/
-  [fuubar]: http://jeffkreeftmeijer.com/2010/fuubar-the-instafailing-rspec-progress-bar-formatter/
-  [license]: https://github.com/sj26/rspec-junit-formatter/blob/master/LICENSE
-  [xml-charsets]: https://www.w3.org/TR/xml/#charsets

data/lib/rspec_junit_formatter.rb

@@ -71,9 +71,24 @@ private
     output << %{ time="#{escape("%.6f" % duration_for(example))}"}
     output << %{>}
     yield if block_given?
+    xml_dump_output(example)
     output << %{</testcase>\n}
   end
 
+  def xml_dump_output(example)
+    if (stdout = stdout_for(example)) && !stdout.empty?
+      output << %{<system-out>}
+      output << escape(stdout)
+      output << %{</system-out>}
+    end
+
+    if (stderr = stderr_for(example)) && !stderr.empty?
+      output << %{<system-err>}
+      output << escape(stderr)
+      output << %{</system-err>}
+    end
+  end
+
   # Inversion of character range from https://www.w3.org/TR/xml/#charsets
   ILLEGAL_REGEXP = Regexp.new(
     "[^" <<

data/lib/rspec_junit_formatter/rspec2.rb

@@ -69,4 +69,12 @@ private
   def group_and_parent_groups(example)
     example.example_group.parent_groups + [example.example_group]
   end
+
+  def stdout_for(example)
+    example.metadata[:stdout]
+  end
+
+  def stderr_for(example)
+    example.metadata[:stderr]
+  end
 end

data/lib/rspec_junit_formatter/rspec3.rb

@@ -122,6 +122,14 @@ private
       yield
     end
   end
+
+  def stdout_for(example_notification)
+    example_notification.example.metadata[:stdout]
+  end
+
+  def stderr_for(example_notification)
+    example_notification.example.metadata[:stderr]
+  end
 end
 
 # rspec-core 3.0.x forgot to mark this as a module function which causes:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec_junit_formatter
 version: !ruby/object:Gem::Version
-  version: 0.4.0.pre2
+  version: 0.4.0
 platform: ruby
 authors:
 - Samuel Cochran
@@ -28,7 +28,7 @@ cert_chain:
   P4lSfmXxsd1C71ckIp0cyXkPhyTtpyS/5hq9HhuUNzEHkSDe36/Rd1xYKV5JxMC2
   YAttWFUs06lor2q1wwncPaMtUtbWwW35+1IV6xhs2rFY6DD/I6ZkK3GnHdY=
   -----END CERTIFICATE-----
-date: 2017-12-17 00:00:00.000000000 Z
+date: 2018-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -60,58 +60,78 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: coderay
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 description: RSpec results that your continuous integration service can read.
 email: sj26@sj26.com
 executables: []
@@ -143,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 2.0.0
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.5
 signing_key: 
 specification_version: 4
 summary: RSpec JUnit XML formatter