ruby_memcheck 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5872b7150e47c3eb369c82bff0f8adbd58e48ecf69cdd2c41f7aee2e11d2591
-  data.tar.gz: eb72ad63ada1c5af40938059f25f6392d30b44262d2482fc836aac795673683c
+  metadata.gz: 4cd707ffa4ebdb25945d2d2654659a38c2272a0e73678d9c9f58e655e19b3cc6
+  data.tar.gz: df247c2a1e77374ad3c9521b1a3f2554c443fa80e33d50cd948727821a3267d5
 SHA512:
-  metadata.gz: 0b6582216142426fb20ebbad4493b0002f83aa3696ec314cf8173890eba2cc1398fcf89d7227a629e7be3f642f60551b315cc9957df47f17e0d603fa406b1a43
-  data.tar.gz: 74739f350aa890ef955fdc8d63c40810f8997ef4aaf8b5c5763086787da22efadf243e1a5e9d2ea20ac672714c1aed20bc72df9ab9a8abd22c7b3c9244114c59
+  metadata.gz: 7b4c337a38ad04be648365f4de828187524f11f67699aaa187182d906e4dbf922d84767003e4bab79572c0b3c41fe908c2bb23b1029b1d49360a9c399df5010f
+  data.tar.gz: 3c73f128a88b0eabce497b0ebb464166ccc541dbf5ec0e03b1951d8e1569abd6123a48a454b6a2e9b808c95770ea922b6e027db8c2be2a458d5f0b53f3cb74bc

data/README.md

@@ -109,13 +109,13 @@ The easiest way to use this gem is to use it on your test suite (minitest or RSp
       For example, if your Rakefile looked like this before:
 
       ```ruby
-      RubyMemcheck::RSpec::RakeTask.new(spec: :compile)
+      RSpec::Core::RakeTask.new(spec: :compile)
       ```
 
       You can change it to look like this:
 
       ```ruby
-      RubyMemcheck::RSpec::RakeTask.new(spec: :compile)
+      RSpec::Core::RakeTask.new(spec: :compile)
       namespace :spec do
         RubyMemcheck::RSpec::RakeTask.new(valgrind: :compile)
       end
@@ -156,7 +156,7 @@ When you run `RubyMemcheck.config`, you are creating a default `RubyMemcheck::Co
 
 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.).
+The most basic suppression file is `ruby.supp`. If you want some suppressions for only specific versions of Ruby, you can add the Ruby version to the filename. For example, `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 `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.).
 
 ## Success stories
 

data/lib/ruby_memcheck/configuration.rb

@@ -29,11 +29,9 @@ module RubyMemcheck
       /\Arb_respond_to\z/,
       /\Arb_thread_create\z/, # Threads are relased to a cache, so they may be reported as a leak
       /\Arb_yield/,
-      /\Astack_chunk_alloc/, # Remove this after Ruby 2.7.7, 3.0.5, 3.1.3 are relased
-                             # See: https://github.com/Shopify/ruby_memcheck/issues/6
     ].freeze
 
-    attr_reader :binary_name, :ruby, :valgrind, :valgrind_options, :valgrind_suppressions_dir,
+    attr_reader :binary_name, :ruby, :valgrind, :valgrind_options, :valgrind_suppression_files,
       :valgrind_generate_suppressions, :skipped_ruby_functions, :valgrind_xml_dir, :output_io
     alias_method :valgrind_generate_suppressions?, :valgrind_generate_suppressions
 
@@ -52,7 +50,9 @@ module RubyMemcheck
       @ruby = ruby
       @valgrind = valgrind
       @valgrind_options = valgrind_options
-      @valgrind_suppressions_dir = File.expand_path(valgrind_suppressions_dir)
+      @valgrind_suppression_files =
+        get_valgrind_suppression_files(File.join(__dir__, "../../suppressions")) +
+        get_valgrind_suppression_files(valgrind_suppressions_dir)
       @valgrind_generate_suppressions = valgrind_generate_suppressions
       @skipped_ruby_functions = skipped_ruby_functions
       @output_io = output_io
@@ -82,7 +82,7 @@ module RubyMemcheck
         "ulimit -s unlimited && ",
         valgrind,
         valgrind_options,
-        get_valgrind_suppression_files(valgrind_suppressions_dir).map { |f| "--suppressions=#{f}" },
+        valgrind_suppression_files.map { |f| "--suppressions=#{f}" },
         valgrind_generate_suppressions ? "--gen-suppressions=all" : "",
         ruby,
         args,
@@ -92,13 +92,22 @@ module RubyMemcheck
     private
 
     def get_valgrind_suppression_files(dir)
+      dir = File.expand_path(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")]
+        old_format_files = Dir[File.join(dir, "#{binary_name}_#{version}.supp")]
+
+        unless old_format_files.empty?
+          warn("ruby_memcheck: please migrate your suppression filenames from " \
+            "`gem_name_ruby-3.1.0.supp` to `ruby-3.1.0.supp` (drop the gem name from the filename)")
+        end
+
+        old_format_files + Dir[File.join(dir, "#{version}.supp")]
       end.flatten
     end
   end

data/lib/ruby_memcheck/version.rb

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

data/suppressions/ruby.supp

@@ -0,0 +1,21 @@
+{
+  On platforms where memcpy is safe for overlapped memory, the compiler will sometimes replace memmove with memcpy. Valgrind may report a false positive.
+  Memcheck:Overlap
+  fun:__memcpy_chk
+  fun:memmove
+  ...
+}
+{
+  Requiring a file will add it to the loaded features, which may be reported as a leak.
+  Memcheck:Leak
+  ...
+  fun:require_internal
+  ...
+}
+{
+  Remove this after Ruby 2.7.7, 3.0.5, 3.1.3 are relased. See: https://github.com/Shopify/ruby_memcheck/issues/6
+  Memcheck:Leak
+  ...
+  fun:stack_chunk_alloc
+  ...
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_memcheck
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Peter Zhu
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-24 00:00:00.000000000 Z
+date: 2022-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -122,7 +122,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
-description:
+description: 
 email:
 - peter@peterzhu.ca
 executables: []
@@ -148,12 +148,13 @@ files:
 - lib/ruby_memcheck/valgrind_error.rb
 - lib/ruby_memcheck/version.rb
 - ruby_memcheck.gemspec
+- suppressions/ruby.supp
 homepage: https://github.com/peterzhu2118/ruby_memcheck
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/peterzhu2118/ruby_memcheck
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -169,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.7
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Use Valgrind memcheck without going crazy
 test_files: []