multicuke 0.0.2 → 0.0.3

data/lib/multicuke/reports_index.rb

@@ -0,0 +1,56 @@
+module Multicuke
+
+  # 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
+
+    def initialize(reports_path, features_dirs)
+      @features_dirs = features_dirs
+      @index_file_path = File.join(reports_path, "index.html")
+    end
+    
+    def generate      
+      index_file = File.new(@index_file_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.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/multicuke/runner.rb

@@ -1,7 +1,7 @@
 require 'fileutils'
 require 'builder'
 require 'nokogiri'
-require 'ostruct'
+require 'multicuke/reports_index'
 
 module Multicuke
 
@@ -38,12 +38,27 @@ module Multicuke
     
   end
 
+  # Actual clas that will spawn one command process per directory of features collected
+  # according to configuration
   class Runner
 
-    attr_accessor :features_dir_path
+    # Root path to your features directory
+    attr_accessor :features_root_path
+
+    # Optional name for directory containing the reports
     attr_accessor :output_dir_name
+
+    # Optional full path for generated reports. Default to where it is run from.
     attr_accessor :output_path
-    attr_accessor :excluded_dirs, :reports_path, :dry_run
+
+    # Optional features directories to exclude
+    attr_accessor :excluded_dirs
+
+    # 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
 
     def initialize
       yield self if block_given?
@@ -57,15 +72,20 @@ module Multicuke
 
     def start
       FileUtils.mkdir_p reports_path
-      index_file_path = File.join(reports_path, "index.html")
-      index_file = File.new(index_file_path, "w")
+      launch_process_per_dir
+      collect_results
+      ReportsIndex.new(reports_path, features_dirs).generate
+    end
+
+    private
 
+    def launch_process_per_dir
       unless dry_run
         features_dirs.each { |features_dir|
           report_file_path = File.join(reports_path, "#{features_dir.name}.html")
-          feature_full_path = File.join(features_dir_path, "#{features_dir.name}")
+          feature_full_path = File.join(features_root_path, "#{features_dir.name}")
           fork {
-            command = "bundle exec cucumber #{feature_full_path} -r #{features_dir_path} --format html --out #{report_file_path}"
+            command = "bundle exec cucumber #{feature_full_path} -r #{features_root_path} --format html --out #{report_file_path}"
             p "RUNNING #{command}"
             system command
           } 
@@ -73,7 +93,9 @@ module Multicuke
           p Process.waitall         
         }
       end
+    end
 
+    def collect_results
       features_dirs.each { |features_dir|
         feature_file = File.join(reports_path, "#{features_dir.name}.html")
         File.open(feature_file) { |file|
@@ -92,42 +114,6 @@ module Multicuke
           features_dir.failed = failed
         } if File.exists?(feature_file)
       }
-
-      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.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
 
     def match_excluded_dirs(path)
@@ -140,7 +126,7 @@ module Multicuke
 
     def find_features_dirs
       @features_dirs = []
-      Dir.glob(File.join(features_dir_path, "*")).reject{ |path|
+      Dir.glob(File.join(features_root_path, "*")).reject{ |path|
         File.file?(path) || match_excluded_dirs(path)
       }.map { |feature_path|
         File.basename(feature_path)

data/lib/multicuke/version.rb

@@ -1,3 +1,3 @@
 module Multicuke
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/dryrun_spec.rb

@@ -10,7 +10,7 @@ module Multicuke
     
     it "generates index file in output folder" do
       runner = Multicuke::Runner.new do |r|
-        r.features_dir_path = File.expand_path("../features", __FILE__)
+        r.features_root_path = File.expand_path("../features", __FILE__)
         r.output_dir_name = "cuke_reports"
         r.dry_run = true
         r.output_path = RESULTS_DIR_PATH
@@ -25,7 +25,7 @@ module Multicuke
 
     it "write link to each features on index file" do
       runner = Multicuke::Runner.new do |r|
-        r.features_dir_path = File.expand_path("../features", __FILE__)
+        r.features_root_path = File.expand_path("../features", __FILE__)
         r.excluded_dirs = ["steps_definition"]
         r.dry_run = true
         r.output_path = RESULTS_DIR_PATH

data/spec/fork_spec.rb

@@ -4,9 +4,13 @@ module Multicuke
   
   describe "Forking" do
 
+    before(:each) do
+      FileUtils.rm_r(Dir.glob("#{RESULTS_DIR_PATH}/*"), :force => true)
+    end
+
     it "generates test results files" do
       runner = Multicuke::Runner.new do |r|
-        r.features_dir_path = File.expand_path("../features", __FILE__)
+        r.features_root_path = File.expand_path("../features", __FILE__)
         r.excluded_dirs = ["steps_definition"]
         r.output_path = RESULTS_DIR_PATH
       end

data/spec/runner_spec.rb

@@ -5,18 +5,17 @@ module Multicuke
   describe Runner do
       it "initializes with provided configuration" do
         runner = Multicuke::Runner.new do |r|
-          r.features_dir_path = "my_feature_path"
+          r.features_root_path = "my_feature_path"
           r.output_dir_name = "my_reports"
           r.output_path = "my_output_path"
           r.dry_run = true
           r.excluded_dirs = ["my_first_dir", "my_second_dir"]
         end
 
-        runner.features_dir_path.should == "my_feature_path"
+        runner.features_root_path.should == "my_feature_path"
         runner.output_dir_name.should == "my_reports"
         runner.output_path.should == "my_output_path"
         runner.dry_run.should be_true
-        runner.reports_path.should == "my_output_path/my_reports"
         runner.excluded_dirs.should include("my_first_dir", "my_second_dir")
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: multicuke
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -23,6 +23,7 @@ files:
 - README.md
 - Rakefile
 - lib/multicuke.rb
+- lib/multicuke/reports_index.rb
 - lib/multicuke/runner.rb
 - lib/multicuke/version.rb
 - multicuke.gemspec