egi-fedcloud-vmhound 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59f9e2aa22326c3b20d57eebdd6a6c9c20af61a7
-  data.tar.gz: e748665d3c1ae05c2864a18232a32d2d5bfcef7c
+  metadata.gz: 29a4951b4b00abba293dba93b23a58adba7180bb
+  data.tar.gz: ae139838f5f0ab021364674fd7e7cd6afa15dede
 SHA512:
-  metadata.gz: 7a414b844fc63a5a503e7d937561592042b4140dda21cc2b64bf7f5da8b01c9e2af90477a647ebbf3e788ec1dbccec201b533962689c951e4c5bf4ccb599d96a
-  data.tar.gz: 362e9c383857a3ca285535e015d5980c4a1bc8fafc571138e142f13d9da9fa809e2698fc74b4a06aad1e9ffbcbc90741355869eeef006aaa7fe41ea1d2be507b
+  metadata.gz: 92b56664baf23c15eff28ee89e9e6452a72ac44e5c8d462a639cd53b5b12e5c42287f8f57a64dc3534e65f83c2bbf8fd42b07130d466f53682fa7cf77a89e56a
+  data.tar.gz: 939a73c56afafda06d4847676e7939d46bef7701483049cba814c1e612d6e2a1bb4b69e38635d568293b901f5a58e2457702dce0a09cd81f08a5c8d9a8b69a39

data/bin/egi-fedcloud-vmhound

@@ -23,6 +23,8 @@ class EgiFedcloudVmhound < Thor
   include Thor::Actions
 
   desc "ip IP_ADDRESS", "Prints information based on the provided IP address or IP address range"
+  method_option :format, :type => :string, :default => Egi::Fedcloud::Vmhound::Settings.format,
+                :enum => Egi::Fedcloud::Vmhound::Formatter::FORMATS, :aliases => '-o', :desc => 'Output formatting'
   method_option :cmf, :type => :string, :default => Egi::Fedcloud::Vmhound::Settings.cmf,
                 :aliases => '-c', :desc => 'Type of the underlying CMF'
   method_option :endpoint, :type => :string, :default => nil,
@@ -37,14 +39,13 @@ 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)
     init_log options[:debug]
 
-    $stdout.puts Egi::Fedcloud::Vmhound::Formatter.as_table(
+    $stdout.puts Egi::Fedcloud::Vmhound::Formatter.send(
+      "as_#{options[:format]}",
       Egi::Fedcloud::Vmhound::Extractor.find_by_ip(
         ip_address,
         options
@@ -54,6 +55,8 @@ class EgiFedcloudVmhound < Thor
   end
 
   desc "appuri URI", "Prints information based on the provided Appliance MPURI"
+  method_option :format, :type => :string, :default => Egi::Fedcloud::Vmhound::Settings.format,
+                :enum => Egi::Fedcloud::Vmhound::Formatter::FORMATS, :aliases => '-o', :desc => 'Output formatting'
   method_option :cmf, :type => :string, :default => Egi::Fedcloud::Vmhound::Settings.cmf,
                 :aliases => '-c', :desc => 'Type of the underlying CMF'
   method_option :endpoint, :type => :string, :default => nil,
@@ -68,14 +71,13 @@ 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)
     init_log options[:debug]
 
-    $stdout.puts Egi::Fedcloud::Vmhound::Formatter.as_table(
+    $stdout.puts Egi::Fedcloud::Vmhound::Formatter.send(
+      "as_#{options[:format]}",
       Egi::Fedcloud::Vmhound::Extractor.find_by_appuri(
         uri,
         options
@@ -85,6 +87,8 @@ class EgiFedcloudVmhound < Thor
   end
 
   desc "user ID", "Prints information based on the provided user identifier"
+  method_option :format, :type => :string, :default => Egi::Fedcloud::Vmhound::Settings.format,
+                :enum => Egi::Fedcloud::Vmhound::Formatter::FORMATS, :aliases => '-o', :desc => 'Output formatting'
   method_option :cmf, :type => :string, :default => Egi::Fedcloud::Vmhound::Settings.cmf,
                 :aliases => '-c', :desc => 'Type of the underlying CMF'
   method_option :endpoint, :type => :string, :default => nil,
@@ -99,14 +103,13 @@ 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)
     init_log options[:debug]
 
-    $stdout.puts Egi::Fedcloud::Vmhound::Formatter.as_table(
+    $stdout.puts Egi::Fedcloud::Vmhound::Formatter.send(
+      "as_#{options[:format]}",
       Egi::Fedcloud::Vmhound::Extractor.find_by_user(
         id,
         options
@@ -129,7 +132,7 @@ class EgiFedcloudVmhound < Thor
   # @return [Egi::Fedcloud::Vmhound::Log] logger instance for additional configuration
   def init_log(debug = false)
     logger = Egi::Fedcloud::Vmhound::Log.new(STDERR)
-    logger.level = debug ? Egi::Fedcloud::Vmhound::Log::DEBUG : Egi::Fedcloud::Vmhound::Log::ERROR
+    logger.level = debug ? Egi::Fedcloud::Vmhound::Log::DEBUG : Egi::Fedcloud::Vmhound::Log::WARN
     logger
   end
 end

data/config/settings.yml

@@ -1,21 +1,21 @@
 ---
 production:
+  format: table
   cmf: opennebula
   ca_path: '/etc/grid-security/certificates'
   insecure: false
-  details: false
   debug: false
 
 development:
+  format: table
   cmf: opennebula
   ca_path: '/etc/grid-security/certificates'
   insecure: true
-  details: true
   debug: true
 
 test:
+  format: table
   cmf: dummy
   ca_path: '/etc/grid-security/certificates'
   insecure: true
-  details: true
   debug: true

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

@@ -13,12 +13,12 @@ class Egi::Fedcloud::Vmhound::Connectors::BaseConnector
   # included.
   #
   # @return [Array<Hash>] List of instances, each represented as a hash
-  def active_instances; end
+  def instances; end
 
   # Retrieves running instances from the underlying CMF. Only currently
   # running instances will be included.
   #
   # @return [Array<Hash>] List of instances, each represented as a hash
-  def running_instances; end
+  def active_instances; end
 
 end

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

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

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

@@ -41,18 +41,18 @@ class Egi::Fedcloud::Vmhound::Connectors::OpennebulaConnector < Egi::Fedcloud::V
   # included.
   #
   # @return [Array<Hash>] List of instances, each represented as a hash
-  def active_instances
+  def instances
     Egi::Fedcloud::Vmhound::Log.info "[#{self.class}] Retrieving active instances"
-    instances
+    fetch_instances
   end
 
   # Retrieves running instances from the underlying OpenNebula. Only currently
   # running instances will be included.
   #
   # @return [Array<Hash>] List of instances, each represented as a hash
-  def running_instances
+  def active_instances
     Egi::Fedcloud::Vmhound::Log.info "[#{self.class}] Retrieving running instances"
-    instances ['ACTIVE']
+    fetch_instances ['ACTIVE']
   end
 
   private
@@ -62,14 +62,14 @@ class Egi::Fedcloud::Vmhound::Connectors::OpennebulaConnector < Egi::Fedcloud::V
   # @param allow_states [Array<String>] a list of allowed states
   # @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)
+  def fetch_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 ||= []
 
-    @vm_pool_ary = instances_batch_pool(@vm_pool) unless @vm_pool_ary
+    @vm_pool_ary = fetch_instances_batch_pool(@vm_pool) unless @vm_pool_ary
 
     vms = []
     @vm_pool_ary.each do |vm|
@@ -91,7 +91,7 @@ class Egi::Fedcloud::Vmhound::Connectors::OpennebulaConnector < Egi::Fedcloud::V
   #
   # @param vm_pool [OpenNebula::VirtualMachinePool] ONe pool instance
   # @return [Array<OpenNebula::VirtualMachine>] a list of VM instances
-  def instances_batch_pool(vm_pool)
+  def fetch_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 without batch processing"
@@ -266,7 +266,7 @@ class Egi::Fedcloud::Vmhound::Connectors::OpennebulaConnector < Egi::Fedcloud::V
     fail 'User object not provided!' unless opennebula_user
     {
       id: opennebula_user['ID'].to_i,
-      name: opennebula_user['TEMPLATE/NAME'],
+      name: opennebula_user['TEMPLATE/NAME'] || opennebula_user['NAME'],
       identities: canonical_user_identities(opennebula_user),
       email: opennebula_user['TEMPLATE/EMAIL'],
       groups: [

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

@@ -22,21 +22,21 @@ class Egi::Fedcloud::Vmhound::Extractor
     def find_by_ip(ip, options = {})
       env_init options
       Egi::Fedcloud::Vmhound::Log.debug "[#{self}] Searching for instances by IP: #{ip.inspect}"
-      @@connector.active_instances.select { |instance| instance[:ips] && instance[:ips].include?(ip) }
+      @@connector.instances.select { |instance| instance[:ips] && instance[:ips].include?(ip) }
     end
 
     #
     def find_by_appuri(uri, options = {})
       env_init options
       Egi::Fedcloud::Vmhound::Log.debug "[#{self}] Searching for instances by MPURI: #{uri.inspect}"
-      @@connector.active_instances.select { |instance| instance[:appliance] && instance[:appliance][:identifiers].include?(uri) }
+      @@connector.instances.select { |instance| instance[:appliance] && instance[:appliance][:identifiers].include?(uri) }
     end
 
     #
     def find_by_user(id, options = {})
       env_init options
       Egi::Fedcloud::Vmhound::Log.debug "[#{self}] Searching for instances by user ID: #{id.inspect}"
-      @@connector.active_instances.select { |instance| instance[:owner] && instance[:owner][:identities].include?(id) }
+      @@connector.instances.select { |instance| instance[:owner] && instance[:owner][:identities].include?(id) }
     end
   end
 

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

@@ -3,33 +3,29 @@ require 'terminal-table'
 #
 class Egi::Fedcloud::Vmhound::Formatter
 
+  FORMATS = %w(table json plain).freeze
+  LINE_SEPARATOR = "\n\t".freeze
+  RECORD_SEPARATOR = "\n\n".freeze
+
   class << self
     #
     def as_table(data, opts = {})
-      data ||= []
       Egi::Fedcloud::Vmhound::Log.debug "[#{self}] Transforming #{data.inspect} into a table"
+
+      data ||= []
       table = Terminal::Table.new
 
-      thead = [
-        ' >>> VM ID <<< ', ' >>> Contact <<< ',
-        ' >>> Location <<< ', ' >>> State <<< '
+      table.add_row [
+        ' >>> VM ID <<< ', ' >>> Group <<< ', ' >>> Contact <<< ',
+        ' >>> Host <<< ', ' >>> State <<< ',
       ]
-      thead.concat [
-        ' >>> Owner Identity <<< ', ' >>> Group <<< ', ' >>> IPs <<< '
-      ] if opts[:details]
-
-      table.add_row thead
       table.add_separator
       data.each do |vm|
         table.add_separator
-        tbody = [
-          vm[:id], vm[:owner][:email], vm[:host], vm[:state]
+        table.add_row [
+          vm[:id], vm[:group], 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
@@ -37,8 +33,33 @@ class Egi::Fedcloud::Vmhound::Formatter
 
     #
     def as_json(data, opts = {})
-      data ||= []
-      data ? JSON.generate(data) : '{}'
+      Egi::Fedcloud::Vmhound::Log.debug "[#{self}] Transforming #{data.inspect} into a JSON document"
+      return '{}' if data.blank?
+
+      JSON.generate(data)
+    end
+
+    #
+    def as_plain(data, opts = {})
+      Egi::Fedcloud::Vmhound::Log.debug "[#{self}] Transforming #{data.inspect} into plain text"
+      return '' if data.blank?
+
+      lines = {}
+      data.each do |vm|
+        Egi::Fedcloud::Vmhound::Log.warn "[#{self}] #{vm[:owner][:name]} doesn't " \
+                                            "have a contact e-mail! VM[#{vm[:id]}]" if vm[:owner][:email].blank?
+        next if vm[:owner][:email].blank?
+
+        line_key = "\"#{vm[:owner][:name]} in #{vm[:owner][:groups].first}\" <#{vm[:owner][:email]}>"
+        lines[line_key] ||= []
+        lines[line_key] << "#{vm[:id]} is #{vm[:state]} on #{vm[:host]}"
+      end
+
+      plain = []
+      lines.each_pair do |line_key, line_vals|
+        plain << "#{line_key}: #{line_vals.count} VMs#{LINE_SEPARATOR}#{line_vals.join LINE_SEPARATOR}"
+      end
+      plain.join RECORD_SEPARATOR
     end
   end
 

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: egi-fedcloud-vmhound
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Boris Parak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-09 00:00:00.000000000 Z
+date: 2015-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport