appmap 0.33.0 → 0.34.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae23c62b9a3f01cc3b7680706746d2f51c94c3a776978a8ee2d4e0e8501fca01
-  data.tar.gz: 4aa33af19ed0c31b826f8cffa75e147e2781fe93ed39353ace29cede8a7882b9
+  metadata.gz: 3b4318e1ef7e025a8f616022cefd323784e7b8ee8ccf06b1b7167b9937e860df
+  data.tar.gz: c6a743f2c7f4ebe8cd58f7ae971b5dae15791bc808dab9d4dcf87f4971986818
 SHA512:
-  metadata.gz: 04a3c1bee70c02c96c1b71d5153a6ed44d668d6fc69d6da77cd6201364ede609bee93604f4ace391ddb38f8259841d6b334fdbe9051f1667d41cf3383281fe58
-  data.tar.gz: c60d868b2c1fa9c1e8742856dd7f946f5bf1284cab01a4478708c1582add5ca8fd16002e150d8a2cd897819edb661a9082cb01ec3e9879686d85d49b341d4ba8
+  metadata.gz: 9f271a71bb8bffa7004d054ae91646c9c93a476b15cbe80c459a9cafcb13ab0169be6c8a2db9b8cc993c3bc767deef4c9c0ca4befe6bd6881cf2d93c7b692b64
+  data.tar.gz: 3b6c5067a325fa2a0aed71b5ed92179196061cd6cfa015f907a25dab798e757c2cd53efbd028513df1f22cc2e2b8aa9345f8d19aa27018eccfbee4cd39766ece

data/.gitignore

@@ -14,4 +14,4 @@ Gemfile.lock
 appmap.json
 .vscode
 .byebug_history
-
+/lib/appmap/appmap.bundle

data/.rbenv-gemsets

@@ -0,0 +1 @@
+appmap-ruby

data/CHANGELOG.md

@@ -1,3 +1,30 @@
+# v0.34.5
+* Ensure that hooking a method doesn't change its arity.
+
+# v0.34.4
+* Make sure `AppMap:Rails::SQLExaminer::ActiveRecordExaminer.server_version` only calls
+  `ActiveRecord::Base.connection.database_version` if it's available.
+* Fix `AppMap:Rails::SQLExaminer::ActiveRecordExaminer.database_type` returns `:postgres`
+  in all supported versions of Rails.
+
+# v0.34.3
+* Fix a crash in `singleton_method_owner_name` that occurred if `__attached__.class` returned
+  something other than a `Module` or a `Class`.
+  
+# v0.34.2
+* Add an extension that gets the name of the owner of a singleton method without calling
+  any methods that may have been redefined (e.g. `#to_s` or `.name`).
+  
+# v0.34.1
+* Ensure that capturing events doesn't change the behavior of a hooked method that uses
+  `Time.now`. For example, if a test expects that `Time.now` will be called a certain
+  number of times by a hooked method, that expectation will now be met.
+* Make sure `appmap/cucumber` requires `appmap`.
+
+# v0.34.0
+
+* Records builtin security and I/O methods from `OpenSSL`, `Net`, and `IO`.
+
 # v0.33.0
 
 * Added command `AppMap.open` to open an AppMap in the browser.

data/README.md

@@ -57,6 +57,15 @@ end
 
 Then install with `bundle`.
 
+**Railtie**
+
+If you are using Ruby on Rails, require the railtie after Rails is loaded. 
+
+```
+# application.rb is a good place to do this, along with all the other railties.
+require 'appmap/railtie'
+```
+
 # Configuration
 
 When you run your program, the `appmap` gem reads configuration settings from `appmap.yml`. Here's a sample configuration
@@ -267,7 +276,13 @@ $ bundle config local.appmap $(pwd)
 Run the tests via `rake`:
 ```
 $ bundle exec rake test
-```  
+```
+
+The `test` target will build the native extension first, then run the tests. If you need
+to build the extension separately, run
+```
+$ bundle exec rake compile
+```
 
 ## Using fixture apps
 
@@ -286,7 +301,7 @@ resources such as a PostgreSQL database.
 To build the fixture container images, first run:
 
 ```sh-session
-$ bundle exec rake fixtures:all
+$ bundle exec rake build:fixtures:all
 ```
 
 This will build the `appmap.gem`, along with a Docker image for each fixture app.

data/Rakefile

@@ -6,6 +6,13 @@ require 'rdoc/task'
 
 require 'open3'
 
+require "rake/extensiontask"
+
+desc 'build the native extension'
+Rake::ExtensionTask.new("appmap") do |ext|
+  ext.lib_dir = "lib/appmap"
+end
+
 namespace 'gem' do
   require 'bundler/gem_tasks'
 end
@@ -104,7 +111,7 @@ end
 namespace :spec do
   RUBY_VERSIONS.each do |ruby_version|
     desc ruby_version
-    task ruby_version, [:specs] => ["build:fixtures:#{ruby_version}:all"] do |_, task_args|
+    task ruby_version, [:specs] => ["compile", "build:fixtures:#{ruby_version}:all"] do |_, task_args|
       run_specs(ruby_version, task_args)
     end.tap do|t|
       desc "Run all specs"
@@ -119,13 +126,13 @@ Rake::RDocTask.new do |rd|
   rd.title = 'AppMap'
 end
 
-Rake::TestTask.new(:minitest) do |t|
+Rake::TestTask.new(minitest: 'compile') do |t|
   t.libs << 'test'
   t.libs << 'lib'
   t.test_files = FileList['test/*_test.rb']
 end
 
-task spec: "spec:all"
+task spec: %i[spec:all]
 
 task test: %i[spec:all minitest]
 

data/appmap.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = `git ls-files --no-deleted`.split("
 ")
+  spec.extensions << "ext/appmap/extconf.rb"
+
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
@@ -34,6 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rdoc'
   spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency "rake-compiler"
 
   # Testing
   spec.add_development_dependency 'climate_control'
@@ -42,4 +45,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'selenium-webdriver'
   spec.add_development_dependency 'webdrivers', '~> 4.0'
+  spec.add_development_dependency 'timecop'
+  spec.add_development_dependency 'hashie'
 end

data/ext/appmap/appmap.c

@@ -0,0 +1,95 @@
+#include <ruby.h>
+#include <ruby/intern.h>
+
+// Seems like CLASS_OR_MODULE_P should really be in a header file in
+// the ruby source -- it's in object.c and duplicated in eval.c.  In
+// the future, we'll fail if it does get moved to a header.
+#define CLASS_OR_MODULE_P(obj) \
+    (!SPECIAL_CONST_P(obj) && \
+     (BUILTIN_TYPE(obj) == T_CLASS || BUILTIN_TYPE(obj) == T_MODULE))
+
+#define ARITIES_KEY "__arities__"
+
+VALUE am_AppMapHook;
+
+static VALUE
+singleton_method_owner_name(VALUE klass, VALUE method)
+{
+  VALUE owner = rb_funcall(method, rb_intern("owner"), 0);
+  VALUE attached = rb_ivar_get(owner, rb_intern("__attached__"));
+  if (!CLASS_OR_MODULE_P(attached)) {
+    attached = rb_funcall(attached, rb_intern("class"), 0);
+  }
+
+  // Did __attached__.class return an object that's a Module or a
+  // Class?
+  if (CLASS_OR_MODULE_P(attached)) {
+    // Yup, get it's name
+    return rb_mod_name(attached);
+  }
+
+  // Nope (which seems weird, but whatever). Fall back to calling
+  // #to_s on the method's owner and hope for the best.
+  return rb_funcall(owner, rb_intern("to_s"), 0);
+}
+
+
+static VALUE
+am_define_method_with_arity(VALUE mod, VALUE name, VALUE arity, VALUE proc)
+{
+  VALUE arities_key = rb_intern(ARITIES_KEY);
+  VALUE arities = rb_ivar_get(mod, arities_key);
+  
+  if (arities == Qundef || NIL_P(arities)) {
+    arities = rb_hash_new();
+    rb_ivar_set(mod, arities_key, arities);
+  }
+  rb_hash_aset(arities, name, arity);
+
+  return rb_funcall(mod, rb_intern("define_method"), 2, name, proc);
+}
+
+static VALUE
+am_get_method_arity(VALUE method, VALUE orig_arity_method)
+{
+  VALUE owner = rb_funcall(method, rb_intern("owner"), 0);
+  VALUE arities = rb_ivar_get(owner, rb_intern(ARITIES_KEY));
+  VALUE name = rb_funcall(method, rb_intern("name"), 0);
+  VALUE arity = Qnil;
+  // See if we saved an arity for the method.
+  if (!NIL_P(arities)) {
+    arity = rb_hash_aref(arities, name);
+  }
+  // Didn't find one, call the original method.
+  if (NIL_P(arity)) {
+    VALUE bound_method = rb_funcall(orig_arity_method, rb_intern("bind"), 1, method);    
+    arity = rb_funcall(bound_method, rb_intern("call"), 0);
+  }
+
+  return arity;
+}
+
+static VALUE
+am_unbound_method_arity(VALUE method)
+{
+  VALUE orig_unbound_method_arity = rb_ivar_get(am_AppMapHook, rb_intern("@unbound_method_arity"));
+  return am_get_method_arity(method, orig_unbound_method_arity);
+}
+
+static VALUE
+am_method_arity(VALUE method)
+{
+  VALUE orig_method_arity = rb_ivar_get(am_AppMapHook, rb_intern("@method_arity"));
+  return am_get_method_arity(method, orig_method_arity);
+}
+
+void Init_appmap() {
+  VALUE appmap = rb_define_module("AppMap");
+  am_AppMapHook = rb_define_class_under(appmap, "Hook", rb_cObject);
+
+  rb_define_singleton_method(am_AppMapHook, "singleton_method_owner_name", singleton_method_owner_name, 1);
+
+  rb_define_method(rb_cModule, "define_method_with_arity", am_define_method_with_arity, 3);
+  rb_define_method(rb_cUnboundMethod, "arity", am_unbound_method_arity, 0);
+  rb_define_method(rb_cMethod, "arity", am_method_arity, 0);
+}

data/ext/appmap/extconf.rb

@@ -0,0 +1,6 @@
+require "mkmf"
+
+$CFLAGS='-Werror'
+extension_name = "appmap"
+dir_config(extension_name)
+create_makefile(File.join(extension_name, extension_name))

data/lib/appmap.rb

@@ -16,6 +16,9 @@ require 'appmap/metadata'
 require 'appmap/util'
 require 'appmap/open'
 
+# load extension
+require 'appmap/appmap'
+
 module AppMap
   class << self
     @configuration = nil

data/lib/appmap/class_map.rb

@@ -61,7 +61,7 @@ module AppMap
             location: location,
             static: static,
             labels: labels
-          }.delete_if {|k,v| v.nil?}
+          }.delete_if { |k,v| v.nil? || v == [] }
         end
       end
     end
@@ -100,11 +100,16 @@ module AppMap
           static: static
         }
         location = method.source_location
-        if location
-          location_file, lineno = location
-          location_file = location_file[Dir.pwd.length + 1..-1] if location_file.index(Dir.pwd) == 0
-          function_info[:location] = [ location_file, lineno ].join(':')
-        end
+
+        function_info[:location] = \
+          if location
+            location_file, lineno = location
+            location_file = location_file[Dir.pwd.length + 1..-1] if location_file.index(Dir.pwd) == 0
+            [ location_file, lineno ].join(':')
+          else
+            [ method.defined_class, static ? '.' : '#', method.name ].join
+          end
+
         function_info[:labels] = package.labels if package.labels
         object_infos << function_info
 

data/lib/appmap/config.rb

@@ -1,31 +1,54 @@
 # frozen_string_literal: true
 
 module AppMap
-  Package = Struct.new(:path, :package_name, :exclude, :labels) do
-    def initialize(path, package_name, exclude, labels = nil)
-      super
+  class Config
+    Package = Struct.new(:path, :package_name, :exclude, :labels) do
+      def initialize(path, package_name: nil, exclude: [], labels: [])
+        super path, package_name, exclude, labels
+      end
+  
+      def to_h
+        {
+          path: path,
+          package_name: package_name,
+          exclude: exclude.blank? ? nil : exclude,
+          labels: labels.blank? ? nil : labels
+        }.compact
+      end
     end
 
-    def to_h
-      {
-        path: path,
-        package_name: package_name,
-        exclude: exclude.blank? ? nil : exclude,
-        labels: labels.blank? ? nil : labels
-      }.compact
+    Hook = Struct.new(:method_names, :package) do
     end
-  end
 
-  class Config
+    OPENSSL_PACKAGE = Package.new('openssl', package_name: 'openssl', labels: %w[security crypto])
+
     # Methods that should always be hooked, with their containing
     # package and labels that should be applied to them.
     HOOKED_METHODS = {
-      'ActiveSupport::SecurityUtils' => {
-        secure_compare: Package.new('active_support', nil, nil, ['security'])
-      }
-    }
+      'ActiveSupport::SecurityUtils' => Hook.new(:secure_compare, Package.new('active_support', package_name: 'active_support', labels: %w[security crypto]))
+    }.freeze
+
+    BUILTIN_METHODS = {
+      'OpenSSL::PKey::PKey' => Hook.new(:sign, OPENSSL_PACKAGE),
+      'Digest::Instance' => Hook.new(:digest, OPENSSL_PACKAGE),
+      'OpenSSL::X509::Request' => Hook.new(%i[sign verify], OPENSSL_PACKAGE),
+      'OpenSSL::PKCS5' => Hook.new(%i[pbkdf2_hmac_sha1 pbkdf2_hmac], OPENSSL_PACKAGE),
+      'OpenSSL::Cipher' => Hook.new(%i[encrypt decrypt final], OPENSSL_PACKAGE),
+      'OpenSSL::X509::Certificate' => Hook.new(:sign, OPENSSL_PACKAGE),
+      'Logger' => Hook.new(:add, Package.new('logger', labels: %w[log io])),
+      'Net::HTTP' => Hook.new(:request, Package.new('net/http', package_name: 'net/http', labels: %w[http io])),
+      'Net::SMTP' => Hook.new(:send, Package.new('net/smtp', package_name: 'net/smtp', labels: %w[smtp email io])),
+      'Net::POP3' => Hook.new(:mails, Package.new('net/pop3', package_name: 'net/pop', labels: %w[pop pop3 email io])),
+      'Net::IMAP' => Hook.new(:send_command, Package.new('net/imap', package_name: 'net/imap', labels: %w[imap email io])),
+      'IO' => Hook.new(%i[read write open close], Package.new('io', labels: %w[io])),
+      'Marshal' => Hook.new(%i[dump load], Package.new('marshal', labels: %w[serialization marshal])),
+      'Psych' => Hook.new(%i[dump dump_stream load load_stream parse parse_stream], Package.new('yaml', package_name: 'psych', labels: %w[serialization yaml])),
+      'JSON::Ext::Parser' => Hook.new(:parse, Package.new('json', package_name: 'json', labels: %w[serialization json])),
+      'JSON::Ext::Generator::State' => Hook.new(:generate, Package.new('json', package_name: 'json', labels: %w[serialization json]))
+    }.freeze
 
     attr_reader :name, :packages
+
     def initialize(name, packages = [])
       @name = name
       @packages = packages
@@ -41,7 +64,7 @@ module AppMap
       # Loads configuration from a Hash.
       def load(config_data)
         packages = (config_data['packages'] || []).map do |package|
-          Package.new(package['path'], nil, package['exclude'] || [])
+          Package.new(package['path'], exclude: package['exclude'] || [])
         end
         Config.new config_data['name'], packages
       end
@@ -55,9 +78,9 @@ module AppMap
     end
 
     def package_for_method(method)
-      defined_class, _, method_name = Hook.qualify_method_name(method)
-      hooked_method = find_hooked_method(defined_class, method_name)
-      return hooked_method if hooked_method
+      defined_class, _, method_name = ::AppMap::Hook.qualify_method_name(method)
+      package = find_package(defined_class, method_name)
+      return package if package
 
       location = method.source_location
       location_file, = location
@@ -75,15 +98,18 @@ module AppMap
     end
 
     def always_hook?(defined_class, method_name)
-      !!find_hooked_method(defined_class, method_name)
+      !!find_package(defined_class, method_name)
     end
 
-    def find_hooked_method(defined_class, method_name)
-      find_hooked_class(defined_class)[method_name]
+    def find_package(defined_class, method_name)
+      hook = find_hook(defined_class)
+      return nil unless hook
+
+      Array(hook.method_names).include?(method_name) ? hook.package : nil      
     end
 
-    def find_hooked_class(defined_class)
-      HOOKED_METHODS[defined_class] || {}
+    def find_hook(defined_class)
+      HOOKED_METHODS[defined_class] || BUILTIN_METHODS[defined_class]
     end
   end
 end

data/lib/appmap/cucumber.rb

@@ -4,6 +4,8 @@ require 'appmap/util'
 
 module AppMap
   module Cucumber
+    APPMAP_OUTPUT_DIR = 'tmp/appmap/cucumber'
+    
     ScenarioAttributes = Struct.new(:name, :feature, :feature_group)
 
     ProviderStruct = Struct.new(:scenario) do
@@ -38,18 +40,27 @@ module AppMap
     end
 
     class << self
+      def init
+        warn 'Configuring AppMap recorder for Cucumber'
+
+        FileUtils.mkdir_p APPMAP_OUTPUT_DIR
+      end
+      
       def write_scenario(scenario, appmap)
         appmap['metadata'] = update_metadata(scenario, appmap['metadata'])
         scenario_filename = AppMap::Util.scenario_filename(appmap['metadata']['name'])
 
-        FileUtils.mkdir_p 'tmp/appmap/cucumber'
-        File.write(File.join('tmp/appmap/cucumber', scenario_filename), JSON.generate(appmap))
+        File.write(File.join(APPMAP_OUTPUT_DIR, scenario_filename), JSON.generate(appmap))
       end
 
       def enabled?
         ENV['APPMAP'] == 'true'
       end
 
+      def run
+        init
+      end
+      
       protected
 
       def cucumber_version
@@ -87,3 +98,9 @@ module AppMap
     end
   end
 end
+
+if AppMap::Cucumber.enabled?
+  require 'appmap'
+
+  AppMap::Cucumber.run
+end