nanonano87-cucumber_statistics 0.0.1

data/lib/cucumber_statistics/view/combined_statistics.html.haml

@@ -0,0 +1,169 @@
+!!!
+%html{:lang => "en"}
+  %head
+    %meta{:charset => "utf-8"}/
+    %meta{:content => "IE=edge", "http-equiv" => "X-UA-Compatible"}/
+    %meta{:content => "width=device-width, initial-scale=1", :name => "viewport"}/
+    %meta{:content => "Cucumber Scenario Statistics", :name => "description"}/
+    %meta{:content => "AlienFast", :name => "author"}/
+    %title Cucumber Scenario Statistics
+    / Bootstrap core CSS
+    %link{:href => "http://netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css", :rel => "stylesheet"}/
+    / Custom styles for this layout
+    :css
+      body {
+          min-height: 2000px;
+          padding-top: 70px;
+      }
+
+      td {
+          white-space: nowrap;
+          /*max-width: 100px;*/
+      }
+      tr td:first-child {
+          overflow: hidden;
+          text-overflow: ellipsis;
+          max-width: 300px;
+      }
+    %link{:href => "https://raw.githack.com/drvic10k/bootstrap-sortable/master/Contents/bootstrap-sortable.css", :rel => "stylesheet"}/
+    / HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries
+    /[if lt IE 9]
+      <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
+      <script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
+  %body
+    / Fixed navbar
+    .navbar.navbar-default.navbar-fixed-top{:role => "navigation"}
+      .container
+        .navbar-header
+          %button.navbar-toggle{"data-target" => ".navbar-collapse", "data-toggle" => "collapse", :type => "button"}
+            %span.sr-only Toggle navigation
+            %span.icon-bar
+            %span.icon-bar
+            %span.icon-bar
+          %a.navbar-brand{:href => "#"} cucumber_statistics
+        .navbar-collapse.collapse
+          %ul.nav.navbar-nav.navbar-right
+            %li
+              %a{:href => "https://github.com/alienfast/cucumber_statistics", :target => 'other'} Github
+    / /.nav-collapse
+
+    .container
+      .navbar
+        .tabbable
+          %ul.nav.nav-tabs
+            %li.active
+              %a.content_tab{:href => "#steps_tab",:toggle=>"tab"}
+                Steps
+            %li
+              %a.content_tab{:href => "#scenarios_tab", :toggle=>"tab"}
+                Scenarios
+            %li
+              %a.content_tab{:href => "#features_tab", :toggle=>"tab"}
+                Features
+
+        .container
+          .tab-content
+            #steps_tab.tab-pane.active
+              / Main component for a primary marketing message or call to action
+              .jumbotron
+                %h1 Cucumber step statistics
+                %p ... allows you to easily identify long running steps.
+
+              .alert.alert-info
+                #{alert_info_text(overall_statistics)}
+
+              %table.table.table-bordered.table-striped.sortable
+                %thead
+                  %tr
+                    %th Step
+                    %th Fastest
+                    %th Slowest
+                    %th Variation
+                    %th Variance
+                    %th Std Deviation
+                    %th Count
+                    %th Average
+                    %th{"data-defaultsort" => "desc"} Total
+                %tbody
+
+                  - highest_average = step_statistics.highest_average
+                  - highest_total = step_statistics.highest_total
+                  - highest_variation = step_statistics.highest_variation
+
+                  - step_statistics.all.each do |step_results|
+
+                    %tr
+                      = name_td step_results
+                      = time_td step_results, :fastest
+                      = time_td step_results, :slowest
+                      = time_td step_results, :variation, highest_variation
+                      = time_td step_results, :variance
+                      = time_td step_results, :standard_deviation
+                      = count_td step_results, :count
+                      = time_td step_results, :average, highest_average
+                      = time_td step_results, :total, highest_total
+            / /container
+
+
+            #scenarios_tab.tab-pane
+              / Main component for a primary marketing message or call to action
+              .jumbotron
+                %h1 Cucumber scenario statistics
+                %p ... find those slow scenarios.
+
+              .alert.alert-info
+                #{alert_info_text(overall_statistics)}
+
+              %table.table.table-bordered.table-striped.sortable
+                %thead
+                  %tr
+                    %th Scenario File
+                    %th{"data-defaultsort" => "desc"} Time
+                %tbody
+                  - scenario_statistics.all.each do |file_name, scenario_result|
+                    %tr
+                      = std_file_td file_name, scenario_result[:scenario_name]
+                      = std_time_td scenario_result[:duration]
+            / /container
+
+
+            #features_tab.tab-pane
+              / Main component for a primary marketing message or call to action
+              .jumbotron
+                %h1 Cucumber feature statistics
+                %p ... find those slow features.
+
+              .alert.alert-info
+                #{alert_info_text(overall_statistics)}
+
+              %table.table.table-bordered.table-striped.sortable
+                %thead
+                  %tr
+                    %th Feature File
+                    %th{"data-defaultsort" => "desc"} Time
+                %tbody
+                  - feature_statistics.all.each do |file_name, feature_result|
+
+                    %tr
+                      = std_file_td file_name, feature_result[:feature_name]
+                      = std_time_td feature_result[:duration]
+    / /container
+
+
+
+    /  Bootstrap core JavaScript
+    /  \==================================================
+    / Placed at the end of the document so the pages load faster
+    %script{:src => "https://ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"}
+    %script{:src => "http://netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"}
+    %script{:src => "https://raw.githack.com/drvic10k/bootstrap-sortable/master/Scripts/moment.min.js"}
+    %script{:src => "https://raw.githack.com/drvic10k/bootstrap-sortable/master/Scripts/bootstrap-sortable.js"}
+    :javascript
+      // Initialise on DOM ready
+      $(function() {
+          $.bootstrapSortable(true, 'reversed');
+      });
+      $('a.content_tab').click(function (e) {
+        e.preventDefault();
+        $(e.target).tab('show');
+      });

data/notes.txt

@@ -0,0 +1,9 @@
+http://www.oesmith.co.uk/morris.js/lines.html
+http://drvic10k.github.io/bootstrap-sortable/
+
+http://stackoverflow.com/questions/6125265/using-layouts-in-haml-files-independently-of-rails
+http://getbootstrap.com/examples/navbar-fixed-top/
+
+
+Total time of run
+file path/name/line number of step

data/spec/cucumber_statistics/configuration_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+module CucumberStatistics
+  describe Configuration do
+
+    before do
+      Configuration.clean_tmp_dir
+    end
+
+    it 'should auto create tmp_dir' do
+
+      tmp_dir = Configuration.tmp_dir
+      expect(Dir.exists?(tmp_dir)).to be_truthy
+
+      Dir.delete tmp_dir
+      tmp_dir = Configuration.tmp_dir
+      expect(Dir.exists?(tmp_dir)).to be_truthy
+    end
+  end
+end

data/spec/cucumber_statistics/feature_statistics_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+module CucumberStatistics
+  describe FeatureStatistics do
+
+    subject(:feature_statistics) { FeatureStatistics.new }
+    subject(:overall_statistics) { OverallStatistics.new } #not sure if really need
+
+    describe 'record' do
+      it 'should create a record' do
+        record 'my feature', 50, 'features/admin_cancel_account.feature'
+
+        expect(feature_statistics.all.count).to eq 1
+        expect(feature_statistics.all['features/admin_cancel_account.feature'][:duration]).to eq 50
+      end
+
+      it 'should support multiple scenarios with the same name' do
+        record 'my feature', 50, 'admin_cancel_account.feature'
+        record 'my feature', 75, 'noise/features/super_admin/admin_cancel_account.feature'
+
+        expect(feature_statistics.all.count).to eq 2
+        expect(feature_statistics.all['admin_cancel_account.feature'][:duration]).to eq 50
+        expect(feature_statistics.all['features/super_admin/admin_cancel_account.feature'][:duration]).to eq 75
+      end
+
+      it 'chops off file path up to features/' do
+        record 'my feature', 50, '/User/some/file/path/that/doesnt/matter really/features/admin_cancel_account.feature'
+        expect(feature_statistics.all.keys.first).to eq 'features/admin_cancel_account.feature'
+      end
+
+      it 'uses the whole string if the filepath doesnt include the features folder' do
+        record 'my feature', 50, 'admin_cancel_account.feature'
+        expect(feature_statistics.all.keys.first).to eq 'admin_cancel_account.feature'
+      end
+    end
+
+    describe 'all' do
+      before(:each) do
+        record 'my feature', 24, 'admin_cancel_account.feature'
+        record 'my feature', 50, 'admin_edit_account.feature'
+      end
+
+      it 'should return all records' do
+        expect(feature_statistics.all.count).to eq 2
+        feature_statistics.all.each_with_index do |file_colon_line, data, index|
+          case index
+            when 1
+              expect(file_colon_line).to eq 'admin_cancel_account.feature'
+            when 2
+              expect(file_colon_line).to eq 'admin_edit_account.feature'
+          end
+        end
+      end
+    end
+
+    describe 'set operations' do
+      before(:each) do
+        record 'a', 25, 'admin_cancel_account.feature'
+        record 'c', 51, 'view_account.feature'
+        record 'b', 75, 'edit_account.feature'
+      end
+
+      describe 'sort_by_property' do
+        context 'should sort all records by any property' do
+          it { expect(feature_statistics.sort_by_property(:feature_name).first[0]).to eq 'admin_cancel_account.feature' }
+          it { expect(feature_statistics.sort_by_property(:feature_name).last[0]).to eq 'view_account.feature' }
+
+          it { expect(feature_statistics.sort_by_property(:duration).first[0]).to eq 'admin_cancel_account.feature' }
+          it { expect(feature_statistics.sort_by_property(:duration).last[0]).to eq 'edit_account.feature' }
+        end
+      end
+    end
+
+    def record(feature_name, duration, file)
+      feature_statistics.record feature_name, duration, file
+    end
+  end
+end

data/spec/cucumber_statistics/renderer_helper_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+module CucumberStatistics
+  describe RendererHelper do
+
+    describe '#format' do
+      it 'formats milliseconds' do
+        assert_format(0.000123, '< 0.000s')
+      end
+      it 'formats seconds' do
+        assert_format(3.123456, '3.123s')
+      end
+      it 'formats minutes' do
+        assert_format(60, '1m 0.000s')
+        assert_format(60.12345, '1m 0.123s')
+      end
+      it 'formats hours' do
+        assert_format(3600, '1h 0m 0.000s')
+        assert_format(3600.12345, '1h 0m 0.123s')
+      end
+    end
+
+    def assert_format(duration, expectation)
+      expect(RendererHelper.new.format duration).to eq(expectation)
+    end
+  end
+end

data/spec/cucumber_statistics/renderer_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+module CucumberStatistics
+  describe Renderer do
+
+    subject(:step_statistics) { StepStatistics.new }
+    subject(:scenario_statistics) { ScenarioStatistics.new }
+    subject(:feature_statistics) { FeatureStatistics.new }
+    subject(:overall_statistics) { OverallStatistics.new }
+
+    before(:each) do
+      # clean up before start, leave after in case we want to inspect it.
+      Configuration.clean_tmp_dir
+
+      overall_statistics.start_time = Time.now - 35
+      overall_statistics.feature_count_inc
+      overall_statistics.scenario_count_inc
+
+      record 'my step 1', 1.100116
+      record 'my step 1', 9.213553
+      record 'my step 2', 3.100117
+      record 'my step 2', 14.204407
+      record 'my step 3', 1.500131
+      record 'my step 3', 3.48993
+      record 'my step 4', 4.21
+      record 'my step 4', 4.21
+
+      record_scenario 'my scenario 1', 10.2, '/Users/kross/alienfast/acme/features/account management/admin_cancel_account.feature:8'
+      record_scenario 'my scenario 2', 30.2, '/Users/kross/alienfast/acme/features/account management/admin_cancel_account.feature:13'
+      record_scenario 'my scenario 3', 17.342, '/Users/kross/alienfast/acme/features/user experience/view.feature:2'
+      record_scenario 'my scenario 3', 3.2, '/Users/kross/alienfast/acme/features/user experience/view.feature:23'
+
+      record_feature 'my admin feature', 50, '/Users/kross/alienfast/acme/features/account management/admin_cancel_account.feature'
+      record_feature 'my user feature', 50, '/Users/kross/alienfast/acme/features/user experience/view.feature'
+
+      overall_statistics.end_time = Time.now
+      step_statistics.calculate
+    end
+
+
+    describe 'render statistics' do
+      context 'should render content' do
+
+        it 'renders combined results file' do
+          expect(File.exists?(Configuration.result_combined_statistics)).to eql false
+          absolute_file_name = Renderer.render_combined_statistics step_statistics, scenario_statistics, feature_statistics, overall_statistics
+          expect(File.exists?(absolute_file_name)).to eql true
+        end
+
+      end
+    end
+
+    def record(step_name, duration)
+      # fake a source for convenience
+      step_statistics.record step_name, duration, '/Users/kross/alienfast/acme/features/account management/admin_cancel_account.feature:8'
+      overall_statistics.step_count_inc
+    end
+
+    def record_scenario(scenario_name, duration, file_colon_line)
+      # fake a source for convenience
+      scenario_statistics.record scenario_name, duration, file_colon_line
+      overall_statistics.scenario_count_inc
+    end
+
+    def record_feature(feature_name, duration, file_colon_line)
+      # fake a source for convenience
+      feature_statistics.record feature_name, duration, file_colon_line
+      overall_statistics.feature_count_inc
+    end
+  end
+end

data/spec/cucumber_statistics/scenario_statistics_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+module CucumberStatistics
+  describe ScenarioStatistics do
+
+    subject(:scenario_statistics) { ScenarioStatistics.new }
+    subject(:overall_statistics) { OverallStatistics.new } #not sure if really need
+
+    describe 'record' do
+      it 'should create a record' do
+        record 'my scenario', 50, 'features/admin_cancel_account.feature:8'
+
+        expect(scenario_statistics.all.count).to eq 1
+        expect(scenario_statistics.all['features/admin_cancel_account.feature:8'][:duration]).to eq 50
+      end
+
+      it 'should support multiple scenarios with the same name' do
+        record 'my scenario', 50, 'admin_cancel_account.feature:8'
+        record 'my scenario', 75, 'noise/features/super_admin/admin_cancel_account.feature:8'
+
+        expect(scenario_statistics.all.count).to eq 2
+        expect(scenario_statistics.all['admin_cancel_account.feature:8'][:duration]).to eq 50
+        expect(scenario_statistics.all['features/super_admin/admin_cancel_account.feature:8'][:duration]).to eq 75
+      end
+
+      it 'chops off file path up to features/' do
+        record 'my scenario', 50, '/User/some/file/path/that/doesnt/matter really/features/admin_cancel_account.feature:8'
+        expect(scenario_statistics.all.keys.first).to eq 'features/admin_cancel_account.feature:8'
+      end
+
+      it 'uses the whole string if the filepath doesnt include the features folder' do
+        record 'my scenario', 50, 'admin_cancel_account.feature:8'
+        expect(scenario_statistics.all.keys.first).to eq 'admin_cancel_account.feature:8'
+      end
+    end
+
+    describe 'all' do
+      before(:each) do
+        record 'my scenario 1', 24, 'admin_cancel_account.feature:8'
+        record 'my scenario 1', 50, 'admin_cancel_account.feature:18'
+        record 'my scenario 2', 75, 'admin_cancel_account.feature:38'
+      end
+
+      it 'should return all records' do
+        expect(scenario_statistics.all.count).to eq 3
+        scenario_statistics.all.each_with_index do |file_colon_line, data, index|
+          case index
+            when 1
+              expect(file_colon_line).to eq 'admin_cancel_account.feature:8'
+            when 2
+              expect(file_colon_line).to eq 'admin_cancel_account.feature:18'
+            when 3
+              expect(file_colon_line).to eq 'admin_cancel_account.feature:38'
+          end
+        end
+      end
+    end
+
+    describe 'set operations' do
+      before(:each) do
+        record 'my scenario 1', 25, 'admin_cancel_account.feature:8'
+        record 'my scenario 2', 50, 'admin_cancel_account.feature:13'
+        record 'my scenario 3', 49, 'admin_cancel_account.feature:15'
+        record 'my scenario 1', 51, 'view_account.feature:3'
+        record 'my scenario 2', 75, 'view_account.feature:6'
+        record 'my scenario 3', 10, 'view_account.feature:22'
+      end
+
+      describe 'sort_by_property' do
+        context 'should sort all records by any property' do
+          it { expect(scenario_statistics.sort_by_property(:scenario_name).first[0]).to eq 'admin_cancel_account.feature:8' }
+          it { expect(scenario_statistics.sort_by_property(:scenario_name).last[0]).to eq 'view_account.feature:22' }
+
+          it { expect(scenario_statistics.sort_by_property(:duration).first[0]).to eq 'view_account.feature:22' }
+          it { expect(scenario_statistics.sort_by_property(:duration).last[0]).to eq 'view_account.feature:6' }
+        end
+      end
+    end
+
+    def record(scenario_name, duration, file_colon_line)
+      # fake a source for convenience
+      scenario_statistics.record scenario_name, duration, file_colon_line
+      #overall_statistics.step_count_inc
+    end
+  end
+end