appmap 0.36.0 → 0.39.1

data/spec/fixtures/rails6_users_app/public/robots.txt

@@ -0,0 +1 @@
+# See http://www.robotstxt.org/robotstxt.html for documentation on how to use the robots.txt file

data/spec/fixtures/rails6_users_app/spec/controllers/users_controller_api_spec.rb

@@ -0,0 +1,29 @@
+require 'rails_helper'
+require 'rack/test'
+
+RSpec.describe Api::UsersController, feature_group: 'Users', type: :controller, appmap: true do
+  describe 'POST /api/users', feature: 'Create a user' do
+    describe 'with required parameters' do
+      it 'creates a user' do
+        post :create, params: { login: 'alice', password: 'foobar' }
+        expect(response.status).to eq(201)
+      end
+    end
+    describe 'with a missing parameter' do
+      it 'reports error 422' do
+        post :create, params: {}
+        expect(response.status).to eq(422)
+      end
+    end
+  end
+  describe 'GET /api/users', feature: 'List users' do
+    before do
+      post :create, params: { login: 'alice' }
+    end
+    it 'lists the users' do
+      get :index, params: {}
+      users = JSON.parse(response.body)
+      expect(users.map { |r| r['login'] }).to include('alice')
+    end
+  end
+end

data/spec/fixtures/rails6_users_app/spec/controllers/users_controller_spec.rb

@@ -0,0 +1,27 @@
+require 'rails_helper'
+require 'rack/test'
+
+RSpec.describe UsersController, type: :controller do
+  render_views
+
+  describe 'GET /users', feature: 'Show all users' do
+    before do
+      User.create login: 'alice'
+    end
+    it 'lists the users' do
+      get :index
+      expect(response).to be_ok
+    end
+  end
+
+  describe 'GET /users/:login', feature: 'Show a user' do
+    before do
+      User.create login: 'alice'
+    end
+
+    it 'shows the user' do
+      get :show, params: { id: 'alice' }
+      expect(response).to be_ok
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+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 appmap.
+  shared_examples_for 'creates the user' do |username|
+    let(:login) { username }
+    let(:user) { User.new(login: login) }
+    it "creates #{username.inspect}" do
+      expect(user.save(raise_on_failure: true)).to be_truthy
+    end
+  end
+
+  describe 'creation', feature: 'Create a user' do
+    context 'using shared_examples_for' do
+      # AppMap.
+#      context "with username 'alice'" do
+#        it_should_behave_like 'creates the user', 'alice'
+#      end
+#      context "with username 'bob'" do
+#        it_should_behave_like 'creates the user', 'bob'
+#      end
+    end
+
+    # So, instead of shared_examples_for, let's go with a simple method
+    # containing the assertions. The method can be called from within an example.
+    def save_and_verify
+      expect(user.save(raise_on_failure: true)).to be_truthy
+    end
+
+    context do
+      let(:login) { 'charles' }
+      let(:user) { User.new(login: login) }
+      it "creates 'charles'" do
+        save_and_verify
+      end
+    end
+  end
+end

data/spec/fixtures/{rails4_users_app → rails6_users_app}/spec/rails_helper.rb

@@ -1,31 +1,12 @@
-STDERR.puts "rails4_users_app rails_helper"
 # This file is copied to spec/ when you run 'rails generate rspec:install'
 require 'spec_helper'
 ENV['RAILS_ENV'] ||= 'test'
-
-require File.expand_path('../config/environment', __dir__)
-
+require File.expand_path('../../config/environment', __FILE__)
 # Prevent database truncation if the environment is production
 abort("The Rails environment is running in production mode!") if Rails.env.production?
 require 'rspec/rails'
 # Add additional requires below this line. Rails is not loaded until this point!
 
-# The issue this hack works around is discussed here
-# https://github.com/rails/rails/issues/34790, with the comment that
-# it won't be fixed here:
-# https://github.com/rails/rails/issues/34790#issuecomment-450036849
-if RUBY_VERSION >= '2.6.0'
-  class ActionController::TestResponse < ActionDispatch::TestResponse
-    def recycle!
-      # hack to avoid MonitorMixin double-initialize error:
-      @mon_mutex_owner_object_id = nil
-      @mon_mutex = nil
-      initialize
-    end
-  end
-end
-
-
 require 'appmap/rspec'
 
 # Requires supporting ruby files with custom matchers and macros, etc, in
@@ -43,18 +24,7 @@ require 'appmap/rspec'
 #
 # Dir[Rails.root.join('spec', 'support', '**', '*.rb')].each { |f| require f }
 
-# Checks for pending migrations and applies them before tests are run.
-# If you are not using ActiveRecord, you can remove these lines.
-begin
-  ActiveRecord::Migration.maintain_test_schema!
-rescue ActiveRecord::PendingMigrationError => e
-  puts e.to_s.strip
-  exit 1
-end
 RSpec.configure do |config|
-  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
-  config.fixture_path = "#{::Rails.root}/spec/fixtures"
-
   # RSpec Rails can automatically mix in different behaviours to your tests
   # based on their file location, for example enabling you to call `get` and
   # `post` in specs under `spec/controllers`.
@@ -75,6 +45,8 @@ RSpec.configure do |config|
   # arbitrary gems may also be filtered via:
   # config.filter_gems_from_backtrace("gem name")
 
+
+  DatabaseCleaner.allow_remote_database_url = true
   
   config.before(:suite) do
     DatabaseCleaner.strategy = :transaction
@@ -91,5 +63,4 @@ RSpec.configure do |config|
       end
     }.call
   end
-  
 end

data/spec/fixtures/{rails4_users_app → rails6_users_app/users_app}/.gitignore

@@ -9,5 +9,12 @@
 
 # Ignore all logfiles and tempfiles.
 /log/*
+/tmp/*
 !/log/.keep
-/tmp
+!/tmp/.keep
+
+
+.byebug_history
+
+# Ignore master key for decrypting credentials and more.
+/config/master.key

data/spec/hook_spec.rb

@@ -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
     ---
@@ -471,24 +517,6 @@ describe 'AppMap class Hooking', docker: false do
       events_yaml = <<~YAML
       ---
       - :id: 1
-        :event: :call
-        :defined_class: NoToSMethod
-        :method_id: respond_to?
-        :path: spec/fixtures/hook/exception_method.rb
-        :lineno: 24
-        :static: false
-        :parameters:
-        - :name: :args
-          :class: Symbol
-          :value: to_s
-          :kind: :rest
-        :receiver:
-          :class: Class
-          :value: NoToSMethod
-      - :id: 2
-        :event: :return
-        :parent_id: 1
-      - :id: 3
         :event: :call
         :defined_class: NoToSMethod
         :method_id: say_hello
@@ -499,9 +527,9 @@ describe 'AppMap class Hooking', docker: false do
         :receiver:
           :class: Class
           :value: NoToSMethod
-      - :id: 4
+      - :id: 2
         :event: :return
-        :parent_id: 3
+        :parent_id: 1
         :return_value:
           :class: String
           :value: hello
@@ -519,24 +547,6 @@ describe 'AppMap class Hooking', docker: false do
       events_yaml = <<~YAML
       ---
       - :id: 1
-        :event: :call
-        :defined_class: NoToSMethod
-        :method_id: respond_to?
-        :path: spec/fixtures/hook/exception_method.rb
-        :lineno: 24
-        :static: false
-        :parameters:
-        - :name: :args
-          :class: Symbol
-          :value: to_s
-          :kind: :rest
-        :receiver:
-          :class: Class
-          :value: "*Error inspecting variable*"
-      - :id: 2
-        :event: :return
-        :parent_id: 1
-      - :id: 3
         :event: :call
         :defined_class: InspectRaises
         :method_id: say_hello
@@ -547,9 +557,9 @@ describe 'AppMap class Hooking', docker: false do
         :receiver:
           :class: Class
           :value: "*Error inspecting variable*"
-      - :id: 4
+      - :id: 2
         :event: :return
-        :parent_id: 3
+        :parent_id: 1
         :return_value:
           :class: String
           :value: hello
@@ -649,8 +659,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 +679,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 +705,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 +747,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 +767,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 +794,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 +813,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: