Add JRuby Support (#43)

It is recommended to use version `9.2.10.0` or later.

Author: avmnu-sng

.github/workflows/jruby-ruby-project.yml

@@ -0,0 +1,40 @@
+name: jruby-ruby-project
+
+on:
+  push:
+    branches: [ 'main' ]
+  pull_request:
+
+concurrency:
+  group: ${{ github.event_name == 'pull_request' && github.head_ref || github.ref }}-jruby-ruby
+  cancel-in-progress: true
+
+jobs:
+  main:
+    name: ruby-${{ matrix.ruby }} rspec-${{ matrix.rspec }} simplecov-${{ matrix.simplecov }}
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ 'jruby-9.2.10.0', 'jruby-9.2.19.0', 'jruby-9.3.0.0' ]
+        rspec: [ '3.6.0', '3.7.0', '3.8.0', '3.9.0', '3.10.0' ]
+        simplecov: [ '0.12.0', '0.13.0', '0.14.0', '0.15.0', '0.16.0', '0.17.0', '0.18.0', '0.19.0', '0.20.0', '0.21.0' ]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Install Dependencies
+        run:  bundle install --jobs 3 --retry 3
+
+      - name: Run Features for Ruby Project
+        env:
+          RSPEC_VERSION: "~> ${{ matrix.rspec }}"
+          SIMPLECOV_VERSION: "~> ${{ matrix.simplecov }}"
+        run: JRUBY_OPTS="--debug -X+O" bundle exec cucumber --retry 3 --no-strict-flaky --tags @ruby-app

.github/workflows/rails-5-project.yml

@@ -40,4 +40,4 @@ jobs:
           RSPEC_RAILS_VERSION: "~> ${{ matrix.rspec-rails }}"
           SIMPLECOV_VERSION: "~> 0.${{ matrix.simplecov }}.0"
           BRANCH_COVERAGE: "${{ matrix.simplecov >= 18 && 'true' || 'false' }}"
-        run: bundle exec cucumber --tags @rails-app
+        run: bundle exec cucumber --retry 3 --no-strict-flaky --tags @rails-app

.github/workflows/rails-6-project.yml

@@ -40,4 +40,4 @@ jobs:
           RSPEC_RAILS_VERSION: "~> ${{ matrix.rspec-rails }}"
           SIMPLECOV_VERSION: "~> 0.${{ matrix.simplecov }}.0"
           BRANCH_COVERAGE: "${{ matrix.simplecov >= 18 && 'true' || 'false' }}"
-        run: bundle exec cucumber --tags @rails-app
+        run: bundle exec cucumber --retry 3 --no-strict-flaky --tags @rails-app

.github/workflows/ruby-project-part-1.yml

@@ -37,4 +37,4 @@ jobs:
         env:
           RSPEC_VERSION: "~> ${{ matrix.rspec }}"
           SIMPLECOV_VERSION: "~> ${{ matrix.simplecov }}"
-        run: bundle exec cucumber --tags @ruby-app
+        run: bundle exec cucumber --retry 3 --no-strict-flaky --tags @ruby-app

.github/workflows/ruby-project-part-2.yml

@@ -38,4 +38,4 @@ jobs:
           RSPEC_VERSION: "~> ${{ matrix.rspec }}"
           SIMPLECOV_VERSION: "~> ${{ matrix.simplecov }}"
           BRANCH_COVERAGE: true
-        run: bundle exec cucumber --tags @ruby-app
+        run: bundle exec cucumber --retry 3 --no-strict-flaky --tags @ruby-app

README.md

@@ -34,6 +34,7 @@ installed.
 
 * [Demo](#demo)
 * [Getting Started](#getting-started)
+  * [Working with JRuby](#working-with-jruby)
 * [Configuring CI Caching](#configuring-ci-caching)
 * [Advanced Configuration](#advanced-configuration)
 * [Filters](#filters)
@@ -135,6 +136,16 @@ any of the application code.**
 3. After running your tests, open `rspec_tracer_report/index.html` in the browser
 of your choice.
 
+### Working with JRuby
+
+It is recommend to use **JRuby 9.2.10.0+**. Also, configure it with **`JRUBY_OPTS="--debug -X+O"`**
+or have the `.jrubyrc` file:
+
+```ruby
+debug.fullTrace=true
+objectspace.enabled=true
+```
+
 ## Configuring CI Caching
 
 To enable RSpec Tracer to share cache between different builds on CI, update the

features/support/env.rb

@@ -24,7 +24,12 @@
   if ENV.fetch('SKIP_COVERAGE_VALIDATION', 'false') == 'true'
     setup_file = File.join(File.expand_path('../..', __dir__), 'support', 'coverage_setup')
 
-    set_environment_variable('RUBYOPT', "-r#{setup_file} #{ENV['RUBYOPT']}")
+    case RUBY_ENGINE
+    when 'ruby'
+      set_environment_variable('RUBYOPT', "-r#{setup_file} #{ENV['RUBYOPT']}")
+    when 'jruby'
+      set_environment_variable('JRUBY_OPTS', "--debug -X+O -r#{setup_file} #{ENV['JRUBY_OPTS']}")
+    end
   end
 end
 

lib/rspec_tracer.rb

@@ -34,6 +34,8 @@ def start(&block)
       RSpecTracer.running = false
       RSpecTracer.pid = Process.pid
 
+      return if RUBY_ENGINE == 'jruby' && !valid_jruby_opts?
+
       puts 'Started RSpec tracer'
 
       configure(&block) if block
@@ -127,6 +129,20 @@ def simplecov?
 
     private
 
+    def valid_jruby_opts?
+      return true if Java::OrgJruby::RubyInstanceConfig.FULL_TRACE_ENABLED &&
+        JRuby.runtime.object_space_enabled?
+
+      puts <<-WARN.strip.gsub(/\s+/, ' ')
+        RSpec Tracer is not running as it requires debug and object space enabled. Use
+        command line options "--debug" and "-X+O" or set the "debug.fullTrace=true" and
+        "objectspace.enabled=true" options in your .jrubyrc file. You can also use
+        JRUBY_OPTS="--debug -X+O".
+      WARN
+
+      false
+    end
+
     def initial_setup
       unless setup_rspec
         puts 'Could not find a running RSpec process'

lib/rspec_tracer/coverage_reporter.rb

@@ -167,8 +167,17 @@ def peek_coverage
     end
 
     def line_stub(file_path)
+      case RUBY_ENGINE
+      when 'ruby'
+        ruby_line_stub(file_path)
+      when 'jruby'
+        jruby_line_stub(file_path)
+      end
+    end
+
+    def ruby_line_stub(file_path)
       lines = File.foreach(file_path).map { nil }
-      iseqs = [RubyVM::InstructionSequence.compile_file(file_path)]
+      iseqs = [::RubyVM::InstructionSequence.compile_file(file_path)]
 
       until iseqs.empty?
         iseq = iseqs.pop
@@ -179,5 +188,28 @@ def line_stub(file_path)
 
       lines
     end
+
+    # rubocop:disable Metrics/AbcSize
+    def jruby_line_stub(file_path)
+      lines = File.foreach(file_path).map { nil }
+      root_node = ::JRuby.parse(File.read(file_path))
+
+      visitor = org.jruby.ast.visitor.NodeVisitor.impl do |_name, node|
+        if node.newline?
+          if node.respond_to?(:position)
+            lines[node.position.line] = 0
+          else
+            lines[node.line] = 0
+          end
+        end
+
+        node.child_nodes.each { |child| child&.accept(visitor) }
+      end
+
+      root_node.accept(visitor)
+
+      lines
+    end
+    # rubocop:enable Metrics/AbcSize
   end
 end

tasks/features/coverage/rspec_tracer.rake

@@ -12,7 +12,7 @@ namespace :features do
           SIMPLECOV_COMMAND_NAME="features:coverage:rspec_tracer"
           RSPEC_VERSION="~> 3.10"
           SIMPLECOV_VERSION="~> 0.21"
-          bundle exec cucumber --tags "@ruby-app and @no-simplecov"
+          bundle exec cucumber --retry 3 --no-strict-flaky --tags "@ruby-app and @no-simplecov"
         COMMAND
 
         exit(1) unless system(command)