appmap 0.37.2 → 0.41.0

data/spec/config_spec.rb

@@ -7,6 +7,7 @@ require 'appmap/config'
 describe AppMap::Config, docker: false do
   it 'loads from a Hash' do
     config_data = {
+      exclude: [],
       name: 'test',
       packages: [
         {

data/spec/fixtures/hook/exclude.rb

@@ -0,0 +1,15 @@
+class ExcludeTest
+  def instance_method
+    'instance_method'
+  end
+
+  class << self
+    def singleton_method
+      'singleton_method'
+    end
+  end
+
+  def self.cls_method
+    'class_method'
+  end
+end

data/spec/fixtures/hook/labels.rb

@@ -0,0 +1,6 @@
+# @label has-cls-label
+class ClassWithLabel
+  # @label has-fn-label
+  def fn_with_label
+  end
+end

data/spec/fixtures/rails5_users_app/Gemfile

@@ -1,7 +1,7 @@
 source 'https://rubygems.org'
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-gem 'rails', '~> 6'
+gem 'rails', '~> 5'
 
 gem 'haml-rails'
 
@@ -33,11 +33,10 @@ appmap_options = \
     { path: appmap_path }
   else
     {}
-  end.merge(require: %w[appmap appmap/railtie])
-
-gem 'appmap', appmap_options
+  end.merge(require: %w[appmap])
 
 group :development, :test do
+  gem 'appmap', appmap_options
   gem 'cucumber-rails', require: false
   gem 'rspec-rails'
   # Required for Sequel, since without ActiveRecord, the Rails transactional fixture support

data/spec/fixtures/rails5_users_app/app/controllers/users_controller.rb

@@ -2,4 +2,12 @@ class UsersController < ApplicationController
   def index
     @users = User.all
   end
+
+  def show
+    if (@user = User[login: params[:id]])
+      render plain: @user
+    else
+      render plain: 'Not found', status: 404
+    end
+  end
 end

data/spec/fixtures/rails5_users_app/appmap.yml

@@ -1,3 +1,7 @@
 name: rails5_users_app
 packages:
-  - path: app
+  - path: app/models
+    labels: [ mvc.model ]
+  - path: app/controllers
+    labels: [ mvc.controller ]
+  - gem: sequel

data/spec/fixtures/rails5_users_app/config/application.rb

@@ -19,6 +19,8 @@ when 'activerecord'
   require 'active_record/railtie'
 end
 
+require 'appmap/railtie' if defined?(AppMap)
+
 # require "active_storage/engine"
 # require "action_mailer/railtie"
 # require "action_cable/engine"

data/spec/fixtures/rails5_users_app/config/routes.rb

@@ -3,7 +3,7 @@ Rails.application.routes.draw do
     resources :users, only: %i[index create]
   end
 
-  resources :users, only: %i[index]
+  resources :users, only: %i[index show]
 
   get 'health', to: 'health#show'
 

data/spec/fixtures/rails5_users_app/spec/controllers/users_controller_api_spec.rb

@@ -21,7 +21,7 @@ RSpec.describe Api::UsersController, feature_group: 'Users', type: :controller,
       post :create, params: { login: 'alice' }
     end
     it 'lists the users' do
-      post :index, params: {}
+      get :index, params: {}
       users = JSON.parse(response.body)
       expect(users.map { |r| r['login'] }).to include('alice')
     end

data/spec/fixtures/rails5_users_app/spec/controllers/users_controller_spec.rb

@@ -0,0 +1,27 @@
+require 'rails_helper'
+require 'rack/test'
+
+RSpec.describe UsersController, type: :controller do
+  render_views
+
+  describe 'GET /users', feature: 'Show all users' do
+    before do
+      User.create login: 'alice'
+    end
+    it 'lists the users' do
+      get :index
+      expect(response).to be_ok
+    end
+  end
+
+  describe 'GET /users/:login', feature: 'Show a user' do
+    before do
+      User.create login: 'alice'
+    end
+
+    it 'shows the user' do
+      get :show, params: { id: 'alice' }
+      expect(response).to be_ok
+    end
+  end
+end

data/spec/fixtures/rails6_users_app/Gemfile

@@ -2,7 +2,7 @@ source 'https://rubygems.org'
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 # Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
-gem 'rails', '~> 5.2.3'
+gem 'rails', '~> 6'
 
 gem 'haml-rails'
 
@@ -34,11 +34,10 @@ appmap_options = \
     { path: appmap_path }
   else
     {}
-  end.merge(require: %w[appmap appmap/railtie])
-
-gem 'appmap', appmap_options
+  end.merge(require: %w[appmap])
 
 group :development, :test do
+  gem 'appmap', appmap_options
   gem 'cucumber-rails', require: false
   gem 'rspec-rails'
   # Required for Sequel, since without ActiveRecord, the Rails transactional fixture support

data/spec/fixtures/rails6_users_app/app/controllers/users_controller.rb

@@ -2,4 +2,12 @@ class UsersController < ApplicationController
   def index
     @users = User.all
   end
+
+  def show
+    if (@user = User[login: params[:id]])
+      render plain: @user
+    else
+      render plain: 'Not found', status: 404
+    end
+  end
 end

data/spec/fixtures/rails6_users_app/appmap.yml

@@ -1,3 +1,8 @@
 name: rails6_users_app
 packages:
-  - path: app
+  - path: app/models
+    labels: [ mvc.model ]
+  - path: app/controllers
+    labels: [ mvc.controller ]
+  - gem: sequel
+

data/spec/fixtures/rails6_users_app/config/application.rb

@@ -19,6 +19,8 @@ when 'activerecord'
   require 'active_record/railtie'
 end
 
+require 'appmap/railtie' if defined?(AppMap)
+
 # require "active_storage/engine"
 # require "action_mailer/railtie"
 # require "action_cable/engine"

data/spec/fixtures/rails6_users_app/config/routes.rb

@@ -3,7 +3,7 @@ Rails.application.routes.draw do
     resources :users, only: %i[index create]
   end
 
-  resources :users, only: %i[index]
+  resources :users, only: %i[index show]
 
   get 'health', to: 'health#show'
 

data/spec/fixtures/rails6_users_app/spec/controllers/users_controller_api_spec.rb

@@ -21,7 +21,7 @@ RSpec.describe Api::UsersController, feature_group: 'Users', type: :controller,
       post :create, params: { login: 'alice' }
     end
     it 'lists the users' do
-      post :index, params: {}
+      get :index, params: {}
       users = JSON.parse(response.body)
       expect(users.map { |r| r['login'] }).to include('alice')
     end

data/spec/fixtures/rails6_users_app/spec/controllers/users_controller_spec.rb

@@ -0,0 +1,27 @@
+require 'rails_helper'
+require 'rack/test'
+
+RSpec.describe UsersController, type: :controller do
+  render_views
+
+  describe 'GET /users', feature: 'Show all users' do
+    before do
+      User.create login: 'alice'
+    end
+    it 'lists the users' do
+      get :index
+      expect(response).to be_ok
+    end
+  end
+
+  describe 'GET /users/:login', feature: 'Show a user' do
+    before do
+      User.create login: 'alice'
+    end
+
+    it 'shows the user' do
+      get :show, params: { id: 'alice' }
+      expect(response).to be_ok
+    end
+  end
+end

data/spec/hook_spec.rb

@@ -52,15 +52,51 @@ describe 'AppMap class Hooking', docker: false do
 
     events = collect_events(tracer).to_yaml
 
-    expect(Diffy::Diff.new(events_yaml, events).to_s).to eq('')
+    expect(Diffy::Diff.new(events_yaml, events).to_s).to eq('') if events_yaml
 
-    [ config, tracer ]
+    [ config, tracer, events ]
   end
 
   after do
     AppMap.configuration = nil
   end
 
+  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 ], %w[ExcludeTest])
+    AppMap.configuration = config
+
+    expect(config.never_hook?(ExcludeTest.new.method(:instance_method))).to be_truthy
+    expect(config.never_hook?(ExcludeTest.method(:cls_method))).to be_truthy
+  end
+
+  it 'parses labels from comments' do
+    _, tracer = invoke_test_file 'spec/fixtures/hook/labels.rb' do
+      ClassWithLabel.new.fn_with_label
+    end
+    class_map = AppMap.class_map(tracer.event_methods).to_yaml
+    expect(Diffy::Diff.new(<<~YAML, class_map).to_s).to eq('')
+    ---
+    - :name: spec/fixtures/hook/labels.rb
+      :type: package
+      :children:
+      - :name: ClassWithLabel
+        :type: class
+        :children:
+        - :name: fn_with_label
+          :type: function
+          :location: spec/fixtures/hook/labels.rb:4
+          :static: false
+          :labels:
+          - has-fn-label
+          :comment: "# @label has-fn-label\\n"
+          :source: |2
+              def fn_with_label
+              end
+      YAML
+  end
+
   it 'hooks an instance method that takes no arguments' do
     events_yaml = <<~YAML
     ---
@@ -517,24 +553,6 @@ describe 'AppMap class Hooking', docker: false do
       events_yaml = <<~YAML
       ---
       - :id: 1
-        :event: :call
-        :defined_class: NoToSMethod
-        :method_id: respond_to?
-        :path: spec/fixtures/hook/exception_method.rb
-        :lineno: 24
-        :static: false
-        :parameters:
-        - :name: :args
-          :class: Array
-          :value: "[:to_s]"
-          :kind: :rest
-        :receiver:
-          :class: Class
-          :value: NoToSMethod
-      - :id: 2
-        :event: :return
-        :parent_id: 1
-      - :id: 3
         :event: :call
         :defined_class: NoToSMethod
         :method_id: say_hello
@@ -545,9 +563,9 @@ describe 'AppMap class Hooking', docker: false do
         :receiver:
           :class: Class
           :value: NoToSMethod
-      - :id: 4
+      - :id: 2
         :event: :return
-        :parent_id: 3
+        :parent_id: 1
         :return_value:
           :class: String
           :value: hello
@@ -565,24 +583,6 @@ describe 'AppMap class Hooking', docker: false do
       events_yaml = <<~YAML
       ---
       - :id: 1
-        :event: :call
-        :defined_class: NoToSMethod
-        :method_id: respond_to?
-        :path: spec/fixtures/hook/exception_method.rb
-        :lineno: 24
-        :static: false
-        :parameters:
-        - :name: :args
-          :class: Array
-          :value: "[:to_s]"
-          :kind: :rest
-        :receiver:
-          :class: Class
-          :value: "*Error inspecting variable*"
-      - :id: 2
-        :event: :return
-        :parent_id: 1
-      - :id: 3
         :event: :call
         :defined_class: InspectRaises
         :method_id: say_hello
@@ -593,9 +593,9 @@ describe 'AppMap class Hooking', docker: false do
         :receiver:
           :class: Class
           :value: "*Error inspecting variable*"
-      - :id: 4
+      - :id: 2
         :event: :return
-        :parent_id: 3
+        :parent_id: 1
         :return_value:
           :class: String
           :value: hello
@@ -741,9 +741,33 @@ describe 'AppMap class Hooking', docker: false do
           :value: 'true'
       YAML
 
-      test_hook_behavior 'spec/fixtures/hook/compare.rb', events_yaml do
+      _, _, events = test_hook_behavior 'spec/fixtures/hook/compare.rb', nil do
         expect(Compare.compare('string', 'string')).to be_truthy
       end
+      secure_compare_event = YAML.load(events).find { |evt| evt[:defined_class] == 'ActiveSupport::SecurityUtils' }
+      secure_compare_event.delete(:lineno)
+
+      expect(Diffy::Diff.new(<<~YAML, secure_compare_event.to_yaml).to_s).to eq('')
+      ---
+      :id: 2
+      :event: :call
+      :defined_class: ActiveSupport::SecurityUtils
+      :method_id: secure_compare
+      :path: lib/active_support/security_utils.rb
+      :static: true
+      :parameters:
+      - :name: :a
+        :class: String
+        :value: string
+        :kind: :req
+      - :name: :b
+        :class: String
+        :value: string
+        :kind: :req
+      :receiver:
+        :class: Module
+        :value: ActiveSupport::SecurityUtils
+      YAML
     end
 
     it 'gets labeled in the classmap' do
@@ -806,16 +830,14 @@ describe 'AppMap class Hooking', docker: false do
               - crypto
       YAML
 
-      config, tracer = invoke_test_file 'spec/fixtures/hook/compare.rb' do
+      _, tracer = invoke_test_file 'spec/fixtures/hook/compare.rb' do
         expect(Compare.compare('string', 'string')).to be_truthy
       end
       cm = AppMap::Util.sanitize_paths(AppMap::ClassMap.build_from_methods(tracer.event_methods))
       entry = cm[1][:children][0][:children][0][:children][0]
       # Sanity check, make sure we got the right one
       expect(entry[:name]).to eq('secure_compare')
-      spec = Gem::Specification.find_by_name('activesupport')
-      entry[:location].gsub!(spec.base_dir + '/', '')
-      expect(Diffy::Diff.new(classmap_yaml, cm.to_yaml).to_s).to eq('')
+      expect(entry[:labels]).to eq(%w[provider.secure_compare])
     end
   end
 

data/spec/rails_spec_helper.rb

@@ -30,7 +30,7 @@ def run_cmd(*cmd, &failed)
 end
 
 shared_context 'Rails app pg database' do |fixture_dir|
-  let(:fixture_dir) { fixture_dir }
+  define_method(:fixture_dir) { fixture_dir }
 
   before(:all) do
     print_pg_logs = lambda do
@@ -40,7 +40,7 @@ shared_context 'Rails app pg database' do |fixture_dir|
       puts logs
     end
 
-    Dir.chdir fixture_dir do 
+    Dir.chdir fixture_dir do
       run_cmd 'docker-compose down -v'
       cmd = 'docker-compose up -d pg'
       run_cmd cmd