ruby_memcheck 1.0.0 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 751718a23aee213973e93656dba653e4e253fd3f83618007c39e809827273ac5
-  data.tar.gz: 55d6196fb48e0c18fabb5c87536c2c4114d7a1c1a2b04128ec2c707389934de0
+  metadata.gz: c5872b7150e47c3eb369c82bff0f8adbd58e48ecf69cdd2c41f7aee2e11d2591
+  data.tar.gz: eb72ad63ada1c5af40938059f25f6392d30b44262d2482fc836aac795673683c
 SHA512:
-  metadata.gz: 861d0639b3d06d124f4020cb372472954018ad113ba4864b9367be6c6d167a338297d18c7c4adbcae767ba4a30e8925402bd7faa5a97841a513914ce41e10997
-  data.tar.gz: e0dc1e236947746baef93281f00ec8129f651b7e560e56d2dffc5c188f14e5b32b39adc204ecea2da51c1e9ed341f1c00ff55b4b82521bb2b7b54085d5bfddfc
+  metadata.gz: 0b6582216142426fb20ebbad4493b0002f83aa3696ec314cf8173890eba2cc1398fcf89d7227a629e7be3f642f60551b315cc9957df47f17e0d603fa406b1a43
+  data.tar.gz: 74739f350aa890ef955fdc8d63c40810f8997ef4aaf8b5c5763086787da22efadf243e1a5e9d2ea20ac672714c1aed20bc72df9ab9a8abd22c7b3c9244114c59

data/.github/workflows/test.yml

@@ -6,9 +6,9 @@ jobs:
     strategy:
       matrix:
         entry:
-          - { ruby: '2.6', allowed-failure: false }
           - { ruby: '2.7', allowed-failure: false }
           - { ruby: '3.0', allowed-failure: false }
+          - { ruby: '3.1', allowed-failure: false }
           - { ruby: ruby-head, allowed-failure: false }
     name: ruby ${{ matrix.entry.ruby }}
     steps:

data/.rubocop.yml

@@ -8,3 +8,6 @@ AllCops:
 Style/GlobalVars:
   Exclude:
     - test/ruby_memcheck/ext/extconf.rb
+
+Layout/CommentIndentation:
+  AllowForAlignment: true

data/README.md

@@ -26,16 +26,19 @@ Only gems with native extensions can use this gem. If your gem is written in pla
 
 This gem runs Valgrind with the `--xml` option to generate an XML of all the errors. It will then parse the XML and use various heuristics based on the type of the error and the stack trace to filter out errors that are false positives.
 
+For more details, read [this blog post](https://blog.peterzhu.ca/ruby-memcheck/).
+
 ### Limitations
 
 Because of the aggressive heuristics used to filter out false positives, there are various limitations of what this gem can detect.
 
 1. This gem is only expected to work on Linux.
+1. This gem runs your gem's test suite to find errors and memory leaks. It will only be able to report errors on code paths that are covered by your tests. So make sure your test suite has good coverage!
 1. It will not find memory leaks in Ruby. It filters out everything in Ruby.
 1. It will not find memory leaks of allocations that occurred in Ruby (even if the memory leak is caused by your native extension).
 
     An example of this is if a string is allocated in Ruby, passed into your native extension, you change the pointer of the string without freeing the contents, so the contents of the string becomes leaked.
-1. To filter out false-positives, it will only find definite leaks (i.e. memory regions with no pointers to it). It will not find possible leaks (i.e. memory regions with pointers to it).
+1. To filter out false positives, it will only find definite leaks (i.e. memory regions with no pointers to it). It will not find possible leaks (i.e. memory regions with pointers to it).
 1. It will not find leaks that occur in the `Init` function of your native extension.
 1. It will not find uses of undefined values (e.g. conditional jumps depending on undefined values). This is just a technical limitation that has not been solved yet (contributions welcome!).
 
@@ -67,6 +70,7 @@ The easiest way to use this gem is to use it on your test suite (minitest or RSp
     ```ruby
     RubyMemcheck.config(binary_name: "your_binary_name")
     ```
+
 1. Setup the test task for your test framework.
     - **minitest**
     
@@ -117,6 +121,18 @@ The easiest way to use this gem is to use it on your test suite (minitest or RSp
       end
       ```
 
+1. Add the following line to your `test_helper.rb` or `spec_helper.rb`:
+
+    ```ruby
+    at_exit { GC.start }
+    ```
+
+    This will run a major garbage collection cycle before the Ruby process shuts down. This will ensure that any remaining Ruby objects are collected which will prevent Valgrind from reporting false positives.
+
+    It is safest to add the line above at the very first line of `test_helper.rb` or `spec_helper.rb`.
+
+    - **For minitest:** It is important that the line above is added BEFORE the `require "minitest/autorun"` line.
+
 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 Valgrind suppression files. See the [`Suppression files`](#suppression-files) section for more details.
 

data/lib/ruby_memcheck/configuration.rb

@@ -29,6 +29,8 @@ 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,
@@ -71,6 +73,13 @@ module RubyMemcheck
 
     def command(*args)
       [
+        # On some Rubies, not setting the stack size to be ulimited causes
+        # Valgrind to report the following error:
+        #   Invalid write of size 1
+        #     reserve_stack (thread_pthread.c:845)
+        #     ruby_init_stack (thread_pthread.c:871)
+        #     main (main.c:48)
+        "ulimit -s unlimited && ",
         valgrind,
         valgrind_options,
         get_valgrind_suppression_files(valgrind_suppressions_dir).map { |f| "--suppressions=#{f}" },

data/lib/ruby_memcheck/test_task_reporter.rb

@@ -10,8 +10,9 @@ module RubyMemcheck
 
     def report_valgrind_errors
       if configuration.valgrind_xml_dir
-        parse_valgrind_output
-        remove_valgrind_xml_files
+        xml_files = valgrind_xml_files
+        parse_valgrind_output(xml_files)
+        remove_valgrind_xml_files(xml_files)
 
         unless errors.empty?
           output_valgrind_errors
@@ -20,31 +21,39 @@ module RubyMemcheck
       end
     end
 
-    def parse_valgrind_output
+    def valgrind_xml_files
+      Dir[File.join(configuration.valgrind_xml_dir, "*")]
+    end
+
+    def parse_valgrind_output(xml_files)
       require "nokogiri"
 
       @errors = []
 
-      Dir[File.join(configuration.valgrind_xml_dir, "*")].each do |file|
+      xml_files.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 remove_valgrind_xml_files(xml_files)
+      xml_files.each do |file|
+        File.delete(file)
+      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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_memcheck
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.3
 platform: ruby
 authors:
 - Peter Zhu
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-03 00:00:00.000000000 Z
+date: 2022-07-24 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: []
@@ -153,7 +153,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/peterzhu2118/ruby_memcheck
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -168,8 +168,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Use Valgrind memcheck without going crazy
 test_files: []