aboutsummaryrefslogtreecommitdiff
path: root/lib/shell_utils.rb
blob: b22e7914aad54510fe46cfa87274e91eed7f4039 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# GOV.UK Mini Environment Admin
# Copyright © 2018  Christopher Baines <mail@cbaines.net>
#
# This file is part of the GOV.UK Mini Environment Admin.
#
# The GOV.UK Mini Environment Admin is free software: you can
# redistribute it and/or modify it under the terms of the GNU Affero
# General Public License as published by the Free Software Foundation,
# either version 3 of the License, or (at your option) any later
# version.
#
# The GOV.UK Mini Environment Admin is distributed in the hope that it
# will be useful, but WITHOUT ANY WARRANTY; without even the implied
# warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
# See the GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public
# License along with the GOV.UK Mini Environment Admin.  If not, see
# <http://www.gnu.org/licenses/>.

require 'open3'
require 'shellwords'
require 'tempfile'

module ShellUtils
  def run_command(*command, run_remotely_on_host: nil)
    if run_remotely_on_host
      command = command.map do |arg|
        Shellwords.escape(arg)
      end

      identity_file = Tempfile.new(
        'private-identity-file',
        Rails.root.join('tmp')
      )
      identity_file.write(run_remotely_on_host.private_key)
      identity_file.close

      command = [
        'ssh',
        # Use a automatically trust on first use model
        '-o', 'StrictHostKeyChecking=no',
        '-i', identity_file.path,
        run_remotely_on_host.user_at_address,
        *command
      ]
    end

    logger.info("#{self.class}: Running command #{command.join(' ')}")

    Open3.popen2e(*command) do |_stdin, stdout_and_stderr, wait_thr|
      logger.info("#{self.class}: commmand running, pid #{wait_thr.pid}")

      output = []
      stdout_and_stderr.each_line do |line|
        logger.info(self.class) { line.chomp }
        output << line
      end

      exit_status = wait_thr.value
      unless exit_status == 0
        logger.error(self.class) { "failed, exit status #{exit_status}" }

        identity_file.unlink if identity_file
        raise "Running #{command.join(' ')} failed:\n\n#{output.join}\n"
      end

      identity_file.unlink if identity_file

      output
    end
  end

  def read_json_file(filename, from_remote_host: nil)
    if from_remote_host
      identity_file = Tempfile.new(
        'private-identity-file',
        Rails.root.join('tmp')
      )
      identity_file.write(from_remote_host.private_key)
      identity_file.close

      command = [
        'ssh',
        from_remote_host.user_at_address,
        # Use a automatically trust on first use model
        '-o', 'StrictHostKeyChecking=no',
        '-i', identity_file.path,
        'cat',
        filename
      ]

      stdout_str, status = Open3.capture2(*command)

      identity_file.unlink if identity_file

      unless status.exitstatus == 0
        logger.error(self.class) { "failed, exit status #{exit_status}" }

        raise "Running #{command.join(' ')} failed:\n\n#{output.join}\n"
      end

      JSON.parse(stdout_str)
    else
      JSON.parse(File.read(filename))
    end
  end

  def hash_to_arguments(hash)
    hash.flat_map do |(key, value)|
      transformed_key = key.to_s.tr('_', '-')

      if value == true
        ["--#{transformed_key}"]
      elsif value.kind_of?(Array)
        value.map { |x| "--#{transformed_key}=#{x}" }
      else
        ["--#{transformed_key}=#{value}"]
      end
    end
  end
end