various updates (#23)

.rubocop_todo.yml

@@ -6,13 +6,75 @@
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: with_first_argument, with_fixed_indentation
+Layout/AlignArguments:
+  Exclude:
+    - 'lib/report_portal/rspec/formatter.rb'
+
 # Offense count: 2
 # Cop supports --auto-correct.
 Layout/EmptyLineAfterGuardClause:
   Exclude:
     - 'lib/report_portal/cucumber/json_slurper.rb'
     - 'tests/features/step_definitions/steps.rb'
 
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment, AllowBeforeTrailingComments, ForceEqualSignAlignment.
+Layout/ExtraSpacing:
+  Exclude:
+    - 'lib/report_portal/logging/logging_appender.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/LeadingCommentSpace:
+  Enabled: true
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: aligned, indented
+Layout/MultilineOperationIndentation:
+  Exclude:
+    - 'lib/report_portal/cucumber/report.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+Layout/SpaceAfterComma:
+  Exclude:
+    - 'lib/report_portal/cucumber/report.rb'
+    - 'lib/reportportal.rb'
+    - 'tests/formatter_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: space, no_space
+Layout/SpaceAroundEqualsInParameterDefault:
+  Exclude:
+    - 'lib/reportportal.rb'
+
+# Offense count: 5
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment.
+Layout/SpaceAroundOperators:
+  Exclude:
+    - 'lib/report_portal/cucumber/report.rb'
+    - 'lib/report_portal/logging/logging_appender.rb'
+    - 'lib/report_portal/rspec/formatter.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
+# SupportedStyles: space, no_space
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceInsideBlockBraces:
+  Exclude:
+    - 'tests/formatter_spec.rb'
+
 # Offense count: 5
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces.
@@ -52,7 +114,7 @@ Metrics/BlockLength:
 # Offense count: 2
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 169
+  Max: 350
 
 # Offense count: 3
 Metrics/CyclomaticComplexity:
@@ -66,7 +128,8 @@ Metrics/MethodLength:
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/ModuleLength:
-  Max: 162
+  Max: 250
+
 
 # Offense count: 5
 Metrics/PerceivedComplexity:
@@ -112,8 +175,6 @@ Style/Documentation:
     - 'spec/**/*'
     - 'test/**/*'
     - 'lib/report_portal/cucumber/formatter.rb'
-    - 'lib/report_portal/cucumber/parallel_formatter.rb'
-    - 'lib/report_portal/cucumber/parallel_report.rb'
     - 'lib/report_portal/logging/logger.rb'
     - 'lib/report_portal/patches/rest_client.rb'
     - 'lib/report_portal/rspec/formatter.rb'
@@ -168,7 +229,6 @@ Style/GlobalVars:
 # Configuration parameters: MinBodyLength.
 Style/GuardClause:
   Exclude:
-    - 'lib/report_portal/cucumber/parallel_report.rb'
     - 'lib/report_portal/cucumber/report.rb'
     - 'lib/report_portal/rspec/formatter.rb'
     - 'lib/reportportal.rb'

Gemfile

@@ -3,10 +3,11 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'cucumber', '~> 3'
-gem 'parallel_tests'
-gem 'rake'
-gem 'rspec'
-gem 'rubytree', git: 'https://github.com/razboev/RubyTree'
-
+gem 'faraday'
 gem 'log4r'
 gem 'logging'
+gem 'parallel_tests', '~> 2.15.0'
+gem 'rake'
+gem 'rspec'
+gem 'rubytree'
+gem 'sys-proctable', '~> 1.1.5'

README.md

@@ -28,12 +28,18 @@ Add `gem 'reportportal', git: 'https://github.com/reportportal/agent-ruby.git'`
 
 * With Cucumber:
 
-```cucumber <other options> -f ReportPortal::Cucumber::Formatter```
+```cucumber <other options> -f ReportPortal::Cucumber::Formatter -o '<log_file>'```
 
-* With Cucumber and parallel_tests gem:
-
-```parallel_cucumber <some options> -o '<some other options> -f ReportPortal::Cucumber::ParallelFormatter'```
+* With Cucumber (Advanced)
 
+```ruby
+AfterConfiguration do |config|
+  ...
+  #rp_log_file = <Generated or from ENV>
+  ...
+  config.formats.push(["ReportPortal::Cucumber::Formatter", {}, rp_log_file])
+end 
+```
 * With RSpec:
 
 ```rspec <other options> -f ReportPortal::RSpec::Formatter```
@@ -54,6 +60,8 @@ Supported settings:
  - launch_id - id of previously created launch (to be used if formatter_modes contains attach_to_launch)
  - file_with_launch_id - path to file with id of launch (to be used if formatter_modes contains attach_to_launch)
  - disable_ssl_verification - set to true to disable SSL verification on connect to ReportPortal (potential security hole!). Set `disable_ssl_verification` to `true` if you see the following error:
+ - launch_uuid - when formatter_mode is `attach_to_launch`, launch_uuid will be used to create uniq report group(tmp dir should be shared across all lunches)
+ - log_level - this is log level for report_portal agent (useful for troubleshooting issued when run in parallel mode)
 ```
 Request to https://rp.epam.com/reportportal-ws/api/v1/pass-team/launch//finish produced an exception: RestClient::SSLCertificateNotVerified: SSL_connect returned=1 errno=0 state=SSLv3 read server certificate B: certificate verify failed
 ```
@@ -75,12 +83,36 @@ WebMock.disable_net_connect!(:net_http_connect_on_start => true, :allow_localhos
 ## Formatter modes
 
 The following modes are supported:
-
-| Name | Purpose |
-| --- | --- |
-| attach_to_launch | Do not create a new launch but add executing features/scenarios to an existing launch. Use launch_id or file_with_launch_id settings to configure that. If they are not present client will check rp_launch_id.tmp in `Dir.tmpdir`)
-| use_same_thread_for_reporting | Send reporting commands in the same main thread used for running tests. This mode is useful for debugging this Report Portal client. It changes default behavior to send commands in the separate thread. Default behavior is there not to slow test execution. |
-| skip_reporting_hierarchy | Do not create items for folders and feature files |
+<table><thead><tr><th>Name</th><th>Purpose</th></tr></thead>
+<tbody>
+<tr>
+<td>attach_to_launch</td>
+<td>
+Add executing features/scenarios to same launch. 
+Use following options are available to configure that. 
+
+    1. launch_id
+    2. file_with_launch_id 
+    3. launch_uuid
+    4. rp_launch_id_for_<fisrt process pid>.lock in `Dir.tmpdir` 
+
+    *** If launch is not created, cucumber process will create one. Such that user does not need to worry about creating new launch.
+</td>
+</tr>
+<tr>
+<td>use_same_thread_for_reporting</td>
+<td>
+Send reporting commands in the same main thread used for running tests. This mode is useful for debugging 
+Report Portal client. It changes default behavior to send commands in the separate thread.
+Default behavior is there not to slow test execution. </td>
+</tr>
+<tr>
+<td>skip_reporting_hierarchy</td>
+<td>
+Do not create items for folders and feature files</td>
+</tr>
+</tbody>
+</table>
 
 ## Logging
 Experimental support for three common logging frameworks was added:
@@ -91,12 +123,6 @@ Experimental support for three common logging frameworks was added:
 
 To use Logger, set use_standard_logger parameter to true (see Configuration chapter). For the other two corresponding appenders/outputters are available under reportportal/logging.
 
-## Parallel formatter
-
-ReportPortal::Cucumber::ParallelFormatter can be used for tests started via parallel_tests gem.
-
-Note: Launch id is shared between independent processes (as is the case with parallel_tests gem) via a file in `Dir.tmpdir`.
-
 ## Links
 
  - [ReportPortal](https://github.com/reportportal/)

lib/report_portal/cucumber/formatter.rb

@@ -7,12 +7,10 @@ module Cucumber
     class Formatter
       # @api private
       def initialize(config)
-        ENV['REPORT_PORTAL_USED'] = 'true'
-
+        @logger = Logger.new(config.out_stream)
+        @logger.level = ReportPortal::Settings.instance.log_level || :warn
         setup_message_processing
 
-        @io = config.out_stream
-
         [:test_case_started, :test_case_finished, :test_step_started, :test_step_finished, :test_run_finished].each do |event_name|
           config.on_event event_name do |event|
             process_message(event_name, event)
@@ -23,8 +21,6 @@ def initialize(config)
 
       def puts(message)
         process_message(:puts, message)
-        @io.puts(message)
-        @io.flush
       end
 
       def embed(*args)
@@ -34,7 +30,7 @@ def embed(*args)
       private
 
       def report
-        @report ||= ReportPortal::Cucumber::Report.new
+        @report ||= ReportPortal::Cucumber::Report.new(@logger)
       end
 
       def setup_message_processing