appmap 0.28.1 → 0.34.1

data/spec/abstract_controller_base_spec.rb

@@ -47,17 +47,17 @@ describe 'AbstractControllerBase' do
       SERVER_REQUEST
     end
 
-    it 'Properly captures method parameters in the appmap' do
+    it 'properly captures method parameters in the appmap' do
       expect(File).to exist(appmap_json)
       appmap = JSON.parse(File.read(appmap_json)).to_yaml
 
       expect(appmap).to match(<<-CREATE_CALL.strip)
   event: call
+  thread_id: .*
   defined_class: Api::UsersController
   method_id: build_user
   path: app/controllers/api/users_controller.rb
   lineno: 23
-  thread_id: .*
   static: false
   parameters:
   - name: params
@@ -68,5 +68,12 @@ describe 'AbstractControllerBase' do
   receiver:
       CREATE_CALL
     end
+
+    it 'returns a minimal event' do
+      expect(File).to exist(appmap_json)
+      appmap = JSON.parse(File.read(appmap_json))
+      event = appmap['events'].find { |event| event['event'] == 'return' && event['return_value'] }
+      expect(event.keys).to eq(%w[id event thread_id parent_id elapsed return_value])
+    end
   end
 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/instance_method.rb

@@ -20,4 +20,8 @@ class InstanceMethod
   def say_block(&block)
     yield
   end
+
+  def say_the_time
+    Time.now.to_s
+  end
 end

data/spec/hook_spec.rb

@@ -15,48 +15,35 @@ module ShowYamlNulls
 end
 Psych::Visitors::YAMLTree.prepend(ShowYamlNulls)
 
-describe 'AppMap class Hooking' do
+describe 'AppMap class Hooking', docker: false do
+  require 'appmap/util'
   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.map(&AppMap::Util.method(:sanitize_event)).to_yaml
   end
 
   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::Config::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
 
@@ -64,7 +51,8 @@ describe 'AppMap class Hooking' do
     config, tracer = invoke_test_file(file, setup: setup, &block)
 
     events = collect_events(tracer)
-    expect(Diffy::Diff.new(events, events_yaml).to_s).to eq('')
+
+    expect(Diffy::Diff.new(events_yaml, events).to_s).to eq('')
 
     [ config, tracer ]
   end
@@ -94,7 +82,7 @@ describe 'AppMap class Hooking' do
         :class: String
         :value: default
     YAML
-    config, tracer = test_hook_behavior 'spec/fixtures/hook/instance_method.rb', events_yaml do
+    test_hook_behavior 'spec/fixtures/hook/instance_method.rb', events_yaml do
       expect(InstanceMethod.new.say_default).to eq('default')
     end
   end
@@ -104,7 +92,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
@@ -112,7 +100,7 @@ describe 'AppMap class Hooking' do
       InstanceMethod.new.say_default
     end
     class_map = AppMap.class_map(tracer.event_methods).to_yaml
-    expect(Diffy::Diff.new(class_map, <<~YAML).to_s).to eq('')
+    expect(Diffy::Diff.new(<<~YAML, class_map).to_s).to eq('')
     ---
     - :name: spec/fixtures/hook/instance_method.rb
       :type: package
@@ -403,14 +391,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 +438,201 @@ describe 'AppMap class Hooking' do
       expect { ExceptionMethod.new.raise_exception }.to raise_exception
     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: :call
+        :defined_class: Digest::Instance
+        :method_id: digest
+        :path: Digest::Instance#digest
+        :static: false
+        :parameters:
+        - :name: arg
+          :class: String
+          :value: string
+          :kind: :rest
+        :receiver:
+          :class: Digest::SHA256
+          :value: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
+      - :id: 4
+        :event: :return
+        :parent_id: 3
+        :return_value:
+          :class: String
+          :value: "G2__)__qc____X____3_].\\x02y__.___/_"
+      - :id: 5
+        :event: :call
+        :defined_class: Digest::Instance
+        :method_id: digest
+        :path: Digest::Instance#digest
+        :static: false
+        :parameters:
+        - :name: arg
+          :class: String
+          :value: string
+          :kind: :rest
+        :receiver:
+          :class: Digest::SHA256
+          :value: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
+      - :id: 6
+        :event: :return
+        :parent_id: 5
+        :return_value:
+          :class: String
+          :value: "G2__)__qc____X____3_].\\x02y__.___/_"
+      - :id: 7
+        :event: :return
+        :parent_id: 2
+        :return_value:
+          :class: TrueClass
+          :value: 'true'
+      - :id: 8
+        :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
+              - crypto
+      - :name: openssl
+        :type: package
+        :children:
+        - :name: Digest
+          :type: class
+          :children:
+          - :name: Instance
+            :type: class
+            :children:
+            - :name: digest
+              :type: function
+              :location: Digest::Instance#digest
+              :static: false
+              :labels:
+              - security
+              - crypto
+      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(classmap_yaml, cm.to_yaml).to_s).to eq('')
+    end
+  end
+
+  it "doesn't cause expectations on Time.now to fail" do
+    events_yaml = <<~YAML
+    ---
+    - :id: 1
+      :event: :call
+      :defined_class: InstanceMethod
+      :method_id: say_the_time
+      :path: spec/fixtures/hook/instance_method.rb
+      :lineno: 24
+      :static: false
+      :parameters: []
+      :receiver:
+        :class: InstanceMethod
+        :value: Instance Method fixture
+    - :id: 2
+      :event: :return
+      :parent_id: 1
+      :return_value:
+        :class: String
+        :value: '2020-01-01 00:00:00 +0000'
+    YAML
+    test_hook_behavior 'spec/fixtures/hook/instance_method.rb', events_yaml do
+      require 'timecop'
+      begin
+        tz = ENV['TZ']
+        ENV['TZ'] = 'UTC'
+        Timecop.freeze(Time.utc('2020-01-01')) do
+          expect(Time).to receive(:now).exactly(3).times.and_call_original
+          expect(InstanceMethod.new.say_the_time).to be
+        end
+      ensure
+        ENV['TZ'] = tz
+      end
+    end
+  end
 end

data/spec/open_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe AppMap::Open do
+  context 'a block of Ruby code' do
+    it 'opens in the browser' do
+      appmap = AppMap.record do
+        File.read __FILE__
+      end
+
+      open = AppMap::Open.new(appmap)
+      server = open.run_server
+      page = Net::HTTP.get URI.parse("http://localhost:#{open.port}")
+      expect(page).to include(%(name="data" value='{"version))
+      server.kill
+    end
+  end
+end

data/spec/record_sql_rails_pg_spec.rb

@@ -1,6 +1,6 @@
 require 'rails_spec_helper'
 
-describe 'Record SQL queries in a Rails app' do
+describe 'SQL events' do
   before(:all) { @fixture_dir = 'spec/fixtures/rails_users_app' }
   include_context 'Rails app pg database'
 
@@ -14,54 +14,77 @@ describe 'Record SQL queries in a Rails app' do
   end
 
   let(:tmpdir) { "tmp/spec/record_sql_rails_pg_spec" }
-  let(:appmap) { JSON.parse(File.read(appmap_json)).to_yaml }
 
-  context 'while creating a new record' do
+  describe 'fields' do
     let(:test_line_number) { 8 }
     let(:appmap_json) { File.join(tmpdir, 'appmap/rspec/Api_UsersController_POST_api_users_with_required_parameters_creates_a_user.appmap.json') }
+    let(:orm_module) { 'sequel' }
+    let(:appmap) { JSON.parse(File.read(appmap_json)) }
+    describe 'on a call event' do
+      let(:event) do
+        appmap['events'].find do |event|
+          event['event'] == 'call' &&
+            event.keys.include?('sql_query')
+        end
+      end
+      it 'do not include function-only fields' do
+        expect(event.keys).to_not include('defined_class')
+        expect(event.keys).to_not include('method_id')
+        expect(event.keys).to_not include('path')
+        expect(event.keys).to_not include('lineno')
+      end
+    end
+  end
+
+  describe 'in a Rails app' do
+    let(:appmap) { JSON.parse(File.read(appmap_json)).to_yaml }
+    context 'while creating a new record' do
+      let(:test_line_number) { 8 }
+      let(:appmap_json) { File.join(tmpdir, 'appmap/rspec/Api_UsersController_POST_api_users_with_required_parameters_creates_a_user.appmap.json') }
 
-    context 'using Sequel ORM' do
-      let(:orm_module) { 'sequel' }
-      it 'detects the sql INSERT' do
-        expect(appmap).to include(<<-SQL_QUERY.strip)
+      context 'using Sequel ORM' do
+        let(:orm_module) { 'sequel' }
+        it 'detects the sql INSERT' do
+          expect(appmap).to include(<<-SQL_QUERY.strip)
   sql_query:
     sql: INSERT INTO "users" ("login") VALUES ('alice') RETURNING *
-        SQL_QUERY
+          SQL_QUERY
+        end
       end
-    end
-    context 'using ActiveRecord ORM' do
-      let(:orm_module) { 'activerecord' }
-      it 'detects the sql INSERT' do
-        expect(appmap).to include(<<-SQL_QUERY.strip)
+      context 'using ActiveRecord ORM' do
+        let(:orm_module) { 'activerecord' }
+        it 'detects the sql INSERT' do
+          expect(appmap).to include(<<-SQL_QUERY.strip)
   sql_query:
     sql: INSERT INTO "users" ("login") VALUES ($1) RETURNING "id"
-        SQL_QUERY
+          SQL_QUERY
+        end
       end
     end
-  end
-
-  context 'while listing records' do
-    let(:test_line_number) { 23 }
-    let(:appmap_json) { File.join(tmpdir, 'appmap/rspec/Api_UsersController_GET_api_users_lists_the_users.appmap.json') }
-
-    context 'using Sequel ORM' do
-      let(:orm_module) { 'sequel' }
-      it 'detects the sql SELECT' do
-        expect(appmap).to include(<<-SQL_QUERY.strip)
+  
+    context 'while listing records' do
+      let(:test_line_number) { 23 }
+      let(:appmap_json) { File.join(tmpdir, 'appmap/rspec/Api_UsersController_GET_api_users_lists_the_users.appmap.json') }
+  
+      context 'using Sequel ORM' do
+        let(:orm_module) { 'sequel' }
+        it 'detects the sql SELECT' do
+          expect(appmap).to include(<<-SQL_QUERY.strip)
   sql_query:
     sql: SELECT * FROM "users"
-        SQL_QUERY
-
-        expect(appmap).to include('sql:')
+          SQL_QUERY
+  
+          expect(appmap).to include('sql:')
+        end
       end
-    end
-    context 'using ActiveRecord ORM' do
-      let(:orm_module) { 'activerecord' }
-      it 'detects the sql SELECT' do
-        expect(appmap).to include(<<-SQL_QUERY.strip)
+      context 'using ActiveRecord ORM' do
+        let(:orm_module) { 'activerecord' }
+        it 'detects the sql SELECT' do
+          expect(appmap).to include(<<-SQL_QUERY.strip)
   sql_query:
     sql: SELECT "users".* FROM "users"
-        SQL_QUERY
+          SQL_QUERY
+        end
       end
     end
   end