Class: Razor::CLI::Parse

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/razor/cli/parse.rb

Constant Summary collapse

LINUX_PEM_FILE = 
'/etc/puppetlabs/puppet/ssl/certs/ca.pem'
WIN_PEM_FILE = 
'C:\ProgramData\PuppetLabs\puppet\etc\ssl\certs\ca.pem'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(args) ⇒ Parse

Returns a new instance of Parse.



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/razor/cli/parse.rb', line 165

def initialize(args)
  @args = args.dup
  # To be populated externally.
  @stripped_args = []
  @format = 'short'
  @verify_ssl = true
  @args = get_optparse.order(@args)
  parse_and_set_api_url(ENV["RAZOR_API"], :env) if ENV["RAZOR_API"] && !@api_url
  env_pem_file = ENV['RAZOR_CA_FILE']
  # If this is set, it should actually exist.
  if env_pem_file && !File.exists?(env_pem_file)
    raise Razor::CLI::InvalidCAFileError.new(env_pem_file)
  end
  pem_file_locations = [env_pem_file, LINUX_PEM_FILE, WIN_PEM_FILE]
  pem_file_locations.each do |file|
    if file && File.exists?(file)
      @ssl_ca_file = file
      break
    end
  end

  @args = set_help_vars(@args)
  if @args == ['version'] or @show_version
    @show_version = true
  elsif @args.any?
    @navigation = @args.dup
  else
    # Called with no remaining arguments to parse.
    @option_help = true
  end
end

Instance Attribute Details

#api_url ⇒ Object (readonly)

Returns the value of attribute api_url.



159
160
161
 
# File 'lib/razor/cli/parse.rb', line 159

def api_url
  @api_url
end

#args ⇒ Object (readonly)

Returns the value of attribute args.



159
160
161
 
# File 'lib/razor/cli/parse.rb', line 159

def args
  @args
end

#format ⇒ Object

The format can be determined from later segments.



161
162
163
 
# File 'lib/razor/cli/parse.rb', line 161

def format
  @format
end

#ssl_ca_file ⇒ Object

The format can be determined from later segments.



161
162
163
 
# File 'lib/razor/cli/parse.rb', line 161

def ssl_ca_file
  @ssl_ca_file
end

#stripped_args ⇒ Object

The format can be determined from later segments.



161
162
163
 
# File 'lib/razor/cli/parse.rb', line 161

def stripped_args
  @stripped_args
end

Instance Method Details

#dump_response? ⇒ Boolean

Returns:

  • (Boolean) 


147
148
149
 
# File 'lib/razor/cli/parse.rb', line 147

def dump_response?
  !!@dump
end

#get_optparse ⇒ Object 



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
 
# File 'lib/razor/cli/parse.rb', line 22

def get_optparse
  @optparse ||= OptionParser.new do |opts|
    opts.banner = _("Usage: razor [FLAGS] NAVIGATION\n")

    opts.on "-d", "--dump", _("Dumps API output to the screen") do
      @dump = true
    end

    opts.on "-a", "--api", _("Show API help for a command") do
      @api_help = true
    end

    opts.on "-k", "--insecure", _("Allow SSL connections without verified certificates") do
      @verify_ssl = false
    end

    opts.on "-u", "--url URL",
      _("The full Razor API URL, can also be set\n" + " "*37 +
      "with the RAZOR_API environment variable\n" + " "*37 +
      "(default %{https_api} or \n" + " "*37 +
      "%{http_api})") % {http_api: Razor::CLI::Navigate::RAZOR_HTTP_API,
                         https_api: Razor::CLI::Navigate::RAZOR_HTTPS_API} do |url|
      parse_and_set_api_url(url, :opts)
    end

    opts.on "-v", "--version", _("Show the version of Razor") do
      @show_version = true
    end

    opts.on "-h", "--help", _("Show this screen") do
      # If searching for a command's help, leave the argument for navigation.
      @option_help = true
    end

  end
end

#help ⇒ Object 



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
123
124
125
126
127
128
129
 
# File 'lib/razor/cli/parse.rb', line 83

def help
  output = get_optparse.to_s
  exit = 0
  begin
    replacements = {collections: list_things(_("Collections"), navigate.collections),
                    commands: list_things(_("Commands"), navigate.commands)}
    output << _(<<-HELP) % replacements
%{collections}

  Navigate to entries of a collection using COLLECTION NAME, for example,
  'nodes node15'  for the  details of a node or 'nodes node15 log' to see
  the log for node15
%{commands}

  Pass arguments to commands either directly by name ('--name=NAME')
  or save the JSON body for the  command  in a file and pass it with
  '--json FILE'.  Using --json is the only way to pass  arguments in
  nested structures such as the configuration for a broker.

HELP
  rescue RestClient::Unauthorized
    output << _(<<-UNAUTH) % {url: @api_url}
Error: Credentials are required to connect to the server at %{url}"
UNAUTH
    exit = 1
  rescue SocketError, Errno::ECONNREFUSED => e
    puts _("Error: Could not connect to the server at %{url}") % {url: @api_url}
    puts "       #{e}\n"
    die
  rescue RestClient::SSLCertificateNotVerified
    puts _("Error: SSL certificate could not be verified against known CA certificates.\n" +
           "       To turn off verification, use the -k or --insecure option.")
    die
  rescue OpenSSL::SSL::SSLError => e
    # Occurs in case of e.g. certificate mismatch (FQDN vs. hostname)
    puts _("Error: SSL certificate error from server at %{url}") % {url: @api_url}
    puts "       #{e}"
    die
  rescue => e
    output << _(<<-ERR) % {url: @api_url}
Error: Unknown error occurred while connecting to server at %{url}:
   #{e}
ERR
    exit = 1
  end
  [output, exit]
end

#list_things(name, items) ⇒ Object 



59
60
61
62
63
64
 
# File 'lib/razor/cli/parse.rb', line 59

def list_things(name, items)
  "\n    #{name}:\n" +
    items.map {|x| x["name"]}.compact.sort.map do |name|
    "        #{name}"
  end.join("\n")
end

#navigate ⇒ Object 



217
218
219
 
# File 'lib/razor/cli/parse.rb', line 217

def navigate
  @navigate ||=Navigate.new(self, @navigation)
end

#parse_and_set_api_url(url, source) ⇒ Object 



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/razor/cli/parse.rb', line 221

def parse_and_set_api_url(url, source)
  begin
    unless url.start_with?('http:') or url.start_with?('https:')
      raise Razor::CLI::InvalidURIError.new(url, source)
    end
    @api_url = URI.parse(url)

    # Localhost won't match the server's certificate; no verification required.
    # This needs to happen after get_optparse so `-k` and `-u` can take effect.
    if @api_url.hostname == 'localhost'
      @verify_ssl = false
    end
  rescue URI::InvalidURIError => e
    raise Razor::CLI::InvalidURIError.new(url, source)
  end
end

#set_help_vars(rest) ⇒ Object

This method sets the appropriate help flags ‘@command_help` and `@option_help`, then returns a new set of arguments.



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/razor/cli/parse.rb', line 199

def set_help_vars(rest)
  # Find and remove 'help' variations anywhere in the command.
  if rest.any? { |arg| ['-h', '--help'].include? arg } or
      rest.first == 'help' or rest.drop(1).first == 'help'
    rest = rest.reject { |arg| ['-h', '--help', 'help'].include? arg }
    # If anything is left, assume it is a command.
    if rest.any?
      @command_help = true
    else
      @option_help = true
    end
  end
  if @option_help && rest.any?
    @command_help = true
  end
  rest
end

#show_api_help? ⇒ Boolean

Returns:

  • (Boolean) 


135
136
137
 
# File 'lib/razor/cli/parse.rb', line 135

def show_api_help?
  !!@api_help
end

#show_command_help? ⇒ Boolean

Returns:

  • (Boolean) 


143
144
145
 
# File 'lib/razor/cli/parse.rb', line 143

def show_command_help?
  !!@command_help
end

#show_help? ⇒ Boolean

Returns:

  • (Boolean) 


139
140
141
 
# File 'lib/razor/cli/parse.rb', line 139

def show_help?
  !!@option_help
end

#show_version? ⇒ Boolean

Returns:

  • (Boolean) 


131
132
133
 
# File 'lib/razor/cli/parse.rb', line 131

def show_version?
  !!@show_version
end

#verify_ssl=(arg) ⇒ Object 



151
152
153
 
# File 'lib/razor/cli/parse.rb', line 151

def verify_ssl=(arg)
  @verify_ssl = arg
end

#verify_ssl? ⇒ Boolean

Returns:

  • (Boolean) 


155
156
157
 
# File 'lib/razor/cli/parse.rb', line 155

def verify_ssl?
  !!@verify_ssl
end

#version ⇒ Object 



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/razor/cli/parse.rb', line 66

def version
  server_version = '(unknown)'
  error = ''
  begin
    server_version = navigate.server_version
  rescue RestClient::Unauthorized
    error = _("Error: Credentials are required to connect to the server at %{url}.") % {url: @api_url}
  rescue
    error = _("Error: Could not connect to the server at %{url}.") % {url: @api_url}
  ensure
    return [(_(<<-OUTPUT) % {server_version: server_version, client_version: Razor::CLI::VERSION} + "\n" + error).rstrip, error != '' ? 1 : 0]
    Razor Server version: #{server_version}
    Razor Client version: #{Razor::CLI::VERSION}
    OUTPUT
  end
end