berta 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ddb138a3a440ced8f3cac19a172dc852553bf6d7
-  data.tar.gz: d03578fdc338e243fa153094632a10e08f4e6925
+  metadata.gz: 0b948acea2bb242909ad1d4f48c7a63955fb26e4
+  data.tar.gz: 33ab8c9275003edea5335835ca89f680dd0fd2ed
 SHA512:
-  metadata.gz: 5d39ec846445b8e28c9431aded6a925de3ecc61fb520e1f959964ee8ad917856761f7186573def0e85b9587d6785f860c7fbd944f2e5e617695965c23e2a627b
-  data.tar.gz: 12b40d29cb3e5549fa9ad8299af378d5b9a9f8b05d4a8eb434b3f76e501237eff5a236c73cdef1588b189ad2478aeda1cb184305981eb9c8e31566540770c859
+  metadata.gz: d897e5502b897611794beb1e6ddbc29ca028171954ecf1ce8c548261c7055a0040550f925124a4cb6a1087138ca747abd715c948fcb46b9d4efa018d3e5e37d0
+  data.tar.gz: f3b22ce6b6eb4763503bbfe70476668bb100187a187da5facb82933da986f2b1bb41dc54c4b5bf72f5a49e7506cc71aa054e9b7d66b9acdfb290c7d5fc241040

data/.rubocop.yml

@@ -16,6 +16,7 @@ Metrics/BlockLength:
     - 'spec/**/*.rb'
     - '*.gemspec'
 Metrics/AbcSize:
+  Max: 20
   Exclude:
     - 'lib/berta/cli.rb'
 

data/lib/berta/exclusions.rb

@@ -0,0 +1,109 @@
+module Berta
+  # Class for Handeling berta exclusions
+  class Exclusions
+    # VM states that take resources
+    RESOURCE_STATES = %w(SUSPENDED POWEROFF CLONING).freeze
+    # Active state has some lcm states that should not expire
+    ACTIVE_STATE = 'ACTIVE'.freeze
+    # LCM states in which active state shouldn't expire
+    NON_RESOURCE_ACTIVE_LCM_STATES = %w(EPILOG SHUTDOWN STOP UNDEPLOY FAILURE).freeze
+
+    # Constructs Exclusions object.
+    #
+    # @param ids [Array<Numeric>] Ids of VM to exclude
+    # @param users [Array<String>] User names to exclude
+    # @param groups [Array<String>] Group names to exclude
+    # @param clusters [Array<OpenNebula::Cluster>] Clusters to exclude
+    def initialize(ids, users, groups, clusters)
+      @ids = ids
+      @users = users
+      @groups = groups
+      @clusters = clusters
+      log_exclusions
+    end
+
+    # Filters out excluded vms, and vms that doesn't take resources
+    #
+    # @param vmhs [Array<Berta::VirtualMachineHandler>] Array of VMs to filter
+    def filter!(vmhs)
+      filter_resources!(vmhs)
+      filter_ids!(vmhs)
+      filter_users!(vmhs)
+      filter_groups!(vmhs)
+      filter_clusters!(vmhs)
+      logger.debug "After excluding: #{vmhs.map { |vmh| vmh.handle.id }}"
+      vmhs
+    end
+
+    private
+
+    def log_exclusions
+      logger.debug "Excluded ids     : #{@ids}"
+      logger.debug "Excluded users   : #{@users}"
+      logger.debug "Excluded groups  : #{@groups}"
+      logger.debug "Excluded clusters: #{@clusters.map { |cluster| cluster['NAME'] }}"
+    end
+
+    def excluded_id?(vmh)
+      @ids.find { |id| vmh.handle['ID'].to_i == id.to_i } if vmh.handle['ID'] && @ids
+    end
+
+    def excluded_user?(vmh)
+      @users.find { |user| vmh.handle['UNAME'] == user } if vmh.handle['UNAME'] && @users
+    end
+
+    def excluded_group?(vmh)
+      @groups.find { |group| vmh.handle['GNAME'] == group } if vmh.handle['GNAME'] && @groups
+    end
+
+    def excluded_cluster?(vmh)
+      vmhcid = latest_cluster_id(vmh)
+      @clusters.find { |cluster| vmhcid == cluster['ID'] } if vmhcid && @clusters
+    end
+
+    def takes_resources?(vmh)
+      return true if RESOURCE_STATES.any? { |state| vmh.handle.state_str == state }
+      true if vmh.handle.state_str == ACTIVE_STATE &&
+              NON_RESOURCE_ACTIVE_LCM_STATES.none? { |state| vmh.handle.lcm_state_str.include? state }
+    end
+
+    def filter_ids!(vmhs)
+      deleted, keep = vmhs.partition { |vmh| excluded_id?(vmh) }
+      logger.debug "Excluding based on IDs. Excluded IDs            : #{deleted.map { |vmh| vmh.handle.id }}"
+      vmhs.replace(keep)
+      deleted
+    end
+
+    def filter_users!(vmhs)
+      deleted, keep = vmhs.partition { |vmh| excluded_user?(vmh) }
+      logger.debug "Excluding based on USERs. Excluded IDs          : #{deleted.map { |vmh| vmh.handle.id }}"
+      vmhs.replace(keep)
+      deleted
+    end
+
+    def filter_groups!(vmhs)
+      deleted, keep = vmhs.partition { |vmh| excluded_group?(vmh) }
+      logger.debug "Excluding based on GROUPs. Excluded IDs         : #{deleted.map { |vmh| vmh.handle.id }}"
+      vmhs.replace(keep)
+      deleted
+    end
+
+    def filter_clusters!(vmhs)
+      deleted, keep = vmhs.partition { |vmh| excluded_cluster?(vmh) }
+      logger.debug "Excluding based on CLUSTERs. Excluded IDs       : #{deleted.map { |vmh| vmh.handle.id }}"
+      vmhs.replace(keep)
+      deleted
+    end
+
+    def filter_resources!(vmhs)
+      keep, deleted = vmhs.partition { |vmh| takes_resources?(vmh) }
+      logger.debug "Excluding based on RESOURCE_STATEs. Excluded IDs: #{deleted.map { |vmh| vmh.handle.id }}"
+      vmhs.replace(keep)
+      deleted
+    end
+
+    def latest_cluster_id(vmh)
+      vmh.handle['HISTORY_RECORDS/HISTORY[last()]/CID']
+    end
+  end
+end

data/lib/berta/service.rb

@@ -3,13 +3,6 @@ require 'opennebula'
 module Berta
   # Berta service for communication with OpenNebula
   class Service
-    # VM states that take resources
-    RESOURCE_STATES = %w(SUSPENDED POWEROFF CLONING).freeze
-    # Active state has some lcm states that should not expire
-    ACTIVE_STATE = 'ACTIVE'.freeze
-    # LCM states in which active state shouldn't expire
-    NON_RESOURCE_ACTIVE_LCM_STATES = %w(EPILOG SHUTDOWN STOP UNDEPLOY FAILURE).freeze
-
     attr_reader :endpoint
     attr_reader :client
 
@@ -35,11 +28,13 @@ module Berta
     # @raise [Berta::Errors::OpenNebula::ResourceStateError]
     # @raise [Berta::Errors::OpenNebula::ResourceRetrievalError]
     def running_vms
-      logger.debug 'Fetching vms'
       vm_pool = OpenNebula::VirtualMachinePool.new(client)
       Berta::Utils::OpenNebula::Helper.handle_error { vm_pool.info_all }
-      vm_pool.map { |vm| Berta::VirtualMachineHandler.new(vm) }
-             .delete_if { |vmh| excluded?(vmh) || !takes_resources?(vmh) }
+      logger.debug "Fetched vms: #{vm_pool.map(&:id)}"
+      Berta::Exclusions.new(Berta::Settings.exclude.ids,
+                            Berta::Settings.exclude.users,
+                            Berta::Settings.exclude.groups,
+                            excluded_clusters).filter!(vm_pool.map { |vm| Berta::VirtualMachineHandler.new(vm) })
     end
 
     # Fetch users from OpenNebula
@@ -51,9 +46,9 @@ module Berta
     # @raise [Berta::Errors::OpenNebula::ResourceStateError]
     # @raise [Berta::Errors::OpenNebula::ResourceRetrievalError]
     def users
-      logger.debug 'Fetching users'
       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
     end
 
@@ -67,54 +62,23 @@ module Berta
     # @raise [Berta::Errors::OpenNebula::ResourceRetrievalError]
     def clusters
       return @cached_clusters if @cached_clusters
-      logger.debug 'Fetching clusters'
       cluster_pool = OpenNebula::ClusterPool.new(client)
       Berta::Utils::OpenNebula::Helper.handle_error { cluster_pool.info }
+      logger.debug "Fetched clusters: #{cluster_pool.map(&:id)}"
       @cached_clusters = cluster_pool
       cluster_pool
     end
 
     private
 
-    def excluded?(vmh)
-      excluded_id?(vmh) ||
-        excluded_user?(vmh) ||
-        excluded_group?(vmh) ||
-        excluded_cluster?(vmh)
-    end
-
-    def excluded_id?(vmh)
-      Berta::Settings.exclude.ids.find { |id| vmh.handle.id == id } \
-        if vmh.handle.id && Berta::Settings.exclude.ids
-    end
-
-    def excluded_user?(vmh)
-      Berta::Settings.exclude.users.find { |user| vmh.handle['UNAME'] == user } \
-        if vmh.handle['UNAME'] && Berta::Settings.exclude.users
-    end
-
-    def excluded_group?(vmh)
-      Berta::Settings.exclude.groups.find { |group| vmh.handle['GNAME'] == group } \
-        if vmh.handle['GNAME'] && Berta::Settings.exclude.groups
-    end
-
-    def excluded_cluster?(vmh)
-      return unless Berta::Settings.exclude.clusters
-      vmcid = latest_cluster_id(vmh)
-      vmcluster = clusters.find { |cluster| cluster['ID'] == vmcid }
-      return unless vmcluster
-      Berta::Settings.exclude.clusters.find { |name| vmcluster['NAME'] == name } \
-        if vmcluster['NAME']
-    end
-
-    def latest_cluster_id(vmh)
-      vmh.handle['HISTORY_RECORDS/HISTORY[last()]/CID']
-    end
-
-    def takes_resources?(vmh)
-      return true if RESOURCE_STATES.any? { |state| vmh.handle.state_str == state }
-      return true if vmh.handle.state_str == ACTIVE_STATE &&
-                     NON_RESOURCE_ACTIVE_LCM_STATES.none? { |state| vmh.handle.lcm_state_str.include? state }
+    def excluded_clusters
+      excluded = []
+      if Berta::Settings.exclude.clusters
+        clusters.each do |cluster|
+          excluded << cluster if Berta::Settings.exclude.clusters.find { |cname| cname == cluster['NAME'] }
+        end
+      end
+      excluded
     end
   end
 end

data/lib/berta/version.rb

@@ -1,3 +1,3 @@
 module Berta
-  VERSION = '1.3.0'.freeze
+  VERSION = '1.4.0'.freeze
 end

data/lib/berta/virtual_machine_handler.rb

@@ -13,8 +13,9 @@ module Berta
       @handle = vm
     end
 
-    # Sets NOTIFIED value in USER_TEMPLATE to current time
-    # as integer. After updating notified value
+    # Sets notified flag value in USER_TEMPLATE to default expiration
+    # time as integer. If VM has no default expiration nothing will
+    # be updated. After updating notified value
     # fetches data from opennebula database.
     #
     # @note This method modifies OpenNebula database
@@ -24,7 +25,9 @@ module Berta
     # @raise [Berta::Errors::OpenNebula::ResourceStateError]
     # @raise [Berta::Errors::OpenNebula::ResourceRetrievalError]
     def update_notified
-      notify_time = Time.now
+      exp = default_expiration
+      return unless exp
+      notify_time = exp.time
       logger.debug "Setting notified flag of VM with id #{handle['ID']} to #{notify_time}"
       return if Berta::Settings['dry-run']
       Berta::Utils::OpenNebula::Helper.handle_error do
@@ -33,27 +36,26 @@ module Berta
       end
     end
 
-    # Return NOTIFIED value from USER_TEMPLATE if it is set
+    # Return notified flag 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.
+    # @return [Numeric] Time of expiration that VM was notified about
     def notified
       time = handle["USER_TEMPLATE/#{NOTIFIED_FLAG}"]
       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.
+    # To be notified, VM musn't have the same notification
+    # time as default expiration time and must be 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
+      return false if notified == expiration.time.to_i
       expiration.in_notification_interval?
     end
 
@@ -66,7 +68,8 @@ module Berta
       template = ''
       exps.each { |exp| template += exp.template }
       return if template == ''
-      logger.debug "Setting multiple expirations on vm with id=#{handle['ID']} :\n#{template}"
+      logger.debug \
+        "Setting expirations on vm with id=#{handle['ID']} usr=#{handle['UNAME']} grp=#{handle['GNAME']} : #{template.delete("\n ")}"
       return if Berta::Settings['dry-run']
       Berta::Utils::OpenNebula::Helper.handle_error do
         handle.update(template, true)
@@ -96,7 +99,9 @@ module Berta
         .min { |exp| exp.time.to_i }
     end
 
-    # TODO
+    # Return first available SCHED_ACTION/ID
+    #
+    # @return [Numeric] Next sched action id
     def next_expiration_id
       elems = handle.retrieve_elements('USER_TEMPLATE/SCHED_ACTION/ID')
       return 0 unless elems

data/lib/berta.rb

@@ -1,6 +1,7 @@
 # Main Berta module
 module Berta
   autoload :Service, 'berta/service'
+  autoload :Exclusions, 'berta/exclusions'
   autoload :VirtualMachineHandler, 'berta/virtual_machine_handler'
   autoload :ExpirationManager, 'berta/expiration_manager'
   autoload :NotificationManager, 'berta/notification_manager'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: berta
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Dusan Baran
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-14 00:00:00.000000000 Z
+date: 2017-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -271,6 +271,7 @@ files:
 - lib/berta/errors/opennebula/stub_error.rb
 - lib/berta/errors/opennebula/user_not_authorized_error.rb
 - lib/berta/errors/standard_error.rb
+- lib/berta/exclusions.rb
 - lib/berta/expiration_manager.rb
 - lib/berta/notification_manager.rb
 - lib/berta/service.rb
@@ -300,7 +301,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Berta VM expiration tool