knife-xenserver 1.1 → 1.2

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+# 1.2 - Thu 25 Oct 2012 
+
+* Greatly improved 'vm list' command
+
+  - Table columns can now be disabled in output:
+  
+      knife xenserver vm list --no-uuid \
+                              --no-power \
+                              --no-networks \
+                              --no-tools 
+  
+  - Print CSV output with --csv instead of a regular ASCII table
+    
+    knife xenserver vm list --csv
+
+* Added --match option to 'vm list'
+
+  Print only VMs whose name matches the given regex:
+
+    knife xenserver vm list --match '^my-vm.*?devel.bvox.net$'
+
+* FIX: Set exit status to 1 when XenServer auth fails
+* FIX: Print error if XenServer host is not defined
+
 # 1.1 - 2012/10/21
 
 * Fixed --no-host-key-verify vm create flag

data/lib/chef/knife/xenserver_base.rb

@@ -54,6 +54,11 @@ class Chef
       def connection
         if not @connection
           host = config[:xenserver_host] || Chef::Config[:knife][:xenserver_host]
+          if host.nil?
+            ui.error "XenServer host not defined." 
+            ui.error "Use --xenserver-host or add it to the knife config file." 
+            exit 1
+          end
           username = config[:xenserver_username] || Chef::Config[:knife][:xenserver_username]
           password = config[:xenserver_password] || Chef::Config[:knife][:xenserver_password]
           ui.info "Connecting to XenServer host #{host.yellow}..."
@@ -70,7 +75,7 @@ class Chef
           rescue Fog::XenServer::InvalidLogin => e
             ui.error "Error connecting to the hypervisor: #{host}" 
             ui.error "Check the username and password."
-            exit
+            exit 1
           rescue => e
             ui.error "Error connecting to the hypervisor" 
             ui.error "#{e.class} #{e.message}" 

data/lib/chef/knife/xenserver_vm_list.rb

@@ -25,36 +25,167 @@ class Chef
       include Knife::XenserverBase
       
       banner "knife xenserver vm list (options)"
+      
+      option :csv,
+        :long => "--csv",
+        :description => "Comma separated list of VMs",
+        :boolean => true,
+        :default => false
+      
+      option :uuid,
+        :long => "--[no-]uuid",
+        :description => "Print/Hide VM UUID",
+        :boolean => true,
+        :default => true
+      
+      option :tools,
+        :long => "--[no-]tools",
+        :description => "Print/Hide XenTools Availability",
+        :boolean => true,
+        :default => true
+      
+      option :networks,
+        :long => "--[no-]networks",
+        :description => "Print/Hide VM Networks",
+        :boolean => true,
+        :default => true
+      
+      option :mem,
+        :long => "--[no-]mem",
+        :description => "Print/Hide VM Memory",
+        :boolean => true,
+        :default => true
 
-      def run
-        $stdout.sync = true
+      option :ips,
+        :long => "--[no-]ips",
+        :description => "Print/Hide VM IPs",
+        :boolean => true,
+        :default => true
+      
+      option :power_state,
+        :long => "--[no-]power-state",
+        :description => "Print/Hide VM Power State",
+        :boolean => true,
+        :default => true
+      
+      option :match,
+        :long => "--match REGEX",
+        :description => "Print only VMs whose name matches REGEX"
+      
+      def gen_headings
+        headings = %w{NAME}
+        if config[:mem]
+          headings << 'MEM'
+        end
+        if config[:power_state]
+          headings << 'POWER'
+        end
+        if config[:tools]
+          headings << 'TOOLS'
+        end
+        if config[:networks]
+          headings << 'NETWORKS'
+        end
+        if config[:ips]
+          headings << 'IPs'
+        end
+        headings
+      end
+
+      def gen_table
+        # row format
+        # [uuid, name, [ips], [networks], mem, power, tools]
+        table = []
+        connection.servers.each do |vm|
+          if config[:match] and vm.name !~ /#{config[:match]}/
+            next
+          end
+          row = [vm.uuid, vm.name] 
+          if vm.tools_installed?
+            ips = []
+            vm.guest_metrics.networks.each do |k,v|
+              ips << v
+            end
+            row << ips
+          else
+            row << []
+          end
+          networks = []
+          vm.vifs.each do |vif|
+            name = vif.network.name
+            if name.size > 20
+              name = name[0..16] + '...'
+            end
+            networks << name
+          end
+          row << networks
+          row << vm.memory_static_max.to_i.bytes.to.megabytes.round
+          row << vm.power_state
+          row << vm.tools_installed?
+          table << row
+        end
+        table
+      end
+
+      def print_table
         vm_table = table do |t|
-          t.headings = %w{NAME MEM POWER TOOLS NETWORKS IPs}
-          connection.servers.each do |vm|
-            if vm.tools_installed?
-              ips = []
-              vm.guest_metrics.networks.each do |k,v|
-                ips << v
-              end
-              ips = ips.join("\n")
+          t.headings = gen_headings
+          gen_table.each do |row|
+            # [uuid, name, [ips], [networks], mem, power, tools]
+            uuid, name, ips, networks, mem, power, tools = row
+            elements = []
+            if config[:uuid]
+              elements << "#{uuid}\n  #{ui.color('name: ', :yellow)}#{name.ljust(32)}"
             else
-              ips = "unknown"
-            end
-            networks = []
-            vm.vifs.each do |vif|
-              name = vif.network.name
-              if name.size > 20
-                name = name[0..16] + '...'
-              end
-              networks << name
+              elements << "#{ui.color('name: ', :yellow)}#{name.ljust(32)}"
             end
-            networks = networks.join("\n")
-            mem = vm.memory_static_max.to_i.bytes.to.megabytes.round
-            t << ["#{vm.uuid}\n  #{ui.color('name: ', :yellow)}#{vm.name.ljust(32)}", mem, vm.power_state, vm.tools_installed?, networks,ips]
+            elements << mem if config[:mem]
+            elements << power if config[:power_state]
+            elements << tools if config[:tools]
+            elements << networks.join("\n") if config[:networks]
+            elements << ips.join("\n") if config[:ips]
+            t << elements
           end
         end
         puts vm_table if connection.servers.size > 0
       end
+
+      def print_csv
+        lines = []
+        header = ""
+        gen_table.each do |row|
+          uuid, name, ips, networks, mem, power, tools = row
+          elements = []
+          elements << name
+          elements << mem if config[:mem]
+          elements << power if config[:power_state]
+          elements << tools if config[:tools]
+          elements << networks.join(";") if config[:networks]
+          elements << ips.join(";") if config[:ips]
+          if config[:uuid]
+            header = "UUID,#{gen_headings.join(',')}"
+            lines << "#{uuid},#{elements.join(',')}"
+          else
+            header = "#{gen_headings.join(',')}"
+            lines << "#{elements.join(',')}"
+          end
+        end
+
+        puts header
+        lines.each do |l| 
+          puts l
+        end
+      end
+
+      def run
+        $stdout.sync = true
+        if config[:csv]
+          print_csv
+        else
+          print_table
+        end
+      end
+
     end
   end
 end

data/lib/knife-xenserver/version.rb

@@ -1,6 +1,6 @@
 module Knife
   module XenServer
-    VERSION = "1.1"
+    VERSION = "1.2"
     MAJOR, MINOR, TINY = VERSION.split('.')
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-xenserver
 version: !ruby/object:Gem::Version
-  version: '1.1'
+  version: '1.2'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-21 00:00:00.000000000 Z
+date: 2012-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: terminal-table