teamcity_formatter 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 19413a553aa95f33da74361eecc502b4f539f13d
+  data.tar.gz: 6dc1b95375a743e508018d1634a81bd80c7ae0ea
+SHA512:
+  metadata.gz: cf78946ab73e41ecfc421e7ad1596bbf1fd1f5df80b9e09c79f2fc1611ab1e4f57f1eec9b9a9eddc155d4219c7421a5def8e0f62d3eccc4c4c1c57bea571e969
+  data.tar.gz: 66c01e67b574cdce70db044b6e591f54fa40b766fc32cc44273c66d64829f7f41c935725918e2b5ae63a9a3e63bc81b03c06f2f6c215370a90039db370496db6

data/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/lib/teamcity_formatter.rb

@@ -0,0 +1 @@
+require_relative 'teamcity_formatter/formatter'

data/lib/teamcity_formatter/formatter.rb

@@ -0,0 +1,137 @@
+require_relative 'logger'
+require_relative 'models'
+
+module TeamCityFormatter
+  class Formatter
+    def initialize(runtime, io, options)
+      @logger = Logger.new(io)
+      @feature = nil
+      @exception = nil
+      @scenario = nil
+      @scenario_outline = nil
+    end
+
+    def before_feature(cuke_feature)
+      @feature = Feature.new.tap do |x|
+        x.name = "#{cuke_feature.keyword}: #{cuke_feature.name}"
+      end
+
+      @logger.test_suite_started(@feature.name)
+    end
+
+    def after_feature(cuke_feature)
+      @logger.test_suite_finished(@feature.name)
+
+      @feature = nil
+    end
+
+    # this method gets called before a scenario or scenario outline
+    # we dispatch to our own more specific methods
+    def before_feature_element(cuke_feature_element)
+      if cuke_feature_element.is_a?(Cucumber::Core::Ast::Scenario)
+        before_scenario(cuke_feature_element)
+      elsif cuke_feature_element.is_a?(Cucumber::Core::Ast::ScenarioOutline)
+        before_scenario_outline(cuke_feature_element)
+      else
+        raise("unsupported feature element `#{cuke_feature_element.class.name}`")
+      end
+    end
+
+    # this method gets called after a scenario or scenario outline
+    # we dispatch to our own more specific methods
+    def after_feature_element(cuke_feature_element)
+      if cuke_feature_element.is_a?(Cucumber::Formatter::LegacyApi::Ast::Scenario)
+        after_scenario(cuke_feature_element)
+      elsif cuke_feature_element.is_a?(Cucumber::Formatter::LegacyApi::Ast::ScenarioOutline)
+        after_scenario_outline(cuke_feature_element)
+      else
+        raise("unsupported feature element `#{cuke_feature_element.class.name}`")
+      end
+
+      @exception = nil
+      @scenario = nil
+      @scenario_outline = nil
+    end
+
+    # this method is called before a scenario outline row OR step data table row
+    def before_table_row(cuke_table_row)
+      if cuke_table_row.is_a?(Cucumber::Formatter::LegacyApi::ExampleTableRow)
+        is_not_header_row = (@scenario_outline.example_column_names != cuke_table_row.values)
+        if is_not_header_row
+          example = @scenario_outline.examples.find { |example| example.column_values == cuke_table_row.values }
+          test_name = scenario_outline_test_name(@scenario_outline.name, example.column_values)
+          @logger.test_started(test_name)
+        end
+      end
+    end
+
+    # this method is called after a scenario outline row OR step data table row
+    def after_table_row(cuke_table_row)
+      if cuke_table_row.is_a?(Cucumber::Formatter::LegacyApi::Ast::ExampleTableRow)
+        is_not_header_row = (@scenario_outline.example_column_names != cuke_table_row.cells)
+        if is_not_header_row
+          # treat scenario-level exception as example exception
+          # the exception could have been raised in a background section
+          exception = (@exception || cuke_table_row.exception)
+          example = @scenario_outline.examples.find { |example| example.column_values == cuke_table_row.cells }
+          test_name = scenario_outline_test_name(@scenario_outline.name, example.column_values)
+          if exception
+            @logger.test_failed(test_name, exception)
+          end
+          @logger.test_finished(test_name)
+
+          @exception = nil
+        end
+      end
+    end
+
+    def exception(exception, status)
+      @exception = exception
+    end
+
+    private
+
+    def before_scenario(cuke_scenario)
+      @scenario = Scenario.new.tap do |x|
+        x.name = "#{cuke_scenario.keyword}: #{cuke_scenario.name}"
+      end
+      @logger.test_started(@scenario.name)
+    end
+
+    def before_scenario_outline(cuke_scenario_outline)
+      cuke_example_rows = cuke_scenario_outline.examples_tables.first.example_rows
+      @scenario_outline = ScenarioOutline.new.tap do |x|
+        x.name = "#{cuke_scenario_outline.keyword}: #{cuke_scenario_outline.name}"
+        x.example_column_names = cuke_example_rows.first.send(:data).keys
+        x.examples =
+          cuke_example_rows.map do |example_row|
+            example_row.send(:data).values
+          end.map do |example_column_values|
+            Example.new.tap do |x|
+              x.column_values = example_column_values
+            end
+          end
+      end
+    end
+
+    def after_scenario(cuke_scenario)
+      test_name = @scenario.name
+      if @exception
+        @logger.test_failed_with_exception(test_name, @exception)
+      end
+      # a background step previously failed and was reported the first time the failure happened
+      if (cuke_scenario.status == :skipped) && (@exception == nil)
+        @logger.test_failed(test_name, 'Background failure')
+      end
+      @logger.test_finished(test_name)
+    end
+
+    def after_scenario_outline(cuke_scenario_outline)
+      # do nothing
+    end
+
+    def scenario_outline_test_name(scenario_outline_name, example_column_values)
+      "#{scenario_outline_name} - | #{example_column_values.join(' | ')} |"
+    end
+  end
+end

data/lib/teamcity_formatter/logger.rb

@@ -0,0 +1,63 @@
+module TeamCityFormatter
+  class Logger
+    def initialize(io)
+      @io = io
+    end
+
+    def test_suite_started(test_suite_name)
+      render_output("##teamcity[testSuiteStarted name='#{teamcity_escape(test_suite_name)}' timestamp='#{timestamp}']")
+    end
+
+    def test_suite_finished(test_suite_name)
+      render_output("##teamcity[testSuiteFinished name='#{teamcity_escape(test_suite_name)}' timestamp='#{timestamp}']")
+    end
+
+    def test_started(test_name)
+      render_output("##teamcity[testStarted name='#{teamcity_escape(test_name)}' timestamp='#{timestamp}' captureStandardOutput='true']")
+    end
+
+    def test_failed_with_exception(test_name, exception)
+      details = format_exception(exception)
+      test_failed(test_name, details)
+    end
+
+    def test_failed(test_name, details)
+      render_output("##teamcity[testFailed name='#{teamcity_escape(test_name)}' timestamp='#{timestamp}' details='#{teamcity_escape(details)}']")
+    end
+
+    def test_finished(test_name)
+      render_output("##teamcity[testFinished name='#{teamcity_escape(test_name)}' timestamp='#{timestamp}']")
+    end
+
+    private
+
+    def render_output(text)
+      @io.puts(text)
+      @io.flush
+    end
+
+    def teamcity_escape(s)
+      s.to_s.strip
+        .gsub('|', '||')
+        .gsub("'", "|'")
+        .gsub(']', '|]')
+        .gsub("\r", '|r')
+        .gsub("\n", '|n')
+    end
+
+    def timestamp_short
+      now = Time.now
+      '%s.%0.3d' % [now.strftime('%H:%M:%S'), (now.usec / 1000)]
+    end
+
+    def timestamp
+      now = Time.now
+      '%s.%0.3d' % [now.strftime('%Y-%m-%dT%H:%M:%S'), (now.usec / 1000)]
+    end
+
+    def format_exception(exception)
+      lines = ["#{exception.message} (#{exception.class})"] + exception.backtrace
+      lines.join("\n")
+    end
+  end
+end

data/lib/teamcity_formatter/models.rb

@@ -0,0 +1,17 @@
+module TeamCityFormatter
+  class Feature
+    attr_accessor :name
+  end
+
+  class Scenario
+    attr_accessor :name
+  end
+
+  class ScenarioOutline
+    attr_accessor :name, :example_column_names, :examples
+  end
+
+  class Example
+    attr_accessor :column_values
+  end
+end

data/readme.md

@@ -0,0 +1,46 @@
+# TeamCity Formatter
+
+Render cucumber output in the format expected by TeamCity. This formatter is compatible with cucumber 2.0
+
+## Installation
+
+Add this to your test suite's Gemfile:
+
+    gem 'teamcity_formatter'
+
+Then execute:
+
+    $ bundle install
+
+Or, install it directly:
+
+    $ gem install teamcity_formatter
+
+## Usage
+
+Direct cucumber to use the formatter:
+
+    $ cucumber -f TeamCityFormatter::Formatter
+
+## Notes
+
+Our overall goals in writing a cucumber formatter are:
+
+1. Generate TeamCity output from a cucumber 2 test suite
+1. Passing and failing test counts should match the same counts as the standard cucumber formatter
+
+Cucumber elements are mapped simply to TeamCity test artifacts:
+
+Cucumber                 | TeamCity
+----                     | ---
+Feature                  | TestSuite
+Scenario                 | Test
+Sceanrio Outline Example | Test
+
+Test failures include the stack trace of the exception which triggered the failure.
+
+## Acknowledgements
+
+This gem drew some code from [`cucumber_teamcity`](https://github.com/ankurcha/cucumber_teamcity/). The `cucumber_teamcity` formatter is not compatible with Cucumber 2.
+
+Also, though we did not use code from their project, JetBrains makes available some TeamCity-related code [here](https://github.com/JetBrains/intellij-plugins/tree/master/ruby-testing/src/rb/testing/patch/bdd/teamcity), which may be of interest to others researching TeamCity Cucumber formatters.

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: teamcity_formatter
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+platform: ruby
+authors:
+- Kevin Rood
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  name: cucumber
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Render cucumber test output in a format consumable by TeamCity
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/teamcity_formatter.rb
+- lib/teamcity_formatter/formatter.rb
+- lib/teamcity_formatter/logger.rb
+- lib/teamcity_formatter/models.rb
+- readme.md
+homepage: https://github.com/kevinrood/teamcity_formatter
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.4.8
+signing_key:
+specification_version: 4
+summary: TeamCity cucumber output formatter
+test_files: []