berta 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ce1338b8020499e9cae1605ddf66c0dad404aae
-  data.tar.gz: dea58173ca736a372e9b6a30f3b08a29efa282b7
+  metadata.gz: 1502060c465b5ab799d53bc8491473c8434f9ca1
+  data.tar.gz: db80f4d14ef9cbd0098fada264402b5e7bd84512
 SHA512:
-  metadata.gz: db63fd0e325e176bd390db3481f48b063077d21e5b0edd6db0d00498cd48a9b0b65a46fc4b205da9e59a2c189994fe39450809be103e4bd60247d4be0fc1fba5
-  data.tar.gz: 6e12df6f7cec8f294ed0893528208a317ac40695e51d12d765fdf7e70961234ab081e9449e08c8da4bade3f2314e86c2bb642dd81dc44ddb8e05711f94daf326
+  metadata.gz: 164b3296d94d8213d9c42556155af66c44d5620ee714536a423b5dc1843e0d63c7b5b5db25b200539f0e222a08a0eb513e45c2bb1ee9fd8ed7e85fc6d0ff220b
+  data.tar.gz: 2d42b4f6a2d2eb2ddabffbc34706977eedaad2c1672b46d9421e1219b72e784e5cc2c4ec6c48de156070377208fb804ab7c4a390d9cb1bf3af55dc1142bf4b9d

data/.rubocop.yml

@@ -8,6 +8,8 @@ Metrics/LineLength:
 
 Metrics/MethodLength:
   Max: 15
+  Exclude:
+   - 'lib/berta/cli.rb'
 
 Metrics/BlockLength:
   Exclude:
@@ -25,3 +27,6 @@ RSpec/MultipleExpectations:
 
 RSpec/ExampleLength:
   Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false

data/config/berta.yml

@@ -7,11 +7,12 @@ berta:
     action: terminate-hard         # Type of action that will be executed
   notification:
     deadline: 1 day                # Time when user should be notified before action will be executed
-  exclude:                         # Exclude VMs to ignore them
-    ids:                           # VMs with this IDs will be ignored
-    users:                         # VMs owned by this users will be ignored
-    groups:                        # VMs in this groups will be ignored
-    clusters:                      # VMs in this clusters will be ignored
+  filter:                          # Filter VMs in after fetch
+    type: exclude                  # Type of filter, options are include and exclude
+    ids:                           # VMs with this IDs will be used in filter
+    users:                         # VMs owned by this users will be used in filter
+    groups:                        # VMs in this groups will be used in filter
+    clusters:                      # VMs in this clusters will be used in filter
   logging:
     file: /var/log/berta/berta.log # File to write log to. To turn off file logging leave this field empty
     level: error                   # Logging level

data/lib/berta/cli.rb

@@ -31,17 +31,20 @@ module Berta
                  required: true,
                  default: safe_fetch(%w[notification deadline]),
                  type: :string
-    class_option :'exclude-ids',
-                 default: safe_fetch(%w[exclude ids]),
+    class_option :'filter-type',
+                 default: safe_fetch(%w[filter type]),
+                 type: :string
+    class_option :'filter-ids',
+                 default: safe_fetch(%w[filter ids]),
                  type: :array
-    class_option :'exclude-users',
-                 default: safe_fetch(%w[exclude users]),
+    class_option :'filter-users',
+                 default: safe_fetch(%w[filter users]),
                  type: :array
-    class_option :'exclude-groups',
-                 default: safe_fetch(%w[exclude groups]),
+    class_option :'filter-groups',
+                 default: safe_fetch(%w[filter groups]),
                  type: :array
-    class_option :'exclude-clusters',
-                 default: safe_fetch(%w[exclude clusters]),
+    class_option :'filter-clusters',
+                 default: safe_fetch(%w[filter clusters]),
                  type: :array
     class_option :'dry-run',
                  default: safe_fetch(%w[dry-run]),
@@ -80,10 +83,11 @@ module Berta
       settings['expiration']['offset'] = options['expiration-offset']
       settings['expiration']['action'] = options['expiration-action']
       settings['notification']['deadline'] = options['notification-deadline']
-      settings['exclude']['ids'] = options['exclude-ids']
-      settings['exclude']['users'] = options['exclude-users']
-      settings['exclude']['groups'] = options['exclude-groups']
-      settings['exclude']['clusters'] = options['exclude-clusters']
+      settings['filter']['type'] = options['filter-type']
+      settings['filter']['ids'] = options['filter-ids']
+      settings['filter']['users'] = options['filter-users']
+      settings['filter']['groups'] = options['filter-groups']
+      settings['filter']['clusters'] = options['filter-clusters']
       settings['dry-run'] = options['dry-run']
       settings['debug'] = options['debug']
       settings['logging']['file'] = options['logging-file']

data/lib/berta/command_executor.rb

@@ -1,5 +1,6 @@
 require 'erb'
 require 'tilt'
+require 'mail'
 
 module Berta
   # Class for executing main berta commands
@@ -12,6 +13,7 @@ module Berta
       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.
@@ -24,7 +26,6 @@ module Berta
       vms = service.running_vms
       users = service.users
       vms.each(&:update)
-      Mail.defaults { delivery_method :sendmail }
       users.each { |user| user.notify(service.user_vms(user), @email_template) }
     rescue Berta::Errors::BackendError => e
       logger.error e.message

data/lib/berta/errors/wrong_filter_type_error.rb

@@ -0,0 +1,5 @@
+module Berta
+  module Errors
+    class WrongFilterTypeError < StandardError; end
+  end
+end

data/lib/berta/errors.rb

@@ -2,6 +2,7 @@ module Berta
   # Module for Berta error classes
   module Errors
     autoload :StandardError, 'berta/errors/standard_error'
+    autoload :WrongFilterTypeError, 'berta/errors/wrong_filter_type_error'
     autoload :BackendError, 'berta/errors/backend_error'
     autoload :OpenNebula, 'berta/errors/opennebula'
     autoload :Entities, 'berta/errors/entities'

data/lib/berta/service.rb

@@ -6,6 +6,9 @@ module Berta
     attr_reader :endpoint
     attr_reader :client
 
+    FILTERS = { 'exclude' => Berta::Utils::ExcludeFilter,
+                'include' => Berta::Utils::IncludeFilter }.freeze
+
     # Initializes service object and connects to opennebula
     # backend. If both arguments are nil default ONE_AUTH
     # will be used.
@@ -15,6 +18,16 @@ module Berta
     def initialize(secret, endpoint)
       @endpoint = endpoint
       @client = OpenNebula::Client.new(secret, endpoint)
+      create_filter
+    end
+
+    def create_filter
+      filter = FILTERS[Berta::Settings.filter.type]
+      raise Berta::Errors::WrongFilterTypeError, "Wrong filter type: #{Berta::Settings.filter.type}" unless filter
+      @filter = filter.new(Berta::Settings.filter.ids,
+                           Berta::Settings.filter.users,
+                           Berta::Settings.filter.groups,
+                           filtered_clusters)
     end
 
     # Fetch running vms from OpenNebula and filter out vms that
@@ -32,10 +45,7 @@ module Berta
       vm_pool = OpenNebula::VirtualMachinePool.new(client)
       Berta::Utils::OpenNebula::Helper.handle_error { vm_pool.info_all }
       logger.debug "Fetched vms: #{vm_pool.map(&:id)}"
-      @cached_vms = 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) })
+      @cached_vms = @filter.run(vm_pool.map { |vm| Berta::VirtualMachineHandler.new(vm) })
       @cached_vms
     end
 
@@ -82,14 +92,9 @@ module Berta
 
     private
 
-    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
+    def filtered_clusters
+      return unless Berta::Settings.filter.clusters
+      clusters.select { |cluster| Berta::Settings.filter.clusters.find { |cname| cname == cluster['NAME'] } }
     end
   end
 end

data/lib/berta/utils/exclude_filter.rb

@@ -0,0 +1,15 @@
+module Berta
+  module Utils
+    # Filter that excludes vms in given params
+    class ExcludeFilter < Filter
+      # Overrides filter method to exclude vms
+      def filter(vmhs)
+        ide = filter_ids(vmhs)
+        usere = filter_users(vmhs)
+        groupe = filter_groups(vmhs)
+        clustere = filter_clusters(vmhs)
+        vmhs - ide - usere - groupe - clustere
+      end
+    end
+  end
+end

data/lib/berta/utils/filter.rb

@@ -0,0 +1,99 @@
+module Berta
+  module Utils
+    # Base Filter class, filters out invalid states
+    class Filter
+      # 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 Filter object.
+      #
+      # @param ids [Array<Numeric>] Ids of VM to filter
+      # @param users [Array<String>] User names to filter
+      # @param groups [Array<String>] Group names to filter
+      # @param clusters [Array<OpenNebula::Cluster>] Clusters to filter
+      def initialize(ids, users, groups, clusters)
+        @ids = ids || []
+        @users = users || []
+        @groups = groups || []
+        @clusters = clusters || []
+        logger.debug "Filter type: #{self.class}"
+        log_filter
+      end
+
+      # Execute this filter
+      #
+      # @param vmhs [Array<Berta::VirtualMachineHandler>] VMs to filter
+      # @return [Array<Berta::VirtualMachineHandler>] Filtered VMs
+      def run(vmhs)
+        fvmhs = vmhs.select { |vmh| takes_resources?(vmh) }
+        logger.debug "Filtered based on RESOURCE: #{(vmhs - fvmhs).map { |vmh| vmh.handle.id }}"
+        fvmhs = filter(fvmhs)
+        logger.debug "VMS after filter : #{fvmhs.map { |vmh| vmh.handle.id }}"
+        fvmhs
+      end
+
+      protected
+
+      # This method is for child classes to override.
+      # It is executed in `run` method.
+      #
+      # @param vmhs [Array<Berta::VirtualMachineHandler>] VMs without invalid states
+      # @return [Array<Berta::VirtualMachineHandler>] Filtered VMs
+      def filter(vmhs)
+        vmhs
+      end
+
+      # Gets latest cluster id on given VM
+      #
+      # @param vmh [Berta::VirtualMachineHandler] VM to get cluster id on
+      # @return [String] Latest cluster id
+      def latest_cluster_id(vmh)
+        vmh.handle['HISTORY_RECORDS/HISTORY[last()]/CID']
+      end
+
+      def filter_ids(vmhs)
+        idi = vmhs.select { |vmh| @ids.include?(vmh.handle['ID']) }
+        logger.debug "[#{self.class}] filtered based on IDs: #{idi.map { |vmh| vmh.handle.id }}"
+        idi
+      end
+
+      def filter_users(vmhs)
+        useri = vmhs.select { |vmh| @users.include?(vmh.handle['UNAME']) }
+        logger.debug "[#{self.class}] filtered based on USERs: #{useri.map { |vmh| vmh.handle.id }}"
+        useri
+      end
+
+      def filter_groups(vmhs)
+        groupi = vmhs.select { |vmh| @groups.include?(vmh.handle['GNAME']) }
+        logger.debug "[#{self.class}] filtered based on GROUPs: #{groupi.map { |vmh| vmh.handle.id }}"
+        groupi
+      end
+
+      def filter_clusters(vmhs)
+        cids = @clusters.map { |cluster| cluster['ID'] }
+        clusteri = vmhs.select { |vmh| cids.include?(latest_cluster_id(vmh)) }
+        logger.debug "[#{self.class}] filtered based on CLUSTERs: #{clusteri.map { |vmh| vmh.handle.id }}"
+        clusteri
+      end
+
+      private
+
+      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 log_filter
+        logger.debug "Filter ids     : #{@ids}"
+        logger.debug "Filter users   : #{@users}"
+        logger.debug "Filter groups  : #{@groups}"
+        logger.debug "Filter clusters: #{@clusters.map { |cluster| cluster['NAME'] }}"
+      end
+    end
+  end
+end

data/lib/berta/utils/include_filter.rb

@@ -0,0 +1,15 @@
+module Berta
+  module Utils
+    # Filter that includes vms in given params
+    class IncludeFilter < Filter
+      # Overrides filter method to include vms
+      def filter(vmhs)
+        idi        = filter_ids(vmhs)
+        useri      = filter_users(vmhs)
+        groupi     = filter_groups(vmhs)
+        clusteri   = filter_clusters(vmhs)
+        idi | useri | groupi | clusteri
+      end
+    end
+  end
+end

data/lib/berta/utils.rb

@@ -2,5 +2,8 @@ module Berta
   # Utility classes
   module Utils
     autoload :OpenNebula, 'berta/utils/opennebula'
+    autoload :Filter, 'berta/utils/filter'
+    autoload :ExcludeFilter, 'berta/utils/exclude_filter'
+    autoload :IncludeFilter, 'berta/utils/include_filter'
   end
 end

data/lib/berta/version.rb

@@ -1,3 +1,3 @@
 module Berta
-  VERSION = '1.4.1'.freeze
+  VERSION = '1.5.0'.freeze
 end

data/lib/berta/virtual_machine_handler.rb

@@ -93,6 +93,10 @@ module Berta
       time.to_i if time
     end
 
+    def ==(other)
+      handle.id == other.handle.id
+    end
+
     private
 
     # Sets array of expirations to vm, rewrites all old ones.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: berta
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Dusan Baran
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-04 00:00:00.000000000 Z
+date: 2017-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -271,11 +271,15 @@ 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/errors/wrong_filter_type_error.rb
 - lib/berta/exclusions.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
+- lib/berta/utils/include_filter.rb
 - lib/berta/utils/opennebula.rb
 - lib/berta/utils/opennebula/helper.rb
 - lib/berta/version.rb
@@ -300,7 +304,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Berta VM expiration tool