appmap 0.54.4 → 0.58.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13450fa6c0ff3576dc48e27f35355e3eb4bd4ed70aac677af1235b8b8b8ce793
-  data.tar.gz: 2c08a504d3e6a467d212630290205ecab9391c64a33831574df43cb8526ab0ad
+  metadata.gz: ca5a16a5edc35706d33aa6ec21e45b5641aa9342b6fc5ab03ada141556c2b859
+  data.tar.gz: 7a4b5b6ff0c504814b7eccebba46a739cc4e00fcf6eb1e5492ef7f52d2f887d6
 SHA512:
-  metadata.gz: 49585b5fba1c9b7a0aabffd6dfc44fb051532fd9fe96d35a0176c6bcf382a51df948bfac8f1f0d3db474917f5587dbf07e90de9c9097d3de9a1650a1632f8fd6
-  data.tar.gz: aa489a3dc598dfc2c16ee3a6167e53683e5564870c3b1ed0552e9e0ba0d758da2d1c442059bee3efbe57206f9088a98ca7c271d8550f52ed5d18d0aa2a039635
+  metadata.gz: 5267e3ba0827671d825ca0bb0323965ae0d8b5c0ac772f95721227af2b66a3a2d2843f7813a4f1faff997e49cd83dc4b7d78a57cb3b4852cfd6fbe63290aa223
+  data.tar.gz: cdb60a38a5d9c836a159c9473a7bf42e06589926ec7011b5978add71dca14ef6fd8acc807d7ef745e3d17ab908e38eca49bfbb3094c5b48a97d4084d9a2f34d8

data/CHANGELOG.md

@@ -1,3 +1,47 @@
+# [0.58.0](https://github.com/applandinc/appmap-ruby/compare/v0.57.1...v0.58.0) (2021-07-06)
+
+
+### Features
+
+* Add `test_commands` sections to `appmap-agent-status` executable ([4cd8fe5](https://github.com/applandinc/appmap-ruby/commit/4cd8fe58acb4af72b7818db96de9e479562b9ea0))
+
+## [0.57.1](https://github.com/applandinc/appmap-ruby/compare/v0.57.0...v0.57.1) (2021-07-02)
+
+
+### Bug Fixes
+
+* rename agentVersionPorject to agentVersion ([905fc5d](https://github.com/applandinc/appmap-ruby/commit/905fc5dd643411deb94f8a1087bcdb3a562d218a))
+
+# [0.57.0](https://github.com/applandinc/appmap-ruby/compare/v0.56.0...v0.57.0) (2021-06-29)
+
+
+### Features
+
+* Update init command to return JSON ([1f93e89](https://github.com/applandinc/appmap-ruby/commit/1f93e8909684e1018f513d69adfde2a5d0bf6bc9))
+
+# [0.56.0](https://github.com/applandinc/appmap-ruby/compare/v0.55.0...v0.56.0) (2021-06-28)
+
+
+### Features
+
+* add appmap-agent-status executable with config/project properties ([043f845](https://github.com/applandinc/appmap-ruby/commit/043f8453a2533a6e172d1cd23fcde04f19e73173))
+
+# [0.55.0](https://github.com/applandinc/appmap-ruby/compare/v0.54.4...v0.55.0) (2021-06-28)
+
+
+### Bug Fixes
+
+* Avoid calling == ([f30ed9f](https://github.com/applandinc/appmap-ruby/commit/f30ed9f309753252df35e372d925db3b914260d4))
+* Log dynamic loading of appmap helpers at info level ([15dcd3c](https://github.com/applandinc/appmap-ruby/commit/15dcd3c913fa1c32aea034b28ddae59668efa217))
+* Remove dynamic loading of rake and rspec helpers ([6790970](https://github.com/applandinc/appmap-ruby/commit/67909702f3c8a52081ef1e23a87c292908883334))
+
+
+### Features
+
+* APPMAP_PROFILE_DISPLAY_STRING and APPMAP_OBJECT_STRING ([3f5daa8](https://github.com/applandinc/appmap-ruby/commit/3f5daa890bfbfd39b7f825794d0c43da509b3201))
+* Package name to require can be specified when hooking a gem ([fcc5eb6](https://github.com/applandinc/appmap-ruby/commit/fcc5eb691a0330444560eb4c2afe7fc3c4c8afa8))
+* Profile packaging hooking ([c020a31](https://github.com/applandinc/appmap-ruby/commit/c020a312f4545348ec7cc302443269c57a7fc026))
+
 ## [0.54.4](https://github.com/applandinc/appmap-ruby/compare/v0.54.3...v0.54.4) (2021-06-27)
 
 

data/exe/appmap-agent-init

@@ -5,10 +5,10 @@ require 'optparse'
 require 'appmap'
 require 'appmap/command/agent_setup/init'
 
-@options = {:config_file => AppMap::DEFAULT_CONFIG_FILE_PATH}
+@options = { config_file: AppMap::DEFAULT_CONFIG_FILE_PATH }
 
 OptionParser.new do |parser|
-  parser.banner = 'Usage: bundle exec exe/appmap-agent-init [options]'
+  parser.banner = 'Usage: appmap-agent-init [options]'
 
   description = "AppMap configuration file path (default: #{AppMap::DEFAULT_CONFIG_FILE_PATH})"
   parser.on('-c', '--config=FILEPATH', description) do |filepath|

data/exe/appmap-agent-status

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'optparse'
+require 'appmap'
+require 'appmap/command/agent_setup/status'
+
+@options = { config_file: AppMap::DEFAULT_CONFIG_FILE_PATH }
+
+OptionParser.new do |parser|
+  parser.banner = 'Usage: appmap-agent-status [options]'
+
+  description = "AppMap configuration file path (default: #{AppMap::DEFAULT_CONFIG_FILE_PATH})"
+  parser.on('-c', '--config=FILEPATH', description) do |filepath|
+    @options[:config_file] = filepath
+  end
+end.parse!
+
+AppMap::Command::AgentSetup::Status.new(@options[:config_file]).perform

data/lib/appmap.rb

@@ -28,11 +28,9 @@ lambda do
   INITIALIZERS = {
     # In a Rails app, Rails is always defined by the time the other gems are loaded. Therefore, we
     # don't try and trap the loading of Rails itself here.
-    'RSpec' => Initializer.new('AppMap::RSpec', 'appmap/rspec', 'rspec-core'),
+    # Emperically, Rake and RSpec are also defined before appmap is loaded whenever a Rake task or
+    # RSpec tests are being run. Therefore, the only hook we need here is Minitest.
     'Minitest::Unit::TestCase' => Initializer.new('AppMap::Minitest', 'appmap/minitest', 'minitest'),
-    'Rake' => [
-      Initializer.new('AppMap::Swagger', 'appmap/swagger', 'rake')
-    ]
   }
 
   TracePoint.new(:class) do |tp|

data/lib/appmap/command/agent_setup/init.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
-require 'fileutils'
+require 'json'
 require 'appmap/service/guesser'
-require 'appmap/util'
 
 module AppMap
   module Command
@@ -11,32 +10,19 @@ module AppMap
 
       class Init < InitStruct
         def perform
-          if File.exist?(config_file)
-            puts AppMap::Util.color(%(The AppMap config file #{config_file} already exists.), :magenta)
-            return
-          end
-
-          ensure_directory_exists
-
           config = {
             'name' => Service::Guesser.guess_name,
             'packages' => Service::Guesser.guess_paths.map { |path| { 'path' => path } }
           }
-          content = YAML.dump(config).gsub("---\n", '')
 
-          File.write(config_file, content)
-          puts AppMap::Util.color(
-            %(The following AppMap config file #{config_file} has been created:),
-            :green
-          )
-          puts content
-        end
-
-        private
+          result = {
+            configuration: {
+              filename: config_file,
+              contents: YAML.dump(config)
+            }
+          }
 
-        def ensure_directory_exists
-          dirname = File.dirname(config_file)
-          FileUtils.mkdir_p(dirname) unless File.directory?(dirname)
+          puts JSON.pretty_generate(result)
         end
       end
     end

data/lib/appmap/command/agent_setup/status.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'appmap/service/config_analyzer'
+require 'appmap/service/integration_test_path_finder'
+require 'appmap/service/test_command_provider'
+
+module AppMap
+  module Command
+    module AgentSetup
+      StatusStruct = Struct.new(:config_file)
+
+      class Status < StatusStruct
+        def perform
+          status = {
+            test_commands: Service::TestCommandProvider.all,
+            properties: {
+              config: {
+                app: config_analyzer.app_name,
+                present: config_analyzer.present?,
+                valid: config_analyzer.valid?
+              },
+              project: {
+                agentVersion: AppMap::VERSION,
+                language: 'ruby',
+                remoteRecordingCapable: Gem.loaded_specs.has_key?('rails'),
+                integrationTests: Service::IntegrationTestPathFinder.count_paths > 0
+              }
+            }
+          }
+
+          puts JSON.pretty_generate(status)
+        end
+
+        private
+
+        def config_analyzer
+          @config_analyzer ||= Service::ConfigAnalyzer.new(config_file)
+        end
+      end
+    end
+  end
+end

data/lib/appmap/config.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'set'
 require 'yaml'
 require 'appmap/util'
 require 'appmap/handler/net_http'
@@ -343,7 +344,7 @@ module AppMap
                 shallow = package['shallow']
                 # shallow is true by default for gems
                 shallow = true if shallow.nil?
-                Package.build_from_gem(gem, exclude: package['exclude'] || [], shallow: shallow)
+                Package.build_from_gem(gem, package_name: package['package'], exclude: package['exclude'] || [], shallow: shallow)
               else
                 Package.build_from_path(path, exclude: package['exclude'] || [], shallow: package['shallow'])
               end

data/lib/appmap/event.rb

@@ -29,11 +29,31 @@ module AppMap
 
         # Gets a display string for a value. This is not meant to be a machine deserializable value.
         def display_string(value)
-          return nil unless value
+          return nil if value.equal?(nil)
 
+          # With setting APPMAP_PROFILE_DISPLAY_STRING, stringifying this class is shown to take 9 seconds(!) of a 17 second test run.
+          return nil if best_class_name(value) == 'ActiveSupport::Callbacks::Filters::Environment'
+
+          if @times.nil? && ENV['APPMAP_PROFILE_DISPLAY_STRING'] == 'true'
+            @times = Hash.new {|memo,key| memo[key] = 0}
+            Thread.new do
+              sleep 0.5
+              while true
+                warn @times.to_a.sort{|a,b| b[1] <=> a[1]}[0..9].join("\n")
+                sleep 3
+              end
+            end
+          end
+
+          start = Time.now
           value_string = custom_display_string(value) || default_display_string(value)
 
-          (value_string||'')[0...LIMIT].encode('utf-8', invalid: :replace, undef: :replace, replace: '_')
+          if @times
+            elapsed = Time.now - start
+            @times[best_class_name(value)] += elapsed
+          end
+
+          encode_dislay_string(value_string)
         end
 
         def object_properties(hash_like)
@@ -57,8 +77,16 @@ module AppMap
           value_cls.name
         end
 
+        def encode_dislay_string(value)
+          (value||'')[0...LIMIT].encode('utf-8', invalid: :replace, undef: :replace, replace: '_')
+        end
+
         def custom_display_string(value)
           case value
+          when NilClass, TrueClass, FalseClass, Numeric, Time, Date
+            value.to_s
+          when String
+            value[0...LIMIT].encode('utf-8', invalid: :replace, undef: :replace, replace: '_')
           when File
             "#{value.class}[path=#{value.path}]"
           when Net::HTTP
@@ -71,6 +99,8 @@ module AppMap
         end
 
         def default_display_string(value)
+          return nil if ENV['APPMAP_OBJECT_STRING'] == 'false'
+
           last_resort_string = lambda do
             warn "AppMap encountered an error inspecting a #{value.class.name}: #{$!.message}"
             '*Error inspecting variable*'

data/lib/appmap/hook.rb

@@ -9,6 +9,7 @@ module AppMap
 
     OBJECT_INSTANCE_METHODS = %i[! != !~ <=> == === =~ __id__ __send__ class clone define_singleton_method display dup enum_for eql? equal? extend freeze frozen? hash inspect instance_eval instance_exec instance_of? instance_variable_defined? instance_variable_get instance_variable_set instance_variables is_a? itself kind_of? method methods nil? object_id private_methods protected_methods public_method public_methods public_send remove_instance_variable respond_to? send singleton_class singleton_method singleton_methods taint tainted? tap then to_enum to_s to_h to_a trust untaint untrust untrusted? yield_self].freeze
     OBJECT_STATIC_METHODS = %i[! != !~ < <= <=> == === =~ > >= __id__ __send__ alias_method allocate ancestors attr attr_accessor attr_reader attr_writer autoload autoload? class class_eval class_exec class_variable_defined? class_variable_get class_variable_set class_variables clone const_defined? const_get const_missing const_set constants define_method define_singleton_method deprecate_constant display dup enum_for eql? equal? extend freeze frozen? hash include include? included_modules inspect instance_eval instance_exec instance_method instance_methods instance_of? instance_variable_defined? instance_variable_get instance_variable_set instance_variables is_a? itself kind_of? method method_defined? methods module_eval module_exec name new nil? object_id prepend private_class_method private_constant private_instance_methods private_method_defined? private_methods protected_instance_methods protected_method_defined? protected_methods public_class_method public_constant public_instance_method public_instance_methods public_method public_method_defined? public_methods public_send remove_class_variable remove_instance_variable remove_method respond_to? send singleton_class singleton_class? singleton_method singleton_methods superclass taint tainted? tap then to_enum to_s trust undef_method untaint untrust untrusted? yield_self].freeze
+    SLOW_PACKAGE_THRESHOLD = 0.05
 
     @unbound_method_arity = ::UnboundMethod.instance_method(:arity)
     @method_arity = ::Method.instance_method(:arity)
@@ -49,6 +50,27 @@ module AppMap
       @notrace_paths = Set.new
       # Locations that have already been visited.
       @trace_locations = Set.new
+      @module_load_times = Hash.new {|memo,k| memo[k] = 0}
+      @slow_packages = Set.new
+
+      if ENV['APPMAP_PROFILE_HOOK'] == 'true'
+        Thread.new do
+          sleep 1
+          while true
+            @module_load_times
+              .keys
+              .select { |key| !@slow_packages.member?(key) }
+              .each do |key|
+              elapsed = @module_load_times[key]
+              if elapsed >= SLOW_PACKAGE_THRESHOLD
+                @slow_packages.add(key)
+                warn "AppMap: Package #{key} took #{@module_load_times[key]} seconds to hook"
+              end
+            end
+            sleep 5
+          end
+        end
+      end
 
       @trace_end = TracePoint.new(:end, &method(:trace_end))
       @trace_end.enable(&block)
@@ -157,6 +179,7 @@ module AppMap
         end
       end
 
+      start = Time.now
       instance_methods.each(&hook.(cls))
       begin
         # NoMethodError: private method `singleton_class' called for Rack::MiniProfiler:Class
@@ -166,6 +189,11 @@ module AppMap
         #   uninitialized constant Faraday::Connection
         warn "NameError in #{__FILE__}: #{$!.message}"
       end
+      elapsed = Time.now - start
+      if location.index(Bundler.bundle_path.to_s) == 0
+        package_tokens = location[Bundler.bundle_path.to_s.length + 1..-1].split('/')
+        @module_load_times[package_tokens[1]] += elapsed
+      end
     end
   end
 end

data/lib/appmap/hook/method.rb

@@ -49,9 +49,14 @@ module AppMap
 
         hook_method_def = Proc.new do |*args, &block|
           instance_method = hook_method.bind(self).to_proc
+
+          is_array_containing_empty_hash = ->(obj) {
+            obj.is_a?(Array) && obj.length == 1 && obj[0].is_a?(Hash) && obj[0].size == 0
+          }
+
           call_instance_method = -> {
             # https://github.com/applandinc/appmap-ruby/issues/153
-            if Util.ruby_minor_version >= 2.7 && args == ARRAY_OF_EMPTY_HASH && hook_method.arity == 1
+            if Util.ruby_minor_version >= 2.7 && is_array_containing_empty_hash.(args) && hook_method.arity == 1
               instance_method.call({}, &block)
             else
               instance_method.call(*args, &block)

data/lib/appmap/service/config_analyzer.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module AppMap
+  module Service
+    class ConfigAnalyzer
+      attr_reader :config_error
+
+      def initialize(config_file)
+        @config_file = config_file
+        @config = load_config
+      end
+
+      def app_name
+        @config.to_h[:name] if present?
+      end
+
+      def present?
+        File.exist?(@config_file)
+      end
+
+      def valid?
+        present? && @config.to_h.key?(:name) && @config.to_h.key?(:packages)
+      end
+
+      private
+
+      def load_config
+        AppMap::Config.load_from_file @config_file if present?
+      rescue
+        nil
+      end
+    end
+  end
+end

data/lib/appmap/service/integration_test_path_finder.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'appmap/service/test_framework_detector'
+
+module AppMap
+  module Service
+    class IntegrationTestPathFinder
+      class << self
+        def find
+          @paths ||= begin
+            paths = { rspec: [], minitest: [], cucumber: [] }
+            paths[:rspec] = find_rspec_paths if TestFrameworkDetector.rspec_present?
+            paths[:minitest] = find_minitest_paths if TestFrameworkDetector.minitest_present?
+            paths[:cucumber] = find_cucumber_paths if TestFrameworkDetector.cucumber_present?
+            paths
+          end
+        end
+
+        def count_paths
+          find.flatten(2).length - 3
+        end
+
+        private
+
+        def find_rspec_paths
+          find_non_empty_paths(%w[spec/controllers spec/requests spec/integration spec/api spec/features spec/system])
+        end
+
+
+        def find_minitest_paths
+          find_non_empty_paths(%w[test/controllers test/integration])
+        end
+
+        def find_cucumber_paths
+          find_non_empty_paths(%w[features])
+        end
+
+        def find_non_empty_paths(paths)
+          paths.select { |path| Dir.exist?(path) && !Dir.empty?(path) }
+        end
+      end
+    end
+  end
+end

data/lib/appmap/service/test_command_provider.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'appmap/service/test_framework_detector'
+require 'appmap/service/integration_test_path_finder'
+
+module AppMap
+  module Service
+    class TestCommandProvider
+      class << self
+        def all
+          commands = []
+
+          if TestFrameworkDetector.rspec_present? && !integration_test_paths[:rspec].empty?
+            commands << {
+              framework: :rspec,
+              command: "APPMAP=true bundle exec rspec #{integration_test_paths[:rspec].join(' ')}"
+            }
+          end
+
+          if TestFrameworkDetector.minitest_present? && !integration_test_paths[:minitest].empty?
+            commands << {
+              framework: :minitest,
+              command: minitest_command
+            }
+          end
+
+          if TestFrameworkDetector.cucumber_present? && !integration_test_paths[:cucumber].empty?
+            commands << {
+              framework: :cucumber,
+              command: 'APPMAP=true bundle exec cucumber'
+            }
+          end
+
+          commands
+        end
+
+        private
+
+        def minitest_command
+          if Gem.loaded_specs.has_key?('rails')
+            "APPMAP=true bundle exec rails test #{integration_test_paths[:minitest].join(' ')}"
+          else
+            subcommands = integration_test_paths[:minitest].map { |path| "APPMAP=true bundle exec ruby #{path}" }
+            subcommands.join(' && ')
+          end
+        end
+
+        def integration_test_paths
+          @paths ||= Service::IntegrationTestPathFinder.find
+        end
+      end
+    end
+  end
+end

data/lib/appmap/service/test_framework_detector.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module AppMap
+  module Service
+    class TestFrameworkDetector
+      class << self
+        def rspec_present?
+          Gem.loaded_specs.has_key?('rspec-core')
+        end
+
+        def minitest_present?
+          Gem.loaded_specs.has_key?('minitest')
+        end
+
+        def cucumber_present?
+          Gem.loaded_specs.has_key?('cucumber')
+        end
+      end
+    end
+  end
+end

data/lib/appmap/util.rb

@@ -185,7 +185,7 @@ module AppMap
 
       def startup_message(msg)
         if defined?(::Rails) && defined?(::Rails.logger) && ::Rails.logger
-          ::Rails.logger.debug msg
+          ::Rails.logger.info msg
         elsif ENV['DEBUG'] == 'true'
           warn msg
         end

data/lib/appmap/version.rb

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

data/spec/fixtures/config/incomplete_config.yml

@@ -0,0 +1 @@
+name: app

data/spec/fixtures/config/invalid_config.yml

@@ -0,0 +1,2 @@
+name: -123- %
+packages: ~{}~ ''

data/spec/fixtures/config/valid_config.yml

@@ -0,0 +1,3 @@
+name: appmap
+packages:
+  - path: app/models

data/spec/fixtures/rails6_users_app/test/controllers/functional_calc_test.rb

@@ -0,0 +1,10 @@
+# minitest_calc_test_unit_format_spec.rb
+
+require "minitest/autorun"
+
+class FunctionalCalcTest < Minitest::Test
+  def test_add
+    puts 'functional'
+    assert_equal 2 + 2, 4
+  end
+end

data/spec/fixtures/rails6_users_app/test/integration/integration_calc_test.rb

@@ -0,0 +1,12 @@
+# minitest_calc_test_unit_format_spec.rb
+
+require "minitest/autorun"
+
+class IntegrationCalcTest < Minitest::Test
+  class CalcTest < Minitest::Test
+    def test_add
+      puts 'integration'
+      assert_equal 2 + 2, 4
+    end
+  end
+end

data/spec/hook_spec.rb

@@ -970,7 +970,7 @@ describe 'AppMap class Hooking', docker: false do
         tz = ENV['TZ']
         ENV['TZ'] = 'UTC'
         Timecop.freeze(Time.utc('2020-01-01')) do
-          expect(Time).to receive(:now).exactly(3).times.and_call_original
+          expect(Time).to receive(:now).at_least(3).times.and_call_original
           expect(InstanceMethod.new.say_the_time).to be
         end
       ensure

data/spec/service/config_analyzer_spec.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'appmap/service/config_analyzer'
+
+describe AppMap::Service::ConfigAnalyzer do
+  subject { described_class.new(config_file) }
+
+  context 'with non-existing config' do
+    let(:config_file) { 'spec/fixtures/config/non_existing_config.yml'}
+
+    describe '.app_name' do
+      it 'returns nil' do
+        expect(subject.app_name).to be_nil
+      end
+    end
+
+    describe '.is_valid?' do
+      it 'returns false' do
+        expect(subject.valid?).to be_falsey
+      end
+    end
+
+    describe '.is_present?' do
+      it 'returns false' do
+        expect(subject.present?).to be_falsey
+      end
+    end
+  end
+
+  context 'with valid config' do
+    let(:config_file) { 'spec/fixtures/config/valid_config.yml'}
+
+    describe '.app_name' do
+      it 'returns app name value from config' do
+        expect(subject.app_name).to eq('appmap')
+      end
+    end
+
+    describe '.is_valid?' do
+      it 'returns true' do
+        expect(subject.valid?).to be_truthy
+      end
+    end
+
+    describe '.is_present?' do
+      it 'returns true' do
+        expect(subject.present?).to be_truthy
+      end
+    end
+  end
+
+  context 'with invalid YAML config' do
+    let(:config_file) { 'spec/fixtures/config/invalid_config.yml'}
+
+    describe '.app_name' do
+      it 'returns app name value from config' do
+        expect(subject.app_name).to be_nil
+      end
+    end
+
+    describe '.is_valid?' do
+      it 'returns false' do
+        expect(subject.valid?).to be_falsey
+      end
+    end
+
+    describe '.is_present?' do
+      it 'return true' do
+        expect(subject.present?).to be_truthy
+      end
+    end
+  end
+
+  context 'with incomplete config' do
+    let(:config_file) { 'spec/fixtures/config/incomplete_config.yml'}
+
+    describe '.app_name' do
+      it 'returns nil' do
+        expect(subject.app_name).to eq('app')
+      end
+    end
+
+    describe '.is_valid?' do
+      it 'guesses paths and returns true ' do
+        expect(subject.valid?).to be_truthy
+      end
+    end
+
+    describe '.is_present?' do
+      it 'returns true' do
+        expect(subject.present?).to be_truthy
+      end
+    end
+  end
+end

data/test/agent_setup_init_test.rb

@@ -5,8 +5,8 @@ require 'test_helper'
 
 class AgentSetupInitTest < Minitest::Test
   CONFIG_FILENAME = '123.yml'
-  SUBFOLDER_CONFIG_FILEPATH = 'conf/123.yml'
-  EXPECTED_CONFIG_CONTENT = %(name: appmap-ruby
+  EXPECTED_CONFIG_CONTENT = %(---
+name: appmap-ruby
 packages:
 - path: lib
 )
@@ -14,24 +14,24 @@ packages:
   def test_init_when_config_exists
     output = `./exe/appmap-agent-init`
     assert_equal 0, $CHILD_STATUS.exitstatus
-    assert_includes output, 'The AppMap config file appmap.yml already exists.'
+    expected = JSON.pretty_generate({
+      configuration: {
+        filename: 'appmap.yml',
+        contents: EXPECTED_CONFIG_CONTENT
+      }
+    })
+    assert_equal expected, output.strip
   end
 
   def test_init_with_custom_config_filename
     output = `./exe/appmap-agent-init -c #{CONFIG_FILENAME}`
     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-init --config=#{SUBFOLDER_CONFIG_FILEPATH}`
-    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)
+    expected = JSON.pretty_generate({
+      configuration: {
+        filename: CONFIG_FILENAME,
+        contents: EXPECTED_CONFIG_CONTENT
+      }
+    })
+    assert_equal expected, output.strip
   end
 end

data/test/agent_setup_status_test.rb

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class AgentSetupInitTest < Minitest::Test
+  def test_status_gem
+    output = `./exe/appmap-agent-status`
+    assert_equal 0, $CHILD_STATUS.exitstatus
+    expected = {
+      test_commands: [],
+      properties: {
+        config: {
+          app: 'AppMap Rubygem',
+          present: true,
+          valid: true
+        },
+        project: {
+          agentVersion: AppMap::VERSION,
+          language: 'ruby',
+          remoteRecordingCapable: false,
+          integrationTests: false
+        }
+      }
+    }
+    assert_equal JSON.pretty_generate(expected), output.strip
+  end
+
+  def test_status_rails_app
+    def test_status
+      output = `cd spec/fixtures/rails6_users_app && bundle exec ../../../exe/appmap-agent-status`
+      assert_equal 0, $CHILD_STATUS.exitstatus
+      expected = {
+        test_commands: [
+          {
+            framework: :rspec,
+            command: 'APPMAP=true bundle exec rspec spec/controllers'
+          },
+          {
+            framework: :minitest,
+            command: 'APPMAP=true bundle exec ruby test/controllers && APPMAP=true bundle exec ruby test/integration'
+          },
+          {
+            framework: :cucumber,
+            command: 'APPMAP=true bundle exec cucumber'
+          }
+        ],
+        properties: {
+          config: {
+            app: nil,
+            present: true,
+            valid: true
+          },
+          project: {
+            agentVersion: AppMap::VERSION,
+            language: 'ruby',
+            remoteRecordingCapable: false,
+            integrationTests: true
+          }
+        }
+      }
+      assert_equal JSON.pretty_generate(expected), output.strip
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.54.4
+  version: 0.58.0
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-27 00:00:00.000000000 Z
+date: 2021-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -295,6 +295,7 @@ email:
 - kgilpin@gmail.com
 executables:
 - appmap-agent-init
+- appmap-agent-status
 - appmap-inspect
 extensions:
 - ext/appmap/extconf.rb
@@ -324,6 +325,7 @@ files:
 - examples/mock_webapp/lib/mock_webapp/request.rb
 - examples/mock_webapp/lib/mock_webapp/user.rb
 - exe/appmap-agent-init
+- exe/appmap-agent-status
 - exe/appmap-inspect
 - ext/appmap/appmap.c
 - ext/appmap/extconf.rb
@@ -331,6 +333,7 @@ files:
 - lib/appmap/agent.rb
 - lib/appmap/class_map.rb
 - lib/appmap/command/agent_setup/init.rb
+- lib/appmap/command/agent_setup/status.rb
 - lib/appmap/command/inspect.rb
 - lib/appmap/command_error.rb
 - lib/appmap/config.rb
@@ -351,7 +354,11 @@ files:
 - lib/appmap/railtie.rb
 - lib/appmap/record.rb
 - lib/appmap/rspec.rb
+- lib/appmap/service/config_analyzer.rb
 - lib/appmap/service/guesser.rb
+- lib/appmap/service/integration_test_path_finder.rb
+- lib/appmap/service/test_command_provider.rb
+- lib/appmap/service/test_framework_detector.rb
 - lib/appmap/swagger.rb
 - lib/appmap/swagger/configuration.rb
 - lib/appmap/swagger/markdown_descriptions.rb
@@ -364,6 +371,9 @@ files:
 - release.sh
 - spec/class_map_spec.rb
 - spec/config_spec.rb
+- spec/fixtures/config/incomplete_config.yml
+- spec/fixtures/config/invalid_config.yml
+- spec/fixtures/config/valid_config.yml
 - spec/fixtures/hook/.gitignore
 - spec/fixtures/hook/app/controllers/api/api_keys_controller.rb
 - spec/fixtures/hook/app/controllers/organizations_controller.rb
@@ -536,6 +546,8 @@ files:
 - spec/fixtures/rails6_users_app/spec/models/user_spec.rb
 - spec/fixtures/rails6_users_app/spec/rails_helper.rb
 - spec/fixtures/rails6_users_app/spec/spec_helper.rb
+- spec/fixtures/rails6_users_app/test/controllers/functional_calc_test.rb
+- spec/fixtures/rails6_users_app/test/integration/integration_calc_test.rb
 - spec/fixtures/rails6_users_app/users_app/.gitignore
 - spec/hook_spec.rb
 - spec/open_spec.rb
@@ -545,10 +557,12 @@ files:
 - spec/record_net_http_spec.rb
 - spec/record_sql_rails_pg_spec.rb
 - spec/remote_recording_spec.rb
+- spec/service/config_analyzer_spec.rb
 - spec/spec_helper.rb
 - spec/swagger/swagger_spec.rb
 - spec/util_spec.rb
 - test/agent_setup_init_test.rb
+- test/agent_setup_status_test.rb
 - test/bundle_vendor_test.rb
 - test/cucumber_test.rb
 - test/expectations/openssl_test_key_sign1.json