appmap 0.48.2 → 0.51.2

data/lib/appmap/trace.rb

@@ -2,10 +2,12 @@
 
 module AppMap
   module Trace
-    class RubyMethod
+    class RubyMethod < SimpleDelegator
       attr_reader :class_name, :static
 
       def initialize(package, class_name, method, static)
+        super(method)
+
         @package = package
         @class_name = class_name
         @method = method
@@ -111,7 +113,7 @@ module AppMap
       @last_package_for_thread[Thread.current.object_id] = package if package
       @events << event
       static = event.static if event.respond_to?(:static)
-      @methods << Trace::RubyMethod.new(package, defined_class, method, static) \
+      record_method Trace::RubyMethod.new(package, defined_class, method, static) \
         if package && defined_class && method && (event.event == :call)
     end
 

data/lib/appmap/util.rb

@@ -4,6 +4,21 @@ require 'bundler'
 
 module AppMap
   module Util
+    # https://wynnnetherland.com/journal/a-stylesheet-author-s-guide-to-terminal-colors/
+    # Embed in a String to clear all previous ANSI sequences.
+    CLEAR   = "\e[0m"
+    BOLD    = "\e[1m"
+
+    # Colors
+    BLACK   = "\e[30m"
+    RED     = "\e[31m"
+    GREEN   = "\e[32m"
+    YELLOW  = "\e[33m"
+    BLUE    = "\e[34m"
+    MAGENTA = "\e[35m"
+    CYAN    = "\e[36m"
+    WHITE   = "\e[37m"
+
     class << self
       # scenario_filename builds a suitable file name from a scenario name.
       # Special characters are removed, and the file name is truncated to fit within
@@ -128,6 +143,12 @@ module AppMap
           FileUtils.mv tempfile.path, filename
         end
       end
+
+      def color(text, color, bold: false)
+        color = Util.const_get(color.to_s.upcase) if color.is_a?(Symbol)
+        bold  = bold ? BOLD : ""
+        "#{bold}#{color}#{text}#{CLEAR}"
+      end
     end
   end
 end

data/lib/appmap/version.rb

@@ -3,7 +3,10 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.48.2'
+  VERSION = '0.51.2'
 
   APPMAP_FORMAT_VERSION = '1.5.1'
+
+  DEFAULT_APPMAP_DIR = 'tmp/appmap'.freeze
+  DEFAULT_CONFIG_FILE_PATH = 'appmap.yml'.freeze
 end

data/spec/abstract_controller_base_spec.rb

@@ -1,9 +1,30 @@
 require 'rails_spec_helper'
 
 describe 'Rails' do
+  shared_context 'rails integration test setup' do
+    def tmpdir
+      'tmp/spec/AbstractControllerBase'
+    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'
+      end
+    end
+
+    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'] }
+  end
+
   %w[5 6].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?
+      include_context 'rails integration test setup'
 
       def run_spec(spec_name)
         cmd = <<~CMD.gsub "\n", ' '
@@ -13,24 +34,6 @@ describe 'Rails' do
         run_cmd cmd, chdir: fixture_dir
       end
 
-      def tmpdir
-        'tmp/spec/AbstractControllerBase'
-      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'
-        end
-      end
-
-      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'] }
-
       describe 'an API route' do
         describe 'creating an object' do
           let(:appmap_json_file) do
@@ -253,4 +256,40 @@ describe 'Rails' do
       end
     end
   end
+
+  describe 'with default appmap.yml' do
+    include_context 'Rails app pg database', "spec/fixtures/rails5_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
+
+    it 'http_server_request is recorded' do
+      expect(events).to include(
+        hash_including(
+          'http_server_request' => hash_including(
+            'request_method' => 'POST',
+            'path_info' => '/api/users'
+          )
+        )
+      )
+    end
+
+    it 'controller method is recorded' do
+      expect(events).to include hash_including(
+        'defined_class' => 'Api::UsersController',
+        'method_id' => 'build_user',
+        'path' => 'app/controllers/api/users_controller.rb',
+      )
+    end
+  end
 end

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/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

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/cli_test.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class CLITest < Minitest::Test
+  CONFIG_FILENAME = '123.yml'
+  SUBFOLDER_CONFIG_FILEPATH = 'conf/123.yml'
+  EXPECTED_CONFIG_CONTENT = %(name: appmap-ruby
+packages:
+- path: lib
+)
+
+  def test_init_when_config_exists
+    output = `./exe/appmap-agent-setup init`
+    assert_equal 0, $CHILD_STATUS.exitstatus
+    assert_includes output, 'The AppMap config file appmap.yml already exists.'
+  end
+
+  def test_init_with_custom_config_filename
+    output = `./exe/appmap-agent-setup -c #{CONFIG_FILENAME} init`
+    assert_equal 0, $CHILD_STATUS.exitstatus
+    assert_includes output, "The following AppMap config file #{CONFIG_FILENAME} has been created:"
+    assert_equal EXPECTED_CONFIG_CONTENT, File.read(CONFIG_FILENAME)
+  ensure
+    File.delete(CONFIG_FILENAME) if File.exist?(CONFIG_FILENAME)
+  end
+
+  def test_init_with_custom_config_file_in_subfolder
+    output = `./exe/appmap-agent-setup -c #{SUBFOLDER_CONFIG_FILEPATH} init`
+    assert_equal 0, $CHILD_STATUS.exitstatus
+    assert_includes output, "The following AppMap config file #{SUBFOLDER_CONFIG_FILEPATH} has been created:"
+    assert_equal EXPECTED_CONFIG_CONTENT, File.read(SUBFOLDER_CONFIG_FILEPATH)
+  ensure
+    File.delete(SUBFOLDER_CONFIG_FILEPATH) if File.exist?(SUBFOLDER_CONFIG_FILEPATH)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.48.2
+  version: 0.51.2
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2021-05-26 00:00:00.000000000 Z
+date: 2021-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -307,7 +307,8 @@ dependencies:
 description: 
 email:
 - kgilpin@gmail.com
-executables: []
+executables:
+- appmap-agent-setup
 extensions:
 - ext/appmap/extconf.rb
 extra_rdoc_files: []
@@ -335,12 +336,14 @@ files:
 - examples/mock_webapp/lib/mock_webapp/controller.rb
 - examples/mock_webapp/lib/mock_webapp/request.rb
 - examples/mock_webapp/lib/mock_webapp/user.rb
+- exe/appmap-agent-setup
 - ext/appmap/appmap.c
 - ext/appmap/extconf.rb
 - lib/appmap.rb
 - lib/appmap/algorithm/prune_class_map.rb
 - lib/appmap/algorithm/stats.rb
 - lib/appmap/class_map.rb
+- lib/appmap/command/init.rb
 - lib/appmap/command/record.rb
 - lib/appmap/command/stats.rb
 - lib/appmap/config.rb
@@ -360,6 +363,7 @@ files:
 - lib/appmap/railtie.rb
 - lib/appmap/record.rb
 - lib/appmap/rspec.rb
+- lib/appmap/service/guesser.rb
 - lib/appmap/trace.rb
 - lib/appmap/util.rb
 - lib/appmap/version.rb
@@ -455,7 +459,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 +530,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
@@ -558,6 +560,7 @@ files:
 - spec/spec_helper.rb
 - spec/util_spec.rb
 - test/bundle_vendor_test.rb
+- test/cli_test.rb
 - test/cucumber_test.rb
 - test/expectations/openssl_test_key_sign1.json
 - test/expectations/openssl_test_key_sign2.json

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?