codeclimate-fede 0.85.21

data/lib/cc/analyzer/issue_sorter.rb

@@ -0,0 +1,30 @@
+module CC
+  module Analyzer
+    class IssueSorter
+      def initialize(issues)
+        @issues = issues
+      end
+
+      def by_location
+        @issues.sort_by { |i| line_or_offset(i) }
+      end
+
+      private
+
+      def line_or_offset(issue)
+        location = issue["location"]
+
+        case
+        when location["lines"]
+          [location["lines"]["begin"].to_i]
+        when location["positions"] && location["positions"]["begin"]["line"]
+          [location["positions"]["begin"]["line"].to_i, location["positions"]["begin"]["column"].to_i]
+        when location["positions"] && location["positions"]["begin"]["offset"]
+          [1_000_000_000] # push offsets to end of list
+        else
+          [0] # whole-file issues are first
+        end
+      end
+    end
+  end
+end

data/lib/cc/analyzer/issue_validations/category_validation.rb

@@ -0,0 +1,32 @@
+module CC
+  module Analyzer
+    module IssueValidations
+      class CategoryValidation < Validation
+        CATEGORIES = [
+          "Bug Risk".freeze,
+          "Clarity".freeze,
+          "Compatibility".freeze,
+          "Complexity".freeze,
+          "Duplication".freeze,
+          "Performance".freeze,
+          "Security".freeze,
+          "Style".freeze,
+        ].freeze
+
+        def valid?
+          object["categories"].present? && no_invalid_categories?
+        end
+
+        def message
+          "Category must be at least one of #{CATEGORIES.join(", ")}"
+        end
+
+        private
+
+        def no_invalid_categories?
+          (CATEGORIES | object["categories"]) == CATEGORIES
+        end
+      end
+    end
+  end
+end

data/lib/cc/analyzer/issue_validations/check_name_presence_validation.rb

@@ -0,0 +1,15 @@
+module CC
+  module Analyzer
+    module IssueValidations
+      class CheckNamePresenceValidation < Validation
+        def valid?
+          object["check_name"].present?
+        end
+
+        def message
+          "Check name must be present"
+        end
+      end
+    end
+  end
+end

data/lib/cc/analyzer/issue_validations/content_validation.rb

@@ -0,0 +1,21 @@
+module CC
+  module Analyzer
+    module IssueValidations
+      class ContentValidation < Validation
+        def valid?
+          !has_content? || (content.is_a?(Hash) && content["body"].is_a?(String))
+        end
+
+        def message
+          "Content must be a hash containing a 'body' key with string contents"
+        end
+
+        private
+
+        def has_content?
+          object.key?("content")
+        end
+      end
+    end
+  end
+end

data/lib/cc/analyzer/issue_validations/description_presence_validation.rb

@@ -0,0 +1,15 @@
+module CC
+  module Analyzer
+    module IssueValidations
+      class DescriptionPresenceValidation < Validation
+        def valid?
+          object["description"].present?
+        end
+
+        def message
+          "Description must be present"
+        end
+      end
+    end
+  end
+end

data/lib/cc/analyzer/issue_validations/location_format_validation.rb

@@ -0,0 +1,72 @@
+module CC
+  module Analyzer
+    module IssueValidations
+      class LocationFormatValidation < Validation
+        class Validator
+          def initialize(location)
+            @location = location
+            check_validity
+          end
+
+          def valid?
+            error.nil?
+          end
+
+          def message
+            if error
+              "Location is not formatted correctly: #{error}"
+            end
+          end
+
+          private
+
+          attr_accessor :error
+
+          attr_reader :location
+
+          def check_validity
+            if location["lines"]
+              self.error = "location.lines is not valid: #{JSON.dump(location["lines"])}" unless valid_lines?(location["lines"])
+            elsif location["positions"]
+              self.error = "location.positions is not valid: #{JSON.dump(location["positions"])}" unless valid_positions?(location["positions"])
+            else
+              self.error = "location.lines or location.positions must be present"
+            end
+          end
+
+          def valid_positions?(positions)
+            positions.is_a?(Hash) &&
+              valid_position?(positions["begin"]) &&
+              valid_position?(positions["end"])
+          end
+
+          def valid_position?(position)
+            position &&
+              (
+                [position["line"], position["column"]].all? { |value| value.is_a?(Integer) } ||
+                position["offset"].is_a?(Integer)
+              )
+          end
+
+          def valid_lines?(lines)
+            lines.is_a?(Hash) && [lines["begin"], lines["end"]].all? { |value| value.is_a?(Integer) }
+          end
+        end
+
+        def valid?
+          validation.valid?
+        end
+
+        def message
+          validation.message
+        end
+
+        private
+
+        def validation
+          @validation ||= Validator.new(object.fetch("location", {}))
+        end
+      end
+    end
+  end
+end

data/lib/cc/analyzer/issue_validations/other_locations_format_validation.rb

@@ -0,0 +1,41 @@
+module CC
+  module Analyzer
+    module IssueValidations
+      class OtherLocationsFormatValidation < Validation
+        CHECKS = [
+          LocationFormatValidation,
+          PathExistenceValidation,
+          PathPresenceValidation,
+          RelativePathValidation,
+        ].freeze
+
+        def initialize(object)
+          super
+          @other_location_valid = {}
+        end
+
+        def valid?
+          if object["other_locations"]
+            object["other_locations"].is_a?(Array) &&
+              object["other_locations"].all?(&method(:other_location_valid?))
+          else
+            true
+          end
+        end
+
+        def message
+          "Other locations are not formatted correctly"
+        end
+
+        private
+
+        def other_location_valid?(location)
+          path = location && location["path"]
+          @other_location_valid[path] ||= CHECKS.all? do |klass|
+            klass.new("location" => location).valid?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cc/analyzer/issue_validations/path_existence_validation.rb

@@ -0,0 +1,15 @@
+module CC
+  module Analyzer
+    module IssueValidations
+      class PathExistenceValidation < Validation
+        def valid?
+          path && File.exist?(path)
+        end
+
+        def message
+          "File does not exist: '#{path}'"
+        end
+      end
+    end
+  end
+end

data/lib/cc/analyzer/issue_validations/path_is_file_validation.rb

@@ -0,0 +1,15 @@
+module CC
+  module Analyzer
+    module IssueValidations
+      class PathIsFileValidation < Validation
+        def valid?
+          path && File.file?(path)
+        end
+
+        def message
+          "Path is not a file: '#{path}'"
+        end
+      end
+    end
+  end
+end

data/lib/cc/analyzer/issue_validations/path_presence_validation.rb

@@ -0,0 +1,15 @@
+module CC
+  module Analyzer
+    module IssueValidations
+      class PathPresenceValidation < Validation
+        def valid?
+          path.present?
+        end
+
+        def message
+          "Path must be present"
+        end
+      end
+    end
+  end
+end

data/lib/cc/analyzer/issue_validations/relative_path_validation.rb

@@ -0,0 +1,32 @@
+require "pathname"
+
+module CC
+  module Analyzer
+    module IssueValidations
+      class RelativePathValidation < Validation
+        BUILDER_CODE_PATH = "/tmp/workspace/code".freeze
+
+        def valid?
+          path &&
+            !path.start_with?("/") && (
+              relative_to?(MountedPath.code.container_path) ||
+              relative_to?(BUILDER_CODE_PATH)
+            )
+        end
+
+        def message
+          "Path must be relative to the project directory"
+        end
+
+        private
+
+        def relative_to?(directory)
+          expanded_base = Pathname.new(directory).expand_path.to_s
+          expanded_path = Pathname.new(path).expand_path.to_s
+
+          expanded_path.start_with?(expanded_base)
+        end
+      end
+    end
+  end
+end

data/lib/cc/analyzer/issue_validations/remediation_points_validation.rb

@@ -0,0 +1,25 @@
+module CC
+  module Analyzer
+    module IssueValidations
+      class RemediationPointsValidation < Validation
+        def valid?
+          remediation_points.nil? || positive_integer?(remediation_points)
+        end
+
+        def message
+          "Remediation points must be a non-negative integer"
+        end
+
+        private
+
+        def remediation_points
+          @remediation_points ||= object["remediation_points"]
+        end
+
+        def positive_integer?(x)
+          x.is_a?(Integer) && x >= 0
+        end
+      end
+    end
+  end
+end

data/lib/cc/analyzer/issue_validations/severity_validation.rb

@@ -0,0 +1,39 @@
+module CC
+  module Analyzer
+    module IssueValidations
+      class SeverityValidation < Validation
+        INFO = "info".freeze
+        MINOR = "minor".freeze
+        MAJOR = "major".freeze
+        CRITICAL = "critical".freeze
+        BLOCKER = "blocker".freeze
+
+        DEPRECATED_SEVERITIES = [
+          NORMAL = "normal".freeze,
+        ].freeze
+
+        VALID_SEVERITIES = ([
+          INFO,
+          MINOR,
+          MAJOR,
+          CRITICAL,
+          BLOCKER,
+        ] + DEPRECATED_SEVERITIES).freeze
+
+        def valid?
+          severity.nil? || VALID_SEVERITIES.include?(severity)
+        end
+
+        def message
+          "Permitted severities include #{VALID_SEVERITIES.join(", ")}"
+        end
+
+        private
+
+        def severity
+          @severity ||= object["severity"]
+        end
+      end
+    end
+  end
+end

data/lib/cc/analyzer/issue_validations/type_validation.rb

@@ -0,0 +1,15 @@
+module CC
+  module Analyzer
+    module IssueValidations
+      class TypeValidation < Validation
+        def valid?
+          type&.casecmp("issue")&.zero?
+        end
+
+        def message
+          "Type must be 'issue' but was '#{type}'"
+        end
+      end
+    end
+  end
+end

data/lib/cc/analyzer/issue_validations/validation.rb

@@ -0,0 +1,35 @@
+module CC
+  module Analyzer
+    module IssueValidations
+      class Validation
+        def initialize(object)
+          @object = object
+        end
+
+        def valid?
+          raise NotImplementedError
+        end
+
+        def message
+          raise NotImplementedError
+        end
+
+        private
+
+        attr_reader :object
+
+        def path
+          object.fetch("location", {})["path"]
+        end
+
+        def type
+          object["type"]
+        end
+
+        def content
+          object["content"]
+        end
+      end
+    end
+  end
+end

data/lib/cc/analyzer/issue_validations.rb

@@ -0,0 +1,26 @@
+module CC
+  module Analyzer
+    module IssueValidations
+      autoload :CategoryValidation, "cc/analyzer/issue_validations/category_validation"
+      autoload :CheckNamePresenceValidation, "cc/analyzer/issue_validations/check_name_presence_validation"
+      autoload :ContentValidation, "cc/analyzer/issue_validations/content_validation"
+      autoload :DescriptionPresenceValidation, "cc/analyzer/issue_validations/description_presence_validation"
+      autoload :LocationFormatValidation, "cc/analyzer/issue_validations/location_format_validation"
+      autoload :OtherLocationsFormatValidation, "cc/analyzer/issue_validations/other_locations_format_validation"
+      autoload :PathExistenceValidation, "cc/analyzer/issue_validations/path_existence_validation"
+      autoload :PathIsFileValidation, "cc/analyzer/issue_validations/path_is_file_validation"
+      autoload :PathPresenceValidation, "cc/analyzer/issue_validations/path_presence_validation"
+      autoload :RelativePathValidation, "cc/analyzer/issue_validations/relative_path_validation"
+      autoload :RemediationPointsValidation, "cc/analyzer/issue_validations/remediation_points_validation"
+      autoload :SeverityValidation, "cc/analyzer/issue_validations/severity_validation"
+      autoload :TypeValidation, "cc/analyzer/issue_validations/type_validation"
+      autoload :Validation, "cc/analyzer/issue_validations/validation"
+
+      def self.validations
+        constants.sort.map(&method(:const_get)).select do |klass|
+          klass.is_a?(Class) && klass.superclass == Validation
+        end
+      end
+    end
+  end
+end

data/lib/cc/analyzer/issue_validator.rb

@@ -0,0 +1,11 @@
+module CC
+  module Analyzer
+    class IssueValidator
+      include Validator
+
+      def self.validations
+        IssueValidations.validations
+      end
+    end
+  end
+end

data/lib/cc/analyzer/location_description.rb

@@ -0,0 +1,45 @@
+module CC
+  module Analyzer
+    class LocationDescription
+      def initialize(source_buffer, location, suffix = "")
+        @source_buffer = source_buffer
+        @location = location
+        @suffix = suffix
+      end
+
+      def to_s
+        if location["lines"]
+          begin_line = location["lines"]["begin"]
+          end_line = location["lines"]["end"]
+        elsif location["positions"]
+          begin_line = position_to_line(location["positions"]["begin"])
+          end_line = position_to_line(location["positions"]["end"])
+        end
+
+        str = render_lines(begin_line, end_line)
+        str << suffix unless str.blank?
+        str
+      end
+
+      private
+
+      attr_reader :location, :suffix
+
+      def render_lines(begin_line, end_line)
+        if end_line == begin_line
+          begin_line.to_s
+        else
+          "#{begin_line}-#{end_line}"
+        end
+      end
+
+      def position_to_line(position)
+        if position["line"]
+          position["line"]
+        else
+          @source_buffer.decompose_position(position["offset"]).first
+        end
+      end
+    end
+  end
+end

data/lib/cc/analyzer/logging_container_listener.rb

@@ -0,0 +1,24 @@
+module CC
+  module Analyzer
+    class LoggingContainerListener < ContainerListener
+      def initialize(logger)
+        @logger = logger
+      end
+
+      def started(engine, _details)
+        logger.info("starting engine #{engine.name}")
+      end
+
+      def finished(engine, _details, result)
+        logger.info("finished engine #{engine.name}")
+        if result.skipped?
+          logger.warn("skipped engine #{engine.name}: #{result.stderr}")
+        end
+      end
+
+      private
+
+      attr_reader :logger
+    end
+  end
+end

data/lib/cc/analyzer/measurement.rb

@@ -0,0 +1,22 @@
+module CC
+  module Analyzer
+    class Measurement
+      def initialize(engine_name, output)
+        @engine_name = engine_name
+        @output = output
+      end
+
+      def as_json(*)
+        parsed_output.merge("engine_name" => engine_name)
+      end
+
+      private
+
+      attr_reader :engine_name, :output
+
+      def parsed_output
+        @parsed_output ||= JSON.parse(output)
+      end
+    end
+  end
+end

data/lib/cc/analyzer/measurement_validations/name_validation.rb

@@ -0,0 +1,23 @@
+module CC
+  module Analyzer
+    module MeasurementValidations
+      class NameValidation < Validation
+        REGEX = /^[A-Za-z0-9_\.\-]+$/
+
+        def valid?
+          name&.is_a?(String) && REGEX.match?(name)
+        end
+
+        def message
+          "Name must be present and contain only letters, numbers, periods, hyphens, and underscores"
+        end
+
+        private
+
+        def name
+          object["name"]
+        end
+      end
+    end
+  end
+end

data/lib/cc/analyzer/measurement_validations/type_validation.rb

@@ -0,0 +1,15 @@
+module CC
+  module Analyzer
+    module MeasurementValidations
+      class TypeValidation < Validation
+        def valid?
+          type&.casecmp("measurement")&.zero?
+        end
+
+        def message
+          "Type must be 'measurement' but was '#{type}'"
+        end
+      end
+    end
+  end
+end

data/lib/cc/analyzer/measurement_validations/validation.rb

@@ -0,0 +1,27 @@
+module CC
+  module Analyzer
+    module MeasurementValidations
+      class Validation
+        def initialize(object)
+          @object = object
+        end
+
+        def valid?
+          raise NotImplementedError
+        end
+
+        def message
+          raise NotImplementedError
+        end
+
+        private
+
+        attr_reader :object
+
+        def type
+          object["type"]
+        end
+      end
+    end
+  end
+end

data/lib/cc/analyzer/measurement_validations/value_validation.rb

@@ -0,0 +1,21 @@
+module CC
+  module Analyzer
+    module MeasurementValidations
+      class ValueValidation < Validation
+        def valid?
+          value&.is_a?(Numeric)
+        end
+
+        def message
+          "Value must be present and numeric"
+        end
+
+        private
+
+        def value
+          object["value"]
+        end
+      end
+    end
+  end
+end

data/lib/cc/analyzer/measurement_validations.rb

@@ -0,0 +1,16 @@
+module CC
+  module Analyzer
+    module MeasurementValidations
+      autoload :NameValidation, "cc/analyzer/measurement_validations/name_validation"
+      autoload :TypeValidation, "cc/analyzer/measurement_validations/type_validation"
+      autoload :ValueValidation, "cc/analyzer/measurement_validations/value_validation"
+      autoload :Validation, "cc/analyzer/measurement_validations/validation"
+
+      def self.validations
+        constants.sort.map(&method(:const_get)).select do |klass|
+          klass.is_a?(Class) && klass.superclass == Validation
+        end
+      end
+    end
+  end
+end