guignol 0.1.2.1 → 0.3.0

data/lib/guignol/commands/list.rb

@@ -1,60 +1,34 @@
-# Copyright (c) 2012, HouseTrip SA.
-# All rights reserved.
-# 
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met: 
-# 
-# 1. Redistributions of source code must retain the above copyright notice, this
-#    list of conditions and the following disclaimer. 
-# 2. Redistributions in binary form must reproduce the above copyright notice,
-#    this list of conditions and the following disclaimer in the documentation
-#    and/or other materials provided with the distribution. 
-# 
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
-# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-# 
-# The views and conclusions contained in the software and documentation are those
-# of the authors and should not be interpreted as representing official policies, 
-# either expressed or implied, of the authors.
-
 require 'guignol/commands/base'
-require 'guignol/instance'
-require 'term/ansicolor'
+
+Guignol::Shell.class_eval do
+  desc 'list [PATTERNS]', 'List the status of all known instances'
+  def list(*patterns)
+    patterns.push('.*') if patterns.empty?
+    Guignol::Commands::List.new(patterns).run
+  end
+end
 
 module Guignol::Commands
   class List < Base
-    def initialize(*argv)
-      argv = ['.*'] if argv.empty?
-      super(*argv)
-    end
+    private
 
-    def run_on_server(config)
-      instance = Guignol::Instance.new(config)
-      puts "%s:\t%s" % [instance.name, colorize(instance.state)]
+    def run_on_server(instance, options = {})
+      synchronize do
+        shell.say instance.name.ljust(@max_width + 1)
+        shell.say instance.state, colorize(instance.state)
+      end
     end
 
-    def self.short_usage
-      ["[regexp]", "List known instances (matching the regexp) and their status."]
+    def before_run(configs)
+      @max_width = configs.keys.map(&:size).max
     end
 
-  private
-
     def colorize(state)
       case state
-        when 'running'     then Term::ANSIColor.green(state)
-        when 'stopped'     then Term::ANSIColor.yellow(state)
-        when 'nonexistent' then Term::ANSIColor.red(state)
-        else state
+        when 'running'            then :green
+        when /starting|stopping/  then :yellow
+        when 'nonexistent'        then :red
       end
     end
   end
 end
-

data/lib/guignol/commands/start.rb

@@ -1,41 +1,22 @@
-# Copyright (c) 2012, HouseTrip SA.
-# All rights reserved.
-# 
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met: 
-# 
-# 1. Redistributions of source code must retain the above copyright notice, this
-#    list of conditions and the following disclaimer. 
-# 2. Redistributions in binary form must reproduce the above copyright notice,
-#    this list of conditions and the following disclaimer in the documentation
-#    and/or other materials provided with the distribution. 
-# 
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
-# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-# 
-# The views and conclusions contained in the software and documentation are those
-# of the authors and should not be interpreted as representing official policies, 
-# either expressed or implied, of the authors.
 
 require 'guignol/commands/base'
-require 'guignol/instance'
+require 'guignol/models/instance'
 
-module Guignol::Commands
-  class Start < Base
-    def run_on_server(config)
-      Guignol::Instance.new(config).start
+Guignol::Shell.class_eval do
+  desc 'start PATTERNS', 'Start all instances matching PATTERNS, attach their volumes, and setup DNS records'
+  def start(*patterns)
+    if patterns.empty?
+      raise Thor::Error.new('You must specify at least one PATTERN.')
     end
+    Guignol::Commands::Start.new(patterns).run
+  end
+end
 
-    def self.short_usage
-      ["<regexps>", "Start instances (unless they're running) and setup DNS"]
+
+module Guignol::Commands
+  class Start < Base
+    def run_on_server(instance, options = {})
+      instance.start
     end
   end
 end

data/lib/guignol/commands/stop.rb

@@ -1,47 +1,28 @@
-# Copyright (c) 2012, HouseTrip SA.
-# All rights reserved.
-# 
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met: 
-# 
-# 1. Redistributions of source code must retain the above copyright notice, this
-#    list of conditions and the following disclaimer. 
-# 2. Redistributions in binary form must reproduce the above copyright notice,
-#    this list of conditions and the following disclaimer in the documentation
-#    and/or other materials provided with the distribution. 
-# 
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
-# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-# 
-# The views and conclusions contained in the software and documentation are those
-# of the authors and should not be interpreted as representing official policies, 
-# either expressed or implied, of the authors.
 
 require 'guignol/commands/base'
-require 'guignol/instance'
+require 'guignol/models/instance'
 
-module Guignol::Commands
-  class Stop < Base
-    def before_run
-      return true if @configs.empty?
-      names = @configs.map { |config| config[:name] }.join(", ")
-      confirm "Are you sure you want to stop servers #{names}"
+Guignol::Shell.class_eval do
+  desc 'stop PATTERNS', 'Stop all instances matching PATTERNS, and remove DNS records'
+  def stop(*patterns)
+    if patterns.empty?
+      raise Thor::Error.new('You must specify at least one PATTERN.')
     end
+    Guignol::Commands::Stop.new(patterns).run
+  end
+end
 
-    def run_on_server(config)
-      Guignol::Instance.new(config).stop
+
+module Guignol::Commands
+  class Stop < Base
+    def before_run(configs)
+      return true if configs.empty?
+      names = configs.keys.join(", ")
+      shell.yes? "Are you sure you want to stop servers #{names}? [y/N]", :cyan
     end
 
-    def self.short_usage
-      ["<regexps>", "Stop instances (if they're running) and remove DNS"]
+    def run_on_server(instance, options = {})
+      instance.stop
     end
   end
 end

data/lib/guignol/commands/uuid.rb

@@ -1,41 +1,28 @@
-# Copyright (c) 2012, HouseTrip SA.
-# All rights reserved.
-# 
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met: 
-# 
-# 1. Redistributions of source code must retain the above copyright notice, this
-#    list of conditions and the following disclaimer. 
-# 2. Redistributions in binary form must reproduce the above copyright notice,
-#    this list of conditions and the following disclaimer in the documentation
-#    and/or other materials provided with the distribution. 
-# 
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
-# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-# 
-# The views and conclusions contained in the software and documentation are those
-# of the authors and should not be interpreted as representing official policies, 
-# either expressed or implied, of the authors.
 
 require 'guignol/commands/base'
 require 'uuidtools'
 
-module Guignol::Commands
-  class UUID
-    def run
-      puts UUIDTools::UUID.random_create.to_s.upcase
+Guignol::Shell.class_eval do
+  desc 'uuid [COUNT]', 'Print random UUIDs'
+  method_option :count,
+    :aliases => %w(-c),
+    :type => :numeric, :default => 1,
+    :desc => 'Number of UUIDs to print'
+  def uuid
+    unless options[:count].kind_of?(Fixnum) && options[:count] > 0
+      raise Thor::Error.new('Count should be a positive integer')
     end
+    Guignol::Commands::UUID.new.run(options[:count])
+  end
+end
 
-    def self.short_usage
-      ["", "Return a brand new UUID"]
+
+module Guignol::Commands
+  class UUID
+    def run(count = 1)
+      count.times do
+        puts UUIDTools::UUID.random_create.to_s.upcase
+      end
     end
   end
 end

data/lib/guignol/configuration.rb

@@ -0,0 +1,43 @@
+
+require 'active_support'
+require 'active_support/core_ext/enumerable'
+require 'guignol'
+
+module Guignol::Configuration
+
+  def configuration
+    @configuration ||= load_config_file
+  end
+
+  private
+
+  def config_file_path
+    @config_file_path ||= [
+      Pathname.new(ENV['GUIGNOL_YML'] || '/var/nonexistent'),
+      Pathname.new('guignol.yml'),
+      Pathname.new('config/guignol.yml'),
+      Pathname.new(ENV['HOME']).join('.guignol.yml')
+    ].find(&:exist?)
+  end
+
+  # Load the config hash for the file, converting old (v0.2.0) Yaml config files.
+  def load_config_file
+    return {} if config_file_path.nil?
+    data = YAML.load(config_file_path.read)
+    return data unless data.kind_of?(Array)
+
+    # Convert the toplevel array to a hash. Same for arrays of volumes.
+    Guignol.logger.warn "Configuration file '#{config_file_path}' uses the old array format. Trying to load it."
+    raise "Instance config lacks :name" unless data.collect_key(:name).all?
+    result = data.index_by { |item| item.delete(:name) }
+    result.each_pair do |name, config|
+      next unless config[:volumes]
+      raise "Volume config lacks :name" unless config[:volumes].collect_key(:name).all?
+      config[:volumes] = config[:volumes].index_by { |item| item.delete(:name) }
+    end
+
+    return result
+  end
+
+  Guignol.extend(self)
+end

data/lib/guignol/connection.rb

@@ -0,0 +1,33 @@
+
+require 'fog'
+require 'active_support/core_ext/hash/slice'
+require 'active_support/core_ext/hash/reverse_merge'
+require 'guignol/configuration'
+
+module Guignol
+  # Pool Fog connections to minimize latency
+  module Connection
+    def self.get(options)
+      @connections ||= {}
+      @connections[options] ||= Fog::Compute.new(options)
+    end
+
+
+    private
+
+
+    # Find and return credentials
+    def credentials
+      if ENV['AWS_SECRET_KEY_ID'] && ENV['AWS_SECRET_ACCESS_KEY']
+        {
+          :aws_access_key_id     => ENV['AWS_SECRET_KEY_ID'],
+          :aws_secret_access_key => ENV['AWS_SECRET_ACCESS_KEY']
+        }
+      else
+        Guignol.configuration.slice(:aws_access_key_id, :aws_secret_access_key)
+      end
+    end
+
+
+  end
+end

data/lib/guignol/env.rb

@@ -0,0 +1,19 @@
+module Guignol
+  def env
+    @env ||= Env.new
+  end
+
+  private
+
+  class Env
+    def initialize
+      @env = ENV['GUIGNOL_ENV'] || 'development'
+    end
+
+    def test?
+      @env == 'test'
+    end
+  end
+
+  Guignol.extend(self)
+end

data/lib/guignol/logger.rb

@@ -0,0 +1,29 @@
+require 'logger'
+
+module Guignol::Logger
+  def logger
+    @logger ||= ::Logger.new(logger_file).tap do |logger|
+      logger.progname = 'guignol'
+      logger.formatter = Formatter.new
+    end
+  end
+
+
+  private
+
+  class Formatter < ::Logger::Formatter
+    Format = "[%s] %s: %s\n"
+
+    def call(severity, time, progname, msg)
+      Format % [time.strftime('%F %T'), severity, msg2str(msg)]
+    end
+  end
+
+
+  def logger_file
+    return File.open(ENV['GUIGNOL_LOG'] ,'a') if ENV['GUIGNOL_LOG'] 
+    $stdout.tty? ? $stdout : File.open('/dev/null','w')  
+  end
+
+  Guignol.extend(self)
+end

data/lib/guignol/models/base.rb

@@ -0,0 +1,125 @@
+
+require 'guignol/connection'
+require 'guignol/tty_spinner'
+
+module Guignol::Models
+  class Base
+    # The wrapped instance, volume, etc we're manipulating
+    attr :subject
+    attr :options
+    attr :connection
+    attr :name
+
+    def initialize(name, options)
+      @name    = name
+      @options = default_options.merge(options)
+      require_name!
+      require_options! :uuid
+      connection_options = Guignol::DefaultConnectionOptions.merge @options.slice(:region)
+
+      @connection = Guignol::Connection.get(connection_options)
+      @subject = find_subject
+    end
+
+
+    def exist?
+      !!@subject
+    end
+    alias_method :exists?, :exist?
+
+
+    def uuid
+      @options[:uuid]
+    end
+
+
+    def state
+      @subject and @subject.state or 'nonexistent'
+    end
+
+
+    protected
+
+
+    def set_subject(subject)
+      @subject = subject
+    end
+
+
+    def reload
+      @subject = find_subject
+    end
+
+
+    def find_subject
+      raise 'Define me in a subclass'
+    end
+
+
+    Interval = 200e-3
+    Timeout  = 300
+
+
+    def default_options
+      {}
+    end
+
+    def log(message, options={})
+      Guignol.logger.info("#{name}: #{message}")
+      if e = options[:error]
+        Guignol.logger.info e.class.name
+        Guignol.logger.info e.message
+        e.backtrace.each { |line| Guignol.logger.debug line }
+      end
+      Thread.pass
+      true
+    end
+
+
+    def subject_name
+      self.class.name.gsub(/.*:/,'').downcase
+    end
+
+
+    # wait until the subject is in one of +states+
+    def wait_for_state(*states)
+      exist? or raise "#{subject_name} doesn't exist"
+      original_state = state
+      return if states.include?(original_state)
+      log "waiting for #{subject_name} to become #{states.join(' or ')}..."
+      Fog.wait_for(Timeout,Interval) do
+        Guignol::TtySpinner.spin!
+        reload
+        if state != original_state
+          log "#{subject_name} now #{state}"
+          original_state = state
+        end
+        states.include?(state)
+      end
+    end
+
+
+    def wait_for(&block)
+      return unless @subject
+      @subject.wait_for(Timeout,Interval) { Guignol::TtySpinner.spin! ; block.call }
+    end
+
+
+    def confirm(message)
+      puts "#{message} [y/n]"
+      $stdin.gets =~ /^y$/i
+    end
+
+    def require_name!
+      return unless @name.nil? || @name =~ /^\s*$/
+      raise "Name cannot be empty or blank"
+    end
+
+    def require_options!(*required_options)
+      required_options.each do |required_option|
+        next if @options.include?(required_option)
+        raise "option '#{required_option}' is mandatory for each #{subject_name}"
+      end
+    end
+  end
+end