appmap 0.83.2 → 0.83.5

data/spec/config_spec.rb

@@ -1,155 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_spec_helper'
-require 'appmap/config'
-
-describe AppMap::Config do
-  it 'loads as expected' do
-    config_data = {
-      name: 'test',
-      packages: [],
-      functions: [
-        {
-          name: 'pkg/cls#fn',
-        },
-        {
-          methods: ['cls#new_fn'],
-          path: 'pkg'
-        }
-      ]
-    }.deep_stringify_keys!
-    config = AppMap::Config.load(config_data)
-
-    expect(config.as_json.keys.sort).to eq(["appmap_dir", "builtin_hooks", "depends_config", "exclude", "functions", "gem_hooks", "hook_paths", "name", "packages", "swagger_config"])
-    expect(config.as_json['appmap_dir']).to eq('tmp/appmap')
-    expect(config.as_json['name']).to eq('test')
-    expect(config.as_json['packages']).to eq([])
-    expect(config.as_json['depends_config']).to eq({
-      "base_dir" => nil,
-      "base_branches" => [
-        "remotes/origin/main",
-        "remotes/origin/master"
-      ],
-      "test_file_patterns" => [
-        "spec/**/*_spec.rb",
-        "test/**/*_test.rb"
-      ],
-      "dependent_tasks" => [
-        "swagger"
-      ],
-      "description" => "Bring AppMaps up to date with local file modifications, and updated derived data such as Swagger files",
-      "rspec_environment_method" => "AppMap::Depends.test_env",
-      "minitest_environment_method" => "AppMap::Depends.test_env",
-      "rspec_select_tests_method" => "AppMap::Depends.select_rspec_tests",
-      "minitest_select_tests_method" => "AppMap::Depends.select_minitest_tests",
-      "rspec_test_command_method" => "AppMap::Depends.rspec_test_command",
-      "minitest_test_command_method" => "AppMap::Depends.minitest_test_command"
-    })
-    expect(config.as_json['swagger_config']).to eq({
-      "project_name" => nil,
-      "project_version" => "1.0",
-      "output_dir" => "swagger",
-      "description" => "Generate Swagger from AppMaps"
-    })
-    expect(config.as_json['hook_paths']).to eq([
-      "pkg",
-      "#{Gem.loaded_specs['activesupport'].gem_dir}"
-    ])
-    expect(config.as_json['exclude']).to eq([])
-    expect(config.as_json['functions'].map(&:deep_stringify_keys)).to eq([
-      {
-        "cls" => "cls",
-        "target_methods" => {
-          "package" => "pkg",
-          "method_names" => [
-            :fn
-          ]
-        }
-      },
-      {
-        "cls" => "cls",
-        "target_methods" => {
-          "package" => "pkg",
-          "method_names" => [
-            :new_fn
-          ]
-        }
-      }
-    ])
-    expect(config.as_json['builtin_hooks']).to have_key('JSON::Ext::Parser')
-    expect(config.as_json['builtin_hooks']['JSON::Ext::Parser'].map(&:deep_stringify_keys)).to eq([{
-        "package" => "json",
-        "method_names" => [
-          :parse
-        ]
-      }
-    ])
-    expect(config.as_json['gem_hooks']).to have_key('cls')
-    expect(config.as_json['gem_hooks']['cls'].map(&:deep_stringify_keys)).to eq([
-      {
-        "package" => "pkg",
-        "method_names" => [
-          :fn
-        ]
-      },
-      {
-        "package" => "pkg",
-        "method_names" => [
-          :new_fn
-        ]
-      }
-    ])
-    expect(config.as_json['gem_hooks']).to have_key('ActiveSupport::Callbacks::CallbackSequence')
-    expect(config.as_json['gem_hooks']['ActiveSupport::Callbacks::CallbackSequence'].map(&:deep_stringify_keys)).to eq([
-      {
-        "package" => "activesupport",
-        "method_names" => [
-          :invoke_before
-        ]
-      },
-      {
-        "package" => "activesupport",
-        "method_names" => [
-          :invoke_after
-        ]
-      }
-    ])
-  end
-
-  describe AppMap::Config::Package do
-    describe :build_from_gem do
-      let(:mock_rails) { double(logger: double(info: true)) }
-
-      before do
-        stub_const('Rails', mock_rails)
-      end
-
-      it 'does not return a truthy value on failure' do
-        result = AppMap::Config::Package.build_from_gem('some_missing_gem_name', optional: true)
-        expect(result).to_not be_truthy
-      end
-    end
-  end
-
-  context do
-    let(:warnings) { @warnings ||= [] }
-    let(:warning) { warnings.join }
-    before do
-      expect(AppMap::Config).to receive(:warn).at_least(1) { |msg| warnings << msg }
-    end
-    it 'prints a warning and uses a default config' do
-      config = AppMap::Config.load_from_file 'no/such/file'
-      expect(config.to_h).to eq(YAML.load(<<~CONFIG))
-      :name: appmap-ruby
-      :packages:
-      - :name: lib
-        :path: lib
-        :handler_class: AppMap::Handler::Function
-        :shallow: false
-      :functions: []
-      :exclude: []
-      CONFIG
-      expect(warning).to include('NOTICE: The AppMap config file no/such/file was not found!')
-    end
-  end
-end

data/spec/depends/api_spec.rb

@@ -1,196 +0,0 @@
-require_relative './spec_helper'
-require 'appmap/depends/api'
-
-module AppMap
-  module Depends
-    module APISpec
-      class << self
-        def minitest_environment_method
-          AppMap::Depends.test_env
-        end
-
-        def rspec_environment_method
-          AppMap::Depends.test_env
-        end
-
-        def minitest_test_command(test_files)
-          "time bundle exec ruby -rminitest -Itest #{test_files}"
-        end
-
-        alias minitest_test_command_method minitest_test_command
-
-        def rspec_test_command_method(test_files)
-          "time bundle exec rspec #{test_files}"
-        end
-
-        def rspec_select_tests_method(test_files)
-          AppMap::Depends.select_rspec_tests(test_files)
-        end
-
-        def minitest_select_tests_method(test_files)
-          AppMap::Depends.select_minitest_tests(test_files)
-        end
-      end
-    end
-  end
-end
-
-describe 'Depends API' do
-  let(:api) { AppMap::Depends::API.new(ENV['DEBUG'] == 'true') }
-  let(:fixture_dir) { DEPENDS_TEST_DIR }
-
-  describe '.modified' do
-    it 'is empty by default' do
-      test_list = api.modified(appmap_dir: DEPENDS_TEST_DIR, base_dir: DEPENDS_BASE_DIR)
-      expect(test_list).to be_empty
-    end
-
-    it 'detects modification of a dependent file' do
-      FileUtils.touch 'spec/fixtures/depends/app/models/user.rb'
-      test_list = api.modified(appmap_dir: DEPENDS_TEST_DIR, base_dir: DEPENDS_BASE_DIR)
-      expect(test_list.to_a).to eq(%w[spec/fixtures/depends/spec/user_spec.rb])
-    end
-  end
-
-  describe '.inspect_test_files' do
-    it 'reports metadata, added, removed, changed, failed' do
-      test_report = api.inspect_test_files(appmap_dir: DEPENDS_TEST_DIR, test_file_patterns: %w[spec/fixtures/depends/spec/*_spec.rb])
-      expect(test_report.metadata_files.sort).to eq(%w[spec/fixtures/depends/revoke_api_key/metadata.json spec/fixtures/depends/user_page_scenario/metadata.json])
-      expect(test_report.added).to be_empty
-      expect(test_report.removed).to be_empty
-      expect(test_report.changed).to be_empty
-      expect(test_report.failed.to_a).to eq(%w[spec/fixtures/depends/spec/user_spec.rb])
-    end
-    it 'detects an added test' do
-      FileUtils.touch 'spec/tmp/new_spec.rb'
-      test_report = api.inspect_test_files(appmap_dir: DEPENDS_TEST_DIR, test_file_patterns: %w[spec/fixtures/depends/spec/*_spec.rb spec/tmp/*_spec.rb])
-      expect(test_report.added.to_a).to eq(%w[spec/tmp/new_spec.rb])
-    end
-    it 'detects a removed test' do
-      FileUtils.mv 'spec/fixtures/depends/spec/user_spec.rb', 'spec/tmp/'
-      begin
-        test_report = api.inspect_test_files(appmap_dir: DEPENDS_TEST_DIR, test_file_patterns: %w[spec/fixtures/depends/spec/*_spec.rb spec/tmp/*_spec.rb])
-        expect(test_report.removed.to_a).to eq(%w[spec/fixtures/depends/spec/user_spec.rb])
-      ensure
-        FileUtils.mv 'spec/tmp/user_spec.rb', 'spec/fixtures/depends/spec/'
-      end
-    end
-    it 'detects a changed test' do
-      FileUtils.touch 'spec/fixtures/depends/spec/user_spec.rb'
-      test_report = api.inspect_test_files(appmap_dir: DEPENDS_TEST_DIR, test_file_patterns: %w[spec/fixtures/depends/spec/*_spec.rb])
-      expect(test_report.changed.to_a).to eq(%w[spec/fixtures/depends/spec/user_spec.rb])
-    end
-    it 'removes AppMaps whose source file has been removed' do
-      appmap = JSON.parse(File.read('spec/fixtures/depends/revoke_api_key.appmap.json'))
-      appmap['metadata']['source_location'] = 'spec/tmp/new_spec.rb'
-      new_spec_file = 'spec/fixtures/depends/revoke_api_key_2.appmap.json'
-      File.write new_spec_file, JSON.pretty_generate(appmap)
-
-      begin
-        update_appmap_index
-        test_report = api.inspect_test_files(appmap_dir: DEPENDS_TEST_DIR, test_file_patterns: %w[spec/fixtures/depends/spec/*_spec.rb])
-        expect(test_report.removed.to_a).to eq(%w[spec/tmp/new_spec.rb])
-
-        test_report.clean_appmaps
-
-        expect(File.exist?(new_spec_file)).to be_falsey
-      ensure
-        FileUtils.rm_f new_spec_file if File.exist?(new_spec_file)
-        FileUtils.rm_rf new_spec_file.split('.')[0]
-      end
-    end
-  end
-
-  describe '.run_tests' do
-    def run_tests
-      Dir.chdir 'spec/fixtures/depends' do
-        api.run_tests([ 'spec/actual_rspec_test.rb', 'test/actual_minitest_test.rb' ], appmap_dir: Pathname.new('.').expand_path.to_s)
-      end
-    end
-
-    describe 'smoke test' do
-      around do |test|
-        begin
-          @minitest_test_command_method = AppMap.configuration.depends_config.minitest_test_command_method
-          AppMap.configuration.depends_config.minitest_test_command_method = 'AppMap::Depends::APISpec.minitest_test_command'
-
-          test.call
-        ensure
-          AppMap.configuration.depends_config.minitest_test_command_method = @minitest_test_command
-        end
-      end
-
-      it 'passes a smoke test' do
-        run_tests
-      end
-    end
-
-    describe 'configuration settings' do
-      it 'can all be modified' do
-        begin
-          defaults = {}
-
-          %i[rspec minitest].each do |framework|
-            %i[environment_method select_tests_method test_command_method].each do |setting|
-              full_setting = [ framework, setting ].join('_').to_sym
-              defaults[full_setting] = AppMap.configuration.depends_config.send(full_setting)
-              AppMap.configuration.depends_config.send("#{full_setting}=", "AppMap::Depends::APISpec.#{full_setting}")
-            end
-          end
-
-          run_tests
-        ensure
-          defaults.keys.each do |setting|
-            AppMap.configuration.depends_config.send("#{setting}=", defaults[setting])
-          end
-        end
-      end
-    end
-  end
-
-  describe '.remove_out_of_date_appmaps' do
-    it 'is a nop in normal circumstances' do
-      since = Time.now
-      removed = api.remove_out_of_date_appmaps(since, appmap_dir: DEPENDS_TEST_DIR, base_dir: DEPENDS_BASE_DIR)
-      expect(removed).to be_empty
-    end
-
-    it "removes an out-of-date AppMap that hasn't been brought up to date" do
-      # This AppMap will be modified before the 'since' time
-      appmap_path = "spec/fixtures/depends/user_page_scenario.appmap.json"
-      appmap = File.read(appmap_path)
-
-      sleep 0.01
-      since = Time.now
-      sleep 0.01
-
-      # Touch the rest of the AppMaps so that they are modified after +since+
-      Dir.glob('spec/fixtures/depends/*.appmap.json').each do |path|
-        next if path == appmap_path
-        FileUtils.touch path
-      end
-
-      sleep 0.01
-      # Make the AppMaps out of date
-      FileUtils.touch 'spec/fixtures/depends/app/models/user.rb'
-      sleep 0.01
-
-      begin
-        # At this point, we would run tests to bring the AppMaps up to date
-        # Then once the tests have finished, remove any AppMaps that weren't refreshed
-        removed = api.remove_out_of_date_appmaps(since, appmap_dir: DEPENDS_TEST_DIR, base_dir: DEPENDS_BASE_DIR)
-        expect(removed).to eq([ appmap_path.split('.')[0] ])
-      ensure
-        File.write(appmap_path, appmap)
-      end
-    end
-  end
-
-  before do
-    Dir.glob("#{DEPENDS_TEST_DIR}/*.appmap.json").each { |fname| FileUtils.touch fname }
-    update_appmap_index
-
-    FileUtils.rm_rf 'spec/tmp'
-    FileUtils.mkdir_p 'spec/tmp'
-  end
-end

data/spec/depends/spec_helper.rb

@@ -1,18 +0,0 @@
-require_relative '../spec_helper'
-
-DEPENDS_TEST_DIR = 'spec/fixtures/depends'
-DEPENDS_BASE_DIR = DEPENDS_TEST_DIR
-
-def update_appmap_index
-  cmd = [
-    './exe/appmap-index',
-    '--appmap-dir',
-    DEPENDS_TEST_DIR
-  ]
-  if ENV['DEBUG'] == 'true'
-    cmd << '--verbose'
-  end
-
-  system cmd.join(' ') or raise "Failed to update AppMap index in #{DEPENDS_TEST_DIR}"
-end
-

data/spec/display_string_spec.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'appmap/event'
-
-include AppMap
-
-describe 'display_string' do
-  def display_string(value)
-    Event::MethodEvent.display_string value
-  end
-
-  def compare_display_string(value, expected)
-    expect(display_string(value)).to eq(expected)
-  end
-
-  context 'for a' do
-    it 'String' do
-      compare_display_string 'foo', 'foo'
-    end
-    it 'long String' do
-      compare_display_string 'foo' * 100, 'foo' * 33 + 'f (...200 more characters)'
-    end
-    it 'Array' do
-      compare_display_string([ 1, 'my', :bar, [ 2, 3 ], { 4 => 5 } ], '[1, my, :bar, [2, 3], {4=>5}]')
-    end
-    it 'large Array' do
-      compare_display_string 50.times.map { |i| i }, '[0, 1, 2, 3, 4, 5, 6, 7, 8, 9 (...40 more items)]'
-    end
-    it 'large Hash' do
-      compare_display_string(50.times.map { |i| [ i*2, i*2+1] }.to_h, '{0=>1, 2=>3, 4=>5, 6=>7, 8=>9, 10=>11, 12=>13, 14=>15, 16=>17, 18=>19 (...40 more entries)}')
-    end
-    it 'Hash' do
-      compare_display_string({ 1 => 2, 'my' => 'neighbor', bar: :baz, ary: [ 1, 2 ]}, '{1=>2, my=>neighbor, :bar=>:baz, :ary=>[1, 2]}')
-    end
-    it 'big Hash' do
-      compare_display_string(50.times.map { |i| [ i*2, i*2+1] }.to_h, '{0=>1, 2=>3, 4=>5, 6=>7, 8=>9, 10=>11, 12=>13, 14=>15, 16=>17, 18=>19 (...40 more entries)}')
-    end
-  end
-end

data/spec/fixtures/config/incomplete_config.yml

@@ -1 +0,0 @@
-name: app

data/spec/fixtures/config/invalid_config.yml

@@ -1,2 +0,0 @@
-name: name
-packages: [1,2,3]

data/spec/fixtures/config/invalid_yaml_config.yml

@@ -1,3 +0,0 @@
-name:
--
-packages: "[]" asd

data/spec/fixtures/config/maximal_config.yml

@@ -1,14 +0,0 @@
-name: appmap
-packages:
-  - path: app/models
-    exclude: app/models/helpers
-  - gem: rack
-  - gem: activesupport
-    shallow: false
-functions:
-  - methods:
-    - OpenSSL::X509::Request#sign
-    - OpenSSL::X509::Request#verify
-    label: crypto.x509
-language: ruby
-appmap_dir: tmp/appmap

data/spec/fixtures/config/missing_path_or_gem.yml

@@ -1,3 +0,0 @@
-name: name
-packages:
-  - dogs: are friendly

data/spec/fixtures/config/valid_config.yml

@@ -1,3 +0,0 @@
-name: appmap
-packages:
-  - path: app/models

data/spec/fixtures/database.yml

@@ -1,11 +0,0 @@
-default: &default
-  url: <%= ENV['DATABASE_URL'] %>
-  adapter: postgresql
-  database: <%= ENV['TEST_DATABASE'] || 'appland-rails6-test' %>
-
-development:
-  <<: *default
-test:
-  <<: *default
-production:
-  <<: *default

data/spec/fixtures/depends/.gitignore

@@ -1,2 +0,0 @@
-user_page_scenario
-revoke_api_key

data/spec/fixtures/depends/app/controllers/api/api_keys_controller.rb

@@ -1,2 +0,0 @@
-# dummy
-# This file is just here so it can be touched and trigger re-test.

data/spec/fixtures/depends/app/controllers/organizations_controller.rb

@@ -1,2 +0,0 @@
-# dummy
-# This file is just here so it can be touched and trigger re-test.

data/spec/fixtures/depends/app/models/api_key.rb

@@ -1,2 +0,0 @@
-# dummy
-# This file is just here so it can be touched and trigger re-test.

data/spec/fixtures/depends/app/models/configuration.rb

@@ -1,2 +0,0 @@
-# dummy
-# This file is just here so it can be touched and trigger re-test.

data/spec/fixtures/depends/app/models/show.rb

@@ -1,2 +0,0 @@
-# dummy
-# This file is just here so it can be touched and trigger re-test.

data/spec/fixtures/depends/app/models/user.rb

@@ -1,2 +0,0 @@
-# dummy
-# This file is just here so it can be touched and trigger re-test.