appmap 0.18.1

data/spec/rspec_feature_metadata_spec.rb

@@ -0,0 +1,30 @@
+require 'rails_spec_helper'
+
+describe 'RSpec feature and feature group metadata' do
+  before(:all) { @fixture_dir = 'spec/fixtures/rails_users_app' }
+  include_examples 'Rails app pg database'
+  
+  around(:each) do |example|
+    FileUtils.rm_rf tmpdir
+    FileUtils.mkdir_p tmpdir
+    cmd = "docker-compose run --rm -e APPMAP=true -v #{File.absolute_path(tmpdir).shellescape}:/app/tmp app ./bin/rspec spec/models/user_spec.rb"
+    system cmd, chdir: @fixture_dir or raise 'Failed to run rails_users_app container'
+
+    example.run
+  end
+
+  let(:tmpdir) { 'tmp/spec/RSpec feature and feature group metadata' }
+  let(:appmap_json) { File.join(tmpdir, %(appmap/rspec/User_creation_creates_charles.appmap.json)) }
+
+  describe do
+    it 'are recorded in the appmap' do
+      expect(File).to exist(appmap_json)
+      appmap = JSON.parse(File.read(appmap_json)).to_yaml
+
+      expect(appmap).to include(<<-METADATA.strip)
+  feature: Create a user
+  feature_group: User
+      METADATA
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+require 'net/http'
+require 'json'
+require 'yaml'
+require 'English'
+require 'webdrivers/chromedriver'

data/test/cli_test.rb

@@ -0,0 +1,81 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'English'
+
+class CLITest < Minitest::Test
+  OUTPUT_FILENAME = File.expand_path('../tmp/appmap.json', __dir__)
+
+  def setup
+    FileUtils.rm_f 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'
+    JSON.parse(output)
+  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
+    end
+
+    assert_equal 0, $CHILD_STATUS.exitstatus
+    assert File.file?(OUTPUT_FILENAME), "#{OUTPUT_FILENAME} does not exist"
+    assert_equal 'Hello', output
+    output = JSON.parse(File.read(OUTPUT_FILENAME))
+    assert output['classMap'], 'Output should contain classMap'
+    assert output['events'], 'Output should contain events'
+  end
+
+  def test_record_to_default_location
+    Dir.chdir 'test/fixtures/cli_record_test' do
+      system({ 'APPMAP_FILE' => OUTPUT_FILENAME }, "#{File.expand_path '../exe/appmap', __dir__} record ./lib/cli_record_test/main.rb")
+    end
+
+    assert_equal 0, $CHILD_STATUS.exitstatus
+    assert File.file?(OUTPUT_FILENAME), 'appmap.json does not exist'
+  end
+
+  def test_record_to_stdout
+    output = Dir.chdir 'test/fixtures/cli_record_test' do
+      `#{File.expand_path '../exe/appmap', __dir__} record -o - ./lib/cli_record_test/main.rb`
+    end
+
+    assert_equal 0, $CHILD_STATUS.exitstatus
+    assert_includes output, %("location":"lib/cli_record_test")
+    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/config_test.rb

@@ -0,0 +1,149 @@
+require 'test_helper'
+require 'appmap/config'
+require 'appmap/inspect'
+
+class ConfigTest < Minitest::Test
+  include FixtureFile
+
+  def test_explicit_module_path_naming
+    config = AppMap::Config::PackageDir.new(INSPECT_PACKAGE_FIXTURE_DIR).tap do |c|
+      c.mode = :explicit
+      c.exclude = [ 'module_a/ignore_module_c' ]
+    end
+    feature = AppMap::Inspect.detect_features(config)
+
+    assert_equal %w[inspect_package module_a module_b], feature_names(feature)
+  end
+
+  def test_implicit_module_path_naming
+    config = AppMap::Config::PackageDir.new(INSPECT_PACKAGE_FIXTURE_DIR).tap do |c|
+      c.exclude = [ 'module_a/ignore_module_c' ]
+    end
+    feature = AppMap::Inspect.detect_features(config)
+
+    assert_equal %w[inspect_package module_a module_b A B Main], feature_names(feature)
+  end
+
+  def test_ignore_non_ruby_file
+    config = AppMap::Config::PackageDir.new(File.join(FIXTURE_DIR, 'ignore_non_ruby_file'))
+    feature = AppMap::Inspect.detect_features(config)
+    assert_equal %w[ignore_non_ruby_file Cls], feature_names(feature)
+  end
+
+  def test_inspect_multiple_subdirs
+    config_yaml = <<-YAML
+    packages:
+      - path: module_a
+      - path: module_b
+    named_functions: []
+    YAML
+
+    require 'yaml'
+    config = AppMap::Config.load YAML.safe_load(config_yaml)
+    features = Dir.chdir File.join(FIXTURE_DIR, 'inspect_multiple_subdirs') do
+      config.source_locations.map(&AppMap::Inspect.method(:detect_features))
+    end.flatten
+    features = features.map(&:reparent)
+    assert_equal %w[module_a ModuleA ClassA module_b ModuleB ClassB ClassC], features.map(&method(:feature_names)).flatten
+  end
+
+  def test_active_record_like
+    config_yaml = <<-YAML
+    packages:
+      - path: .
+        name: ROOT
+    named_functions: []
+    YAML
+
+    require 'yaml'
+    config = AppMap::Config.load YAML.safe_load(config_yaml)
+    features = Dir.chdir File.join(FIXTURE_DIR, 'active_record_like') do
+      config.source_locations.map(&AppMap::Inspect.method(:detect_features))
+    end.flatten
+    features = features.map(&:reparent)
+
+    assert_equal <<-FEATURES.strip, JSON.pretty_generate(features)
+[
+  {
+    "name": "ROOT",
+    "location": ".",
+    "type": "package",
+    "children": [
+      {
+        "name": "ActiveRecord",
+        "location": "./active_record.rb:1",
+        "type": "class",
+        "children": [
+          {
+            "name": "Aggregations",
+            "location": "./active_record/aggregations.rb:2",
+            "type": "class"
+          },
+          {
+            "name": "Associations",
+            "location": "./active_record/association.rb:2",
+            "type": "class",
+            "children": [
+              {
+                "name": "JoinDependency",
+                "location": "./active_record/associations/join_dependency.rb:3",
+                "type": "class",
+                "children": [
+                  {
+                    "name": "JoinBase",
+                    "location": "./active_record/associations/join_dependency/join_base.rb:4",
+                    "type": "class"
+                  },
+                  {
+                    "name": "JoinPart",
+                    "location": "./active_record/associations/join_dependency/join_part.rb:4",
+                    "type": "class"
+                  }
+                ]
+              }
+            ]
+          },
+          {
+            "name": "CAPS",
+            "location": "./active_record/caps/caps.rb:2",
+            "type": "class"
+          }
+        ]
+      },
+      {
+        "name": "active_record",
+        "location": "./active_record",
+        "type": "package",
+        "children": [
+          {
+            "name": "associations",
+            "location": "./active_record/associations",
+            "type": "package",
+            "children": [
+              {
+                "name": "join_dependency",
+                "location": "./active_record/associations/join_dependency",
+                "type": "package"
+              }
+            ]
+          },
+          {
+            "name": "caps",
+            "location": "./active_record/caps",
+            "type": "package"
+          }
+        ]
+      }
+    ]
+  }
+]
+    FEATURES
+  end
+
+  def feature_names(feature, names = [])
+    names.tap do |_|
+      names << feature.name
+      feature.children.each { |child| feature_names(child, names) }
+    end
+  end
+end

data/test/explict_inspect_test.rb

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

data/test/fixtures/active_record_like/active_record/aggregations.rb

@@ -0,0 +1,4 @@
+module ActiveRecord
+  class Aggregations
+  end
+end

data/test/fixtures/active_record_like/active_record/association.rb

@@ -0,0 +1,4 @@
+module ActiveRecord
+  module Associations
+  end
+end

data/test/fixtures/active_record_like/active_record/associations/join_dependency/join_base.rb

@@ -0,0 +1,8 @@
+module ActiveRecord
+  module Associations
+    module JoinDependency
+      class JoinBase
+      end
+    end
+  end
+end

data/test/fixtures/active_record_like/active_record/associations/join_dependency/join_part.rb

@@ -0,0 +1,8 @@
+module ActiveRecord
+  module Associations
+    module JoinDependency
+      class JoinPart
+      end
+    end
+  end
+end

data/test/fixtures/active_record_like/active_record/associations/join_dependency.rb

@@ -0,0 +1,6 @@
+module ActiveRecord
+  module Associations
+    module JoinDependency
+    end
+  end
+end

data/test/fixtures/active_record_like/active_record/caps/caps.rb

@@ -0,0 +1,4 @@
+module ActiveRecord
+  module CAPS
+  end
+end

data/test/fixtures/active_record_like/active_record.rb

@@ -0,0 +1,2 @@
+module ActiveRecord
+end

data/test/fixtures/cli_record_test/appmap.yml

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

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

@@ -0,0 +1,7 @@
+class Main
+  def Main.say_hello
+    puts 'Hello'
+  end
+end
+
+Main.say_hello

data/test/fixtures/ignore_non_ruby_file/class.rb

@@ -0,0 +1,3 @@
+# @appmap
+class Cls
+end

data/test/fixtures/ignore_non_ruby_file/non-ruby.txt

@@ -0,0 +1 @@
+This is not ruby.

data/test/fixtures/includes_excludes/lib/a/a_1.rb

@@ -0,0 +1,6 @@
+module A
+  class A1
+    def action
+    end
+  end
+end

data/test/fixtures/includes_excludes/lib/a/a_2.rb

@@ -0,0 +1,6 @@
+module A
+  class A2
+    def action
+    end
+  end
+end

data/test/fixtures/includes_excludes/lib/a/x/x_1.rb

@@ -0,0 +1,8 @@
+module A
+  module X
+    class X1
+      def action
+      end
+    end
+  end
+end

data/test/fixtures/includes_excludes/lib/b/b_1.rb

@@ -0,0 +1,6 @@
+module B
+  class B1
+    def action
+    end
+  end
+end

data/test/fixtures/includes_excludes/lib/root_1.rb

@@ -0,0 +1,4 @@
+class Root1
+  def action
+  end
+end

data/test/fixtures/inspect_multiple_subdirs/module_a/class_a.rb

@@ -0,0 +1,5 @@
+module ModuleA
+  # @appmap
+  class ClassA
+  end
+end

data/test/fixtures/inspect_multiple_subdirs/module_a.rb

@@ -0,0 +1,2 @@
+module ModuleA
+end

data/test/fixtures/inspect_multiple_subdirs/module_b/class_b.rb

@@ -0,0 +1,5 @@
+module ModuleB
+  # @appmap
+  class ClassB
+  end
+end

data/test/fixtures/inspect_multiple_subdirs/module_b/class_c.rb

@@ -0,0 +1,5 @@
+module ModuleB
+  # @appmap
+  class ClassC
+  end
+end

data/test/fixtures/inspect_multiple_subdirs/module_b.rb

@@ -0,0 +1,2 @@
+module ModuleB
+end

data/test/fixtures/inspect_package/module_a/module_b/class_in_module.rb

@@ -0,0 +1,6 @@
+module A
+  module B
+    class Main
+    end
+  end
+end

data/test/fixtures/parse_file/defs_static_function.rb

@@ -0,0 +1,96 @@
+class Main
+  # @appmap
+  def self.main_func; end
+end
+
+class Sub < Main
+  # @appmap
+  def self.sub_func; end
+
+  # @appmap
+  def Main.sub_func_2; end
+
+  # @appmap
+  def self.sub_func_3; end
+
+  protected
+
+  # TODO: ensure that this is ignored by implicit scan
+  def self.sub_func_protected; end
+end
+
+puts DATA.read
+__END__
+{
+  "explicit": [
+    {
+      "name": "main_func",
+      "location": "$FIXTURE_DIR/defs_static_function.rb:3",
+      "type": "function",
+      "class_name": "Main",
+      "static": true
+    },
+    {
+      "name": "sub_func",
+      "location": "$FIXTURE_DIR/defs_static_function.rb:8",
+      "type": "function",
+      "class_name": "Sub",
+      "static": true
+    },
+    {
+      "name": "sub_func_2",
+      "location": "$FIXTURE_DIR/defs_static_function.rb:11",
+      "type": "function",
+      "class_name": "Main",
+      "static": true
+    },
+    {
+      "name": "sub_func_3",
+      "location": "$FIXTURE_DIR/defs_static_function.rb:14",
+      "type": "function",
+      "class_name": "Sub",
+      "static": true
+    }
+  ],
+  "implicit": [
+    {
+      "name": "Main",
+      "location": "$FIXTURE_DIR/defs_static_function.rb:1",
+      "type": "class",
+      "children": [
+        {
+          "name": "main_func",
+          "location": "$FIXTURE_DIR/defs_static_function.rb:3",
+          "type": "function",
+          "static": true
+        }
+      ]
+    },
+    {
+      "name": "Sub",
+      "location": "$FIXTURE_DIR/defs_static_function.rb:6",
+      "type": "class",
+      "children": [
+        {
+          "name": "sub_func",
+          "location": "$FIXTURE_DIR/defs_static_function.rb:8",
+          "type": "function",
+          "static": true
+        },
+        {
+          "name": "sub_func_2",
+          "location": "$FIXTURE_DIR/defs_static_function.rb:11",
+          "type": "function",
+          "class_name": "Main",
+          "static": true
+        },
+        {
+          "name": "sub_func_3",
+          "location": "$FIXTURE_DIR/defs_static_function.rb:14",
+          "type": "function",
+          "static": true
+        }
+      ]
+    }
+  ]
+}

data/test/fixtures/parse_file/function_within_class.rb

@@ -0,0 +1,36 @@
+# @appmap
+class Main
+  class << self
+    # @appmap
+    def sclass_function
+    end
+  end
+
+  # @appmap
+  def instance_function
+  end
+end
+
+puts DATA.read
+__END__
+[
+  {
+    "name": "Main",
+    "location": "$FIXTURE_DIR/function_within_class.rb:2",
+    "type": "class",
+    "children": [
+      {
+        "name": "sclass_function",
+        "location": "$FIXTURE_DIR/function_within_class.rb:5",
+        "type": "function",
+        "static": true
+      },
+      {
+        "name": "instance_function",
+        "location": "$FIXTURE_DIR/function_within_class.rb:10",
+        "type": "function",
+        "static": false
+      }
+    ]
+  }
+]