ruby_memcheck 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa5f0f59617f5220d6870d3d44cae58605b9488c31d03c1c1d027895fafaf83d
-  data.tar.gz: 999a0744c5a3c32ddf1e51d3f31164d13c144afe138fc4793b1930fcf3ec7a9e
+  metadata.gz: 7d7e2556e802cceebbd1607895ed319b54037e2a945586f8fe65e9f6bda0928c
+  data.tar.gz: 3cba76f62de7ad396458d651a272d660456e362a85c1c6a67ac6ae688b3e4c30
 SHA512:
-  metadata.gz: f95821f8680a6685deb30e3a3acb8763878a52c76149f922f8a237f36406a0ded80e34dcbf66da29f78112e4fc4a4e3e534a7f6aa019a1df104c9e0d3cc18dbf
-  data.tar.gz: 1d8cd567af6606c87b4222832917417a478e8ab265db59fffbc8ad4cd418bfd6bf06f63170ce537865972232134b503c23a661abdbdbc6b3f64d0ee2c7ca3a44
+  metadata.gz: 6e849c1bcfc9947293939452298c344acd71136dd7b617bb3edfc07c7b8122a9bc366e1e57a83d86293ed284569121185d465fd9e47959a9e9e0b6579b212022
+  data.tar.gz: 3131ae9a995bcd2e9f9fcab7f7bfb8b99c3449eadb12d9bfad0366681971d3c3fa7234e194fbf7e5c9a41583d18814cc59aad7802836ba1d075e0d6893be0e1d

data/.rubocop.yml

@@ -3,3 +3,7 @@ inherit_gem:
 
 AllCops:
   SuggestExtensions: false
+
+Style/GlobalVars:
+  Exclude:
+    - test/ruby_memcheck/ext/extconf.rb

data/README.md

@@ -83,14 +83,15 @@ The easiest way to use this gem is to use it on your test suite using rake.
       RubyMemcheck::TestTask.new(valgrind: :compile, &test_config)
     end
     ```
-1. In your `test_helper.rb`/`spec_helper.rb` (or whatever file sets up your test suite), add this line:
+1. At the top of your `test_helper.rb`/`spec_helper.rb` (or whatever file sets up your test suite), add this line:
 
     ```ruby
-    END { GC.start }
+    at_exit { GC.start }
     ```
 
-    This will ensure that the Garbage Collector is ran before Ruby shuts down. This will reduce the number of false-positives.
+    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. (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

@@ -10,11 +10,13 @@ module RubyMemcheck
       "--leak-check=full",
       "--show-leak-kinds=definite",
     ].freeze
+    DEFAULT_VALGRIND_SUPPRESSIONS_DIR = "suppressions"
     DEFAULT_SKIPPED_RUBY_FUNCTIONS = [
       /\Arb_check_funcall/,
       /\Arb_enc_raise\z/,
       /\Arb_exc_raise\z/,
       /\Arb_funcall/,
+      /\Arb_intern/,
       /\Arb_ivar_set\z/,
       /\Arb_raise\z/,
       /\Arb_rescue/,
@@ -30,6 +32,7 @@ module RubyMemcheck
       ruby: FileUtils::RUBY,
       valgrind: DEFAULT_VALGRIND,
       valgrind_options: DEFAULT_VALGRIND_OPTIONS,
+      valgrind_suppressions_dir: DEFAULT_VALGRIND_SUPPRESSIONS_DIR,
       skipped_ruby_functions: DEFAULT_SKIPPED_RUBY_FUNCTIONS,
       valgrind_xml_file: Tempfile.new,
       output_io: $stderr
@@ -37,7 +40,9 @@ module RubyMemcheck
       @binary_name = binary_name
       @ruby = ruby
       @valgrind = valgrind
-      @valgrind_options = valgrind_options
+      @valgrind_options =
+        valgrind_options +
+        get_valgrind_suppression_files(valgrind_suppressions_dir).map { |f| "--suppressions=#{f}" }
       @skipped_ruby_functions = skipped_ruby_functions
       @output_io = output_io
 
@@ -89,5 +94,18 @@ module RubyMemcheck
         false
       end
     end
+
+    private
+
+    def get_valgrind_suppression_files(dir)
+      full_ruby_version = "#{RUBY_ENGINE}-#{RUBY_VERSION}.#{RUBY_PATCHLEVEL}"
+      versions = [full_ruby_version]
+      (0..3).reverse_each { |i| versions << full_ruby_version.split(".")[0, i].join(".") }
+      versions << RUBY_ENGINE
+
+      versions.map do |version|
+        Dir[File.join(dir, "#{binary_name}_#{version}.supp")]
+      end.flatten
+    end
   end
 end

data/lib/ruby_memcheck/suppression.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module RubyMemcheck
+  class Suppression
+    attr_reader :root
+
+    def initialize(configuration, suppression_node)
+      @root = suppression_node
+    end
+
+    def to_s
+      return "" if root.nil?
+
+      str = StringIO.new
+      str << "{\n"
+      str << "  #{root.at_xpath("sname").content}\n"
+      str << "  #{root.at_xpath("skind").content}\n"
+      root.xpath("./sframe/fun | ./sframe/obj").each do |frame|
+        str << "  #{frame.name}:#{frame.content}\n"
+      end
+      str << "}\n"
+      str.string
+    end
+  end
+end

data/lib/ruby_memcheck/test_task.rb

@@ -20,7 +20,7 @@ module RubyMemcheck
     def ruby(*args, **options, &block)
       command = configuration.command(args)
       sh(command, **options) do |ok, res|
-        if ok && configuration.valgrind_xml_file
+        if configuration.valgrind_xml_file
           parse_valgrind_output
           unless errors.empty?
             output_valgrind_errors
@@ -35,10 +35,13 @@ module RubyMemcheck
     private
 
     def parse_valgrind_output
+      require "nokogiri"
+
       @errors = []
 
-      xml = Nokogiri::XML(configuration.valgrind_xml_file.read)
-      xml.xpath("/valgrindoutput/error").each do |error_xml|
+      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

data/lib/ruby_memcheck/valgrind_error.rb

@@ -2,7 +2,7 @@
 
 module RubyMemcheck
   class ValgrindError
-    attr_reader :kind, :msg, :stack
+    attr_reader :kind, :msg, :stack, :suppression
 
     def initialize(configuration, error)
       @kind = error.at_xpath("kind").content
@@ -14,6 +14,7 @@ module RubyMemcheck
         end
       @stack = Stack.new(configuration, error.at_xpath("stack"))
       @configuration = configuration
+      @suppression = Suppression.new(configuration, error.at_xpath("suppression"))
     end
 
     def skip?
@@ -34,6 +35,7 @@ module RubyMemcheck
           "  #{frame}\n"
         end
       end
+      str << suppression.to_s
       str.string
     end
 

data/lib/ruby_memcheck/version.rb

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

data/lib/ruby_memcheck.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "tempfile"
-require "nokogiri"
 require "rake/testtask"
 
 require "ruby_memcheck/configuration"
@@ -9,6 +8,7 @@ require "ruby_memcheck/frame"
 require "ruby_memcheck/stack"
 require "ruby_memcheck/test_task"
 require "ruby_memcheck/valgrind_error"
+require "ruby_memcheck/suppression"
 require "ruby_memcheck/version"
 
 module RubyMemcheck

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_memcheck
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.1
 platform: ruby
 authors:
 - Peter Zhu
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-18 00:00:00.000000000 Z
+date: 2021-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -94,7 +94,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
-description:
+description: 
 email:
 - peter@peterzhu.ca
 executables: []
@@ -113,6 +113,7 @@ files:
 - lib/ruby_memcheck/configuration.rb
 - lib/ruby_memcheck/frame.rb
 - lib/ruby_memcheck/stack.rb
+- lib/ruby_memcheck/suppression.rb
 - lib/ruby_memcheck/test_task.rb
 - lib/ruby_memcheck/valgrind_error.rb
 - lib/ruby_memcheck/version.rb
@@ -122,7 +123,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/peterzhu2118/ruby_memcheck
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -137,8 +138,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
-signing_key:
+rubygems_version: 3.3.0.dev
+signing_key: 
 specification_version: 4
 summary: Use Valgrind memcheck without going crazy
 test_files: []