Class: Kdeploy::Executor

Inherits:
Object
  • Object
show all
Defined in:
lib/kdeploy/executor.rb

Overview

SSH/SCP executor for remote command execution and file operations

Instance Method Summary collapse

Constructor Details

#initialize(host_config) ⇒ Executor

Returns a new instance of Executor.



13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/kdeploy/executor.rb', line 13

def initialize(host_config)
  @host = host_config[:name]
  @user = host_config[:user]
  @ip = host_config[:ip]
  @password = host_config[:password]
  @key = host_config[:key]
  @port = host_config[:port] # 新增端口支持
  @use_sudo = host_config[:use_sudo] || false
  @sudo_password = host_config[:sudo_password]
  @base_dir = host_config[:base_dir] # Base directory for resolving relative paths
end

Instance Method Details

#build_command_result(stdout, stderr, command, exit_status) ⇒ Object 



68
69
70
71
72
73
74
75
 
# File 'lib/kdeploy/executor.rb', line 68

def build_command_result(stdout, stderr, command, exit_status)
  {
    stdout: stdout.strip,
    stderr: stderr.strip,
    command: command,
    exit_status: exit_status
  }
end

#execute(command, use_sudo: nil) ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/kdeploy/executor.rb', line 25

def execute(command, use_sudo: nil)
  use_sudo = @use_sudo if use_sudo.nil?
  command = wrap_with_sudo(command) if use_sudo

  Net::SSH.start(@ip, @user, ssh_options) do |ssh|
    execute_command_on_ssh(ssh, command)
  end
rescue Net::SSH::AuthenticationFailed => e
  raise SSHError.new("SSH authentication failed: #{e.message}", e)
rescue StandardError => e
  raise SSHError.new("SSH execution failed: #{e.message}", e)
end

#execute_command_on_ssh(ssh, command) ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/kdeploy/executor.rb', line 38

def execute_command_on_ssh(ssh, command)
  stdout = String.new
  stderr = String.new
  exit_status = nil

  ssh.open_channel do |channel|
    channel.exec(command) do |_ch, success|
      raise SSHError, "Could not execute command: #{command}" unless success

      setup_channel_handlers(channel, stdout, stderr)
      channel.on_request('exit-status') do |_ch, data|
        exit_status = data.read_long
      end
    end
  end
  ssh.loop
  raise_nonzero_exit!(command, exit_status, stdout, stderr)
  build_command_result(stdout, stderr, command, exit_status)
end

#raise_nonzero_exit!(command, exit_status, stdout, stderr) ⇒ Object

Raises:



77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/kdeploy/executor.rb', line 77

def raise_nonzero_exit!(command, exit_status, stdout, stderr)
  return if exit_status.nil?
  return if exit_status.zero?

  raise SSHError.new(
    "Command exited with status #{exit_status}",
    nil,
    command: command,
    exit_status: exit_status,
    stdout: stdout.strip,
    stderr: stderr.strip
  )
end

#setup_channel_handlers(channel, stdout, stderr) ⇒ Object 



58
59
60
61
62
63
64
65
66
 
# File 'lib/kdeploy/executor.rb', line 58

def setup_channel_handlers(channel, stdout, stderr)
  channel.on_data do |_ch, data|
    stdout << data
  end

  channel.on_extended_data do |_ch, _type, data|
    stderr << data
  end
end

#sync_directory(source, destination, ignore: [], exclude: [], delete: false, use_sudo: nil) ⇒ Object 



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/kdeploy/executor.rb', line 117

def sync_directory(source, destination, ignore: [], exclude: [], delete: false, use_sudo: nil)
  use_sudo = @use_sudo if use_sudo.nil?

  # Resolve relative paths relative to base_dir
  resolved_source = resolve_path(source)

  # Validate source directory
  raise FileNotFoundError, "Source directory not found: #{resolved_source}" unless File.directory?(resolved_source)

  # Create file filter
  all_patterns = ignore + exclude
  filter = FileFilter.new(ignore_patterns: all_patterns)

  # Collect files to sync
  files_to_sync = collect_files_to_sync(resolved_source, filter)

  # Upload files
  uploaded_count = 0
  source_path = Pathname.new(resolved_source)
  files_to_sync.each do |file_path|
    relative_path = Pathname.new(file_path).relative_path_from(source_path).to_s
    remote_path = File.join(destination, relative_path).gsub(%r{/+}, '/')

    # Ensure remote directory exists
    remote_dir = File.dirname(remote_path)
    ensure_remote_directory(remote_dir, use_sudo: use_sudo)

    # Upload file
    upload(file_path, remote_path, use_sudo: use_sudo)
    uploaded_count += 1
  end

  # Delete extra files if requested
  deleted_count = 0
  deleted_count = delete_extra_files(resolved_source, destination, filter, use_sudo: use_sudo) if delete

  {
    uploaded: uploaded_count,
    deleted: deleted_count,
    total: files_to_sync.size
  }
rescue StandardError => e
  raise SCPError.new("Directory sync failed: #{e.message}", e)
end

#upload(source, destination, use_sudo: nil) ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/kdeploy/executor.rb', line 91

def upload(source, destination, use_sudo: nil)
  use_sudo = @use_sudo if use_sudo.nil?

  # Resolve relative paths relative to base_dir
  resolved_source = resolve_path(source)

  # If destination requires sudo, upload to temp location first, then move with sudo
  if use_sudo || requires_sudo?(destination)
    upload_with_sudo(resolved_source, destination)
  else
    Net::SCP.start(@ip, @user, ssh_options) do |scp|
      scp.upload!(resolved_source, destination)
    end
  end
rescue StandardError => e
  raise SCPError.new("SCP upload failed: #{e.message}", e)
end

#upload_template(source, destination, variables = {}) ⇒ Object 



109
110
111
112
113
114
115
 
# File 'lib/kdeploy/executor.rb', line 109

def upload_template(source, destination, variables = {})
  # Resolve relative paths relative to base_dir
  resolved_source = resolve_path(source)
  Template.render_and_upload(self, resolved_source, destination, variables)
rescue StandardError => e
  raise TemplateError.new("Template upload failed: #{e.message}", e)
end