appmap 0.55.0 → 0.59.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfd518bd44a86f1270fe90e70c397e213763dd582260ace7c5a01898b94030d2
-  data.tar.gz: cf449bff5700a1bfd5efabda40ccd59c5281d595aa34ca551d6a3b4b1f89f5f8
+  metadata.gz: b0592a1e7b252df037c7e06986095c4e7f5feba8011a317e54edda181c53aed7
+  data.tar.gz: 44d0c65506400e36016dd140e7f4a109f6495dd2ae6bdd893e038bd8c1504d95
 SHA512:
-  metadata.gz: 1824e49817ccceca6571fb2cb6f4a3033fb4873bb184577ec3989af3d74d09aecbf7685f9ce9f7efeb2a43e811f9477b0cfc5c6f6778ba3ec8d141c37560112c
-  data.tar.gz: da796d7072dab9b505f6fe1220ae3987e0577be458dfb1253b3d4b860df41d7a4856640629dd300ebcb6588f350f4f55af2b867bf730d0a65e90788c0f2eeb0d
+  metadata.gz: cc7057bf09581066d6ef84f2f73b17ea9a3088ec6e19dfd90f2983a15706f98de6ca1e20ccfc949aad334ccfa7f0346474bd53899eefb9a44d871618c7c17995
+  data.tar.gz: 4c86d5a8782501a8924f286e41334b79473d87990e7a731ee7832288ae81ad4db112d6826313dfae99cb1a5b418e77fbea63a3a2888ec9d09fffbbd98d0c7e80

data/CHANGELOG.md

@@ -1,3 +1,38 @@
+# [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)
+
+
+### Features
+
+* add appmap-agent-status executable with config/project properties ([043f845](https://github.com/applandinc/appmap-ruby/commit/043f8453a2533a6e172d1cd23fcde04f19e73173))
+
 # [0.55.0](https://github.com/applandinc/appmap-ruby/compare/v0.54.4...v0.55.0) (2021-06-28)
 
 

data/exe/appmap-agent-init

@@ -5,10 +5,10 @@ require 'optparse'
 require 'appmap'
 require 'appmap/command/agent_setup/init'
 
-@options = {:config_file => AppMap::DEFAULT_CONFIG_FILE_PATH}
+@options = { config_file: AppMap::DEFAULT_CONFIG_FILE_PATH }
 
 OptionParser.new do |parser|
-  parser.banner = 'Usage: bundle exec exe/appmap-agent-init [options]'
+  parser.banner = 'Usage: appmap-agent-init [options]'
 
   description = "AppMap configuration file path (default: #{AppMap::DEFAULT_CONFIG_FILE_PATH})"
   parser.on('-c', '--config=FILEPATH', description) do |filepath|

data/exe/appmap-agent-status

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'optparse'
+require 'appmap'
+require 'appmap/command/agent_setup/status'
+
+@options = { config_file: AppMap::DEFAULT_CONFIG_FILE_PATH }
+
+OptionParser.new do |parser|
+  parser.banner = 'Usage: appmap-agent-status [options]'
+
+  description = "AppMap configuration file path (default: #{AppMap::DEFAULT_CONFIG_FILE_PATH})"
+  parser.on('-c', '--config=FILEPATH', description) do |filepath|
+    @options[:config_file] = filepath
+  end
+end.parse!
+
+AppMap::Command::AgentSetup::Status.new(@options[:config_file]).perform

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'appmap/service/config_analyzer'
+require 'appmap/service/integration_test_path_finder'
+require 'appmap/service/test_command_provider'
+
+module AppMap
+  module Command
+    module AgentSetup
+      StatusStruct = Struct.new(:config_file)
+
+      class Status < StatusStruct
+        def perform
+          status = {
+            test_commands: Service::TestCommandProvider.all,
+            properties: {
+              config: {
+                app: config_analyzer.app_name,
+                present: config_analyzer.present?,
+                valid: config_analyzer.valid?
+              },
+              project: {
+                agentVersion: AppMap::VERSION,
+                language: 'ruby',
+                remoteRecordingCapable: Gem.loaded_specs.has_key?('rails'),
+                integrationTests: Service::IntegrationTestPathFinder.count_paths > 0
+              }
+            }
+          }
+
+          puts JSON.pretty_generate(status)
+        end
+
+        private
+
+        def config_analyzer
+          @config_analyzer ||= Service::ConfigAnalyzer.new(config_file)
+        end
+      end
+    end
+  end
+end

data/lib/appmap/config.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'set'
 require 'yaml'
 require 'appmap/util'
 require 'appmap/handler/net_http'

data/lib/appmap/service/config_analyzer.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module AppMap
+  module Service
+    class ConfigAnalyzer
+      attr_reader :config_error
+
+      def initialize(config_file)
+        @config_file = config_file
+        @config = load_config
+      end
+
+      def app_name
+        @config.to_h[:name] if present?
+      end
+
+      def present?
+        File.exist?(@config_file)
+      end
+
+      def valid?
+        present? && @config.to_h.key?(:name) && @config.to_h.key?(:packages)
+      end
+
+      private
+
+      def load_config
+        AppMap::Config.load_from_file @config_file if present?
+      rescue
+        nil
+      end
+    end
+  end
+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/version.rb

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

data/spec/fixtures/config/incomplete_config.yml

@@ -0,0 +1 @@
+name: app

data/spec/fixtures/config/invalid_config.yml

@@ -0,0 +1,2 @@
+name: -123- %
+packages: ~{}~ ''

data/spec/fixtures/config/valid_config.yml

@@ -0,0 +1,3 @@
+name: appmap
+packages:
+  - path: app/models

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/spec/service/config_analyzer_spec.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'appmap/service/config_analyzer'
+
+describe AppMap::Service::ConfigAnalyzer do
+  subject { described_class.new(config_file) }
+
+  context 'with non-existing config' do
+    let(:config_file) { 'spec/fixtures/config/non_existing_config.yml'}
+
+    describe '.app_name' do
+      it 'returns nil' do
+        expect(subject.app_name).to be_nil
+      end
+    end
+
+    describe '.is_valid?' do
+      it 'returns false' do
+        expect(subject.valid?).to be_falsey
+      end
+    end
+
+    describe '.is_present?' do
+      it 'returns false' do
+        expect(subject.present?).to be_falsey
+      end
+    end
+  end
+
+  context 'with valid config' do
+    let(:config_file) { 'spec/fixtures/config/valid_config.yml'}
+
+    describe '.app_name' do
+      it 'returns app name value from config' do
+        expect(subject.app_name).to eq('appmap')
+      end
+    end
+
+    describe '.is_valid?' do
+      it 'returns true' do
+        expect(subject.valid?).to be_truthy
+      end
+    end
+
+    describe '.is_present?' do
+      it 'returns true' do
+        expect(subject.present?).to be_truthy
+      end
+    end
+  end
+
+  context 'with invalid YAML config' do
+    let(:config_file) { 'spec/fixtures/config/invalid_config.yml'}
+
+    describe '.app_name' do
+      it 'returns app name value from config' do
+        expect(subject.app_name).to be_nil
+      end
+    end
+
+    describe '.is_valid?' do
+      it 'returns false' do
+        expect(subject.valid?).to be_falsey
+      end
+    end
+
+    describe '.is_present?' do
+      it 'return true' do
+        expect(subject.present?).to be_truthy
+      end
+    end
+  end
+
+  context 'with incomplete config' do
+    let(:config_file) { 'spec/fixtures/config/incomplete_config.yml'}
+
+    describe '.app_name' do
+      it 'returns nil' do
+        expect(subject.app_name).to eq('app')
+      end
+    end
+
+    describe '.is_valid?' do
+      it 'guesses paths and returns true ' do
+        expect(subject.valid?).to be_truthy
+      end
+    end
+
+    describe '.is_present?' do
+      it 'returns true' do
+        expect(subject.present?).to be_truthy
+      end
+    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

@@ -0,0 +1,81 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class AgentSetupInitTest < Minitest::Test
+  def test_status_gem
+    output = `./exe/appmap-agent-status`
+    assert_equal 0, $CHILD_STATUS.exitstatus
+    expected = {
+      test_commands: [],
+      properties: {
+        config: {
+          app: 'AppMap Rubygem',
+          present: true,
+          valid: true
+        },
+        project: {
+          agentVersion: AppMap::VERSION,
+          language: 'ruby',
+          remoteRecordingCapable: false,
+          integrationTests: false
+        }
+      }
+    }
+    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.55.0
+  version: 0.59.0
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-28 00:00:00.000000000 Z
+date: 2021-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -295,6 +295,7 @@ email:
 - kgilpin@gmail.com
 executables:
 - appmap-agent-init
+- appmap-agent-status
 - appmap-inspect
 extensions:
 - ext/appmap/extconf.rb
@@ -324,6 +325,7 @@ files:
 - examples/mock_webapp/lib/mock_webapp/request.rb
 - examples/mock_webapp/lib/mock_webapp/user.rb
 - exe/appmap-agent-init
+- exe/appmap-agent-status
 - exe/appmap-inspect
 - ext/appmap/appmap.c
 - ext/appmap/extconf.rb
@@ -331,6 +333,7 @@ files:
 - lib/appmap/agent.rb
 - lib/appmap/class_map.rb
 - lib/appmap/command/agent_setup/init.rb
+- lib/appmap/command/agent_setup/status.rb
 - lib/appmap/command/inspect.rb
 - lib/appmap/command_error.rb
 - lib/appmap/config.rb
@@ -351,7 +354,11 @@ files:
 - lib/appmap/railtie.rb
 - lib/appmap/record.rb
 - 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
@@ -364,6 +371,9 @@ files:
 - release.sh
 - spec/class_map_spec.rb
 - spec/config_spec.rb
+- spec/fixtures/config/incomplete_config.yml
+- spec/fixtures/config/invalid_config.yml
+- spec/fixtures/config/valid_config.yml
 - spec/fixtures/hook/.gitignore
 - spec/fixtures/hook/app/controllers/api/api_keys_controller.rb
 - spec/fixtures/hook/app/controllers/organizations_controller.rb
@@ -536,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
@@ -545,10 +557,12 @@ files:
 - spec/record_net_http_spec.rb
 - spec/record_sql_rails_pg_spec.rb
 - spec/remote_recording_spec.rb
+- spec/service/config_analyzer_spec.rb
 - spec/spec_helper.rb
 - spec/swagger/swagger_spec.rb
 - spec/util_spec.rb
 - test/agent_setup_init_test.rb
+- test/agent_setup_status_test.rb
 - test/bundle_vendor_test.rb
 - test/cucumber_test.rb
 - test/expectations/openssl_test_key_sign1.json