egi-fedcloud-vmhound 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7d2500d9814285384362ec97be8452dc5d93d0e
-  data.tar.gz: 30e2f5b8618fdebff446a5b11c975d2c209e5c9a
+  metadata.gz: 318e4b960de7c33ef26bdc80d47b2549e7990540
+  data.tar.gz: 6443cbdf45d2a17a90a73a5b7a0c0419a1641247
 SHA512:
-  metadata.gz: 3e04485f77b349d06f86276a2c3a7962608ca1b2a83843b570707c6bac429995d874ed8aaa47c7bf0cddbeb33ee2ee2892cddcd4fc5fe66c9afcbe81e1db6c73
-  data.tar.gz: f0f1cbf2155b63877890a640bff420ccb4a8ccf0e079341916b029827033f09719c8735b96479366690b20a24c4528eb9419ec02382618f2af937bc467ff1c91
+  metadata.gz: eb7997567ebd5f0c68f917ee1d3503581dec6aa2fc0776f900eab238ef4048710ba04db6937788f3fcc80afbd4abb97867e61e2df6725af93878cc1df3a41d35
+  data.tar.gz: 7fdda488d9ce49582c2b114b7b9280f37601749d74069e2a5af406cf70c5ac60c91f8a8ff3fa1be2c99871841210ee73ba7327c4a4bcab6bcb231269f7a454eb

data/bin/egi-fedcloud-vmhound

@@ -24,7 +24,7 @@ class EgiFedcloudVmhound < Thor
 
   desc "ip IP_ADDRESS", "Prints information based on the provided IP address or IP address range"
   method_option :cmf, :type => :string, :default => Egi::Fedcloud::Vmhound::Settings.cmf,
-                :aliases => '-c', :desc => 'Type of the underlying CMF', :required => true
+                :aliases => '-c', :desc => 'Type of the underlying CMF'
   method_option :endpoint, :type => :string, :default => nil,
                 :aliases => '-e', :desc => 'Endpoint of the CMF'
   method_option :username, :type => :string, :default => nil,
@@ -37,6 +37,8 @@ class EgiFedcloudVmhound < Thor
                 :aliases => '-x', :desc => 'Directory path to all trusted CA certificates'
   method_option :insecure, :type => :boolean, :default => Egi::Fedcloud::Vmhound::Settings.insecure,
                 :aliases => '-k', :desc => 'Enable insecure mode for SSL (no peer validation)'
+  method_option :details, :type => :boolean, :default => Egi::Fedcloud::Vmhound::Settings.details,
+                :aliases => '-l', :desc => 'Enable wide tables with more details (off by default)'
   method_option :debug, :type => :boolean, :default => Egi::Fedcloud::Vmhound::Settings.debug,
                 :aliases => '-d', :desc => 'Enable debugging'
   def ip(ip_address)
@@ -46,13 +48,14 @@ class EgiFedcloudVmhound < Thor
       Egi::Fedcloud::Vmhound::Extractor.find_by_ip(
         ip_address,
         options
-      )
+      ),
+      options
     )
   end
 
   desc "appuri URI", "Prints information based on the provided Appliance MPURI"
   method_option :cmf, :type => :string, :default => Egi::Fedcloud::Vmhound::Settings.cmf,
-                :aliases => '-c', :desc => 'Type of the underlying CMF', :required => true
+                :aliases => '-c', :desc => 'Type of the underlying CMF'
   method_option :endpoint, :type => :string, :default => nil,
                 :aliases => '-e', :desc => 'Endpoint of the CMF'
   method_option :username, :type => :string, :default => nil,
@@ -65,6 +68,8 @@ class EgiFedcloudVmhound < Thor
                 :aliases => '-x', :desc => 'Directory path to all trusted CA certificates'
   method_option :insecure, :type => :boolean, :default => Egi::Fedcloud::Vmhound::Settings.insecure,
                 :aliases => '-k', :desc => 'Enable insecure mode for SSL (no peer validation)'
+  method_option :details, :type => :boolean, :default => Egi::Fedcloud::Vmhound::Settings.details,
+                :aliases => '-l', :desc => 'Enable wide tables with more details (off by default)'
   method_option :debug, :type => :boolean, :default => Egi::Fedcloud::Vmhound::Settings.debug,
                 :aliases => '-d', :desc => 'Enable debugging'
   def appuri(uri)
@@ -74,13 +79,14 @@ class EgiFedcloudVmhound < Thor
       Egi::Fedcloud::Vmhound::Extractor.find_by_appuri(
         uri,
         options
-      )
+      ),
+      options
     )
   end
 
   desc "user ID", "Prints information based on the provided user identifier"
   method_option :cmf, :type => :string, :default => Egi::Fedcloud::Vmhound::Settings.cmf,
-                :aliases => '-c', :desc => 'Type of the underlying CMF', :required => true
+                :aliases => '-c', :desc => 'Type of the underlying CMF'
   method_option :endpoint, :type => :string, :default => nil,
                 :aliases => '-e', :desc => 'Endpoint of the CMF'
   method_option :username, :type => :string, :default => nil,
@@ -93,6 +99,8 @@ class EgiFedcloudVmhound < Thor
                 :aliases => '-x', :desc => 'Directory path to all trusted CA certificates'
   method_option :insecure, :type => :boolean, :default => Egi::Fedcloud::Vmhound::Settings.insecure,
                 :aliases => '-k', :desc => 'Enable insecure mode for SSL (no peer validation)'
+  method_option :details, :type => :boolean, :default => Egi::Fedcloud::Vmhound::Settings.details,
+                :aliases => '-l', :desc => 'Enable wide tables with more details (off by default)'
   method_option :debug, :type => :boolean, :default => Egi::Fedcloud::Vmhound::Settings.debug,
                 :aliases => '-d', :desc => 'Enable debugging'
   def user(id)
@@ -102,7 +110,8 @@ class EgiFedcloudVmhound < Thor
       Egi::Fedcloud::Vmhound::Extractor.find_by_user(
         id,
         options
-      )
+      ),
+      options
     )
   end
 

data/config/settings.yml

@@ -3,16 +3,19 @@ production:
   cmf: opennebula
   ca_path: '/etc/grid-security/certificates'
   insecure: false
+  details: false
   debug: false
 
 development:
   cmf: opennebula
   ca_path: '/etc/grid-security/certificates'
   insecure: true
+  details: true
   debug: true
 
 test:
   cmf: dummy
   ca_path: '/etc/grid-security/certificates'
   insecure: true
+  details: true
   debug: true

data/lib/egi/fedcloud/vmhound/connectors/dummy_connector.rb

@@ -7,6 +7,7 @@ class Egi::Fedcloud::Vmhound::Connectors::DummyConnector < Egi::Fedcloud::Vmhoun
   #
   # @return [Array<Hash>] List of instances, each represented as a hash
   def active_instances
+    Egi::Fedcloud::Vmhound::Log.info "[#{self.class}] Retrieving active instances"
     []
   end
 
@@ -15,6 +16,7 @@ class Egi::Fedcloud::Vmhound::Connectors::DummyConnector < Egi::Fedcloud::Vmhoun
   #
   # @return [Array<Hash>] List of instances, each represented as a hash
   def running_instances
+    Egi::Fedcloud::Vmhound::Log.info "[#{self.class}] Retrieving running instances"
     []
   end
 

data/lib/egi/fedcloud/vmhound/connectors/opennebula_connector.rb

@@ -13,8 +13,10 @@ class Egi::Fedcloud::Vmhound::Connectors::OpennebulaConnector < Egi::Fedcloud::V
     super
 
     secret = if opts[:username] && opts[:password]
+               Egi::Fedcloud::Vmhound::Log.debug "[#{self.class}] Using provided plain credentials"
                "#{opts[:username]}:#{opts[:password]}"
              else
+               Egi::Fedcloud::Vmhound::Log.debug "[#{self.class}] Falling back to file and environment credentials"
                opts[:auth_file] ? File.read(opts[:auth_file]) : nil
              end
     secret.strip! if secret
@@ -43,6 +45,7 @@ class Egi::Fedcloud::Vmhound::Connectors::OpennebulaConnector < Egi::Fedcloud::V
   #
   # @return [Array<Hash>] List of instances, each represented as a hash
   def active_instances
+    Egi::Fedcloud::Vmhound::Log.info "[#{self.class}] Retrieving active instances"
     instances
   end
 
@@ -51,6 +54,7 @@ class Egi::Fedcloud::Vmhound::Connectors::OpennebulaConnector < Egi::Fedcloud::V
   #
   # @return [Array<Hash>] List of instances, each represented as a hash
   def running_instances
+    Egi::Fedcloud::Vmhound::Log.info "[#{self.class}] Retrieving running instances"
     instances ['ACTIVE']
   end
 
@@ -62,6 +66,9 @@ class Egi::Fedcloud::Vmhound::Connectors::OpennebulaConnector < Egi::Fedcloud::V
   # @param reject_states [Array<String>] a list of states to be rejected
   # @return [Array<Hash>] a list of instances matching given criteria
   def instances(allow_states = nil, reject_states = nil)
+    Egi::Fedcloud::Vmhound::Log.debug "[#{self.class}] Retrieving instances: " \
+                                      "allow_states=#{allow_states.inspect} & " \
+                                      "reject_states=#{reject_states.inspect}"
     return if allow_states && allow_states.empty?
     reject_states ||= []
 
@@ -69,7 +76,12 @@ class Egi::Fedcloud::Vmhound::Connectors::OpennebulaConnector < Egi::Fedcloud::V
 
     vms = []
     @vm_pool_ary.each do |vm|
-      next if reject_states.include? vm.state_str
+      if reject_states.include? vm.state_str
+        Egi::Fedcloud::Vmhound::Log.debug "[#{self.class}] Rejecting VM #{vm['ID']} " \
+                                          "-- #{vm.state_str}"
+        next
+      end
+
       vms << canonical_instance(vm) if (allow_states.nil? || (allow_states && allow_states.include?(vm.state_str)))
     end
 
@@ -84,17 +96,21 @@ class Egi::Fedcloud::Vmhound::Connectors::OpennebulaConnector < Egi::Fedcloud::V
   # @return [Array<OpenNebula::VirtualMachine>] a list of VM instances
   def instances_batch_pool(vm_pool)
     fail 'Pool object not provided!' unless vm_pool
+    Egi::Fedcloud::Vmhound::Log.debug "[#{self.class}] Iterating over the VM " \
+                                      "pool with batch size #{VM_POOL_BATCH_SIZE}"
 
     batch_start = 0
     batch_stop = VM_POOL_BATCH_SIZE - 1
     vm_pool_ary = []
 
     begin
+      Egi::Fedcloud::Vmhound::Log.debug "[#{self.class}] Getting #{batch_start} to #{batch_stop}"
       check_retval vm_pool.info(
         OpenNebula::VirtualMachinePool::INFO_ALL,
         batch_start, batch_stop,
         OpenNebula::VirtualMachinePool::INFO_NOT_DONE
       )
+      Egi::Fedcloud::Vmhound::Log.debug "[#{self.class}] Got #{vm_pool.count.inspect} VMs from pool"
       vm_pool_ary.concat vm_pool.to_a unless vm_pool.count < 1
 
       batch_start = batch_stop + 1
@@ -110,6 +126,7 @@ class Egi::Fedcloud::Vmhound::Connectors::OpennebulaConnector < Egi::Fedcloud::V
   # @return [Array<Hash>] a list of images
   def images
     return @canonical_image_pool if @canonical_image_pool
+    Egi::Fedcloud::Vmhound::Log.debug "[#{self.class}] Retrieving all images"
     check_retval @image_pool.info_all!
 
     @canonical_image_pool = []
@@ -122,6 +139,7 @@ class Egi::Fedcloud::Vmhound::Connectors::OpennebulaConnector < Egi::Fedcloud::V
   # @param image_id [String,Integer] native image ID
   # @return [Hash,NilClass] canonical image structure
   def image_by_id(image_id)
+    Egi::Fedcloud::Vmhound::Log.debug "[#{self.class}] Picking image ID #{image_id.inspect} from pool"
     images.select { |image| image[:id] == image_id.to_i }.first
   end
 
@@ -130,6 +148,7 @@ class Egi::Fedcloud::Vmhound::Connectors::OpennebulaConnector < Egi::Fedcloud::V
   # @return [Array<Hash>] a list of users
   def users
     return @canonical_user_pool if @canonical_user_pool
+    Egi::Fedcloud::Vmhound::Log.debug "[#{self.class}] Retrieving all users"
     check_retval @user_pool.info!
 
     @canonical_user_pool = []
@@ -142,6 +161,7 @@ class Egi::Fedcloud::Vmhound::Connectors::OpennebulaConnector < Egi::Fedcloud::V
   # @param user_id [String,Integer] native user ID
   # @return [Hash,NilClass] canonical user structure
   def user_by_id(user_id)
+    Egi::Fedcloud::Vmhound::Log.debug "[#{self.class}] Picking user ID #{user_id.inspect} from pool"
     users.select { |user| user[:id] == user_id.to_i }.first
   end
 
@@ -175,6 +195,8 @@ class Egi::Fedcloud::Vmhound::Connectors::OpennebulaConnector < Egi::Fedcloud::V
     opennebula_instance.each('TEMPLATE/NIC') { |nic| ips << nic['IP'] }
     ips.compact!
 
+    Egi::Fedcloud::Vmhound::Log.debug "[#{self.class}] Assigning IPs #{ips.inspect} " \
+                                      "to #{opennebula_instance['ID'].inspect}"
     ips
   end
 
@@ -191,6 +213,8 @@ class Egi::Fedcloud::Vmhound::Connectors::OpennebulaConnector < Egi::Fedcloud::V
     identifiers << opennebula_instance['ID'].to_s
     identifiers.compact!
 
+    Egi::Fedcloud::Vmhound::Log.debug "[#{self.class}] Assigning instance IDs " \
+                                      "#{identifiers.inspect} to #{opennebula_instance['ID'].inspect}"
     identifiers
   end
 
@@ -205,6 +229,8 @@ class Egi::Fedcloud::Vmhound::Connectors::OpennebulaConnector < Egi::Fedcloud::V
     opennebula_instance.each('HISTORY_RECORDS/HISTORY') { |history| hosts << history['HOSTNAME'] }
     hosts.compact!
 
+    Egi::Fedcloud::Vmhound::Log.debug "[#{self.class}] Assigning hosts #{hosts.inspect} " \
+                                      "to #{opennebula_instance['ID'].inspect}"
     hosts.last
   end
 
@@ -242,6 +268,8 @@ class Egi::Fedcloud::Vmhound::Connectors::OpennebulaConnector < Egi::Fedcloud::V
     identifiers << opennebula_image['ID'].to_s
     identifiers.compact!
 
+    Egi::Fedcloud::Vmhound::Log.debug "[#{self.class}] Assigning IDs #{identifiers.inspect} " \
+                                      "to image #{opennebula_image['ID'].inspect}"
     identifiers
   end
 
@@ -277,6 +305,8 @@ class Egi::Fedcloud::Vmhound::Connectors::OpennebulaConnector < Egi::Fedcloud::V
     identities.flatten!
     identities.compact!
 
+    Egi::Fedcloud::Vmhound::Log.debug "[#{self.class}] Assigning identities #{identities.inspect} " \
+                                      "to user #{opennebula_user['ID'].inspect}"
     identities
   end
 

data/lib/egi/fedcloud/vmhound/extractor.rb

@@ -12,6 +12,7 @@ class Egi::Fedcloud::Vmhound::Extractor
       return if defined?(@@connector)
 
       connector_name = "#{options[:cmf].camelize}Connector"
+      Egi::Fedcloud::Vmhound::Log.debug "[#{self}] Getting #{connector_name} for #{options[:cmf]}"
       @@connector = Egi::Fedcloud::Vmhound::Connectors.const_get(connector_name).new(options)
 
       connector_name

data/lib/egi/fedcloud/vmhound/formatter.rb

@@ -5,30 +5,38 @@ class Egi::Fedcloud::Vmhound::Formatter
 
   class << self
     #
-    def as_table(data)
+    def as_table(data, opts = {})
       data ||= []
       Egi::Fedcloud::Vmhound::Log.debug "[#{self}] Transforming #{data.inspect} into a table"
       table = Terminal::Table.new
 
-      table.add_row [
-        ' >>> VM ID <<< ', ' >>> Owner <<< ', ' >>> VO/Group <<< ',
-        ' >>> IPs <<< ', ' >>> Phys. location <<< ', ' >>> State <<< ',
-        ' >>> Contact <<< '
+      thead = [
+        ' >>> VM ID <<< ', ' >>> Contact <<< ',
+        ' >>> Location <<< ', ' >>> State <<< '
       ]
+      thead.concat [
+        ' >>> Owner Identity <<< ', ' >>> Group <<< ', ' >>> IPs <<< '
+      ] if opts[:details]
+
+      table.add_row thead
       table.add_separator
       data.each do |vm|
         table.add_separator
-        table.add_row [
-          vm[:id], vm[:owner][:identities].join("\n"), vm[:group],
-          vm[:ips].join("\n"), vm[:host], vm[:state], vm[:owner][:email]
+        tbody = [
+          vm[:id], vm[:owner][:email], vm[:host], vm[:state]
         ]
+        tbody.concat [
+          vm[:owner][:identities].join("\n"),
+          vm[:group], vm[:ips].join("\n")
+        ] if opts[:details]
+        table.add_row tbody
       end
 
       table
     end
 
     #
-    def as_json(data)
+    def as_json(data, opts = {})
       data ||= []
       data ? JSON.generate(data) : '{}'
     end

data/lib/egi/fedcloud/vmhound/version.rb

@@ -2,7 +2,7 @@ module Egi
   module Fedcloud
     module Vmhound
       # Versioning constant
-      VERSION = "0.0.1" unless defined?(::Egi::Fedcloud::Vmhound::VERSION)
+      VERSION = "0.0.2" unless defined?(::Egi::Fedcloud::Vmhound::VERSION)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: egi-fedcloud-vmhound
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Boris Parak
@@ -249,7 +249,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
 summary: A proof-of-concept utility for locating VM instances in EGI Federated Cloud