codeclimate-fede 0.85.21

data/lib/cc/cli/engines/list.rb

@@ -0,0 +1,18 @@
+module CC
+  module CLI
+    module Engines
+      class List < EngineCommand
+        SHORT_HELP = "List all available engines".freeze
+
+        def run
+          say "Available engines:"
+          engine_registry.
+            sort_by { |engine, _| engine.name }.
+            each do |engine, metadata|
+              say "- #{engine.name}: #{metadata.description}"
+            end
+        end
+      end
+    end
+  end
+end

data/lib/cc/cli/engines.rb

@@ -0,0 +1,5 @@
+require "cc/analyzer"
+
+require "cc/cli/engines/engine_command"
+require "cc/cli/engines/install"
+require "cc/cli/engines/list"

data/lib/cc/cli/file_store.rb

@@ -0,0 +1,42 @@
+require "fileutils"
+require "yaml"
+
+module CC
+  module CLI
+    class FileStore
+      # This class is not supposed to be directly used. It should be sublcassed
+      # and a few constants need to be defined on the sublass to be usable.
+      #
+      # FILE_NAME is the name of the file this class wraps.
+
+      def initialize
+        load_data
+      end
+
+      def save
+        return false unless File.exist? self.class::FILE_NAME
+
+        File.open(self.class::FILE_NAME, "w") do |f|
+          YAML.dump data, f
+        end
+
+        true
+      end
+
+      private
+
+      attr_reader :data
+
+      def load_data
+        @data =
+          if File.exist? self.class::FILE_NAME
+            File.open(self.class::FILE_NAME, "r:bom|utf-8") do |f|
+              YAML.safe_load(f, [Time], [], false, self.class::FILE_NAME) || {}
+            end
+          else
+            {}
+          end
+      end
+    end
+  end
+end

data/lib/cc/cli/global_cache.rb

@@ -0,0 +1,47 @@
+require "cc/cli/file_store"
+
+module CC
+  module CLI
+    class GlobalCache < FileStore
+      FILE_NAME = "/cache.yml".freeze
+
+      # Cache entries
+
+      def last_version_check
+        data["last-version-check"] || Time.at(0)
+      end
+
+      def last_version_check=(value)
+        data["last-version-check"] =
+          if value.is_a? Time
+            value
+          else
+            Time.at(0)
+          end
+        save
+        value
+      end
+
+      def latest_version
+        data["latest-version"]
+      end
+
+      def latest_version=(value)
+        data["latest-version"] = value
+        save
+        value
+      end
+
+      def outdated
+        data["outdated"] == true
+      end
+      alias outdated? outdated
+
+      def outdated=(value)
+        data["outdated"] = value == true
+        save
+        value
+      end
+    end
+  end
+end

data/lib/cc/cli/global_config.rb

@@ -0,0 +1,35 @@
+require "cc/cli/file_store"
+require "uuid"
+
+module CC
+  module CLI
+    class GlobalConfig < FileStore
+      FILE_NAME = "/config.yml".freeze
+
+      DEFAULT_CONFIG = {
+        "check-version" => true,
+      }.freeze
+
+      # Config entries
+
+      def check_version
+        data["check-version"]
+      end
+      alias check_version? check_version
+
+      def check_version=(value)
+        data["check-version"] = value == true
+      end
+
+      def uuid
+        data["uuid"] ||= UUID.new.generate
+      end
+
+      private
+
+      def load_data
+        @data = DEFAULT_CONFIG.merge(super)
+      end
+    end
+  end
+end

data/lib/cc/cli/help.rb

@@ -0,0 +1,51 @@
+require "rainbow"
+
+module CC
+  module CLI
+    class Help < Command
+      ARGUMENT_LIST = "[command]".freeze
+      SHORT_HELP = "Display help information.".freeze
+      HELP = "#{SHORT_HELP}\n" \
+        "\n" \
+        "    no arguments   Show help summary for all commands.\n" \
+        "    [command]      Show help for specific commands. Can be specified multiple times.".freeze
+
+      def run
+        if @args.any?
+          @args.each do |command|
+            show_help(command)
+          end
+        else
+          show_help_summary
+        end
+      end
+
+      private
+
+      def show_help(command_name)
+        if (command = Command[command_name])
+          say "Usage: codeclimate #{command.synopsis}\n"
+          say "\n"
+          say "#{command.help}\n"
+          say "\n\n"
+        else
+          say "Unknown command: #{command_name}"
+        end
+      end
+
+      def show_help_summary
+        short_helps =
+          Command.all.sort_by(&:command_name).map do |command|
+            [command.synopsis, command.short_help]
+          end.compact.to_h
+
+        longest_command_length = short_helps.keys.map(&:length).max
+
+        say "Usage: codeclimate COMMAND ...\n\nAvailable commands:\n"
+        short_helps.each do |command, help|
+          say format("    %-#{longest_command_length}s    %s\n", command, help)
+        end
+      end
+    end
+  end
+end

data/lib/cc/cli/output.rb

@@ -0,0 +1,34 @@
+module CC
+  module CLI
+    module Output
+      def success(message)
+        terminal.say colorize(message, :green)
+      end
+
+      def say(message)
+        terminal.say message
+      end
+
+      def warn(message)
+        terminal.say colorize("WARNING: #{message}", :yellow)
+      end
+
+      def fatal(message)
+        $stderr.puts colorize(message, :red)
+        exit 1
+      end
+
+      def colorize(string, *args)
+        rainbow.wrap(string).color(*args)
+      end
+
+      def rainbow
+        @rainbow ||= Rainbow.new
+      end
+
+      def terminal
+        @terminal ||= HighLine.new($stdin, $stdout)
+      end
+    end
+  end
+end

data/lib/cc/cli/prepare.rb

@@ -0,0 +1,98 @@
+require "fileutils"
+require "ipaddr"
+require "json"
+require "net/http"
+require "pathname"
+require "uri"
+
+require "cc/resolv"
+
+module CC
+  module CLI
+    class Prepare < Command
+      ARGUMENT_LIST = "[--allow-internal-ips]".freeze
+      SHORT_HELP = "Run the commands in your prepare step.".freeze
+      HELP = "#{SHORT_HELP}\n" \
+        "\n" \
+        "    --allow-internal-ips    Allow fetching from internal IPs.".freeze
+
+      InternalHostError = Class.new(StandardError)
+      FetchError = Class.new(StandardError)
+
+      PRIVATE_ADDRESS_SUBNETS = [
+        IPAddr.new("10.0.0.0/8"),
+        IPAddr.new("172.16.0.0/12"),
+        IPAddr.new("192.168.0.0/16"),
+        IPAddr.new("fd00::/8"),
+        IPAddr.new("127.0.0.1"),
+        IPAddr.new("0:0:0:0:0:0:0:1"),
+      ].freeze
+
+      def run
+        ::CC::Resolv.with_fixed_dns { fetch_all }
+      rescue FetchError, InternalHostError => ex
+        fatal(ex.message)
+      end
+
+      private
+
+      def allow_internal_ips?
+        @args.include?("--allow-internal-ips")
+      end
+
+      def fetches
+        @fetches ||= config.prepare.fetch
+      end
+
+      def config
+        @config ||= CC::Config.load
+      end
+
+      def fetch_all
+        fetches.each do |entry|
+          fetch(entry.url, entry.path)
+        end
+      end
+
+      def fetch(url, target_path)
+        ensure_external!(url) unless allow_internal_ips?
+
+        uri = URI.parse(url)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = uri.scheme == "https"
+        resp = http.get(uri)
+        if resp.code == "200"
+          write_file(target_path, resp.body)
+          say("Wrote #{url} to #{target_path}")
+        else
+          raise FetchError, "Failed fetching #{url}: code=#{resp.code} body=#{resp.body}"
+        end
+      end
+
+      def write_file(target_path, content)
+        FileUtils.mkdir_p(Pathname.new(target_path).parent.to_s)
+        File.write(target_path, content)
+      end
+
+      def ensure_external!(url)
+        uri = URI.parse(url)
+
+        if internal?(uri.host)
+          raise InternalHostError, "Won't fetch #{url.inspect}: it maps to an internal address"
+        end
+      end
+
+      # rubocop:disable Style/CaseEquality
+      def internal?(host)
+        address = ::Resolv.getaddress(host)
+
+        PRIVATE_ADDRESS_SUBNETS.any? do |subnet|
+          subnet === IPAddr.new(address.to_s)
+        end
+      rescue ::Resolv::ResolvError
+        true # localhost
+      end
+      # rubocop:enable Style/CaseEquality
+    end
+  end
+end

data/lib/cc/cli/runner.rb

@@ -0,0 +1,75 @@
+require "active_support"
+require "active_support/core_ext"
+require "cc/cli/version_checker"
+
+module CC
+  module CLI
+    class Runner
+      def self.run(argv)
+        new(argv).run
+      rescue => ex
+        $stderr.puts("error: (#{ex.class}) #{ex.message}")
+        CLI.logger.debug("backtrace: #{ex.backtrace.join("\n\t")}")
+        exit 1
+      end
+
+      def initialize(args)
+        @args = args
+      end
+
+      def run
+        VersionChecker.new.check if check_version?
+
+        if command_class
+          command = command_class.new(command_arguments)
+          command.execute
+        else
+          command_not_found
+        end
+      end
+
+      def command_not_found
+        $stderr.puts "unknown command #{command}"
+        exit 1
+      end
+
+      def command_class
+        command_const = Command[command]
+        if command_const.abstract?
+          nil
+        else
+          command_const
+        end
+      rescue NameError
+        nil
+      end
+
+      def command_arguments
+        Array(@args[1..-1])
+      end
+
+      def command
+        command_name = @args.first
+        case command_name
+        when nil, "-h", "-?", "--help"
+          "help"
+        when "-v", "--version"
+          "version"
+        else
+          command_name
+        end
+      end
+
+      private
+
+      def check_version?
+        if ARGV.first == "--no-check-version"
+          ARGV.shift
+          false
+        else
+          true
+        end
+      end
+    end
+  end
+end

data/lib/cc/cli/validate_config.rb

@@ -0,0 +1,84 @@
+module CC
+  module CLI
+    class ValidateConfig < Command
+      NO_CONFIG_MESSAGE = "No checked in config: nothing to validate.".freeze
+      TOO_MANY_CONFIG_MESSAGE = "Don't commit both .codeclimate.yml & .codeclimate.json: only the JSON will be used.".freeze
+      SHORT_HELP = "Validate your .codeclimate.yml or .codeclimate.json.".freeze
+      VALID_CONFIG_MESSAGE = "No errors or warnings found in %s.".freeze
+
+      def run
+        require_json_or_yaml
+        process_args
+
+        if any_issues?
+          display_issues
+        else
+          puts format(VALID_CONFIG_MESSAGE, validator.path)
+        end
+
+        exit 1 unless validator.valid?
+      end
+
+      private
+
+      attr_reader :config, :registry_path, :registry_prefix, :validator
+
+      def process_args
+        @registry_path = EngineRegistry::DEFAULT_MANIFEST_PATH
+        @registry_prefix = ""
+
+        # Undocumented; we only need these from Builder so we can validate
+        # engines/channels against our own registry and prefix.
+        while (arg = @args.shift)
+          case arg
+          when "--registry" then @registry_path = @args.shift
+          when "--registry-prefix" then @registry_prefix = @args.shift
+          end
+        end
+      end
+
+      def any_issues?
+        validator.errors.any? ||
+          validator.warnings.any?
+      end
+
+      def display_issues
+        validator.errors.each do |error|
+          puts "#{colorize("ERROR", :red)}: #{error}"
+        end
+
+        validator.warnings.each do |warning|
+          puts "#{colorize("WARNING", :yellow)}: #{warning}"
+        end
+      end
+
+      def require_json_or_yaml
+        if !filesystem.exist?(Config::YAMLAdapter::DEFAULT_PATH) && !filesystem.exist?(Config::JSONAdapter::DEFAULT_PATH)
+          puts NO_CONFIG_MESSAGE
+          exit 0
+        elsif filesystem.exist?(Config::YAMLAdapter::DEFAULT_PATH) && filesystem.exist?(Config::JSONAdapter::DEFAULT_PATH)
+          puts "#{colorize("WARNING", :yellow)}: #{TOO_MANY_CONFIG_MESSAGE}"
+        end
+      end
+
+      def validator
+        @validator =
+          if filesystem.exist?(Config::JSONAdapter::DEFAULT_PATH)
+            Config::Validation::JSON.new(
+              Config::JSONAdapter::DEFAULT_PATH,
+              engine_registry,
+            )
+          elsif filesystem.exist?(Config::YAMLAdapter::DEFAULT_PATH)
+            Config::Validation::YAML.new(
+              Config::YAMLAdapter::DEFAULT_PATH,
+              engine_registry,
+            )
+          end
+      end
+
+      def engine_registry
+        EngineRegistry.new(registry_path, registry_prefix)
+      end
+    end
+  end
+end

data/lib/cc/cli/version.rb

@@ -0,0 +1,16 @@
+module CC
+  module CLI
+    class Version < Command
+      SHORT_HELP = "Display the CLI version.".freeze
+
+      def run
+        say version
+      end
+
+      def version
+        path = File.expand_path("../../../../VERSION", __FILE__)
+        @version ||= File.read(path)
+      end
+    end
+  end
+end

data/lib/cc/cli/version_checker.rb

@@ -0,0 +1,107 @@
+require "cc/cli/global_config"
+require "cc/cli/global_cache"
+
+module CC
+  module CLI
+    class VersionChecker
+      include CC::CLI::Output
+
+      VERSION_CHECK_TIMEOUT = 60 * 60 # 1 Hour in seconds
+      DEFAULT_VERSIONS_URL = "https://versions.codeclimate.com".freeze
+
+      def check
+        return unless global_config.check_version? && version_check_is_due?
+
+        print_new_version_message if outdated?
+
+        global_config.save
+      rescue => error
+        CLI.logger.debug(error)
+      end
+
+      private
+
+      def version_check_is_due?
+        Time.now > global_cache.last_version_check + VERSION_CHECK_TIMEOUT
+      end
+
+      def outdated?
+        api_response["outdated"]
+      end
+
+      def latest_version
+        api_response["latest"]
+      end
+
+      def print_new_version_message
+        warn "A new version (v#{latest_version}) is available. Upgrade instructions are available at: https://github.com/codeclimate/codeclimate#packages"
+      end
+
+      def api_response
+        @api_response ||=
+          begin
+            cache! JSON.parse(api_response_body)
+          rescue JSON::ParserError => error
+            CLI.logger.debug(error)
+            {
+              "outdated" => false,
+            }
+          end
+      end
+
+      def api_response_body
+        if http_response.is_a? Net::HTTPSuccess
+          http_response.body
+        else
+          raise Net::HTTPFatalError.new("HTTP Error", http_response)
+        end
+      rescue Net::HTTPFatalError => error
+        CLI.logger.debug(error)
+        ""
+      end
+
+      def http_response
+        @http_response ||=
+          begin
+            uri = URI.parse(ENV.fetch("CODECLIMATE_VERSIONS_URL", DEFAULT_VERSIONS_URL))
+            uri.query = { version: version, uid: global_config.uuid }.to_query
+
+            http = Net::HTTP.new(uri.host, uri.port)
+            http.open_timeout = 5
+            http.read_timeout = 5
+            http.ssl_timeout = 5
+            http.use_ssl = uri.scheme == "https"
+
+            http.get(uri, "User-Agent" => user_agent)
+          end
+      end
+
+      def cache!(data)
+        global_cache.latest_version = data["latest"]
+        global_cache.outdated = data["outdated"] == true
+        global_cache.last_version_check = Time.now
+        data
+      end
+
+      def version
+        @version ||= Version.new.version
+      end
+
+      def user_agent
+        "Code Climate CLI #{version}"
+      end
+
+      def global_config
+        @global_config ||= GlobalConfig.new
+      end
+
+      def global_cache
+        @global_cache ||= GlobalCache.new
+      end
+
+      def terminal
+        @terminal ||= HighLine.new(nil, $stderr)
+      end
+    end
+  end
+end

data/lib/cc/cli.rb

@@ -0,0 +1,39 @@
+require "active_support"
+require "active_support/core_ext"
+require "yaml"
+require "cc/analyzer"
+require "cc/config"
+require "cc/engine_registry"
+require "cc/workspace"
+
+require "cc/cli/analyze"
+require "cc/cli/command"
+require "cc/cli/console"
+require "cc/cli/engines"
+require "cc/cli/help"
+require "cc/cli/output"
+require "cc/cli/prepare"
+require "cc/cli/runner"
+require "cc/cli/validate_config"
+require "cc/cli/version"
+
+module CC
+  module CLI
+    def self.debug?
+      ENV["CODECLIMATE_DEBUG"].present?
+    end
+
+    def self.logger
+      @logger ||= ::Logger.new(STDERR).tap do |logger|
+        logger.level =
+          if debug?
+            ::Logger::DEBUG
+          else
+            ::Logger::ERROR
+          end
+      end
+    end
+  end
+
+  Analyzer.logger = CLI.logger
+end

data/lib/cc/config/checks_adapter.rb

@@ -0,0 +1,40 @@
+module CC
+  class Config
+    class ChecksAdapter
+      attr_reader :config
+
+      def initialize(data = {})
+        @config = data
+
+        return unless checks.present?
+        copy_qm_checks_config
+      end
+
+      private
+
+      def copy_qm_checks_config
+        DefaultAdapter::ENGINES.keys.each do |name|
+          copy_checks(name)
+        end
+      end
+
+      def copy_checks(engine_name)
+        engine = config.fetch("plugins", {}).fetch(engine_name, {})
+        engine["config"] ||= {}
+
+        if engine["config"].is_a?(String)
+          engine["config"] = {
+            "file" => engine["config"],
+            "checks" => checks,
+          }
+        elsif engine["config"].is_a?(Hash)
+          engine["config"]["checks"] = checks
+        end
+      end
+
+      def checks
+        config["checks"]
+      end
+    end
+  end
+end