Module: FissherConf

Defined in:
lib/fissher_conf.rb

Overview

Module for all aspects of configuration within fissher.

Defined Under Namespace

Classes: Misc

Instance Method Summary collapse

Instance Method Details

#die(msg) ⇒ Object

A shortcut method to make errors a little more graceful.

Parameters:

  • msg (String) —

    the message to be displayed before the usage message.



61
62
63
64
65
 
# File 'lib/fissher_conf.rb', line 61

def die( msg )
  puts "#{msg}\n"
  usage
  exit 1
end

#handle_opts ⇒ Object

Parse command line options using getopt and options within the json config file.



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
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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/fissher_conf.rb', line 68

def handle_opts
  opt = Getopt::Std.getopts("pc:g:G:u:n:sH:hU:")
  ret = Hash.new

  if opt["h"]
    usage
    exit 1
  end
 
  # Import configuration, either from default or a custom JSON config
  if opt["c"]
    conf_file = opt["c"]
  elsif File.exists?("#{Dir.home}/.fissherrc")
    conf_file = "#{Dir.home}/.fissherrc"
  elsif File.exists?("/etc/fissher/fissher.conf")
    conf_file = "/etc/fissher/fissher.conf"
  else
    conf_file = File.dirname(__FILE__)  + "/../etc/fissher.conf"
  end
  
  # Ensure the file exists
  begin 
    config = JSON.parse(File.read(conf_file),:symbolize_names => true)
  rescue

    etcloc = File.dirname(__FILE__).to_s.gsub(/\/lib$/, '/etc')
    puts <<EOB
****    It appears that you have not yet created your config file!    ****
You can do this by copying the sample config to one of the following
locations:

~/.fissherrc
/etc/fissher/fissher.conf
#{etcloc}/fissher.conf

You can find a copy of the sample in the following location:

#{etcloc}

A script will be included in the next release that will generate the file
for you if it does not already exist.
EOB
    abort
  end
  

  # Use sudo for our command
  if opt["s"]
    sudo_cmd = "sudo"
  end

  if opt["U"] #&& opt["s"].nil?
    sudo_cmd = "sudo -u #{opt['U']}"
  end

  # Gateway if an edgeserver is present
  if opt["g"]
    ret[:gateway] = opt["g"]
  elsif opt["G"] && !config[:hostgroups][:"#{opt['G']}"][:gateway].nil?
    ret[:gateway] = config[:hostgroups][:"#{opt['G']}"][:gateway]
  elsif !config[:default_gateway].nil?
    ret[:gateway] = config[:default_gateway]
  end  

  # Hostgroup used for batch jobs
  if opt["G"]
    abort "You may only specify one of -G or -H!\n" unless opt["H"].nil?
    h = Misc.new
    ret[:hostlist] = h.group_hosts(opt["G"],config,conf_file) 
  end

  # Username used by connections
  if opt["u"]
    ret[:user] = opt['u']
  elsif config[:user]
    ret[:user] = config[:user]
  end

  # Job Concurrency limit
  if opt["n"] == '0'
    ret[:concurrency] = nil
  elsif opt["n"]
    ret[:concurrency] = opt["n"].to_i
  elsif config[:concurrency]
    ret[:concurrency] = config[:concurrency].to_i
  else
    ret[:concurrency] = 10
  end

  # Host list
  if opt["H"]
    abort "You may only specify one of -G or -H!\n" unless opt["G"].nil?
    if opt["H"] =~ /,/
      ret[:hostlist] = opt["H"].split(",")
    else
      ret[:hostlist] = [ opt["H"] ]
    end
  end

  # Our command
  if ARGV.count >= 1
    if sudo_cmd
      ret[:command] = "#{sudo_cmd} " + ARGV.join(' ').to_s
    else
      ret[:command] = ARGV.join(' ').to_s 
    end
  else
    die "No command specified!\n" unless !ret[:command].nil?
  end

  # Get our account password
  if (opt["p"] || config[:enable_password] == 'true')
    p = Misc.new
    ret[:password] = p.getpass()
  else
    ret[:password] = nil
  end
  
  ret
end

#usage ⇒ Object

Print usage message



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

def usage
  app = File.basename($0)
  puts <<-EOF
#{app} [flags] [command]:
-G Hostgroup       Execute command on all hosts listed in the JSON config for
                   the specified group.
-H Host1,Host2     Execute command on hosts listed on the command line
-g jumpbox         Manually specify/override a jump server, if necessary.
-s 		     Execute the provided commands with sudo.   
-u username        Manually specify/override username to connect with.
-p                 Use password based authentication, specified via STDIN
-c config.json     Manually specify the path to your fissher config file
-n num             Number of concurrent connections. Enter 0 for unlimited.
-U username	     Specify an alternate user to run the command as. Uses sudo.
                   (E.G. -U webmaster)
  EOF
end