appmap 0.26.0 → 0.31.0

data/lib/appmap/util.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module AppMap
+  module Util
+    class << self
+      # scenario_filename builds a suitable file name from a scenario name.
+      # Special characters are removed, and the file name is truncated to fit within
+      # shell limitations.
+      def scenario_filename(name, max_length: 255, separator: '_', extension: '.appmap.json')
+        # Cribbed from v5 version of ActiveSupport:Inflector#parameterize:
+        # https://github.com/rails/rails/blob/v5.2.4/activesupport/lib/active_support/inflector/transliterate.rb#L92
+        # Replace accented chars with their ASCII equivalents.
+
+        fname = name.encode('utf-8', invalid: :replace, undef: :replace, replace: '_')
+
+        # Turn unwanted chars into the separator.
+        fname.gsub!(/[^a-z0-9\-_]+/i, separator)
+
+        re_sep = Regexp.escape(separator)
+        re_duplicate_separator        = /#{re_sep}{2,}/
+        re_leading_trailing_separator = /^#{re_sep}|#{re_sep}$/i
+
+        # No more than one of the separator in a row.
+        fname.gsub!(re_duplicate_separator, separator)
+
+        # Finally, Remove leading/trailing separator.
+        fname.gsub!(re_leading_trailing_separator, '')
+
+        if (fname.length + extension.length) > max_length
+          require 'base64'
+          require 'digest'
+          fname_digest = Base64.urlsafe_encode64 Digest::MD5.digest(fname), padding: false
+          fname[max_length - fname_digest.length - extension.length - 1..-1] = [ '-', fname_digest ].join
+        end
+
+        [ fname, extension ].join
+      end
+    end
+  end
+end

data/lib/appmap/version.rb

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

data/package-lock.json

@@ -551,9 +551,9 @@
       }
     },
     "lodash": {
-      "version": "4.17.15",
-      "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.15.tgz",
-      "integrity": "sha512-8xOcRHvCjnocdS5cpwXQXVzmmh5e5+saE2QGoeQmbKmRS6J3VQppPOIt0MnmE+4xlZoumy0GPG0D0MVIQbNA1A=="
+      "version": "4.17.19",
+      "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.19.tgz",
+      "integrity": "sha512-JNvd8XER9GQX0v2qJgsaN/mzFCNA5BRe/j8JN9d+tWyGLSodKQHKFicdwNYzWwI3wjRnaKPsGj1XkBjx/F96DQ=="
     },
     "longest": {
       "version": "1.0.1",

data/spec/abstract_controller4_base_spec.rb

@@ -52,8 +52,8 @@ describe 'AbstractControllerBase' do
   method_id: build_user
   path: app/controllers/api/users_controller.rb
   lineno: 23
-  static: false
   thread_id: .*
+  static: false
   parameters:
   - name: params
     class: Hash

data/spec/abstract_controller_base_spec.rb

@@ -57,8 +57,8 @@ describe 'AbstractControllerBase' do
   method_id: build_user
   path: app/controllers/api/users_controller.rb
   lineno: 23
-  static: false
   thread_id: .*
+  static: false
   parameters:
   - name: params
     class: ActiveSupport::HashWithIndifferentAccess

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/fixtures/hook/singleton_method.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+class SingletonMethod
+  class << self
+    def say_default
+      'default'
+    end
+  end
+
+  def SingletonMethod.say_class_defined
+    'defined with explicit class scope'
+  end
+
+  def self.say_self_defined
+    'defined with self class scope'
+  end
+
+  # When called, do_include calls +include+ to bring in the module
+  # AddMethod. AddMethod defines a new instance method, which gets
+  # added to the singleton class of SingletonMethod.
+  def do_include
+    class << self
+      SingletonMethod.include(AddMethod)
+    end
+    self
+  end
+  
+  def self.new_with_instance_method
+    SingletonMethod.new.tap do |m|
+      def m.say_instance_defined
+        'defined for an instance'
+      end
+    end
+  end
+  
+  def to_s
+    'Singleton Method fixture'
+  end
+end
+
+module AddMethod
+  def self.included(base)
+    base.module_eval do
+      define_method "added_method" do
+        _added_method
+      end
+    end
+  end
+  
+  def _added_method
+    'defined by including a module'
+  end
+end
+

data/spec/fixtures/rails_users_app/Gemfile

@@ -39,6 +39,7 @@ appmap_options = \
 gem 'appmap', appmap_options
 
 group :development, :test do
+  gem 'cucumber-rails', require: false
   gem 'rspec-rails'
   # Required for Sequel, since without ActiveRecord, the Rails transactional fixture support
   # isn't activated.

data/spec/fixtures/rails_users_app/features/api_users.feature

@@ -0,0 +1,13 @@
+Feature: /api/users
+
+  @appmap-disable
+  Scenario: A user can be created
+    When I create a user
+    Then the response status should be 201
+
+  Scenario: When a user is created, it should be in the user list
+    Given I create a user
+    And the response status should be 201
+    When I list the users
+    Then the response status should be 200
+    And the response should include the user

data/spec/fixtures/rails_users_app/features/support/env.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'cucumber/rails'
+require 'appmap/cucumber'

data/spec/fixtures/rails_users_app/features/support/hooks.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+if AppMap::Cucumber.enabled?
+  Around('not @appmap-disable') do |scenario, block|
+    appmap = AppMap.record do
+      block.call
+    end
+
+    AppMap::Cucumber.write_scenario(scenario, appmap)
+  end
+end

data/spec/fixtures/rails_users_app/features/support/steps.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+When 'I create a user' do
+  @response = post '/api/users', login: 'alice'
+end
+
+Then(/the response status should be (\d+)/) do |status|
+  expect(@response.status).to eq(status.to_i)
+end
+
+When 'I list the users' do
+  @response = get '/api/users'
+  @users = JSON.parse(@response.body)
+end
+
+Then 'the response should include the user' do
+  expect(@users.map { |u| u['login'] }).to include('alice')
+end

data/spec/hook_spec.rb

@@ -5,7 +5,17 @@ require 'appmap/hook'
 require 'appmap/event'
 require 'diffy'
 
-describe 'AppMap class Hooking' do
+# Show nulls as the literal +null+, rather than just leaving the field
+# empty. This make some of the expected YAML below easier to
+# understand.
+module ShowYamlNulls
+  def visit_NilClass(o)
+    @emitter.scalar('null', nil, 'tag:yaml.org,2002:null', true, false, Psych::Nodes::Scalar::ANY)
+  end
+end
+Psych::Visitors::YAMLTree.prepend(ShowYamlNulls)
+
+describe 'AppMap class Hooking', docker: false do
   def collect_events(tracer)
     [].tap do |events|
       while tracer.event?
@@ -20,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)
@@ -30,24 +43,30 @@ describe 'AppMap class Hooking' do
     end.to_yaml
   end
 
-  def invoke_test_file(file, &block)
-    package = AppMap::Hook::Package.new(file, [])
-    config = AppMap::Hook::Config.new('hook_spec', [ package ])
-    AppMap::Hook.hook(config)
-
-    tracer = AppMap.tracing.trace
-    AppMap::Event.reset_id_counter
-    begin
-      load file
-      yield
-    ensure
-      AppMap.tracing.delete(tracer)
+  def invoke_test_file(file, setup: nil, &block)
+    AppMap.configuration = nil
+    package = AppMap::Package.new(file, [])
+    config = AppMap::Config.new('hook_spec', [ package ])
+    AppMap.configuration = config
+    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
 
-  def test_hook_behavior(file, events_yaml, &block)
-    config, tracer = invoke_test_file(file, &block)
+  def test_hook_behavior(file, events_yaml, setup: nil, &block)
+    config, tracer = invoke_test_file(file, setup: setup, &block)
 
     events = collect_events(tracer)
     expect(Diffy::Diff.new(events, events_yaml).to_s).to eq('')
@@ -55,6 +74,10 @@ describe 'AppMap class Hooking' do
     [ config, tracer ]
   end
 
+  after do
+    AppMap.configuration = nil
+  end
+
   it 'hooks an instance method that takes no arguments' do
     events_yaml = <<~YAML
     ---
@@ -86,14 +109,14 @@ 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
-    config, tracer = invoke_test_file 'spec/fixtures/hook/instance_method.rb' do
+    _, tracer = invoke_test_file 'spec/fixtures/hook/instance_method.rb' do
       InstanceMethod.new.say_default
     end
-    class_map = AppMap.class_map(config, tracer.event_methods).to_yaml
+    class_map = AppMap.class_map(tracer.event_methods).to_yaml
     expect(Diffy::Diff.new(class_map, <<~YAML).to_s).to eq('')
     ---
     - :name: spec/fixtures/hook/instance_method.rb
@@ -202,7 +225,7 @@ describe 'AppMap class Hooking' do
       :parameters:
       - :name: :kw
         :class: NilClass
-        :value: 
+        :value: null
         :kind: :key
       :receiver:
         :class: InstanceMethod
@@ -232,7 +255,7 @@ describe 'AppMap class Hooking' do
       :parameters:
       - :name: :block
         :class: NilClass
-        :value: 
+        :value: null
         :kind: :block
       :receiver:
         :class: InstanceMethod
@@ -254,15 +277,15 @@ describe 'AppMap class Hooking' do
     ---
     - :id: 1
       :event: :call
-      :defined_class: ClassMethod
+      :defined_class: SingletonMethod
       :method_id: say_default
-      :path: spec/fixtures/hook/class_method.rb
+      :path: spec/fixtures/hook/singleton_method.rb
       :lineno: 5
       :static: true
       :parameters: []
       :receiver:
         :class: Class
-        :value: ClassMethod
+        :value: SingletonMethod
     - :id: 2
       :event: :return
       :parent_id: 1
@@ -270,8 +293,8 @@ describe 'AppMap class Hooking' do
         :class: String
         :value: default
     YAML
-    test_hook_behavior 'spec/fixtures/hook/class_method.rb', events_yaml do
-      expect(ClassMethod.say_default).to eq('default')
+    test_hook_behavior 'spec/fixtures/hook/singleton_method.rb', events_yaml do
+      expect(SingletonMethod.say_default).to eq('default')
     end
   end
 
@@ -280,15 +303,15 @@ describe 'AppMap class Hooking' do
     ---
     - :id: 1
       :event: :call
-      :defined_class: ClassMethod
+      :defined_class: SingletonMethod
       :method_id: say_class_defined
-      :path: spec/fixtures/hook/class_method.rb
+      :path: spec/fixtures/hook/singleton_method.rb
       :lineno: 10
       :static: true
       :parameters: []
       :receiver:
         :class: Class
-        :value: ClassMethod
+        :value: SingletonMethod
     - :id: 2
       :event: :return
       :parent_id: 1
@@ -296,8 +319,8 @@ describe 'AppMap class Hooking' do
         :class: String
         :value: defined with explicit class scope
     YAML
-    test_hook_behavior 'spec/fixtures/hook/class_method.rb', events_yaml do
-      expect(ClassMethod.say_class_defined).to eq('defined with explicit class scope')
+    test_hook_behavior 'spec/fixtures/hook/singleton_method.rb', events_yaml do
+      expect(SingletonMethod.say_class_defined).to eq('defined with explicit class scope')
     end
   end
 
@@ -306,15 +329,15 @@ describe 'AppMap class Hooking' do
     ---
     - :id: 1
       :event: :call
-      :defined_class: ClassMethod
+      :defined_class: SingletonMethod
       :method_id: say_self_defined
-      :path: spec/fixtures/hook/class_method.rb
+      :path: spec/fixtures/hook/singleton_method.rb
       :lineno: 14
       :static: true
       :parameters: []
       :receiver:
         :class: Class
-        :value: ClassMethod
+        :value: SingletonMethod
     - :id: 2
       :event: :return
       :parent_id: 1
@@ -322,8 +345,74 @@ describe 'AppMap class Hooking' do
         :class: String
         :value: defined with self class scope
     YAML
-    test_hook_behavior 'spec/fixtures/hook/class_method.rb', events_yaml do
-      expect(ClassMethod.say_self_defined).to eq('defined with self class scope')
+    test_hook_behavior 'spec/fixtures/hook/singleton_method.rb', events_yaml do
+      expect(SingletonMethod.say_self_defined).to eq('defined with self class scope')
+    end
+  end
+
+
+  it 'hooks an included method' do
+    events_yaml = <<~YAML
+    ---
+    - :id: 1
+      :event: :call
+      :defined_class: SingletonMethod
+      :method_id: added_method
+      :path: spec/fixtures/hook/singleton_method.rb
+      :lineno: 44
+      :static: false
+      :parameters: []
+      :receiver:
+        :class: SingletonMethod
+        :value: Singleton Method fixture
+    - :id: 2
+      :event: :call
+      :defined_class: AddMethod
+      :method_id: _added_method
+      :path: spec/fixtures/hook/singleton_method.rb
+      :lineno: 50
+      :static: false
+      :parameters: []
+      :receiver:
+        :class: SingletonMethod
+        :value: Singleton Method fixture
+    - :id: 3
+      :event: :return
+      :parent_id: 2
+      :return_value:
+        :class: String
+        :value: defined by including a module
+    - :id: 4
+      :event: :return
+      :parent_id: 1
+      :return_value:
+        :class: String
+        :value: defined by including a module
+    YAML
+
+    load 'spec/fixtures/hook/singleton_method.rb'
+    setup = -> { SingletonMethod.new.do_include }
+    test_hook_behavior 'spec/fixtures/hook/singleton_method.rb', events_yaml, setup: setup do |s|
+      expect(s.added_method).to eq('defined by including a module')
+    end
+  end
+
+  it "doesn't hook a singleton method defined for an instance" do
+    # Ideally, Ruby would fire a TracePoint event when a singleton
+    # class gets created by defining a method on an instance. It
+    # currently doesn't, though, so there's no way for us to hook such
+    # a method.
+    #
+    # This example will fail if Ruby's behavior changes at some point
+    # in the future.
+    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
 
@@ -366,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