appmap 0.18.1

data/test/fixtures/parse_file/include_public_methods.rb

@@ -0,0 +1,127 @@
+# @appmap include=public_methods
+class Main
+  class << self
+    def sclass_function
+    end
+  end
+
+  def public_function
+  end
+
+  protected
+
+  def protected_function
+  end
+
+  def Main.protected_function_2
+  end
+
+  def self.protected_function_3
+  end
+
+  public
+
+  def public_function_2
+  end
+end
+
+module Mod
+end
+
+# @appmap include=public_methods
+class M2
+  include Mod
+
+  def public_function_3
+  end
+end
+
+puts DATA.read
+__END__
+{
+  "explicit": [
+    {
+      "name": "Main",
+      "location": "$FIXTURE_DIR/include_public_methods.rb:2",
+      "attributes": {
+        "include": "public_methods"
+      },
+      "type": "class",
+      "children": [
+        {
+          "name": "public_function",
+          "location": "$FIXTURE_DIR/include_public_methods.rb:8",
+          "type": "function",
+          "static": false
+        },
+        {
+          "name": "public_function_2",
+          "location": "$FIXTURE_DIR/include_public_methods.rb:24",
+          "type": "function",
+          "static": false
+        }
+      ]
+    },    
+    {
+      "name": "M2",
+      "location": "$FIXTURE_DIR/include_public_methods.rb:32",
+      "attributes": {
+        "include": "public_methods"
+      },
+      "type": "class",
+      "children": [
+        {
+          "name": "public_function_3",
+          "location": "$FIXTURE_DIR/include_public_methods.rb:35",
+          "type": "function",
+          "static": false
+        }
+      ]
+    }
+  ],
+  "implicit": [
+    {
+      "name": "Main",
+      "location": "$FIXTURE_DIR/include_public_methods.rb:2",
+      "type": "class",
+      "children": [
+        {
+          "name": "sclass_function",
+          "location": "$FIXTURE_DIR/include_public_methods.rb:4",
+          "type": "function",
+          "static": true
+        },
+        {
+          "name": "public_function",
+          "location": "$FIXTURE_DIR/include_public_methods.rb:8",
+          "type": "function",
+          "static": false
+        },
+        {
+          "name": "public_function_2",
+          "location": "$FIXTURE_DIR/include_public_methods.rb:24",
+          "type": "function",
+          "static": false
+        }
+      ]
+    },
+    {
+      "name": "Mod",
+      "location": "$FIXTURE_DIR/include_public_methods.rb:28",
+      "type": "class"
+    },
+    {
+      "name": "M2",
+      "location": "$FIXTURE_DIR/include_public_methods.rb:32",
+      "type": "class",
+      "children": [
+        {
+          "name": "public_function_3",
+          "location": "$FIXTURE_DIR/include_public_methods.rb:35",
+          "type": "function",
+          "static": false
+        }
+      ]
+    }
+  ]
+}

data/test/fixtures/parse_file/instance_function.rb

@@ -0,0 +1,17 @@
+class Main
+  # @appmap
+  def instance_func
+  end
+end
+
+puts DATA.read
+__END__
+[
+  {
+    "name": "instance_func",
+    "location": "$FIXTURE_DIR/instance_func.rb:3",
+    "type": "function",
+    "class_name": "Main",
+    "static": false
+  }
+]

data/test/fixtures/parse_file/modules.rb

@@ -0,0 +1,71 @@
+module Main
+  def main_func; end
+
+  module MainModule
+    def module_func; end
+
+    def MainModule.module_class_func; end
+  end
+
+  class Cls
+    module ClsModule
+      def cls_module_func; end
+    end
+  end
+end
+puts DATA.read
+__END__
+[
+  {
+    "name": "Main",
+    "location": "$FIXTURE_DIR/modules.rb:1",
+    "type": "class",
+    "children": [
+      {
+        "name": "main_func",
+        "location": "$FIXTURE_DIR/modules.rb:2",
+        "type": "function",
+        "static": false
+      },
+      {
+        "name": "MainModule",
+        "location": "$FIXTURE_DIR/modules.rb:4",
+        "type": "class",
+        "children": [
+          {
+            "name": "module_func",
+            "location": "$FIXTURE_DIR/modules.rb:5",
+            "type": "function",
+            "static": false
+          },
+          {
+            "name": "module_class_func",
+            "location": "$FIXTURE_DIR/modules.rb:7",
+            "type": "function",
+            "static": true
+          }
+        ]
+      },
+      {
+        "name": "Cls",
+        "location": "$FIXTURE_DIR/modules.rb:10",
+        "type": "class",
+        "children": [
+          {
+            "name": "ClsModule",
+            "location": "$FIXTURE_DIR/modules.rb:11",
+            "type": "class",
+            "children": [
+              {
+                "name": "cls_module_func",
+                "location": "$FIXTURE_DIR/modules.rb:12",
+                "type": "function",
+                "static": false
+              }
+            ]
+          }
+        ]
+      }
+    ]
+  }
+]

data/test/fixtures/parse_file/sclass_static_function.rb

@@ -0,0 +1,88 @@
+obj = Object.new
+class << obj
+  # @appmap
+  def object_sclass_func
+  end
+end
+
+class Main
+  class << self
+    # @appmap
+    def main_sclass_func_1
+    end
+  end
+end
+
+class Main2
+  class << self
+    # @appmap
+    def main_sclass_func_1
+    end
+
+    # @appmap
+    def main_sclass_func_2
+    end
+  end
+end
+
+puts DATA.read
+__END__
+{
+  "explicit": [
+    {
+      "name": "main_sclass_func_1",
+      "location": "$FIXTURE_DIR/sclass_static_function.rb:11",
+      "type": "function",
+      "class_name": "Main",
+      "static": true
+    },
+    {
+      "name": "main_sclass_func_1",
+      "location": "$FIXTURE_DIR/sclass_static_function.rb:19",
+      "type": "function",
+      "class_name": "Main2",
+      "static": true
+    },
+    {
+      "name": "main_sclass_func_2",
+      "location": "$FIXTURE_DIR/sclass_static_function.rb:23",
+      "type": "function",
+      "class_name": "Main2",
+      "static": true
+    }
+  ],
+  "implicit": [
+    {
+      "name": "Main",
+      "location": "$FIXTURE_DIR/sclass_static_function.rb:8",
+      "type": "class",
+      "children": [
+        {
+          "name": "main_sclass_func_1",
+          "location": "$FIXTURE_DIR/sclass_static_function.rb:11",
+          "type": "function",
+          "static": true
+        }
+      ]
+    },
+    {
+      "name": "Main2",
+      "location": "$FIXTURE_DIR/sclass_static_function.rb:16",
+      "type": "class",
+      "children": [
+        {
+          "name": "main_sclass_func_1",
+          "location": "$FIXTURE_DIR/sclass_static_function.rb:19",
+          "type": "function",
+          "static": true
+        },
+        {
+          "name": "main_sclass_func_2",
+          "location": "$FIXTURE_DIR/sclass_static_function.rb:23",
+          "type": "function",
+          "static": true
+        }
+      ]
+    }
+  ]
+}

data/test/fixtures/parse_file/toplevel_class.rb

@@ -0,0 +1,13 @@
+# @appmap
+class Main
+end
+
+puts DATA.read
+__END__
+[
+  {
+    "name": "Main",
+    "location": "$FIXTURE_DIR/toplevel_class.rb:2",
+    "type": "class"
+  }
+]

data/test/fixtures/parse_file/toplevel_function.rb

@@ -0,0 +1,14 @@
+# @appmap
+def main
+end
+
+puts DATA.read
+__END__
+[
+  {
+    "name": "main",
+    "location": "$FIXTURE_DIR/toplevel_function.rb:2",
+    "type": "function",
+    "static": false
+  }
+]

data/test/fixtures/rspec_recorder/Gemfile

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

data/test/fixtures/rspec_recorder/appmap.yml

@@ -0,0 +1,3 @@
+name: rspec_recorder
+packages:
+  - path: lib

data/test/fixtures/rspec_recorder/lib/hello.rb

@@ -0,0 +1,5 @@
+class Hello
+  def say_hello
+    'Hello!'
+  end
+end

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

@@ -0,0 +1,9 @@
+require 'rspec'
+require 'appmap/rspec'
+require 'hello'
+
+describe Hello, feature_group: 'Hello' do
+  it 'says hello', feature: 'Say hello', appmap: true do
+    expect(Hello.new.say_hello).to eq('Hello!')
+  end
+end

data/test/fixtures/trace_test/trace_program_1.rb

@@ -0,0 +1,44 @@
+module Fixtures
+  module TraceTest
+    module TraceProgram1
+      class Main
+        def initialize(printer)
+          @printer = printer
+        end
+
+        def say(msg)
+          @printer.say(msg)
+        end
+      end
+
+      module Printer
+        # Stdout is a class with a 'say' instance method.
+        class Stdout
+          def say(msg)
+            puts(msg)
+          end
+        end
+
+        # Define 'say' on a static class method.
+        class Stderr
+          class << self
+            def say(msg)
+              warn(msg)
+            end
+          end
+        end
+
+        # make_stderr_printer builds an object which modifies 'say' to print to stderr.
+        def Printer.make_stderr_printer
+          Stdout.new.tap do |err_printer|
+            class << err_printer
+              def say(msg)
+                warn(msg)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/test/implicit_inspect_test.rb

@@ -0,0 +1,33 @@
+require 'test_helper'
+
+class ImplicitInspectTest < Minitest::Test
+  include FixtureFile
+
+  def test_toplevel_class
+    assert_fixture_features :implicit, 'toplevel_class.rb'
+  end
+
+  def test_defs_static_function
+    assert_fixture_features :implicit, 'defs_static_function.rb'
+  end
+
+  def test_sclass_static_function
+    assert_fixture_features :implicit, 'sclass_static_function.rb'
+  end
+
+  def test_toplevel_function
+    assert_fixture_features :implicit, 'toplevel_function.rb'
+  end
+
+  def test_function_within_class
+    assert_fixture_features :implicit, 'function_within_class.rb'
+  end
+
+  def test_include_public_methods
+    assert_fixture_features :implicit, 'include_public_methods.rb'
+  end
+
+  def test_modules
+    assert_fixture_features :implicit, 'modules.rb'
+  end
+end

data/test/include_exclude_test.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'appmap/config'
+
+class IncludeExcludeTest < Minitest::Test
+  include FixtureFile
+
+  INCLUDE_EXCLUDE_FIXTURE_DIR = File.join(FIXTURE_DIR, 'includes_excludes')
+
+  def setup
+    @package_dir = AppMap::Config::PackageDir.new(File.join(INCLUDE_EXCLUDE_FIXTURE_DIR, 'lib')).tap do |c|
+      c.package_name = 'include_exclude'
+    end
+  end
+
+  def test_exclude_dir
+    @package_dir.exclude = %w[b]
+    assert_equal %w[lib/root_1.rb lib/a], normalized_children
+  end
+
+  def test_exclude_file
+    @package_dir.exclude = %w[root_1.rb]
+    assert_equal %w[lib/a lib/b], normalized_children
+  end
+
+  def test_exclude_subfile
+    @package_dir.exclude = %w[a/a_1.rb root_1.rb b]
+    assert_equal %w[lib/a], normalized_children
+    assert_equal %w[lib/a/a_2.rb lib/a/x], normalize_paths(@package_dir.children.first.children.map(&:path))
+  end
+
+  def test_exclude_subdir
+    @package_dir.exclude = %w[a/a_1.rb root_1.rb b a/x]
+    assert_equal %w[lib/a], normalized_children
+    assert_equal %w[lib/a/a_2.rb], normalize_paths(@package_dir.children.first.children.map(&:path))
+  end
+
+  protected
+
+  def normalized_children
+    normalize_paths(@package_dir.children.map(&:path))
+  end
+
+  def normalize_paths(paths)
+    paths.map { |p| Pathname.new(p).to_s.gsub("#{INCLUDE_EXCLUDE_FIXTURE_DIR}/", '') }
+  end
+end

data/test/prerecorded_trace_test.rb

@@ -0,0 +1,76 @@
+require 'test_helper'
+require 'appmap'
+require 'appmap/config'
+require 'appmap/inspect'
+require 'appmap/trace/tracer'
+
+class PrerecordedTraceTest < Minitest::Test
+  # Runs a sequence of pre-recorded events.
+  def test_trace_web_request
+    config_yaml = <<-CONFIG
+    lib/appmap:
+      type: package
+      package_name: appmap
+      exclude:
+        - appmap/server
+
+    examples:
+      type: package
+      package_name: examples
+    CONFIG
+
+    events = %q(
+    {"id":1,"event":"call","defined_class":"#<Class:MockWebapp::Controller>","method_id":"instance","path":"/Users/kgilpin/Documents/appland/appmap-ruby/examples/mock_webapp/controller.rb","lineno":11,"static":true,"thread_id":70232530171540,"self":{"class":"Class","value":"MockWebapp::Controller","object_id":70232551211420},"parameters":{}}
+    {"id":2,"event":"return","defined_class":"#<Class:MockWebapp::Controller>","method_id":"instance","path":"/Users/kgilpin/Documents/appland/appmap-ruby/examples/mock_webapp/controller.rb","lineno":13,"static":true,"thread_id":70232530171540,"return_value":{"class":"MockWebapp::Controller","value":"#\u003cMockWebapp::Controller:0x00007fc094883a18\u003e","object_id":70232551202060},"parent_id":1,"elapsed":7.0e-06}
+    {"id":3,"event":"call","defined_class":"MockWebapp::Request","method_id":"initialize","path":"/Users/kgilpin/Documents/appland/appmap-ruby/examples/mock_webapp/request.rb","lineno":8,"static":false,"thread_id":70232530171540,"self":{"class":"MockWebapp::Request","value":"#\u003cstruct MockWebapp::Request params=nil\u003e","object_id":70232551201560},"parameters":{"args":{"class":"Array","value":"[{:id=\u003e\"alice\"}]","object_id":70232551201520}}}
+    {"id":4,"event":"return","defined_class":"MockWebapp::Request","method_id":"initialize","path":"/Users/kgilpin/Documents/appland/appmap-ruby/examples/mock_webapp/request.rb","lineno":10,"static":false,"thread_id":70232530171540,"return_value":{"class":"NilClass","value":null,"object_id":8},"parent_id":3,"elapsed":3.0e-06}
+    {"id":5,"event":"call","defined_class":"MockWebapp::Controller","method_id":"process","path":"/Users/kgilpin/Documents/appland/appmap-ruby/examples/mock_webapp/controller.rb","lineno":17,"static":false,"thread_id":70232530171540,"self":{"class":"MockWebapp::Controller","value":"#\u003cMockWebapp::Controller:0x00007fc094883a18\u003e","object_id":70232551202060},"parameters":{"request":{"class":"MockWebapp::Request","value":"#\u003cstruct MockWebapp::Request params={:id=\u003e\"alice\"}\u003e","object_id":70232551201560}}}
+    {"id":6,"event":"call","defined_class":"MockWebapp::User","method_id":"find","path":"/Users/kgilpin/Documents/appland/appmap-ruby/examples/mock_webapp/user.rb","lineno":13,"static":true,"thread_id":70232530171540,"self":{"class":"Class","value":"MockWebapp::User","object_id":70232551218320},"parameters":{"id":{"class":"String","value":"alice","object_id":70232551201600}}}
+    {"id":7,"event":"return","defined_class":"MockWebapp::User","method_id":"find","path":"/Users/kgilpin/Documents/appland/appmap-ruby/examples/mock_webapp/user.rb","lineno":15,"static":true,"thread_id":70232530171540,"return_value":{"class":"MockWebapp::User","value":"#\u003cstruct MockWebapp::User login=\"alice\"\u003e","object_id":70232551218180},"parent_id":6,"elapsed":3.0e-06}
+    {"id":8,"event":"return","defined_class":"MockWebapp::Controller","method_id":"process","path":"/Users/kgilpin/Documents/appland/appmap-ruby/examples/mock_webapp/controller.rb","lineno":21,"static":false,"thread_id":70232530171540,"return_value":{"class":"Hash","value":"{:login=\u003e\"alice\"}","object_id":70232551198060},"parent_id":5,"elapsed":0.000251}
+    )
+
+    require 'yaml'
+    config = AppMap::Config.load YAML.safe_load(config_yaml)
+    features = config.source_locations.map(&AppMap::Inspect.method(:detect_features)).flatten
+    methods = features.map(&:collect_functions).flatten
+
+    def method_call_from_event(evt)
+      AppMap::Trace::MethodCall.new(evt.id, evt.event.intern, evt.defined_class, evt.method_id, evt.path, evt.lineno,
+        evt.static, evt.thread_id, evt.self, evt.parameters)
+    end
+
+    def method_return_from_event(evt, parent_id, elapsed)
+      AppMap::Trace::MethodReturn.new(evt.id, evt.event.intern, evt.defined_class, evt.method_id, evt.path, evt.lineno,
+        evt.static, evt.thread_id, nil, nil, evt.return_value).tap do |mr|
+        assert_equal parent_id, evt.parent_id
+        mr.parent_id = evt.parent_id
+        mr.elapsed = evt.elapsed
+      end
+    end
+
+    tracer = AppMap::Trace::Tracer.new(methods)
+    handler = AppMap::Trace::TracePointHandler.new(tracer)
+    handler.call_constructor = method(:method_call_from_event)
+    handler.return_constructor = method(:method_return_from_event)
+
+    events = events
+             .split("\n")
+             .map(&:strip)
+             .reject(&:empty?)
+             .map(&JSON.method(:parse))
+
+    events.each do |evt_hash|
+      evt = OpenStruct.new(evt_hash.dup)
+      evt['event'] = evt['event'].intern
+      handler.handle evt
+    end
+
+    i = 0
+    while tracer.event?
+      event = tracer.next_event
+      assert_equal events[i], JSON.parse(event.to_h.to_json)
+      i += 1
+    end
+  end
+end

data/test/rspec_test.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'English'
+
+class RSpecTest < Minitest::Test
+  def test_record_rspec
+    Bundler.with_clean_env do
+      Dir.chdir 'test/fixtures/rspec_recorder' do
+        appmap_file = 'tmp/appmap/rspec/Hello_says_hello.json'
+        FileUtils.rm_rf 'tmp'
+        system 'bundle'
+        system({ 'APPMAP' => 'true' }, 'bundle exec rspec')
+        assert File.file?(appmap_file), 'appmap output file does not exist'
+        assert_includes File.read(appmap_file), %("class":"String","value":"Hello!")
+        assert_includes File.read(appmap_file), %("feature":"Say hello")
+        assert_includes File.read(appmap_file), %("feature_group":"Hello")
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,46 @@
+$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