Enhance/parallel linkstatus (#28)

* change parallel helper to module

* change template config setting

* change to block

* fix spec

* change into float

* fix number

* move check hash place

* fix for rubocop

* change to include

* change block parameter

* fix block

* fix for review.

* fix for rubocop

Author: rueyjye

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bucky-core (0.9.5)
+    bucky-core (0.9.7)
       color_echo (~> 3.1)
       json (~> 2.1)
       nokogiri (~> 1.8)

example/bucky-management/config/bucky_config.yml

@@ -1,4 +1,3 @@
-:parallel_num: 4
 :test_result_path: './system/test_results/'
 :log_path: './system/logs/'
 :screen_shot_path: './system/evidences/screen_shots/'

example/bucky-management/config/e2e_config.yml

@@ -2,6 +2,7 @@
 :selenium_port: '4444'     # Default selenium port
 :browser: :chrome          # Only chrome
 :headless: false
+:e2e_parallel_num: 1
 :sp_device_name: :iphone
 :tablet_device_name: :ipad
 :device_name_on_chrome:

example/bucky-management/config/linkstatus_config.yml

@@ -1,3 +1,4 @@
-:linkstatus_parallel_num: 8
+:linkstatus_parallel_num: 1
+:linkstatus_thread_num: 4
 :linkstatus_open_timeout: 60
 :linkstatus_read_timeout: 60

example/hands-on/config/bucky_config.yml

@@ -1,4 +1,3 @@
-:parallel_num: 4
 :test_result_path: './system/test_results/'
 :log_path: './system/logs/'
 :screen_shot_path: './system/evidences/screen_shots/'

example/hands-on/config/e2e_config.yml

@@ -2,6 +2,7 @@
 :selenium_port: '4444'     # default selenium port
 :browser: :chrome          # Only chrome
 :headless: false
+:e2e_parallel_num: 1
 :sp_device_name: :iphone
 :tablet_device_name: :ipad
 :device_name_on_chrome:

example/hands-on/config/linkstatus_config.yml

@@ -1,3 +1,4 @@
-:linkstatus_parallel_num: 8
+:linkstatus_parallel_num: 1
+:linkstatus_thread_num: 4
 :linkstatus_open_timeout: 60
 :linkstatus_read_timeout: 60

lib/bucky/core/test_core/test_class_generator.rb

@@ -45,7 +45,7 @@ def initialize(test_cond)
         end
 
         # Genrate test class by test suite and test case data
-        def generate_test_class(data, link_status_url_log)
+        def generate_test_class(data, link_status_url_log = {})
           test_cond = @test_cond
           # Common proccessing
           # e.g.) TestSampleAppPcE2e1, TestSampleAppPcHttpstatus1

lib/bucky/core/test_core/test_manager.rb

@@ -8,7 +8,50 @@
 module Bucky
   module Core
     module TestCore
+      module ParallelHelper
+        parent_pid = Process.pid
+
+        # Terminate parent and child process when getting interrupt signal
+        Signal.trap('INT') do
+          Process.kill('TERM', -1 * parent_pid)
+        end
+
+        private
+
+        def parallel_new_worker_each(data_set, max_processes, &block)
+          # Max parallel workers number
+          available_workers = max_processes
+
+          # If child process dead, available workers increase
+          Signal.trap('CLD') { available_workers += 1 }
+
+          data_set.each do |data|
+            # Wait until worker is available
+            Process.wait unless available_workers.positive?
+            # Workers decrease when start working
+            available_workers -= 1
+            fork { block.call(data) }
+          end
+          Process.waitall
+        end
+
+        def parallel_distribute_into_workers(data_set, max_processes, &block)
+          # Group the data by remainder of index
+          data_set_grouped = data_set.group_by.with_index { |_elem, index| index % max_processes }
+          # Use 'values' method to get only hash's key into an array
+          data_set_grouped.values.each do |data_for_pre_worker|
+            # Number of child process is equal to max_processes (or equal to data_set length when data_set length is less than max_processes)
+            fork do
+              data_for_pre_worker.each { |data| block.call(data) }
+            end
+          end
+          Process.waitall
+        end
+      end
+
       class TestManager
+        include ParallelHelper
+
         # Keep test conditions and round number
         def initialize(test_cond)
           @test_cond = test_cond
@@ -45,8 +88,17 @@ def load_test_suites
 
         # Generate and execute test
         def do_test_suites(test_suite_data)
-          parallel_num = Bucky::Utils::Config.instance[:parallel_num]
-          parallel_helper(test_suite_data, parallel_num)
+          # For checking on linkstatus
+          e2e_parallel_num = Bucky::Utils::Config.instance[:e2e_parallel_num]
+          linkstatus_parallel_num = Bucky::Utils::Config.instance[:linkstatus_parallel_num]
+          tcg = Bucky::Core::TestCore::TestClassGenerator.new(@test_cond)
+
+          case @test_cond[:test_category][0]
+          when 'e2e' then parallel_new_worker_each(test_suite_data, e2e_parallel_num) { |data| tcg.generate_test_class(data) }
+          when 'linkstatus' then
+            link_status_url_log = {}
+            parallel_distribute_into_workers(test_suite_data, linkstatus_parallel_num) { |data| tcg.generate_test_class(data, link_status_url_log) }
+          end
         end
 
         def execute_test
@@ -60,31 +112,6 @@ def execute_test
             break if @test_cond[:re_test_cond].empty?
           end
         end
-
-        def parallel_helper(test_suite_data, max_processes)
-          # Max parallel workers number
-          available_workers = max_processes
-          # For checking on linkstatus
-          link_status_url_log = {}
-          parent_pid = Process.pid
-          tcg = Bucky::Core::TestCore::TestClassGenerator.new(@test_cond)
-
-          # If child process dead, available workers increase
-          Signal.trap('CLD') { available_workers += 1 }
-          # Terminate parent and child process when getting interrupt signal
-          Signal.trap('INT') do
-            Process.kill('TERM', -1 * parent_pid)
-          end
-
-          test_suite_data.each do |data|
-            # Wait until worker is available
-            Process.wait unless available_workers.positive?
-            # Workers decrease when start working
-            available_workers -= 1
-            fork { tcg.generate_test_class(data, link_status_url_log) }
-          end
-          Process.waitall
-        end
       end
     end
   end

lib/bucky/test_equipment/verifications/status_checker.rb

@@ -90,7 +90,7 @@ def link_status_check(args)
           links = exclude(links, exclude_urls) unless exclude_urls.nil?
 
           errors = []
-          Parallel.each(links.uniq, in_threads: Bucky::Utils::Config.instance[:linkstatus_parallel_num]) do |link|
+          Parallel.each(links.uniq, in_threads: Bucky::Utils::Config.instance[:linkstatus_thread_num]) do |link|
             http_status_check_args[:url] = link
             http_status_check_args[:redirect_url_list] = []
             link_response = http_status_check(http_status_check_args)

spec/core/test_core/test_manager_spec.rb

@@ -70,16 +70,18 @@
 
   describe '#parallel_helper' do
     let(:tm) { Bucky::Core::TestCore::TestManager.new(re_test_count: 1) }
+    let(:parallel_helper) { Class.new { extend Bucky::Core::TestCore::ParallelHelper } }
+    let(:block_mock) { proc { 'Block mock' } }
+    let(:ng_case_data) { {} }
     before do
       $debug = true
     end
     after do
       $debug = false
     end
-    context 'run test in multiprocess' do
-      let(:ng_case_data) { {} }
-      let(:parallel_num) { 2 }
-      let(:test_suite_data) do
+    context 'parallel_new_worker_each' do
+      let(:e2e_parallel_num) { 2 }
+      let(:test_suite_data_e2e) do
         [
           { test_class_name: 'test',
             test_suite_name: 'test',
@@ -95,11 +97,38 @@
         ]
       end
 
-      it 'create test class instance in fork' do
-        allow(tm).to receive(:fork) do |&block|
-          expect(block.call).to eq(Bucky::Core::TestCore::TestClasses::TestSpecPcE2etest)
+      it 'call target block in fork' do
+        allow(parallel_helper).to receive(:fork) do |&block|
+          expect(block.call).to eq('Block mock')
         end
-        tm.send(:parallel_helper, test_suite_data, parallel_num)
+        parallel_helper.send(:parallel_new_worker_each, test_suite_data_e2e, e2e_parallel_num, &block_mock)
+      end
+    end
+
+    context 'parallel_distribute_into_workers' do
+      let(:linkstatus_parallel_num) { 2 }
+      let(:test_suite_data_linkstatus) do
+        [
+          { test_class_name: 'test',
+            test_suite_name: 'test',
+            test_category: 'linkstatus',
+            suite: {
+              device: 'pc',
+              service: 'spec',
+              test_category: 'linkstatus',
+              cases: [
+                { case_name: 'test_1' }
+              ]
+            } }
+        ]
+      end
+      it 'make workers in fork then call block in each' do
+        allow(parallel_helper).to receive(:fork) do |&block_fork|
+          allow(block_fork.call).to receive(:each) do |&block_each|
+            expect(block_each.call).to eq('Block mock')
+          end
+        end
+        parallel_helper.send(:parallel_distribute_into_workers, test_suite_data_linkstatus, linkstatus_parallel_num, &block_mock)
       end
     end
   end

spec/test_equipment/verifications/status_checker_spec.rb

@@ -104,7 +104,7 @@
       allow(response).to receive(:code).and_return(code)
       allow(response).to receive(:entity)
       allow(subject).to receive(:make_target_links).and_return(links)
-      allow(Bucky::Utils::Config).to receive(:instance).and_return(linkstatus_parallel_num: 4)
+      allow(Bucky::Utils::Config).to receive(:instance).and_return(linkstatus_thread_num: 4)
     end
     context 'no error base url, link url' do
       it 'not raise exception' do

spec/utils/bucky_config.yml

@@ -1,4 +1,3 @@
-:parallel_num: 4
 :log_path: './spec/utils/'
 :screen_shot_path: './system/screen_shots/'
 :bucky_error: 'bucky_error'

spec/utils/e2e_config.yml

@@ -3,6 +3,7 @@
 :selenium_mode: :remote    # Other selection: :local(only PC mode), :headless
 :browser: :chrome          # Other selection: :firefox (only PC mode)
 :headless: false
+:e2e_parallel_num: 1
 :sp_device_name: :iphone6  # Other selection: nexus5
 :device_chrome_name:
   :iphone6: 'Apple iPhone 6'

spec/utils/linkstatus_config.yml

@@ -1,3 +1,4 @@
 :linkstatus_open_timeout: 60
 :linkstatus_read_timeout: 60
-:linkstatus_parallel_num: 8
+:linkstatus_parallel_num: 1
+:linkstatus_thread_num: 4

system_testing/test_bucky_project/config/bucky_config.yml

@@ -1,4 +1,3 @@
-:parallel_num: 4
 :test_result_path: './system/test_results/'
 :log_path: './system/logs/'
 :screen_shot_path: './system/evidences/screen_shots/'

system_testing/test_bucky_project/config/e2e_config.yml

@@ -2,6 +2,7 @@
 :selenium_port: '4444'     # Default selenium port
 :browser: :chrome          # Only chrome
 :headless: false
+:e2e_parallel_num: 1
 :sp_device_name: :iphone
 :tablet_device_name: :ipad
 :device_name_on_chrome:

system_testing/test_bucky_project/config/linkstatus_config.yml

@@ -1,3 +1,4 @@
-:linkstatus_parallel_num: 8
+:linkstatus_parallel_num: 1
+:linkstatus_thread_num: 4
 :linkstatus_open_timeout: 60
 :linkstatus_read_timeout: 60

template/new/config/bucky_config.yml

@@ -1,4 +1,3 @@
-:parallel_num: 4
 :test_result_path: './system/test_results/'
 :log_path: './system/logs/'
 :screen_shot_path: './system/evidences/screen_shots/'

template/new/config/e2e_config.yml

@@ -2,6 +2,7 @@
 :selenium_port: '4444'     # Default selenium port
 :browser: :chrome          # Only chrome
 :headless: false
+:e2e_parallel_num: 1
 :sp_device_name: :iphone
 :tablet_device_name: :ipad
 :device_name_on_chrome:

template/new/config/linkstatus_config.yml

@@ -1,3 +1,4 @@
-:linkstatus_parallel_num: 8
+:linkstatus_parallel_num: 1
+:linkstatus_thread_num: 4
 :linkstatus_open_timeout: 60
 :linkstatus_read_timeout: 60