appmap 0.42.1 → 0.46.0

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/gem_test.rb

@@ -26,7 +26,7 @@ class MinitestTest < Minitest::Test
       assert_equal 2, events.size
       assert_equal 'call', events.first['event']
       assert_equal 'default_parser', events.first['method_id']
-      assert_equal "#{Gem.loaded_specs['parser'].gem_dir}/lib/parser/base.rb", events.first['path']
+      assert_match /\lib\/parser\/base\.rb$/, events.first['path']
       assert_equal 'return', events.second['event']
       assert_equal 1, events.second['parent_id']
     end

data/test/rspec_test.rb

@@ -18,19 +18,6 @@ class RSpecTest < Minitest::Test
     end
   end
 
-  def test_inventory
-    perform_test 'plain_hello_spec' do
-      appmap_file = 'tmp/appmap/rspec/Inventory.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 'Inventory', metadata['name']
-    end
-  end
-
   def test_record_decorated_rspec
     perform_test 'decorated_hello_spec' do
       appmap_file = 'tmp/appmap/rspec/Hello_says_hello.appmap.json'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.42.1
+  version: 0.46.0
 platform: ruby
 authors:
 - Kevin Gilpin
-autorequire:
-bindir: exe
+autorequire: 
+bindir: bin
 cert_chain: []
-date: 2021-03-29 00:00:00.000000000 Z
+date: 2021-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -304,11 +304,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: 
 email:
 - kgilpin@gmail.com
-executables:
-- appmap
+executables: []
 extensions:
 - ext/appmap/extconf.rb
 extra_rdoc_files: []
@@ -316,6 +315,7 @@ files:
 - ".dockerignore"
 - ".gitignore"
 - ".rbenv-gemsets"
+- ".releaserc.yml"
 - ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
@@ -324,6 +324,7 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
+- README_CI.md
 - Rakefile
 - appmap.gemspec
 - appmap.yml
@@ -334,7 +335,6 @@ files:
 - examples/mock_webapp/lib/mock_webapp/controller.rb
 - examples/mock_webapp/lib/mock_webapp/request.rb
 - examples/mock_webapp/lib/mock_webapp/user.rb
-- exe/appmap
 - ext/appmap/appmap.c
 - ext/appmap/extconf.rb
 - lib/appmap.rb
@@ -346,14 +346,17 @@ files:
 - lib/appmap/config.rb
 - lib/appmap/cucumber.rb
 - lib/appmap/event.rb
+- lib/appmap/handler/function.rb
+- lib/appmap/handler/net_http.rb
+- lib/appmap/handler/rails/request_handler.rb
+- lib/appmap/handler/rails/sql_handler.rb
+- lib/appmap/handler/rails/template.rb
 - lib/appmap/hook.rb
 - lib/appmap/hook/method.rb
 - lib/appmap/metadata.rb
 - lib/appmap/middleware/remote_recording.rb
 - lib/appmap/minitest.rb
 - lib/appmap/open.rb
-- lib/appmap/rails/request_handler.rb
-- lib/appmap/rails/sql_handler.rb
 - lib/appmap/railtie.rb
 - lib/appmap/record.rb
 - lib/appmap/rspec.rb
@@ -379,16 +382,19 @@ files:
 - lore/public/stylesheets/style.css
 - package-lock.json
 - package.json
+- release.sh
 - spec/abstract_controller_base_spec.rb
 - spec/class_map_spec.rb
 - spec/config_spec.rb
 - spec/fixtures/hook/attr_accessor.rb
 - spec/fixtures/hook/compare.rb
 - spec/fixtures/hook/constructor.rb
+- spec/fixtures/hook/custom_instance_method.rb
 - spec/fixtures/hook/exception_method.rb
 - spec/fixtures/hook/exclude.rb
 - spec/fixtures/hook/instance_method.rb
 - spec/fixtures/hook/labels.rb
+- spec/fixtures/hook/method_named_call.rb
 - spec/fixtures/hook/singleton_method.rb
 - spec/fixtures/rack_users_app/.dockerignore
 - spec/fixtures/rack_users_app/.gitignore
@@ -546,11 +552,11 @@ files:
 - spec/open_spec.rb
 - spec/rails_spec_helper.rb
 - spec/railtie_spec.rb
+- spec/record_net_http_spec.rb
 - spec/record_sql_rails_pg_spec.rb
 - spec/remote_recording_spec.rb
 - spec/spec_helper.rb
 - spec/util_spec.rb
-- test/cli_test.rb
 - test/cucumber_test.rb
 - test/expectations/openssl_test_key_sign1.json
 - test/expectations/openssl_test_key_sign2.json
@@ -600,7 +606,7 @@ homepage: https://github.com/applandinc/appmap-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -615,8 +621,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.0.8
+signing_key: 
 specification_version: 4
 summary: Record the operation of a Ruby program, using the AppLand 'AppMap' format.
 test_files: []

data/exe/appmap

@@ -1,154 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'gli'
-
-ENV['APPMAP_INITIALIZE'] = 'false'
-
-require 'appmap'
-require 'appmap/version'
-
-# AppMap CLI.
-module AppMap
-  class App
-    extend GLI::App
-
-    program_desc 'AppMap client'
-
-    version AppMap::VERSION
-
-    subcommand_option_handling :normal
-    arguments :strict
-    preserve_argv true
-
-    class << self
-      protected
-
-      def default_appmap_file
-        ENV['APPMAP_FILE'] || 'appmap.json'
-      end
-
-      def output_file_flag(c, default_value: nil)
-        c.desc 'Name of the output file'
-        c.long_desc <<~DESC
-        Use a single dash '-' for stdout.
-        DESC
-        c.default_value default_value if default_value
-        c.arg_name 'filename'
-        c.flag %i[o output]
-      end
-    end
-
-    desc 'AppMap configuration file name'
-    default_value ENV['APPMAP_CONFIG'] || 'appmap.yml'
-    arg_name 'filename'
-    flag %i[c config]
-
-    desc 'Record the execution of a program and generate an AppMap.'
-    arg_name 'program'
-    command :record do |c|
-      output_file_flag(c, default_value: default_appmap_file)
-
-      c.action do |_, _, args|
-        # My subcommand name
-        ARGV.shift
-
-        # Consume the :output option, if provided
-        if %w[-o --output].find { |arg_name| ARGV[0] == arg_name.to_s }
-          ARGV.shift
-          ARGV.shift
-        end
-
-        # Name of the program to execute. GLI will ensure that it's present.
-        program = args.shift or help_now!("'program' argument is required")
-
-        # Also pop the program name from ARGV, because the command will use raw ARGV
-        # to load the extra arguments into this Ruby process.
-        ARGV.shift
-
-        require 'appmap/command/record'
-        AppMap::Command::Record.new(@config, program).perform do |version, metadata, class_map, events|
-          @output_file.write JSON.generate(version: version,
-                                           metadata: metadata,
-                                           classMap: class_map,
-                                           events: events)
-        end
-      end
-    end
-
-    desc 'Calculate and print statistics of scenario files.'
-    arg_name 'filename'
-    command :stats do |c|
-      output_file_flag(c, default_value: '-')
-
-      c.desc 'Display format for the result (text | json)'
-      c.default_value 'text'
-      c.flag %i[f format]
-
-      c.desc 'Maximum number of lines to display for each stat'
-      c.flag %i[l limit]
-
-      c.action do |_, options, args|
-        require 'appmap/command/stats'
-
-        limit = options[:limit].to_i if options[:limit]
-
-        # Name of the file to analyze. GLI will ensure that it's present.
-        filenames = args
-        help_now!("'filename' argument is required") if filenames.empty?
-
-        require 'appmap/algorithm/stats'
-        result = filenames.inject(::AppMap::Algorithm::Stats::Result.new([], [])) do |stats_result, filename|
-          appmap = begin
-            JSON.parse(File.read(filename))
-          rescue JSON::ParserError
-            STDERR.puts "#{filename} is not valid JSON : #{$!}"
-            nil
-          end
-          stats_result.tap do
-            if appmap
-              limit = options[:limit].to_i if options[:limit]
-              stats_for_file = AppMap::Command::Stats.new(appmap).perform(limit: limit)
-              stats_result.merge!(stats_for_file)
-            end
-          end
-        end
-
-        result.sort!
-        result.limit!(limit) if limit
-
-        display = case options[:format]
-        when 'json'
-          JSON.pretty_generate(result.as_json)
-        else
-          result.as_text
-        end
-        @output_file.write display
-      end
-    end
-
-    pre do |global, _, options, _|
-      @config = interpret_config_option(global[:config])
-      @output_file = interpret_output_file_option(options[:output])
-
-      true
-    end
-
-    class << self
-      protected
-
-      def interpret_config_option(fname)
-        AppMap.initialize fname
-      end
-
-      def interpret_output_file_option(file_name)
-        Hash.new { |_, fname| -> { File.new(fname, 'w') } }.tap do |open_output_file|
-          open_output_file[nil] = -> { nil }
-          open_output_file['-'] = -> { $stdout }
-        end[file_name].call
-      end
-    end
-  end
-end
-
-exit AppMap::App.run(ARGV)