berta 1.6.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e3d5595d6f87b950bd563bf4131046970d8697d
-  data.tar.gz: f05ff671fa9187a3b6f18a366b312e893ea50fe2
+  metadata.gz: fe77a2da93232291aabe8c6d12e3eeda3c739744
+  data.tar.gz: 93770cebde1409fcf7c20f36329f5728b05768e2
 SHA512:
-  metadata.gz: 21df07bb8eb98444a58e5c30fe78e38805ea9816411f912a418439571bc556e620460701c27cd833f97f3a4f3c6df745433dcc24e2b99d1c58ac04010b310bf2
-  data.tar.gz: 8f66e09d3f8e66e5b3870fc7c528fd9fcd79db8c7ec6aef49ea59419f30a0e5cfc5e8891e7db6994187d5dcd271e7f188fbb06b03f56bc4ae8136f18e8b0a154
+  metadata.gz: c928e9fcb19dac4de670aeba0a3ef82b409b6ba27e76db22ee6bdc47c79e6e1cd4143ec22d5b309ecb746395d83a29aded0aee9d75a2d136ae1ff05a0b1ab86a
+  data.tar.gz: 21184a21e33aee401b61a79c6720f6ccfbff2522080fdf5d075534a0d7c4aa6cc9400b2fdbed3f725d7a36845b98ccccb16110c8470721798c3375025c42cb51

data/.rubocop.yml

@@ -1,7 +1,7 @@
 require: rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.0
+  TargetRubyVersion: 2.1
 
 Metrics/LineLength:
   Max: 135
@@ -17,6 +17,11 @@ Metrics/BlockLength:
     - '**/*.rake'
     - 'spec/**/*.rb'
     - '*.gemspec'
+
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/berta/cli.rb'
+
 Metrics/AbcSize:
   Max: 20
   Exclude:

data/README.md

@@ -1,3 +1,7 @@
+<p align="center">
+  <img alt="Berta" src="http://i.imgur.com/tGCcsEU.png" width="500"/>
+</p>
+
 # Berta
 
 [![Build Status](https://travis-ci.org/dudoslav/berta.svg?branch=master)](https://travis-ci.org/dudoslav/berta)

data/berta.gemspec

@@ -1,5 +1,3 @@
-# coding: utf-8
-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'berta/version'
@@ -20,20 +18,20 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   s.add_development_dependency 'bundler', '~> 1.13'
+  s.add_development_dependency 'coveralls', '~> 0.8'
+  s.add_development_dependency 'pry', '~> 0.10'
   s.add_development_dependency 'rake', '~> 11.2'
   s.add_development_dependency 'rspec', '~> 3.5'
   s.add_development_dependency 'rubocop', '~> 0.42'
   s.add_development_dependency 'rubocop-rspec', '~> 1.7'
-  s.add_development_dependency 'pry', '~> 0.10'
-  s.add_development_dependency 'webmock', '~> 2.3'
   s.add_development_dependency 'vcr', '~> 3.0'
-  s.add_development_dependency 'coveralls', '~> 0.8'
+  s.add_development_dependency 'webmock', '~> 2.3'
 
-  s.add_runtime_dependency 'thor', '~> 0.19'
-  s.add_runtime_dependency 'settingslogic', '~> 2.0'
-  s.add_runtime_dependency 'yell', '~> 2.0'
-  s.add_runtime_dependency 'opennebula', '~> 5.2'
   s.add_runtime_dependency 'chronic_duration', '~> 0.10'
   s.add_runtime_dependency 'mail', '~> 2.6'
+  s.add_runtime_dependency 'opennebula', '~> 5.2'
+  s.add_runtime_dependency 'settingslogic', '~> 2.0'
+  s.add_runtime_dependency 'thor', '~> 0.19'
   s.add_runtime_dependency 'tilt', '~> 2.0'
+  s.add_runtime_dependency 'yell', '~> 2.0'
 end

data/config/berta.yml

@@ -18,3 +18,4 @@ berta:
     level: error                   # Logging level
   dry-run: false                   # Berta won't change anything on running instance of OpenNebula
   debug: false                     # Debug mode
+  email-template:                  # Email template to use for notification

data/config/email.erb

@@ -1,15 +1,16 @@
 <%# Available parameters: %>
-<%# [String] user_name   %>
-<%# [String] user_email  %>
+<%# [String] name   %>
+<%# [String] email  %>
+<%# [String] type  %>
 <%# [Array<Hash>] vms, Array of Hashes with values: %>
 <%# 	[String] id  %>
 <%# 	[String] name  %>
 <%# 	[String] expiration  %>
 From: cesnet@mail.muni.cz
-To: <%= user_email %>
+To: <%= email %>
 Subject: OpenNebula VM expiration
 
-Hi <%= user_name %>,
+Hi <%= name %>,
 your vms are about to expire..
 
 VM Name | Expiration Date

data/lib/berta.rb

@@ -3,7 +3,8 @@ module Berta
   autoload :Service, 'berta/service'
   autoload :Exclusions, 'berta/exclusions'
   autoload :VirtualMachineHandler, 'berta/virtual_machine_handler'
-  autoload :UserHandler, 'berta/user_handler'
+  autoload :EntityHandler, 'berta/entity_handler'
+  autoload :Notification, 'berta/notification'
   autoload :CommandExecutor, 'berta/command_executor'
   autoload :CLI, 'berta/cli'
   autoload :Errors, 'berta/errors'

data/lib/berta/cli.rb

@@ -59,19 +59,30 @@ module Berta
     class_option :debug,
                  default: safe_fetch(%w[debug]),
                  type: :boolean
+    class_option :'email-template',
+                 required: true,
+                 default: safe_fetch(%w[email-template]),
+                 type: :string
 
     desc 'cleanup', 'Task that sets all expiration to all vms and notifies users'
     def cleanup
       initialize_configuration(options)
       initialize_logger(options)
+      initialize_email
       Berta::CommandExecutor.new.cleanup
     end
 
-    desc 'version', 'Prints berta version'
+    desc 'version', 'Prints Berta version'
     def version
       $stdout.puts Berta::VERSION
     end
 
+    desc 'config', 'Prints Berta config values'
+    def config
+      initialize_configuration(options)
+      Berta::Settings.each { |key, val| $stdout.puts "#{key}\t=\t#{val}" }
+    end
+
     default_task :cleanup
 
     private
@@ -92,6 +103,7 @@ module Berta
       settings['debug'] = options['debug']
       settings['logging']['file'] = options['logging-file']
       settings['logging']['level'] = options['logging-level']
+      settings['email-template'] = options['email-template']
       Berta::Settings.merge!(settings)
     end
 
@@ -104,7 +116,7 @@ module Berta
 
       setup_file_logger(options['logging-file']) if options['logging-file']
 
-      logger.debug 'Running in debug mode...'
+      logger.debug { 'Running in debug mode...' }
     end
 
     def setup_file_logger(logging_file)
@@ -114,5 +126,9 @@ module Berta
       end
       logger.adapter :file, logging_file
     end
+
+    def initialize_email
+      Mail.defaults { delivery_method :sendmail }
+    end
   end
 end

data/lib/berta/command_executor.rb

@@ -1,21 +1,6 @@
-require 'erb'
-require 'tilt'
-require 'mail'
-
 module Berta
   # Class for executing main berta commands
   class CommandExecutor
-    def initialize
-      email_file = 'email.erb'.freeze
-      email_template_path = "#{File.dirname(__FILE__)}/../../config/#{email_file}"
-      email_template_path = "/etc/berta/#{email_file}" \
-        if File.exist?("/etc/berta/#{email_file}")
-      email_template_path = "#{ENV['HOME']}/.berta/#{email_file}" \
-        if File.exist?("#{ENV['HOME']}/.berta/#{email_file}")
-      @email_template = Tilt.new(email_template_path)
-      Mail.defaults { delivery_method :sendmail }
-    end
-
     # Function that performs clean up operation.
     # Connects to opennebula database,
     # runs expiration update process and
@@ -25,8 +10,10 @@ module Berta
                                    Berta::Settings['opennebula']['endpoint'])
       vms = service.running_vms
       users = service.users
+      groups = service.groups
       vms.each(&:update)
-      users.each { |user| user.notify(service.user_vms(user), @email_template) }
+      users.each { |user| user.notify(service.user_vms(user)) }
+      groups.each { |group| group.notify(service.group_vms(group)) }
     rescue Berta::Errors::BackendError => e
       logger.error e.message
     end

data/lib/berta/entities/expiration.rb

@@ -41,13 +41,13 @@ module Berta
       #
       # @return [String] Schelude action template
       def template
-        <<-EOT
+        <<-VM_TEMPLATE
       SCHED_ACTION = [
           ID     = "#{id}",
           ACTION = "#{action}",
           TIME   = "#{time}"
       ]
-      EOT
+      VM_TEMPLATE
       end
 
       # Determines if this schelude action is in notification interval.

data/lib/berta/entity_handler.rb

@@ -0,0 +1,27 @@
+module Berta
+  # Class for handeling entities in OpenNebula
+  class EntityHandler
+    attr_reader :type, :name, :email, :id, :handle
+
+    def initialize(handle)
+      @handle = handle
+      @type = handle.class.name.split('::').last
+      @name = handle['NAME']
+      @email = handle['TEMPLATE/EMAIL']
+      @id = handle['ID']
+    end
+
+    def notify(vms)
+      notification = Berta::Notification.new(name, email, type)
+      to_notify = vms.keep_if(&:should_notify?)
+      if to_notify.empty?
+        logger.debug { "No notifications for #{type} #{name} with id #{id}" }
+        return
+      end
+      notification.notify(to_notify)
+      to_notify.each(&:update_notified)
+    rescue Berta::Errors::Entities::NoEmailError
+      logger.debug { "#{type} #{id} has no email, skipping" }
+    end
+  end
+end

data/lib/berta/errors/entities.rb

@@ -3,7 +3,7 @@ module Berta
     # Module for entity errors
     module Entities
       autoload :InvalidEntityXMLError, 'berta/errors/entities/invalid_entity_xml_error'
-      autoload :NoUserEmailError, 'berta/errors/entities/no_user_email_error'
+      autoload :NoEmailError, 'berta/errors/entities/no_email_error'
     end
   end
 end

data/lib/berta/errors/entities/{no_user_email_error.rb → no_email_error.rb}

@@ -1,7 +1,7 @@
 module Berta
   module Errors
     module Entities
-      class NoUserEmailError < Berta::Errors::StandardError; end
+      class NoEmailError < Berta::Errors::StandardError; end
     end
   end
 end

data/lib/berta/notification.rb

@@ -0,0 +1,34 @@
+require 'erb'
+require 'tilt'
+require 'mail'
+
+module Berta
+  # Class that encapsulates mailing functionality
+  class Notification
+    attr_accessor :name, :email, :template, :type
+
+    def initialize(name, email, type)
+      @type = type
+      @name = name
+      @email = email
+      @template = Tilt.new(Berta::Settings['email-template'])
+      raise Berta::Errors::Entities::NoEmailError, 'Notification requires email' \
+        unless email
+    end
+
+    def notify(vms)
+      text = template.render(Object.new, name: name, email: email, type: type, vms: vms_hash(vms))
+      logger.info "Sending mail to entity: #{name} on email: #{email}"
+      logger.debug { text }
+      Mail.new(text).deliver unless Berta::Settings['dry-run']
+    end
+
+    def vms_hash(vms)
+      vms.map do |vm|
+        { id: vm.handle['ID'],
+          name: vm.handle['NAME'],
+          expiration: vm.default_expiration.time.to_i }
+      end
+    end
+  end
+end

data/lib/berta/service.rb

@@ -61,7 +61,14 @@ module Berta
       user_pool = OpenNebula::UserPool.new(client)
       Berta::Utils::OpenNebula::Helper.handle_error { user_pool.info }
       logger.debug "Fetched users: #{user_pool.map(&:id)}"
-      user_pool.map { |user| Berta::UserHandler.new(user) }
+      user_pool.map { |user| Berta::EntityHandler.new(user) }
+    end
+
+    def groups
+      group_pool = OpenNebula::GroupPool.new(client)
+      Berta::Utils::OpenNebula::Helper.handle_error { group_pool.info }
+      logger.debug "Fetched groups: #{group_pool.map(&:id)}"
+      group_pool.map { |group| Berta::EntityHandler.new(group) }
     end
 
     # Return vms that belong to given user
@@ -70,7 +77,11 @@ module Berta
     # @param user [Berta::UserHandler] User to find vms for
     # @return [Array<Berta::VirtualMachineHandler>] VMs that belong to given user
     def user_vms(user)
-      running_vms.select { |vm| vm.handle['UID'] == user.handle['ID'] }
+      running_vms.select { |vm| vm.handle['UID'] == user.id }
+    end
+
+    def group_vms(group)
+      running_vms.select { |vm| vm.handle['GID'] == group.id }
     end
 
     # Fetch clusters from OpenNebula

data/lib/berta/version.rb

@@ -1,3 +1,3 @@
 module Berta
-  VERSION = '1.6.1'.freeze
+  VERSION = '2.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: berta
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Dusan Baran
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-09 00:00:00.000000000 Z
+date: 2017-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,89 +25,89 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.13'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.2'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.2'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.42'
+        version: '11.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.42'
+        version: '11.2'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.42'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.42'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -123,105 +123,105 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: chronic_duration
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
-  name: settingslogic
+  name: mail
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
-  name: yell
+  name: opennebula
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
-  name: opennebula
+  name: settingslogic
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: chronic_duration
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.19'
 - !ruby/object:Gem::Dependency
-  name: mail
+  name: tilt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: tilt
+  name: yell
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -258,11 +258,12 @@ files:
 - lib/berta/command_executor.rb
 - lib/berta/entities.rb
 - lib/berta/entities/expiration.rb
+- lib/berta/entity_handler.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/entities/no_email_error.rb
 - lib/berta/errors/opennebula.rb
 - lib/berta/errors/opennebula/authentication_error.rb
 - lib/berta/errors/opennebula/resource_not_found_error.rb
@@ -273,9 +274,9 @@ files:
 - lib/berta/errors/standard_error.rb
 - lib/berta/errors/wrong_filter_type_error.rb
 - lib/berta/exclusions.rb
+- lib/berta/notification.rb
 - lib/berta/service.rb
 - lib/berta/settings.rb
-- lib/berta/user_handler.rb
 - lib/berta/utils.rb
 - lib/berta/utils/exclude_filter.rb
 - lib/berta/utils/filter.rb
@@ -304,7 +305,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Berta VM expiration tool

data/lib/berta/user_handler.rb

@@ -1,56 +0,0 @@
-require 'mail'
-require 'erb'
-require 'tilt'
-
-module Berta
-  # Class for handeling user methods
-  class UserHandler
-    attr_reader :handle
-
-    # Initializes UserHandler object
-    #
-    # @param user [OpenNebula::User] User that will this
-    #   handle use
-    def initialize(user)
-      @handle = user
-    end
-
-    # Notifies user about all vms that are in notification interval
-    #
-    # @param user_vms [Array<Berta::VirtualMachineHandler>] All vms that belong to
-    #   this user
-    # @param email_template [Tilt::ERBTemplate] Email template
-    def notify(user_vms, email_template)
-      to_notify = user_vms.keep_if(&:should_notify?)
-      if to_notify.empty?
-        logger.debug "No notifications for user #{handle['NAME']}"
-        return
-      end
-      send_notification(to_notify, email_template)
-      user_vms.each(&:update_notified)
-    rescue ArgumentError, Berta::Errors::Entities::NoUserEmailError => e
-      logger.error e.message
-    end
-
-    def send_notification(user_vms, email_template)
-      user_email = handle['TEMPLATE/EMAIL']
-      user_name = handle['NAME']
-      raise Berta::Errors::Entities::NoUserEmailError, "User: #{user_name} with id: #{handle['ID']} has no email set" \
-        unless user_email
-      email_text = email_template.render(Hash, user_email: user_email, user_name: user_name, vms: vms_data(user_vms))
-      logger.info "Sending mail to user: #{user_name} on email: #{user_email}"
-      logger.debug email_text
-      Mail.new(email_text).deliver unless Berta::Settings['dry-run']
-    end
-
-    private
-
-    def vms_data(vms)
-      vms.map do |vm|
-        { id: vm.handle['ID'],
-          name: vm.handle['NAME'],
-          expiration: vm.default_expiration.time.to_i }
-      end
-    end
-  end
-end