appmap 0.56.0 → 0.59.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cfb7d49bd076c0599f8b4866cee8475109553812d13be58a873a288391f9f25
-  data.tar.gz: 2cc00cb780ac948e058ca4742ce3bc52d79b8c08f55bcf964363a9f1fcfc2763
+  metadata.gz: 63240e66f2942705bc89667ac6bdf7af49fc9e1c2225d4a6ffd243ad43ccbb80
+  data.tar.gz: 7f0d20e3b75dee93c32cab9d99844528ba35aa2e4987ec649e3194a806b1de8e
 SHA512:
-  metadata.gz: acf4df227c1cadc89495c36528eb386f1a09323010dba9869a8a1e7d4b584bf2097a7148a57fe0ca0979560a30cb5f083cf132f799f309a1ef89461025151558
-  data.tar.gz: 628153961f02ad5cb6b34e3ac21432afdce20a61234f3dfa9b57835e33ef5189d9a10c12ba4d361126e820ecd6dd3b89b8b64f2f72a5e1f6d38ee3ea4e5888a9
+  metadata.gz: 5f3892093241092685b18ebd1f5f2a63e4f697c6099b32bd6cabfe2edba79448542ecc7c3080c69e4bdad8732805e69bd80b5bbc2c3b21a15f4085d3034520d1
+  data.tar.gz: 8279d3bd2403bf28f255c7c985e90760e7700a865259865a89ec793cf5539a5caab7810b153a1bc9ca2b09c9654edd84db94c1535fdd155ea4d7181dfc914eef

data/CHANGELOG.md

@@ -1,3 +1,38 @@
+## [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)
+
+
+### Features
+
+* Update init command to return JSON ([1f93e89](https://github.com/applandinc/appmap-ruby/commit/1f93e8909684e1018f513d69adfde2a5d0bf6bc9))
+
 # [0.56.0](https://github.com/applandinc/appmap-ruby/compare/v0.55.0...v0.56.0) (2021-06-28)
 
 

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

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
-require 'fileutils'
+require 'json'
 require 'appmap/service/guesser'
-require 'appmap/util'
 
 module AppMap
   module Command
@@ -11,32 +10,19 @@ module AppMap
 
       class Init < InitStruct
         def perform
-          if File.exist?(config_file)
-            puts AppMap::Util.color(%(The AppMap config file #{config_file} already exists.), :magenta)
-            return
-          end
-
-          ensure_directory_exists
-
           config = {
             'name' => Service::Guesser.guess_name,
             'packages' => Service::Guesser.guess_paths.map { |path| { 'path' => path } }
           }
-          content = YAML.dump(config).gsub("---\n", '')
 
-          File.write(config_file, content)
-          puts AppMap::Util.color(
-            %(The following AppMap config file #{config_file} has been created:),
-            :green
-          )
-          puts content
-        end
-
-        private
+          result = {
+            configuration: {
+              filename: config_file,
+              contents: YAML.dump(config)
+            }
+          }
 
-        def ensure_directory_exists
-          dirname = File.dirname(config_file)
-          FileUtils.mkdir_p(dirname) unless File.directory?(dirname)
+          puts JSON.pretty_generate(result)
         end
       end
     end

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
 

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

@@ -3,7 +3,7 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.56.0'
+  VERSION = '0.59.1'
 
   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_init_test.rb

@@ -5,8 +5,8 @@ require 'test_helper'
 
 class AgentSetupInitTest < Minitest::Test
   CONFIG_FILENAME = '123.yml'
-  SUBFOLDER_CONFIG_FILEPATH = 'conf/123.yml'
-  EXPECTED_CONFIG_CONTENT = %(name: appmap-ruby
+  EXPECTED_CONFIG_CONTENT = %(---
+name: appmap-ruby
 packages:
 - path: lib
 )
@@ -14,24 +14,24 @@ packages:
   def test_init_when_config_exists
     output = `./exe/appmap-agent-init`
     assert_equal 0, $CHILD_STATUS.exitstatus
-    assert_includes output, 'The AppMap config file appmap.yml already exists.'
+    expected = JSON.pretty_generate({
+      configuration: {
+        filename: 'appmap.yml',
+        contents: EXPECTED_CONFIG_CONTENT
+      }
+    })
+    assert_equal expected, output.strip
   end
 
   def test_init_with_custom_config_filename
     output = `./exe/appmap-agent-init -c #{CONFIG_FILENAME}`
     assert_equal 0, $CHILD_STATUS.exitstatus
-    assert_includes output, "The following AppMap config file #{CONFIG_FILENAME} has been created:"
-    assert_equal EXPECTED_CONFIG_CONTENT, File.read(CONFIG_FILENAME)
-  ensure
-    File.delete(CONFIG_FILENAME) if File.exist?(CONFIG_FILENAME)
-  end
-
-  def test_init_with_custom_config_file_in_subfolder
-    output = `./exe/appmap-agent-init --config=#{SUBFOLDER_CONFIG_FILEPATH}`
-    assert_equal 0, $CHILD_STATUS.exitstatus
-    assert_includes output, "The following AppMap config file #{SUBFOLDER_CONFIG_FILEPATH} has been created:"
-    assert_equal EXPECTED_CONFIG_CONTENT, File.read(SUBFOLDER_CONFIG_FILEPATH)
-  ensure
-    File.delete(SUBFOLDER_CONFIG_FILEPATH) if File.exist?(SUBFOLDER_CONFIG_FILEPATH)
+    expected = JSON.pretty_generate({
+      configuration: {
+        filename: CONFIG_FILENAME,
+        contents: EXPECTED_CONFIG_CONTENT
+      }
+    })
+    assert_equal expected, output.strip
   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.56.0
+  version: 0.59.1
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-28 00:00:00.000000000 Z
+date: 2021-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -356,6 +356,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 +546,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