feat: APPMAP_AUTOREQUIRE and APPMAP_INITIALIZE env vars to customize loading behavior

Author: kgilpin

lib/appmap.rb

@@ -74,6 +74,6 @@
     require 'appmap/depends'
   end
 
-end.call
+end.call unless ENV['APPMAP_AUTOREQUIRE'] == 'false'
 
-AppMap.initialize_configuration if ENV['APPMAP'] == 'true'
+AppMap.initialize_configuration if ENV['APPMAP'] == 'true' && ENV['APPMAP_INITIALIZE'] != 'false'

test/fixtures/mocha_mock_app/test/sheep_test.rb

@@ -1,9 +1,11 @@
 $LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 
-require 'appmap/minitest'
+require 'minitest/autorun'
+
+require 'appmap'
+require 'appmap/minitest' if ENV['APPMAP_AUTOREQUIRE'] == 'false'
 
 require 'sheep'
-require 'minitest/autorun'
 require 'mocha/minitest'
 
 class SheepTest < Minitest::Test

test/mock_compatibility_test.rb

@@ -4,13 +4,13 @@
 require 'test_helper'
 
 class MockCompatibilityTest < Minitest::Test
-  def perform_minitest_test(test_name)
+  def perform_minitest_test(test_name, env = {})
     Bundler.with_clean_env do
       Dir.chdir 'test/fixtures/mocha_mock_app' do
         FileUtils.rm_rf 'tmp'
         system 'bundle config --local local.appmap ../../..'
         system 'bundle'
-        system({ 'APPMAP' => 'true' }, %(bundle exec ruby -Ilib -Itest test/#{test_name}_test.rb))
+        system(env.merge({ 'APPMAP' => 'true' }), %(bundle exec ruby -Ilib -Itest test/#{test_name}_test.rb))
 
         yield
       end
@@ -29,4 +29,17 @@ def test_expectation
       assert_equal 'succeeded', metadata['test_status']
     end
   end
+
+  def test_expectation_without_autorequire
+    perform_minitest_test('sheep', 'APPMAP_AUTOREQUIRE' => 'false') do
+      appmap_file = 'tmp/appmap/minitest/Sheep_sheep.appmap.json'
+
+      assert File.file?(appmap_file), 'appmap output file does not exist'
+      appmap = JSON.parse(File.read(appmap_file))
+      assert_equal AppMap::APPMAP_FORMAT_VERSION, appmap['version']
+      assert_includes appmap.keys, 'metadata'
+      metadata = appmap['metadata']
+      assert_equal 'succeeded', metadata['test_status']
+    end
+  end
 end