Merge pull request #293 from Shopify/add-ruby-memcheck

Add ruby memcheck to use valgrind in CI

Author: kddnewton

.github/workflows/main.yml

@@ -22,3 +22,28 @@ jobs:
 
     - name: Run Ruby tests
       run: bundle exec rake
+
+  memcheck:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Install valgrind from source
+      run: |
+        sudo apt-get install -y libc6-dbg
+        wget https://sourceware.org/pub/valgrind/valgrind-3.20.0.tar.bz2
+        tar xvf valgrind-3.20.0.tar.bz2
+        cd valgrind-3.20.0
+        ./configure
+        make
+        sudo make install
+
+    - uses: actions/checkout@v2
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: head
+        bundler-cache: true
+
+    - name: Run Ruby tests with valgrind
+      run: bundle exec rake test:valgrind

Gemfile

@@ -7,3 +7,4 @@ ruby ">= 3.1.0"
 gem "rake"
 gem "rake-compiler"
 gem "test-unit"
+gem "ruby_memcheck"

Gemfile.lock

@@ -1,10 +1,17 @@
 GEM
   remote: https://rubygems.org/
   specs:
+    mini_portile2 (2.8.1)
+    nokogiri (1.14.2)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
     power_assert (2.0.1)
+    racc (1.6.2)
     rake (13.0.6)
     rake-compiler (1.2.0)
       rake
+    ruby_memcheck (1.2.0)
+      nokogiri
     test-unit (3.5.3)
       power_assert
 
@@ -14,6 +21,7 @@ PLATFORMS
 DEPENDENCIES
   rake
   rake-compiler
+  ruby_memcheck
   test-unit
 
 RUBY VERSION

Rakefile

@@ -3,6 +3,9 @@
 require "rake/extensiontask"
 require "rake/testtask"
 require "rake/clean"
+require "ruby_memcheck"
+
+RubyMemcheck.config(binary_name: "yarp")
 
 task compile: :make
 
@@ -13,12 +16,18 @@ Rake::ExtensionTask.new(:compile) do |ext|
   ext.gem_spec = Gem::Specification.load("yarp.gemspec")
 end
 
-Rake::TestTask.new(test: :compile) do |t|
+test_config = lambda do |t|
   t.libs << "test"
   t.libs << "lib"
   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
+
 task default: :test
 
 TEMPLATES = [