berta 1.0.0

data/lib/berta/utils/opennebula/helper.rb

@@ -0,0 +1,47 @@
+require 'opennebula'
+
+module Berta
+  module Utils
+    module OpenNebula
+      # Class designed to help with working with OpenNebula
+      class Helper
+        class << self
+          # Hash of errors that can be returned by opennebula
+          ERRORS = Hash.new(Berta::Errors::OpenNebula::ResourceRetrievalError)
+                       .update(::OpenNebula::Error::EAUTHENTICATION => Berta::Errors::OpenNebula::AuthenticationError,
+                               ::OpenNebula::Error::EAUTHORIZATION => Berta::Errors::OpenNebula::UserNotAuthorizedError,
+                               ::OpenNebula::Error::ENO_EXISTS => Berta::Errors::OpenNebula::ResourceNotFoundError,
+                               ::OpenNebula::Error::EACTION => Berta::Errors::OpenNebula::ResourceStateError)
+                       .freeze
+          # Handles OpenNebula error codes and turns them into exceptions
+          #
+          # @raise [Berta::Errors::OpenNebula::AuthenticationError]
+          # @raise [Berta::Errors::OpenNebula::UserNotAuthorizedError]
+          # @raise [Berta::Errors::OpenNebula::ResourceNotFoundError]
+          # @raise [Berta::Errors::OpenNebula::ResourceStateError]
+          # @raise [Berta::Errors::OpenNebula::ResourceRetrievalError]
+          def handle_error
+            unless block_given?
+              raise Berta::Errors::OpenNebula::StubError, 'OpenNebula service-wrapper was called without a block!'
+            end
+            return_value = yield
+            return return_value unless ::OpenNebula.is_error?(return_value)
+            raise decode_error(return_value.errno), return_value.message
+          end
+
+          # Decodes OpenNebula error codes into exceptions and returns them
+          #
+          # @param errno [OpenNebula::Error] Error code to turn into exception
+          # @return [Berta::Errors::OpenNebula::AuthenticationError]
+          # @return [Berta::Errors::OpenNebula::UserNotAuthorizedError]
+          # @return [Berta::Errors::OpenNebula::ResourceNotFoundError]
+          # @return [Berta::Errors::OpenNebula::ResourceStateError]
+          # @return [Berta::Errors::OpenNebula::ResourceRetrievalError]
+          def decode_error(errno)
+            ERRORS[errno]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/berta/virtual_machine_handler.rb

@@ -0,0 +1,120 @@
+module Berta
+  # Class for Berta operations on virtual machines
+  class VirtualMachineHandler
+    attr_reader :handle
+
+    # Constructs Virtual machine handler from given vm.
+    #
+    # @param vm [Berta::VirtualMachineHandler] VM that will
+    #   this handler use.
+    def initialize(vm)
+      @handle = vm
+    end
+
+    # Sets NOTIFIED value in USER_TEMPLATE to current time
+    # as integer. After updating notified value
+    # fetches data from opennebula database.
+    #
+    # @note This method modifies OpenNebula database
+    # @raise [Berta::Errors::OpenNebula::AuthenticationError]
+    # @raise [Berta::Errors::OpenNebula::UserNotAuthorizedError]
+    # @raise [Berta::Errors::OpenNebula::ResourceNotFoundError]
+    # @raise [Berta::Errors::OpenNebula::ResourceStateError]
+    # @raise [Berta::Errors::OpenNebula::ResourceRetrievalError]
+    def update_notified
+      logger.debug "Setting notified flag of #{handle['ID']} to #{Time.now.to_i}"
+      return if Berta::Settings['dry-run']
+      Berta::Utils::OpenNebula::Helper.handle_error do
+        handle.update("NOTIFIED = #{Time.now.to_i}", true)
+        handle.info
+      end
+    end
+
+    # Return NOTIFIED value from USER_TEMPLATE if it is set
+    # else nil.
+    #
+    # @return [Numeric] Time when notified was set else nil.
+    #   Time is in UNIX epoch time format.
+    def notified
+      time = handle['USER_TEMPLATE/NOTIFIED']
+      time.to_i if time
+    end
+
+    # Determines if VM meets criteria to be notified.
+    # To be notified, VM musn't be notified and
+    # must have expiration with valid expiration
+    # action in notification interval.
+    #
+    # @return [Boolean] If this vm should be notified.
+    #   True if vm should be notified else false.
+    def should_notify?
+      return false if notified
+      expiration = default_expiration
+      return false unless expiration
+      expiration.in_notification_interval?
+    end
+
+    # Adds schelude action to virtual machine. This command
+    # modifies USER_TEMPLATE of virtual machine. But does
+    # not delete old variables is USER_TEMPLATE.
+    #
+    # @note This method modifies OpenNebula database
+    # @param time [Numeric] Time when to notify user
+    # @param action [String] Action to perform on expiration
+    def add_expiration(time, action)
+      logger.debug "Setting expiration date of #{handle['ID']} to #{action} on #{time} with id #{next_sched_action_id}"
+      return if Berta::Settings['dry-run']
+      new_expiration = \
+        Berta::Entities::Expiration.new(next_sched_action_id,
+                                        time,
+                                        action)
+      update_expirations(expirations << new_expiration)
+    end
+
+    # Sets array of expirations to vm, rewrites all old ones.
+    # Receiving empty array wont change anything.
+    #
+    # @note This method modifies OpenNebula database
+    # @param exps [Array<Berta::Entities::Expiration>] Expirations to use
+    def update_expirations(exps)
+      template = ''
+      exps.each { |exp| template += exp.template }
+      logger.debug "Setting multiple expirations:\n#{template}"
+      return if Berta::Settings['dry-run']
+      Berta::Utils::OpenNebula::Helper.handle_error do
+        handle.update(template, true)
+        handle.info
+      end
+    end
+
+    # Returns array of expirations on vm. Expirations are
+    # classes from USER_TEMPLATE/SCHED_ACTION.
+    #
+    # @return [Array<Berta::Entities::Expiration>] All expirations on vm
+    def expirations
+      exps = []
+      handle.each('USER_TEMPLATE/SCHED_ACTION') \
+        { |saxml| exps.push(Berta::Entities::Expiration.from_xml(saxml)) }
+      exps
+    end
+
+    # Return default expiration, that means expiration with
+    # default expiration action that is in expiration offset interval
+    # and is closes to current date.
+    #
+    # @return [Berta::Entities::Expiration] Nearest default expiration else nil
+    def default_expiration
+      expirations
+        .find_all { |exp| exp.default_action? && exp.in_expiration_interval? }
+        .min { |exp| exp.time.to_i }
+    end
+
+    private
+
+    def next_sched_action_id
+      elems = handle.retrieve_elements('USER_TEMPLATE/SCHED_ACTION/ID')
+      return 0 unless elems
+      elems.to_a.max.to_i + 1
+    end
+  end
+end

metadata

@@ -0,0 +1,304 @@
+--- !ruby/object:Gem::Specification
+name: berta
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Dusan Baran
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.42'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.42'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: settingslogic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: yell
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: opennebula
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: chronic_duration
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Berta will check all VMs on OpenNebula cloud for expiration date
+email: dbaran@hotmail.sk
+executables:
+- berta
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- berta.gemspec
+- bin/berta
+- config/berta.yml
+- config/email.erb
+- lib/berta.rb
+- lib/berta/cli.rb
+- lib/berta/command_executor.rb
+- lib/berta/entities.rb
+- lib/berta/entities/expiration.rb
+- lib/berta/errors.rb
+- lib/berta/errors/backend_error.rb
+- lib/berta/errors/entities.rb
+- lib/berta/errors/entities/invalid_entity_xml_error.rb
+- lib/berta/errors/entities/no_user_email_error.rb
+- lib/berta/errors/opennebula.rb
+- lib/berta/errors/opennebula/authentication_error.rb
+- lib/berta/errors/opennebula/resource_not_found_error.rb
+- lib/berta/errors/opennebula/resource_retrieval_error.rb
+- lib/berta/errors/opennebula/resource_state_error.rb
+- lib/berta/errors/opennebula/stub_error.rb
+- lib/berta/errors/opennebula/user_not_authorized_error.rb
+- lib/berta/errors/standard_error.rb
+- lib/berta/expiration_manager.rb
+- lib/berta/notification_manager.rb
+- lib/berta/service.rb
+- lib/berta/settings.rb
+- lib/berta/utils.rb
+- lib/berta/utils/opennebula.rb
+- lib/berta/utils/opennebula/helper.rb
+- lib/berta/virtual_machine_handler.rb
+homepage: https://github.com/dudoslav/berta
+licenses:
+- Apache License, Version 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Berta VM expiration tool
+test_files: []