appmap 0.31.0

data/spec/fixtures/rails_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/rails_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

@@ -0,0 +1,576 @@
+# frozen_string_literal: true
+
+require 'rails_spec_helper'
+require 'appmap/hook'
+require 'appmap/event'
+require 'diffy'
+
+# Show nulls as the literal +null+, rather than just leaving the field
+# empty. This make some of the expected YAML below easier to
+# understand.
+module ShowYamlNulls
+  def visit_NilClass(o)
+    @emitter.scalar('null', nil, 'tag:yaml.org,2002:null', true, false, Psych::Nodes::Scalar::ANY)
+  end
+end
+Psych::Visitors::YAMLTree.prepend(ShowYamlNulls)
+
+describe 'AppMap class Hooking', docker: false 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)
+
+      case event[:event]
+      when :call
+        event[:path] = event[:path].gsub(Gem.dir + '/', '')
+      when :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, setup: nil, &block)
+    AppMap.configuration = nil
+    package = AppMap::Package.new(file, [])
+    config = AppMap::Config.new('hook_spec', [ package ])
+    AppMap.configuration = config
+    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
+
+  def test_hook_behavior(file, events_yaml, setup: nil, &block)
+    config, tracer = invoke_test_file(file, setup: setup, &block)
+
+    events = collect_events(tracer)
+    expect(Diffy::Diff.new(events, events_yaml).to_s).to eq('')
+
+    [ config, tracer ]
+  end
+
+  after do
+    AppMap.configuration = nil
+  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(&:to_s)).to eq([ InstanceMethod.public_instance_method(:say_default).to_s ])
+  end
+
+  it 'builds a class map of invoked methods' do
+    _, tracer = invoke_test_file 'spec/fixtures/hook/instance_method.rb' 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('')
+    ---
+    - :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: null
+        :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: null
+        :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: SingletonMethod
+      :method_id: say_default
+      :path: spec/fixtures/hook/singleton_method.rb
+      :lineno: 5
+      :static: true
+      :parameters: []
+      :receiver:
+        :class: Class
+        :value: SingletonMethod
+    - :id: 2
+      :event: :return
+      :parent_id: 1
+      :return_value:
+        :class: String
+        :value: default
+    YAML
+    test_hook_behavior 'spec/fixtures/hook/singleton_method.rb', events_yaml do
+      expect(SingletonMethod.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: SingletonMethod
+      :method_id: say_class_defined
+      :path: spec/fixtures/hook/singleton_method.rb
+      :lineno: 10
+      :static: true
+      :parameters: []
+      :receiver:
+        :class: Class
+        :value: SingletonMethod
+    - :id: 2
+      :event: :return
+      :parent_id: 1
+      :return_value:
+        :class: String
+        :value: defined with explicit class scope
+    YAML
+    test_hook_behavior 'spec/fixtures/hook/singleton_method.rb', events_yaml do
+      expect(SingletonMethod.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: SingletonMethod
+      :method_id: say_self_defined
+      :path: spec/fixtures/hook/singleton_method.rb
+      :lineno: 14
+      :static: true
+      :parameters: []
+      :receiver:
+        :class: Class
+        :value: SingletonMethod
+    - :id: 2
+      :event: :return
+      :parent_id: 1
+      :return_value:
+        :class: String
+        :value: defined with self class scope
+    YAML
+    test_hook_behavior 'spec/fixtures/hook/singleton_method.rb', events_yaml do
+      expect(SingletonMethod.say_self_defined).to eq('defined with self class scope')
+    end
+  end
+
+
+  it 'hooks an included method' do
+    events_yaml = <<~YAML
+    ---
+    - :id: 1
+      :event: :call
+      :defined_class: SingletonMethod
+      :method_id: added_method
+      :path: spec/fixtures/hook/singleton_method.rb
+      :lineno: 44
+      :static: false
+      :parameters: []
+      :receiver:
+        :class: SingletonMethod
+        :value: Singleton Method fixture
+    - :id: 2
+      :event: :call
+      :defined_class: AddMethod
+      :method_id: _added_method
+      :path: spec/fixtures/hook/singleton_method.rb
+      :lineno: 50
+      :static: false
+      :parameters: []
+      :receiver:
+        :class: SingletonMethod
+        :value: Singleton Method fixture
+    - :id: 3
+      :event: :return
+      :parent_id: 2
+      :return_value:
+        :class: String
+        :value: defined by including a module
+    - :id: 4
+      :event: :return
+      :parent_id: 1
+      :return_value:
+        :class: String
+        :value: defined by including a module
+    YAML
+
+    load 'spec/fixtures/hook/singleton_method.rb'
+    setup = -> { SingletonMethod.new.do_include }
+    test_hook_behavior 'spec/fixtures/hook/singleton_method.rb', events_yaml, setup: setup do |s|
+      expect(s.added_method).to eq('defined by including a module')
+    end
+  end
+
+  it "doesn't hook a singleton method defined for an instance" do
+    # Ideally, Ruby would fire a TracePoint event when a singleton
+    # class gets created by defining a method on an instance. It
+    # currently doesn't, though, so there's no way for us to hook such
+    # a method.
+    #
+    # This example will fail if Ruby's behavior changes at some point
+    # in the future.
+    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
+    ---
+    - :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
+      begin
+        ExceptionMethod.new.raise_exception
+      rescue
+        # don't let the exception fail the test
+      end
+    end
+  end
+
+  it 're-raises exceptions' do
+    RSpec::Expectations.configuration.on_potential_false_positives = :nothing
+
+    invoke_test_file 'spec/fixtures/hook/exception_method.rb' do
+      expect { ExceptionMethod.new.raise_exception }.to raise_exception
+    end
+  end
+
+  context 'OpenSSL::X509::Certificate.sign' do
+    # OpenSSL::X509 is not being hooked.
+    # This might be because the class is being loaded before AppMap, and so the TracePoint
+    # set by AppMap doesn't see it.
+    xit 'is hooked' do
+      events_yaml = <<~YAML
+      ---
+      YAML
+      test_hook_behavior 'spec/fixtures/hook/openssl_sign.rb', events_yaml do
+        expect(OpenSSLExample.example).to be_truthy
+      end
+    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: :return
+        :parent_id: 2
+        :return_value:
+          :class: TrueClass
+          :value: 'true'
+      - :id: 4
+        :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
+      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(cm.to_yaml, classmap_yaml).to_s).to eq('')
+    end
+  end
+end