appmap 0.35.0 → 0.37.2

data/spec/fixtures/rails6_users_app/spec/rails_helper.rb

@@ -0,0 +1,66 @@
+# 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', __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!
+
+require 'appmap/rspec'
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# The following line is provided for convenience purposes. It has the downside
+# of increasing the boot-up time by auto-requiring all files in the support
+# directory. Alternatively, in the individual `*_spec.rb` files, manually
+# require only the support files necessary.
+#
+# Dir[Rails.root.join('spec', 'support', '**', '*.rb')].each { |f| require f }
+
+RSpec.configure do |config|
+  # 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`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, :type => :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+
+  # Filter lines from Rails gems in backtraces.
+  config.filter_rails_from_backtrace!
+  # 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
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.around :each do |example|
+    # Enable the use of 'return' from a guard
+    -> {
+      return example.run unless %i[model controller].member?(example.metadata[:type])
+
+      DatabaseCleaner.cleaning do
+        example.run
+      end
+    }.call
+  end
+end

data/spec/fixtures/rails6_users_app/spec/spec_helper.rb

@@ -0,0 +1,96 @@
+# This file was generated by the `rails generate rspec:install` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/fixtures/rails6_users_app/users_app/.gitignore

@@ -0,0 +1,20 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+
+.byebug_history
+
+# Ignore master key for decrypting credentials and more.
+/config/master.key

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
@@ -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
     ---
@@ -465,6 +511,132 @@ describe 'AppMap class Hooking', docker: false do
     end
   end
 
+  context 'string conversions works for the receiver when' do
+
+    it 'is missing #to_s' 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: Array
+          :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
+        :path: spec/fixtures/hook/exception_method.rb
+        :lineno: 32
+        :static: false
+        :parameters: []
+        :receiver:
+          :class: Class
+          :value: NoToSMethod
+      - :id: 4
+        :event: :return
+        :parent_id: 3
+        :return_value:
+          :class: String
+          :value: hello
+      YAML
+
+      test_hook_behavior 'spec/fixtures/hook/exception_method.rb', events_yaml do
+        inst = NoToSMethod.new
+        # sanity check
+        expect(inst).not_to respond_to(:to_s)
+        inst.say_hello
+      end
+    end
+
+    it 'it is missing #to_s and it raises an exception in #inspect' 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: Array
+          :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
+        :path: spec/fixtures/hook/exception_method.rb
+        :lineno: 42
+        :static: false
+        :parameters: []
+        :receiver:
+          :class: Class
+          :value: "*Error inspecting variable*"
+      - :id: 4
+        :event: :return
+        :parent_id: 3
+        :return_value:
+          :class: String
+          :value: hello
+      YAML
+
+      test_hook_behavior 'spec/fixtures/hook/exception_method.rb', events_yaml do
+        inst = InspectRaises.new
+        # sanity check
+        expect(inst).not_to respond_to(:to_s)
+        inst.say_hello
+      end
+    end
+
+    it 'it raises an exception in #to_s' do
+      events_yaml = <<~YAML
+      ---
+      - :id: 1
+        :event: :call
+        :defined_class: ToSRaises
+        :method_id: say_hello
+        :path: spec/fixtures/hook/exception_method.rb
+        :lineno: 52
+        :static: false
+        :parameters: []
+        :receiver:
+          :class: ToSRaises
+          :value: "*Error inspecting variable*"
+      - :id: 2
+        :event: :return
+        :parent_id: 1
+        :return_value:
+          :class: String
+          :value: hello
+      YAML
+
+      test_hook_behavior 'spec/fixtures/hook/exception_method.rb', events_yaml do
+        ToSRaises.new.say_hello
+      end
+    end
+  end
+
   it 're-raises exceptions' do
     RSpec::Expectations.configuration.on_potential_false_positives = :nothing
 
@@ -523,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
@@ -543,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
@@ -587,6 +759,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:
@@ -603,6 +779,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:
@@ -642,7 +827,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: