ruby_memcheck 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d7e2556e802cceebbd1607895ed319b54037e2a945586f8fe65e9f6bda0928c
-  data.tar.gz: 3cba76f62de7ad396458d651a272d660456e362a85c1c6a67ac6ae688b3e4c30
+  metadata.gz: 149d43766feab55baa7f6822767ec4d68ae465668fc6183c8ad9cca7b4bd7955
+  data.tar.gz: 1d97e5ac70355a3b14f14e7e7acbba925b8d4e43a1907e5ceb0af7de29a60732
 SHA512:
-  metadata.gz: 6e849c1bcfc9947293939452298c344acd71136dd7b617bb3edfc07c7b8122a9bc366e1e57a83d86293ed284569121185d465fd9e47959a9e9e0b6579b212022
-  data.tar.gz: 3131ae9a995bcd2e9f9fcab7f7bfb8b99c3449eadb12d9bfad0366681971d3c3fa7234e194fbf7e5c9a41583d18814cc59aad7802836ba1d075e0d6893be0e1d
+  metadata.gz: f1953d6feaba3701b695d0c8d84086efa586ce05e2da518b4e68e8e8b5f8a615e35360ce36a32e5f61a489bc3bb88517b48353a644a72cb2f902edb6ff34e633
+  data.tar.gz: a95a1a75f17ddafb64a2e767d0a32ce5aa0b941e5bd4522a9ab5b3bbe5fc647c49579014fe09571f27b64e543521d6327b3dbde4e066044005696edc13442a39

data/.rubocop.yml

@@ -2,6 +2,7 @@ inherit_gem:
   rubocop-shopify: rubocop.yml
 
 AllCops:
+  TargetRubyVersion: 2.6
   SuggestExtensions: false
 
 Style/GlobalVars:

data/README.md

@@ -9,7 +9,7 @@ This gem provides a sane way to use Valgrind's memcheck on your native extension
     1. [How does it work?](#how-does-it-work)
     1. [Limitations](#limitations)
 1. [Installation](#installation)
-1. [Usage](#usage)
+1. [Setup](#setup)
 
 ## What is this gem?
 
@@ -38,15 +38,13 @@ Because of the aggressive heuristics used to filter out false-positives, there a
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem "ruby_memcheck"
+```
+gem install ruby_memcheck
 ```
 
-## Usage
+## Setup
 
-The easiest way to use this gem is to use it on your test suite using rake.
+The easiest way to use this gem is to use it on your test suite (minitest or RSpec) using rake.
 
 0. Install Valgrind.
 1. In your Rakefile, require this gem.
@@ -54,43 +52,69 @@ The easiest way to use this gem is to use it on your test suite using rake.
     ```ruby
     require "ruby_memcheck"
     ```
+
+    - **For RSpec:** If you're using RSpec, also add the following require.
+
+      ```ruby
+      require "ruby_memcheck/rspec/rake_task"
+      ```
+
 1. Configure the gem by calling `RubyMemcheck.config`. You must pass it your binary name. This is the same value you passed into `create_makefile` in your `extconf.rb` file. Make sure this value is correct or it will filter out almost everything as a false-positive!
 
     ```ruby
     RubyMemcheck.config(binary_name: "your_binary_name")
     ```
-1. Locate your test task(s) in your Rakefile. You can identify it with a call to `Rake::TestTask.new`.
-1. Create a namespace under the test task and create a `RubyMemcheck::TestTask` with the same configuration.
+1. Setup the test task for your test framework.
+    - **minitest**
+    
+      Locate your test task(s) in your Rakefile. You can identify it with a call to `Rake::TestTask.new`.
 
-    For example, if your Rakefile looked like this before:
+      Create a namespace under the test task and create a `RubyMemcheck::TestTask` with the same configuration.
 
-    ```ruby
-    Rake::TestTask.new(test: :compile) do |t|
-      t.libs << "test"
-      t.test_files = FileList["test/unit/**/*_test.rb"]
-    end
-    ```
+      For example, if your Rakefile looked like this before:
 
-    You can change it to look like this:
+      ```ruby
+      Rake::TestTask.new(test: :compile) do |t|
+        t.libs << "test"
+        t.test_files = FileList["test/unit/**/*_test.rb"]
+      end
+      ```
 
-    ```ruby
-    test_config = lambda do |t|
-      t.libs << "test"
-      t.test_files = FileList["test/**/*_test.rb"]
-    end
-    Rake::TestTask.new(test: :compile, &test_config)
-    namespace :test do
-      RubyMemcheck::TestTask.new(valgrind: :compile, &test_config)
-    end
-    ```
-1. At the top of your `test_helper.rb`/`spec_helper.rb` (or whatever file sets up your test suite), add this line:
+      You can change it to look like this:
 
-    ```ruby
-    at_exit { GC.start }
-    ```
+      ```ruby
+      test_config = lambda do |t|
+        t.libs << "test"
+        t.test_files = FileList["test/**/*_test.rb"]
+      end
+      Rake::TestTask.new(test: :compile, &test_config)
+      namespace :test do
+        RubyMemcheck::TestTask.new(valgrind: :compile, &test_config)
+      end
+      ```
+
+    - **RSpec**
+
+      Locate your rake task(s) in your Rakefile. You can identify it with a call to `RSpec::Core::RakeTask.new`.
+
+      Create a namespace under the test task and create a `RubyMemcheck::RSpec::RakeTask` with the same configuration.
+
+      For example, if your Rakefile looked like this before:
+
+      ```ruby
+      RubyMemcheck::RSpec::RakeTask.new(spec: :compile)
+      ```
+
+      You can change it to look like this:
+
+      ```ruby
+      RubyMemcheck::RSpec::RakeTask.new(spec: :compile)
+      namespace :spec do
+        RubyMemcheck::RSpec::RakeTask.new(valgrind: :compile)
+      end
+      ```
 
-    Place this line as close to the top of the file as possible, before any requires in the file (especially before the call to `require "minitest/autorun"`). This will ensure that the Garbage Collector is ran before Ruby shuts down. This will reduce the number of false-positives.
-1. You're ready to run your test suite with Valgrind using `rake test:valgrind`! Note that this will take a while to run because Valgrind will make Ruby significantly slower.
+1. You're ready to run your test suite with Valgrind using `rake test:valgrind` or `rake spec:valgrind`! Note that this will take a while to run because Valgrind will make Ruby significantly slower.
 1. (Optional) If you find false-positives in the output, you can create suppression files in a `suppressions` directory in the root directory of your gem. In this directory, you can create [Valgrind suppression files](https://wiki.wxwidgets.org/Valgrind_Suppression_File_Howto). The most basic suppression file is `your_binary_name_ruby.supp`. If you want some suppressions for only specific versions of Ruby, you can add the Ruby version to the filename. For example, `your_binary_name_ruby-3.supp` will suppress for any Rubies with a major version of 3 (e.g. 3.0.0, 3.1.1, etc.), while suppression file `your_binary_name_ruby-3.1.supp` will only be used for Ruby with a major and minor version of 3.1 (e.g. 3.1.0, 3.1.1, etc.).
 
 ## License

data/lib/ruby_memcheck/configuration.rb

@@ -6,26 +6,33 @@ module RubyMemcheck
     DEFAULT_VALGRIND_OPTIONS = [
       "--num-callers=50",
       "--error-limit=no",
+      "--trace-children=yes",
       "--undef-value-errors=no",
       "--leak-check=full",
       "--show-leak-kinds=definite",
     ].freeze
     DEFAULT_VALGRIND_SUPPRESSIONS_DIR = "suppressions"
     DEFAULT_SKIPPED_RUBY_FUNCTIONS = [
+      /\Aeval_string_with_cref\z/,
+      /\Arb_add_method_cfunc\z/,
       /\Arb_check_funcall/,
+      /\Arb_class_boot\z/,
       /\Arb_enc_raise\z/,
       /\Arb_exc_raise\z/,
+      /\Arb_extend_object\z/,
       /\Arb_funcall/,
       /\Arb_intern/,
       /\Arb_ivar_set\z/,
+      /\Arb_module_new\z/,
       /\Arb_raise\z/,
       /\Arb_rescue/,
       /\Arb_respond_to\z/,
       /\Arb_yield/,
     ].freeze
 
-    attr_reader :binary_name, :ruby, :valgrind_options, :valgrind,
-      :skipped_ruby_functions, :valgrind_xml_file, :output_io
+    attr_reader :binary_name, :ruby, :valgrind, :valgrind_options, :valgrind_suppressions_dir,
+      :valgrind_generate_suppressions, :skipped_ruby_functions, :valgrind_xml_dir, :output_io
+    alias_method :valgrind_generate_suppressions?, :valgrind_generate_suppressions
 
     def initialize(
       binary_name:,
@@ -33,30 +40,43 @@ module RubyMemcheck
       valgrind: DEFAULT_VALGRIND,
       valgrind_options: DEFAULT_VALGRIND_OPTIONS,
       valgrind_suppressions_dir: DEFAULT_VALGRIND_SUPPRESSIONS_DIR,
+      valgrind_generate_suppressions: false,
       skipped_ruby_functions: DEFAULT_SKIPPED_RUBY_FUNCTIONS,
-      valgrind_xml_file: Tempfile.new,
+      valgrind_xml_dir: Dir.mktmpdir,
       output_io: $stderr
     )
       @binary_name = binary_name
       @ruby = ruby
       @valgrind = valgrind
-      @valgrind_options =
-        valgrind_options +
-        get_valgrind_suppression_files(valgrind_suppressions_dir).map { |f| "--suppressions=#{f}" }
+      @valgrind_options = valgrind_options
+      @valgrind_suppressions_dir = File.expand_path(valgrind_suppressions_dir)
+      @valgrind_generate_suppressions = valgrind_generate_suppressions
       @skipped_ruby_functions = skipped_ruby_functions
       @output_io = output_io
 
-      if valgrind_xml_file
-        @valgrind_xml_file = valgrind_xml_file
+      if valgrind_xml_dir
+        valgrind_xml_dir = File.expand_path(valgrind_xml_dir)
+        FileUtils.mkdir_p(valgrind_xml_dir)
+        @valgrind_xml_dir = valgrind_xml_dir
         @valgrind_options += [
           "--xml=yes",
-          "--xml-file=#{valgrind_xml_file.path}",
+          # %p will be replaced with the PID
+          # This prevents forking and shelling out from generating a corrupted XML
+          # See --log-file from https://valgrind.org/docs/manual/manual-core.html
+          "--xml-file=#{File.join(valgrind_xml_dir, "%p.out")}",
         ]
       end
     end
 
     def command(*args)
-      "#{valgrind} #{valgrind_options.join(" ")} #{ruby} #{args.join(" ")}"
+      [
+        valgrind,
+        valgrind_options,
+        get_valgrind_suppression_files(valgrind_suppressions_dir).map { |f| "--suppressions=#{f}" },
+        valgrind_generate_suppressions ? "--gen-suppressions=all" : "",
+        ruby,
+        args,
+      ].flatten.join(" ")
     end
 
     def skip_stack?(stack)

data/lib/ruby_memcheck/rspec/rake_task.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "rspec/core/rake_task"
+
+module RubyMemcheck
+  module RSpec
+    class RakeTask < ::RSpec::Core::RakeTask
+      include TestTaskReporter
+
+      attr_reader :configuration
+
+      def initialize(*args)
+        @configuration =
+          if !args.empty? && args[0].is_a?(Configuration)
+            args.shift
+          else
+            RubyMemcheck.default_configuration
+          end
+
+        super
+      end
+
+      def run_task(verbose)
+        error = nil
+
+        begin
+          # RSpec::Core::RakeTask#run_task calls Kernel.exit on failure
+          super
+        rescue SystemExit => e
+          error = e
+        end
+
+        report_valgrind_errors
+
+        raise error if error
+      end
+
+      private
+
+      def spec_command
+        # First part of command is Ruby
+        args = super.split(" ")[1..]
+
+        configuration.command(args)
+      end
+    end
+  end
+end

data/lib/ruby_memcheck/suppression.rb

@@ -9,8 +9,6 @@ module RubyMemcheck
     end
 
     def to_s
-      return "" if root.nil?
-
       str = StringIO.new
       str << "{\n"
       str << "  #{root.at_xpath("sname").content}\n"

data/lib/ruby_memcheck/test_task.rb

@@ -2,9 +2,9 @@
 
 module RubyMemcheck
   class TestTask < Rake::TestTask
-    VALGRIND_REPORT_MSG = "Valgrind reported errors (e.g. memory leak or use-after-free)"
+    include TestTaskReporter
 
-    attr_reader :configuration, :errors
+    attr_reader :configuration
 
     def initialize(*args)
       @configuration =
@@ -20,39 +20,10 @@ module RubyMemcheck
     def ruby(*args, **options, &block)
       command = configuration.command(args)
       sh(command, **options) do |ok, res|
-        if configuration.valgrind_xml_file
-          parse_valgrind_output
-          unless errors.empty?
-            output_valgrind_errors
-            raise VALGRIND_REPORT_MSG
-          end
-        end
+        report_valgrind_errors
 
         yield ok, res if block_given?
       end
     end
-
-    private
-
-    def parse_valgrind_output
-      require "nokogiri"
-
-      @errors = []
-
-      Nokogiri::XML::Reader(File.open(configuration.valgrind_xml_file.to_path)).each do |node|
-        next unless node.name == "error" && node.node_type == Nokogiri::XML::Reader::TYPE_ELEMENT
-        error_xml = Nokogiri::XML::Document.parse(node.outer_xml).root
-        error = ValgrindError.new(configuration, error_xml)
-        next if error.skip?
-        @errors << error
-      end
-    end
-
-    def output_valgrind_errors
-      @errors.each do |error|
-        configuration.output_io.puts error
-        configuration.output_io.puts
-      end
-    end
   end
 end

data/lib/ruby_memcheck/test_task_reporter.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module RubyMemcheck
+  module TestTaskReporter
+    VALGRIND_REPORT_MSG = "Valgrind reported errors (e.g. memory leak or use-after-free)"
+
+    attr_reader :errors
+
+    private
+
+    def report_valgrind_errors
+      if configuration.valgrind_xml_dir
+        parse_valgrind_output
+        remove_valgrind_xml_files
+
+        unless errors.empty?
+          output_valgrind_errors
+          raise VALGRIND_REPORT_MSG
+        end
+      end
+    end
+
+    def parse_valgrind_output
+      require "nokogiri"
+
+      @errors = []
+
+      Dir[File.join(configuration.valgrind_xml_dir, "*")].each do |file|
+        Nokogiri::XML::Reader(File.open(file)).each do |node|
+          next unless node.name == "error" && node.node_type == Nokogiri::XML::Reader::TYPE_ELEMENT
+          error_xml = Nokogiri::XML::Document.parse(node.outer_xml).root
+          error = ValgrindError.new(configuration, error_xml)
+          next if error.skip?
+          @errors << error
+        end
+      end
+    end
+
+    def output_valgrind_errors
+      @errors.each do |error|
+        configuration.output_io.puts error
+        configuration.output_io.puts
+      end
+    end
+
+    def remove_valgrind_xml_files
+      FileUtils.rm_rf(configuration.valgrind_xml_dir)
+    end
+  end
+end

data/lib/ruby_memcheck/valgrind_error.rb

@@ -2,6 +2,9 @@
 
 module RubyMemcheck
   class ValgrindError
+    SUPPRESSION_NOT_CONFIGURED_ERROR_MSG =
+      "Please enable suppressions by configuring with valgrind_generate_suppressions set to true"
+
     attr_reader :kind, :msg, :stack, :suppression
 
     def initialize(configuration, error)
@@ -14,7 +17,13 @@ module RubyMemcheck
         end
       @stack = Stack.new(configuration, error.at_xpath("stack"))
       @configuration = configuration
-      @suppression = Suppression.new(configuration, error.at_xpath("suppression"))
+
+      suppression_node = error.at_xpath("suppression")
+      if configuration.valgrind_generate_suppressions?
+        @suppression = Suppression.new(configuration, suppression_node)
+      elsif suppression_node
+        raise SUPPRESSION_NOT_CONFIGURED_ERROR_MSG
+      end
     end
 
     def skip?
@@ -35,7 +44,7 @@ module RubyMemcheck
           "  #{frame}\n"
         end
       end
-      str << suppression.to_s
+      str << suppression.to_s if suppression
       str.string
     end
 

data/lib/ruby_memcheck/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyMemcheck
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/ruby_memcheck.rb

@@ -6,6 +6,7 @@ require "rake/testtask"
 require "ruby_memcheck/configuration"
 require "ruby_memcheck/frame"
 require "ruby_memcheck/stack"
+require "ruby_memcheck/test_task_reporter"
 require "ruby_memcheck/test_task"
 require "ruby_memcheck/valgrind_error"
 require "ruby_memcheck/suppression"

data/ruby_memcheck.gemspec

@@ -27,8 +27,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency("nokogiri")
 
   spec.add_development_dependency("minitest", "~> 5.0")
+  spec.add_development_dependency("minitest-parallel_fork", "~> 1.2")
   spec.add_development_dependency("rake", "~> 13.0")
   spec.add_development_dependency("rake-compiler", "~> 1.1")
+  spec.add_development_dependency("rspec-core")
   spec.add_development_dependency("rubocop", "~> 1.22")
   spec.add_development_dependency("rubocop-shopify", "~> 2.3")
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_memcheck
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Peter Zhu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-22 00:00:00.000000000 Z
+date: 2021-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-parallel_fork
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -112,9 +140,11 @@ files:
 - lib/ruby_memcheck.rb
 - lib/ruby_memcheck/configuration.rb
 - lib/ruby_memcheck/frame.rb
+- lib/ruby_memcheck/rspec/rake_task.rb
 - lib/ruby_memcheck/stack.rb
 - lib/ruby_memcheck/suppression.rb
 - lib/ruby_memcheck/test_task.rb
+- lib/ruby_memcheck/test_task_reporter.rb
 - lib/ruby_memcheck/valgrind_error.rb
 - lib/ruby_memcheck/version.rb
 - ruby_memcheck.gemspec
@@ -138,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.0.dev
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Use Valgrind memcheck without going crazy