appmap 0.59.2 → 0.60.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93b0a392f69c9de659a086819d29b2b4c94c4b704d04ac2d57f99cafe56f4f80
-  data.tar.gz: 4f42ab168f8bb4f1c8500f6f98682d7c048119125ba34aa0ddd80f9a521c7d02
+  metadata.gz: 832f968242440a6bac78181dbb49ca1b34d75c37074810df66c3d1b1d546c0cf
+  data.tar.gz: 26ffec9cffe15f63dc661563ec7bee9c8b4659a54c0a8888dd797b6253518954
 SHA512:
-  metadata.gz: 95538abb1fc5ba05793bba2efc1731a823c324515956aa7b388b04d8b43953f3885d45ca1937d684c0b6e2415fc7fb6d1f591da02ffa0dbc06883c7298d3eb0b
-  data.tar.gz: 48d7105b1ced68d2ddd9229b2811b0d157ca60b879b8d781e014cf02ca512147c33a95b4a52e49216e5fbf47b3fc7fafa19fa25d00a57506872ab1a3ef71651f
+  metadata.gz: '09eb7e68782f397a59a960ba617af180ee2d0746316db9b7d2c4cd011755e815205a5b484d0a90cd19224ab7f4be7231a96c664ea87e962c02372e155088cc82'
+  data.tar.gz: eea1765efb3ab76716d7c8c74f9f7b9d860923d815dab0bd003ecf8f07dc62ac6d3660e43ba0576b615bd6de094156e14e8a5be876dfe3851d4dc2c95cd82368

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# [0.60.0](https://github.com/applandinc/appmap-ruby/compare/v0.59.2...v0.60.0) (2021-07-08)
+
+
+### Features
+
+* add agent-setup-validate command ([d9b3bc1](https://github.com/applandinc/appmap-ruby/commit/d9b3bc15e01bf89994aa67b0256dd69b9983be76))
+* validate ruby version (+ better config loading validation) ([1756e6c](https://github.com/applandinc/appmap-ruby/commit/1756e6c30b5c44a033c23eb47c27c56732d12470))
+
 ## [0.59.2](https://github.com/applandinc/appmap-ruby/compare/v0.59.1...v0.59.2) (2021-07-08)
 
 

data/exe/appmap-agent-validate

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'optparse'
+require 'appmap'
+require 'appmap/command/agent_setup/validate'
+
+@options = { config_file: AppMap::DEFAULT_CONFIG_FILE_PATH }
+
+OptionParser.new do |parser|
+  parser.banner = 'Usage: appmap-agent-validate [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::Validate.new(@options[:config_file]).perform

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'appmap/service/validator/config_validator'
+
+module AppMap
+  module Command
+    module AgentSetup
+      ValidateStruct = Struct.new(:config_file)
+
+      class Validate < ValidateStruct
+        def perform
+          puts JSON.pretty_generate(config_validator.valid? ? [] : config_validator.violations.map(&:to_h))
+        end
+
+        private
+
+        def config_validator
+          @validator ||= Service::Validator::ConfigValidator.new(config_file)
+        end
+      end
+    end
+  end
+end

data/lib/appmap/service/config_analyzer.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'appmap/service/validator/config_validator'
+
 module AppMap
   module Service
     class ConfigAnalyzer
@@ -7,11 +9,10 @@ module AppMap
 
       def initialize(config_file)
         @config_file = config_file
-        @config = load_config
       end
 
       def app_name
-        @config.to_h[:name] if present?
+        config_validator.config.to_h['name'] if present?
       end
 
       def present?
@@ -19,16 +20,14 @@ module AppMap
       end
 
       def valid?
-        present? && @config.to_h.key?(:name) && @config.to_h.key?(:packages)
+        config_validator.valid?
       end
 
       private
 
-      def load_config
-        AppMap::Config.load_from_file @config_file if present?
-      rescue
-        nil
+      def config_validator
+        @validator ||= AppMap::Service::Validator::ConfigValidator.new(@config_file)
       end
     end
   end
-end
+end

data/lib/appmap/service/validator/config_validator.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'appmap/service/validator/violation'
+
+module AppMap
+  module Service
+    module Validator
+      class ConfigValidator
+        attr_reader :violations
+
+        def initialize(config_file)
+          @config_file = config_file
+          @violations = []
+        end
+
+        def config
+          parse_config
+        end
+
+        def valid?
+          validate_ruby_version
+          validate_config_presence
+          parse_config
+          validate_config_load
+          @violations.empty?
+        end
+
+        private
+
+        def present?
+          File.exist?(@config_file)
+        end
+
+        def parse_config
+          return unless present?
+
+          @config_data ||= YAML.load_file(@config_file)
+        rescue Psych::SyntaxError => e
+          @violations << Violation.error(
+            filename: @config_file,
+            message: 'AppMap configuration is not valid YAML',
+            detailed_message: e.message
+          )
+          nil
+        end
+
+        def validate_config_load
+          return unless @config_data
+
+          AppMap::Config.load(@config_data)
+        rescue StandardError => e
+          @violations << Violation.error(
+            filename: @config_file,
+            message: 'AppMap configuration could not be loaded',
+            detailed_message: e.message
+          )
+          nil
+        end
+
+        def validate_config_presence
+          unless present?
+            @violations << Violation.error(
+              filename: @config_file,
+              message: 'AppMap configuration file does not exist'
+            )
+          end
+        end
+
+        def validate_ruby_version
+          unless RUBY_VERSION =~ AppMap::SUPPORTED_RUBY_VERSIONS_REGEX
+            @violations << Violation.error(
+              message: "AppMap does not support Ruby #{RUBY_VERSION}. " \
+                "Supported versions are: #{AppMap::SUPPORTED_RUBY_VERSIONS.join(', ')}."
+              )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/appmap/service/validator/violation.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module AppMap
+  module Service
+    module Validator
+      class Violation
+        attr_reader :level, :setting, :filename, :message, :detailed_message, :help_urls
+
+        class << self
+          def error(message:, setting: nil, filename: nil, detailed_message: nil, help_urls: nil)
+            self.new(
+              level: :error,
+              message: message,
+              setting: setting,
+              filename: filename,
+              detailed_message: detailed_message,
+              help_urls: help_urls
+            )
+          end
+
+          def warning(message:, setting: nil, filename: nil, detailed_message: nil, help_urls: nil)
+            self.new(
+              level: :warning,
+              message: message,
+              setting: setting,
+              filename: filename,
+              detailed_message: detailed_message,
+              help_urls: help_urls
+            )
+          end
+        end
+
+        def initialize(level:, message:, setting:, filename:, detailed_message:, help_urls:)
+          @level = level
+          @setting = setting
+          @filename = filename
+          @message = message
+          @detailed_message = detailed_message
+          @help_urls = help_urls
+        end
+
+        def to_h
+          instance_variables.each_with_object({}) do |var, hash|
+            hash[var.to_s.delete("@")] = self.instance_variable_get(var)
+          end.compact
+        end
+      end
+    end
+  end
+end

data/lib/appmap/version.rb

@@ -3,10 +3,13 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.59.2'
+  VERSION = '0.60.0'
 
   APPMAP_FORMAT_VERSION = '1.5.1'
 
+  SUPPORTED_RUBY_VERSIONS_REGEX = /^2\.[567]\./.freeze
+  SUPPORTED_RUBY_VERSIONS = %w[2.5 2.6 2.7].freeze
+
   DEFAULT_APPMAP_DIR = 'tmp/appmap'.freeze
   DEFAULT_CONFIG_FILE_PATH = 'appmap.yml'.freeze
 end

data/spec/fixtures/config/invalid_config.yml

@@ -1,2 +1,2 @@
-name: -123- %
-packages: ~{}~ ''
+name: name
+packages: [1,2,3]

data/spec/fixtures/config/invalid_yaml_config.yml

@@ -0,0 +1,3 @@
+name:
+-
+packages: "[]" asd

data/spec/service/config_analyzer_spec.rb

@@ -51,7 +51,7 @@ describe AppMap::Service::ConfigAnalyzer do
   end
 
   context 'with invalid YAML config' do
-    let(:config_file) { 'spec/fixtures/config/invalid_config.yml'}
+    let(:config_file) { 'spec/fixtures/config/invalid_yaml_config.yml'}
 
     describe '.app_name' do
       it 'returns app name value from config' do

data/spec/service/validator/violation_spec.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'appmap/service/validator/violation'
+
+describe AppMap::Service::Validator::Violation do
+  describe '.error' do
+    let(:message) { 'error' }
+
+    context 'with default parameters' do
+      subject { described_class.error(message: :message) }
+
+      it 'builds an error' do
+        expect(subject.level).to be :error
+        expect(subject.message).to be :message
+      end
+    end
+
+    context 'with default parameters' do
+      subject do
+        described_class.error(
+          message: :message,
+          setting: :setting,
+          filename: :filename,
+          detailed_message: :detailed_message,
+          help_urls: :help_urls
+        )
+      end
+
+      let(:filename) { 'filename' }
+      let(:setting) { 'setting' }
+      let(:detailed_message) { 'details' }
+      let(:help_urls) { %w[123 456] }
+
+      it 'builds an error' do
+        expect(subject.level).to be :error
+        expect(subject.message).to be :message
+        expect(subject.setting).to be :setting
+        expect(subject.detailed_message).to be :detailed_message
+        expect(subject.help_urls).to be :help_urls
+      end
+    end
+
+    describe '.warning' do
+      let(:message) { 'warning' }
+
+      context 'with default parameters' do
+        subject { described_class.warning(message: :message) }
+
+        it 'builds an error' do
+          expect(subject.level).to be :warning
+          expect(subject.message).to be :message
+        end
+      end
+    end
+
+    describe '#to_hash' do
+      subject { described_class.warning(message: :message) }
+
+      let(:message) { 'warning' }
+
+      it 'returns correct hash' do
+        expect(subject.to_h['level']).to be :warning
+        expect(subject.to_h['message']).to be :message
+      end
+    end
+  end
+end

data/test/agent_setup_status_test.rb

@@ -64,7 +64,7 @@ class AgentSetupInitTest < Minitest::Test
       ],
       properties: {
         config: {
-          app: nil,
+          app: 'rails6_users_app',
           present: true,
           valid: false
         },

data/test/agent_setup_validate_test.rb

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class AgentSetupValidateTest < Minitest::Test
+  NON_EXISTING_CONFIG_FILENAME = '123.yml'
+  INVALID_YAML_CONFIG_FILENAME = 'spec/fixtures/config/invalid_yaml_config.yml'
+  INVALID_CONFIG_FILENAME = 'spec/fixtures/config/invalid_config.yml'
+
+  def test_init_when_config_exists
+    output = `./exe/appmap-agent-validate`
+    assert_equal 0, $CHILD_STATUS.exitstatus
+    assert_equal JSON.pretty_generate([]), output.strip
+  end
+
+  def test_init_with_non_existing_config_file
+    output = `./exe/appmap-agent-validate -c #{NON_EXISTING_CONFIG_FILENAME}`
+    assert_equal 0, $CHILD_STATUS.exitstatus
+    expected = JSON.pretty_generate([
+      {
+        level: :error,
+        filename: NON_EXISTING_CONFIG_FILENAME,
+        message: 'AppMap configuration file does not exist'
+      }
+    ])
+    assert_equal expected, output.strip
+  end
+
+  def test_init_with_invalid_YAML
+    output = `./exe/appmap-agent-validate -c #{INVALID_YAML_CONFIG_FILENAME}`
+    assert_equal 0, $CHILD_STATUS.exitstatus
+    expected = JSON.pretty_generate([
+      {
+        level: :error,
+        filename: INVALID_YAML_CONFIG_FILENAME,
+        message: 'AppMap configuration is not valid YAML',
+        detailed_message: "(#{INVALID_YAML_CONFIG_FILENAME}): " \
+          'did not find expected key while parsing a block mapping at line 1 column 1'
+      }
+    ])
+    assert_equal expected, output.strip
+  end
+
+  def test_init_with_invalid_data_config
+    output = `./exe/appmap-agent-validate -c #{INVALID_CONFIG_FILENAME}`
+    assert_equal 0, $CHILD_STATUS.exitstatus
+    expected = JSON.pretty_generate([
+      {
+        level: :error,
+        filename: INVALID_CONFIG_FILENAME,
+        message: 'AppMap configuration could not be loaded',
+        detailed_message: "no implicit conversion of String into Integer"
+      }
+    ])
+    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.59.2
+  version: 0.60.0
 platform: ruby
 authors:
 - Kevin Gilpin
@@ -296,6 +296,7 @@ email:
 executables:
 - appmap-agent-init
 - appmap-agent-status
+- appmap-agent-validate
 - appmap-inspect
 extensions:
 - ext/appmap/extconf.rb
@@ -327,6 +328,7 @@ files:
 - examples/mock_webapp/lib/mock_webapp/user.rb
 - exe/appmap-agent-init
 - exe/appmap-agent-status
+- exe/appmap-agent-validate
 - exe/appmap-inspect
 - ext/appmap/appmap.c
 - ext/appmap/extconf.rb
@@ -335,6 +337,7 @@ files:
 - lib/appmap/class_map.rb
 - lib/appmap/command/agent_setup/init.rb
 - lib/appmap/command/agent_setup/status.rb
+- lib/appmap/command/agent_setup/validate.rb
 - lib/appmap/command/inspect.rb
 - lib/appmap/command_error.rb
 - lib/appmap/config.rb
@@ -360,6 +363,8 @@ files:
 - lib/appmap/service/integration_test_path_finder.rb
 - lib/appmap/service/test_command_provider.rb
 - lib/appmap/service/test_framework_detector.rb
+- lib/appmap/service/validator/config_validator.rb
+- lib/appmap/service/validator/violation.rb
 - lib/appmap/swagger.rb
 - lib/appmap/swagger/configuration.rb
 - lib/appmap/swagger/markdown_descriptions.rb
@@ -374,6 +379,7 @@ files:
 - spec/config_spec.rb
 - spec/fixtures/config/incomplete_config.yml
 - spec/fixtures/config/invalid_config.yml
+- spec/fixtures/config/invalid_yaml_config.yml
 - spec/fixtures/config/valid_config.yml
 - spec/fixtures/hook/.gitignore
 - spec/fixtures/hook/app/controllers/api/api_keys_controller.rb
@@ -559,11 +565,13 @@ files:
 - spec/record_sql_rails_pg_spec.rb
 - spec/remote_recording_spec.rb
 - spec/service/config_analyzer_spec.rb
+- spec/service/validator/violation_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/agent_setup_validate_test.rb
 - test/bundle_vendor_test.rb
 - test/cucumber_test.rb
 - test/expectations/openssl_test_key_sign1.json