management 1.1 → 1.2

data/README.md

@@ -2,10 +2,18 @@
 
 Minimalist EC2 configuration & deployment tool.
 
-- Version: **1.1**
+- Version: **1.2**
 
 ![build status](https://travis-ci.org/sdegutis/management.svg?branch=master)
 
+#### Install
+
+`gem install management`
+
+#### Intro
+
+Read [this short blog post](http://sdegutis.github.io/2014/06/09/announcing-management/) for a brief summary of this project.
+
 #### Usage
 
 ```

data/lib/management.rb

@@ -5,8 +5,11 @@ require_relative 'management/helper'
 require_relative 'management/command'
 require_relative 'management/commands/create_server'
 require_relative 'management/commands/list_servers'
-require_relative 'management/commands/destroy_server'
+require_relative 'management/commands/destroy_servers'
 require_relative 'management/commands/start_server'
 require_relative 'management/commands/stop_server'
 require_relative 'management/commands/run_script'
 require_relative 'management/commands/ssh_server'
+require_relative 'management/commands/list_addresses'
+require_relative 'management/commands/attach_address'
+require_relative 'management/commands/open_console'

data/lib/management/command.rb

@@ -18,23 +18,33 @@ module Management
       self.class.name.split('::').last.
         gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
         gsub(/([a-z\d])([A-Z])/,'\1_\2').
-        tr("_", "-").
+        tr('_', '-').
         downcase
     end
 
     def help_string
       return sprintf("%20s ", self.command_name) + fn.parameters.map do |req, name|
-        name = "<#{name.to_s.sub('_name', '')}>"
-        req == :opt ? "[#{name}]" : name
+        name = '<' + name.to_s.sub(/_names?/, '') + '>'
+        case req
+        when :opt then '[' + name + ']'
+        when :rest then name + ' [...]'
+        else name
+        end
       end.join(' ')
     end
 
+    def true_arity
+      min = fn.parameters.take_while{|req, name| req == :req}.count
+      max = fn.parameters.count
+      max = Float::INFINITY if max > 0 && fn.parameters.last.first == :rest
+      min..max
+    end
+
     def call_with(args, error_handler)
-      num_all_args = fn.parameters.count
-      num_req_args = fn.arity
+      arity = self.true_arity
 
-      error_handler.call "not enough arguments" if args.count < num_req_args
-      error_handler.call "too many arguments"   if args.count > num_all_args
+      error_handler.call "not enough arguments" if args.count < arity.begin
+      error_handler.call "too many arguments"   if args.count > arity.end
 
       fn.call *args
     end

data/lib/management/commands/attach_address.rb

@@ -0,0 +1,20 @@
+require_relative '../command'
+
+module Management
+
+  class AttachAddress < Management::Command
+
+    include Management::Helper
+
+    def run(address_name, server_name)
+      address = get_address(address_name)
+      server = get_server(server_name)
+
+      puts "Attaching #{address_name} to #{server_name}..."
+      address.server = server
+      puts "Done."
+    end
+
+  end
+
+end

data/lib/management/commands/destroy_servers.rb

@@ -0,0 +1,27 @@
+require_relative '../command'
+
+module Management
+
+  class DestroyServers < Management::Command
+
+    include Management::Helper
+
+    def run(*server_names)
+      servers = server_names.map{|server_name| get_server(server_name)}
+
+      puts "You are about to delete the following servers:"
+      puts ['', *servers.map{ |server| " - #{server.name}" }, '', ''].join("\n")
+
+      print "Are you sure you want to do this? Type 'Yes' to continue, or anything else to abort: "
+      abort "Aborted." if $stdin.gets.chomp != 'Yes'
+
+      servers.each do |server|
+        puts "Destroying #{server.name}..."
+        server.destroy
+        puts "Done."
+      end
+    end
+
+  end
+
+end

data/lib/management/commands/list_addresses.rb

@@ -0,0 +1,31 @@
+require_relative '../command'
+
+module Management
+
+  class ListAddresses < Management::Command
+
+    include Management::Helper
+
+    def run()
+      servers = live_servers
+
+      cols = [
+        {size: 20, title: "IP",         fn: ->(addr){ addr.public_ip } },
+        {size: 20, title: "Server",     fn: ->(addr){ s = servers.find{|server| server.id == addr.server_id }; s ? s.name : "n/a" } },
+        {size: 30, title: "Name",       fn: ->(addr){ a = config[:addresses].find{|k, v| v == addr.public_ip}; a ? a.first : "n/a" } },
+        {size: 15, title: "Status",     fn: ->(addr){ s = servers.find{|server| server.id == addr.server_id }; s ? s.state : "n/a" } },
+      ]
+
+      format = cols.map{|c| "%-#{c[:size]}s"}.join("  ") + "\n"
+
+      send :printf, *([format].concat(cols.map{|c|c[:title]}))
+      send :printf, *([format].concat(cols.map{|c|'-' * c[:size]}))
+
+      cloud.addresses.each do |address|
+        send :printf, *([format].concat(cols.map{|c|c[:fn].call address}))
+      end
+    end
+
+  end
+
+end

data/lib/management/commands/open_console.rb

@@ -0,0 +1,16 @@
+require_relative '../command'
+
+module Management
+
+  class OpenConsole < Management::Command
+
+    include Management::Helper
+
+    def run()
+      require 'pry'
+      binding.pry
+    end
+
+  end
+
+end

data/lib/management/commands/run_script.rb

@@ -24,21 +24,28 @@ module Management
 
         case type.to_sym
         when :copy
-          copy_file(server, *data)
+          local_path, remote_path, opts = *data
+          puts "############ Copying #{local_path} -> #{remote_path}"
+
+          copy_file(server, local_path, remote_path, opts)
         when :run
-          run_remote_command(server, data)
-        end
+          cmd = data
+          puts "############ Running #{cmd}"
 
+          code = run_remote_command(server, cmd)
+          if code != 0
+            abort "Failed. Exit code: #{code}"
+          end
+        end
       end
 
+      puts "############ Success!"
     end
 
     def copy_file(server, local_path, remote_path, opts = nil)
       should_template = opts && opts[:template]
       custom_chown = opts && opts[:chown]
 
-      puts "Copying #{local_path} -> #{remote_path}"
-
       Dir.mktmpdir('management-file-dir') do |file_tmpdir|
 
         # copy to the fake "remote" path locally
@@ -63,27 +70,14 @@ module Management
           server.copy_file(local_tar_path, remote_tar_path)
           server.extract_tar(remote_tar_path)
           server.chown_r(remote_path, custom_chown) if custom_chown
-
         end
-
       end
-
     end
 
+    # returns error code
     def run_remote_command(server, cmd)
-      puts "Running #{cmd}"
-
       result = server.ssh("#{cmd}").first
-
-      if result.respond_to?(:status)
-        puts
-        puts "---------------------------"
-        if result.status == 0
-          puts "Success!"
-        else
-          puts "Failed. Exit code: #{result.status}"
-        end
-      end
+      return result.status
     end
 
     def missing_local_files(script)

data/lib/management/commands/start_server.rb

@@ -8,8 +8,9 @@ module Management
 
     def run(server_name)
       server = get_server(server_name)
+      puts "Starting #{server_name}..."
       server.start
-      puts "Started #{server_name}."
+      puts "Done."
     end
 
   end

data/lib/management/commands/stop_server.rb

@@ -8,8 +8,9 @@ module Management
 
     def run(server_name)
       server = get_server(server_name)
+      puts "Stopping #{server_name}..."
       server.stop
-      puts "Stopped #{server_name}."
+      puts "Done."
     end
 
   end

data/lib/management/helper.rb

@@ -25,8 +25,14 @@ module Management
       server
     end
 
+    def get_address(name)
+      addresses = cloud.addresses
+      ip = config[:addresses][name.to_sym] or invalid_selection "Invalid address: #{name}", config[:addresses].map(&:first)
+      addresses.find{|a| a.public_ip == ip} or abort "Could not find an address with the IP #{ip} (#{name})"
+    end
+
     def live_servers
-      cloud.servers.reject{ |s| s.state == 'terminated' }
+      cloud.servers.reject{ |s| s.state == 'terminated' || s.state == 'shutting-down' }
     end
 
     def config

data/lib/management/interpreter.rb

@@ -6,7 +6,7 @@ module Management
     commands = Management::Command.all
 
     parser = OptionParser.new do |opts|
-      opts.banner = "Usage: management [command] [args*]"
+      opts.banner = "Usage: management [command [arg ...]]"
       opts.separator('')
       opts.separator('Commands:')
       commands.each { |command| opts.separator command.help_string }

data/lib/management/version.rb

@@ -1,3 +1,3 @@
 module Management
-  VERSION = "1.1"
+  VERSION = "1.2"
 end

data/management.gemspec

@@ -18,9 +18,9 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'fog'
   s.add_dependency 'unf' # just to shut up the warnings
+  s.add_dependency 'pry'
 
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'pry'
   s.add_development_dependency 'fakefs'
   s.add_development_dependency 'rspec', '~> 3.0.0'
   s.add_development_dependency 'guard-rspec'

data/spec/main_spec.rb

@@ -40,6 +40,41 @@ describe 'management' do
 
   before { subject.define_singleton_method(:raw_yaml) { YAML.load(SampleConfig) } }
 
+  describe Management::Command do
+
+    describe "true arity" do
+
+      around(:each) { |example| timeout(0.05, &example) }
+
+      it "considers 1 required arg to have 1..1 arity" do
+        subject.define_singleton_method(:run){|x|}
+        expect(subject.true_arity).to eq 1..1
+      end
+
+      it "considers 2 required args to have 2..2 arity" do
+        subject.define_singleton_method(:run){|x, y|}
+        expect(subject.true_arity).to eq 2..2
+      end
+
+      it "considers 2 required args and one optinal arg to have 2..3 arity" do
+        subject.define_singleton_method(:run){|x, y, z = nil|}
+        expect(subject.true_arity).to eq 2..3
+      end
+
+      it "considers 2 required args and a final rest arg to have 2..Float::INFINITY arity" do
+        subject.define_singleton_method(:run){|x, y, *z|}
+        expect(subject.true_arity).to eq 2..Float::INFINITY
+      end
+
+      it "considers 1 required arg, one optional arg, and a final rest arg to have 1..Float::INFINITY arity" do
+        subject.define_singleton_method(:run){|x, y = nil, *z|}
+        expect(subject.true_arity).to eq 1..Float::INFINITY
+      end
+
+    end
+
+  end
+
   describe Management::Helper do
 
     subject { Object.new.extend Management::Helper }
@@ -217,9 +252,9 @@ describe 'management' do
 
   end
 
-  describe Management::DestroyServer do
+  describe Management::DestroyServers do
 
-    let(:server) { double "server" }
+    let(:server) { double "server", name: "server-1" }
     before { allow(subject).to receive(:get_server).with("server-1").and_return(server) }
 
     it "destroys the given server if you type 'Yes' verbatim" do
@@ -230,13 +265,13 @@ describe 'management' do
     it "does not destroy the given server if you don't type 'Yes' verbatim" do
       expect(server).not_to receive(:destroy)
       without_stdout do
-        with_stdin("yes\n") { subject.run("server-1") }
-        with_stdin("Y\n") { subject.run("server-1") }
-        with_stdin("y\n") { subject.run("server-1") }
-        with_stdin("yep\n") { subject.run("server-1") }
-        with_stdin("\n") { subject.run("server-1") }
-        with_stdin("YES\n") { subject.run("server-1") }
-        with_stdin("Yes.\n") { subject.run("server-1") }
+        expect{with_stdin("yes\n" ) { subject.run("server-1") }}.to raise_error SystemExit
+        expect{with_stdin("Y\n"   ) { subject.run("server-1") }}.to raise_error SystemExit
+        expect{with_stdin("y\n"   ) { subject.run("server-1") }}.to raise_error SystemExit
+        expect{with_stdin("yep\n" ) { subject.run("server-1") }}.to raise_error SystemExit
+        expect{with_stdin("\n"    ) { subject.run("server-1") }}.to raise_error SystemExit
+        expect{with_stdin("YES\n" ) { subject.run("server-1") }}.to raise_error SystemExit
+        expect{with_stdin("Yes.\n") { subject.run("server-1") }}.to raise_error SystemExit
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: management
 version: !ruby/object:Gem::Version
-  version: '1.1'
+  version: '1.2'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-09 00:00:00.000000000 Z
+date: 2014-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
@@ -44,14 +44,14 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -60,7 +60,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -140,9 +140,12 @@ files:
 - lib/ext/fog.rb
 - lib/management.rb
 - lib/management/command.rb
+- lib/management/commands/attach_address.rb
 - lib/management/commands/create_server.rb
-- lib/management/commands/destroy_server.rb
+- lib/management/commands/destroy_servers.rb
+- lib/management/commands/list_addresses.rb
 - lib/management/commands/list_servers.rb
+- lib/management/commands/open_console.rb
 - lib/management/commands/run_script.rb
 - lib/management/commands/ssh_server.rb
 - lib/management/commands/start_server.rb

data/lib/management/commands/destroy_server.rb

@@ -1,25 +0,0 @@
-require_relative '../command'
-
-module Management
-
-  class DestroyServer < Management::Command
-
-    include Management::Helper
-
-    def run(server_name)
-      server = get_server(server_name)
-
-      print "Are you sure you want to do this? Type 'Yes' to continue, or anything else to abort: "
-      answer = $stdin.gets.chomp
-
-      if answer == 'Yes'
-        server.destroy
-        puts "Destroyed."
-      else
-        puts "Aborted."
-      end
-    end
-
-  end
-
-end