appmap 0.59.2 → 0.62.0

data/lib/appmap/service/test_command_provider.rb

@@ -16,9 +16,7 @@ module AppMap
               command: {
                 program: 'bundle',
                 args: %w[exec rspec] + integration_test_paths[:rspec].map { |path| "./#{path}" },
-                environment: {
-                  APPMAP: 'true'
-                }
+                environment: { APPMAP: 'true', DISABLE_SPRING: 'true' }
               }
             }
           end
@@ -32,7 +30,7 @@ module AppMap
               command: {
                 program: 'bundle',
                 args: %w[exec cucumber],
-                environment: { APPMAP: 'true' }
+                environment: { APPMAP: 'true', DISABLE_SPRING: 'true' }
               }
             }
           end
@@ -50,7 +48,7 @@ module AppMap
                 command: {
                   program: 'bundle',
                   args: %w[exec rails test] + integration_test_paths[:minitest].map { |path| "./#{path}" },
-                  environment: { APPMAP: 'true' }
+                  environment: { APPMAP: 'true', DISABLE_SPRING: 'true' }
                 }
               }
             ]
@@ -61,7 +59,7 @@ module AppMap
                 command: {
                   program: 'bundle',
                   args: ['exec', 'ruby', "./#{path}"],
-                  environment: { APPMAP: 'true' }
+                  environment: { APPMAP: 'true', DISABLE_SPRING: 'true' }
                 }
               }
             end
@@ -69,7 +67,7 @@ module AppMap
         end
 
         def integration_test_paths
-          @paths ||= Service::IntegrationTestPathFinder.find
+          @paths ||= Service::IntegrationTestPathFinder.new.find
         end
       end
     end

data/lib/appmap/service/validator/config_validator.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'appmap/service/validator/violation'
+
+module AppMap
+  module Service
+    module Validator
+      class ConfigValidator
+        attr_reader :violations
+
+        def initialize(config_file)
+          @config_file = config_file
+          @violations = []
+        end
+
+        def config
+          parse_config
+        end
+
+        def valid?
+          validate_ruby_version
+          validate_rails_presence
+          validate_config_presence
+          parse_config
+          validate_config_load
+          @violations.empty?
+        end
+
+        private
+
+        def present?
+          File.exist?(@config_file)
+        end
+
+        def parse_config
+          return unless present?
+
+          @config_data ||= YAML.load_file(@config_file)
+        rescue Psych::SyntaxError => e
+          @violations << Violation.error(
+            filename: @config_file,
+            message: 'AppMap configuration is not valid YAML',
+            detailed_message: e.message
+          )
+          nil
+        end
+
+        def validate_config_load
+          return unless @config_data
+
+          AppMap::Config.load(@config_data)
+        rescue StandardError => e
+          @violations << Violation.error(
+            filename: @config_file,
+            message: 'AppMap configuration could not be loaded',
+            detailed_message: e.message
+          )
+          nil
+        end
+
+        def validate_config_presence
+          unless present?
+            @violations << Violation.error(
+              filename: @config_file,
+              message: 'AppMap configuration file does not exist'
+            )
+          end
+        end
+
+        def validate_rails_presence
+          unless Gem.loaded_specs.has_key?('rails')
+            @violations << Violation.error(
+              message: 'AppMap auto-configuration is currently not available for non Rails projects'
+            )
+          end
+        end
+
+        def validate_ruby_version
+          unless RUBY_VERSION =~ AppMap::SUPPORTED_RUBY_VERSIONS_REGEX
+            @violations << Violation.error(
+              message: "AppMap does not support Ruby #{RUBY_VERSION}. " \
+                "Supported versions are: #{AppMap::SUPPORTED_RUBY_VERSIONS.join(', ')}."
+              )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/appmap/service/validator/violation.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module AppMap
+  module Service
+    module Validator
+      class Violation
+        attr_reader :level, :setting, :filename, :message, :detailed_message, :help_urls
+
+        class << self
+          def error(message:, setting: nil, filename: nil, detailed_message: nil, help_urls: nil)
+            self.new(
+              level: :error,
+              message: message,
+              setting: setting,
+              filename: filename,
+              detailed_message: detailed_message,
+              help_urls: help_urls
+            )
+          end
+
+          def warning(message:, setting: nil, filename: nil, detailed_message: nil, help_urls: nil)
+            self.new(
+              level: :warning,
+              message: message,
+              setting: setting,
+              filename: filename,
+              detailed_message: detailed_message,
+              help_urls: help_urls
+            )
+          end
+        end
+
+        def initialize(level:, message:, setting:, filename:, detailed_message:, help_urls:)
+          @level = level
+          @setting = setting
+          @filename = filename
+          @message = message
+          @detailed_message = detailed_message
+          @help_urls = help_urls
+        end
+
+        def to_h
+          instance_variables.each_with_object({}) do |var, hash|
+            hash[var.to_s.delete("@")] = self.instance_variable_get(var)
+          end.compact
+        end
+      end
+    end
+  end
+end

data/lib/appmap/version.rb

@@ -3,10 +3,13 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.59.2'
+  VERSION = '0.62.0'
 
   APPMAP_FORMAT_VERSION = '1.5.1'
 
+  SUPPORTED_RUBY_VERSIONS_REGEX = /^2\.[567]\./.freeze
+  SUPPORTED_RUBY_VERSIONS = %w[2.5 2.6 2.7].freeze
+
   DEFAULT_APPMAP_DIR = 'tmp/appmap'.freeze
   DEFAULT_CONFIG_FILE_PATH = 'appmap.yml'.freeze
 end

data/package.json

@@ -17,6 +17,6 @@
   },
   "homepage": "https://github.com/applandinc/appmap-ruby#readme",
   "dependencies": {
-    "@appland/cli": "^1.1.0"
+    "@appland/cli": "^1.3.2"
   }
 }

data/spec/depends/api_spec.rb

@@ -0,0 +1,184 @@
+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).to eq(%w[spec/fixtures/depends/user_page_scenario/metadata.json spec/fixtures/depends/revoke_api_key/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.exists?(new_spec_file)).to be_falsey
+      ensure
+        FileUtils.rm_f new_spec_file if File.exists?(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(DEPENDS_TEST_DIR).expand_path.to_s)
+      end
+    end
+
+    describe 'smoke test' do
+      around do |test|
+        @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
+  
+      it 'passes a smoke test' do
+        run_tests
+      end
+    end
+
+    describe 'configuration settings' do
+      it 'can all be modified' do
+        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
+
+  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
+end

data/spec/depends/spec_helper.rb

@@ -0,0 +1,27 @@
+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
+
+RSpec.configure do |rspec|
+  rspec.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/fixtures/config/invalid_config.yml

@@ -1,2 +1,2 @@
-name: -123- %
-packages: ~{}~ ''
+name: name
+packages: [1,2,3]

data/spec/fixtures/config/invalid_yaml_config.yml

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

data/spec/fixtures/depends/.gitignore

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

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

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

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

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