cucumber-report-format 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 47778d25b6cc4b829087a094e7f5faabdcaefd20
+  data.tar.gz: abb639d264d8e3c8051363270c2ff04eb81555f3
+SHA512:
+  metadata.gz: 494dcde596471f0013cc5ba024e0998ce7264347fca5c1c199fffcd48bd25cb45cb346fbd7898a9d00e2c2f3de572d1331ede8f56403f11eeca63c57143f36b0
+  data.tar.gz: ef1e81c71e49c98e5424bfcf7118052250018646aa6d47fdf7728ce9d2c2b16379cc8ff52053ceb3afbef422c8bf5a6922130ba1851a57c62cf09b89b5ea94d9

data/.gitignore

@@ -0,0 +1 @@
+cucumber-report-format*gem

data/.rubocop.yml

@@ -0,0 +1,14 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-01-16 21:03:27 +0100 using RuboCop version 0.44.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'bin/cucumber-report-format'

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+ - 2.1.0
+ - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+gem 'multi_json'
+gem 'rake'
+gem 'rubocop'

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Funkwerk AG
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,2 @@
+# cucumber-report-format
+Formats Cucumber Reports

data/Rakefile

@@ -0,0 +1,18 @@
+task default: :build
+
+desc 'Builds the Gem.'
+task build: :audit do
+  sh 'gem build cucumber-report-format.gemspec'
+end
+
+desc 'Publishes the Gem'
+task :push do
+  sh 'gem push cucumber-report-format-0.0.1.gem'
+end
+
+task audit: :rubocop
+
+desc 'Checks ruby style'
+task :rubocop do
+  sh 'rubocop bin/*'
+end

data/bin/combine-cucumber-reports

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'multi_json'
+
+puts MultiJson.dump ARGV.map { |file| MultiJson.load File.read file }.flatten

data/bin/cucumber-report-format

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require 'stringio'
+require 'multi_json'
+require 'erb'
+
+class Format
+  def render(template, file)
+    content = File.read file
+
+    render_content(template, content)
+  end
+
+  def render_content(template, content)
+    behave_output = BehaveOutput.new MultiJson.load(content)
+
+    renderer = ERB.new File.read template
+    puts renderer.result behave_output.binding_reference
+  end
+
+  # container class for erb variable
+  class BehaveOutput
+    attr_accessor :features
+
+    def initialize(features)
+      @features = features
+    end
+
+    def binding_reference
+      binding
+    end
+  end
+end
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = 'Usage: format [files]'
+  opts.on('--template [TEMPLATE]', 'Renders into template') do |template|
+    options[:template] = template
+  end
+  opts.on('-', 'Reads from stdin') do
+    options[:stdin] = true
+  end
+end.parse!
+
+formatter = Format.new
+
+exit 1 unless options.key? :template
+
+if options.key? :stdin
+  formatter.render_content(options[:template], STDIN.read)
+else
+  ARGV.each { |file| formatter.render(options[:template], file) }
+end

data/cucumber-report-format.gemspec

@@ -0,0 +1,12 @@
+Gem::Specification.new do |s|
+  s.name        = 'cucumber-report-format'
+  s.version     = '0.0.1'
+  s.date        = '2017-01-16'
+  s.summary     = 'Format Cucumber Reports'
+  s.description = 'Template Engine for Cucumber Reports'
+  s.authors     = ['Stefan Rohe']
+  s.homepage    = 'http://github.com/funkwerk/cucumber-report-format/'
+  s.files       = `git ls-files`.split("\n")
+  s.executables = s.files.grep(%r{^bin/}) { |file| File.basename(file) }.sort.reverse
+  s.add_runtime_dependency 'multi_json', ['>= 1.11.2']
+end

data/templates/markdown.erb

@@ -0,0 +1,131 @@
+<%
+def background(feature)
+  return {} unless feature.key? 'elements'
+  backgrounds = feature['elements'].select { |element| element['keyword'] == 'Background' }
+  return {} if backgrounds.length == 0
+  backgrounds.first
+end
+
+def output_background(background)
+  return '' if background == {}
+  result = '#### Background'
+  result += " (#{background['name']})" if background.key? 'name'
+  result += "\n\n"
+  result + output_steps(background)
+end
+
+def output_steps(element)
+  result = ''
+  steps = []
+  steps = element['steps'] if element.key? 'steps'
+  steps.each do |step|
+    result += "#{step['keyword']} #{step['name']}"
+    result += output_html_table(step)
+    result += output_text(step)
+    result += "\n"
+  end
+  result
+end
+
+def output_html_table(step)
+  return '' unless step.key? 'table'
+  result = "\n<table><tr><td>#{step['table']['headings'].join '</td><td>'}</td></tr>"
+  step['table']['rows'].each do |row|
+    result += "<tr><td>#{row.join '</td><td>'}</td></tr>"
+  end
+  result += '</table>'
+  result
+end
+
+def output_table(step)
+  return '' unless step.key? 'table'
+  result = "\n| #{step['table']['headings'].join ' | '} |"
+  step['table']['rows'].each do |row|
+    result += "\n| #{row.join ' | '} |"
+  end
+  result
+end
+
+
+def output_text(step)
+  return '' unless step.key? 'text'
+  return "\n > " + step['text'] if step['text'].instance_of? String
+  "\n > " + step['text'].join("\n> ")
+end
+
+
+def is_automatic?(scenario)
+  tags = []
+  tags = scenario['tags'] if scenario.key? 'tags'
+  tags.each do |tag|
+    return false if tag == '@manual'
+  end
+  true
+end
+
+def scenarios(feature)
+  return [] unless feature.key? 'elements'
+  feature['elements'].select { |element| element['keyword'] != 'Background' }
+end
+
+def test_result(test)
+  status = 'passed'
+  duration = 0
+  error = []
+
+  steps = []
+  steps = test['steps'] if test.key? 'steps'
+  steps.each do |step|
+    next unless step.key? 'result'
+    duration += step['result']['duration'] if step['result'].key? 'duration'
+    next if status == 'failed'
+    status = step['result']['status'] if step['result'].key? 'status'
+    step['result']['error_message'].each { |a| error.push a } if step['result'].key? 'error_message'
+  end
+  # TODO: symbols as keys, not strings
+  {'status' => status, 'duration' => duration, 'error' => error}
+end
+
+def hover_div(scenario)
+  result = "<div class='outer'><div>#{@scenario['name']}</div><div class='inner'>#{output_steps(@scenario).gsub("\n", '<br>').gsub('|','')}</div></div>"
+
+  result
+end
+
+def test_comment(scenario)
+  errors = test_result(scenario)['error']
+  return '' if errors.empty?
+  errors.last
+end
+
+%>
+
+## Features
+
+<style>
+.inner {
+  display: none;
+}
+
+.outer:hover .inner {
+  display: block;
+}
+</style>
+
+<%
+  number = 0
+%>
+<% for @feature in @features %>### <%= @feature['name'] %>
+
+#### Description
+
+> <%= @feature['description'].join "\n> " %>
+
+<%= output_background(background(@feature)) %>
+#### Testscenarios and Results
+
+| No | Scenario | Type | Result | Comment |
+|----|----------|------|--------|---------|
+<% for @scenario in scenarios(@feature) %><% number += 1 %>| <%= number %> | <%= hover_div(@scenario) %> | <%= is_automatic?(@scenario) ? 'automatic' : 'manual' %> | <%= test_result(@scenario)['status'] %> | <%= test_comment(@scenario) %> |
+<% end %>
+<% end %>

data/templates/overall_summary.erb

@@ -0,0 +1,35 @@
+<%
+def all_tests(features)
+  tests = []
+  features.each do |feature|
+    next unless feature.key? 'elements'
+    feature['elements'].select { |element| element["keyword"] != 'Background' }.each do |element|
+      tests.push element
+    end
+  end
+  tests
+end
+
+def test_result(test)
+  status = 'passed'
+  duration = 0
+
+  steps = []
+  steps = test['steps'] if test.key? 'steps'
+  steps.each do |step|
+    next unless step.key? 'result'
+    result = step['result']
+    duration += result['duration'] if result.key? 'duration'
+    next if status == 'failed'
+    status = result['status'] if result.key? 'status'
+  end
+  {'status' => status, 'duration' => duration}
+end
+
+def is_executed?(test)
+  test['tags'].each do |tag|
+    return false if tag == '@skip'
+  end
+  true
+end
+%><%= all_tests(@features).length %> | <%= all_tests(@features).select { |test| test_result(test)['status'] == 'passed' }.length %> | <%= all_tests(@features).select { |test| test_result(test)['status'] == 'failed' }.length %> | <%= all_tests(@features).select { |test| !is_executed? test }.length %>

data/templates/summary.erb

@@ -0,0 +1,42 @@
+<%
+def all_tests(features)
+  tests = []
+  features.each do |feature|
+    next unless feature.key? 'elements'
+    feature['elements'].select { |element| element["keyword"] != 'Background' }.each do |element|
+      tests.push element
+    end
+  end
+  tests
+end
+
+def test_result(test)
+  status = 'passed'
+  duration = 0
+
+  steps = []
+  steps = test['steps'] if test.key? 'steps'
+  steps.each do |step|
+    next unless step.key? 'result'
+    result = step['result']
+    duration += result['duration'] if result.key? 'duration'
+    next if status == 'failed'
+    status = result['status'] if result.key? 'status'
+  end
+  {'status' => status, 'duration' => duration}
+end
+
+def is_executed?(test)
+  test['tags'].each do |tag|
+    return false if tag == '@skip'
+  end
+  true
+end
+%>
+## Summary
+
+| Tests        | <%= all_tests(@features).length %> |
+| - | - |
+| Passed       | <%= all_tests(@features).select { |test| test_result(test)['status'] == 'passed' }.length %> |
+| Failed       | <%= all_tests(@features).select { |test| test_result(test)['status'] == 'failed' }.length %> |
+| Not Executed | <%= all_tests(@features).select { |test| !is_executed? test }.length %> |

data/templates/tag_overview.erb

@@ -0,0 +1,34 @@
+<%
+def extract_used_tags(features)
+  count features.map { |feature| extract_feature_tags feature }.flatten
+end
+
+def extract_feature_tags(feature)
+  tags = []
+
+  tags += feature['tags'] if feature.key? 'tags'
+  feature['elements'].each { |e| tags += extract_element_tags(e) } if feature.key? 'elements'
+  tags
+end
+
+def extract_element_tags(feature)
+  tags = []
+
+  tags += feature['tags'] if feature.key? 'tags'
+  tags
+end
+
+def count(list)
+  tags = {}
+
+  list.each do |a|
+    tags[a] = 0 unless tags.key? a
+    tags[a] += 1
+  end
+  tags
+end
+%>
+| Tag | Amount |
+| - | - |
+<% for @key, @amount in extract_used_tags(@features).sort_by {|_, v| v }.reverse %>| <%= @key %> | <%= @amount %> |
+<% end %>

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: cucumber-report-format
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stefan Rohe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+description: Template Engine for Cucumber Reports
+email: 
+executables:
+- cucumber-report-format
+- combine-cucumber-reports
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/combine-cucumber-reports
+- bin/cucumber-report-format
+- cucumber-report-format.gemspec
+- templates/markdown.erb
+- templates/overall_summary.erb
+- templates/summary.erb
+- templates/tag_overview.erb
+homepage: http://github.com/funkwerk/cucumber-report-format/
+licenses: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Format Cucumber Reports
+test_files: []