appmap 0.61.1 → 0.62.0

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/version.rb

@@ -3,7 +3,7 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.61.1'
+  VERSION = '0.62.0'
 
   APPMAP_FORMAT_VERSION = '1.5.1'
 

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