# frozen_string_literal: true

require 'bolt/error'
require 'bolt/config/transport/base'

module Bolt
  class Config
    module Transport
      class SSH < Base
        # Options available when using the net-ssh-based transport
        OPTIONS = %w[
          cleanup
          connect-timeout
          disconnect-timeout
          encryption-algorithms
          extensions
          host
          host-key-algorithms
          host-key-check
          interpreters
          kex-algorithms
          load-config
          login-shell
          mac-algorithms
          password
          port
          private-key
          proxyjump
          script-dir
          tmpdir
          tty
          user
        ].concat(RUN_AS_OPTIONS).sort.freeze

        # Options available when using the native ssh transport
        NATIVE_OPTIONS = %w[
          cleanup
          copy-command
          host
          host-key-check
          interpreters
          native-ssh
          port
          private-key
          script-dir
          ssh-command
          tmpdir
          user
        ].concat(RUN_AS_OPTIONS).sort.freeze

        DEFAULTS = {
          "cleanup"            => true,
          "connect-timeout"    => 10,
          "disconnect-timeout" => 5,
          "load-config"        => true,
          "login-shell"        => 'bash',
          "tty"                => false
        }.freeze

        # The set of options available for the ssh and native ssh transports overlap, so we
        # need to check which transport is used before fully initializing, otherwise options
        # may not be filtered correctly.
        def initialize(data = {}, project = nil)
          assert_hash_or_config(data)
          @native = true if data['native-ssh']
          super(data, project)
        end

        # This method is used to filter CLI options in the Config class. This
        # should include `ssh-command` so that we can later warn if the option
        # is present without `native-ssh`
        def self.options
          %w[ssh-command native-ssh].concat(OPTIONS)
        end

        def self.schema
          {
            type:       Hash,
            properties: self::TRANSPORT_OPTIONS.slice(*(self::OPTIONS + self::NATIVE_OPTIONS)),
            _plugin:    true
          }
        end

        private def filter(unfiltered)
          # Because we filter before merging config together it's impossible to
          # know whether both ssh-command *and* native-ssh will be specified
          # unless they are both in the filter. However, we can't add
          # ssh-command to OPTIONS since that's used for documenting available
          # options. This makes it so that ssh-command is preserved so we can
          # warn once all config is resolved if native-ssh isn't set.
          @native ? unfiltered.slice(*NATIVE_OPTIONS) : unfiltered.slice(*self.class.options)
        end

        private def validate
          super

          if (key_opt = @config['private-key'])
            if key_opt.instance_of?(String)
              @config['private-key'] = File.expand_path(key_opt, @project)

              # We have an explicit test for this to only warn if using net-ssh transport
              Bolt::Util.validate_file('ssh key', @config['private-key']) if @config['native-ssh']
            end

            if key_opt.instance_of?(Hash) && @config['native-ssh']
              raise Bolt::ValidationError, 'private-key must be a filepath when using native-ssh'
            end
          end

          if @config['interpreters']
            @config['interpreters'] = normalize_interpreters(@config['interpreters'])
          end

          if @config['login-shell'] == 'powershell'
            %w[tty run-as].each do |key|
              if @config[key]
                raise Bolt::ValidationError,
                      "#{key} is not supported when using PowerShell"
              end
            end
          end

          if @config['native-ssh'] && !@config['load-config']
            msg = 'Cannot use native SSH transport with load-config set to false'
            raise Bolt::ValidationError, msg
          end
        end
      end
    end
  end
end