appmap 0.59.2 → 0.62.0

data/lib/appmap/depends/node_cli.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'shellwords'
+require 'appmap/node_cli'
+
+module AppMap
+  module Depends
+    # +Command+ wraps the Node +depends+ command.
+    class NodeCLI < ::AppMap::NodeCLI
+      # Directory name to prefix to the list of modified files which is provided to +depends+.
+      attr_accessor :base_dir
+      # AppMap field to report.
+      attr_accessor :field
+
+      def initialize(verbose:, appmap_dir:)
+        super(verbose: verbose, appmap_dir: appmap_dir)
+
+        @base_dir = nil
+        @field = 'source_location'
+      end
+
+      # Returns the source_location field of every AppMap that is "out of date" with respect to one of the
+      # +modified_files+.
+      def depends(modified_files = nil)
+        index_appmaps
+
+        cmd = %w[depends]
+        cmd += [ '--field', field ] if field
+        cmd += [ '--appmap-dir', appmap_dir ] if appmap_dir
+        cmd += [ '--base-dir', base_dir ] if base_dir
+
+        options = {}
+        if modified_files
+          cmd << '--stdin-files'
+          options[:stdin_data] = modified_files.map(&:shellescape).join("\n")
+          warn "Checking modified files: #{modified_files.join(' ')}" if verbose
+        end
+
+        stdout, = command cmd, options
+        stdout.split("\n")
+      end
+    end
+  end
+end

data/lib/appmap/depends/rake_tasks.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'rake'
+require 'appmap/node_cli'
+require_relative 'api'
+
+module AppMap
+  module Depends
+    module RakeTasks
+      extend self
+      extend Rake::DSL
+
+      def depends_api
+        AppMap::Depends::API.new(Rake.verbose == true)
+      end
+
+      def configuration
+        AppMap.configuration
+      end
+
+      def define_tasks
+        namespace :depends do
+          task :modified do
+            @appmap_modified_files = depends_api.modified(appmap_dir: configuration.appmap_dir, base_dir: configuration.depends_config.base_dir)
+            depends_api.report_list 'Out of date', @appmap_modified_files
+          end
+      
+          task :test_file_report do
+            @appmap_test_file_report = depends_api.inspect_test_files(appmap_dir: configuration.appmap_dir, test_file_patterns: configuration.depends_config.test_file_patterns)
+            @appmap_test_file_report.report
+          end
+
+          task :run_tests do
+            if @appmap_test_file_report
+              @appmap_test_file_report.clean_appmaps
+              @appmap_modified_files += @appmap_test_file_report.modified_files
+            end
+      
+            if @appmap_modified_files.empty?
+              warn 'AppMaps are up to date'
+              next
+            end
+      
+            start_time = Time.current
+            depends_api.run_tests(@appmap_modified_files, appmap_dir: configuration.appmap_dir)
+
+            warn "Tests succeeded - removing out of date AppMaps."
+            removed = depends_api.remove_out_of_date_appmaps(start_time, appmap_dir: configuration.appmap_dir, base_dir: configuration.depends_config.base_dir)
+            warn "Removed out of date AppMaps: #{removed.join(' ')}" unless removed.empty?
+          end
+
+          desc configuration.depends_config.description
+          task :update => [ :modified, :test_file_report, :run_tests ] + configuration.depends_config.dependent_tasks
+        end
+      end
+    end
+  end
+end

data/lib/appmap/depends/test_file_inspector.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module AppMap
+  module Depends
+    class TestFileInspector
+      TestReport = Struct.new(:metadata_files, :added, :removed, :changed, :failed) do
+        private_methods :metadata_files
+
+        def to_s
+          report = []
+          report << "Added test files   : #{added.to_a.join(' ')}" unless added.empty?
+          report << "Removed test files : #{removed.to_a.join(' ')}" unless removed.empty?
+          report << "Changed test files : #{changed.to_a.join(' ')}" unless changed.empty?
+          report << "Failed test files  : #{failed.to_a.join(' ')}" unless failed.empty?
+          report.compact.join("\n")
+        end
+
+        def report
+          warn to_s unless empty?
+        end
+
+        def empty?
+          [ added, removed, changed, failed ].all?(&:empty?)
+        end
+
+        def modified_files
+          added + changed + failed
+        end
+
+        # Delete AppMaps which depend on test cases that have been deleted.
+        def clean_appmaps
+          return if removed.empty?
+
+          count = metadata_files.each_with_object(0) do |metadata_file, count|
+            metadata = JSON.parse(File.read(metadata_file))
+            source_location = Util.normalize_path(metadata['source_location'])
+            appmap_path = File.join(metadata_file.split('/')[0...-1])
+    
+            if source_location && removed.member?(source_location)
+              Util.delete_appmap(appmap_path)
+              count += 1
+            end
+          end
+          count
+        end
+      end
+
+      attr_reader :test_dir
+      attr_reader :test_file_patterns
+
+      def initialize(test_dir, test_file_patterns)
+        @test_dir = test_dir
+        @test_file_patterns = test_file_patterns
+      end
+
+      def report
+        metadata_files = Dir.glob(File.join(test_dir, '**', 'metadata.json'))
+        source_locations = Set.new
+        changed_test_files = Set.new
+        failed_test_files = Set.new
+        metadata_files.each do |metadata_file|
+          metadata = JSON.parse(File.read(metadata_file))
+          appmap_path = File.join(metadata_file.split('/')[0...-1])
+
+          appmap_mtime = File.read(File.join(appmap_path, 'mtime')).to_i
+          source_location = Util.normalize_path(metadata['source_location'])
+          test_status = metadata['test_status']
+          next unless source_location && test_status
+
+          source_location_mtime = (File.stat(source_location).mtime.to_f * 1000).to_i rescue nil
+          source_locations << source_location
+          if source_location_mtime
+            changed_test_files << source_location if source_location_mtime > appmap_mtime
+            failed_test_files << source_location unless test_status == 'succeeded'
+          end
+        end
+  
+        test_files = Set.new(test_file_patterns.map(&Dir.method(:glob)).flatten)
+        added_test_files = test_files - source_locations
+        changed_test_files -= added_test_files
+        removed_test_files = source_locations - test_files
+    
+        TestReport.new(metadata_files, added_test_files, removed_test_files, changed_test_files, failed_test_files)
+      end
+    end
+  end
+end

data/lib/appmap/depends/test_runner.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require "shellwords"
+
+module AppMap
+  module Depends
+    class << self
+      def select_rspec_tests(test_files)
+        select_tests_by_directory(test_files, 'spec')
+      end
+
+      def select_minitest_tests(test_files)
+        select_tests_by_directory(test_files, 'test')
+      end
+
+      def rspec_test_command(test_files)
+        "bundle exec rspec --format documentation -t '~empty' -t '~large' -t '~unstable' #{test_files}"
+      end
+
+      def minitest_test_command(test_files)
+        "bundle exec rails test #{test_files}"
+      end
+
+      def select_tests_by_directory(test_files, dir)
+        test_files
+          .map(&method(:simplify_path))
+          .uniq
+          .select { |path| path.split('/').first == dir }
+      end
+
+      def normalize_test_files(test_files)
+        test_files
+          .map(&method(:simplify_path))
+          .uniq
+          .map(&:shellescape).join(' ')
+      end
+
+      def test_env
+        # DISABLE_SPRING because it's likely to not have APPMAP=true
+        { 'RAILS_ENV' => 'test', 'APPMAP' => 'true', 'DISABLE_SPRING' => '1' }
+      end
+
+      def simplify_path(file)
+        file.index(Dir.pwd) == 0 ? file[Dir.pwd.length+1..-1] : file
+      end
+    end
+
+    class TestRunner
+      def initialize(test_files)
+        @test_files = test_files
+      end
+
+      def run
+        %i[rspec minitest].each do |framework|
+          run_tests select_tests_fn(framework), build_environment_fn(framework), test_command_fn(framework)
+        end
+      end
+
+      def build_environment_fn(framework)
+        lookup_method("#{framework}_environment_method") do |method|
+          lambda do
+            method.call
+          end
+        end
+      end
+
+      def select_tests_fn(framework)
+        lookup_method("#{framework}_select_tests_method") do |method|
+          lambda do |test_files|
+            method.call(test_files)
+          end
+        end
+      end
+
+      def test_command_fn(framework)
+        lookup_method("#{framework}_test_command_method") do |method|
+          lambda do |test_files|
+            method.call(test_files)
+          end
+        end
+      end
+
+      protected
+
+      def lookup_method(setting_name, &block)
+        method_name = AppMap.configuration.depends_config.send(setting_name)
+        method_tokens = method_name.split(/\:\:|\./)
+        cls = Object
+        while method_tokens.size > 1
+          cls = cls.const_get(method_tokens.shift)
+        end
+        cls.public_method(method_tokens.first)
+      end
+
+      def run_tests(select_tests_fn, env_fn, test_command_fn)
+        test_files = select_tests_fn.(@test_files)
+        return if test_files.empty?
+
+        test_files = Depends.normalize_test_files(test_files)
+        command = test_command_fn.(test_files)
+        succeeded = system(env_fn.(), command)
+        raise %Q|Command failed: #{command}| unless succeeded
+      end
+    end
+  end
+end

data/lib/appmap/depends/util.rb

@@ -0,0 +1,34 @@
+module AppMap
+  module Depends
+    module Util
+      extend self
+
+      def normalize_path(path, pwd: Dir.pwd)
+        normalize_path_fn(pwd).(path)
+      end
+
+      def normalize_paths(paths, pwd: Dir.pwd)
+        paths.map(&normalize_path_fn(pwd))
+      end
+            
+      def delete_appmap(appmap_path)
+        FileUtils.rm_rf(appmap_path)
+        appmap_file_path = [ appmap_path, 'appmap.json' ].join('.')
+        File.unlink(appmap_file_path) if File.exists?(appmap_file_path)
+      rescue
+        warn "Unable to delete AppMap: #{$!}"
+      end
+
+      private
+
+      def normalize_path_fn(pwd)
+        lambda do |path|
+          next path if AppMap::Util.blank?(path)
+
+          path = path[pwd.length + 1..-1] if path.index(pwd) == 0
+          path.split(':')[0]
+        end  
+      end
+    end
+  end
+end

data/lib/appmap/service/config_analyzer.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'appmap/service/validator/config_validator'
+
 module AppMap
   module Service
     class ConfigAnalyzer
@@ -7,11 +9,10 @@ module AppMap
 
       def initialize(config_file)
         @config_file = config_file
-        @config = load_config
       end
 
       def app_name
-        @config.to_h[:name] if present?
+        config_validator.config.to_h['name'] if present?
       end
 
       def present?
@@ -19,16 +20,14 @@ module AppMap
       end
 
       def valid?
-        present? && @config.to_h.key?(:name) && @config.to_h.key?(:packages)
+        config_validator.valid?
       end
 
       private
 
-      def load_config
-        AppMap::Config.load_from_file @config_file if present?
-      rescue
-        nil
+      def config_validator
+        @validator ||= AppMap::Service::Validator::ConfigValidator.new(@config_file)
       end
     end
   end
-end
+end

data/lib/appmap/service/integration_test_path_finder.rb

@@ -5,39 +5,43 @@ require 'appmap/service/test_framework_detector'
 module AppMap
   module Service
     class IntegrationTestPathFinder
-      class << self
-        def find
-          @paths ||= begin
-            paths = { rspec: [], minitest: [], cucumber: [] }
-            paths[:rspec] = find_rspec_paths if TestFrameworkDetector.rspec_present?
-            paths[:minitest] = find_minitest_paths if TestFrameworkDetector.minitest_present?
-            paths[:cucumber] = find_cucumber_paths if TestFrameworkDetector.cucumber_present?
-            paths
-          end
-        end
+      def initialize(base_path = '')
+        @base_path = base_path
+      end
 
-        def count_paths
-          find.flatten(2).length - 3
+      def find
+        @paths ||= begin
+          paths = { rspec: [], minitest: [], cucumber: [] }
+          paths[:rspec] = find_rspec_paths if TestFrameworkDetector.rspec_present?
+          paths[:minitest] = find_minitest_paths if TestFrameworkDetector.minitest_present?
+          paths[:cucumber] = find_cucumber_paths if TestFrameworkDetector.cucumber_present?
+          paths
         end
+      end
 
-        private
+      def count_paths
+        find.flatten(2).length - 3
+      end
 
-        def find_rspec_paths
-          find_non_empty_paths(%w[spec/controllers spec/requests spec/integration spec/api spec/features spec/system])
-        end
+      private
+
+      def find_rspec_paths
+        find_non_empty_paths(%w[spec/controllers spec/requests spec/integration spec/api spec/features spec/system])
+      end
 
 
-        def find_minitest_paths
-          find_non_empty_paths(%w[test/controllers test/integration])
-        end
+      def find_minitest_paths
+        top_level_paths = %w[test/controllers test/integration]
+        children_paths = Dir.glob('test/**/{controllers,integration}')
+        find_non_empty_paths((top_level_paths + children_paths).uniq).sort
+      end
 
-        def find_cucumber_paths
-          find_non_empty_paths(%w[features])
-        end
+      def find_cucumber_paths
+        find_non_empty_paths(%w[features])
+      end
 
-        def find_non_empty_paths(paths)
-          paths.select { |path| Dir.exist?(path) && !Dir.empty?(path) }
-        end
+      def find_non_empty_paths(paths)
+        paths.select { |path| Dir.exist?(@base_path + path) && !Dir.empty?(@base_path + path) }
       end
     end
   end