selenium-reporter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c66eba291cae96f8c635ddca9ec1024032e05435
+  data.tar.gz: e8b737e8b206e25461e17231588c4cb309a1b01e
+SHA512:
+  metadata.gz: 70aa97d7397e5099521581e971c4a1fe1b5f3417886e0c575270fee9df8e90823df19772f4f72b794e1287d9020eee9d86ef900231cbffd1c66165169b7ca32c
+  data.tar.gz: 9f6eea37bf02d4deb94ff130bf316cd636fff5cdf93abad953d5c6dfca32877d9cb8305360e27b9135d9b64360eeb479ddb747321b33f413121b1e1e9ee8288a

data/.gitignore

@@ -0,0 +1,7 @@
+*.lock
+.*.swp
+.DS_Store
+spec/results
+tmp/
+results/
+pkg/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.txt

@@ -0,0 +1,60 @@
+= selenium-reporter
+
+== DESCRIPTION:
+
+A report helper, generator, and viewer for Selenium that displays failure screenshots and stacktraces in an HTML digest.
+
+== INSTALLATION:
+
+gem install selenium-reporter
+
+== USAGE:
+
+=== Environment Variables
+
+SE_OUTPUT_DIR (relative path to where you want to store screenshots and the final report)
+
+=== Capturing Screenshots
+
+ENV['SE_OUTPUT_DIR'] = 'results'
+reporter = SeleniumReporter.new
+driver = Selenium::WebDriver.for :firefox
+driver.save_screenshot(reporter.screenshot_file)
+
+NOTE: This will overwrite result output from previous test runs
+
+=== Generating a Report
+
+reporter.generate_report
+
+NOTE: This will generate an HTML report in a sub-directory within the output directory you specified
+
+=== Viewing a Report
+
+reporter.serve_report
+
+NOTE: This will start a local web server and make the final report available at http://localhost:4567
+
+== LICENSE:
+
+The MIT License (MIT)
+
+Copyright (c) 2014 Dave Haeffner
+
+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/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+

data/lib/selenium-reporter.rb

@@ -0,0 +1,70 @@
+require_relative 'selenium-reporter/config-checker'
+require_relative 'selenium-reporter/system/folder'
+require 'uuid'
+require 'rspec'
+
+class SeleniumReporter
+
+  attr_reader :output_dir
+
+  def initialize
+    ConfigChecker.new
+    make_absolute ENV['SE_OUTPUT_DIR']
+    System::Folder.prepare
+    load_rspec_config
+  end
+
+  def screenshot_file
+    "#{screenshot_dir}/#{UUID.new.generate}.png"
+  end
+
+  def generate_report
+    system("java -jar #{allure_cli} generate #{xml_dir} -o #{report_dir}")
+  end
+
+  def serve_report
+    ENV['SE_REPORT_DIR'] = report_dir
+    @pid = Process.spawn('ruby lib/selenium-reporter/report-server.rb')
+  end
+
+  def stop_report
+    Process.kill("KILL", @pid)
+    ENV['SE_REPORT_DIR'] = nil
+  end
+
+  private
+
+    def pwd
+      Dir.pwd
+    end
+
+    def make_absolute(relative_path)
+      @output_dir = File.join(pwd, ENV['SE_OUTPUT_DIR'])
+      ENV['SE_OUTPUT_DIR'] = output_dir
+    end
+
+    def screenshot_dir
+      output_dir + '/screenshot'
+    end
+
+    def xml_dir
+      output_dir + '/xml'
+    end
+
+    def report_dir
+      output_dir + '/report'
+    end
+
+    def allure_cli
+      File.join(pwd, 'bin/allure/allure-cli-2.1.jar')
+    end
+
+    def load_rspec_config
+      require 'nokogiri' # this is a dependent lib for allure-rspec
+      require 'allure-rspec'
+      AllureRSpec.configure do |c|
+        c.output_dir = xml_dir
+      end
+    end
+
+end

data/lib/selenium-reporter/config-checker.rb

@@ -0,0 +1,20 @@
+class SeleniumReporter
+
+  class ConfigChecker
+
+    def initialize
+      output_dir_check
+    end
+
+    private
+
+      ERRORS = { NoOutputDirSpecified: 'You need to specify an output directory (e.g., SE_OUTPUT_DIR).' }
+
+      def output_dir_check
+        if ENV['SE_OUTPUT_DIR'].nil?
+          raise ERRORS[:NoOutputDirSpecified]
+        end
+      end
+
+  end
+end

data/lib/selenium-reporter/report-server.rb

@@ -0,0 +1,14 @@
+require 'sinatra/base'
+
+class SeleniumReporter
+  class ReportServer < Sinatra::Base
+
+    set :public_folder, ENV['SE_REPORT_DIR']
+
+    get '/' do
+      redirect '/index.html'
+    end
+
+    run! if app_file == $0
+  end
+end

data/lib/selenium-reporter/system/folder.rb

@@ -0,0 +1,47 @@
+class SeleniumReporter
+  module System
+    module Folder
+
+      extend self
+
+      def prepare
+        unless exists?
+          create!
+        else
+          clean!
+        end
+      end
+
+      private
+
+        def exist?
+          File.directory?(ENV['SE_OUTPUT_DIR'])
+        end
+
+        def exists?
+          !Dir.glob(ENV['SE_OUTPUT_DIR'] + '/*').empty?
+        end
+
+        def create!
+          FileUtils.mkdir_p(ENV['SE_OUTPUT_DIR'])
+          FileUtils.mkdir_p(ENV['SE_OUTPUT_DIR'] + '/screenshot')
+          FileUtils.mkdir_p(ENV['SE_OUTPUT_DIR'] + '/xml')
+          FileUtils.mkdir_p(ENV['SE_OUTPUT_DIR'] + '/report')
+        end
+
+        def empty?
+          Dir.glob("#{ENV['SE_OUTPUT_DIR']}/*").empty?
+        end
+
+        def empty!
+          FileUtils.rm_rf Dir.glob("#{ENV['SE_OUTPUT_DIR']}/*")
+        end
+
+        def clean!
+          empty!
+          create!
+        end
+
+    end
+  end
+end

data/lib/selenium-reporter/version.rb

@@ -0,0 +1,3 @@
+class SeleniumReporter
+  VERSION = '0.1.0'
+end

data/selenium-reporter.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'selenium-reporter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'selenium-reporter'
+  spec.version       = SeleniumReporter::VERSION
+  spec.authors       = ['Dave Haeffner']
+  spec.email         = ['dhaeffner@gmail.com']
+  spec.summary       = %q{See README.txt for details.}
+  spec.description   = %q{Generate HTML test reports more easily.}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'allure-rspec', '~> 0.6.5'
+  spec.add_dependency 'nokogiri', '~> 1.6.3.1'
+  spec.add_dependency 'uuid', '~> 2.3.7'
+  spec.add_dependency 'sinatra', '~> 1.4.5'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.3.2'
+  spec.add_development_dependency 'rspec', '~> 3.1.0'
+  spec.add_development_dependency 'guard-rspec', '~> 4.3.1'
+  spec.add_development_dependency 'selenium-webdriver', '~> 2.43.0'
+  spec.add_development_dependency 'typhoeus', '~> 0.6.9'
+end

data/spec/config-checker_spec.rb

@@ -0,0 +1,15 @@
+require_relative '../lib/selenium-reporter/config-checker'
+
+describe 'Config Checker -> ' do
+
+  before(:each) do
+    ENV['SE_OUTPUT_DIR'] = nil
+  end
+
+  it 'no output directory set' do
+    expect { SeleniumReporter::ConfigChecker.new }.to raise_error(
+      RuntimeError,
+      'You need to specify an output directory (e.g., SE_OUTPUT_DIR).')
+  end
+
+end

data/spec/folder_spec.rb

@@ -0,0 +1,39 @@
+require_relative '../lib/selenium-reporter/system/folder'
+
+describe 'Folder manipulation' do
+
+  before(:all) do
+    @loc = ENV['SE_OUTPUT_DIR'] = File.join(Dir.pwd, 'spec/results')
+  end
+
+  before(:each) do
+    FileUtils.rm_rf(@loc)
+  end
+
+  after(:all) do
+    FileUtils.rm_rf(@loc)
+  end
+
+  it 'directory exists' do
+    FileUtils.mkdir_p(@loc)
+    expect(SeleniumReporter::System::Folder.send(:exist?)).to eql true
+  end
+
+  it 'directory creation' do
+    SeleniumReporter::System::Folder.send(:create!)
+    expect(SeleniumReporter::System::Folder.send(:exists?)).to eql true
+  end
+
+  it 'empty' do
+    SeleniumReporter::System::Folder.send(:create!)
+    SeleniumReporter::System::Folder.send(:empty!)
+    expect(SeleniumReporter::System::Folder.send(:empty?)).to eql true
+  end
+
+  it 'clean' do
+    SeleniumReporter::System::Folder.send(:clean!)
+    expect(SeleniumReporter::System::Folder.send(:empty?)).to eql false
+    expect(SeleniumReporter::System::Folder.send(:exists?)).to eql true
+  end
+
+end

data/spec/selenium-reporter_spec.rb

@@ -0,0 +1,39 @@
+require_relative '../lib/selenium-reporter'
+require 'selenium-webdriver'
+require 'typhoeus'
+
+describe 'selenium-reporter' do
+
+  it 'provides a unique file with output directory' do
+    ENV['SE_OUTPUT_DIR'] = 'spec/results'
+    screenshot_file = SeleniumReporter.new.screenshot_file
+    expect(screenshot_file).to include(ENV['SE_OUTPUT_DIR'])
+    expect(screenshot_file).to include('.png')
+  end
+
+  context 'report' do
+
+    before(:all) do
+      ENV['SE_OUTPUT_DIR'] = 'spec/results'
+      @reporter = SeleniumReporter.new
+      driver = Selenium::WebDriver.for :firefox
+      driver.get 'http://the-internet.herokuapp.com'
+      driver.save_screenshot(@reporter.screenshot_file)
+      driver.quit
+    end
+
+    it 'compiles output into a consolidated report' do
+      @reporter.generate_report
+      expect($?.exitstatus).to eql 0
+    end
+
+    it 'consolidated report is viewable in a browser' do
+      @reporter.serve_report
+      sleep 4
+      expect(Typhoeus.get('http://localhost:4567/', followlocation: true).code).to eql 200
+      @reporter.stop_report
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,201 @@
+--- !ruby/object:Gem::Specification
+name: selenium-reporter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dave Haeffner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: allure-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.5
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.3.1
+- !ruby/object:Gem::Dependency
+  name: uuid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.7
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.3.1
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.43.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.43.0
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.9
+description: Generate HTML test reports more easily.
+email:
+- dhaeffner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.txt
+- Rakefile
+- bin/allure/allure-cli-2.1.jar
+- lib/selenium-reporter.rb
+- lib/selenium-reporter/config-checker.rb
+- lib/selenium-reporter/report-server.rb
+- lib/selenium-reporter/system/folder.rb
+- lib/selenium-reporter/version.rb
+- selenium-reporter.gemspec
+- spec/config-checker_spec.rb
+- spec/folder_spec.rb
+- spec/selenium-reporter_spec.rb
+homepage: ''
+licenses:
+- MIT
+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: See README.txt for details.
+test_files:
+- spec/config-checker_spec.rb
+- spec/folder_spec.rb
+- spec/selenium-reporter_spec.rb