feat: validate ruby version (+ better config loading validation)

Author: torchello

lib/appmap/service/validator/config_validator.rb

@@ -15,8 +15,9 @@ def initialize(config_file)
         end
 
         def valid?
+          validate_ruby_version
           validate_config_presence
-          @violations.length == 0
+          @violations.empty?
         end
 
         private
@@ -26,14 +27,22 @@ def present?
         end
 
         def load_config
+          YAML.parse_file(@config_file) if present?
           AppMap::Config.load_from_file(@config_file) if present?
-        rescue StandardError => e
+        rescue Psych::SyntaxError => e
           @violations << Violation.error(
             filename: @config_file,
             message: 'AppMap configuration is not valid YAML',
             detailed_message: e.message
           )
           nil
+        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
@@ -44,6 +53,15 @@ def validate_config_presence
             )
           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

lib/appmap/version.rb

@@ -7,6 +7,9 @@ module AppMap
 
   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

spec/fixtures/config/invalid_config.yml

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

spec/fixtures/config/invalid_yaml_config.yml

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

spec/service/config_analyzer_spec.rb

@@ -51,7 +51,7 @@
   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

test/agent_setup_validate_test.rb

@@ -5,6 +5,7 @@
 
 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
@@ -26,15 +27,30 @@ def test_init_with_non_existing_config_file
     assert_equal expected, output.strip
   end
 
-  def test_init_with_custom_invalid_YAML
+  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 is not valid YAML',
-        detailed_message: "(<unknown>): did not find expected key while parsing a block mapping at line 1 column 1"
+        message: 'AppMap configuration could not be loaded.',
+        detailed_message: "undefined method `map' for \"not_array\":String\nDid you mean?  tap"
       }
     ])
     assert_equal expected, output.strip