appmap 0.78.0 → 0.80.1

data/lib/appmap/handler.rb

@@ -5,6 +5,9 @@ require 'active_support/inflector/methods'
 module AppMap
   # Specific hook handler classes and general related utilities.
   module Handler
+    TEMPLATE_RENDER_FORMAT = 'appmap.handler.template.return_value_format'
+    TEMPLATE_RENDER_VALUE = 'appmap.handler.template.return_value'
+
     # Try to find handler module with a given name.
     #
     # If the module is not loaded, tries to require the appropriate file

data/lib/appmap/hook/method.rb

@@ -24,7 +24,6 @@ module AppMap
       attr_reader :hook_package, :hook_class, :hook_method, :parameters, :arity
 
       HOOK_DISABLE_KEY = 'AppMap::Hook.disable'
-      private_constant :HOOK_DISABLE_KEY
 
       def initialize(hook_package, hook_class, hook_method)
         @hook_package = hook_package

data/lib/appmap/version.rb

@@ -3,7 +3,7 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.78.0'
+  VERSION = '0.80.1'
 
   APPMAP_FORMAT_VERSION = '1.5.1'
 

data/spec/config_spec.rb

@@ -3,7 +3,7 @@
 require 'rails_spec_helper'
 require 'appmap/config'
 
-describe AppMap::Config, docker: false do
+describe AppMap::Config do
   it 'loads as expected' do
     config_data = {
       name: 'test',

data/spec/depends/api_spec.rb

@@ -33,7 +33,7 @@ module AppMap
       end
     end
   end
-end 
+end
 
 describe 'Depends API' do
   let(:api) { AppMap::Depends::API.new(ENV['DEBUG'] == 'true') }
@@ -112,12 +112,12 @@ describe 'Depends API' do
       around do |test|
         @minitest_test_command_method = AppMap.configuration.depends_config.minitest_test_command_method
         AppMap.configuration.depends_config.minitest_test_command_method = 'AppMap::Depends::APISpec.minitest_test_command'
-  
+
         test.call
       ensure
         AppMap.configuration.depends_config.minitest_test_command_method = @minitest_test_command
       end
-  
+
       it 'passes a smoke test' do
         run_tests
       end
@@ -175,10 +175,18 @@ describe 'Depends API' do
         # At this point, we would run tests to bring the AppMaps up to date
         # Then once the tests have finished, remove any AppMaps that weren't refreshed
         removed = api.remove_out_of_date_appmaps(since, appmap_dir: DEPENDS_TEST_DIR, base_dir: DEPENDS_BASE_DIR)
-        expect(removed).to eq([ appmap_path.split('.')[0] ])  
+        expect(removed).to eq([ appmap_path.split('.')[0] ])
       ensure
-        File.write(appmap_path, appmap)        
+        File.write(appmap_path, appmap)
       end
     end
   end
+
+  before do
+    Dir.glob("#{DEPENDS_TEST_DIR}/*.appmap.json").each { |fname| FileUtils.touch fname }
+    update_appmap_index
+
+    FileUtils.rm_rf 'spec/tmp'
+    FileUtils.mkdir_p 'spec/tmp'
+  end
 end

data/spec/depends/spec_helper.rb

@@ -16,12 +16,3 @@ def update_appmap_index
   system cmd.join(' ') or raise "Failed to update AppMap index in #{DEPENDS_TEST_DIR}"
 end
 
-RSpec.configure do |rspec|
-  rspec.before do
-    Dir.glob("#{DEPENDS_TEST_DIR}/*.appmap.json").each { |fname| FileUtils.touch fname }
-    update_appmap_index
-
-    FileUtils.rm_rf 'spec/tmp'
-    FileUtils.mkdir_p 'spec/tmp'
-  end
-end

data/spec/fixtures/database.yml

@@ -0,0 +1,11 @@
+default: &default
+  url: <%= ENV['DATABASE_URL'] %>
+  adapter: postgresql
+  database: <%= ENV['TEST_DATABASE'] || 'appland-rails6-test' %>
+
+development:
+  <<: *default
+test:
+  <<: *default
+production:
+  <<: *default

data/spec/fixtures/rails5_users_app/config/database.yml

@@ -0,0 +1 @@
+../../database.yml

data/spec/fixtures/rails6_users_app/Gemfile

@@ -11,32 +11,8 @@ gem 'sequel', '>= 5.43.0', require: false
 gem 'sequel-rails', require: false
 gem 'sequel_secure_password', require: false
 
-appmap_path = \
-  # Support debugging inside the container with volume-mounted source
-  if File.directory?('/src/appmap-ruby')
-    '/src/appmap-ruby'
-  elsif File.exist?('../../../appmap.gemspec')
-    '../../..'
-  end
-
-if appmap_path
-  # Set the branch parameter, so that 'bundle config local.appmap' will work
-  appmap_branch = Dir.chdir appmap_path do
-    `git rev-parse --abbrev-ref HEAD`.strip
-  end
-end
-
-appmap_options = \
-  if appmap_path && appmap_branch
-    { git: appmap_path, branch: appmap_branch }
-  elsif appmap_path
-    { path: appmap_path }
-  else
-    {}
-  end.merge(require: %w[appmap])
-
 group :development, :test do
-  gem 'appmap', appmap_options
+  gem 'appmap', path: '../../..'
   gem 'cucumber-rails', require: false
   gem 'rspec-rails'
   # Call 'byebug' anywhere in the code to stop execution and get a debugger console

data/spec/fixtures/rails6_users_app/config/database.yml

@@ -0,0 +1 @@
+../../database.yml

data/spec/fixtures/rails7_users_app/Gemfile

@@ -69,31 +69,7 @@ group :test do
   gem "webdrivers"
 end
 
-appmap_path = \
-  # Support debugging inside the container with volume-mounted source
-  if File.directory?('/src/appmap-ruby')
-    '/src/appmap-ruby'
-  elsif File.exist?('../../../appmap.gemspec')
-    '../../..'
-  end
-
-if appmap_path
-  # Set the branch parameter, so that 'bundle config local.appmap' will work
-  appmap_branch = Dir.chdir appmap_path do
-    `git rev-parse --abbrev-ref HEAD`.strip
-  end
-end
-
-appmap_options = \
-  if appmap_path && appmap_branch
-    { git: appmap_path, branch: appmap_branch }
-  elsif appmap_path
-    { path: appmap_path }
-  else
-    {}
-  end.merge(require: %w[appmap])
-
 group :development, :test do
-  gem 'appmap', appmap_options
+  gem 'appmap', path: '../../..'
   gem 'pry-byebug', '>=0', '< 99'
 end

data/spec/fixtures/rails7_users_app/config/database.yml

@@ -0,0 +1 @@
+../../database.yml

data/spec/handler/eval_spec.rb

@@ -32,7 +32,7 @@ describe 'AppMap::Handler::Eval' do
     expect(events[0]).to match hash_including \
       defined_class: 'Kernel',
       method_id: 'eval',
-      parameters: [{ class: 'Array', kind: :rest, name: 'arg', value: '[12]' }]
+      parameters: [{ class: 'Array', kind: :rest, name: 'arg', size: 1, value: '[12]' }]
   end
 
   # a la Ruby 2.6.3 ruby-token.rb

data/spec/hook_spec.rb

@@ -16,7 +16,7 @@ module ShowYamlNulls
 end
 Psych::Visitors::YAMLTree.prepend(ShowYamlNulls)
 
-describe 'AppMap class Hooking', docker: false do
+describe 'AppMap class Hooking' do
   include_context 'collect events'
 
   def invoke_test_file(file, setup: nil, packages: nil)
@@ -491,6 +491,7 @@ describe 'AppMap class Hooking', docker: false do
         :class: Array
         :value: "[4, 5]"
         :kind: :rest
+        :size: 2
       - :name: :kw1
         :class: String
         :value: one
@@ -503,6 +504,7 @@ describe 'AppMap class Hooking', docker: false do
         :class: Hash
         :value: "{:kw3=>:three}"
         :kind: :keyrest
+        :size: 1
       :receiver:
         :class: InstanceMethod
         :value: Instance Method fixture
@@ -1139,6 +1141,7 @@ describe 'AppMap class Hooking', docker: false do
         :class: Array
         :value: "[foo]"
         :kind: :rest
+        :size: 1
       - :name: :kw1
         :class: String
         :value: kw1
@@ -1151,6 +1154,7 @@ describe 'AppMap class Hooking', docker: false do
         :class: Hash
         :value: "{}"
         :kind: :keyrest
+        :size: 0
       :receiver:
         :class: ReportParameters
         :value: ReportParameters
@@ -1160,6 +1164,7 @@ describe 'AppMap class Hooking', docker: false do
       :return_value:
         :class: Array
         :value: "[[:rest, :args], [:keyreq, :kw1], [:key, :kw2], [:keyrest, :kws]]"
+        :size: 4
     YAML
     parameters = [[:rest, :args], [:keyreq, :kw1], [:key, :kw2], [:keyrest, :kws]]
     test_hook_behavior 'spec/fixtures/hook/report_parameters.rb', events do

data/spec/rails_recording_spec.rb

@@ -15,14 +15,6 @@ describe 'Rails' do
       include_context 'Rails app pg database', "spec/fixtures/rails#{rails_major_version}_users_app" unless use_existing_data?
       include_context 'rails integration test setup'
 
-      def run_spec(spec_name)
-        cmd = <<~CMD.gsub "\n", ' '
-          docker-compose run --rm -e RAILS_ENV=test -e APPMAP=true
-          -v #{File.absolute_path tmpdir}:/app/tmp app ./bin/rspec #{spec_name}
-        CMD
-        run_cmd cmd, chdir: fixture_dir
-      end
-
       describe 'an API route' do
         describe 'creating an object' do
           let(:appmap_json_file) do
@@ -62,7 +54,8 @@ describe 'Rails' do
                 'http_server_response' => hash_including(
                   'status_code' => 201,
                   'headers' => hash_including('Content-Type' => 'application/json; charset=utf-8'),
-                )
+                ),
+                'return_value' => hash_including('class' => 'Hash', 'object_id' => Integer, 'properties' => include({'name' => 'login', 'class' => 'String'})),
               )
             )
           end
@@ -80,6 +73,7 @@ describe 'Rails' do
                 'name' => 'params',
                 'class' => 'ActiveSupport::HashWithIndifferentAccess',
                 'object_id' => Integer,
+                'size' => 1,
                 'value' => '{login=>alice}',
                 'kind' => 'req'
               ),
@@ -123,7 +117,7 @@ describe 'Rails' do
                     )
                   )
                 )
-              )    
+              )
             end
           end
         end
@@ -201,7 +195,7 @@ describe 'Rails' do
                   'path_info' => '/users/alice',
                   'normalized_path_info' => '/users/{id}',
                   'headers' => {
-                    'Host' => 'test.host', 
+                    'Host' => 'test.host',
                     'User-Agent' => 'Rails Testing'
                   }
                 }
@@ -236,7 +230,7 @@ describe 'Rails' do
               'defined_class' => 'inline_template',
               'method_id' => 'render'
             )
-  
+
             expect(appmap['classMap']).to include hash_including(
               'name' => 'actionview',
               'children' => include(hash_including(
@@ -251,7 +245,7 @@ describe 'Rails' do
                 ))
               ))
             )
-          end  
+          end
         end
       end
     end
@@ -261,14 +255,6 @@ describe 'Rails' do
     include_context 'Rails app pg database', "spec/fixtures/rails6_users_app" unless use_existing_data?
     include_context 'rails integration test setup'
 
-    def run_spec(spec_name)
-      cmd = <<~CMD.gsub "\n", ' '
-        docker-compose run --rm -e RAILS_ENV=test -e APPMAP=true -e APPMAP_CONFIG_FILE=no/such/file
-        -v #{File.absolute_path tmpdir}:/app/tmp app ./bin/rspec #{spec_name}
-      CMD
-      run_cmd cmd, chdir: fixture_dir
-    end
-
     let(:appmap_json_file) do
       'Api_UsersController_POST_api_users_with_required_parameters_creates_a_user.appmap.json'
     end

data/spec/rails_spec_helper.rb

@@ -1,93 +1,106 @@
 # frozen_string_literal: true
 
+require 'open3'
+
 require 'spec_helper'
 require 'active_support'
 require 'active_support/core_ext'
-require 'open3'
 
-# The RUBY_VERSION global variable indicates the version of the
-# runtime. The RUBY_VERSION environment variable is the version we're
-# testing, so it needs to be used to pick a fixture directory.
 def testing_ruby_2?
-  ENV['RUBY_VERSION'].split('.')[0].to_i == 2
+  RUBY_VERSION.split('.')[0].to_i == 2
 end
 
-# docker compose v2 replaced the --filter flag with --status
-PS_CMD=`docker-compose --version` =~ /version v2/ ?
-         "docker-compose ps -q --status running" :
-         "docker-compose ps -q --filter health=healthy"
+class TestRailsApp
+  def initialize(fixture_dir)
+    @fixture_dir = fixture_dir
+  end
 
-def wait_for_container(app_name)
-  start_time = Time.now
-  until `#{PS_CMD} #{app_name}`.strip != ''
-    elapsed = Time.now - start_time
-    raise "Timeout waiting for container #{app_name} to be ready" if elapsed > 10
+  attr_reader :fixture_dir
 
-    $stderr.write '.' if elapsed > 3
-    sleep 0.25
+  def run_cmd(cmd, env = {})
+    run_process method(:system), cmd, env, exception: true
   end
-end
 
-def run_cmd(*cmd, &failed)
-  out, status = Open3.capture2e(*cmd)
-  return [ out, status ] if status.success?
-
-  warn <<~WARNING
-    Command failed:
-    #{cmd}
-    <<< Output:
-    #{out}
-    >>> End of output
-  WARNING
-  failed&.call
-  raise 'Command failed'
-end
+  def spawn_cmd(cmd, env = {})
+    puts "Spawning `#{cmd}` in #{fixture_dir}..."
+    run_process Process.method(:spawn), cmd, env
+  end
 
-shared_context 'Rails app pg database' do |fixture_dir|
-  define_method(:fixture_dir) { fixture_dir }
+  def capture_cmd(cmd, env = {})
+    puts "Capturing `#{cmd}` in #{fixture_dir}..."
+    run_process(Open3.method(:capture2), cmd, env).first
+  end
 
-  before(:all) do
-    print_pg_logs = lambda do
-      logs, = run_cmd 'docker-compose logs pg'
-      puts "docker-compose logs for pg:"
-      puts
-      puts logs
-    end
+  def database_name
+    # This is used locally too, so make the name nice and unique.
+    @database_name ||= "appland-rails-test-#{Random.bytes(8).unpack1('h*')}"
+  end
 
-    Dir.chdir fixture_dir do
-      run_cmd 'docker-compose down -v'
-      cmd = 'docker-compose up -d pg'
-      run_cmd cmd
-      wait_for_container 'pg'
+  def bundle
+    return if @bundled
 
-      cmd = 'docker-compose run --rm app ./create_app'
-      run_cmd cmd, &print_pg_logs
-    end
+    run_cmd 'bundle'
+    @bundled = true
   end
 
-  after(:all) do
-    if ENV['NOKILL'] != 'true'
-      cmd = 'docker-compose down -v'
-      run_cmd cmd, chdir: fixture_dir
-    end
+  def prepare_db
+    return if @db_prepared
+
+    bundle
+    run_cmd './bin/rake db:create db:schema:load'
+    @db_prepared = true
+    at_exit { drop_db }
+  end
+
+  def drop_db
+    return unless @db_prepared
+
+    run_cmd './bin/rake db:drop'
+    @db_prepared = false
   end
-end
 
-shared_context 'rails integration test setup' do
   def tmpdir
-    'tmp/spec/AbstractControllerBase'
+    @tmpdir ||= File.join(fixture_dir, 'tmp')
+  end
+
+  def run_specs
+    return if @specs_ran or use_existing_data?
+
+    prepare_db
+    FileUtils.rm_rf tmpdir
+    run_cmd \
+      './bin/rspec spec/controllers/users_controller_spec.rb spec/controllers/users_controller_api_spec.rb',
+      'APPMAP' => 'true'
+    @specs_ran = true
+  end
+
+  def self.for_fixture(fixture_dir)
+    @apps ||= {}
+    @apps[fixture_dir] ||= TestRailsApp.new fixture_dir
   end
 
-  unless use_existing_data?
-    before(:all) do
-      FileUtils.rm_rf tmpdir
-      FileUtils.mkdir_p tmpdir
-      run_spec 'spec/controllers/users_controller_spec.rb'
-      run_spec 'spec/controllers/users_controller_api_spec.rb'
+  protected
+
+  def run_process(method, cmd, env, options = {})
+    Bundler.with_clean_env do
+      method.call \
+        env.merge('TEST_DATABASE' => database_name),
+        cmd,
+        options.merge(chdir: fixture_dir)
     end
   end
+end
+
+shared_context 'Rails app pg database' do |dir|
+  before(:all) { @app = TestRailsApp.for_fixture dir }
+  let(:app) { @app }
+end
+
+shared_context 'rails integration test setup' do
+  let(:tmpdir) { app.tmpdir }
+
+  before(:all) { @app.run_specs } unless use_existing_data?
 
-  let(:appmap) { JSON.parse File.read File.join tmpdir, 'appmap/rspec', appmap_json_file }
   let(:appmap_json_path) { File.join(tmpdir, 'appmap/rspec', appmap_json_file) }
   let(:appmap) { JSON.parse File.read(appmap_json_path) }
   let(:events) { appmap['events'] }

data/spec/rails_test_spec.rb

@@ -3,7 +3,7 @@ require 'rails_spec_helper'
 # Rails5 doesn't work with Ruby 3.x, Rails 7 doesn't work with Ruby < 2.7.
 def default_rails_versions
   if testing_ruby_2?
-    if Gem::Requirement.create('>= 2.7') =~ Gem::Version.new(ENV['RUBY_VERSION'])
+    if Gem::Requirement.create('>= 2.7') =~ Gem::Version.new(RUBY_VERSION)
       [ 5, 6, 7 ]
     else
       [ 5, 6 ]
@@ -21,24 +21,14 @@ describe 'Rails' do
   rails_versions.each do |rails_major_version| # rubocop:disable Metrics/BlockLength
     context "#{rails_major_version}" do
       include_context 'Rails app pg database', "spec/fixtures/rails#{rails_major_version}_users_app" unless use_existing_data?
-      def tmpdir
-        'tmp/spec/rails_test_spec'
-      end
-      before(:all) do
-        FileUtils.rm_rf tmpdir
-        FileUtils.mkdir_p tmpdir
-      end
-
-      def run_tests
-        cmd = <<~CMD.gsub "\n", ' '
-          docker-compose run --rm -e RAILS_ENV=test -e APPMAP=true -e TEST_OPTS=--verbose
-          -v #{File.absolute_path tmpdir}:/app/tmp app bundle exec rake
-        CMD
-        run_cmd cmd, chdir: fixture_dir
-      end
 
       it 'runs tests with APPMAP=true' do
-        run_tests
+        app.prepare_db
+        app.run_cmd \
+          'bundle exec rake',
+          'RAILS_ENV' => 'test',
+          'APPMAP' => 'true',
+          'TEST_OPTS' => '--verbose'
       end
     end
   end

data/spec/railtie_spec.rb

@@ -1,27 +1,13 @@
 require 'rails_spec_helper'
 
 describe 'AppMap tracer via Railtie' do
-  include_context 'Rails app pg database', 'spec/fixtures/rails6_users_app' do 
+  include_context 'Rails app pg database', 'spec/fixtures/rails6_users_app' do
     let(:env) { {} }
 
-    let(:cmd) { %(docker-compose run --rm -e RAILS_ENV=development -e APPMAP app ./bin/rails r "puts AppMap.instance_variable_get('@configuration').nil?") }
-    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 rails6_users_app container
-            <<< Output:
-            #{result[0]}
-            #{result[1]}
-            >>> End of output
-          STDERR
-          raise 'Failed to run rails6_users_app container'
-        end
-      end
+    let(:command_output) do
+      app.prepare_db
+      app.capture_cmd(%{./bin/rails r "puts AppMap.instance_variable_get('@configuration').nil?"}, env).strip
     end
-    let(:command_output) { command_capture2[0].strip }
-    let(:command_result) { command_capture2[2] }
 
     describe 'with APPMAP=false' do
       let(:env) { { 'APPMAP' => 'false' } }