appmap 0.23.0 → 0.27.0

data/spec/rails_spec_helper.rb

@@ -3,7 +3,7 @@ require 'open3'
 
 def wait_for_container(app_name)
   start_time = Time.now
-  until (`docker-compose ps -q --filter health=healthy #{app_name}`.strip) != ''
+  until `docker-compose ps -q --filter health=healthy #{app_name}`.strip != ''
     elapsed = Time.now - start_time
     raise "Timeout waiting for container #{app_name} to be ready" if elapsed > 10
 
@@ -12,31 +12,40 @@ def wait_for_container(app_name)
   end
 end
 
-def run_cmd(*cmd)
-  out,s = Open3.capture2e(*cmd)
-  unless s.success?
-    $stderr.puts <<~END
-      Command failed:
-      #{cmd}
-      <<< Output:
-      #{out}
-      >>> End of output
-    END
-    raise 'Command failed'
-  end
+def run_cmd(*cmd, &failed)
+  out, status = Open3.capture2e(*cmd)
+  return [ out, status ] if status.success?
+
+  warn <<~WARNING
+    Command failed:
+    #{cmd}
+    <<< Output:
+    #{out}
+    >>> End of output
+  WARNING
+  failed&.call
+  raise 'Command failed'
 end
 
 shared_context 'Rails app pg database' do
   before(:all) do
-    raise "you must set @fixure_dir" unless @fixture_dir
-    
+    raise 'you must set @fixure_dir' unless @fixture_dir
+
+    print_pg_logs = lambda do
+      logs, = run_cmd 'docker-compose logs pg'
+      puts "docker-compose logs for pg:"
+      puts
+      puts logs
+    end
+
     Dir.chdir @fixture_dir do 
+      run_cmd 'docker-compose down -v'
       cmd = 'docker-compose up -d pg'
       run_cmd cmd
       wait_for_container 'pg'
 
       cmd = 'docker-compose run --rm app ./create_app'
-      run_cmd cmd
+      run_cmd cmd, &print_pg_logs
     end
   end
 

data/spec/railtie_spec.rb

@@ -32,7 +32,7 @@ describe 'AppMap tracer via Railtie' do
   describe 'with APPMAP=true' do
     let(:env) { { 'APPMAP' => 'true' } }
     it 'is enabled' do
-      expect(command_output).to eq('true')
+      expect(command_output.split("\n")).to include('true')
     end
     context 'and RAILS_ENV=test' do
       let(:env) { { 'APPMAP' => 'true', 'RAILS_ENV' => 'test' } }

data/spec/record_sql_rails_pg_spec.rb

@@ -3,13 +3,12 @@ require 'rails_spec_helper'
 describe 'Record SQL queries in a Rails app' do
   before(:all) { @fixture_dir = 'spec/fixtures/rails_users_app' }
   include_context 'Rails app pg database'
-  
+
   around(:each) do |example|
     FileUtils.rm_rf tmpdir
     FileUtils.mkdir_p tmpdir
     cmd = "docker-compose run --rm -e ORM_MODULE=#{orm_module} -e APPMAP=true -v #{File.absolute_path tmpdir}:/app/tmp app ./bin/rspec spec/controllers/users_controller_api_spec.rb:#{test_line_number}"
     run_cmd cmd, chdir: @fixture_dir
-    
 
     example.run
   end

data/spec/remote_recording_spec.rb

@@ -0,0 +1,117 @@
+require 'rails_spec_helper'
+require 'net/http'
+require 'socket'
+
+describe 'remote recording', :order => :defined do
+  before(:all) { @fixture_dir = 'spec/fixtures/rails_users_app' }
+  include_context 'Rails app pg database'
+
+  before(:all) do
+    start_cmd = 'docker-compose up -d app'
+    run_cmd({ 'ORM_MODULE' => 'sequel', 'APPMAP' => 'true' }, start_cmd, chdir: @fixture_dir)
+    Dir.chdir @fixture_dir do
+      wait_for_container 'app'
+    end
+
+    port_cmd = 'docker-compose port app 3000'
+    port_out, = run_cmd port_cmd, chdir: @fixture_dir
+    @service_port = port_out.strip.split(':')[1]
+
+    service_running = false
+    retry_count = 0
+    uri = URI("http://localhost:#{@service_port}/health")
+
+    until service_running
+      sleep(0.25)
+      begin
+        res = Net::HTTP.start(uri.hostname, uri.port) do |http|
+          http.request(Net::HTTP::Get.new(uri))
+        end
+
+        status = res.response.code.to_i
+        service_running = true if status >= 200 && status < 300
+
+        # give up after a certain error threshold is met
+        # we don't want to wait forever if there's an unrecoverable issue
+        raise 'gave up waiting on fixture service' if (retry_count += 1) == 10
+      rescue Errno::ETIMEDOUT, Errno::ECONNRESET, EOFError
+        $stderr.print('.')
+      end
+    end
+  end
+
+  def json_body(res)
+    JSON.parse(res.body).deep_symbolize_keys
+  end
+
+  after(:all) do
+    run_cmd 'docker-compose rm -fs app', chdir: @fixture_dir
+  end
+
+  let(:service_address) { URI("http://localhost:#{@service_port}") }
+  let(:users_path) { '/users' }
+  let(:record_path) { '/_appmap/record' }
+
+  it 'returns the recording status' do
+    res = Net::HTTP.start(service_address.hostname, service_address.port) { |http|
+      http.request(Net::HTTP::Get.new(record_path))
+    }
+
+    expect(res).to be_a(Net::HTTPOK)
+    expect(res['Content-Type']).to eq('application/json')
+    expect(json_body(res)).to eq(enabled: false)
+  end
+
+  it 'starts a new recording session' do
+    res = Net::HTTP.start(service_address.hostname, service_address.port) { |http|
+      http.request(Net::HTTP::Post.new(record_path))
+    }
+
+    expect(res).to be_a(Net::HTTPOK)
+  end
+
+  it 'reflects the recording status' do
+    res = Net::HTTP.start(service_address.hostname, service_address.port) { |http|
+      http.request(Net::HTTP::Get.new(record_path))
+    }
+
+    expect(res).to be_a(Net::HTTPOK)
+    expect(res['Content-Type']).to eq('application/json')
+    expect(json_body(res)).to eq(enabled: true)
+  end
+
+  it 'fails to start a new recording session while recording is already active' do
+    res = Net::HTTP.start(service_address.hostname, service_address.port) { |http|
+      http.request(Net::HTTP::Post.new(record_path))
+    }
+
+    expect(res).to be_a(Net::HTTPConflict)
+  end
+
+  it 'stops recording' do
+    # Generate some events
+    Net::HTTP.start(service_address.hostname, service_address.port) { |http|
+      http.request(Net::HTTP::Get.new(users_path) )
+    }
+
+    res = Net::HTTP.start(service_address.hostname, service_address.port) { |http|
+      http.request(Net::HTTP::Delete.new(record_path))
+    }
+
+    expect(res).to be_a(Net::HTTPOK)
+    expect(res['Content-Type']).to eq('application/json')
+
+    data = json_body(res)
+    expect(data[:metadata]).to be_truthy
+    expect(data[:classMap].length).to be > 0
+    expect(data[:events].length).to be > 0
+  end
+
+  it 'fails to stop recording if there is no active recording session' do
+    res = Net::HTTP.start(service_address.hostname, service_address.port) { |http|
+      http.request(Net::HTTP::Delete.new(record_path))
+    }
+
+    expect(res).to be_a(Net::HTTPNotFound)
+  end
+end

data/spec/spec_helper.rb

@@ -4,3 +4,8 @@ require 'json'
 require 'yaml'
 require 'English'
 require 'webdrivers/chromedriver'
+require 'appmap'
+
+RSpec.configure do |config|
+  config.example_status_persistence_file_path = "tmp/rspec_failed_examples.txt"
+end

data/test/cli_test.rb

@@ -13,40 +13,6 @@ class CLITest < Minitest::Test
     FileUtils.rm_f STATS_OUTPUT_FILENAME
   end
 
-  def test_config_file_must_exist
-    output = `./exe/appmap -c foobar inspect 2>&1`
-
-    assert_equal 1, $CHILD_STATUS.exitstatus
-    assert_includes output, 'No such file or directory'
-    assert_includes output, 'foobar'
-  end
-
-  def test_inspect_to_file
-    `./exe/appmap inspect -o #{OUTPUT_FILENAME}`
-
-    assert_equal 0, $CHILD_STATUS.exitstatus
-    assert File.file?(OUTPUT_FILENAME), "#{OUTPUT_FILENAME} does not exist"
-  end
-
-  def test_inspect_to_stdout
-    output = `./exe/appmap inspect -o -`
-
-    assert !File.file?(OUTPUT_FILENAME), "#{OUTPUT_FILENAME} should not exist"
-
-    assert_equal 0, $CHILD_STATUS.exitstatus
-    assert !output.blank?, 'Output should exist in stdout'
-  end
-
-  def test_inspect_fields
-    output = `./exe/appmap inspect -o -`
-
-    output = JSON.parse(output)
-    assert_includes output.keys, 'version'
-    assert_includes output.keys, 'classMap'
-    assert_includes output.keys, 'metadata'
-    assert !output.keys.include?('events')
-  end
-
   def test_record
     output = Dir.chdir 'test/fixtures/cli_record_test' do
       `#{File.expand_path '../exe/appmap', __dir__} record -o #{OUTPUT_FILENAME} ./lib/cli_record_test/main.rb`.strip
@@ -141,18 +107,10 @@ class CLITest < Minitest::Test
     end
 
     assert_equal 0, $CHILD_STATUS.exitstatus
-    assert_includes output, %("location":"lib/cli_record_test")
+    # Event path
+    assert_includes output, %("path":"lib/cli_record_test/main.rb")
+    # Function location
+    assert_includes output, %("location":"lib/cli_record_test/main.rb:3")
     assert !File.file?(OUTPUT_FILENAME), "#{OUTPUT_FILENAME} should not exist"
   end
-
-  def test_upload
-    `./exe/appmap inspect -o #{OUTPUT_FILENAME}`
-
-    upload_output = `./exe/appmap upload --no-open #{OUTPUT_FILENAME}`
-    assert_equal 0, $CHILD_STATUS.exitstatus
-    # Example: 93e1e07d-4b39-49ac-82bf-27d63e296cae
-    assert_match(/Scenario Id/, upload_output)
-    assert_match(/Batch Id/, upload_output)
-    assert_match(/[0-9a-f]+\-[0-9a-f\-]+/, upload_output)
-  end
 end

data/test/fixtures/cli_record_test/appmap.yml

@@ -1,2 +1,3 @@
+name: cli_record_test
 packages:
-  - path: lib/cli_record_test
+  - path: lib

data/test/fixtures/cli_record_test/lib/cli_record_test/main.rb

@@ -1,6 +1,8 @@
 class Main
-  def Main.say_hello
-    puts 'Hello'
+  class << self
+    def say_hello
+      puts 'Hello'
+    end
   end
 end
 

data/test/fixtures/rspec_recorder/Gemfile

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

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

@@ -3,6 +3,18 @@ require 'appmap/rspec'
 require 'hello'
 
 describe Hello, feature_group: 'Saying hello' do
+  before do
+    # Trick appmap-ruby into thinking we're a Rails app.
+    stub_const('Rails', double('rails', version: 'fake.0'))
+  end
+
+  # 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
+    expect(Hello.new.say_hello).not_to eq('Goodbye!')
+  end
+
   it 'says hello', feature: 'Speak hello', appmap: true do
     expect(Hello.new.say_hello).to eq('Hello!')
   end

data/test/rspec_test.rb

@@ -9,6 +9,7 @@ class RSpecTest < Minitest::Test
     Bundler.with_clean_env do
       Dir.chdir 'test/fixtures/rspec_recorder' do
         FileUtils.rm_rf 'tmp'
+        system 'bundle config --local local.appmap ../../..'
         system 'bundle'
         system({ 'APPMAP' => 'true' }, %(bundle exec rspec spec/#{test_name}.rb))
 
@@ -48,6 +49,10 @@ class RSpecTest < Minitest::Test
       assert_equal({ name: 'appmap', url: AppMap::URL, version: AppMap::VERSION }.stringify_keys, metadata['client'])
       assert_includes metadata.keys, 'recorder'
       assert_equal({ name: 'rspec' }.stringify_keys, metadata['recorder'])
+
+      assert_includes metadata.keys, 'frameworks'
+      rspec = metadata['frameworks'].select {|f| f['name'] == 'rspec'}
+      assert_equal 1, rspec.count
     end
   end
 

data/test/test_helper.rb

@@ -2,45 +2,3 @@ $LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 require 'appmap'
 
 require 'minitest/autorun'
-
-FIXTURE_DIR = File.join(__dir__, 'fixtures')
-PARSE_FILE_FIXTURE_DIR = File.join(FIXTURE_DIR, 'parse_file')
-INSPECT_PACKAGE_FIXTURE_DIR = File.join(FIXTURE_DIR, 'inspect_package')
-
-module FixturePath
-  def parse_fixture_file(path)
-    File.join(FIXTURE_DIR, 'parse_file', path)
-  end
-end
-
-module FixtureFile
-  include FixturePath
-
-  def assert_fixture_features(strategy, path)
-    require 'appmap/inspect'
-
-    features = Array(AppMap::Inspect.inspect_file(strategy, file_path: parse_fixture_file(path)))
-
-    fixup_fixture_path = lambda do |a|
-      a.location = a.location.gsub(PARSE_FILE_FIXTURE_DIR, '$FIXTURE_DIR')
-      a.children.each(&fixup_fixture_path)
-    end
-    features.each(&fixup_fixture_path)
-
-    expectation = JSON.parse(`ruby #{parse_fixture_file(path)}`)
-    expectation = expectation[strategy.to_s] \
-      if expectation.is_a?(Hash) && expectation[strategy.to_s]
-    warn JSON.pretty_generate(features.map(&:to_h)) if ENV['DEBUG']
-    assert_equal JSON.pretty_generate(expectation),
-                 JSON.pretty_generate(features.map(&:to_h))
-  end
-end
-
-# Verify that the fixture files are valid
-Dir.new(PARSE_FILE_FIXTURE_DIR)
-   .entries
-   .select { |e| File.file?(File.join(PARSE_FILE_FIXTURE_DIR, e)) && e.index('.rb') == e.size - 3 }
-   .each do |e|
-  fname = File.join(PARSE_FILE_FIXTURE_DIR, e)
-  raise "Fixture #{fname.inspect} is not valid" unless system("ruby #{fname} > /dev/null")
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.23.0
+  version: 0.27.0
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-27 00:00:00.000000000 Z
+date: 2020-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -112,16 +112,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: climate_control
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: diffy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: launchy
   requirement: !ruby/object:Gem::Requirement
@@ -210,7 +238,6 @@ description:
 email:
 - kgilpin@gmail.com
 executables:
-- _appmap-record-self
 - appmap
 extensions: []
 extra_rdoc_files: []
@@ -235,36 +262,21 @@ 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-record-self
 - exe/appmap
 - lib/appmap.rb
 - lib/appmap/algorithm/prune_class_map.rb
 - lib/appmap/algorithm/stats.rb
-- lib/appmap/command/inspect.rb
+- lib/appmap/class_map.rb
 - lib/appmap/command/record.rb
 - lib/appmap/command/stats.rb
-- lib/appmap/command/upload.rb
-- lib/appmap/config.rb
-- lib/appmap/config/directory.rb
-- lib/appmap/config/file.rb
-- lib/appmap/config/named_function.rb
-- lib/appmap/config/package_dir.rb
-- lib/appmap/config/path.rb
-- lib/appmap/feature.rb
-- lib/appmap/inspect.rb
-- lib/appmap/inspect/inspector.rb
-- lib/appmap/inspect/parse_node.rb
-- lib/appmap/inspect/parser.rb
+- lib/appmap/event.rb
+- lib/appmap/hook.rb
 - lib/appmap/middleware/remote_recording.rb
-- lib/appmap/parser.rb
 - lib/appmap/rails/action_handler.rb
 - lib/appmap/rails/sql_handler.rb
 - lib/appmap/railtie.rb
 - lib/appmap/rspec.rb
-- lib/appmap/rspec/parse_node.rb
-- lib/appmap/rspec/parser.rb
-- lib/appmap/trace/event_handler/rack_handler_webrick.rb
-- lib/appmap/trace/tracer.rb
+- lib/appmap/trace.rb
 - lib/appmap/version.rb
 - lore/pages/2019-05-21-install-and-record/index.pug
 - lore/pages/2019-05-21-install-and-record/install_example_appmap.png
@@ -287,6 +299,12 @@ files:
 - package.json
 - spec/abstract_controller4_base_spec.rb
 - spec/abstract_controller_base_spec.rb
+- spec/config_spec.rb
+- spec/fixtures/hook/attr_accessor.rb
+- spec/fixtures/hook/class_method.rb
+- spec/fixtures/hook/constructor.rb
+- spec/fixtures/hook/exception_method.rb
+- spec/fixtures/hook/instance_method.rb
 - spec/fixtures/rack_users_app/.dockerignore
 - spec/fixtures/rack_users_app/.gitignore
 - spec/fixtures/rack_users_app/Dockerfile
@@ -378,7 +396,6 @@ files:
 - spec/fixtures/rails_users_app/app/views/layouts/application.html.haml
 - spec/fixtures/rails_users_app/app/views/users/index.html.haml
 - spec/fixtures/rails_users_app/appmap.yml
-- spec/fixtures/rails_users_app/bin/_appmap-record-self
 - spec/fixtures/rails_users_app/bin/appmap
 - spec/fixtures/rails_users_app/bin/byebug
 - spec/fixtures/rails_users_app/bin/gli
@@ -427,59 +444,25 @@ files:
 - spec/fixtures/rails_users_app/spec/rails_helper.rb
 - spec/fixtures/rails_users_app/spec/spec_helper.rb
 - spec/fixtures/rails_users_app/users_app/.gitignore
-- spec/rack_handler_webrick_spec.rb
+- spec/hook_spec.rb
 - spec/rails_spec_helper.rb
 - spec/railtie_spec.rb
 - spec/record_sql_rails4_pg_spec.rb
 - spec/record_sql_rails_pg_spec.rb
+- spec/remote_recording_spec.rb
 - spec/rspec_feature_metadata_spec.rb
 - spec/spec_helper.rb
 - test/cli_test.rb
-- test/config_test.rb
-- test/explict_inspect_test.rb
-- test/fixtures/active_record_like/active_record.rb
-- test/fixtures/active_record_like/active_record/aggregations.rb
-- test/fixtures/active_record_like/active_record/association.rb
-- test/fixtures/active_record_like/active_record/associations/join_dependency.rb
-- test/fixtures/active_record_like/active_record/associations/join_dependency/join_base.rb
-- test/fixtures/active_record_like/active_record/associations/join_dependency/join_part.rb
-- test/fixtures/active_record_like/active_record/caps/caps.rb
 - test/fixtures/cli_record_test/appmap.yml
 - test/fixtures/cli_record_test/lib/cli_record_test/main.rb
-- test/fixtures/ignore_non_ruby_file/class.rb
-- test/fixtures/ignore_non_ruby_file/non-ruby.txt
-- test/fixtures/includes_excludes/lib/a/a_1.rb
-- test/fixtures/includes_excludes/lib/a/a_2.rb
-- test/fixtures/includes_excludes/lib/a/x/x_1.rb
-- test/fixtures/includes_excludes/lib/b/b_1.rb
-- test/fixtures/includes_excludes/lib/root_1.rb
-- test/fixtures/inspect_multiple_subdirs/module_a.rb
-- test/fixtures/inspect_multiple_subdirs/module_a/class_a.rb
-- test/fixtures/inspect_multiple_subdirs/module_b.rb
-- test/fixtures/inspect_multiple_subdirs/module_b/class_b.rb
-- test/fixtures/inspect_multiple_subdirs/module_b/class_c.rb
-- test/fixtures/inspect_package/module_a/module_b/class_in_module.rb
-- test/fixtures/parse_file/defs_static_function.rb
-- test/fixtures/parse_file/function_within_class.rb
-- test/fixtures/parse_file/include_public_methods.rb
-- test/fixtures/parse_file/instance_function.rb
-- test/fixtures/parse_file/modules.rb
-- test/fixtures/parse_file/sclass_static_function.rb
-- test/fixtures/parse_file/toplevel_class.rb
-- test/fixtures/parse_file/toplevel_function.rb
 - test/fixtures/rspec_recorder/Gemfile
 - test/fixtures/rspec_recorder/appmap.yml
 - test/fixtures/rspec_recorder/lib/hello.rb
 - test/fixtures/rspec_recorder/spec/decorated_hello_spec.rb
 - test/fixtures/rspec_recorder/spec/labeled_hello_spec.rb
 - test/fixtures/rspec_recorder/spec/plain_hello_spec.rb
-- test/fixtures/trace_test/trace_program_1.rb
-- test/implicit_inspect_test.rb
-- test/include_exclude_test.rb
-- test/prerecorded_trace_test.rb
 - test/rspec_test.rb
 - test/test_helper.rb
-- test/trace_test.rb
 homepage: https://github.com/applandinc/appmap-ruby
 licenses:
 - MIT