appmap 0.35.2 → 0.39.0

data/spec/hook_spec.rb

@@ -27,7 +27,7 @@ describe 'AppMap class Hooking', docker: false do
 
   def invoke_test_file(file, setup: nil, &block)
     AppMap.configuration = nil
-    package = AppMap::Config::Package.new(file)
+    package = AppMap::Config::Package.build_from_path(file)
     config = AppMap::Config.new('hook_spec', [ package ])
     AppMap.configuration = config
     tracer = nil
@@ -52,9 +52,9 @@ describe 'AppMap class Hooking', docker: false do
 
     events = collect_events(tracer).to_yaml
 
-    expect(Diffy::Diff.new(events_yaml, events).to_s).to eq('')
+    expect(Diffy::Diff.new(events_yaml, events).to_s).to eq('') if events_yaml
 
-    [ config, tracer ]
+    [ config, tracer, events ]
   end
 
   after do
@@ -112,6 +112,10 @@ describe 'AppMap class Hooking', docker: false do
           :type: function
           :location: spec/fixtures/hook/instance_method.rb:8
           :static: false
+          :source: |2
+              def say_default
+                'default'
+              end
     YAML
   end
 
@@ -177,8 +181,8 @@ describe 'AppMap class Hooking', docker: false do
       :static: false
       :parameters:
       - :name: :kw
-        :class: Hash
-        :value: '{:kw=>"kw"}'
+        :class: String
+        :value: kw
         :kind: :key
       :receiver:
         :class: InstanceMethod
@@ -225,6 +229,48 @@ describe 'AppMap class Hooking', docker: false do
     end
   end
 
+  it 'hooks an instance method that takes keyword arguments' do
+    events_yaml = <<~YAML
+    ---
+    - :id: 1
+      :event: :call
+      :defined_class: InstanceMethod
+      :method_id: say_kws
+      :path: spec/fixtures/hook/instance_method.rb
+      :lineno: 20
+      :static: false
+      :parameters:
+      - :name: :args
+        :class: Array
+        :value: "[4, 5]"
+        :kind: :rest
+      - :name: :kw1
+        :class: String
+        :value: one
+        :kind: :keyreq
+      - :name: :kw2
+        :class: Integer
+        :value: '2'
+        :kind: :key
+      - :name: :kws
+        :class: Hash
+        :value: "{:kw3=>:three}"
+        :kind: :keyrest
+      :receiver:
+        :class: InstanceMethod
+        :value: Instance Method fixture
+    - :id: 2
+      :event: :return
+      :parent_id: 1
+      :return_value:
+        :class: String
+        :value: one2{:kw3=>:three}45
+    YAML
+    test_hook_behavior 'spec/fixtures/hook/instance_method.rb', events_yaml do
+      expect(InstanceMethod.new.say_kws(4, 5, kw1: 'one', kw2: 2, kw3: :three)).to eq('one2{:kw3=>:three}45')
+    end
+  end
+
   it 'hooks an instance method that takes a block argument' do
     events_yaml = <<~YAML
     ---
@@ -233,7 +279,7 @@ describe 'AppMap class Hooking', docker: false do
       :defined_class: InstanceMethod
       :method_id: say_block
       :path: spec/fixtures/hook/instance_method.rb
-      :lineno: 20
+      :lineno: 24
       :static: false
       :parameters:
       - :name: :block
@@ -401,7 +447,7 @@ describe 'AppMap class Hooking', docker: false do
 
       # Verify the native extension works as expected
       expect(AppMap::Hook.singleton_method_owner_name(say_instance_defined)).to eq('SingletonMethod')
-      
+
       expect(s.say_instance_defined).to eq('defined for an instance')
     end
   end
@@ -432,7 +478,7 @@ describe 'AppMap class Hooking', docker: false do
       expect(SingletonMethod::STRUCT_TEST.say_struct_singleton).to eq('singleton for a struct')
     end
   end
-  
+
   it 'Reports exceptions' do
     events_yaml = <<~YAML
     ---
@@ -479,8 +525,8 @@ describe 'AppMap class Hooking', docker: false do
         :static: false
         :parameters:
         - :name: :args
-          :class: Symbol
-          :value: to_s
+          :class: Array
+          :value: "[:to_s]"
           :kind: :rest
         :receiver:
           :class: Class
@@ -527,8 +573,8 @@ describe 'AppMap class Hooking', docker: false do
         :static: false
         :parameters:
         - :name: :args
-          :class: Symbol
-          :value: to_s
+          :class: Array
+          :value: "[:to_s]"
           :kind: :rest
         :receiver:
           :class: Class
@@ -649,8 +695,8 @@ describe 'AppMap class Hooking', docker: false do
         :static: false
         :parameters:
         - :name: arg
-          :class: String
-          :value: string
+          :class: Array
+          :value: '["string"]'
           :kind: :rest
         :receiver:
           :class: Digest::SHA256
@@ -669,8 +715,8 @@ describe 'AppMap class Hooking', docker: false do
         :static: false
         :parameters:
         - :name: arg
-          :class: String
-          :value: string
+          :class: Array
+          :value: '["string"]'
           :kind: :rest
         :receiver:
           :class: Digest::SHA256
@@ -695,9 +741,33 @@ describe 'AppMap class Hooking', docker: false do
           :value: 'true'
       YAML
 
-      test_hook_behavior 'spec/fixtures/hook/compare.rb', events_yaml do
+      _, _, events = test_hook_behavior 'spec/fixtures/hook/compare.rb', nil do
         expect(Compare.compare('string', 'string')).to be_truthy
       end
+      secure_compare_event = YAML.load(events).find { |evt| evt[:defined_class] == 'ActiveSupport::SecurityUtils' }
+      secure_compare_event.delete(:lineno)
+
+      expect(Diffy::Diff.new(<<~YAML, secure_compare_event.to_yaml).to_s).to eq('')
+      ---
+      :id: 2
+      :event: :call
+      :defined_class: ActiveSupport::SecurityUtils
+      :method_id: secure_compare
+      :path: lib/active_support/security_utils.rb
+      :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
+      YAML
     end
 
     it 'gets labeled in the classmap' do
@@ -713,6 +783,10 @@ describe 'AppMap class Hooking', docker: false do
             :type: function
             :location: spec/fixtures/hook/compare.rb:4
             :static: true
+            :source: |2
+                def self.compare(s1, s2)
+                  ActiveSupport::SecurityUtils.secure_compare(s1, s2)
+                end
       - :name: active_support
         :type: package
         :children:
@@ -729,6 +803,15 @@ describe 'AppMap class Hooking', docker: false do
               :labels:
               - security
               - crypto
+              :comment: |
+                # Constant time string comparison, for variable length strings.
+                #
+                # The values are first processed by SHA256, so that we don't leak length info
+                # via timing attacks.
+              :source: |2
+                    def secure_compare(a, b)
+                      fixed_length_secure_compare(::Digest::SHA256.digest(a), ::Digest::SHA256.digest(b)) && a == b
+                    end
       - :name: openssl
         :type: package
         :children:
@@ -747,16 +830,14 @@ describe 'AppMap class Hooking', docker: false do
               - crypto
       YAML
 
-      config, tracer = invoke_test_file 'spec/fixtures/hook/compare.rb' do
+      _, tracer = invoke_test_file 'spec/fixtures/hook/compare.rb' do
         expect(Compare.compare('string', 'string')).to be_truthy
       end
       cm = AppMap::Util.sanitize_paths(AppMap::ClassMap.build_from_methods(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('')
+      expect(entry[:labels]).to eq(%w[security crypto])
     end
   end
 
@@ -768,7 +849,7 @@ describe 'AppMap class Hooking', docker: false do
       :defined_class: InstanceMethod
       :method_id: say_the_time
       :path: spec/fixtures/hook/instance_method.rb
-      :lineno: 24
+      :lineno: 28
       :static: false
       :parameters: []
       :receiver:

data/spec/rails_spec_helper.rb

@@ -29,10 +29,10 @@ def run_cmd(*cmd, &failed)
   raise 'Command failed'
 end
 
-shared_context 'Rails app pg database' do
-  before(:all) do
-    raise 'you must set @fixure_dir' unless @fixture_dir
+shared_context 'Rails app pg database' do |fixture_dir|
+  define_method(:fixture_dir) { fixture_dir }
 
+  before(:all) do
     print_pg_logs = lambda do
       logs, = run_cmd 'docker-compose logs pg'
       puts "docker-compose logs for pg:"
@@ -40,7 +40,7 @@ shared_context 'Rails app pg database' do
       puts logs
     end
 
-    Dir.chdir @fixture_dir do 
+    Dir.chdir fixture_dir do
       run_cmd 'docker-compose down -v'
       cmd = 'docker-compose up -d pg'
       run_cmd cmd
@@ -54,7 +54,7 @@ shared_context 'Rails app pg database' do
   after(:all) do
     if ENV['NOKILL'] != 'true'
       cmd = 'docker-compose down -v'
-      run_cmd cmd, chdir: @fixture_dir
+      run_cmd cmd, chdir: fixture_dir
     end
   end
 end

data/spec/railtie_spec.rb

@@ -1,43 +1,42 @@
 require 'rails_spec_helper'
 
 describe 'AppMap tracer via Railtie' do
-  before(:all) { @fixture_dir = 'spec/fixtures/rails_users_app' }
-  include_context 'Rails app pg database'
-  
-  let(:env) { {} }
+  include_context 'Rails app pg database', 'spec/fixtures/rails5_users_app' do 
+    let(:env) { {} }
 
-  let(:cmd) { %(docker-compose run --rm -e RAILS_ENV -e APPMAP app ./bin/rails r "puts Rails.configuration.appmap.enabled.inspect") }
-  let(:command_capture2) do
-    require 'open3'
-    Open3.capture3(env, cmd, chdir: @fixture_dir).tap do |result|
-      unless result[2] == 0
-        $stderr.puts <<~END
-          Failed to run rails_users_app container
-          <<< Output:
-          #{result[0]}
-          #{result[1]}
-          >>> End of output
-        END
-        raise 'Failed to run rails_users_app container'
+    let(:cmd) { %(docker-compose run --rm -e RAILS_ENV -e APPMAP app ./bin/rails r "puts Rails.configuration.appmap.enabled.inspect") }
+    let(:command_capture2) do
+      require 'open3'
+      Open3.capture3(env, cmd, chdir: fixture_dir).tap do |result|
+        unless result[2] == 0
+          warn <<~STDERR
+            Failed to run rails5_users_app container
+            <<< Output:
+            #{result[0]}
+            #{result[1]}
+            >>> End of output
+          STDERR
+          raise 'Failed to run rails5_users_app container'
+        end
       end
     end
-  end
-  let(:command_output) { command_capture2[0].strip }
-  let(:command_result) { command_capture2[2] }
-
-  it 'is disabled by default' do
-    expect(command_output).to eq('nil')
-  end
+    let(:command_output) { command_capture2[0].strip }
+    let(:command_result) { command_capture2[2] }
 
-  describe 'with APPMAP=true' do
-    let(:env) { { 'APPMAP' => 'true' } }
-    it 'is enabled' do
-      expect(command_output.split("\n")).to include('true')
+    it 'is disabled by default' do
+      expect(command_output).to eq('nil')
     end
-    context 'and RAILS_ENV=test' do
-      let(:env) { { 'APPMAP' => 'true', 'RAILS_ENV' => 'test' } }
-      it 'is disabled' do
-        expect(command_output).to eq('nil')
+
+    describe 'with APPMAP=true' do
+      let(:env) { { 'APPMAP' => 'true' } }
+      it 'is enabled' do
+        expect(command_output.split("\n")).to include('true')
+      end
+      context 'and RAILS_ENV=test' do
+        let(:env) { { 'APPMAP' => 'true', 'RAILS_ENV' => 'test' } }
+        it 'is disabled' do
+          expect(command_output).to eq('nil')
+        end
       end
     end
   end

data/spec/record_sql_rails4_pg_spec.rb

@@ -1,75 +1,74 @@
 require 'rails_spec_helper'
 
 describe 'Record SQL queries in a Rails4 app' do
-  before(:all) { @fixture_dir = 'spec/fixtures/rails4_users_app' }
-  include_context 'Rails app pg database'
-  
-  around(:each) do |example|
-    FileUtils.rm_rf tmpdir
-    FileUtils.mkdir_p tmpdir
-    cmd = "docker-compose run --rm -e ORM_MODULE=#{orm_module} -e APPMAP=true -v #{File.absolute_path tmpdir}:/app/tmp app ./bin/rspec spec/controllers/users_controller_api_spec.rb:#{test_line_number}"
-    run_cmd cmd, chdir: @fixture_dir
+  include_context 'Rails app pg database', 'spec/fixtures/rails4_users_app' do
+    around(:each) do |example|
+      FileUtils.rm_rf tmpdir
+      FileUtils.mkdir_p tmpdir
+      cmd = "docker-compose run --rm -e ORM_MODULE=#{orm_module} -e APPMAP=true -v #{File.absolute_path tmpdir}:/app/tmp app ./bin/rspec spec/controllers/users_controller_api_spec.rb:#{test_line_number}"
+      run_cmd cmd, chdir: fixture_dir
 
-    example.run
-  end
+      example.run
+    end
+
+    let(:tmpdir) { "tmp/spec/record_sql_rails_pg_spec" }
+    let(:appmap) { JSON.parse(File.read(appmap_json)).to_yaml }
 
-  let(:tmpdir) { "tmp/spec/record_sql_rails_pg_spec" }
-  let(:appmap) { JSON.parse(File.read(appmap_json)).to_yaml }
+    context 'when running specs' do
+      let(:test_line_number) { 31 }
+      let(:orm_module) { 'activerecord' }
 
-  context 'when running specs' do
-    let(:test_line_number) { 31 }
-    let(:orm_module) { 'activerecord' }
+      it { is_expected.to be }
+    end
 
-    it { is_expected.to be }
-  end
-  
-  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 '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') }
 
-    xcontext 'using Sequel ORM' do
-      let(:orm_module) { 'sequel' }
-      it 'detects the sql INSERT' do
-        expect(appmap).to include(<<-SQL_QUERY.strip)
+      xcontext '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", "created_at", "updated_at") VALUES ($1, $2,
       $3) 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 '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') }
 
-    xcontext 'using Sequel ORM' do
-      let(:orm_module) { 'sequel' }
-      it 'detects the sql SELECT' do
-        expect(appmap).to include(<<-SQL_QUERY.strip)
+      xcontext '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
+          SQL_QUERY
 
-        expect(appmap).to include('sql:')
+          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