appmap 0.66.1 → 0.68.0

data/spec/config_spec.rb

@@ -4,58 +4,7 @@ require 'rails_spec_helper'
 require 'appmap/config'
 
 describe AppMap::Config, docker: false do
-  it 'loads from a Hash' do
-    config_data = {
-      exclude: [],
-      name: 'test',
-      packages: [
-        {
-          path: 'path-1'
-        },
-        {
-          path: 'path-2',
-          exclude: [ 'exclude-1' ]
-        }
-      ],
-      functions: [
-        {
-          package: 'pkg',
-          class: 'cls',
-          function: 'fn',
-          label: 'lbl'
-        }
-      ]
-    }.deep_stringify_keys!
-    config = AppMap::Config.load(config_data)
-
-    config_expectation = {
-      exclude: [],
-      name: 'test',
-      packages: [
-        {
-          path: 'path-1',
-          handler_class: 'AppMap::Handler::Function'
-        },
-        {
-          path: 'path-2',
-          handler_class: 'AppMap::Handler::Function',
-          exclude: [ 'exclude-1' ]
-        }
-      ],
-      functions: [
-        {
-          package: 'pkg',
-          class: 'cls',
-          functions: [ :fn ],
-          labels: ['lbl']
-        }
-      ]
-    }.deep_stringify_keys!
-
-    expect(config.to_h.deep_stringify_keys!).to eq(config_expectation)
-  end
-
-  it 'interprets a function in canonical name format' do
+  it 'loads as expected' do
     config_data = {
       name: 'test',
       packages: [],
@@ -67,20 +16,212 @@ describe AppMap::Config, docker: false do
     }.deep_stringify_keys!
     config = AppMap::Config.load(config_data)
 
-    config_expectation = {
-      exclude: [],
-      name: 'test',
-      packages: [],
-      functions: [
+    expect(JSON.parse(JSON.generate(config.as_json))).to eq(JSON.parse(<<~FIXTURE))
+    {
+      "name": "test",
+      "appmap_dir": "tmp/appmap",
+      "packages": [
+      ],
+      "swagger_config": {
+        "project_name": null,
+        "project_version": "1.0",
+        "output_dir": "swagger",
+        "description": "Generate Swagger from AppMaps"
+      },
+      "depends_config": {
+        "base_dir": null,
+        "base_branches": [
+          "remotes/origin/main",
+          "remotes/origin/master"
+        ],
+        "test_file_patterns": [
+          "spec/**/*_spec.rb",
+          "test/**/*_test.rb"
+        ],
+        "dependent_tasks": [
+          "swagger"
+        ],
+        "description": "Bring AppMaps up to date with local file modifications, and updated derived data such as Swagger files",
+        "rspec_environment_method": "AppMap::Depends.test_env",
+        "minitest_environment_method": "AppMap::Depends.test_env",
+        "rspec_select_tests_method": "AppMap::Depends.select_rspec_tests",
+        "minitest_select_tests_method": "AppMap::Depends.select_minitest_tests",
+        "rspec_test_command_method": "AppMap::Depends.rspec_test_command",
+        "minitest_test_command_method": "AppMap::Depends.minitest_test_command"
+      },
+      "hook_paths": [
+        "pkg",
+        "#{Gem.loaded_specs['activesupport'].gem_dir}"
+      ],
+      "exclude": [
+      ],
+      "functions": [
         {
-          package: 'pkg',
-          class: 'cls',
-          functions: [ :fn ],
+          "cls": "cls",
+          "target_methods": {
+            "package": "pkg",
+            "method_names": [
+              "fn"
+            ]
+          }
         }
-      ]
-    }.deep_stringify_keys!
-
-    expect(config.to_h.deep_stringify_keys!).to eq(config_expectation)
+      ],
+      "builtin_hooks": {
+        "JSON::Ext::Parser": [
+          {
+            "package": "json",
+            "method_names": [
+              "parse"
+            ]
+          }
+        ],
+        "JSON::Ext::Generator::State": [
+          {
+            "package": "json",
+            "method_names": [
+              "generate"
+            ]
+          }
+        ],
+        "Net::HTTP": [
+          {
+            "package": "net/http",
+            "method_names": [
+              "request"
+            ]
+          }
+        ],
+        "OpenSSL::PKey::PKey": [
+          {
+            "package": "openssl",
+            "method_names": [
+              "sign"
+            ]
+          }
+        ],
+        "OpenSSL::X509::Request": [
+          {
+            "package": "openssl",
+            "method_names": [
+              "sign"
+            ]
+          },
+          {
+            "package": "openssl",
+            "method_names": [
+              "verify"
+            ]
+          }
+        ],
+        "OpenSSL::X509::Certificate": [
+          {
+            "package": "openssl",
+            "method_names": [
+              "sign"
+            ]
+          }
+        ],
+        "OpenSSL::PKCS5": [
+          {
+            "package": "openssl",
+            "method_names": [
+              "pbkdf2_hmac"
+            ]
+          },
+          {
+            "package": "openssl",
+            "method_names": [
+              "pbkdf2_hmac_sha1"
+            ]
+          }
+        ],
+        "OpenSSL::Cipher": [
+          {
+            "package": "openssl",
+            "method_names": [
+              "encrypt"
+            ]
+          },
+          {
+            "package": "openssl",
+            "method_names": [
+              "decrypt"
+            ]
+          }
+        ],
+        "Psych": [
+          {
+            "package": "yaml",
+            "method_names": [
+              "load"
+            ]
+          },
+          {
+            "package": "yaml",
+            "method_names": [
+              "load_stream"
+            ]
+          },
+          {
+            "package": "yaml",
+            "method_names": [
+              "parse"
+            ]
+          },
+          {
+            "package": "yaml",
+            "method_names": [
+              "parse_stream"
+            ]
+          },
+          {
+            "package": "yaml",
+            "method_names": [
+              "dump"
+            ]
+          },
+          {
+            "package": "yaml",
+            "method_names": [
+              "dump_stream"
+            ]
+          }
+        ]
+      },
+      "gem_hooks": {
+        "cls": [
+          {
+            "package": "pkg",
+            "method_names": [
+              "fn"
+            ]
+          }
+        ],
+        "ActiveSupport::Callbacks::CallbackSequence": [
+          {
+            "package": "activesupport",
+            "method_names": [
+              "invoke_before"
+            ]
+          },
+          {
+            "package": "activesupport",
+            "method_names": [
+              "invoke_after"
+            ]
+          }
+        ],
+        "ActiveSupport::SecurityUtils": [
+          {
+            "package": "activesupport",
+            "method_names": [
+              "secure_compare"
+            ]
+          }
+        ]
+      }
+    }
+    FIXTURE
   end
 
   context do
@@ -94,7 +235,8 @@ describe AppMap::Config, docker: false do
       expect(config.to_h).to eq(YAML.load(<<~CONFIG))
       :name: appmap-ruby
       :packages:
-      - :path: lib
+      - :name: lib
+        :path: lib
         :handler_class: AppMap::Handler::Function
         :shallow: false
       :functions: []

data/spec/depends/api_spec.rb

@@ -93,9 +93,9 @@ describe 'Depends API' do
 
         test_report.clean_appmaps
 
-        expect(File.exists?(new_spec_file)).to be_falsey
+        expect(File.exist?(new_spec_file)).to be_falsey
       ensure
-        FileUtils.rm_f new_spec_file if File.exists?(new_spec_file)
+        FileUtils.rm_f new_spec_file if File.exist?(new_spec_file)
         FileUtils.rm_rf new_spec_file.split('.')[0]
       end
     end
@@ -104,7 +104,7 @@ describe 'Depends API' do
   describe '.run_tests' do
     def run_tests
       Dir.chdir 'spec/fixtures/depends' do
-        api.run_tests([ 'spec/actual_rspec_test.rb', 'test/actual_minitest_test.rb' ], appmap_dir: Pathname.new(DEPENDS_TEST_DIR).expand_path.to_s)
+        api.run_tests([ 'spec/actual_rspec_test.rb', 'test/actual_minitest_test.rb' ], appmap_dir: Pathname.new('.').expand_path.to_s)
       end
     end
 

data/spec/fixtures/config/missing_path_or_gem.yml

@@ -0,0 +1,3 @@
+name: name
+packages:
+  - dogs: are friendly

data/spec/rails_recording_spec.rb

@@ -58,7 +58,7 @@ describe 'Rails' do
               hash_including(
                 'http_server_response' => hash_including(
                   'status_code' => 201,
-                  'mime_type' => 'application/json; charset=utf-8',
+                  'headers' => hash_including('Content-Type' => 'application/json; charset=utf-8'),
                 )
               )
             )

data/spec/rails_spec_helper.rb

@@ -5,9 +5,14 @@ require 'active_support'
 require 'active_support/core_ext'
 require 'open3'
 
+# 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"
+
 def wait_for_container(app_name)
   start_time = Time.now
-  until `docker-compose ps -q --filter health=healthy #{app_name}`.strip != ''
+  until `#{PS_CMD} #{app_name}`.strip != ''
     elapsed = Time.now - start_time
     raise "Timeout waiting for container #{app_name} to be ready" if elapsed > 10
 

data/test/agent_setup_validate_test.rb

@@ -2,27 +2,40 @@
 
 require 'test_helper'
 
+schema_path = File.expand_path('../../config-schema.yml', __FILE__)
+CONFIG_SCHEMA = YAML.safe_load(File.read(schema_path))
 class AgentSetupValidateTest < Minitest::Test
   NON_EXISTING_CONFIG_FILENAME = '123.yml'
   INVALID_YAML_CONFIG_FILENAME = 'spec/fixtures/config/invalid_yaml_config.yml'
   INVALID_CONFIG_FILENAME = 'spec/fixtures/config/invalid_config.yml'
+  MISSING_PATH_OR_GEM_CONFIG_FILENAME = 'spec/fixtures/config/missing_path_or_gem.yml'
 
+  def check_output(output, expected_errors)
+    expected = JSON.pretty_generate(
+      {
+        version: 2,
+        errors: expected_errors,
+        schema: CONFIG_SCHEMA
+      }
+    )
+    assert_equal(expected, output.strip)
+  end
+    
   def test_init_when_config_exists
     output = `./exe/appmap-agent-validate`
     assert_equal 0, $CHILD_STATUS.exitstatus
-    expected = JSON.pretty_generate([
+    check_output(output, [
       {
         level: :error,
         message: 'AppMap auto-configuration is currently not available for non Rails projects'
       }
     ])
-    assert_equal expected, output.strip
   end
 
   def test_init_with_non_existing_config_file
     output = `./exe/appmap-agent-validate -c #{NON_EXISTING_CONFIG_FILENAME}`
     assert_equal 0, $CHILD_STATUS.exitstatus
-    expected = JSON.pretty_generate([
+    check_output(output, [
       {
         level: :error,
         message: 'AppMap auto-configuration is currently not available for non Rails projects'
@@ -33,13 +46,12 @@ class AgentSetupValidateTest < Minitest::Test
         message: "AppMap configuration #{NON_EXISTING_CONFIG_FILENAME} file does not exist"
       }
     ])
-    assert_equal expected, output.strip
   end
 
   def test_init_with_invalid_YAML
     output = `./exe/appmap-agent-validate -c #{INVALID_YAML_CONFIG_FILENAME}`
     assert_equal 0, $CHILD_STATUS.exitstatus
-    expected = JSON.pretty_generate([
+    check_output(output, [
       {
         level: :error,
         message: 'AppMap auto-configuration is currently not available for non Rails projects'
@@ -52,13 +64,12 @@ class AgentSetupValidateTest < Minitest::Test
           'did not find expected key while parsing a block mapping at line 1 column 1'
       }
     ])
-    assert_equal expected, output.strip
   end
 
   def test_init_with_invalid_data_config
     output = `./exe/appmap-agent-validate -c #{INVALID_CONFIG_FILENAME}`
     assert_equal 0, $CHILD_STATUS.exitstatus
-    expected = JSON.pretty_generate([
+    check_output(output, [
       {
         level: :error,
         message: 'AppMap auto-configuration is currently not available for non Rails projects'
@@ -70,6 +81,22 @@ class AgentSetupValidateTest < Minitest::Test
         detailed_message: "no implicit conversion of String into Integer"
       }
     ])
-    assert_equal expected, output.strip
+  end
+
+  def test_init_with_missing_package_key
+    output = `./exe/appmap-agent-validate -c #{MISSING_PATH_OR_GEM_CONFIG_FILENAME}`
+    assert_equal 0, $CHILD_STATUS.exitstatus
+    check_output(output, [
+      {
+        level: :error,
+        message: 'AppMap auto-configuration is currently not available for non Rails projects'
+      },
+      {
+        level: :error,
+        filename: MISSING_PATH_OR_GEM_CONFIG_FILENAME,
+        message: "AppMap configuration #{MISSING_PATH_OR_GEM_CONFIG_FILENAME} could not be loaded",
+        detailed_message: "AppMap config 'package' element should specify 'gem' or 'path'"
+      }
+    ])
   end
 end

data/test/fixtures/mocha_mock_app/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'appmap', git: 'applandinc/appmap-ruby', branch: `git rev-parse --abbrev-ref HEAD`.strip
+gem 'minitest'
+gem 'mocha'

data/test/fixtures/mocha_mock_app/appmap.yml

@@ -0,0 +1,5 @@
+name: mocha_mock_app
+packages:
+  - path: lib
+  - gem: mocha
+    shallow: false

data/test/fixtures/mocha_mock_app/lib/sheep.rb

@@ -0,0 +1,5 @@
+class Sheep
+  def baa
+    'baa'
+  end
+end

data/test/fixtures/mocha_mock_app/test/sheep_test.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+
+require 'minitest/autorun'
+
+require 'appmap'
+require 'appmap/minitest' if ENV['APPMAP_AUTOREQUIRE'] == 'false'
+
+require 'sheep'
+require 'mocha/minitest'
+
+class SheepTest < Minitest::Test
+  def test_sheep
+    sheep = mock('sheep')
+    sheep.responds_like(Sheep.new)
+    sheep.expects(:baa).returns('baa')
+    sheep.baa
+  end
+end

data/test/mock_compatibility_test.rb

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class MockCompatibilityTest < Minitest::Test
+  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(env.merge({ 'APPMAP' => 'true' }), %(bundle exec ruby -Ilib -Itest test/#{test_name}_test.rb))
+
+        yield
+      end
+    end
+  end
+
+  def test_expectation
+    perform_minitest_test('sheep') 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
+
+  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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.66.1
+  version: 0.68.0
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-29 00:00:00.000000000 Z
+date: 2021-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -3405,6 +3405,10 @@ files:
 - ext/appmap/extconf.rb
 - lib/appmap.rb
 - lib/appmap/agent.rb
+- lib/appmap/builtin_hooks/json.yml
+- lib/appmap/builtin_hooks/net/http.yml
+- lib/appmap/builtin_hooks/openssl.yml
+- lib/appmap/builtin_hooks/yaml.yml
 - lib/appmap/class_map.rb
 - lib/appmap/command/agent_setup/init.rb
 - lib/appmap/command/agent_setup/status.rb
@@ -3423,6 +3427,10 @@ files:
 - lib/appmap/depends/test_runner.rb
 - lib/appmap/depends/util.rb
 - lib/appmap/event.rb
+- lib/appmap/gem_hooks/actionpack.yml
+- lib/appmap/gem_hooks/actionview.yml
+- lib/appmap/gem_hooks/activesupport.yml
+- lib/appmap/gem_hooks/cancancan.yml
 - lib/appmap/handler/function.rb
 - lib/appmap/handler/net_http.rb
 - lib/appmap/handler/rails/request_handler.rb
@@ -3462,6 +3470,7 @@ files:
 - spec/fixtures/config/incomplete_config.yml
 - spec/fixtures/config/invalid_config.yml
 - spec/fixtures/config/invalid_yaml_config.yml
+- spec/fixtures/config/missing_path_or_gem.yml
 - spec/fixtures/config/valid_config.yml
 - spec/fixtures/depends/.gitignore
 - spec/fixtures/depends/app/controllers/api/api_keys_controller.rb
@@ -3698,6 +3707,10 @@ files:
 - test/fixtures/minitest_recorder/appmap.yml
 - test/fixtures/minitest_recorder/lib/hello.rb
 - test/fixtures/minitest_recorder/test/hello_test.rb
+- test/fixtures/mocha_mock_app/Gemfile
+- test/fixtures/mocha_mock_app/appmap.yml
+- test/fixtures/mocha_mock_app/lib/sheep.rb
+- test/fixtures/mocha_mock_app/test/sheep_test.rb
 - test/fixtures/openssl_recorder/Gemfile
 - test/fixtures/openssl_recorder/appmap.yml
 - test/fixtures/openssl_recorder/lib/openssl_cert_sign.rb
@@ -3714,6 +3727,7 @@ files:
 - test/gem_test.rb
 - test/inspect_cli_test.rb
 - test/minitest_test.rb
+- test/mock_compatibility_test.rb
 - test/openssl_test.rb
 - test/record_process_test.rb
 - test/rspec_test.rb
@@ -3738,7 +3752,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Record the operation of a Ruby program, using the AppLand 'AppMap' format.