do_snapshot 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25e673a7db69593b0007d27f55f873b12b2efad6
-  data.tar.gz: 159359c4f15b5a85163b660b84e994c742f3cccd
+  metadata.gz: 0c4e8fd9920e0fb822c5f84dadf54aa6cf0a90b5
+  data.tar.gz: 26fa16b5c5e5a1ebb5d474e31467488fca1a3c07
 SHA512:
-  metadata.gz: bb017632d9bdcff73d39310c7d5754fd0579f3975d23f6e16824797e3cf2afc7dfeeb041d645db05df370e1dd45b37842b4150d0f02d5e9158a8577d8e51c566
-  data.tar.gz: 1ef277c08b234bc7925d9e797c85c1e3179d475512ee8debe4159bc4ec818ac274e596e30643f7c2551e92f46451ff5f9d748f86a3113e1ada5766084af401c0
+  metadata.gz: 8368fd230ea50254df7456a01a7e20199b8ee0d7a6937b7e036c11a8902206b7c0034f79ea7cb2f0b80d4621d48b6715c2f02b62b254e5bc01978fb54ae07b8a
+  data.tar.gz: 8139cdbee917477ecc0dea28a63c5d2fb07485e2f4f47781340959ba97fc94317b401c99f632685b8c37177cbaef35e585de39adad0818a5a4f0b12e996e1757

data/bin/do_snapshot

@@ -10,6 +10,6 @@ bin_file = Pathname.new(__FILE__).realpath
 # add self to libpath
 $LOAD_PATH.unshift File.expand_path('../../lib', bin_file)
 
-require 'do_snapshot/cli'
+require 'do_snapshot/runner'
 
-DoSnapshot::CLI.start(ARGV)
+DoSnapshot::Runner.new(ARGV.dup).execute!

data/lib/do_snapshot/adapter/abstract.rb

@@ -6,7 +6,7 @@ module DoSnapshot
     # Operating with Digital Ocean.
     #
     class Abstract
-      include DoSnapshot::Log
+      include DoSnapshot::Helpers
 
       attr_accessor :delay, :timeout
 
@@ -26,18 +26,18 @@ module DoSnapshot
 
       # Waiting for event exit
       def wait_event(id)
-        log.debug "Event Id: #{id}"
+        logger.debug "Event Id: #{id}"
         time = Time.now
         sleep(delay) until get_event_status(id, time)
       end
 
       def after_cleanup(droplet_id, droplet_name, snapshot, event)
         if !event
-          log.error "Destroy of snapshot #{snapshot.name} for droplet id: #{droplet_id} name: #{droplet_name} is failed."
+          logger.error "Destroy of snapshot #{snapshot.name} for droplet id: #{droplet_id} name: #{droplet_name} is failed."
         elsif event && !event.status.include?('OK')
-          log.error event.message
+          logger.error event.message
         else
-          log.debug "Snapshot name: #{snapshot.name} delete requested."
+          logger.debug "Snapshot name: #{snapshot.name} delete requested."
         end
       end
     end

data/lib/do_snapshot/adapter/digitalocean.rb

@@ -36,7 +36,7 @@ module DoSnapshot
         instance = droplet(id)
 
         if instance.status.include? 'active'
-          log.error 'Droplet is still running.'
+          logger.error 'Droplet is still running.'
         else
           power_on id
         end
@@ -85,10 +85,9 @@ module DoSnapshot
       end
 
       def check_keys
-        log.debug 'Checking DigitalOcean Id\'s.'
-        %w( DIGITAL_OCEAN_CLIENT_ID DIGITAL_OCEAN_API_KEY ).each do |key|
-          log.error "You must have #{key} in environment or set it via options." if ENV[key].blank?
-        end
+        logger.debug 'Checking DigitalOcean Id\'s.'
+        errors = %w( DIGITAL_OCEAN_CLIENT_ID DIGITAL_OCEAN_API_KEY ).map { |key| key if ENV[key].blank? }.compact
+        fail DoSnapshot::NoKeysError, "You must have #{errors.join(', ')} in environment or set it via options." if errors.size > 0
       end
 
       protected
@@ -96,7 +95,7 @@ module DoSnapshot
       # Set id's of Digital Ocean API.
       #
       def set_id
-        log.debug 'Setting DigitalOcean Id\'s.'
+        logger.debug 'Setting DigitalOcean Id\'s.'
         ::DigitaloceanC.client_id = ENV['DIGITAL_OCEAN_CLIENT_ID']
         ::DigitaloceanC.api_key = ENV['DIGITAL_OCEAN_API_KEY']
       end
@@ -115,7 +114,7 @@ module DoSnapshot
 
       def timeout?(id, time)
         return false unless (Time.now - time) > @timeout
-        log.debug "Event #{id} finished by timeout #{time}"
+        logger.debug "Event #{id} finished by timeout #{time}"
         true
       end
 
@@ -126,9 +125,9 @@ module DoSnapshot
         event = ::DigitaloceanC::Droplet.power_on(id)
         case event && event.status
         when 'OK'
-          log.info 'Power On has been requested.'
+          logger.info 'Power On has been requested.'
         else
-          log.error 'Power On failed to request.'
+          logger.error 'Power On failed to request.'
         end
       end
     end

data/lib/do_snapshot/adapter/digitalocean_v2.rb

@@ -42,7 +42,7 @@ module DoSnapshot
         instance = droplet(id)
 
         if instance.status && instance.status.include?('active')
-          log.error 'Droplet is still running.'
+          logger.error 'Droplet is still running.'
         else
           power_on id
         end
@@ -81,7 +81,7 @@ module DoSnapshot
           event = client.images.delete(id: snapshot)
 
           unless event.is_a?(TrueClass)
-            log.debug event
+            logger.debug event
             event = false
           end
 
@@ -90,16 +90,16 @@ module DoSnapshot
       end
 
       def check_keys
-        log.debug 'Checking DigitalOcean Access Token.'
+        logger.debug 'Checking DigitalOcean Access Token.'
         %w( DIGITAL_OCEAN_ACCESS_TOKEN ).each do |key|
-          log.error "You must have #{key} in environment or set it via options." if ENV[key].blank?
+          fail DoSnapshot::NoTokenError, "You must have #{key} in environment or set it via options." if ENV[key].blank?
         end
       end
 
       # Set id's of Digital Ocean API.
       #
       def set_id
-        log.debug 'Setting DigitalOcean Access Token.'
+        logger.debug 'Setting DigitalOcean Access Token.'
         @client = ::DropletKit::Client.new(access_token: ENV['DIGITAL_OCEAN_ACCESS_TOKEN'])
       end
 
@@ -107,9 +107,9 @@ module DoSnapshot
 
       def after_cleanup(droplet_id, droplet_name, snapshot, event)
         if !event
-          log.error "Destroy of snapshot #{snapshot} for droplet id: #{droplet_id} name: #{droplet_name} is failed."
+          logger.error "Destroy of snapshot #{snapshot} for droplet id: #{droplet_id} name: #{droplet_name} is failed."
         else
-          log.debug "Snapshot: #{snapshot} delete requested."
+          logger.debug "Snapshot: #{snapshot} delete requested."
         end
       end
 
@@ -118,7 +118,7 @@ module DoSnapshot
       #
       def get_event_status(id, time)
         if (Time.now - time) > @timeout
-          log.debug "Event #{id} finished by timeout #{time}"
+          logger.debug "Event #{id} finished by timeout #{time}"
           return true
         end
 
@@ -135,9 +135,9 @@ module DoSnapshot
         # noinspection RubyResolve
         event = client.droplet_actions.power_on(droplet_id: id)
         if event.status.include?('in-progress')
-          log.info 'Power On has been requested.'
+          logger.info 'Power On has been requested.'
         else
-          log.error 'Power On failed to request.'
+          logger.error 'Power On failed to request.'
         end
       end
     end

data/lib/do_snapshot/cli.rb

@@ -3,14 +3,14 @@ require 'thor'
 require 'do_snapshot'
 require_relative 'log'
 require_relative 'mail'
+require_relative 'helpers'
 require_relative 'command'
 
 module DoSnapshot
   # CLI is here
   #
   class CLI < Thor # rubocop:disable ClassLength
-    include DoSnapshot::Log
-    include DoSnapshot::Mail
+    include DoSnapshot::Helpers
 
     default_task :snap
 
@@ -22,6 +22,7 @@ module DoSnapshot
     def initialize(*args)
       super
 
+      setup_config
       set_logger
       set_mailer
 
@@ -158,11 +159,11 @@ module DoSnapshot
 
     def snap
       command.snap
+    rescue DoSnapshot::NoTokenError, DoSnapshot::NoKeysError => e
+      error_simple(e)
     rescue => e
       command.fail_power_off(e) if [SnapshotCreateError, DropletShutdownError].include?(e.class)
-      log.error e.message
-      backtrace(e) if options.include? 'trace'
-      send_error
+      error_with_backtrace(e)
     end
 
     desc 'version, -V', 'Shows the version of the currently installed DoSnapshot gem'
@@ -171,43 +172,60 @@ module DoSnapshot
     end
 
     no_commands do
+      def error_simple(e)
+        logger.error e.message
+        send_error
+        fail e
+      end
+
+      def error_with_backtrace(e)
+        logger.error e.message
+        backtrace(e) if options.include? 'trace'
+        send_error
+        fail e
+      end
+
       def command
-        @command ||= Command.new(options,
-                                 %w( log smtp mail trace digital_ocean_client_id digital_ocean_api_key digital_ocean_access_token ))
+        @command ||= Command.new(options, command_filter)
       end
 
       def update_command
-        command.load_options(options,
-                             %w( log smtp mail trace digital_ocean_client_id digital_ocean_api_key digital_ocean_access_token ))
+        command.load_options(options, command_filter)
+      end
+
+      def command_filter
+        %w( log smtp mail trace digital_ocean_client_id digital_ocean_api_key digital_ocean_access_token )
+      end
+
+      def setup_config # rubocop:disable Metrics/AbcSize
+        DoSnapshot.configure do |config|
+          config.logger = ::Logger.new(options['log']) if options['log']
+          config.logger_level = Logger::DEBUG if config.verbose
+          config.verbose = options['trace']
+          config.quiet = options['quiet']
+          config.mailer = Mail.new(opts: options['mail'], smtp: options['smtp'])
+        end
       end
 
       def set_mailer
-        Mail.load_options(opts: options['mail'], smtp: options['smtp'])
+        DoSnapshot.mailer = DoSnapshot.config.mailer
       end
 
       def send_error
-        return unless mailer.opts
+        return unless DoSnapshot.mailer.opts
 
-        Mail.opts[:subject] = 'Digital Ocean: Error.'
-        Mail.opts[:body] = 'Please check your droplets.'
+        DoSnapshot.mailer.opts[:subject] = 'Digital Ocean: Error.'
+        DoSnapshot.mailer.opts[:body] = 'Please check your droplets.'
         mailer.notify
       end
 
       def set_logger
-        Log.load_options(quiet: options['quiet'], verbose: options['trace'])
-        # Use Thor shell
-        Log.shell = shell unless options['quiet']
-        init_logger if options.include?('log')
-      end
-
-      def init_logger
-        Log.logger = Logger.new(options['log'])
-        Log.logger.level = Log.verbose ? Logger::DEBUG : Logger::INFO
+        DoSnapshot.logger = Log.new(shell: shell)
       end
 
       def backtrace(e)
         e.backtrace.each do |t|
-          log.error t
+          logger.error t
         end
       end
     end

data/lib/do_snapshot/command.rb

@@ -5,19 +5,18 @@ module DoSnapshot
   # Our commands live here :)
   #
   class Command # rubocop:disable ClassLength
-    include DoSnapshot::Log
-    include DoSnapshot::Mail
+    include DoSnapshot::Helpers
 
     def initialize(*args)
       load_options(*args)
     end
 
     def snap
-      log.info 'Start performing operations'
+      logger.info 'Start performing operations'
       work_with_droplets
-      log.info 'All operations has been finished.'
+      logger.info 'All operations has been finished.'
 
-      mailer.notify if notify && !quiet
+      mailer.notify if mailer && notify && !quiet
     end
 
     def fail_power_off(e)
@@ -41,28 +40,28 @@ module DoSnapshot
     end
 
     def stop_droplet(droplet)
-      log.debug 'Shutting down droplet.'
+      logger.debug 'Shutting down droplet.'
       api.stop_droplet(droplet.id) unless droplet.status.include? 'off'
     end
 
     # Trying to create a snapshot.
     #
     def create_snapshot(droplet) # rubocop:disable MethodLength,Metrics/AbcSize
-      log.info "Start creating snapshot for droplet id: #{droplet.id} name: #{droplet.name}."
+      logger.info "Start creating snapshot for droplet id: #{droplet.id} name: #{droplet.name}."
 
       today         = DateTime.now
       name          = "#{droplet.name}_#{today.strftime('%Y_%m_%d')}"
       # noinspection RubyResolve
       snapshot_size = api.snapshots(droplet).size
 
-      log.debug 'Wait until snapshot will be created.'
+      logger.debug 'Wait until snapshot will be created.'
 
       api.create_snapshot droplet.id, name
 
       snapshot_size += 1
 
-      log.info "Snapshot name: #{name} created successfully."
-      log.info "Droplet id: #{droplet.id} name: #{droplet.name} snapshots: #{snapshot_size}."
+      logger.info "Snapshot name: #{name} created successfully."
+      logger.info "Droplet id: #{droplet.id} name: #{droplet.name} snapshots: #{snapshot_size}."
 
       # Cleanup snapshots.
       cleanup_snapshots droplet, snapshot_size if clean
@@ -99,7 +98,7 @@ module DoSnapshot
     def work_with_droplets
       load_droplets
       dispatch_droplets
-      log.debug 'Working with list of DigitalOcean droplets'
+      logger.debug 'Working with list of DigitalOcean droplets'
       thread_chain
     end
 
@@ -107,7 +106,7 @@ module DoSnapshot
     # And store into object.
     #
     def load_droplets
-      log.debug 'Loading list of DigitalOcean droplets'
+      logger.debug 'Loading list of DigitalOcean droplets'
       self.droplets = api.droplets
     end
 
@@ -142,11 +141,11 @@ module DoSnapshot
     # Droplet instance must be powered off first!
     #
     def prepare_droplet(id, name)
-      log.debug "Droplet id: #{id} name: #{name} "
+      logger.debug "Droplet id: #{id} name: #{name} "
       droplet = api.droplet id
 
       return unless droplet
-      log.info "Preparing droplet id: #{droplet.id} name: #{droplet.name} to take snapshot."
+      logger.info "Preparing droplet id: #{droplet.id} name: #{droplet.name} to take snapshot."
       return if too_much_snapshots(droplet)
       thread_runner(droplet)
     end
@@ -165,7 +164,7 @@ module DoSnapshot
 
       warning_size(droplet.id, droplet.name, size)
 
-      log.debug "Cleaning up snapshots for droplet id: #{droplet.id} name: #{droplet.name}."
+      logger.debug "Cleaning up snapshots for droplet id: #{droplet.id} name: #{droplet.name}."
 
       api.cleanup_snapshots(droplet, size - keep - 1)
     rescue => e
@@ -176,7 +175,7 @@ module DoSnapshot
     #
     def warning_size(id, name, keep)
       message = "For droplet with id: #{id} and name: #{name} the maximum number #{keep} of snapshots is reached."
-      log.warn message
+      logger.warn message
       @notify = true
     end
   end

data/lib/do_snapshot/configuration.rb

@@ -0,0 +1,19 @@
+module DoSnapshot
+  # Configuration class. Used to share config across application.
+  #
+  class Configuration
+    attr_accessor :logger
+    attr_accessor :logger_level
+    attr_accessor :verbose
+    attr_accessor :quiet
+    attr_accessor :mailer
+
+    def initialize
+      @logger  = nil
+      @logger_level = Logger::INFO
+      @verbose = false
+      @quiet   = false
+      @mailer  = nil
+    end
+  end
+end

data/lib/do_snapshot/helpers.rb

@@ -0,0 +1,29 @@
+require_relative 'log'
+require_relative 'mail'
+
+module DoSnapshot
+  # Helpers for main class.
+  #
+  module Helpers
+    def logger
+      UniversalLogger
+    end
+
+    # UniversalLogger is a module to deal with singleton methods.
+    # Used to give classes access only for selected methods
+    #
+    module UniversalLogger
+      %w(debug info warn error fatal unknown).each do |name|
+        define_singleton_method(:"#{name}") { |*args, &block| DoSnapshot.logger.send(:"#{name}", *args, &block) }
+      end
+
+      def self.close
+        DoSnapshot.logger.close
+      end
+    end
+
+    def mailer
+      DoSnapshot.mailer
+    end
+  end
+end

data/lib/do_snapshot/log.rb

@@ -4,60 +4,65 @@ require 'logger'
 module DoSnapshot
   # Shared logger
   #
-  module Log
-    def log
-      UniversalLogger
+  class Log
+    attr_reader :shell
+    attr_accessor :quiet, :verbose
+    attr_writer :buffer, :instance
+
+    def initialize(options = {})
+      @verbose = DoSnapshot.config.verbose
+      @quiet   = DoSnapshot.config.quiet
+      options.each { |key, option| instance_variable_set(:"@#{key}", option) }
+      instance.level = DoSnapshot.config.logger_level if instance
     end
 
-    # UniversalLogger is module to deal with singleton methods.
-    # Used to give classes access only for selected methods
-    #
-    module UniversalLogger
-      %i(info warn error debug).each do |type|
-        define_singleton_method(type) { |message| Log.log type, message }
-      end
+    def instance
+      @instance ||= DoSnapshot.config.logger
     end
 
-    class << self
-      attr_accessor :logger, :shell, :quiet, :verbose
-      attr_writer   :buffer
+    def buffer
+      @buffer ||= %w()
+    end
 
-      def load_options(options = {})
-        options.each { |key, option| send("#{key}=", option) }
-      end
+    def shell=(shell)
+      @shell = shell unless quiet
+    end
 
-      def buffer
-        @buffer ||= %w()
-      end
+    def close
+      instance.close if instance
+    end
 
-      def log(type, message)
-        buffer << message
-        logger.send(type, message) if logger
+    %w(debug info warn error fatal unknown).each_with_index do |name, severity|
+      define_method(:"#{name}") { |*args, &block| log severity, *args, &block }
+    end
 
-        say message, color(type) unless print?(type)
-      end
+    def log(severity, message = nil, progname = nil, &block)
+      buffer << message
+      instance.add(severity, message, progname, &block) if instance
 
-      protected
+      say message, color(severity) unless print?(severity)
+    end
 
-      def print?(type)
-        (type == :debug && !verbose) || quiet
-      end
+    protected
 
-      def say(message, color)
-        shell.say message, color if shell
-      end
+    def print?(type)
+      (type == :debug && !verbose) || quiet
+    end
+
+    def say(message, color)
+      shell.say message, color if shell
+    end
 
-      def color(type)
-        case type
-        when :debug
-          :white
-        when :error
-          :red
-        when :warn
-          :yellow
-        else
-          :green
-        end
+    def color(severity)
+      case severity
+      when 0
+        :white
+      when 3
+        :red
+      when 2
+        :yellow
+      else
+        :green
       end
     end
   end