hoe-debugging 1.2.1 → 1.3.0

data/spec/files/sample.supp

@@ -0,0 +1,84 @@
+{
+   <insert_a_suppression_name_here>
+   Memcheck:Addr4
+   fun:glob_helper
+   fun:ruby_glob0
+   fun:rb_push_glob
+   fun:vm_call_method
+   fun:vm_exec_core
+   fun:vm_exec
+   fun:rb_yield
+   fun:rb_ary_each
+   fun:vm_call_method
+   fun:vm_exec_core
+   fun:vm_exec
+   fun:vm_call0
+   fun:rb_iterate
+   fun:rb_block_call
+   fun:enum_find_all
+   fun:vm_call_method
+   fun:vm_exec_core
+   fun:vm_exec
+   fun:vm_call0
+   fun:rb_class_new_instance
+   fun:vm_call_method
+   fun:vm_exec_core
+   fun:vm_exec
+   fun:vm_call0
+}
+{
+   <insert_a_suppression_name_here>
+   Memcheck:Addr4
+   fun:glob_helper
+   fun:ruby_glob0
+   fun:ruby_brace_expand.constprop.7
+   fun:rb_push_glob
+   fun:vm_call_method
+   fun:vm_exec_core
+   fun:vm_exec
+   fun:any_iter_i
+   fun:vm_yield_with_cfunc
+   fun:rb_yield
+   fun:rb_ary_each
+   fun:vm_call0
+   fun:rb_iterate
+   fun:rb_block_call
+   fun:enum_any
+   fun:vm_call_method
+   fun:vm_exec_core
+   fun:vm_exec
+   fun:vm_call0
+   fun:rb_class_new_instance
+   fun:vm_call_method
+   fun:vm_exec_core
+   fun:vm_exec
+   fun:rb_iseq_eval
+}
+{
+   <insert_a_suppression_name_here>
+   Memcheck:Addr4
+   fun:glob_helper
+   fun:glob_helper
+   fun:ruby_glob0
+   fun:ruby_brace_expand.constprop.7
+   fun:rb_push_glob
+   fun:vm_call_method
+   fun:vm_exec_core
+   fun:vm_exec
+   fun:any_iter_i
+   fun:vm_yield_with_cfunc
+   fun:rb_yield
+   fun:rb_ary_each
+   fun:vm_call0
+   fun:rb_iterate
+   fun:rb_block_call
+   fun:enum_any
+   fun:vm_call_method
+   fun:vm_exec_core
+   fun:vm_exec
+   fun:vm_call0
+   fun:rb_class_new_instance
+   fun:vm_call_method
+   fun:vm_exec_core
+   fun:vm_exec
+}

data/spec/files/test_project/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gem "bundler"
+gem "hoe"
+gem "hoe-debugging", path: "../../.."
+gem "minitest"
+gem "rake-compiler"

data/spec/files/test_project/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2017-01-20
+
+* 1 major enhancement
+
+  * Birthday!
+

data/spec/files/test_project/Manifest.txt

@@ -0,0 +1,8 @@
+.autotest
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/test_project
+lib/test_project.rb
+test/test_test_project.rb

data/spec/files/test_project/README.txt

@@ -0,0 +1,6 @@
+= blah
+
+home  :: http://testproject.example.com/
+code  :: http://testproject.example.com/
+rdoc  :: http://testproject.example.com/
+bugs  :: http://testproject.example.com/

data/spec/files/test_project/Rakefile

@@ -0,0 +1,28 @@
+# -*- ruby -*-
+
+require "rubygems"
+require "hoe"
+
+require 'rake/extensiontask'
+
+# Hoe.plugin :bundler
+# Hoe.plugin :compiler
+Hoe.plugin :debugging
+# Hoe.plugin :gem_prelude_sucks
+# Hoe.plugin :gemspec
+# Hoe.plugin :git
+# Hoe.plugin :inline
+# Hoe.plugin :minitest
+# Hoe.plugin :racc
+# Hoe.plugin :rcov
+# Hoe.plugin :rdoc
+
+HOE = Hoe.spec "test_project" do |spec|
+  developer("Hoe Debuggin", "hoedebuggin@example.com")
+  license("MIT")
+  spec.version = "1.0.0"
+end
+
+Rake::ExtensionTask.new("test_project")
+
+# vim: syntax=ruby

data/spec/files/test_project/ext/test_project/extconf.rb

@@ -0,0 +1,3 @@
+require 'mkmf'
+
+create_makefile('test_project')

data/spec/files/test_project/ext/test_project/test_project.c

@@ -0,0 +1,20 @@
+#include <ruby.h>
+
+static VALUE bad_method()
+{
+  int *foo = malloc(sizeof(int));
+  *foo = 0 ;
+  
+  printf("Hoedebuggingtest: running %d\n", *(foo + 512));
+  printf("Hoedebuggingtest: running %d\n", *(foo + 1024));
+  printf("Hoedebuggingtest: running %d\n", *(foo + 2048));
+  return Qnil;
+}
+
+
+void Init_test_project()
+{
+  VALUE mHoedebuggingtest = rb_define_module("Hoedebuggingtest");
+
+  rb_define_singleton_method(mHoedebuggingtest, "bad_method", bad_method, 0);
+}

data/spec/files/test_project/test/test_test_project.rb

@@ -0,0 +1,11 @@
+gem "minitest"
+require "minitest/autorun"
+require "test_project"
+require "test_project.so"
+
+class TestTestProject < Minitest::Test
+  def test_good
+    STDERR.puts "MIKE: running the test"
+    Hoedebuggingtest.bad_method
+  end
+end

data/spec/hoe_debugging_exit_code_spec.rb

@@ -0,0 +1,45 @@
+require_relative "spec_helper.rb"
+
+describe "exit code" do
+  def sh command
+    Rake.sh command, verbose: false
+  end
+
+  let(:test_dir) { File.join(File.dirname(__FILE__), "files/test_project") }
+
+  before do
+    Bundler.with_clean_env do
+      Dir.chdir test_dir do
+        sh "gem install bundler > #{logfile} 2>&1"
+        sh "bundle install >> #{logfile} 2>&1"
+        sh "bundle exec rake compile >> #{logfile} 2>&1"
+      end
+    end
+  end
+
+  context "from a good run" do
+    let(:logfile) { "good-run.log" }
+    it "is zero" do
+      Bundler.with_clean_env do
+        Dir.chdir test_dir do
+          system "bundle exec rake test:valgrind TESTOPTS='--name /notexist/' >> #{logfile} 2>&1"
+          exitcode = $?
+          expect(exitcode.success?).to(be_truthy, File.read(logfile))
+        end
+      end
+    end
+  end
+
+  context "from a bad run" do
+    let(:logfile) { "good-run.log" }
+    it "is nonzero" do
+      Bundler.with_clean_env do
+        Dir.chdir test_dir do
+          system "bundle exec rake test:valgrind >> #{logfile} 2>&1"
+          exitcode = $?
+          expect(exitcode.success?).to(be_falsey, File.read(logfile))
+        end
+      end
+    end
+  end
+end

data/spec/hoe_debugging_valgrind_helper_spec.rb

@@ -0,0 +1,98 @@
+require_relative "spec_helper.rb"
+
+describe Hoe::Debugging::ValgrindHelper do
+  let(:logfile)  { File.join File.dirname(__FILE__), "files/sample.log" }
+  let(:suppfile) { File.join File.dirname(__FILE__), "files/sample.supp" }
+  let(:klass)    { Hoe::Debugging::ValgrindHelper }
+
+  let(:suppressions_directory) { "tmp/suppressions" }
+  before { FileUtils.rm_rf suppressions_directory }
+
+  describe "#initialize" do
+    it "requires a project_name argument" do
+      expect { klass.new }.to raise_error ArgumentError
+    end
+  end
+
+  describe "#directory" do
+    it { expect(klass.new("myproj")                     .directory).to eq "suppressions" }
+    it { expect(klass.new("myproj", :directory => "foo").directory).to eq "foo" }
+  end
+
+  describe "#project_name" do
+    it { expect(klass.new("myproj").project_name).to eq "myproj" }
+  end
+
+  describe "#version_matches" do
+    it "returns possible suppression file matches in order of specificity" do
+      helper = klass.new "myproj"
+      allow(helper).to receive(:formatted_ruby_version) { "ruby-1.9.3.194" }
+      expect(helper.version_matches).to eq %w[ruby-1.9.3.194 ruby-1.9.3 ruby-1.9]
+    end
+  end
+
+  describe "#parse_suppressions_from" do
+    it "generates a de-duped set of suppressions" do
+      helper = klass.new "myproj"
+      suppressions = helper.parse_suppressions_from logfile
+
+      expected = File.read suppfile
+
+      expect(suppressions).to eq expected
+    end
+  end
+
+  describe "#save_suppressions_from" do
+    it "saves a file simply containing the ruby" do
+      helper = klass.new "myproj", :directory => suppressions_directory
+      actual_file = helper.save_suppressions_from logfile
+      expect(actual_file).to match(/myproj_ruby-.*\.supp/)
+
+      actual = File.read actual_file
+      expected = File.read suppfile
+      expect(actual).to eq expected
+    end
+  end
+
+  describe "#matching_suppression_file" do
+    context "there are multiple matches" do
+      it "returns the best match" do
+        helper = klass.new "myproj", :directory => suppressions_directory
+        exact_match = File.join(suppressions_directory, "myproj_#{helper.formatted_ruby_version}.supp")
+        inexact_match = File.join(suppressions_directory, "myproj_#{helper.version_matches[1]}.999999999.supp")
+        FileUtils.mkdir_p suppressions_directory
+        FileUtils.touch inexact_match
+        FileUtils.touch exact_match
+        expect(helper.matching_suppression_file).to eq exact_match
+      end
+    end
+
+
+    context "there is one inexact match" do
+      it "returns it" do
+        helper = klass.new "myproj", :directory => suppressions_directory
+        inexact_match = File.join(suppressions_directory, "myproj_#{helper.version_matches[1]}.999999999.supp")
+        FileUtils.mkdir_p suppressions_directory
+        FileUtils.touch inexact_match
+        expect(helper.matching_suppression_file).to eq inexact_match
+      end
+    end
+
+    context "there is one exact match" do
+      it "returns it" do
+        helper = klass.new "myproj", :directory => suppressions_directory
+        exact_match = File.join(suppressions_directory, "myproj_#{helper.formatted_ruby_version}.supp")
+        FileUtils.mkdir_p suppressions_directory
+        FileUtils.touch exact_match
+        expect(helper.matching_suppression_file).to eq exact_match
+      end
+    end
+
+    context "there are zero matches" do
+      it "returns nil" do
+        helper = klass.new "myproj", :directory => suppressions_directory
+        expect(helper.matching_suppression_file).to be_nil
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require File.join File.dirname(__FILE__), "../lib/hoe/debugging"
+require "fileutils"
+require "rake"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hoe-debugging
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - John Barnette
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-17 00:00:00.000000000 Z
+date: 2017-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement
@@ -40,21 +40,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: hoe-bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: hoe-git
+  name: hoe-gemspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -68,7 +68,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: hoe-gemspec
+  name: hoe-git
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -82,7 +82,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: hoe-bundler
+  name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,18 +95,40 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 description: |-
-  A Hoe plugin to help you debug your C extensions. This plugin provides
-  <tt>test:gdb</tt> and <tt>test:valgrind</tt> tasks (plus a few
-  variants).
-
-  See the Hoe::Debugging module for a few configuration options.
+  A Hoe plugin to help you debug your C extensions. This plugin provides `test:gdb` and `test:valgrind` tasks (plus a few variants).
 
-  This plugin expects you to have <tt>gdb</tt> and <tt>valgrind</tt>
-  available in your <tt>PATH</tt>.
+  See the `Hoe::Debugging` module for a few configuration options.
 
-  These tasks were extracted from nokogiri / johnson and originally written by
-  ruby legend, {Mike Dalessio}[http://mike.daless.io].
+  This plugin expects you to have `gdb` and `valgrind` available in your `PATH`.
 email:
 - jbarnette@rubyforge.org
 - mike.dalessio@gmail.com
@@ -115,13 +137,28 @@ extensions: []
 extra_rdoc_files:
 - CHANGELOG.rdoc
 - Manifest.txt
-- README.rdoc
+- README.md
 files:
+- ".rspec"
 - CHANGELOG.rdoc
+- LICENSE
 - Manifest.txt
-- README.rdoc
+- README.md
 - Rakefile
 - lib/hoe/debugging.rb
+- spec/files/sample.log
+- spec/files/sample.supp
+- spec/files/test_project/Gemfile
+- spec/files/test_project/History.txt
+- spec/files/test_project/Manifest.txt
+- spec/files/test_project/README.txt
+- spec/files/test_project/Rakefile
+- spec/files/test_project/ext/test_project/extconf.rb
+- spec/files/test_project/ext/test_project/test_project.c
+- spec/files/test_project/test/test_test_project.rb
+- spec/hoe_debugging_exit_code_spec.rb
+- spec/hoe_debugging_valgrind_helper_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/jbarnette/hoe-debugging
 licenses:
 - MIT
@@ -129,7 +166,7 @@ metadata: {}
 post_install_message: 
 rdoc_options:
 - "--main"
-- README.rdoc
+- README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -144,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: A Hoe plugin to help you debug your C extensions