Module: Bcome::Ssh::DriverFunctions

Included in:
Driver
Defined in:
lib/objects/ssh/driver_concerns/functions.rb

Instance Method Summary collapse

Instance Method Details

#do_ssh ⇒ Object 



5
6
7
8
 
# File 'lib/objects/ssh/driver_concerns/functions.rb', line 5

def do_ssh
  cmd = ssh_command
  @context_node.execute_local(cmd)
end

#get(remote_path, local_path) ⇒ Object

Raises:



75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/objects/ssh/driver_concerns/functions.rb', line 75

def get(remote_path, local_path)
  raise Bcome::Exception::MissingParamsForScp, "'get' requires a local_path and a remote_path" if local_path.to_s.empty? || remote_path.to_s.empty?

  puts "\n(#{@context_node.namespace})\s".namespace + "Downloading #{remote_path} to #{local_path}\n".informational

  begin
    scp.download!(remote_path, local_path, recursive: true) do |_ch, name, sent, total|
      puts "#{name}: #{sent}/#{total}".progress
    end
  rescue Exception => e
    puts e.message.error
  end
end

#local_port_forward(start_port, end_port) ⇒ Object 



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/objects/ssh/driver_concerns/functions.rb', line 17

def local_port_forward(start_port, end_port)
  tunnel_command = local_port_forward_command(start_port, end_port)

  if ::Bcome::Workspace.instance.console_set?
    puts "\sOpening ssh tunnel:\s".informational + tunnel_command.to_s.terminal_prompt
    tunnel = ::Bcome::Ssh::Tunnel::LocalPortForward.new(tunnel_command)
    ::Bcome::Ssh::TunnelKeeper.instance << tunnel
    tunnel.open!
    tunnel
  else
    puts "\n\nOpening ssh tunnel".informational + "\slocalhost:#{start_port} ~> #{@context_node.namespace}:#{end_port}"
    puts "\nTo use, navigate to another terminal window or application."
    puts "\nctrl+c to close."
    ::Bcome::Command::Local.run(tunnel_command)
  end
end

#ping ⇒ Object 



34
35
36
37
38
39
 
# File 'lib/objects/ssh/driver_concerns/functions.rb', line 34

def ping
  ssh_connect!
  { success: true }
rescue Exception => e
  { success: false, error: e, backtrace: e.backtrace }
end

#put(local_path, remote_path) ⇒ Object

Raises:



45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/objects/ssh/driver_concerns/functions.rb', line 45

def put(local_path, remote_path)
  raise Bcome::Exception::MissingParamsForScp, "'put' requires a local_path and a remote_path" if local_path.to_s.empty? || remote_path.to_s.empty?

  puts "\n(#{@context_node.namespace})\s".namespace + "Uploading #{local_path} to #{remote_path}\n".informational

  begin
    scp.upload!(local_path, remote_path, recursive: true) do |_ch, name, sent, total|
      puts "#{name}: #{sent}/#{total}".progress
    end
  rescue Exception => e # scp just throws generic exceptions :-/
    puts e.message.error
  end
  nil
end

#put_str(string, remote_path, silence_progress = false) ⇒ Object

Raises:



60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/objects/ssh/driver_concerns/functions.rb', line 60

def put_str(string, remote_path, silence_progress = false)
  raise Bcome::Exception::MissingParamsForScp, "'put' requires a string and a remote_path" if string.nil? || remote_path.to_s.empty?

  puts "\n(#{@context_node.namespace})\s".namespace + "Uploading from string to #{remote_path}\n".informational unless silence_progress

  begin
    scp.upload!(StringIO.new(string), remote_path) do |_ch, name, sent, total|
      puts "#{name}: #{sent}/#{total}".progress unless silence_progress
    end
  rescue StandardError => e
    raise ::Bcome::Exception::Generic, e.message
  end
  nil
end

#rsync(local_path, remote_path) ⇒ Object

Raises:



10
11
12
13
14
15
 
# File 'lib/objects/ssh/driver_concerns/functions.rb', line 10

def rsync(local_path, remote_path)
  raise Bcome::Exception::MissingParamsForRsync, "'rsync' requires a local_path and a remote_path" if local_path.to_s.empty? || remote_path.to_s.empty?

  command = rsync_command(local_path, remote_path)
  @context_node.execute_local(command)
end

#scp ⇒ Object 



41
42
43
 
# File 'lib/objects/ssh/driver_concerns/functions.rb', line 41

def scp
  ssh_connection.scp
end