egi-fedcloud-vmhound 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29a4951b4b00abba293dba93b23a58adba7180bb
-  data.tar.gz: ae139838f5f0ab021364674fd7e7cd6afa15dede
+  metadata.gz: aa4eb6dedfd6c0c0da42d64722f528b1f3731cab
+  data.tar.gz: 1fa2317b48bccc8dde25efa50caf66851390cbe7
 SHA512:
-  metadata.gz: 92b56664baf23c15eff28ee89e9e6452a72ac44e5c8d462a639cd53b5b12e5c42287f8f57a64dc3534e65f83c2bbf8fd42b07130d466f53682fa7cf77a89e56a
-  data.tar.gz: 939a73c56afafda06d4847676e7939d46bef7701483049cba814c1e612d6e2a1bb4b69e38635d568293b901f5a58e2457702dce0a09cd81f08a5c8d9a8b69a39
+  metadata.gz: 309e16398fe2852c1382704c4dcb2c726c2e32c0640aee50828fedd5f0265c4ae361f5d8e70e3ef75da50f72082fefcd5fc84247609ae1c0207b447ae23b619b
+  data.tar.gz: 864c1d2514cbb6cdfa6ca44a89d4407f8b661a212b219c7fb771f483a34d0a228ad805f8992e619145f3cf25b0f3161ca10dde8dd7f95454025322248842b820

data/README.md

@@ -3,10 +3,73 @@
 [![Gem Version](https://fury-badge.herokuapp.com/rb/egi-fedcloud-vmhound.png)](https://badge.fury.io/rb/egi-fedcloud-vmhound)
 [![Code Climate](https://codeclimate.com/github/arax/egi-fedcloud-vmhound.png)](https://codeclimate.com/github/arax/egi-fedcloud-vmhound)
 
-# EGI FedCloud CloudHound
+# EGI FedCloud VMHound
 
 A proof-of-concept utility for locating VM instances in EGI Federated Cloud.
 
+## Installation
+### Dependencies
+* __Debian-based__
+```bash
+$ sudo apt-get install ruby ruby-dev libxml2 build-essential
+```
+* __RHEL-based__
+```bash
+$ sudo yum install ruby ruby-devel libxml2
+```
+
+### From RubyGems.org
+```bash
+$ gem install egi-fedcloud-vmhound
+$ egi-fedcloud-vmhound help
+```
+
+### From Source
+```bash
+$ git clone https://github.com/arax/egi-fedcloud-vmhound.git
+$ cd egi-fedcloud-vmhound
+$ gem install bundler
+$ bundle install
+$ bundle exec bin/egi-fedcloud-vmhound help
+```
+
+## Usage
+```bash
+$ egi-fedcloud-vmhound help
+Commands:
+  egi-fedcloud-vmhound appuri URI      # Prints information based on the provided Appliance MPURI
+  egi-fedcloud-vmhound help [COMMAND]  # Describe available commands or one specific command
+  egi-fedcloud-vmhound ip IP_ADDRESS   # Prints information based on the provided IP address or IP address range
+  egi-fedcloud-vmhound user ID         # Prints information based on the provided user identifier
+```
+
+```bash
+$ egi-fedcloud-vmhound help user
+
+$ USER_DN="/DC=cz/DC=cesnet-ca/O=CESNET/CN=John Doe"
+$ egi-fedcloud-vmhound user $USER_DN
+$ egi-fedcloud-vmhound user $USER_DN --format=plain
+$ egi-fedcloud-vmhound user $USER_DN --format=json
+```
+
+```bash
+$ egi-fedcloud-vmhound help appuri
+
+$ MPURI="https://appdb.egi.eu/store/vo/image/ac34bc96-4d78-583a-b73b-a9102aeec206:403/"
+$ egi-fedcloud-vmhound appuri $MPURI
+$ egi-fedcloud-vmhound appuri $MPURI --format=plain
+$ egi-fedcloud-vmhound appuri $MPURI --format=json
+```
+
+```bash
+$ egi-fedcloud-vmhound help ip
+
+$ IP_ADDRESS="192.168.5.0/24" # range or host IP
+$ egi-fedcloud-vmhound ip $IP_ADDRESS
+$ egi-fedcloud-vmhound ip $IP_ADDRESS --format=plain
+$ egi-fedcloud-vmhound ip $IP_ADDRESS --format=json
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/arax/egi-fedcloud-vmhound/fork )

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

@@ -9,31 +9,13 @@ class Egi::Fedcloud::Vmhound::Connectors::OpennebulaConnector < Egi::Fedcloud::V
   def initialize(opts = {})
     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
-
     options = {}
     options[:sync] = true
     # TODO: fix https://github.com/OpenNebula/one/blob/ced1a29bfb3f3d1991ea88e658ea9462071fe4b8/src/oca/ruby/opennebula/client.rb#L166
     #options[:cert_dir] = opts[:ca_path] unless opts[:ca_path].blank?
     options[:disable_ssl_verify] = opts[:insecure]
 
-    client = OpenNebula::Client.new(secret, opts[:endpoint], options)
-
-    @vm_pool = OpenNebula::VirtualMachinePool.new(client)
-    @vm_pool_ary = nil
-
-    @image_pool = OpenNebula::ImagePool.new(client)
-    @canonical_image_pool = nil
-
-    @user_pool = OpenNebula::UserPool.new(client)
-    @canonical_user_pool = nil
+    initialize_pools initialize_secret(opts), opts, options
   end
 
   # Retrieves active instances from the underlying OpenNebula. Including instances
@@ -57,9 +39,47 @@ class Egi::Fedcloud::Vmhound::Connectors::OpennebulaConnector < Egi::Fedcloud::V
 
   private
 
+  # Processes options and extracts the secret used to connect to
+  # OpenNebula. This can be username & password, file with a token,
+  # or nothing (`nil`).
+  #
+  # @param opts [Hash] hash with options
+  # @return [NilClass, String] constructed secret
+  def initialize_secret(opts = {})
+    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
+    secret
+  end
+
+  # Initializes client instance and corresponding OpenNebula
+  # resource pools and caches.
+  #
+  # @param secret [String, NilClass] authentication secret
+  # @param opts [Hash] user-defined options
+  # @param options [Hash] computed options for ONe client
+  # @return [NilClass] nothing
+  def initialize_pools(secret, opts = {}, options = {})
+    client = OpenNebula::Client.new(secret, opts[:endpoint], options)
+
+    @vm_pool = OpenNebula::VirtualMachinePool.new(client)
+    @vm_pool_ary = nil
+
+    @image_pool = OpenNebula::ImagePool.new(client)
+    @canonical_image_pool = nil
+
+    @user_pool = OpenNebula::UserPool.new(client)
+    @canonical_user_pool = nil
+  end
+
   # Retrieves a list of instances matching given criteria.
   #
-  # @param allow_states [Array<String>] a list of allowed states
+  # @param allow_states [Array<String>] a list of allowed states, `nil` represents all
   # @param reject_states [Array<String>] a list of states to be rejected
   # @return [Array<Hash>] a list of instances matching given criteria
   def fetch_instances(allow_states = nil, reject_states = nil)
@@ -69,20 +89,25 @@ class Egi::Fedcloud::Vmhound::Connectors::OpennebulaConnector < Egi::Fedcloud::V
     return if allow_states && allow_states.empty?
     reject_states ||= []
 
-    @vm_pool_ary = fetch_instances_batch_pool(@vm_pool) unless @vm_pool_ary
-
-    vms = []
-    @vm_pool_ary.each do |vm|
-      if reject_states.include? vm.state_str
-        Egi::Fedcloud::Vmhound::Log.debug "[#{self.class}] Rejecting VM #{vm['ID']} " \
-                                          "-- #{vm.state_str}"
-        next
-      end
+    @vm_pool_ary ||= fetch_instances_batch_pool(@vm_pool)
+    @vm_pool_ary.collect { |vm| fetch_instances_vm(vm, allow_states, reject_states) }.compact
+  end
 
-      vms << canonical_instance(vm) if (allow_states.nil? || (allow_states && allow_states.include?(vm.state_str)))
+  # Applies given selection criteria and returns canonical representation
+  # of a VM or `nil`.
+  #
+  # @param vm [OpenNebula::VirtualMachine] VM instance from OpenNebula
+  # @param allow_states [NilClass, Array] allowed VM states, `nil` represents all
+  # @param reject_states [Array] reject VMs in given states
+  # @return [NilClass, Hash] normalized VM instance structure
+  def fetch_instances_vm(vm, allow_states, reject_states)
+    if reject_states.include? vm.state_str
+      Egi::Fedcloud::Vmhound::Log.debug "[#{self.class}] Rejecting VM #{vm['ID']} " \
+                                        "-- #{vm.state_str}"
+      return
     end
 
-    vms
+    allow_states.nil? || allow_states.include?(vm.state_str) ? canonical_instance(vm) : nil
   end
 
   # Hides batch processing from the rest of the application. Returns

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

@@ -2,7 +2,7 @@ module Egi
   module Fedcloud
     module Vmhound
       # Versioning constant
-      VERSION = "0.0.4" unless defined?(::Egi::Fedcloud::Vmhound::VERSION)
+      VERSION = "0.0.5" 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.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Boris Parak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-03 00:00:00.000000000 Z
+date: 2015-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport