ugly_face 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5f8cf74da2e0daddffd8fdb0ee03a71b8357b974
+  data.tar.gz: 54ce14b5b3c72814ac4b295865c19213b855a723
+SHA512:
+  metadata.gz: d34d0ea7a0ba0978d70f4d2dd1fc54f5da2325977fc55dc586013110b2831a98e75563080710805ea8f9a3998a6a7ef9e7075f1db60400ea794aed626c9f1663
+  data.tar.gz: 940bed0678b652b5aeb25fa34c5a3a4f78473abd35080b35abc6b7ebffefc313dd1fd6c31ad026b8ab2e011da6e57e10c5827f52529f32bd606aa91bd4aa7590

data/.gitignore

@@ -0,0 +1,18 @@
+.idea/*
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/ChangeLog

@@ -0,0 +1,2 @@
+=== Release 0.1 / 2015-11-20
+Initial release

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+
+gem 'rake'
+gem 'fuubar'
+gem 'rb-fsevent', :require => false if RUBY_PLATFORM =~ /darwin/i
+gem 'growl'
+gem 'guard-rspec'
+gem 'guard-cucumber'
+gem 'page-object'
+gem 'syntax'
+
+# Specify your gem's dependencies in ugly_face.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,19 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :cli => '--color --format Fuubar' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { "spec" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+guard 'cucumber', :notification => true, :all_after_pass => false, :cli => '--profile focus' do
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$})          { 'features' }
+  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
+  watch(%r{^lib/.+\.rb$})                   { "features" }
+  watch(%r{^lib/.+\.erb$})                  { "features" }
+  watch(%r{^lib/.+\.css$})                  { "features" }
+
+end
+

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2011-2012 Jeff Morgan
+Copyright (c) 2015 Justin Commu
+
+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,25 @@
+# ugly_face
+
+Customized HTML report for cucumber. 
+ 
+
+## Getting Started
+
+### Download gem
+Add the gem to your Gemfile
+
+   `gem 'ugly_face'`
+
+Then do a  `bundle update` to get the latest version
+
+### Add Formatter
+Update your profile in cucumber.yml file with the following arguments 
+
+    --format UglyFace::Formatter::Html --out index.html
+
+You can also run cucumber from the command line with the same arguments.
+
+
+## Copyright
+
+Copyright (c) 2015 Justin Commu & Jeffrey S. Morgan. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,19 @@
+require "bundler/gem_tasks"
+require 'cucumber'
+require 'cucumber/rake/task'
+require 'rspec/core/rake_task'
+
+Cucumber::Rake::Task.new(:features, "Run all features") do |t|
+  t.profile = 'default'
+end
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.ruby_opts = "-I lib:spec"
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+task :spec
+
+desc 'Run all specs and features'
+task :test => %w[spec features]
+
+task :default => :test

data/cucumber.yml

@@ -0,0 +1,4 @@
+default: --color --no-source --format pretty 
+fixture: --color --no-source --require fixtures/step_definitions --format UglyFace::Formatter::Html --out results/fixture.html
+focus: --color --no-source --format pretty --tags @focus
+

data/features/feature_pages.feature

@@ -0,0 +1,110 @@
+@no-clobber
+Feature: pages that show details for features
+
+  Background:
+    When I run `cucumber fixtures --require fixtures/step_definitions --format UglyFace::Formatter::Html --out results/fixture.html`
+
+@announce
+@focus
+  Scenario: Generate the pages
+    Then the following files should exist:
+    | results/basic.html    |
+    | results/advanced.html |
+
+  Scenario: Generating the basic html page from the erb
+    Then the file "results/basic.html" should contain "DOCTYPE html PUBLIC"
+    And the file "results/basic.html" should contain "<html xmlns='http://www.w3.org/1999/xhtml'>"
+    And the file "results/basic.html" should contain "<head>"
+    And the file "results/basic.html" should contain "<body"
+    And the file "results/basic.html" should contain "<title>Feature Results</title>"
+
+  Scenario: Including an image / logo
+    Then the file "results/basic.html" should contain "<img src="
+
+  Scenario: It should show start time and duration in the header
+    Then the file "results/basic.html" should contain "started:"
+    And the file "results/basic.html" should contain "duration:"
+
+  Scenario: Generating some basic stats from the erb
+    Then the file "results/basic.html" should contain "<th>Executed<"
+    And the file "results/basic.html" should contain "<th>Average Duration"
+    And the file "results/basic.html" should contain "Scenarios"
+    And the file "results/basic.html" should contain "Steps"
+
+  Scenario: It should capture scenario and step statuses
+    Then the file "results/basic.html" should contain "Passed"
+    And the file "results/basic.html" should contain "Failed"
+    And the file "results/basic.html" should contain "Pending"
+    And the file "results/basic.html" should contain "Undefined"
+    And the file "results/basic.html" should contain "Skipped"
+
+  Scenario: It should display scenario names
+    Then the file "results/basic.html" should contain "A passing scenario"
+    And the file "results/advanced.html" should contain "A scenario outline"
+    And the file "results/background.html" should contain "Another passing scenario"
+
+  Scenario: It should display scenario steps
+    Then the file "results/basic.html" should contain "it should say hello"
+    And the file "results/background.html" should contain "it should say hello"
+    And the file "results/advanced.html" should contain "I am using a scenario outline"
+
+  Scenario: It should display the step and data for scenario outline steps
+    Then the file "results/advanced.html" should contain "I use aaa"
+    And the file "results/advanced.html" should contain "I use bbb"
+
+  Scenario: It should display descriptions for features
+    Then the file "results/basic.html" should contain "As a stakeholder"
+    Then the file "results/basic.html" should contain "I want to see some details about this feature"
+    Then the file "results/basic.html" should contain "So that I have some idea why this test matters"
+
+  Scenario: It should display a nested table
+    Then the file "results/advanced.html" should contain "<th>key1</th>"
+    And the file "results/advanced.html" should contain "<th>key2</th>"
+    And the file "results/advanced.html" should contain "<th>key3</th>"
+    And the file "results/advanced.html" should contain "<td>value1</td>"
+    And the file "results/advanced.html" should contain "<td>value2</td>"
+    And the file "results/advanced.html" should contain "<td>value3</td>"
+
+  Scenario: It should display the multi-line argument
+    Then the file "results/advanced.html" should contain "Hello with"
+    And the file "results/advanced.html" should contain "more than one"
+    And the file "results/advanced.html" should contain "line in a string"
+
+  Scenario: It should display errors for features
+    Then the file "results/basic.html" should contain "RSpec::Expectations::ExpectationNotMetError"
+    And the file "results/advanced.html" should contain "RSpec::Expectations::ExpectationNotMetError"
+    And the file "results/failing_background.html" should contain "RSpec::Expectations::ExpectationNotMetError"
+
+  Scenario: It should display error message with a yellow background and red text
+    Then the file "results/basic.html" should contain "RSpec::Expectations::ExpectationNotMetError"
+    And the background of the error message row should be "rgba(249, 231, 8, 1)"
+    And the text of the of the error message row should be "rgba(0, 0, 0, 1)"
+
+  Scenario: Embedding an image into the page
+    Then the file "results/basic.html" should contain "<img id='img_0' style='display: none' src='images/autotrader.png'/>"
+    And the file "results/basic.html" should contain "<a href='' onclick="
+    And the file "results/basic.html" should contain "img=document.getElementById('img_0'); img.style.display = (img.style.display == 'none' ? 'block' : 'none');return false"
+    And the file "results/basic.html" should contain ">AutoTrader</a>"
+
+  Scenario: Displaying a background
+    Then the file "results/background.html" should contain "Background: A scenario can have a background"
+    And the file "results/background.html" should contain "When  Cucumber puts"
+
+  Scenario: Feature pages should have a link back to the report summary
+    Then the file "results/advanced.html" should contain "<a href="
+
+  Scenario: Should create directories when directories exist in features directory
+    Then the following files should exist:
+    | results/more/more.html |
+
+  Scenario: Should create a directory for each directory under features
+    Then the following files should exist:
+    | results/onemore/more.html |
+    | results/onemore/deep/more.html |
+
+  Scenario: It should replace the header for the feature pages
+    When I have a feature header partial in the correct location
+    And I run `cucumber fixtures --profile fixture`
+    Then the file "results/basic.html" should contain "The Code Monkeys"
+    And the file "results/basic.html" should contain "Feature Results"
+    And I should remove the feature header partial file

data/features/pretty_face_report.feature

@@ -0,0 +1,81 @@
+@no-clobber
+Feature: pretty face report
+  
+  Background:
+    When I run `cucumber fixtures --profile fixture`
+
+  Scenario: Cucumber crefates an html report
+    Then the following files should exist:
+    | results/fixture.html |
+
+  Scenario: Generating the basic html page from the erb
+    Then the file "results/fixture.html" should contain "DOCTYPE html PUBLIC"
+    And the file "results/fixture.html" should contain "<html xmlns='http://www.w3.org/1999/xhtml'>"
+    And the file "results/fixture.html" should contain "<head>"
+    And the file "results/fixture.html" should contain "<body"
+    And the file "results/fixture.html" should contain "<title>Test Results</title>"
+
+  Scenario: Generating some basic stats from the erb
+    Then the file "results/fixture.html" should contain "<th>Executed<"
+    And the file "results/fixture.html" should contain "<th>Average Duration"
+    And the file "results/fixture.html" should contain "Scenarios"
+    And the file "results/fixture.html" should contain "Steps"
+
+  Scenario: Including the styles for the main page
+    Then the file "results/fixture.html" should contain "<link href='stylesheets/style.css' type='text/css' rel='stylesheet' />"
+    And the file "results/fixture.html" should not contain "</style>"
+    
+  Scenario: Including an image / logo
+    Then the file "results/fixture.html" should contain "<img src="
+
+  Scenario: It should copy the style sheet to the stylesheets directory
+    Then the following files should exist:
+      | results/stylesheets/style.css |
+
+  Scenario: It should copy the logo image to the images directory
+    Then the following files should exist:
+    | results/images/face.png |
+
+  Scenario: It should show start time and duration in the header
+    Then the file "results/fixture.html" should contain "started:"
+    And the file "results/fixture.html" should contain "duration:"
+
+  Scenario: It should capture scenario and step statuses
+    Then the file "results/fixture.html" should contain "Passed"
+    And the file "results/fixture.html" should contain "Failed"
+    And the file "results/fixture.html" should contain "Pending"
+    And the file "results/fixture.html" should contain "Undefined"
+    And the file "results/fixture.html" should contain "Skipped"
+
+  Scenario: It should display all of the tests with failures
+    Then the file "results/fixture.html" should contain "Tests With Failures:"
+
+  Scenario: It should display a list of all features / scenarios
+    Then the file "results/fixture.html" should contain "Feature Overview:"
+
+  Scenario: It should display useful information about each scenario
+    Then the file "results/fixture.html" should contain "Feature"
+    And the file "results/fixture.html" should contain "File"
+    And the file "results/fixture.html" should contain "Passed"
+    And the file "results/fixture.html" should contain "Failed"
+    And the file "results/fixture.html" should contain "Pending"
+    And the file "results/fixture.html" should contain "Undefined"
+    And the file "results/fixture.html" should contain "Skipped"
+
+  Scenario: It should display the data from scenario outlines
+    Then the file "results/fixture.html" should contain "| aaa | bbb |"
+    And the file "results/fixture.html" should contain "| ccc | ddd |"
+  
+  Scenario: It should replace the logo image on the top level page
+    When I have a logo file in the correct location
+    And I run `cucumber fixtures --profile fixture`
+    Then the file "results/fixture.html" should contain "img src='images/logo.png'"
+    And I should remove the logo file
+
+  Scenario: It should replace the header for the main page of the report
+    When I have a suite header partial in the correct location
+    And I run `cucumber fixtures --profile fixture`
+    Then the file "results/fixture.html" should contain "The Code Monkeys"
+    And the file "results/fixture.html" should contain "Test Results"
+    And I should remove the suite header partial file
+

data/features/step_definitions/report_steps.rb

@@ -0,0 +1,36 @@
+require 'fileutils'
+
+When /^I have a logo file in the correct location$/ do
+  FileUtils.cp "features/support/logo.png", "features/support/ugly_face/"
+end
+
+Then /^I should remove the logo file$/ do
+  FileUtils.rm "features/support/ugly_face/logo.png"
+end
+
+When /^I have a suite header partial in the correct location$/ do
+  FileUtils.cp "features/support/_suite_header.erb", "features/support/ugly_face/"
+end
+
+Then /^I should remove the suite header partial file$/ do
+  FileUtils.rm "features/support/ugly_face/_suite_header.erb"
+end
+
+When /^I have a feature header partial in the correct location$/ do
+  FileUtils.cp "features/support/_feature_header.erb", "features/support/ugly_face/"
+end
+
+Then /^I should remove the feature header partial file$/ do
+  FileUtils.rm "features/support/ugly_face/_feature_header.erb"
+end
+
+Then(/^the background of the error message row should be "(.*?)"$/) do |background|
+  @browser = Watir::Browser.new :firefox
+  visit ErrorDisplay do |page|
+    expect(page.error_background).to include background
+  end
+end
+
+Then(/^the text of the of the error message row should be "(.*?)"$/) do |color|
+  expect(on(ErrorDisplay).error_text_color).to include color
+end

data/features/support/_feature_header.erb

@@ -0,0 +1,2 @@
+<h1>The Code Monkeys</h1>
+<h2>Feature Results:</h2>

data/features/support/_suite_header.erb

@@ -0,0 +1,2 @@
+<h1>The Code Monkeys</h1>
+<h2>Feature Results:</h2>

data/features/support/env.rb

@@ -0,0 +1,20 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '../../', 'lib'))
+
+require 'aruba/cucumber'
+require 'page-object'
+require 'ugly_face'
+require 'watir-webdriver'
+
+World PageObject::PageFactory
+
+Aruba.configure do |config|
+  config.working_directory = "."
+end
+
+Before do
+  @dirs = [File.join(File.dirname(__FILE__), '..', '..')]
+end
+
+After do
+  @browser.close if @browser
+end

data/features/support/error_display.rb

@@ -0,0 +1,16 @@
+class ErrorDisplay
+  include PageObject
+
+  page_url "file://#{File.dirname(__FILE__)}/../../results/basic.html"
+
+  element(:error, :tr, :class => 'error')
+
+  def error_background
+    error_element.style('background-color')
+  end
+
+  def error_text_color
+    error_element.style('color')
+  end
+  
+end

data/features/support/hooks.rb

@@ -0,0 +1,11 @@
+require 'fileutils'
+
+Before do
+  @aruba_timeout_seconds = 60
+  FileUtils.mkdir('results') unless File.exists? 'results'
+end
+
+After do
+  file = File.join(File.dirname(__FILE__), '..', '..', 'fixture.html')
+ # FileUtils.rm file
+end

data/fixtures/advanced.feature

@@ -0,0 +1,57 @@
+Feature: Advanced scenarios
+
+  Scenario Outline: A scenario outline
+    Given I am using a scenario outline
+    When I use <first>
+    And I use <second>
+    Then the examples should work
+
+  Examples:
+  | first | second |
+  | aaa   | bbb    |
+  | ccc   | ddd    |
+  | eee   | fff    |
+    
+  Scenario: Nested table in a step
+    When I have a nested table step like this:
+    | key1   | key2   | key3   |
+    | value1 | value2 | value3 |
+    Then the table should be displayed in the results
+
+  Scenario: A scenario with muti-line arguments
+    When Cucumber puts
+      """
+      Hello with
+      more than one
+      line in a string
+      """
+    Then it should say
+      """
+      Hello with
+      more than one
+      line in a string
+      """
+
+  Scenario Outline:  Fails during examples
+    Given I am using a scenario outline
+    When I fail with <first>
+    Then I use <second>
+    Then the examples should not work
+  
+  Examples:
+  | first | second |
+  | aaa   | bbb    |
+  | ccc   | ddd    |
+  | eee   | fff    |
+  
+  Scenario Outline:  Fails before examples
+    Given the first step fails
+    When I use <first>
+    And I use <second>
+    Then the examples should not work
+
+  Examples:
+  | first | second |
+  | aaa   | bbb    |
+  | ccc   | ddd    |
+  | eee   | fff    |

data/fixtures/background.feature

@@ -0,0 +1,10 @@
+Feature: Background for scenarios
+
+  Background: A scenario can have a background
+    When Cucumber puts "hello" in a background
+
+  Scenario: A passing scenario
+    Then it should say hello
+
+  Scenario: Another passing scenario
+    Then it should say hello

data/fixtures/basic.feature

@@ -0,0 +1,20 @@
+Feature: Basic scenarios
+  As a stakeholder
+  I want to see some details about this feature
+  So that I have some idea why this test matters
+
+  Scenario: A passing scenario
+    When Cucumber puts "hello"
+    Then it should say hello
+
+  Scenario: A failing scenario
+    When the first step fails
+    Then the second step should not execute
+
+  Scenario: A pending scenario
+    When the first step is pending
+    Then the second step is undefined
+
+  Scenario: A undefined scenario
+    When all steps are undefined
+    Then the scenario is undefined

data/fixtures/failing_background.feature

@@ -0,0 +1,7 @@
+Feature: Failing Background for scenarios
+
+  Background: A scenario can have a failing background
+    Given the first step fails
+
+  Scenario: A scenario with failing background
+    Then the second step should not execute

data/fixtures/more/more.feature

@@ -0,0 +1,8 @@
+Feature: More scenarios
+  As a stakeholder
+  I want to see some details about this feature
+  So that I have some idea why this test matters
+
+  Scenario: A passing scenario with more
+    When Cucumber puts "hello"
+    Then it should say hello

data/fixtures/onemore/deep/more.feature

@@ -0,0 +1,8 @@
+Feature: More scenarios
+  As a stakeholder
+  I want to see some details about this feature
+  So that I have some idea why this test matters
+
+  Scenario: A passing scenario with more
+    When Cucumber puts "hello"
+    Then it should say hello

data/fixtures/onemore/more.feature

@@ -0,0 +1,8 @@
+Feature: More scenarios
+  As a stakeholder
+  I want to see some details about this feature
+  So that I have some idea why this test matters
+
+  Scenario: A passing scenario with more
+    When Cucumber puts "hello"
+    Then it should say hello

data/fixtures/step_definitions/advanced_steps.rb

@@ -0,0 +1,34 @@
+Given /^I am using a scenario outline$/ do
+
+end
+
+When /^I use (.*?)$/ do |value|
+
+end
+
+When /^I fail with (.*?)$/ do |value|
+  expect(true).to be false
+end
+
+
+Then /^the examples should(?: not)? work$/ do
+  sleep 1
+end
+
+When /^I have a nested table step like this:$/ do |table|
+
+end
+
+Then /^the table should be displayed in the results$/ do
+
+end
+
+When /^Cucumber puts$/ do |some_string|
+  puts some_string
+  @last_string = some_string
+  sleep 1
+end
+
+Then /^it should say$/ do |some_string|
+  expect(@last_string).to eql some_string
+end

data/fixtures/step_definitions/basic_steps.rb

@@ -0,0 +1,25 @@
+When /^Cucumber puts "(.*?)"$/ do |some_string|
+  puts some_string
+  embed('autotrader.png', 'image/png', 'AutoTrader')
+  sleep 1
+end
+
+When /^Cucumber puts "(.*?)" in a background$/ do |some_string|
+  puts some_string
+end
+
+Then /^it should say hello$/ do
+  puts "It said hello"
+end
+
+When /^the first step fails$/ do
+  expect(true).to be false
+end
+
+Then /^the second step should not execute$/ do
+  puts "Should not execute"
+end
+
+When /^the first step is pending$/ do
+  pending
+end

data/fixtures/support/env.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '../../', 'lib'))
+
+require 'ugly_face'