parallel_calabash 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a66007ad0d753bdc9664b5f4583fc80a47536566
-  data.tar.gz: b8196f697abf267a9deba0170ad02daf366b5793
+  metadata.gz: b3cc74523250c60f0398e05a6c48f836440f25a6
+  data.tar.gz: 83f6df11b48c1f1bd8a005aed355f3eaf9a91cd3
 SHA512:
-  metadata.gz: 7a76ae1d4616bcccae2622fcd618d9df0fb3993a2d3998d3ea5acd708acab088c8f34c935c7a12db8bafbcadb861414a25dbda90d85621f45a7ba24f4a5222a6
-  data.tar.gz: eeeddfae731c1e4fe2920b72bfbe0d52617a8b85e3eb6a570413faae2523e39a29de07243e0ae49b6617ba93cae4f1465ba7c7ab8526b91ccb3810885b6d0b38
+  metadata.gz: 381b18478ffaa24329d6bbeb26834e479cbe1270606a1a401416562b84f61ec8d6b0eb229fbd4281927a7bbad7901d91057705fc7712d5da2fa277b3b6da096d
+  data.tar.gz: 95cbc60ccee529eb91c750604081c1c9ea99bb1bd8b1f57df8261dcc3fee872805535dea1518b236d90a1d0f4898b2c09c5da30200df292db6c2cac6eebdc8d3

data/.gitignore

@@ -13,3 +13,4 @@
 *.o
 *.a
 mkmf.log
+test_files

data/README.md

@@ -1,6 +1,11 @@
-# ParallelCalabash
+# calabash parallel execution
 
-TODO: Write a gem description
+## NOTE: This is not yet tested on windows.
+
+
+Run calabash-android tests in parallel on multiple connected devices. This is inspired by parallel_tests  https://rubygems.org/gems/parallel_tests
+
+eg. bundle exec parallel_calabash -a my.apk -o'--format pretty' features/ --serialize-stdout
 
 ## Installation
 
@@ -12,7 +17,7 @@ gem 'parallel_calabash'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -20,7 +25,27 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Usage: parallel_calabash [options]
+
+Example: parallel_calabash -a my.apk -o 'cucumber_opts_like_tags_profile_etc_here' features/
+
+
+    -h, --help                       Show this message
+    -v, --version                    Show version
+    -a, --apk apk_path               apk file path
+    -o, --cucumber_opts '[OPTIONS]'  execute with those cucumber options
+
+    -d distribution_tag,             divide features into groups as per occurrence of given tag
+            --distribution-tag
+        --serialize-stdout           Serialize stdout output show output only after process completion
+        
+## REPROTING
+
+use ENV['TEST_PROCESS_NUMBER'] environment variable in your ruby scripts to find out the process number. you can use this for reporting purpose.
+
+eg. modify default profile in cucumber.yml as below to get different report from different process
+
+default: --format html --out reports/Automation_report_<%= ENV['TEST_PROCESS_NUMBER'] %>.html --format pretty
 
 ## Contributing
 

data/bin/parallel_calabash

@@ -25,6 +25,10 @@ def parse_arguments(arguments)
       options[:apk_path] = apk_path
     end
 
+    opts.on("-d", "--distribution-tag distribution_tag", "divide features into groups as per occurrence of given tag") do |distribution_tag|
+      options[:distribution_tag] = distribution_tag
+    end
+
     opts.on("-o", "--cucumber_opts '[OPTIONS]'", "execute with those cucumber options") do |cucumber_opts|
       options[:cucumber_options] = cucumber_opts
     end

data/lib/parallel_calabash.rb

@@ -26,7 +26,7 @@ module ParallelCalabash
 
       test_results = nil
       report_time_taken do
-        groups = FeatureGrouper.feature_groups(options[:feature_folder], number_of_processes)
+        groups = FeatureGrouper.feature_groups(options[:feature_folder], number_of_processes,options[:distribution_tag])
         puts "#{number_of_processes} processes for #{groups.flatten.size} features"
         test_results = Parallel.map(groups, :in_threads => groups.size) do |group|
           Runner.run_tests(group, groups.index(group), options)
@@ -44,7 +44,9 @@ module ParallelCalabash
     def report_time_taken
       start = Time.now
       yield
-      puts "\nTook #{Time.now - start} seconds"
+      time_in_sec = Time.now - start
+      mm, ss = time_in_sec.divmod(60)
+      puts "\nTook #{mm} Minutes, #{ss.round(2)} Seconds"
     end
 
   end

data/lib/parallel_calabash/feature_grouper.rb

@@ -3,7 +3,11 @@ module ParallelCalabash
 
     class << self
 
-      def feature_groups(feature_folder, group_size)
+      def feature_groups(feature_folder, group_size,weighing_factor = nil)
+        weighing_factor.nil? ? feature_groups_by_feature_files(feature_folder, group_size) :  feature_groups_by_weight(feature_folder, group_size,weighing_factor)
+      end
+
+      def feature_groups_by_feature_files(feature_folder, group_size)
         files = feature_files_in_folder feature_folder
         min_number_files_per_group = files.size/group_size
         remaining_number_of_files = files.size % group_size
@@ -19,13 +23,45 @@ module ParallelCalabash
         groups.reject(&:empty?)
       end
 
-      def feature_files_in_folder feature_dir
+      def feature_files_in_folder(feature_dir)
         if File.directory?(feature_dir.first)
           files = Dir[File.join(feature_dir, "**{,/*/**}/*")].uniq
           files.grep(/\.feature$/)
         end
       end
 
+      def weight_of_feature(feature_file, weighing_factor)
+        content = File.read(feature_file)
+        content.scan(/#{weighing_factor}\b/).size
+      end
+
+      def features_with_weights(feature_dir, weighing_factor)
+        files = feature_files_in_folder feature_dir
+        features_and_weight = []
+        files.each do |file|
+          features_and_weight << {:feature => file, :weight => weight_of_feature(file, weighing_factor)}
+        end
+        features_and_weight
+      end
+
+      def feature_groups_by_weight(feature_folder, group_size, weighing_factor)
+        features = features_with_weights feature_folder, weighing_factor
+        feature_groups = Array.new(group_size).map{|e| e = []}
+        features.each do |feature|
+          feature_groups[index_of_lightest_group(feature_groups)] << feature
+        end
+        feature_groups.map{|group| group.map{|feature_hash| feature_hash[:feature]}}
+      end
+
+      def index_of_lightest_group feature_groups
+        lightest = feature_groups.min { |x, y| weight_of_group(x) <=> weight_of_group(y) }
+        index = feature_groups.index(lightest)
+      end
+
+      def weight_of_group group
+        group.inject(0) { |sum, b| sum + b[:weight] }
+      end
+
     end
 
   end

data/lib/parallel_calabash/result_formatter.rb

@@ -22,7 +22,7 @@ module ParallelCalabash
       end
 
       def summarize_results(results)
-        output = []
+        output = ["\n\n************ FINAL SUMMARY ************"]
 
         failing_scenarios = results.grep(failing_scenario_regex)
         if failing_scenarios.any?
@@ -69,7 +69,7 @@ module ParallelCalabash
       end
 
       def failing_scenario_regex
-        /^cucumber features\/.+:\d+/
+        /^cucumber .*features\/.+:\d+/
       end
 
     end

data/lib/parallel_calabash/version.rb

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

data/spec/lib/parallel_calabash/feature_grouper_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+require 'parallel_calabash/feature_grouper'
+
+describe ParallelCalabash::FeatureGrouper do
+
+  describe :feature_files_in_folder do
+    it 'should find all feature files path in the given folder' do
+      expect(ParallelCalabash::FeatureGrouper.feature_files_in_folder ['spec/test_data/features']).to eq \
+      ["spec/test_data/features/aaa.feature", "spec/test_data/features/bbb.feature", "spec/test_data/features/ccc.feature", "spec/test_data/features/ddd.feature", "spec/test_data/features/eee.feature", "spec/test_data/features/fff.feature"]
+    end
+  end
+
+  describe :feature_groups do
+
+    it 'should group all features in only one group' do
+      expect(ParallelCalabash::FeatureGrouper.feature_groups(['spec/test_data/features'], 1)).to eq \
+      [["spec/test_data/features/aaa.feature", "spec/test_data/features/bbb.feature", "spec/test_data/features/ccc.feature", "spec/test_data/features/ddd.feature", "spec/test_data/features/eee.feature", "spec/test_data/features/fff.feature"]]
+    end
+
+    it 'should divide features in 2 groups' do
+      expect(ParallelCalabash::FeatureGrouper.feature_groups(['spec/test_data/features'], 2)).to eq \
+      [["spec/test_data/features/aaa.feature", "spec/test_data/features/bbb.feature", "spec/test_data/features/ccc.feature"], ["spec/test_data/features/ddd.feature", "spec/test_data/features/eee.feature", "spec/test_data/features/fff.feature"]]
+    end
+
+    it 'should divide features in 3 groups' do
+      expect(ParallelCalabash::FeatureGrouper.feature_groups(['spec/test_data/features'], 3)).to eq \
+      [["spec/test_data/features/aaa.feature", "spec/test_data/features/bbb.feature"], ["spec/test_data/features/ccc.feature", "spec/test_data/features/ddd.feature"], ["spec/test_data/features/eee.feature", "spec/test_data/features/fff.feature"]]
+    end
+
+    it 'should divide features in 4 groups' do
+      expect(ParallelCalabash::FeatureGrouper.feature_groups(['spec/test_data/features'], 4)).to eq \
+      [["spec/test_data/features/aaa.feature", "spec/test_data/features/eee.feature"], ["spec/test_data/features/bbb.feature", "spec/test_data/features/fff.feature"], ["spec/test_data/features/ccc.feature"], ["spec/test_data/features/ddd.feature"]]
+    end
+
+    it 'should divide features in 5 groups' do
+      expect(ParallelCalabash::FeatureGrouper.feature_groups(['spec/test_data/features'], 5)).to eq \
+      [["spec/test_data/features/aaa.feature", "spec/test_data/features/fff.feature"], ["spec/test_data/features/bbb.feature"], ["spec/test_data/features/ccc.feature"], ["spec/test_data/features/ddd.feature"], ["spec/test_data/features/eee.feature"]]
+    end
+
+  end
+
+  describe :feature_weight do
+    it 'should find number of occurrence of given tag in feature' do
+      expect(ParallelCalabash::FeatureGrouper.weight_of_feature('spec/test_data/features/aaa.feature', '@tag1')).to eq 14
+    end
+
+    it 'should find number of occurrence of given tag in feature' do
+      expect(ParallelCalabash::FeatureGrouper.weight_of_feature('spec/test_data/features/bbb.feature', '@tag1')).to eq 5
+    end
+  end
+
+  describe :features_with_weights do
+    it 'should give all features along with their weights' do
+      expect(ParallelCalabash::FeatureGrouper.features_with_weights(['spec/test_data/features'], '@tag1')).to eq \
+      [{:feature => "spec/test_data/features/aaa.feature", :weight => 14}, {:feature => "spec/test_data/features/bbb.feature", :weight => 5}, {:feature => "spec/test_data/features/ccc.feature", :weight => 4}, {:feature => "spec/test_data/features/ddd.feature", :weight => 3}, {:feature => "spec/test_data/features/eee.feature", :weight => 2}, {:feature => "spec/test_data/features/fff.feature", :weight => 0}]
+    end
+
+  end
+
+  describe :feature_groups_by_weight do
+    it 'should groups all features equally into 2 groups per their weight' do
+      expect(ParallelCalabash::FeatureGrouper.feature_groups_by_weight(['spec/test_data/features'], 2, '@tag1')).to eq \
+      [["spec/test_data/features/aaa.feature", "spec/test_data/features/fff.feature"], ["spec/test_data/features/bbb.feature", "spec/test_data/features/ccc.feature", "spec/test_data/features/ddd.feature", "spec/test_data/features/eee.feature"]]
+    end
+
+    it 'should groups all features equally into 3 groups as per their weight' do
+      expect(ParallelCalabash::FeatureGrouper.feature_groups_by_weight(['spec/test_data/features'], 3, '@tag1')).to eq \
+       [["spec/test_data/features/aaa.feature"], ["spec/test_data/features/bbb.feature", "spec/test_data/features/eee.feature", "spec/test_data/features/fff.feature"], ["spec/test_data/features/ccc.feature", "spec/test_data/features/ddd.feature"]]
+    end
+
+    it 'should groups all features equally into 4 groups as per their weight' do
+      expect(ParallelCalabash::FeatureGrouper.feature_groups_by_weight(['spec/test_data/features'], 4, '@tag1')).to eq \
+      [["spec/test_data/features/aaa.feature"], ["spec/test_data/features/bbb.feature"], ["spec/test_data/features/ccc.feature", "spec/test_data/features/fff.feature"], ["spec/test_data/features/ddd.feature", "spec/test_data/features/eee.feature"]]
+    end
+
+    it 'should groups all features equally into 5 groups as per their weight' do
+      expect(ParallelCalabash::FeatureGrouper.feature_groups_by_weight(['spec/test_data/features'], 5, '@tag1')).to eq \
+      [["spec/test_data/features/aaa.feature"], ["spec/test_data/features/bbb.feature"], ["spec/test_data/features/ccc.feature"], ["spec/test_data/features/ddd.feature"], ["spec/test_data/features/eee.feature", "spec/test_data/features/fff.feature"]]
+    end
+
+    it 'should groups all features equally into 6 groups as per their weight' do
+      expect(ParallelCalabash::FeatureGrouper.feature_groups_by_weight(['spec/test_data/features'], 6, '@tag1')).to eq \
+      [["spec/test_data/features/aaa.feature"], ["spec/test_data/features/bbb.feature"], ["spec/test_data/features/ccc.feature"], ["spec/test_data/features/ddd.feature"], ["spec/test_data/features/eee.feature"], ["spec/test_data/features/fff.feature"]]
+    end
+  end
+
+
+end

data/spec/lib/parallel_calabash/runner_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require 'parallel_calabash'
+
+describe ParallelCalabash::Runner do
+  describe :command_for_process do
+    it 'should return command with env variables' do
+      ParallelCalabash::AdbHelper.should_receive(:device_for_process).with(0).and_return("5555")
+      expect(ParallelCalabash::Runner.command_for_process(0, 'base_command')).to eq \
+      "AUTOTEST=1;export AUTOTEST ADB_DEVICE_ARG=5555;export ADB_DEVICE_ARG TEST_PROCESS_NUMBER=1;export TEST_PROCESS_NUMBER;base_command"
+    end
+  end
+
+
+  describe :execute_command_for_process do
+    it 'should execute the command with correct env variables set and return exit status 0 when command gets executed successfully' do
+      ParallelCalabash::AdbHelper.should_receive(:device_for_process).with(3).and_return("DEVICE3")
+      expect(ParallelCalabash::Runner.execute_command_for_process(3,'echo $ADB_DEVICE_ARG;echo $TEST_PROCESS_NUMBER',true)).to eq ({:stdout=>"DEVICE3\n4\n", :exit_status=>0})
+    end
+
+    it 'should return exit status of 1' do
+      expect(ParallelCalabash::Runner.execute_command_for_process(3,"ruby -e 'exit(1)'",true)).to eq ({:stdout=>"", :exit_status=>1})
+    end
+  end
+
+end

data/spec/test_data/features/aaa.feature

@@ -0,0 +1,43 @@
+Feature: aaa feature
+
+  @tag1
+  Scenario:
+
+  @tag1
+  Scenario:
+
+  @tag1
+  Scenario:
+
+  @tag1
+  Scenario:
+
+  @tag1
+  Scenario:
+
+  @tag1
+  Scenario:
+
+  @tag1
+  Scenario:
+
+  @tag1
+  Scenario:
+
+  @tag1
+  Scenario:
+
+  @tag1
+  Scenario:
+
+  @tag1
+  Scenario:
+
+  @tag1
+  Scenario:
+
+  @tag1
+  Scenario:
+
+  @tag1
+  Scenario:

data/spec/test_data/features/bbb.feature

@@ -0,0 +1,19 @@
+Feature: bbb.feature
+
+  @tag1
+  Scenario:
+
+  @tag1
+  Scenario:
+
+  @tag12
+  Scenario:
+
+  @tag1
+  Scenario:
+
+  @tag1
+  Scenario:
+
+  @tag1
+  Scenario:

data/spec/test_data/features/ccc.feature

@@ -0,0 +1,14 @@
+Feature: ccc.feature
+
+
+  @tag1
+  Scenario:
+
+  @tag1
+  Scenario:
+
+  @tag1
+  Scenario:
+
+  @tag1
+  Scenario:

data/spec/test_data/features/ddd.feature

@@ -0,0 +1,10 @@
+Feature: ddd.feature
+
+  @tag1
+  Scenario:
+
+  @tag1
+  Scenario:
+
+  @tag1
+  Scenario:

data/spec/test_data/features/eee.feature

@@ -0,0 +1,7 @@
+Feature: eee feature
+
+  @tag1
+  Scenario:
+
+  @tag1
+  Scenario:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parallel_calabash
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Rajdeep
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-10 00:00:00.000000000 Z
+date: 2014-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,7 +75,15 @@ files:
 - lib/parallel_calabash/runner.rb
 - lib/parallel_calabash/version.rb
 - parallel_calabash.gemspec
+- spec/lib/parallel_calabash/feature_grouper_spec.rb
+- spec/lib/parallel_calabash/runner_spec.rb
 - spec/spec_helper.rb
+- spec/test_data/features/aaa.feature
+- spec/test_data/features/bbb.feature
+- spec/test_data/features/ccc.feature
+- spec/test_data/features/ddd.feature
+- spec/test_data/features/eee.feature
+- spec/test_data/features/fff.feature
 homepage: https://github.com/rajdeepv/parallel_calabash
 licenses:
 - MIT
@@ -101,4 +109,12 @@ signing_key:
 specification_version: 4
 summary: calabash android tests in parallel
 test_files:
+- spec/lib/parallel_calabash/feature_grouper_spec.rb
+- spec/lib/parallel_calabash/runner_spec.rb
 - spec/spec_helper.rb
+- spec/test_data/features/aaa.feature
+- spec/test_data/features/bbb.feature
+- spec/test_data/features/ccc.feature
+- spec/test_data/features/ddd.feature
+- spec/test_data/features/eee.feature
+- spec/test_data/features/fff.feature