appmap 0.23.0 → 0.25.0

data/spec/abstract_controller_base_spec.rb

@@ -3,7 +3,7 @@ require 'rails_spec_helper'
 describe 'AbstractControllerBase' do
   before(:all) { @fixture_dir = 'spec/fixtures/rails_users_app' }
   include_context 'Rails app pg database'
-  
+
   around(:each) do |example|
     FileUtils.rm_rf tmpdir
     FileUtils.mkdir_p tmpdir
@@ -17,7 +17,11 @@ describe 'AbstractControllerBase' do
   let(:appmap_json) { File.join(tmpdir, 'appmap/rspec/Api_UsersController_POST_api_users_with_required_parameters_creates_a_user.appmap.json') }
 
   describe 'testing with rspec' do
-    it 'Message fields are recorded in the appmap' do
+    it 'inventory file is printed' do
+      expect(File).to exist(File.join(tmpdir, 'appmap/rspec/Inventory.appmap.json'))
+    end
+
+    it 'message fields are recorded in the appmap' do
       expect(File).to exist(appmap_json)
       appmap = JSON.parse(File.read(appmap_json)).to_yaml
 
@@ -50,7 +54,7 @@ describe 'AbstractControllerBase' do
       expect(appmap).to match(<<-CREATE_CALL.strip)
   event: call
   defined_class: Api::UsersController
-  method_id: create_user
+  method_id: build_user
   path: app/controllers/api/users_controller.rb
   lineno: 23
   static: false

data/spec/config_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'rails_spec_helper'
+require 'active_support/core_ext'
+require 'appmap/hook'
+
+describe AppMap::Hook::Config do
+  it 'loads from a Hash' do
+    config_data = {
+      name: 'test',
+      packages: [
+        {
+          path: 'path-1'
+        },
+        {
+          path: 'path-2',
+          exclude: [ 'exclude-1' ]
+        }
+      ]
+    }.deep_stringify_keys!
+    config = AppMap::Hook::Config.load(config_data)
+
+    expect(config.to_h.deep_stringify_keys!).to eq(config_data)
+  end
+end

data/spec/fixtures/hook/attr_accessor.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class AttrAccessor
+  attr_accessor :value
+end

data/spec/fixtures/hook/class_method.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class ClassMethod
+  class << self
+    def say_default
+      'default'
+    end
+  end
+
+  def ClassMethod.say_class_defined
+    'defined with explicit class scope'
+  end
+
+  def self.say_self_defined
+    'defined with self class scope'
+  end
+end

data/spec/fixtures/hook/constructor.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Constructor
+  def initialize(value)
+    @value = value
+  end
+end

data/spec/fixtures/hook/exception_method.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class ExceptionMethod
+  def to_s
+    'Exception Method fixture'
+  end
+
+  def raise_exception
+    raise 'Exception occurred in raise_exception'
+  end
+end

data/spec/fixtures/hook/instance_method.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class InstanceMethod
+  def to_s
+    'Instance Method fixture'
+  end
+
+  def say_default
+    'default'
+  end
+
+  def say_echo(arg)
+    arg.to_s
+  end
+
+  def say_kw(kw: 'kw')
+    kw.to_s
+  end
+
+  def say_block(&block)
+    yield
+  end
+end

data/spec/fixtures/rails4_users_app/app/controllers/api/users_controller.rb

@@ -6,7 +6,7 @@ module Api
     end
 
     def create
-      @user = create_user(params.slice(:login).to_unsafe_h)
+      @user = build_user(params.slice(:login).to_unsafe_h)
       unless @user.valid?
         error = {
           code: 'invalid',
@@ -18,9 +18,9 @@ module Api
       end
       @user.save
       render json: @user, status: :created
-    end 
+    end
 
-    def create_user(params)
+    def build_user(params)
       User.new(params)
     end
   end

data/spec/fixtures/rails4_users_app/config/database.yml

@@ -1,5 +1,6 @@
 default: &default
-  host: pg
+  host: <%= ENV['PGHOST'] || 'pg' %>
+  port: <%= ENV['PGPORT'] || 5432 %>
   user: postgres
   adapter: postgresql
   encoding: unicode

data/spec/fixtures/rails4_users_app/docker-compose.yml

@@ -6,6 +6,8 @@ services:
       dockerfile: Dockerfile.pg
     ports:
       - "5432"
+    environment:
+      POSTGRES_HOST_AUTH_METHOD: trust
 
   app:
     build:

data/spec/fixtures/rails_users_app/.ruby-version

@@ -1 +1 @@
-2.5.5
+2.6.2

data/spec/fixtures/rails_users_app/app/controllers/api/users_controller.rb

@@ -6,7 +6,7 @@ module Api
     end
 
     def create
-      @user = create_user(params.slice(:login).to_unsafe_h)
+      @user = build_user(params.slice(:login).to_unsafe_h)
       unless @user.valid?
         error = {
           code: 'invalid',
@@ -20,7 +20,7 @@ module Api
       render json: @user, status: :created
     end
 
-    def create_user(params)
+    def build_user(params)
       User.new(params)
     end
   end

data/spec/fixtures/rails_users_app/config/database.yml

@@ -1,5 +1,6 @@
 default: &default
-  host: pg
+  host: <%= ENV['PGHOST'] || 'pg' %>
+  port: <%= ENV['PGPORT'] || 5432 %>
   user: postgres
   adapter: postgresql
   encoding: unicode

data/spec/fixtures/rails_users_app/create_app

@@ -1,4 +1,5 @@
 #!/usr/bin/env bash
+set -e
 
 # Just checking for a healthy container isn't enough, apparently. If
 # we don't wait here, sometimes the database is inaccessible.

data/spec/fixtures/rails_users_app/docker-compose.yml

@@ -6,6 +6,8 @@ services:
       dockerfile: Dockerfile.pg
     ports:
       - "5432"
+    environment:
+      POSTGRES_HOST_AUTH_METHOD: trust
 
   app:
     build:
@@ -16,6 +18,8 @@ services:
       [ "./bin/rails", "server", "-b", "0.0.0.0", "webrick" ]
     environment:
       RAILS_ENV:
+      ORM_MODULE:
+      APPMAP:
     volumes:
     - .:/src/app
     ports:

data/spec/fixtures/rails_users_app/spec/models/user_spec.rb

@@ -2,7 +2,7 @@ require 'rails_helper'
 
 describe User, feature_group: 'User', appmap: true do
   # TODO: appmap/rspec doesn't handle shared_examples_for 100% correctly yet.
-  # In my tests, only one of these two tests will be emitted as an 
+  # In my tests, only one of these two tests will be emitted as an appmap.
   shared_examples_for 'creates the user' do |username|
     let(:login) { username }
     let(:user) { User.new(login: login) }

data/spec/hook_spec.rb

@@ -0,0 +1,357 @@
+# frozen_string_literal: true
+
+require 'rails_spec_helper'
+require 'appmap/hook'
+require 'appmap/event'
+require 'diffy'
+
+describe 'AppMap class Hooking' do
+  def collect_events(tracer)
+    [].tap do |events|
+      while tracer.event?
+        events << tracer.next_event.to_h
+      end
+    end.map do |event|
+      event.delete(:thread_id)
+      event.delete(:elapsed)
+      delete_object_id = ->(obj) { (obj || {}).delete(:object_id) }
+      delete_object_id.call(event[:receiver])
+      delete_object_id.call(event[:return_value])
+      (event[:parameters] || []).each(&delete_object_id)
+      (event[:exceptions] || []).each(&delete_object_id)
+
+      if event[:event] == :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)
+        end
+      end
+      event
+    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)
+    end
+    [ config, tracer ]
+  end
+
+  def test_hook_behavior(file, events_yaml, &block)
+    config, tracer = invoke_test_file(file, &block)
+
+    events = collect_events(tracer)
+    expect(Diffy::Diff.new(events, events_yaml).to_s).to eq('')
+
+    [ config, tracer ]
+  end
+
+  it 'hooks an instance method that takes no arguments' do
+    events_yaml = <<~YAML
+    ---
+    - :id: 1
+      :event: :call
+      :defined_class: InstanceMethod
+      :method_id: say_default
+      :path: spec/fixtures/hook/instance_method.rb
+      :lineno: 8
+      :static: false
+      :parameters: []
+      :receiver:
+        :class: InstanceMethod
+        :value: Instance Method fixture
+    - :id: 2
+      :event: :return
+      :parent_id: 1
+      :return_value:
+        :class: String
+        :value: default
+    YAML
+    config, tracer = test_hook_behavior 'spec/fixtures/hook/instance_method.rb', events_yaml do
+      expect(InstanceMethod.new.say_default).to eq('default')
+    end
+  end
+
+  it 'collects the methods that are invoked' do
+    _, tracer = invoke_test_file 'spec/fixtures/hook/instance_method.rb' 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 ])
+  end
+
+  it 'builds a class map of invoked methods' do
+    config, 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
+    expect(Diffy::Diff.new(class_map, <<~YAML).to_s).to eq('')
+    ---
+    - :name: spec/fixtures/hook/instance_method.rb
+      :type: package
+      :children:
+      - :name: InstanceMethod
+        :type: class
+        :children:
+        - :name: say_default
+          :type: function
+          :location: spec/fixtures/hook/instance_method.rb:8
+          :static: false
+    YAML
+  end
+
+  it 'does not hook an attr_accessor' do
+    events_yaml = <<~YAML
+    --- []
+    YAML
+    test_hook_behavior 'spec/fixtures/hook/attr_accessor.rb', events_yaml do
+      obj = AttrAccessor.new
+      obj.value = 'foo'
+      expect(obj.value).to eq('foo')
+    end
+  end
+
+  it 'does not hook a constructor' do
+    events_yaml = <<~YAML
+    --- []
+    YAML
+    test_hook_behavior 'spec/fixtures/hook/constructor.rb', events_yaml do
+      Constructor.new('foo')
+    end
+  end
+
+  it 'hooks an instance method that takes an argument' do
+    events_yaml = <<~YAML
+    ---
+    - :id: 1
+      :event: :call
+      :defined_class: InstanceMethod
+      :method_id: say_echo
+      :path: spec/fixtures/hook/instance_method.rb
+      :lineno: 12
+      :static: false
+      :parameters:
+      - :name: :arg
+        :class: String
+        :value: echo
+        :kind: :req
+      :receiver:
+        :class: InstanceMethod
+        :value: Instance Method fixture
+    - :id: 2
+      :event: :return
+      :parent_id: 1
+      :return_value:
+        :class: String
+        :value: echo
+    YAML
+    test_hook_behavior 'spec/fixtures/hook/instance_method.rb', events_yaml do
+      expect(InstanceMethod.new.say_echo('echo')).to eq('echo')
+    end
+  end
+
+  it 'hooks an instance method that takes a keyword argument' do
+    events_yaml = <<~YAML
+    ---
+    - :id: 1
+      :event: :call
+      :defined_class: InstanceMethod
+      :method_id: say_kw
+      :path: spec/fixtures/hook/instance_method.rb
+      :lineno: 16
+      :static: false
+      :parameters:
+      - :name: :kw
+        :class: Hash
+        :value: '{:kw=>"kw"}'
+        :kind: :key
+      :receiver:
+        :class: InstanceMethod
+        :value: Instance Method fixture
+    - :id: 2
+      :event: :return
+      :parent_id: 1
+      :return_value:
+        :class: String
+        :value: kw
+    YAML
+    test_hook_behavior 'spec/fixtures/hook/instance_method.rb', events_yaml do
+      expect(InstanceMethod.new.say_kw(kw: 'kw')).to eq('kw')
+    end
+  end
+
+  it 'hooks an instance method that takes a default keyword argument' do
+    events_yaml = <<~YAML
+    ---
+    - :id: 1
+      :event: :call
+      :defined_class: InstanceMethod
+      :method_id: say_kw
+      :path: spec/fixtures/hook/instance_method.rb
+      :lineno: 16
+      :static: false
+      :parameters:
+      - :name: :kw
+        :class: NilClass
+        :value: 
+        :kind: :key
+      :receiver:
+        :class: InstanceMethod
+        :value: Instance Method fixture
+    - :id: 2
+      :event: :return
+      :parent_id: 1
+      :return_value:
+        :class: String
+        :value: kw
+    YAML
+    test_hook_behavior 'spec/fixtures/hook/instance_method.rb', events_yaml do
+      expect(InstanceMethod.new.say_kw).to eq('kw')
+    end
+  end
+
+  it 'hooks an instance method that takes a block argument' do
+    events_yaml = <<~YAML
+    ---
+    - :id: 1
+      :event: :call
+      :defined_class: InstanceMethod
+      :method_id: say_block
+      :path: spec/fixtures/hook/instance_method.rb
+      :lineno: 20
+      :static: false
+      :parameters:
+      - :name: :block
+        :class: NilClass
+        :value: 
+        :kind: :block
+      :receiver:
+        :class: InstanceMethod
+        :value: Instance Method fixture
+    - :id: 2
+      :event: :return
+      :parent_id: 1
+      :return_value:
+        :class: String
+        :value: albert
+    YAML
+    test_hook_behavior 'spec/fixtures/hook/instance_method.rb', events_yaml do
+      expect(InstanceMethod.new.say_block { 'albert' }).to eq('albert')
+    end
+  end
+
+  it 'hooks a singleton method' do
+    events_yaml = <<~YAML
+    ---
+    - :id: 1
+      :event: :call
+      :defined_class: ClassMethod
+      :method_id: say_default
+      :path: spec/fixtures/hook/class_method.rb
+      :lineno: 5
+      :static: true
+      :parameters: []
+      :receiver:
+        :class: Class
+        :value: ClassMethod
+    - :id: 2
+      :event: :return
+      :parent_id: 1
+      :return_value:
+        :class: String
+        :value: default
+    YAML
+    test_hook_behavior 'spec/fixtures/hook/class_method.rb', events_yaml do
+      expect(ClassMethod.say_default).to eq('default')
+    end
+  end
+
+  it 'hooks a class method with explicit class name scope' do
+    events_yaml = <<~YAML
+    ---
+    - :id: 1
+      :event: :call
+      :defined_class: ClassMethod
+      :method_id: say_class_defined
+      :path: spec/fixtures/hook/class_method.rb
+      :lineno: 10
+      :static: true
+      :parameters: []
+      :receiver:
+        :class: Class
+        :value: ClassMethod
+    - :id: 2
+      :event: :return
+      :parent_id: 1
+      :return_value:
+        :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')
+    end
+  end
+
+  it "hooks a class method with 'self' as the class name scope" do
+    events_yaml = <<~YAML
+    ---
+    - :id: 1
+      :event: :call
+      :defined_class: ClassMethod
+      :method_id: say_self_defined
+      :path: spec/fixtures/hook/class_method.rb
+      :lineno: 14
+      :static: true
+      :parameters: []
+      :receiver:
+        :class: Class
+        :value: ClassMethod
+    - :id: 2
+      :event: :return
+      :parent_id: 1
+      :return_value:
+        :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')
+    end
+  end
+
+  it 'Reports exceptions' do
+    events_yaml = <<~YAML
+    ---
+    - :id: 1
+      :event: :call
+      :defined_class: ExceptionMethod
+      :method_id: raise_exception
+      :path: spec/fixtures/hook/exception_method.rb
+      :lineno: 8
+      :static: false
+      :parameters: []
+      :receiver:
+        :class: ExceptionMethod
+        :value: Exception Method fixture
+    - :id: 2
+      :event: :return
+      :parent_id: 1
+      :exceptions:
+      - :class: RuntimeError
+        :message: Exception occurred in raise_exception
+        :path: spec/fixtures/hook/exception_method.rb
+        :lineno: 9
+    YAML
+    test_hook_behavior 'spec/fixtures/hook/exception_method.rb', events_yaml do
+      ExceptionMethod.new.raise_exception
+    end
+  end
+end