launcuke 0.0.0 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NzI2M2UzMjhjNWFmZWY4ZGZjOTAyZmNmY2ZmODUyZDUxNDRjMjI3Zg==
+    ODgyNmIwNzBhOWJlNjk3NjYzN2E4NDlmOGNmZDczMDE4ZTM0ODY5OA==
   data.tar.gz: !binary |-
-    NDVhOGY2YzQyODQ0NjNlN2JmNDgwYzM5MjJiZDUwOWZlNmFlZjUxZg==
+    YzdkOTBhNjFiZDliZDA4NzFlMmE5ODU2Y2Q0MmI3NTE2YzFmYzNlOQ==
 SHA512:
   metadata.gz: !binary |-
-    OTA0Y2RiZWE1ODRhOGU4ZGMzNGFlNzEyODllNWQ1MGQ2YzA2OTEzYjYxZmE0
-    Y2ZjOTQwYzAwOWJkYzRiMjRhZWJiMWIyODc5NTAzOTI4NDlmNzdkMzZkNWM0
-    M2E5NGQ0ZGRiYjNlOWQ4ZWMzMjYxYzE2MjE4MGViZjUyMzAzZDY=
+    MjVjNWU2ZWFiM2I4MWIzYWE2MzdmZDc0NjQxOTQwODBlMDBlMWM3MjFlNTlh
+    Y2IwNTM1NTAyZDkzYWZmYTk0NTdhNDQxMDUyY2FkNzU3NmIwMThjM2M1MWFj
+    MWQ1NDlkOWQwZWQxMzM0MTliNzQzN2Q1Y2ZlN2FlN2UzYjRiNmI=
   data.tar.gz: !binary |-
-    ODU1ZjMzZTc3OTEwYTUzZTI2YTQ3YzVhMWFmN2VkYWRiZTk2NWE0OGVjYjA3
-    NTk4ZTk0NDg3YjY2NGYzYWI1NWJiNDNiYjJhYzhkNjY2NWZhOTc5MTUwZjdi
-    NGEzZDIwOWFmY2MwYzRmMWU3YzNkYzE4MTZmZTY4YTM0NzljZDI=
+    MzkwZDBjYjI0OTEwNGI4OTYzNWE5MGM3NDY5YmY5ZTU4ZjIzODBmYjVjODJl
+    ZWY1Njc1Yzk3NTMxYTBhODgwNzg2NDI3ODk4ZWQ5NmE5ZTkzMzJiZmMwNTIx
+    NTRmNTY1MmQ0MzdkMGVhZmYyZmY0YzQ0Mjc4NzQ5MmQ0MTc5YTk=

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'cucumber'
+gem 'rspec'
+gem 'nokogiri'

data/README.md

@@ -0,0 +1,31 @@
+# Launcuke
+
+Run your cucumber test and generate a index html page to show all reports by feature.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'launcuke'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install launcuke
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/launcuke/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/launcuke.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/launcuke/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'launcuke'
+  s.date        = '2014-11-24'
+  s.summary     = "Launch cuke!"
+  s.description = "A simple cucumber runner gem"
+  s.authors     = ["Yi MIN"]
+  s.email       = 'tebat804@gmail.com'
+  s.files       = ["lib/launcuke.rb"]
+  s.homepage    =
+    'http://rubygems.org/gems/launcuke'
+  s.files         = `git ls-files`.split($\)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.license       = 'MIT'
+  s.require_paths = ["lib"]
+  s.version       = Launcuke::VERSION
+  s.add_dependency 'cucumber'
+  s.add_dependency 'rspec'
+  s.add_dependency 'nokogiri'
+end

data/lib/launcuke/index.rb

@@ -0,0 +1,59 @@
+module Launcuke
+
+  # Generate the index page reporting on the features and their status.
+  # Provides the links to the actual full Cucumber html reports.
+  class ReportsIndex
+
+    # Collection of ran features directories results used for reporting
+    attr_reader :features_dirs
+
+    # Full path for the index html file
+    attr_reader :index_path
+
+    def initialize(reports_path, features_dirs)
+      @features_dirs = features_dirs
+      @index_path = File.join(reports_path, "index.html")
+    end
+
+    def generate
+      index_file = File.new(index_path, "w")
+
+      b = Builder::XmlMarkup.new :target => index_file, :indent => 2
+      b.html {
+        b.head {
+          b.title("Cucumber Reports")
+          b.style(css_content)
+        }
+        b.body {
+          b.h2("Features")
+          b.ul {
+            features_dirs.each { |features_dir|
+                b.li(:class => (features_dir.failed? ? "failed" : "success")) {
+                  b.a(features_dir.human_name, :href => "#{features_dir.dir_name}.html")
+                  b.span("[#{features_dir.duration}]", :class => "duration")
+                  b.span("Scenarios: #{features_dir.scenarios_results}, Steps: #{features_dir.steps_results}", :class => "result")
+                }
+            }
+          }
+        }
+      }
+
+      index_file.close
+    end
+
+    private
+
+    def css_content
+      <<-CSS
+        body {font-family: "Lucida Grande", Helvetica, sans-serif; margin: 2em 8em 2em 8em;}
+        ul {list-style-type: square;}
+        li {margin: 1em 0 1em 0;}
+        li span {float: right; margin-left: 1em; padding: 0 0.3em;}
+        li.failed span.result{background: #DC6E6E;}
+        li.success span.result{background: #C1E799;}
+        span.duration {color: #999999;}
+      CSS
+    end
+
+  end
+end

data/lib/launcuke/runner.rb

@@ -0,0 +1,197 @@
+require 'launcuke/index'
+
+module Launcuke
+
+  # Wrapper of {Kernel#system} method for test/mock
+  class SystemCommand
+
+    def run(full_command_as_array)
+      system *full_command_as_array
+    end
+
+    def exit(status = 0)
+      Kernel.exit(status == 0)
+    end
+
+  end
+
+  # Set of features under one specific directory
+  class FeaturesDir
+
+    # Directory name fo the features
+    attr_reader :dir_name
+
+    # Result string for passed/failed scenarios
+    attr_accessor :scenarios_results
+
+    # Result string for passed/failed steps
+    attr_accessor :steps_results
+
+    # Running time in ms for all features in this feature directory
+    attr_accessor :duration
+
+    # True if a scenario or step has failed for this set of features
+    attr_writer :failed
+
+    def initialize(directory_name)
+      @dir_name = directory_name
+      @failed = false
+      @scenarios_results = ""
+      @steps_results = ""
+    end
+
+    # True if one feature has failed
+    def failed?
+      (scenarios_results.include?"failed") || (steps_results.include?"failed")
+    end
+
+    # Human readable name used for index page (ex: user_logout --> User logout)
+    def human_name
+      dir_name.gsub(/[_-]/, " ").capitalize
+    end
+
+  end
+
+  # Actual clas that will spawn one command process per directory of features collected
+  # according to configuration
+  class Runner
+
+    # Root path to your features directory. Ex: your_project/features
+    attr_accessor :features_root_path
+
+    # Optional name for directory containing the reports. Default to 'cucumber_reports'
+    attr_accessor :output_dir_name
+
+    # Optional full path for generated reports. Default to ../{features_root_path}.
+    attr_accessor :output_path
+
+    # Optional regexp for name of features directories to exclude.
+    attr_accessor :excluded_dirs
+
+    # Optional only the features directories to be included
+    attr_accessor :included_only_dirs
+
+    # Array of extra options to pass to the command. Ex: ["-p", "my_profile", "--backtrace"]
+    attr_accessor :extra_options
+
+    # Define the size for the pool of forks. Default is 5
+    attr_accessor :forks_pool_size
+
+    # Full final path where html reports will be generated
+    attr_reader :reports_path
+
+    # Optional. If true will generate index file but not launch processes. Used for testing.
+    attr_accessor :dry_run
+
+    # Add cucumber --require option load *.rb files under features root path by default unless specified to false.
+    attr_accessor :require_features_root_option
+
+    # Delegate to a wrapper of system call in order mock/test
+    attr_accessor :system_command
+
+    def initialize(features_root)
+      @features_root_path = features_root
+      @extra_options ||= []
+      yield self if block_given?
+
+      @dry_run = false if dry_run.nil?
+      @forks_pool_size ||= 5
+      @require_features_root_option = true if require_features_root_option.nil?
+      @output_dir_name = "#{@extra_options[1]}" unless output_dir_name
+      @output_path = File.expand_path("../reports", output_dir_name) unless output_path
+      @excluded_dirs ||= []
+      @included_only_dirs ||= []
+
+      @reports_path = File.join(output_path, output_dir_name)
+      @system_command ||= SystemCommand.new
+    end
+
+    def start
+      FileUtils.mkdir_p reports_path
+      exit_status = launch_process_per_dir
+      collect_results
+      reports = ReportsIndex.new(reports_path, features_dirs).generate
+      puts "See reports index at #{reports.index_path}" if reports
+      system_command.exit(exit_status)
+    end
+
+    private
+
+    def launch_process_per_dir
+      if dry_run
+        0
+      else
+
+        results = features_dirs.each { |features_dir|
+            report_file_path = File.join(reports_path, "#{features_dir.dir_name}.html")
+            feature_full_path = File.join(features_root_path, "#{features_dir.dir_name}")
+            main_command = %W[bundle exec cucumber #{feature_full_path}]
+            options = %W[--format html --out #{report_file_path}]
+            options.concat %W[--require #{features_root_path}] if require_features_root_option
+            full_command = main_command + options + extra_options
+            result = system_command.run full_command
+            puts "Features '#{features_dir.dir_name.upcase}' finished. #{result ? 'SUCCESS' : 'FAILURE'} (pid: #{Process.pid})"
+            result
+        }
+
+
+        global_exit_status = results.inject(0) { |acc, result|
+          result ? acc : acc +1
+        }
+        puts "Global exit status = #{global_exit_status}"
+        global_exit_status
+      end
+    end
+
+    def collect_results
+      features_dirs.each { |features_dir|
+        feature_file = File.join(reports_path, "#{features_dir.dir_name}.html")
+        File.open(feature_file) { |file|
+          content = file.read
+          duration_match = content.match(/Finished in\s+<\w+>(.*?)</)
+          duration = duration_match ? duration_match.captures.first : ""
+          scenarios_match = content.match(/\d+ scenarios? \((.*?)\)/)
+          scenarios =  scenarios_match ? scenarios_match.captures.first : ""
+          steps_match = content.match(/\d+ steps? \((.*?)\)/)
+          steps =  steps_match ? steps_match.captures.first : ""
+
+          features_dir.scenarios_results = scenarios
+          features_dir.steps_results = steps
+          features_dir.duration = duration
+        } if File.exists?(feature_file)
+      }
+    end
+
+    def features_dirs
+      @features_dirs ||= resolve_features_dirs_name
+    end
+
+    def resolve_features_dirs_name
+      Dir.glob(File.join(features_root_path, "*", "*.feature")).select{ |path|
+        configured_dir?(path)
+      }.map { |feature_path|
+        dir_name = File.basename(File.dirname(feature_path))
+        FeaturesDir.new(dir_name)
+      }.uniq { |feature_dir|
+        feature_dir.dir_name
+      }
+    end
+
+    def configured_dir?(path)
+      if included_only_dirs.empty?
+        included_dir?(path)
+      else
+        exact_word_match_expressions = included_only_dirs.map { |dir_name|
+          "\\b#{dir_name}\\b"
+        }
+        path.match(Regexp.new(exact_word_match_expressions.join("|")))
+      end
+    end
+
+    def included_dir?(path)
+      excluded_dirs.empty? || (not path.match(Regexp.new(excluded_dirs.join("|"))))
+    end
+
+  end
+
+end

data/lib/launcuke/version.rb

@@ -0,0 +1,3 @@
+module Launcuke
+  VERSION = '0.0.2'
+end

data/lib/launcuke.rb

@@ -1,5 +1,6 @@
-class Launcuke
-  def self.hi
-    puts "Hello world!"
-  end
-end
+require "launcuke/version"
+require "launcuke/runner"
+
+require 'fileutils'
+require 'builder'
+require 'nokogiri'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: launcuke
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.2
 platform: ruby
 authors:
 - Yi MIN
@@ -9,14 +9,62 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2014-11-24 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A simple cucumber runner gem
 email: tebat804@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
+- README.md
+- launcuke.gemspec
 - lib/launcuke.rb
+- lib/launcuke/index.rb
+- lib/launcuke/runner.rb
+- lib/launcuke/version.rb
 homepage: http://rubygems.org/gems/launcuke
 licenses:
 - MIT