Skip to content

Commit 5b3780e

Browse files
rexrex
committed
Major refactor of gem; Implemented config templates;
1 parent 1170006 commit 5b3780e

28 files changed

+714
-86
lines changed

‎Rakefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Jeweler::Tasks.new do |gem|
2323
gem.authors = ["Pierce Moore"]
2424
gem.executables = ['ssh_builder']
2525
gem.require_paths = ["lib"]
26-
gem.files = Dir.glob("lib/**/*.rb")
26+
gem.files = Dir.glob("lib/**/*.{rb,mustache}")
2727
# dependencies defined in Gemfile
2828
end
2929
Jeweler::RubygemsDotOrgTasks.new

‎bin/ssh_builder

+2-7
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,4 @@
11
#!/usr/bin/env ruby
22

3-
require 'ssh_builder/autoload'
4-
5-
$Log = SshBuilder::Log.new(STDOUT)
6-
$Log.debug("ARGV: #{ARGV}")
7-
8-
app = SshBuilder::App.new
9-
app.init
3+
require 'ssh_builder/utils/autoload'
4+
SshBuilder::App.boot

‎lib/build_script.rb

+247
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,247 @@
1+
#!/usr/bin/env ruby
2+
3+
class EnvMissing < Exception
4+
end
5+
6+
begin
7+
require 'colorize'
8+
require 'optparse'
9+
require 'aws-sdk'
10+
require 'fileutils'
11+
raise EnvMissing unless ENV['YOUTOO_AWS_ACCESS_KEY']
12+
raise EnvMissing unless ENV['YOUTOO_AWS_SECRET_KEY']
13+
rescue LoadError
14+
puts "Running this program requires the following gems to be installed:
15+
- colorize
16+
- aws-sdk
17+
Fix this problem by installing the gems with this command:
18+
gem install colorize aws-sdk
19+
"
20+
exit 1
21+
rescue EnvMissing
22+
puts "This program requires two environment variables be set and valid:
23+
YOUTOO_AWS_ACCESS_KEY
24+
YOUTOO_AWS_SECRET_KEY
25+
Add these keys with their proper values to your .zshrc/.bashrc, open a new tab, and try again."
26+
exit 1
27+
end
28+
29+
$ec2 = AWS::EC2.new(
30+
:access_key_id => ENV['YOUTOO_AWS_ACCESS_KEY'],
31+
:secret_access_key => ENV['YOUTOO_AWS_SECRET_KEY']
32+
)
33+
34+
class SSHBuilder
35+
def initialize(opts)
36+
@backup_enabled = opts[:backup]
37+
@detailed = opts[:detailed]
38+
end
39+
40+
def log(msg)
41+
puts " #{'>'.green} #{msg.blue}"
42+
end
43+
44+
def pounds(n)
45+
output = ""
46+
n.times do
47+
output += "#"
48+
end
49+
50+
output
51+
end
52+
53+
def date
54+
Time.now.strftime("%F_%T")
55+
end
56+
57+
def config_path
58+
File.expand_path("~/.ssh/config")
59+
end
60+
61+
def personal_config_path
62+
"#{config_path}_personal"
63+
end
64+
65+
def backup_config_path
66+
"#{config_path}.sshbuilder_#{date}.backup"
67+
end
68+
69+
def get_name(instance)
70+
instance.tags.to_h.fetch('Name', '').to_s
71+
end
72+
73+
def tag_html(instance)
74+
tag_template = "
75+
# %{key}: %{val}"
76+
output = ""
77+
instance.tags.each do |key,val|
78+
output += tag_template % { key: key, val: val }
79+
end
80+
81+
output
82+
end
83+
84+
def header
85+
"#{pounds 40}
86+
# SSH Config
87+
#
88+
# Built on: %{date}
89+
#{pounds 40}
90+
91+
"
92+
end
93+
94+
def personal_config
95+
output = ""
96+
File.open(personal_config_path, "r") do |f|
97+
f.each_line do |line|
98+
output += "#{line}"
99+
end
100+
end
101+
102+
output
103+
end
104+
105+
def youtoo_config
106+
output = ""
107+
instance_template = "
108+
Host youtoo-%{host}
109+
HostName %{hostname}
110+
User ec2-user
111+
Port %{port}
112+
PasswordAuthentication no
113+
IdentityFile ~/.ssh/[email protected]
114+
"
115+
detailed_instance_template = "
116+
# Instance Name: %{host}
117+
# Instance ID: %{id}
118+
# Instance Type: %{type}
119+
# Launched: %{launch_time}
120+
# Availability Zone: %{availability_zone}
121+
# Tags: %{tags}
122+
Host youtoo-%{host}
123+
HostName %{hostname}
124+
User ec2-user
125+
Port %{port}
126+
PasswordAuthentication no
127+
IdentityFile ~/.ssh/[email protected]
128+
"
129+
region_template = "
130+
#{pounds 40}
131+
# Youtoo AWS Region: %{region} (%{count} instances)
132+
#{pounds 40}
133+
"
134+
135+
AWS.memoize do
136+
$ec2.regions.each do |region|
137+
log "Parsing region: #{region.name}"
138+
instance_count = region.instances.map(&:id).length
139+
140+
unless instance_count == 0
141+
log " - Found #{instance_count} instances"
142+
output += region_template % { region: region.name, count: instance_count }
143+
144+
region.instances.each do |instance|
145+
if instance.status == :running
146+
name = get_name(instance)
147+
148+
case name
149+
when "aspera-01"
150+
port = 33001
151+
when "storage-02"
152+
port = 46732
153+
else
154+
port = 22
155+
end
156+
157+
template = @detailed ? detailed_instance_template : instance_template
158+
output += template % {
159+
region: region.name,
160+
host: name,
161+
hostname: instance.ip_address,
162+
port: port,
163+
tags: tag_html(instance),
164+
id: instance.id,
165+
type: instance.instance_type,
166+
launch_time: instance.launch_time,
167+
availability_zone: instance.availability_zone
168+
}
169+
end
170+
end
171+
end
172+
end
173+
end
174+
175+
output
176+
end
177+
178+
def build_config
179+
log "Building SSH config file"
180+
@compiled_config = "#{header % {date: date}}
181+
#{pounds 60}
182+
# Personal SSH Config
183+
#{pounds 60}
184+
#{personal_config}
185+
186+
#{pounds 60}
187+
# Youtoo AWS Config
188+
#{pounds 60}
189+
#{youtoo_config}"
190+
log "SSH config file built"
191+
end
192+
193+
def do_config_backup
194+
log "Backing up existing config: #{config_path} > #{backup_config_path}"
195+
FileUtils.move config_path, backup_config_path
196+
log "Config backed up to #{backup_config_path}"
197+
end
198+
199+
def write_config
200+
log "Writing config to #{config_path}"
201+
File.open(config_path, "w") do |file|
202+
file.write(@compiled_config)
203+
end
204+
log "Config written to #{config_path}"
205+
end
206+
207+
def generate
208+
log "Generating SSH config (detailed: #{@detailed}, backup_enabled: #{@backup_enabled})"
209+
build_config
210+
do_config_backup if @backup_enabled
211+
write_config
212+
log "SSH config generated successfully!"
213+
end
214+
end
215+
216+
options = {
217+
detailed: false,
218+
backup: false
219+
}
220+
221+
opt_parser = OptionParser.new do |opts|
222+
opts.banner = "Usage: ruby build-ssh-config.rb [options]"
223+
224+
opts.on("-d","--detailed","Include detailed instance info") do |d|
225+
options[:detailed] = d
226+
end
227+
228+
opts.on("-b","--backup","Backup existing ~/.ssh/config") do |b|
229+
options[:backup] = b
230+
end
231+
232+
opts.on("-h","--help","Show this help message") do |h|
233+
puts opts
234+
exit 0
235+
end
236+
end
237+
238+
begin
239+
opt_parser.parse!
240+
rescue OptionParser::InvalidOption => e
241+
puts e
242+
puts opt_parser
243+
exit 1
244+
end
245+
246+
builder = SSHBuilder.new(options)
247+
builder.generate

‎lib/ssh_builder/app.rb

+42-5
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,48 @@
1+
require 'fileutils'
2+
require 'mustache'
3+
14
module SshBuilder
25
class App
3-
def initialize
4-
puts "Initializing ssh-builder"
5-
end
6+
class << self
7+
attr_reader :template_path, :runtime_path
8+
9+
@timestamp = Time.now.strftime("%F_%T")
10+
11+
def verbose?
12+
ARGV.include? "-v"
13+
end
14+
15+
def boot
16+
@runtime_path = File.expand_path('..', File.dirname(__FILE__))
17+
@template_path = File.expand_path('./templates', File.dirname(__FILE__) )
18+
$Log = SshBuilder::Utils::Log.new(STDOUT)
19+
$Log.debug("ARGV: #{ARGV}")
20+
$fs = SshBuilder::Utils::Fs.new
21+
22+
require 'ssh_builder/utils/step'
23+
require 'ssh_builder/utils/signals'
24+
25+
$config_paths = {
26+
:personal => File.expand_path("~/.ssh/config_personal"),
27+
:ssh => File.expand_path("~/.ssh/config"),
28+
:credentials => File.expand_path("~/.ssh_builder")
29+
}
30+
$credentials = SshBuilder::Credentials.new
31+
32+
$Log.info " > Personal config exists? #{SshBuilder::Config::Personal.exists?}"
33+
$Log.info " > Credentials config exists? #{SshBuilder::Config::Credentials.exists?}"
34+
$Log.info " > Ssh config exists? #{SshBuilder::Config::Ssh.exists?}"
35+
36+
Step.start("Testing Step")
37+
Step.complete
638

7-
def init
8-
puts "SshBuilder::App.init()"
39+
puts SshBuilder::Config::Credentials.generate({
40+
servers: [
41+
{ name: 'Server 1', ip: '123.123.123.123' },
42+
{ name: 'Server 2', ip: '123.123.123.123' }
43+
]
44+
})
45+
end
946
end
1047
end
1148
end

‎lib/ssh_builder/autoload.rb

-5
This file was deleted.

‎lib/ssh_builder/aws.rb

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
module SshBuilder
2+
class Aws
3+
def ec2(credentials)
4+
AWS::EC2.new(
5+
:access_key_id => credentials[:access_key_id],
6+
:secret_access_key => credentials[:secret_access_key]
7+
)
8+
end
9+
end
10+
end

‎lib/ssh_builder/config/config_provider.rb

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
module SshBuilder
2+
module Config
3+
class ConfigProvider
4+
class << self
5+
@location = nil
6+
@template = nil
7+
8+
def read
9+
$fs.read @location
10+
end
11+
12+
def write(data)
13+
$fs.write @location, @template.render
14+
end
15+
16+
def ensure
17+
$fs.generate_if_not_exists(@location, @template.render)
18+
end
19+
20+
def exists?
21+
$fs.exists? @location
22+
end
23+
24+
def debug
25+
{
26+
file: @template.template_file,
27+
path: @template.template_path,
28+
name: @template.template_name
29+
}.inspect
30+
end
31+
32+
def generate(data = {})
33+
@template.render(data)
34+
end
35+
end
36+
end
37+
end
38+
end

‎lib/ssh_builder/config/credentials.rb

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
module SshBuilder
2+
module Config
3+
class Credentials < ConfigProvider
4+
@location = $config_paths[:credentials]
5+
@template = SshBuilder::Templates::Credentials
6+
end
7+
end
8+
end

0 commit comments

Comments
 (0)