features/step_definitions/ssh.rb

   1 require 'socket'
   2
   3 def assert_not_ipaddr(str)
   4   err_msg = "'#{str}' looks like a LAN IP address."
   5   assert_raise(IPAddr::InvalidAddressError, err_msg) do
   6     IPAddr.new(str)
   7   end
   8 end
   9
  10 def read_and_validate_ssh_config(srv_type)
  11   conf = $config[srv_type]
  12   begin
  13     required_settings = ['private_key', 'public_key', 'username', 'hostname']
  14     required_settings.each do |key|
  15       assert(conf.key?(key))
  16       assert_not_nil(conf[key])
  17       assert(!conf[key].empty?)
  18     end
  19   rescue NoMethodError
  20     raise(
  21       "Your #{srv_type} config is incorrect or missing from your local " \
  22       "configuration file (#{LOCAL_CONFIG_FILE}). " \
  23       'See wiki/src/contribute/release_process/test/usage.mdwn for the format.'
  24     )
  25   end
  26
  27   case srv_type
  28   when 'SSH'
  29     @ssh_host        = conf['hostname']
  30     @ssh_port        = conf['port'].to_i if conf['port']
  31     @ssh_username    = conf['username']
  32     assert_not_ipaddr(@ssh_host)
  33   when 'SFTP'
  34     @sftp_host       = conf['hostname']
  35     @sftp_port       = conf['port'].to_i if conf['port']
  36     @sftp_username   = conf['username']
  37     assert_not_ipaddr(@sftp_host)
  38   end
  39 end
  40
  41 Given /^I have the SSH key pair for an? (Git|SSH|SFTP) (?:repository|server)( on the LAN)?$/ do |server_type, lan|
  42   $vm.execute_successfully("install -m 0700 -d '/home/#{LIVE_USER}/.ssh/'",
  43                            user: LIVE_USER)
  44   if server_type == 'Git' || lan
  45     secret_key = $config['Unsafe_SSH_private_key']
  46     public_key = $config['Unsafe_SSH_public_key']
  47   else
  48     read_and_validate_ssh_config(server_type)
  49     secret_key = $config[server_type]['private_key']
  50     public_key = $config[server_type]['public_key']
  51   end
  52
  53   $vm.execute_successfully(
  54     "echo '#{secret_key}' > '/home/#{LIVE_USER}/.ssh/id_rsa'",
  55     user: LIVE_USER
  56   )
  57   $vm.execute_successfully(
  58     "echo '#{public_key}' > '/home/#{LIVE_USER}/.ssh/id_rsa.pub'",
  59     user: LIVE_USER
  60   )
  61   $vm.execute_successfully("chmod 0600 '/home/#{LIVE_USER}/.ssh/'id*",
  62                            user: LIVE_USER)
  63 end
  64
  65 Given /^I (?:am prompted to )?verify the SSH fingerprint for the (?:Git|SSH) (?:repository|server)$/ do
  66   @screen.wait('SSHFingerprint.png', 60)
  67   sleep 1 # brief pause to ensure that the following keystrokes do not get lost
  68   @screen.type('yes', ['Return'])
  69 end
  70
  71 def get_free_tcp_port
  72   server = TCPServer.new('127.0.0.1', 0)
  73   server.addr[1]
  74 ensure
  75   server.close
  76 end
  77
  78 Given /^an SSH server is running on the LAN$/ do
  79   @sshd_server_port = get_free_tcp_port
  80   @sshd_server_host = $vmnet.bridge_ip_addr
  81   sshd = SSHServer.new(@sshd_server_host, @sshd_server_port)
  82   sshd.start
  83   add_extra_allowed_host(@sshd_server_host, @sshd_server_port)
  84   add_after_scenario_hook { sshd.stop }
  85 end
  86
  87 When /^I connect to an SSH server on the (Internet|LAN)$/ do |location|
  88   case location
  89   when 'Internet'
  90     read_and_validate_ssh_config('SSH')
  91   when 'LAN'
  92     @ssh_port = @sshd_server_port
  93     @ssh_username = 'user'
  94     @ssh_host = @sshd_server_host
  95   end
  96
  97   ssh_port_suffix = "-p #{@ssh_port}" if @ssh_port
  98
  99   cmd = "ssh #{@ssh_username}@#{@ssh_host} #{ssh_port_suffix}"
 100
 101   step 'process "ssh" is not running'
 102
 103   recovery_proc = proc do
 104     step 'I kill the process "ssh"' if $vm.process_running?('ssh')
 105     step 'I run "clear" in GNOME Terminal'
 106   end
 107
 108   retry_tor(recovery_proc) do
 109     step "I run \"#{cmd}\" in GNOME Terminal"
 110     step 'process "ssh" is running within 10 seconds'
 111     step 'I verify the SSH fingerprint for the SSH server'
 112   end
 113 end
 114
 115 Then /^I have sucessfully logged into the SSH server$/ do
 116   @screen.wait('SSHLoggedInPrompt.png', 60)
 117 end
 118
 119 Then /^I connect to an SFTP server on the Internet$/ do
 120   read_and_validate_ssh_config 'SFTP'
 121
 122   @sftp_port ||= 22
 123   @sftp_port = @sftp_port.to_s
 124
 125   recovery_proc = proc do
 126     step 'I kill the process "ssh"'
 127     step 'I kill the process "nautilus"'
 128   end
 129
 130   retry_tor(recovery_proc) do
 131     step 'I start "Nautilus" via GNOME Activities Overview'
 132     nautilus = Dogtail::Application.new('org.gnome.Nautilus')
 133     nautilus.child(roleName: 'frame')
 134     # "Other Locations" has no click action, so Dogtail cannot interact with it.
 135     @screen.click('NautilusOtherLocations.png')
 136     connect_bar = nautilus.child('Connect to Server', roleName: 'label').parent
 137     connect_bar
 138       .child(roleName: 'filler', recursive: false)
 139       .child(roleName: 'text', recursive: false)
 140       .text = 'sftp://' + @sftp_username + '@' + @sftp_host + ':' + @sftp_port
 141     connect_bar.button('Connect', recursive: false).click
 142     step 'I verify the SSH fingerprint for the SFTP server'
 143   end
 144 end
 145
 146 Then /^I verify the SSH fingerprint for the SFTP server$/ do
 147   try_for(30) do
 148     Dogtail::Application.new('gnome-shell').child?('Log In Anyway')
 149   end
 150   # Here we'd like to click on the button using Dogtail, but something
 151   # is buggy so let's just use the keyboard.
 152   @screen.type(['Tab'], ['Return'])
 153 end
 154
 155 Then /^I successfully connect to the SFTP server$/ do
 156   try_for(60) do
 157     Dogtail::Application.new('org.gnome.Nautilus')
 158                         .child?("#{@sftp_username} on #{@sftp_host}")
 159   end
 160 end