appmap 0.35.0 → 0.37.2

data/spec/rspec_feature_metadata_spec.rb

@@ -3,30 +3,29 @@
 require 'rails_spec_helper'
 
 describe 'RSpec feature and feature group metadata' do
-  before(:all) { @fixture_dir = 'spec/fixtures/rails_users_app' }
-  include_examples 'Rails app pg database'
-  
-  around(:each) do |example|
-    FileUtils.rm_rf tmpdir
-    FileUtils.mkdir_p tmpdir
-    cmd = "docker-compose run --rm -e APPMAP=true -v #{File.absolute_path(tmpdir).shellescape}:/app/tmp app ./bin/rspec spec/models/user_spec.rb"
-    run_cmd cmd, chdir: @fixture_dir
+  include_examples 'Rails app pg database', 'spec/fixtures/rails5_users_app' do
+    around(:each) do |example|
+      FileUtils.rm_rf tmpdir
+      FileUtils.mkdir_p tmpdir
+      cmd = "docker-compose run --rm -e APPMAP=true -v #{File.absolute_path(tmpdir).shellescape}:/app/tmp app ./bin/rspec spec/models/user_spec.rb"
+      run_cmd cmd, chdir: fixture_dir
 
-    example.run
-  end
+      example.run
+    end
 
-  let(:tmpdir) { 'tmp/spec/RSpec feature and feature group metadata' }
-  let(:appmap_json) { File.join(tmpdir, %(appmap/rspec/User_creation_creates_charles.appmap.json)) }
+    let(:tmpdir) { 'tmp/spec/RSpec feature and feature group metadata' }
+    let(:appmap_json) { File.join(tmpdir, %(appmap/rspec/User_creation_creates_charles.appmap.json)) }
 
-  describe do
-    it 'are recorded in the appmap' do
-      expect(File).to exist(appmap_json)
-      appmap = JSON.parse(File.read(appmap_json)).to_yaml
+    describe do
+      it 'are recorded in the appmap' do
+        expect(File).to exist(appmap_json)
+        appmap = JSON.parse(File.read(appmap_json)).to_yaml
 
-      expect(appmap).to include(<<-METADATA.strip)
+        expect(appmap).to include(<<-METADATA.strip)
   feature: Create a user
   feature_group: User
-      METADATA
+        METADATA
+      end
     end
   end
 end

data/test/cli_test.rb

@@ -56,12 +56,10 @@ class CLITest < Minitest::Test
     Class frequency:
     ----------------
     1	Main
-    1	IO
 
     Method frequency:
     ----------------
     1	Main.say_hello
-    1	IO#write
     OUTPUT
   end
 
@@ -82,20 +80,12 @@ class CLITest < Minitest::Test
         {
           "name": "Main",
           "count": 1
-        },
-        {
-          "name": "IO",
-          "count": 1
         }
       ],
       "method_frequency": [
         {
           "name": "Main.say_hello",
           "count": 1
-        },
-        {
-          "name": "IO#write",
-          "count": 1
         }
       ]
     }

data/test/expectations/openssl_test_key_sign1.json

@@ -0,0 +1,55 @@
+[
+  {
+    "name": "lib",
+    "type": "package",
+    "children": [
+      {
+        "name": "Example",
+        "type": "class",
+        "children": [
+          {
+            "name": "sign",
+            "type": "function",
+            "location": "lib/openssl_key_sign.rb:10",
+            "static": true,
+            "source": "  def Example.sign\n    key = OpenSSL::PKey::RSA.new 2048\n\n    document = 'the document'\n\n    digest = OpenSSL::Digest::SHA256.new\n    key.sign digest, document\n  end\n"
+          }
+        ]
+      }
+    ]
+  },
+  {
+    "name": "openssl",
+    "type": "package",
+    "children": [
+      {
+        "name": "OpenSSL",
+        "type": "class",
+        "children": [
+          {
+            "name": "PKey",
+            "type": "class",
+            "children": [
+              {
+                "name": "PKey",
+                "type": "class",
+                "children": [
+                  {
+                    "name": "sign",
+                    "type": "function",
+                    "location": "OpenSSL::PKey::PKey#sign",
+                    "static": false,
+                    "labels": [
+                      "security",
+                      "crypto"
+                    ]
+                  }
+                ]
+              }
+            ]
+          }
+        ]
+      }
+    ]
+  }
+]

data/test/expectations/openssl_test_key_sign2.json

@@ -0,0 +1,58 @@
+[
+  {
+    "id": 1,
+    "event": "call",
+    "defined_class": "Example",
+    "method_id": "sign",
+    "path": "lib/openssl_key_sign.rb",
+    "lineno": 10,
+    "static": true,
+    "parameters": [
+
+    ],
+    "receiver": {
+      "class": "Module"
+    }
+  },
+  {
+    "id": 2,
+    "event": "call",
+    "defined_class": "OpenSSL::PKey::PKey",
+    "method_id": "sign",
+    "path": "OpenSSL::PKey::PKey#sign",
+    "static": false,
+    "parameters": [
+      {
+        "name": "arg",
+        "class": "OpenSSL::Digest::SHA256",
+        "value": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
+        "kind": "req"
+      },
+      {
+        "name": "arg",
+        "class": "String",
+        "value": "the document",
+        "kind": "req"
+      }
+    ],
+    "receiver": {
+      "class": "OpenSSL::PKey::RSA"
+    }
+  },
+  {
+    "id": 3,
+    "event": "return",
+    "parent_id": 2,
+    "return_value": {
+      "class": "String"
+    }
+  },
+  {
+    "id": 4,
+    "event": "return",
+    "parent_id": 1,
+    "return_value": {
+      "class": "String"
+    }
+  }
+]

data/test/fixtures/gem_test/Gemfile

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

data/test/fixtures/gem_test/appmap.yml

@@ -0,0 +1,3 @@
+name: gem_test
+packages:
+  - gem: activesupport

data/test/fixtures/gem_test/test/to_param_test.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'appmap/minitest'
+require 'minitest/autorun'
+require 'active_support'
+require 'active_support/core_ext'
+
+class ToParamTest < ::Minitest::Test
+  def test_to_param
+    # record use of a core extension
+    assert_equal 'my+id', 'my+id'.to_param
+  end
+end

data/test/gem_test.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'English'
+
+class MinitestTest < Minitest::Test
+  def perform_gem_test(test_name)
+    Bundler.with_clean_env do
+      Dir.chdir 'test/fixtures/gem_test' 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))
+
+        yield
+      end
+    end
+  end
+
+  def test_record_gem
+    perform_gem_test 'to_param' do
+      appmap_file = 'tmp/appmap/minitest/To_param_to_param.appmap.json'
+      appmap = JSON.parse(File.read(appmap_file))
+      events = appmap['events']
+      assert_equal 2, events.size
+      assert_equal 'call', events.first['event']
+      assert_equal 'to_param', events.first['method_id']
+      assert_equal "#{Gem.loaded_specs['activesupport'].gem_dir}/lib/active_support/core_ext/object/to_query.rb", events.first['path']
+      assert_equal 'return', events.second['event']
+      assert_equal 1, events.second['parent_id']
+    end
+  end
+end

data/test/minitest_test.rb

@@ -5,7 +5,7 @@ require 'test_helper'
 require 'English'
 
 class MinitestTest < Minitest::Test
-  def perform_test(test_name)
+  def perform_minitest_test(test_name)
     Bundler.with_clean_env do
       Dir.chdir 'test/fixtures/minitest_recorder' do
         FileUtils.rm_rf 'tmp'
@@ -19,7 +19,7 @@ class MinitestTest < Minitest::Test
   end
 
   def test_hello
-    perform_test 'hello' do
+    perform_minitest_test 'hello' do
       appmap_file = 'tmp/appmap/minitest/Hello_hello.appmap.json'
 
       assert File.file?(appmap_file), 'appmap output file does not exist'

data/test/openssl_test.rb

@@ -11,13 +11,17 @@ class OpenSSLTest < Minitest::Test
         FileUtils.rm_rf 'tmp'
         system 'bundle config --local local.appmap ../../..'
         system 'bundle'
-        system({ 'APPMAP' => 'true', 'DEBUG' => 'true' }, %(bundle exec ruby lib/openssl_#{test_name}.rb))
+        system({ 'APPMAP' => 'true' }, %(bundle exec ruby lib/openssl_#{test_name}.rb))
 
         yield
       end
     end
   end
 
+  def expectation(name)
+    File.read File.join __dir__, 'expectations', name
+  end
+
   def test_key_sign
     perform_test 'key_sign' do
       appmap_file = 'appmap.json'
@@ -26,83 +30,7 @@ class OpenSSLTest < Minitest::Test
       appmap = JSON.parse(File.read(appmap_file))
       assert_equal AppMap::APPMAP_FORMAT_VERSION, appmap['version']
       assert_equal [ { 'recorder' => 'lib/openssl_key_sign.rb' } ], appmap['metadata']
-      assert_equal JSON.parse(<<~JSON), appmap['classMap']
-      [
-        {
-          "name": "lib",
-          "type": "package",
-          "children": [
-            {
-              "name": "Example",
-              "type": "class",
-              "children": [
-                {
-                  "name": "sign",
-                  "type": "function",
-                  "location": "lib/openssl_key_sign.rb:10",
-                  "static": true
-                }
-              ]
-            }
-          ]
-        },
-        {
-          "name": "openssl",
-          "type": "package",
-          "children": [
-            {
-              "name": "OpenSSL",
-              "type": "class",
-              "children": [
-                {
-                  "name": "PKey",
-                  "type": "class",
-                  "children": [
-                    {
-                      "name": "PKey",
-                      "type": "class",
-                      "children": [
-                        {
-                          "name": "sign",
-                          "type": "function",
-                          "location": "OpenSSL::PKey::PKey#sign",
-                          "static": false,
-                          "labels": [
-                            "security",
-                            "crypto"
-                          ]
-                        }
-                      ]
-                    }
-                  ]
-                }
-              ]
-            }
-          ]
-        },
-        {
-          "name": "io",
-          "type": "package",
-          "children": [
-            {
-              "name": "IO",
-              "type": "class",
-              "children": [
-                {
-                  "name": "write",
-                  "type": "function",
-                  "location": "IO#write",
-                  "static": false,
-                  "labels": [
-                    "io"
-                  ]
-                }
-              ]
-            }
-          ]
-        }
-      ]
-      JSON
+      assert_equal JSON.parse(expectation('openssl_test_key_sign1.json')), appmap['classMap']
       sanitized_events = appmap['events'].map(&:deep_symbolize_keys).map(&AppMap::Util.method(:sanitize_event)).map do |event|
         delete_value = ->(obj) { (obj || {}).delete(:value) }
         delete_value.call(event[:receiver])
@@ -110,93 +38,10 @@ class OpenSSLTest < Minitest::Test
         event
       end
 
-      diff = Diffy::Diff.new(<<~JSON.strip, JSON.pretty_generate(sanitized_events).strip)
-      [
-        {
-          "id": 1,
-          "event": "call",
-          "defined_class": "Example",
-          "method_id": "sign",
-          "path": "lib/openssl_key_sign.rb",
-          "lineno": 10,
-          "static": true,
-          "parameters": [
-      
-          ],
-          "receiver": {
-            "class": "Module"
-          }
-        },
-        {
-          "id": 2,
-          "event": "call",
-          "defined_class": "OpenSSL::PKey::PKey",
-          "method_id": "sign",
-          "path": "OpenSSL::PKey::PKey#sign",
-          "static": false,
-          "parameters": [
-            {
-              "name": "arg",
-              "class": "OpenSSL::Digest::SHA256",
-              "value": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
-              "kind": "req"
-            },
-            {
-              "name": "arg",
-              "class": "String",
-              "value": "the document",
-              "kind": "req"
-            }
-          ],
-          "receiver": {
-            "class": "OpenSSL::PKey::RSA"
-          }
-        },
-        {
-          "id": 3,
-          "event": "return",
-          "parent_id": 2,
-          "return_value": {
-            "class": "String"
-          }
-        },
-        {
-          "id": 4,
-          "event": "return",
-          "parent_id": 1,
-          "return_value": {
-            "class": "String"
-          }
-        },
-        {
-          "id": 5,
-          "event": "call",
-          "defined_class": "IO",
-          "method_id": "write",
-          "path": "IO#write",
-          "static": false,
-          "parameters": [
-            {
-              "name": "arg",
-              "class": "String",
-              "value": "Computed signature",
-              "kind": "rest"
-            }
-          ],
-          "receiver": {
-            "class": "IO"
-          }
-        },
-        {
-          "id": 6,
-          "event": "return",
-          "parent_id": 5,
-          "return_value": {
-            "class": "Integer"
-          }
-        }
-      ]
-      JSON
+      diff = Diffy::Diff.new(
+        expectation('openssl_test_key_sign2.json').strip,
+        JSON.pretty_generate(sanitized_events).strip
+      )
       assert_equal '', diff.to_s
     end
   end