appmap 0.41.2 → 0.45.0

data/spec/fixtures/rails6_users_app/spec/rails_helper.rb

@@ -45,7 +45,6 @@ RSpec.configure do |config|
   # arbitrary gems may also be filtered via:
   # config.filter_gems_from_backtrace("gem name")
 
-
   DatabaseCleaner.allow_remote_database_url = true
   
   config.before(:suite) do
@@ -54,13 +53,8 @@ RSpec.configure do |config|
   end
 
   config.around :each do |example|
-    # Enable the use of 'return' from a guard
-    -> {
-      return example.run unless %i[model controller].member?(example.metadata[:type])
-
-      DatabaseCleaner.cleaning do
-        example.run
-      end
-    }.call
+    DatabaseCleaner.cleaning do
+      example.run
+    end
   end
 end

data/spec/hook_spec.rb

@@ -16,14 +16,7 @@ end
 Psych::Visitors::YAMLTree.prepend(ShowYamlNulls)
 
 describe 'AppMap class Hooking', docker: false do
-  require 'appmap/util'
-  def collect_events(tracer)
-    [].tap do |events|
-      while tracer.event?
-        events << tracer.next_event.to_h
-      end
-    end.map(&AppMap::Util.method(:sanitize_event))
-  end
+  include_context 'collect events'
 
   def invoke_test_file(file, setup: nil, &block)
     AppMap.configuration = nil
@@ -64,13 +57,144 @@ describe 'AppMap class Hooking', docker: false do
   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])
+    config = AppMap::Config.new('hook_spec', [ package ], exclude: %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 "handles an instance method named 'call' without issues" do
+    events_yaml = <<~YAML
+    ---
+    - :id: 1
+      :event: :call
+      :defined_class: MethodNamedCall
+      :method_id: call
+      :path: spec/fixtures/hook/method_named_call.rb
+      :lineno: 8
+      :static: false
+      :parameters:
+      - :name: :a
+        :class: Integer
+        :value: '1'
+        :kind: :req
+      - :name: :b
+        :class: Integer
+        :value: '2'
+        :kind: :req
+      - :name: :c
+        :class: Integer
+        :value: '3'
+        :kind: :req
+      - :name: :d
+        :class: Integer
+        :value: '4'
+        :kind: :req
+      - :name: :e
+        :class: Integer
+        :value: '5'
+        :kind: :req
+      :receiver:
+        :class: MethodNamedCall
+        :value: MethodNamedCall
+    - :id: 2
+      :event: :return
+      :parent_id: 1
+      :return_value:
+        :class: String
+        :value: 1 2 3 4 5
+    YAML
+
+    _, tracer = test_hook_behavior 'spec/fixtures/hook/method_named_call.rb', events_yaml do
+      expect(MethodNamedCall.new.call(1, 2, 3, 4, 5)).to eq('1 2 3 4 5')
+    end
+    class_map = AppMap.class_map(tracer.event_methods)
+    expect(Diffy::Diff.new(<<~CLASSMAP, YAML.dump(class_map)).to_s).to eq('')
+    ---
+    - :name: spec/fixtures/hook/method_named_call.rb
+      :type: package
+      :children:
+      - :name: MethodNamedCall
+        :type: class
+        :children:
+        - :name: call
+          :type: function
+          :location: spec/fixtures/hook/method_named_call.rb:8
+          :static: false
+    CLASSMAP
+  end
+
+  it 'can custom hook and label a function' do
+    events_yaml = <<~YAML
+    ---
+    - :id: 1
+      :event: :call
+      :defined_class: CustomInstanceMethod
+      :method_id: say_default
+      :path: spec/fixtures/hook/custom_instance_method.rb
+      :lineno: 8
+      :static: false
+      :parameters: []
+      :receiver:
+        :class: CustomInstanceMethod
+        :value: CustomInstance Method fixture
+    - :id: 2
+      :event: :return
+      :parent_id: 1
+      :return_value:
+        :class: String
+        :value: default
+    YAML
+
+    config = AppMap::Config.load({
+      functions: [
+        {
+          package: 'hook_spec',
+          class: 'CustomInstanceMethod',
+          functions: [ :say_default ],
+          labels: ['cowsay']
+        }
+      ]
+    }.deep_stringify_keys)
+
+    load 'spec/fixtures/hook/custom_instance_method.rb'
+    hook_cls = CustomInstanceMethod
+    method = hook_cls.instance_method(:say_default)
+
+    require 'appmap/hook/method'
+    hook_method = AppMap::Hook::Method.new(config.package_for_method(method), hook_cls, method)
+    hook_method.activate
+
+    tracer = AppMap.tracing.trace
+    AppMap::Event.reset_id_counter
+    begin
+      expect(CustomInstanceMethod.new.say_default).to eq('default')
+    ensure
+      AppMap.tracing.delete(tracer)
+    end
+
+    events = collect_events(tracer).to_yaml
+
+    expect(Diffy::Diff.new(events_yaml, events).to_s).to eq('')
+    class_map = AppMap.class_map(tracer.event_methods)
+    expect(Diffy::Diff.new(<<~CLASSMAP, YAML.dump(class_map)).to_s).to eq('')
+    ---
+    - :name: hook_spec
+      :type: package
+      :children:
+      - :name: CustomInstanceMethod
+        :type: class
+        :children:
+        - :name: say_default
+          :type: function
+          :location: spec/fixtures/hook/custom_instance_method.rb:8
+          :static: false
+          :labels:
+          - cowsay
+    CLASSMAP
+  end
+
   it 'parses labels from comments' do
     _, tracer = invoke_test_file 'spec/fixtures/hook/labels.rb' do
       ClassWithLabel.new.fn_with_label
@@ -91,9 +215,6 @@ describe 'AppMap class Hooking', docker: false do
           :labels:
           - has-fn-label
           :comment: "# @label has-fn-label\\n"
-          :source: |2
-              def fn_with_label
-              end
       YAML
   end
 
@@ -148,10 +269,6 @@ describe 'AppMap class Hooking', docker: false do
           :type: function
           :location: spec/fixtures/hook/instance_method.rb:8
           :static: false
-          :source: |2
-              def say_default
-                'default'
-              end
     YAML
   end
 
@@ -746,6 +863,7 @@ describe 'AppMap class Hooking', docker: false do
       end
       secure_compare_event = YAML.load(events).find { |evt| evt[:defined_class] == 'ActiveSupport::SecurityUtils' }
       secure_compare_event.delete(:lineno)
+      secure_compare_event.delete(:path)
 
       expect(Diffy::Diff.new(<<~YAML, secure_compare_event.to_yaml).to_s).to eq('')
       ---
@@ -753,7 +871,6 @@ describe 'AppMap class Hooking', docker: false do
       :event: :call
       :defined_class: ActiveSupport::SecurityUtils
       :method_id: secure_compare
-      :path: lib/active_support/security_utils.rb
       :static: true
       :parameters:
       - :name: :a
@@ -837,7 +954,7 @@ describe 'AppMap class Hooking', docker: false do
       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')
-      expect(entry[:labels]).to eq(%w[provider.secure_compare])
+      expect(entry[:labels]).to eq(%w[crypto.secure_compare])
     end
   end
 

data/spec/record_net_http_spec.rb

@@ -0,0 +1,160 @@
+require 'spec_helper'
+require 'diffy'
+require 'rack'
+require 'rack/handler/webrick'
+
+class HelloWorldApp
+  def call(env)
+    req = Rack::Request.new(env)
+    case req.path_info
+    when /hello/
+      [200, {"Content-Type" => "text/html"}, ["Hello World!"]]
+    when /goodbye/  
+      [500, {"Content-Type" => "text/html"}, ["Goodbye Cruel World!"]]
+    else
+      [404, {"Content-Type" => "text/html"}, ["I'm Lost!"]]
+    end
+  end
+end
+
+describe 'Net::HTTP handler' do
+  include_context 'collect events'
+
+  def get_hello(params: nil)
+    http = Net::HTTP.new('localhost', 19292)
+    http.get [ '/hello', params ].compact.join('?')
+  end
+  
+  before(:all) do
+    @rack_thread = Thread.new do
+      Rack::Handler::WEBrick.run HelloWorldApp.new, Port: 19292
+    end
+    10.times do
+      sleep 0.1
+      break if get_hello.code.to_i == 200
+    end
+    raise "Web server didn't start" unless get_hello.code.to_i == 200
+  end
+
+  after(:all) do
+    @rack_thread.kill
+  end
+
+  def start_recording
+    AppMap.configuration = configuration
+    AppMap::Hook.new(configuration).enable
+
+    @tracer = AppMap.tracing.trace
+    AppMap::Event.reset_id_counter
+  end
+
+  def record(&block)
+    start_recording
+    begin
+      yield
+    ensure
+      stop_recording
+    end
+  end
+
+  def stop_recording
+    AppMap.tracing.delete(@tracer)
+  end
+
+  context 'with trace enabled' do
+    let(:configuration) { AppMap::Config.new('record_net_http_spec', []) }
+
+    after do
+      AppMap.configuration = nil
+    end
+    
+    describe 'GET request' do
+      it 'with a single query parameter' do
+        record do
+          get_hello(params: 'msg=hi')
+        end
+
+        events = collect_events(@tracer).to_yaml
+        expect(Diffy::Diff.new(<<~EVENTS, events).to_s).to eq('')
+        ---
+        - :id: 1
+          :event: :call
+          :http_client_request:
+            :request_method: GET
+            :url: http://localhost:19292/hello
+            :headers:
+              Accept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+              Accept: "*/*"
+              User-Agent: Ruby
+              Connection: close
+          :message:
+          - :name: msg
+            :class: String
+            :value: hi
+        - :id: 2
+          :event: :return
+          :parent_id: 1
+          :http_client_response:
+            :status_code: 200
+            :headers:
+              Content-Type: text/html
+              Server: WEBrick
+              Date: "<instanceof date>"
+              Content-Length: '12'
+              Connection: close
+        EVENTS
+      end
+
+      it 'with a multi-valued query parameter' do
+        record do
+          get_hello(params: 'ary[]=1&ary[]=2')
+        end
+
+        event = collect_events(@tracer).first.to_yaml
+        expect(Diffy::Diff.new(<<~EVENT, event).to_s).to eq('')
+        ---
+        :id: 1
+        :event: :call
+        :http_client_request:
+          :request_method: GET
+          :url: http://localhost:19292/hello
+          :headers:
+            Accept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+            Accept: "*/*"
+            User-Agent: Ruby
+            Connection: close
+        :message:
+        - :name: ary
+          :class: Array
+          :value: '["1", "2"]'
+        EVENT
+      end
+
+      it 'with a URL encoded query parameter' do
+        msg = 'foo/bar?baz'
+        record do
+          get_hello(params: "msg=#{CGI.escape msg}")
+        end
+
+        event = collect_events(@tracer).first.to_yaml
+        expect(Diffy::Diff.new(<<~EVENT, event).to_s).to eq('')
+        ---
+        :id: 1
+        :event: :call
+        :http_client_request:
+          :request_method: GET
+          :url: http://localhost:19292/hello
+          :headers:
+            Accept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+            Accept: "*/*"
+            User-Agent: Ruby
+            Connection: close
+        :message:
+        - :name: msg
+          :class: String
+          :value: #{msg}
+        EVENT
+      end
+    end
+  end
+end

data/spec/record_sql_rails_pg_spec.rb

@@ -61,7 +61,7 @@ describe 'SQL events' do
       end
 
       context 'while listing records' do
-        let(:test_line_number) { 23 }
+        let(:test_line_number) { 29 }
         let(:appmap_json) { File.join(tmpdir, 'appmap/rspec/Api_UsersController_GET_api_users_lists_the_users.appmap.json') }
 
         context 'using Sequel ORM' do

data/spec/spec_helper.rb

@@ -14,3 +14,19 @@ require 'appmap'
 RSpec.configure do |config|
   config.example_status_persistence_file_path = "tmp/rspec_failed_examples.txt"
 end
+
+# Re-run the Rails specs without re-generating the data. This is useful for efficiently enhancing and
+# debugging the test itself.
+def use_existing_data?
+  ENV['USE_EXISTING_DATA'] == 'true'
+end
+
+shared_context 'collect events' do
+  def collect_events(tracer)
+    [].tap do |events|
+      while tracer.event?
+        events << tracer.next_event.to_h
+      end
+    end.map(&AppMap::Util.method(:sanitize_event))
+  end
+end

data/test/expectations/openssl_test_key_sign1.json

@@ -11,8 +11,7 @@
             "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"
+            "static": true
           }
         ]
       }
@@ -40,8 +39,7 @@
                     "location": "OpenSSL::PKey::PKey#sign",
                     "static": false,
                     "labels": [
-                      "security",
-                      "crypto"
+                      "crypto.pkey"
                     ]
                   }
                 ]

data/test/fixtures/rspec_recorder/spec/decorated_hello_spec.rb

@@ -2,7 +2,7 @@ require 'rspec'
 require 'appmap/rspec'
 require 'hello'
 
-describe Hello, feature_group: 'Saying hello' do
+describe Hello do
   before do
     # Trick appmap-ruby into thinking we're a Rails app.
     stub_const('Rails', double('rails', version: 'fake.0'))
@@ -11,11 +11,11 @@ describe Hello, feature_group: 'Saying hello' do
   # The order of these examples is important. The tests check the
   # appmap for 'says hello', and we want another example to get run
   # before it.
-  it 'does not say goodbye', feature: 'Speak hello', appmap: true do
+  it 'does not say goodbye' do
     expect(Hello.new.say_hello).not_to eq('Goodbye!')
   end
 
-  it 'says hello', feature: 'Speak hello', appmap: true do
+  it 'says hello' do
     expect(Hello.new.say_hello).to eq('Hello!')
   end
 end