appmap 0.28.1 → 0.31.0

data/lib/appmap/metadata.rb

@@ -17,7 +17,7 @@ module AppMap
             version: AppMap::VERSION
           }
         }.tap do |m|
-          if defined?(::Rails)
+          if defined?(::Rails) && defined?(::Rails.version)
             m[:frameworks] ||= []
             m[:frameworks] << {
               name: 'rails',

data/lib/appmap/minitest.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+require 'appmap/util'
+
+module AppMap
+  # Integration of AppMap with Minitest. When enabled with APPMAP=true, the AppMap tracer will
+  # be activated around each test.
+  module Minitest
+    APPMAP_OUTPUT_DIR = 'tmp/appmap/minitest'
+    LOG = false
+
+    def self.metadata
+      AppMap.detect_metadata
+    end
+
+    Recording = Struct.new(:test) do
+      def initialize(test)
+        super
+
+        warn "Starting recording of test #{test.class}.#{test.name}" if AppMap::Minitest::LOG
+        @trace = AppMap.tracing.trace
+      end
+
+      def finish
+        warn "Finishing recording of test #{test.class}.#{test.name}" if AppMap::Minitest::LOG
+
+        events = []
+        AppMap.tracing.delete @trace
+
+        events << @trace.next_event.to_h while @trace.event?
+
+        AppMap::Minitest.add_event_methods @trace.event_methods
+
+        class_map = AppMap.class_map(@trace.event_methods)
+
+        feature_group = test.class.name.underscore.split('_')[0...-1].join('_').capitalize
+        feature_name = test.name.split('_')[1..-1].join(' ')
+        scenario_name = [ feature_group, feature_name ].join(' ')
+
+        AppMap::Minitest.save scenario_name,
+                              class_map,
+                              events: events,
+                              feature_name: feature_name,
+                              feature_group_name: feature_group
+      end
+    end
+
+    @recordings_by_test = {}
+    @event_methods = Set.new
+
+    class << self
+      def init
+        warn 'Configuring AppMap recorder for Minitest'
+
+        FileUtils.mkdir_p APPMAP_OUTPUT_DIR
+      end
+
+      def begin_test(test)
+        @recordings_by_test[test.object_id] = Recording.new(test)
+      end
+
+      def end_test(test)
+        recording = @recordings_by_test.delete(test.object_id)
+        return warn "No recording found for #{test}" unless recording
+
+        recording.finish
+      end
+
+      def config
+        @config or raise "AppMap is not configured"
+      end
+
+      def add_event_methods(event_methods)
+        @event_methods += event_methods
+      end
+
+      def save(example_name, class_map, events: nil, feature_name: nil, feature_group_name: nil, labels: nil)
+        metadata = AppMap::Minitest.metadata.tap do |m|
+          m[:name] = example_name
+          m[:app] = AppMap.configuration.name
+          m[:feature] = feature_name if feature_name
+          m[:feature_group] = feature_group_name if feature_group_name
+          m[:frameworks] ||= []
+          m[:frameworks] << {
+            name: 'minitest',
+            version: Gem.loaded_specs['minitest']&.version&.to_s
+          }
+          m[:recorder] = {
+            name: 'minitest'
+          }
+        end
+
+        appmap = {
+          version: AppMap::APPMAP_FORMAT_VERSION,
+          metadata: metadata,
+          classMap: class_map,
+          events: events
+        }.compact
+        fname = AppMap::Util.scenario_filename(example_name)
+
+        File.write(File.join(APPMAP_OUTPUT_DIR, fname), JSON.generate(appmap))
+      end
+
+      def print_inventory
+        class_map = AppMap.class_map(@event_methods)
+        save 'Inventory', class_map, labels: %w[inventory]
+      end
+
+      def enabled?
+        ENV['APPMAP'] == 'true'
+      end
+
+      def run
+        init
+        at_exit do
+          print_inventory
+        end
+      end
+    end
+  end
+end
+
+if AppMap::Minitest.enabled?
+  require 'appmap'
+  require 'minitest/test'
+
+  class ::Minitest::Test
+    alias run_without_hook run
+
+    def run
+      AppMap::Minitest.begin_test self
+      begin
+        run_without_hook
+      ensure
+        AppMap::Minitest.end_test self
+      end
+    end
+  end
+
+  AppMap::Minitest.run
+end

data/lib/appmap/record.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'appmap'
+require 'json'
+
+tracer = AppMap.tracing.trace
+
+at_exit do
+  AppMap.tracing.delete(tracer)
+
+  events = [].tap do |event_list|
+    event_list << tracer.next_event.to_h while tracer.event?
+  end
+
+  metadata = AppMap.detect_metadata
+  metadata[:recorder] = {
+    name: 'record_process'
+  }
+
+  appmap = {
+    'version' => AppMap::APPMAP_FORMAT_VERSION,
+    'metadata' => metadata,
+    'classMap' => AppMap.class_map(tracer.event_methods),
+    'events' => events
+  }
+  File.write 'appmap.json', JSON.generate(appmap)
+end

data/lib/appmap/rspec.rb

@@ -218,7 +218,7 @@ module AppMap
       end
 
       def save(example_name, class_map, events: nil, feature_name: nil, feature_group_name: nil, labels: nil)
-        metadata = RSpec.metadata.tap do |m|
+        metadata = AppMap::RSpec.metadata.tap do |m|
           m[:name] = example_name
           m[:app] = AppMap.configuration.name
           m[:feature] = feature_name if feature_name

data/lib/appmap/trace.rb

@@ -2,7 +2,15 @@
 
 module AppMap
   module Trace
-    ScopedMethod = Struct.new(:defined_class, :method, :static)
+    class ScopedMethod < SimpleDelegator
+      attr_reader :defined_class, :static
+      
+      def initialize(defined_class, method, static)
+        @defined_class = defined_class
+        @static = static
+        super(method)
+      end
+    end
 
     class Tracing
       def initialize

data/lib/appmap/version.rb

@@ -3,7 +3,7 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.28.1'
+  VERSION = '0.31.0'
 
   APPMAP_FORMAT_VERSION = '1.2'
 end

data/spec/config_spec.rb

@@ -2,9 +2,9 @@
 
 require 'rails_spec_helper'
 require 'active_support/core_ext'
-require 'appmap/hook'
+require 'appmap/config'
 
-describe AppMap::Hook::Config do
+describe AppMap::Config, docker: false do
   it 'loads from a Hash' do
     config_data = {
       name: 'test',
@@ -18,7 +18,7 @@ describe AppMap::Hook::Config do
         }
       ]
     }.deep_stringify_keys!
-    config = AppMap::Hook::Config.load(config_data)
+    config = AppMap::Config.load(config_data)
 
     expect(config.to_h.deep_stringify_keys!).to eq(config_data)
   end

data/spec/fixtures/hook/compare.rb

@@ -0,0 +1,7 @@
+require 'active_support/security_utils'
+
+class Compare
+  def self.compare(s1, s2)
+    ActiveSupport::SecurityUtils.secure_compare(s1, s2)
+  end
+end

data/spec/fixtures/hook/openssl_sign.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+# From the manual page https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL.html
+
+require 'openssl'
+
+module OpenSSLExample
+  def OpenSSLExample.example
+    ca_key = OpenSSL::PKey::RSA.new 2048
+    pass_phrase = 'my secure pass phrase goes here'
+
+    cipher = OpenSSL::Cipher.new 'AES-256-CBC'
+
+    open 'tmp/ca_key.pem', 'w', 0644 do |io|
+      io.write ca_key.export(cipher, pass_phrase)
+    end
+
+    ca_name = OpenSSL::X509::Name.parse '/CN=ca/DC=example'
+
+    ca_cert = OpenSSL::X509::Certificate.new
+    ca_cert.serial = 0
+    ca_cert.version = 2
+    ca_cert.not_before = Time.now
+    ca_cert.not_after = Time.now + 86400
+
+    ca_cert.public_key = ca_key.public_key
+    ca_cert.subject = ca_name
+    ca_cert.issuer = ca_name
+
+    extension_factory = OpenSSL::X509::ExtensionFactory.new
+    extension_factory.subject_certificate = ca_cert
+    extension_factory.issuer_certificate = ca_cert
+
+    ca_cert.add_extension    extension_factory.create_extension('subjectKeyIdentifier', 'hash')
+    ca_cert.add_extension    extension_factory.create_extension('basicConstraints', 'CA:TRUE', true)
+
+    ca_cert.add_extension    extension_factory.create_extension(
+      'keyUsage', 'cRLSign,keyCertSign', true)
+
+    ca_cert.sign ca_key, OpenSSL::Digest::SHA1.new
+
+    open 'tmp/ca_cert.pem', 'w' do |io|
+      io.write ca_cert.to_pem
+    end
+
+    csr = OpenSSL::X509::Request.new
+    csr.version = 0
+    csr.subject = OpenSSL::X509::Name.new([ ['CN', 'the name to sign', OpenSSL::ASN1::UTF8STRING] ])
+    csr.public_key = ca_key.public_key
+    csr.sign ca_key, OpenSSL::Digest::SHA1.new
+
+    open 'tmp/csr.pem', 'w' do |io|
+      io.write csr.to_pem
+    end
+
+    csr = OpenSSL::X509::Request.new File.read 'tmp/csr.pem'
+
+    raise 'CSR can not be verified' unless csr.verify csr.public_key
+
+    csr_cert = OpenSSL::X509::Certificate.new
+    csr_cert.serial = 0
+    csr_cert.version = 2
+    csr_cert.not_before = Time.now
+    csr_cert.not_after = Time.now + 600
+
+    csr_cert.subject = csr.subject
+    csr_cert.public_key = csr.public_key
+    csr_cert.issuer = ca_cert.subject
+
+    extension_factory = OpenSSL::X509::ExtensionFactory.new
+    extension_factory.subject_certificate = csr_cert
+    extension_factory.issuer_certificate = ca_cert
+
+    csr_cert.add_extension    extension_factory.create_extension('basicConstraints', 'CA:FALSE')
+
+    csr_cert.add_extension    extension_factory.create_extension(
+        'keyUsage', 'keyEncipherment,dataEncipherment,digitalSignature')
+
+    csr_cert.add_extension    extension_factory.create_extension('subjectKeyIdentifier', 'hash')
+
+    csr_cert.sign ca_key, OpenSSL::Digest::SHA1.new
+
+    open 'tmp/csr_cert.pem', 'w' do |io|
+      io.write csr_cert.to_pem
+    end
+  end
+end

data/spec/hook_spec.rb

@@ -15,7 +15,7 @@ module ShowYamlNulls
 end
 Psych::Visitors::YAMLTree.prepend(ShowYamlNulls)
 
-describe 'AppMap class Hooking' do
+describe 'AppMap class Hooking', docker: false do
   def collect_events(tracer)
     [].tap do |events|
       while tracer.event?
@@ -30,7 +30,10 @@ describe 'AppMap class Hooking' do
       (event[:parameters] || []).each(&delete_object_id)
       (event[:exceptions] || []).each(&delete_object_id)
 
-      if event[:event] == :return
+      case event[:event]
+      when :call
+        event[:path] = event[:path].gsub(Gem.dir + '/', '')
+      when :return
         # These should be removed from the appmap spec
         %i[defined_class method_id path lineno static].each do |obsolete_field|
           event.delete(obsolete_field)
@@ -42,21 +45,23 @@ describe 'AppMap class Hooking' do
 
   def invoke_test_file(file, setup: nil, &block)
     AppMap.configuration = nil
-    package = AppMap::Hook::Package.new(file, [])
-    config = AppMap::Hook::Config.new('hook_spec', [ package ])
+    package = AppMap::Package.new(file, [])
+    config = AppMap::Config.new('hook_spec', [ package ])
     AppMap.configuration = config
-    AppMap::Hook.hook(config)
-    
-    setup_result = setup.call if setup
-
-    tracer = AppMap.tracing.trace
-    AppMap::Event.reset_id_counter
-    begin
-      load file
-      yield setup_result
-    ensure
-      AppMap.tracing.delete(tracer)
+    tracer = nil
+    AppMap::Hook.new(config).enable do
+      setup_result = setup.call if setup
+
+      tracer = AppMap.tracing.trace
+      AppMap::Event.reset_id_counter
+      begin
+        load file
+        yield setup_result
+      ensure
+        AppMap.tracing.delete(tracer)
+      end
     end
+
     [ config, tracer ]
   end
 
@@ -104,7 +109,7 @@ describe 'AppMap class Hooking' do
       InstanceMethod.new.say_default
     end
     expect(tracer.event_methods.to_a.map(&:defined_class)).to eq([ 'InstanceMethod' ])
-    expect(tracer.event_methods.to_a.map(&:method).map(&:to_s)).to eq([ InstanceMethod.public_instance_method(:say_default).to_s ])
+    expect(tracer.event_methods.to_a.map(&:to_s)).to eq([ InstanceMethod.public_instance_method(:say_default).to_s ])
   end
 
   it 'builds a class map of invoked methods' do
@@ -403,14 +408,14 @@ describe 'AppMap class Hooking' do
     events_yaml = <<~YAML
     --- []
     YAML
-    
+
     load 'spec/fixtures/hook/singleton_method.rb'
     setup = -> { SingletonMethod.new_with_instance_method }
     test_hook_behavior 'spec/fixtures/hook/singleton_method.rb', events_yaml, setup: setup do |s|
       expect(s.say_instance_defined).to eq('defined for an instance')
     end
   end
-  
+
   it 'Reports exceptions' do
     events_yaml = <<~YAML
     ---
@@ -450,4 +455,122 @@ describe 'AppMap class Hooking' do
       expect { ExceptionMethod.new.raise_exception }.to raise_exception
     end
   end
+
+  context 'OpenSSL::X509::Certificate.sign' do
+    # OpenSSL::X509 is not being hooked.
+    # This might be because the class is being loaded before AppMap, and so the TracePoint
+    # set by AppMap doesn't see it.
+    xit 'is hooked' do
+      events_yaml = <<~YAML
+      ---
+      YAML
+      test_hook_behavior 'spec/fixtures/hook/openssl_sign.rb', events_yaml do
+        expect(OpenSSLExample.example).to be_truthy
+      end
+    end
+  end
+
+  context 'ActiveSupport::SecurityUtils.secure_compare' do
+    it 'is hooked' do
+      events_yaml = <<~YAML
+      ---
+      - :id: 1
+        :event: :call
+        :defined_class: Compare
+        :method_id: compare
+        :path: spec/fixtures/hook/compare.rb
+        :lineno: 4
+        :static: true
+        :parameters:
+        - :name: :s1
+          :class: String
+          :value: string
+          :kind: :req
+        - :name: :s2
+          :class: String
+          :value: string
+          :kind: :req
+        :receiver:
+          :class: Class
+          :value: Compare
+      - :id: 2
+        :event: :call
+        :defined_class: ActiveSupport::SecurityUtils
+        :method_id: secure_compare
+        :path: gems/activesupport-6.0.3.2/lib/active_support/security_utils.rb
+        :lineno: 26
+        :static: true
+        :parameters:
+        - :name: :a
+          :class: String
+          :value: string
+          :kind: :req
+        - :name: :b
+          :class: String
+          :value: string
+          :kind: :req
+        :receiver:
+          :class: Module
+          :value: ActiveSupport::SecurityUtils
+      - :id: 3
+        :event: :return
+        :parent_id: 2
+        :return_value:
+          :class: TrueClass
+          :value: 'true'
+      - :id: 4
+        :event: :return
+        :parent_id: 1
+        :return_value:
+          :class: TrueClass
+          :value: 'true'
+      YAML
+
+      test_hook_behavior 'spec/fixtures/hook/compare.rb', events_yaml do
+        expect(Compare.compare('string', 'string')).to be_truthy
+      end
+    end
+
+    it 'gets labeled in the classmap' do
+      classmap_yaml = <<~YAML
+      ---
+      - :name: spec/fixtures/hook/compare.rb
+        :type: package
+        :children:
+        - :name: Compare
+          :type: class
+          :children:
+          - :name: compare
+            :type: function
+            :location: spec/fixtures/hook/compare.rb:4
+            :static: true
+      - :name: active_support
+        :type: package
+        :children:
+        - :name: ActiveSupport
+          :type: class
+          :children:
+          - :name: SecurityUtils
+            :type: class
+            :children:
+            - :name: secure_compare
+              :type: function
+              :location: gems/activesupport-6.0.3.2/lib/active_support/security_utils.rb:26
+              :static: true
+              :labels:
+              - security
+      YAML
+      
+      config, tracer = invoke_test_file 'spec/fixtures/hook/compare.rb' do
+        expect(Compare.compare('string', 'string')).to be_truthy
+      end
+      cm = AppMap::ClassMap.build_from_methods(config, tracer.event_methods)
+      entry = cm[1][:children][0][:children][0][:children][0]
+      # Sanity check, make sure we got the right one
+      expect(entry[:name]).to eq('secure_compare')
+      spec = Gem::Specification.find_by_name('activesupport')
+      entry[:location].gsub!(spec.base_dir + '/', '')
+      expect(Diffy::Diff.new(cm.to_yaml, classmap_yaml).to_s).to eq('')
+    end
+  end
 end