appmap 0.57.0 → 0.59.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 442ca8673e42cd8bea0db1ba97a533e7a38965f3d27707bd8e4379b578ee85cb
-  data.tar.gz: 1174d299f1446c8c3e16403437682196ce794bad27b7c6dd69d712f9bd59e36a
+  metadata.gz: 93b0a392f69c9de659a086819d29b2b4c94c4b704d04ac2d57f99cafe56f4f80
+  data.tar.gz: 4f42ab168f8bb4f1c8500f6f98682d7c048119125ba34aa0ddd80f9a521c7d02
 SHA512:
-  metadata.gz: 73bb23b5ac1401565c57ffbd833fe266ddebfe71271926ca0afaa08b92c88ffd47f5c92f6e91f213b8066729e6607a1b0f99731449eecf7bd68ab125a0f5de3f
-  data.tar.gz: f72d956ed6c6a46aebe12724a910d5cbdec1aee3d8b61f300e8b2a679873b25db245cca4407c02a03df1588fd3734d616472aed69c2741898e60bc04f6d04b33
+  metadata.gz: 95538abb1fc5ba05793bba2efc1731a823c324515956aa7b388b04d8b43953f3885d45ca1937d684c0b6e2415fc7fb6d1f591da02ffa0dbc06883c7298d3eb0b
+  data.tar.gz: 48d7105b1ced68d2ddd9229b2811b0d157ca60b879b8d781e014cf02ca512147c33a95b4a52e49216e5fbf47b3fc7fafa19fa25d00a57506872ab1a3ef71651f

data/CHANGELOG.md

@@ -1,3 +1,38 @@
+## [0.59.2](https://github.com/applandinc/appmap-ruby/compare/v0.59.1...v0.59.2) (2021-07-08)
+
+
+### Bug Fixes
+
+* Remove improper reliance on Rails 'try' ([c6b5b16](https://github.com/applandinc/appmap-ruby/commit/c6b5b16a6963988e20bab5f88b99401e25691f3c))
+
+## [0.59.1](https://github.com/applandinc/appmap-ruby/compare/v0.59.0...v0.59.1) (2021-07-08)
+
+
+### Bug Fixes
+
+* Events may be constructed in stages ([b0b23f5](https://github.com/applandinc/appmap-ruby/commit/b0b23f59a84158b8162424b84430894fe4278324))
+
+# [0.59.0](https://github.com/applandinc/appmap-ruby/compare/v0.58.0...v0.59.0) (2021-07-07)
+
+
+### Features
+
+* define commands as objects ([1b43203](https://github.com/applandinc/appmap-ruby/commit/1b432039040277e1b5349cc2f75aa436238ea873))
+
+# [0.58.0](https://github.com/applandinc/appmap-ruby/compare/v0.57.1...v0.58.0) (2021-07-06)
+
+
+### Features
+
+* Add `test_commands` sections to `appmap-agent-status` executable ([4cd8fe5](https://github.com/applandinc/appmap-ruby/commit/4cd8fe58acb4af72b7818db96de9e479562b9ea0))
+
+## [0.57.1](https://github.com/applandinc/appmap-ruby/compare/v0.57.0...v0.57.1) (2021-07-02)
+
+
+### Bug Fixes
+
+* rename agentVersionPorject to agentVersion ([905fc5d](https://github.com/applandinc/appmap-ruby/commit/905fc5dd643411deb94f8a1087bcdb3a562d218a))
+
 # [0.57.0](https://github.com/applandinc/appmap-ruby/compare/v0.56.0...v0.57.0) (2021-06-29)
 
 

data/config-schema.yml

@@ -0,0 +1,57 @@
+type: object
+additionalProperties: false
+required:
+  - name
+properties:
+  name:
+    type: string
+  packages:
+    type: array
+    items:
+      anyOf:
+        - type: object
+          additionalProperties: false
+          required:
+            - path
+          properties:
+            path:
+              type: string
+            shallow:
+              type: boolean
+            exclude:
+              type: array
+              items:
+                type: string
+        - type: object
+          additionalProperties: false
+          required:
+            - gem
+          properties:
+            gem:
+              type: string
+            shallow:
+              type: boolean
+            exclude:
+              type: array
+              items:
+                type: string
+  exclude:
+    type: array
+    items:
+      type: string
+  functions:
+    type: array
+    items:
+      type: object
+      additionalProperties: false
+      properties:
+        package:
+          type: string
+        class:
+          type: string
+        function:
+          type: string
+        labels:
+          type: array
+          items:
+            type: string

data/lib/appmap/command/agent_setup/status.rb

@@ -2,6 +2,8 @@
 
 require 'json'
 require 'appmap/service/config_analyzer'
+require 'appmap/service/integration_test_path_finder'
+require 'appmap/service/test_command_provider'
 
 module AppMap
   module Command
@@ -11,22 +13,23 @@ module AppMap
       class Status < StatusStruct
         def perform
           status = {
-            :properties => {
-              :config => {
-                :app => config_analyzer.app_name,
-                :present => config_analyzer.present?,
-                :valid => config_analyzer.valid?
+            test_commands: Service::TestCommandProvider.all,
+            properties: {
+              config: {
+                app: config_analyzer.app_name,
+                present: config_analyzer.present?,
+                valid: config_analyzer.valid?
               },
-              :project => {
-                :agentVersionProject => AppMap::VERSION,
-                :language => 'ruby',
-                :remoteRecordingCapable => Gem.loaded_specs.has_key?('rails'),
-                :integrationTests => false #TODO
+              project: {
+                agentVersion: AppMap::VERSION,
+                language: 'ruby',
+                remoteRecordingCapable: Gem.loaded_specs.has_key?('rails'),
+                integrationTests: Service::IntegrationTestPathFinder.count_paths > 0
               }
             }
           }
 
-          puts status.to_json
+          puts JSON.pretty_generate(status)
         end
 
         private

data/lib/appmap/event.rb

@@ -119,6 +119,14 @@ module AppMap
           end
         end
       end
+      
+      # An event may be partially constructed, and then completed at a later time. When the event
+      # is only partially constructed, it's not ready for serialization to the AppMap file. 
+      # 
+      # @return false until the event is fully constructed and available.
+      def ready?
+        true
+      end
 
       protected
 
@@ -240,7 +248,7 @@ module AppMap
               next_exception = exception
               exceptions = []
               while next_exception
-                exception_backtrace = next_exception.backtrace_locations.try(:[], 0)
+                exception_backtrace = AppMap::Util.try(next_exception.backtrace_locations, :[], 0)
                 exceptions << {
                   class: best_class_name(next_exception),
                   message: display_string(next_exception.message),

data/lib/appmap/handler/rails/template.rb

@@ -71,11 +71,16 @@ module AppMap
           attr_reader :render_instance
           # Path to the view template.
           attr_accessor :path
-  
+          # Indicates when the event is fully constructed.
+          attr_accessor :ready
+
+          alias ready? ready
+ 
           def initialize(render_instance)
             super :call
   
             AppMap::Event::MethodEvent.build_from_invocation(:call, event: self)
+            @ready = false
             @render_instance = render_instance
           end
   
@@ -95,8 +100,7 @@ module AppMap
                 object_id: render_instance.__id__,
                 value: AppMap::Event::MethodEvent.display_string(render_instance)
               }
-              h.compact
-            end
+            end.compact
           end
         end
  
@@ -158,7 +162,8 @@ module AppMap
             end
   
             def handle_return(call_event_id, elapsed, return_value, exception)
-              Array(Thread.current[TEMPLATE_RENDERER]).pop
+              template_call = Array(Thread.current[TEMPLATE_RENDERER]).pop
+              template_call.ready = true
 
               AppMap::Event::MethodReturnIgnoreValue.build_from_invocation(call_event_id, elapsed: elapsed)
             end

data/lib/appmap/service/integration_test_path_finder.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+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 count_paths
+          find.flatten(2).length - 3
+        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_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
+      end
+    end
+  end
+end

data/lib/appmap/service/test_command_provider.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'appmap/service/test_framework_detector'
+require 'appmap/service/integration_test_path_finder'
+
+module AppMap
+  module Service
+    class TestCommandProvider
+      class << self
+        def all
+          commands = []
+
+          if TestFrameworkDetector.rspec_present? && !integration_test_paths[:rspec].empty?
+            commands << {
+              framework: :rspec,
+              command: {
+                program: 'bundle',
+                args: %w[exec rspec] + integration_test_paths[:rspec].map { |path| "./#{path}" },
+                environment: {
+                  APPMAP: 'true'
+                }
+              }
+            }
+          end
+
+          if TestFrameworkDetector.minitest_present? && !integration_test_paths[:minitest].empty?
+            commands += minitest_commands
+          end
+          if TestFrameworkDetector.cucumber_present? && !integration_test_paths[:cucumber].empty?
+            commands << {
+              framework: :cucumber,
+              command: {
+                program: 'bundle',
+                args: %w[exec cucumber],
+                environment: { APPMAP: 'true' }
+              }
+            }
+          end
+
+          commands
+        end
+
+        private
+
+        def minitest_commands
+          if Gem.loaded_specs.has_key?('rails')
+            [
+              {
+                framework: :minitest,
+                command: {
+                  program: 'bundle',
+                  args: %w[exec rails test] + integration_test_paths[:minitest].map { |path| "./#{path}" },
+                  environment: { APPMAP: 'true' }
+                }
+              }
+            ]
+          else
+            integration_test_paths[:minitest].map do |path|
+              {
+                framework: :minitest,
+                command: {
+                  program: 'bundle',
+                  args: ['exec', 'ruby', "./#{path}"],
+                  environment: { APPMAP: 'true' }
+                }
+              }
+            end
+          end
+        end
+
+        def integration_test_paths
+          @paths ||= Service::IntegrationTestPathFinder.find
+        end
+      end
+    end
+  end
+end

data/lib/appmap/service/test_framework_detector.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module AppMap
+  module Service
+    class TestFrameworkDetector
+      class << self
+        def rspec_present?
+          Gem.loaded_specs.has_key?('rspec-core')
+        end
+
+        def minitest_present?
+          Gem.loaded_specs.has_key?('minitest')
+        end
+
+        def cucumber_present?
+          Gem.loaded_specs.has_key?('cucumber')
+        end
+      end
+    end
+  end
+end

data/lib/appmap/trace.rb

@@ -143,12 +143,12 @@ module AppMap
 
     # Whether there is an event available for processing.
     def event?
-      !@events.empty?
+      !@events.empty? && @events.first.ready?
     end
 
     # Gets the next available event, if any.
     def next_event
-      @events.shift
+      @events.shift if event?
     end
   end
 end

data/lib/appmap/util.rb

@@ -183,6 +183,15 @@ module AppMap
         false
       end
 
+      # https://github.com/rails/rails/blob/8cd143900978902ed9bbba10b34099a3140de5c6/activesupport/lib/active_support/core_ext/object/try.rb
+      def try(obj, *methods)
+        return nil if methods.empty?
+
+        return nil unless obj.respond_to?(methods.first)
+
+        obj.public_send(*methods)
+      end
+
       def startup_message(msg)
         if defined?(::Rails) && defined?(::Rails.logger) && ::Rails.logger
           ::Rails.logger.info msg

data/lib/appmap/version.rb

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

data/spec/fixtures/rails6_users_app/test/controllers/functional_calc_test.rb

@@ -0,0 +1,10 @@
+# minitest_calc_test_unit_format_spec.rb
+
+require "minitest/autorun"
+
+class FunctionalCalcTest < Minitest::Test
+  def test_add
+    puts 'functional'
+    assert_equal 2 + 2, 4
+  end
+end

data/spec/fixtures/rails6_users_app/test/integration/integration_calc_test.rb

@@ -0,0 +1,12 @@
+# minitest_calc_test_unit_format_spec.rb
+
+require "minitest/autorun"
+
+class IntegrationCalcTest < Minitest::Test
+  class CalcTest < Minitest::Test
+    def test_add
+      puts 'integration'
+      assert_equal 2 + 2, 4
+    end
+  end
+end

data/test/agent_setup_status_test.rb

@@ -4,24 +4,78 @@
 require 'test_helper'
 
 class AgentSetupInitTest < Minitest::Test
-  def test_status
+  def test_status_gem
     output = `./exe/appmap-agent-status`
     assert_equal 0, $CHILD_STATUS.exitstatus
     expected = {
-      :properties => {
-        :config => {
-          :app => 'AppMap Rubygem',
-          :present => true,
-          :valid => true
+      test_commands: [],
+      properties: {
+        config: {
+          app: 'AppMap Rubygem',
+          present: true,
+          valid: true
         },
-        :project => {
-          :agentVersionProject => AppMap::VERSION,
-          :language => 'ruby',
-          :remoteRecordingCapable => false,
-          :integrationTests => false
+        project: {
+          agentVersion: AppMap::VERSION,
+          language: 'ruby',
+          remoteRecordingCapable: false,
+          integrationTests: false
         }
       }
-    }.to_json
-    assert_equal expected, output.strip
+    }
+    assert_equal JSON.pretty_generate(expected), output.strip
+  end
+
+  def test_status_rails_app
+    output = `cd spec/fixtures/rails6_users_app && bundle exec ../../../exe/appmap-agent-status`
+    assert_equal 0, $CHILD_STATUS.exitstatus
+    expected = {
+      test_commands: [
+        {
+          framework: :rspec,
+          command: {
+            program: 'bundle',
+            args: %w[exec rspec ./spec/controllers],
+            environment: {
+              APPMAP: 'true'
+            }
+          }
+        },
+        {
+          framework: :minitest,
+          command: {
+            program: 'bundle',
+            args: %w[exec ruby ./test/controllers],
+            environment: {
+              APPMAP: 'true'
+            }
+          }
+        },
+        {
+          framework: :minitest,
+          command: {
+            program: 'bundle',
+            args: %w[exec ruby ./test/integration],
+            environment: {
+              APPMAP: 'true'
+            }
+          }
+        }
+      ],
+      properties: {
+        config: {
+          app: nil,
+          present: true,
+          valid: false
+        },
+        project: {
+          agentVersion: AppMap::VERSION,
+          language: 'ruby',
+          remoteRecordingCapable: false,
+          integrationTests: true
+        }
+      }
+    }
+    assert_equal JSON.pretty_generate(expected), output.strip
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.57.0
+  version: 0.59.2
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-29 00:00:00.000000000 Z
+date: 2021-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -317,6 +317,7 @@ files:
 - Rakefile
 - appmap.gemspec
 - appmap.yml
+- config-schema.yml
 - examples/install.rb
 - examples/mock_webapp/Gemfile
 - examples/mock_webapp/appmap.yml
@@ -356,6 +357,9 @@ files:
 - lib/appmap/rspec.rb
 - lib/appmap/service/config_analyzer.rb
 - lib/appmap/service/guesser.rb
+- lib/appmap/service/integration_test_path_finder.rb
+- lib/appmap/service/test_command_provider.rb
+- lib/appmap/service/test_framework_detector.rb
 - lib/appmap/swagger.rb
 - lib/appmap/swagger/configuration.rb
 - lib/appmap/swagger/markdown_descriptions.rb
@@ -543,6 +547,8 @@ files:
 - spec/fixtures/rails6_users_app/spec/models/user_spec.rb
 - spec/fixtures/rails6_users_app/spec/rails_helper.rb
 - spec/fixtures/rails6_users_app/spec/spec_helper.rb
+- spec/fixtures/rails6_users_app/test/controllers/functional_calc_test.rb
+- spec/fixtures/rails6_users_app/test/integration/integration_calc_test.rb
 - spec/fixtures/rails6_users_app/users_app/.gitignore
 - spec/hook_spec.rb
 - spec/open_spec.rb