appmap 0.55.0 → 0.56.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfd518bd44a86f1270fe90e70c397e213763dd582260ace7c5a01898b94030d2
-  data.tar.gz: cf449bff5700a1bfd5efabda40ccd59c5281d595aa34ca551d6a3b4b1f89f5f8
+  metadata.gz: 1cfb7d49bd076c0599f8b4866cee8475109553812d13be58a873a288391f9f25
+  data.tar.gz: 2cc00cb780ac948e058ca4742ce3bc52d79b8c08f55bcf964363a9f1fcfc2763
 SHA512:
-  metadata.gz: 1824e49817ccceca6571fb2cb6f4a3033fb4873bb184577ec3989af3d74d09aecbf7685f9ce9f7efeb2a43e811f9477b0cfc5c6f6778ba3ec8d141c37560112c
-  data.tar.gz: da796d7072dab9b505f6fe1220ae3987e0577be458dfb1253b3d4b860df41d7a4856640629dd300ebcb6588f350f4f55af2b867bf730d0a65e90788c0f2eeb0d
+  metadata.gz: acf4df227c1cadc89495c36528eb386f1a09323010dba9869a8a1e7d4b584bf2097a7148a57fe0ca0979560a30cb5f083cf132f799f309a1ef89461025151558
+  data.tar.gz: 628153961f02ad5cb6b34e3ac21432afdce20a61234f3dfa9b57835e33ef5189d9a10c12ba4d361126e820ecd6dd3b89b8b64f2f72a5e1f6d38ee3ea4e5888a9

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [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/status.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'appmap/service/config_analyzer'
+
+module AppMap
+  module Command
+    module AgentSetup
+      StatusStruct = Struct.new(:config_file)
+
+      class Status < StatusStruct
+        def perform
+          status = {
+            :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
+              }
+            }
+          }
+
+          puts status.to_json
+        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/version.rb

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

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class AgentSetupInitTest < Minitest::Test
+  def test_status
+    output = `./exe/appmap-agent-status`
+    assert_equal 0, $CHILD_STATUS.exitstatus
+    expected = {
+      :properties => {
+        :config => {
+          :app => 'AppMap Rubygem',
+          :present => true,
+          :valid => true
+        },
+        :project => {
+          :agentVersionProject => AppMap::VERSION,
+          :language => 'ruby',
+          :remoteRecordingCapable => false,
+          :integrationTests => false
+        }
+      }
+    }.to_json
+    assert_equal expected, output.strip
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.55.0
+  version: 0.56.0
 platform: ruby
 authors:
 - Kevin Gilpin
@@ -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,6 +354,7 @@ 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/swagger.rb
 - lib/appmap/swagger/configuration.rb
@@ -364,6 +368,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
@@ -545,10 +552,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