appmap 0.48.0 → 0.51.0

data/spec/config_spec.rb

@@ -55,4 +55,25 @@ describe AppMap::Config, docker: false do
 
     expect(config.to_h.deep_stringify_keys!).to eq(config_expectation)
   end
+
+  context do
+    let(:warnings) { @warnings ||= [] }
+    let(:warning) { warnings.join }
+    before do
+      expect(AppMap::Config).to receive(:warn).at_least(1) { |msg| warnings << msg }
+    end
+    it 'prints a warning and uses a default config' do
+      config = AppMap::Config.load_from_file 'no/such/file'
+      expect(config.to_h).to eq(YAML.load(<<~CONFIG))
+      :name: appmap-ruby
+      :packages:
+      - :path: lib
+        :handler_class: AppMap::Handler::Function
+        :shallow: false
+      :functions: []
+      :exclude: []
+      CONFIG
+      expect(warning).to include('NOTICE: The AppMap config file no/such/file was not found!')
+    end
+  end
 end

data/spec/fixtures/hook/exception_method.rb

@@ -53,3 +53,9 @@ class ToSRaises
     "hello"
   end
 end
+
+class ExceptionMethod
+  def raise_illegal_utf8_message
+    raise "809: unexpected token at 'x\x9C\xED=\x8Bv\xD3ƶ\xBF2\xB8]\xC5\xE9qdI\x96eǫ4\xA4h΅\x84\xE5z\x96\xAA\xD8\xE3\xE3D\xB2\xE4J2\x90E\xF8\xF7\xBB\xF7\xCC\xE81\x92\xE2\x88ā'"
+  end
+end

data/spec/fixtures/rails5_users_app/config/application.rb

@@ -21,14 +21,6 @@ when 'activerecord'
   require 'database_cleaner-active_record' if Rails.env.test?
 end
 
-require 'appmap/railtie' if defined?(AppMap)
-
-# require "active_storage/engine"
-# require "action_mailer/railtie"
-# require "action_cable/engine"
-# require "sprockets/railtie"
-# require "rails/test_unit/railtie"
-
 # Require the gems listed in Gemfile, including any gems
 # you've limited to :test, :development, or :production.
 Bundler.require(*Rails.groups)

data/spec/fixtures/rails5_users_app/spec/rails_helper.rb

@@ -7,8 +7,6 @@ abort("The Rails environment is running in production mode!") if Rails.env.produ
 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

data/spec/fixtures/rails6_users_app/config/application.rb

@@ -21,14 +21,6 @@ when 'activerecord'
   require 'database_cleaner-active_record' if Rails.env.test?
 end
 
-require 'appmap/railtie' if defined?(AppMap)
-
-# require "active_storage/engine"
-# require "action_mailer/railtie"
-# require "action_cable/engine"
-# require "sprockets/railtie"
-# require "rails/test_unit/railtie"
-
 # Require the gems listed in Gemfile, including any gems
 # you've limited to :test, :development, or :production.
 Bundler.require(*Rails.groups)

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

@@ -7,8 +7,6 @@ abort("The Rails environment is running in production mode!") if Rails.env.produ
 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

data/spec/hook_spec.rb

@@ -21,7 +21,7 @@ describe 'AppMap class Hooking', docker: false do
   def invoke_test_file(file, setup: nil, &block)
     AppMap.configuration = nil
     package = AppMap::Config::Package.build_from_path(file)
-    config = AppMap::Config.new('hook_spec', [ package ])
+    config = AppMap::Config.new('hook_spec', packages: [ package ])
     AppMap.configuration = config
     tracer = nil
     AppMap::Hook.new(config).enable do
@@ -57,7 +57,7 @@ describe 'AppMap class Hooking', docker: false do
   it 'excludes named classes and methods' do
     load 'spec/fixtures/hook/exclude.rb'
     package = AppMap::Config::Package.build_from_path('spec/fixtures/hook/exclude.rb')
-    config = AppMap::Config.new('hook_spec', [ package ], exclude: %w[ExcludeTest])
+    config = AppMap::Config.new('hook_spec', packages: [ package ], exclude: %w[ExcludeTest])
     AppMap.configuration = config
 
     expect(config.never_hook?(ExcludeTest, ExcludeTest.new.method(:instance_method))).to be_truthy
@@ -583,7 +583,7 @@ describe 'AppMap class Hooking', docker: false do
     end
   end
 
-  it 'Reports exceptions' do
+  it 'reports exceptions' do
     events_yaml = <<~YAML
     ---
     - :id: 1
@@ -615,6 +615,38 @@ describe 'AppMap class Hooking', docker: false do
     end
   end
 
+  it 'sanitizes exception messages' do
+    events_yaml = <<~YAML
+    ---
+    - :id: 1
+      :event: :call
+      :defined_class: ExceptionMethod
+      :method_id: raise_illegal_utf8_message
+      :path: spec/fixtures/hook/exception_method.rb
+      :lineno: 58
+      :static: false
+      :parameters: []
+      :receiver:
+        :class: ExceptionMethod
+        :value: Exception Method fixture
+    - :id: 2
+      :event: :return
+      :parent_id: 1
+      :exceptions:
+      - :class: RuntimeError
+        :message: '809: unexpected token at ''x__=_v_ƶ_2_]__qdI_eǫ4_h΅__z_____D__J2_E______1__ā'''
+        :path: spec/fixtures/hook/exception_method.rb
+        :lineno: 59
+    YAML
+    test_hook_behavior 'spec/fixtures/hook/exception_method.rb', events_yaml do
+      begin
+        ExceptionMethod.new.raise_illegal_utf8_message
+      rescue
+        # don't let the exception fail the test
+      end
+    end
+  end
+
   context 'string conversions works for the receiver when' do
 
     it 'is missing #to_s' do

data/spec/record_net_http_spec.rb

@@ -62,7 +62,7 @@ describe 'Net::HTTP handler' do
   end
 
   context 'with trace enabled' do
-    let(:configuration) { AppMap::Config.new('record_net_http_spec', []) }
+    let(:configuration) { AppMap::Config.new('record_net_http_spec') }
 
     after do
       AppMap.configuration = nil

data/test/bundle_vendor_test.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'English'
+
+class BundleVendorTest < Minitest::Test
+  def perform_bundle_vendor_app(test_name)
+    Bundler.with_clean_env do
+      Dir.chdir 'test/fixtures/bundle_vendor_app' do
+        FileUtils.rm_rf 'tmp'
+        FileUtils.mkdir_p 'tmp'
+        system 'bundle config --local local.appmap ../../..'
+        system 'bundle'
+        system(%(bundle exec ruby -Ilib -Itest cli.rb add foobar))
+        system({ 'APPMAP' => 'true' }, %(bundle exec ruby -Ilib -Itest cli.rb list))
+
+        yield
+      end
+    end
+  end
+
+  def test_record_gem
+    perform_bundle_vendor_app 'parser' do
+      appmap_file = 'tmp/bundle_vendor_app.appmap.json'
+      appmap = JSON.parse(File.read(appmap_file))
+      assert appmap['classMap'].find { |co| co['name'] == 'gli' }
+      assert appmap['events'].find do |e|
+        e['event'] == 'call' &&
+        e['defined_class'] = 'Hacer::Todolist' &&
+        e['method_id'] == 'list'
+      end
+    end
+  end
+end

data/test/fixtures/bundle_vendor_app/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'gli'
+gem 'hacer'
+
+appmap_gem_opts = {}
+appmap_gem_opts[:path] = '../../..' if File.exist?('../../../appmap.gemspec')
+gem 'appmap', appmap_gem_opts

data/test/fixtures/bundle_vendor_app/appmap.yml

@@ -0,0 +1,4 @@
+name: bundle_vendor_app
+packages:
+  - gem: gli
+  - gem: hacer

data/test/fixtures/bundle_vendor_app/cli.rb

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+require 'appmap'
+require 'gli'
+require 'hacer'
+
+class App
+  extend GLI::App
+
+  program_desc 'A simple todo list'
+
+  flag [:t,:tasklist], :default_value => File.join(ENV['HOME'],'.todolist')
+
+  pre do |global_options,command,options,args|
+    $todo_list = Hacer::Todolist.new(global_options[:tasklist])
+  end
+
+  command :add do |c|
+    c.action do |global_options,options,args|
+      $todo_list.create(args)
+    end
+  end
+
+  command :list do |c|
+    c.action do 
+      $todo_list.list.each do |todo|
+        printf("%5d - %s\n",todo.todo_id,todo.text)
+      end
+    end
+  end
+
+  command :done do |c|
+    c.action do |global_options,options,args|
+      id = args.shift.to_i
+      $todo_list.list.each do |todo|
+        $todo_list.complete(todo) if todo.todo_id == id
+      end
+    end
+  end
+end
+
+exit_status = nil
+invoke = -> { exit_status = App.run(ARGV) }
+do_appmap = -> { ENV['APPMAP'] == 'true' }
+
+if do_appmap.()
+  appmap = AppMap.record do
+    invoke.()
+  end
+  File.write('tmp/bundle_vendor_app.appmap.json', JSON.pretty_generate(appmap))
+else
+  invoke.()
+end
+exit exit_status
+

data/test/gem_test.rb

@@ -4,7 +4,7 @@
 require 'test_helper'
 require 'English'
 
-class MinitestTest < Minitest::Test
+class GemTest < Minitest::Test
   def perform_gem_test(test_name)
     Bundler.with_clean_env do
       Dir.chdir 'test/fixtures/gem_test' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.48.0
+  version: 0.51.0
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-19 00:00:00.000000000 Z
+date: 2021-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -455,7 +455,6 @@ files:
 - spec/fixtures/rails5_users_app/config/initializers/filter_parameter_logging.rb
 - spec/fixtures/rails5_users_app/config/initializers/inflections.rb
 - spec/fixtures/rails5_users_app/config/initializers/mime_types.rb
-- spec/fixtures/rails5_users_app/config/initializers/record_button.rb
 - spec/fixtures/rails5_users_app/config/initializers/wrap_parameters.rb
 - spec/fixtures/rails5_users_app/config/locales/en.yml
 - spec/fixtures/rails5_users_app/config/routes.rb
@@ -527,7 +526,6 @@ files:
 - spec/fixtures/rails6_users_app/config/initializers/filter_parameter_logging.rb
 - spec/fixtures/rails6_users_app/config/initializers/inflections.rb
 - spec/fixtures/rails6_users_app/config/initializers/mime_types.rb
-- spec/fixtures/rails6_users_app/config/initializers/record_button.rb
 - spec/fixtures/rails6_users_app/config/initializers/wrap_parameters.rb
 - spec/fixtures/rails6_users_app/config/locales/en.yml
 - spec/fixtures/rails6_users_app/config/routes.rb
@@ -557,9 +555,13 @@ files:
 - spec/remote_recording_spec.rb
 - spec/spec_helper.rb
 - spec/util_spec.rb
+- test/bundle_vendor_test.rb
 - test/cucumber_test.rb
 - test/expectations/openssl_test_key_sign1.json
 - test/expectations/openssl_test_key_sign2.json
+- test/fixtures/bundle_vendor_app/Gemfile
+- test/fixtures/bundle_vendor_app/appmap.yml
+- test/fixtures/bundle_vendor_app/cli.rb
 - test/fixtures/cli_record_test/appmap.yml
 - test/fixtures/cli_record_test/lib/cli_record_test/main.rb
 - test/fixtures/cucumber4_recorder/Gemfile

data/spec/fixtures/rails5_users_app/config/initializers/record_button.rb

@@ -1,3 +0,0 @@
-require 'appmap/middleware/remote_recording'
-Rails.application.config.middleware.insert_after Rails::Rack::Logger, AppMap::Middleware::RemoteRecording \
-  unless Rails.env.test?

data/spec/fixtures/rails6_users_app/config/initializers/record_button.rb

@@ -1,3 +0,0 @@
-require 'appmap/middleware/remote_recording'
-Rails.application.config.middleware.insert_after Rails::Rack::Logger, AppMap::Middleware::RemoteRecording \
-  unless Rails.env.test?