opennebula-cli 3.8.0.beta1

data/bin/onevnet

@@ -0,0 +1,227 @@
+#!/usr/bin/env ruby
+
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2012, OpenNebula Project Leads (OpenNebula.org)             #
+#                                                                            #
+# Licensed under the Apache License, Version 2.0 (the "License"); you may    #
+# not use this file except in compliance with the License. You may obtain    #
+# a copy of the License at                                                   #
+#                                                                            #
+# http://www.apache.org/licenses/LICENSE-2.0                                 #
+#                                                                            #
+# Unless required by applicable law or agreed to in writing, software        #
+# distributed under the License is distributed on an "AS IS" BASIS,          #
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   #
+# See the License for the specific language governing permissions and        #
+# limitations under the License.                                             #
+#--------------------------------------------------------------------------- #
+
+ONE_LOCATION=ENV["ONE_LOCATION"]
+
+if !ONE_LOCATION
+    RUBY_LIB_LOCATION="/usr/lib/one/ruby"
+else
+    RUBY_LIB_LOCATION=ONE_LOCATION+"/lib/ruby"
+end
+
+$: << RUBY_LIB_LOCATION
+$: << RUBY_LIB_LOCATION+"/cli"
+
+require 'command_parser'
+require 'one_helper/onevnet_helper'
+require 'one_helper/onecluster_helper'
+
+cmd=CommandParser::CmdParser.new(ARGV) do
+    usage "`onevnet` <command> [<args>] [<options>]"
+    version OpenNebulaHelper::ONE_VERSION
+
+    helper = OneVNetHelper.new
+
+    ########################################################################
+    # Global Options
+    ########################################################################
+    set :option, CommandParser::OPTIONS
+
+    CREATE_OPTIONS = [OneClusterHelper::CLUSTER]
+
+    ########################################################################
+    # Formatters for arguments
+    ########################################################################
+    set :format, :groupid, OpenNebulaHelper.rname_to_id_desc("GROUP") do |arg|
+        OpenNebulaHelper.rname_to_id(arg, "GROUP")
+    end
+
+    set :format, :userid, OpenNebulaHelper.rname_to_id_desc("USER") do |arg|
+        OpenNebulaHelper.rname_to_id(arg, "USER")
+    end
+
+    set :format, :vnetid, OneVNetHelper.to_id_desc do |arg|
+        helper.to_id(arg)
+    end
+
+    set :format, :vnetid_list, OneVNetHelper.list_to_id_desc do |arg|
+        helper.list_to_id(arg)
+    end
+
+    set :format, :filterflag, OneVNetHelper.filterflag_to_i_desc do |arg|
+        helper.filterflag_to_i(arg)
+    end
+
+    ########################################################################
+    # Commands
+    ########################################################################
+
+    create_desc = <<-EOT.unindent
+        Creates a new Virtual Network from the given template file
+    EOT
+
+    command :create, create_desc, :file, :options=>CREATE_OPTIONS do
+        cid = options[:cluster] || ClusterPool::NONE_CLUSTER_ID
+
+        helper.create_resource(options) do |vn|
+            begin 
+                template=File.read(args[0])
+                vn.allocate(template, cid)
+            rescue => e
+                STDERR.puts e.message
+                exit -1
+            end
+        end
+    end
+
+    delete_desc = <<-EOT.unindent
+        Deletes the given Virtual Network
+    EOT
+
+    command :delete, delete_desc, [:range, :vnetid_list] do
+        helper.perform_actions(args[0],options,"deleted") do |vn|
+            vn.delete
+        end
+    end
+
+    addleases_desc = <<-EOT.unindent
+        Adds a lease to the Virtual Network
+    EOT
+
+    command :addleases, addleases_desc, :vnetid, :ip, [:mac, nil] do
+        helper.perform_action(args[0],options,"lease added") do |vn|
+            vn.addleases(args[1], args[2])
+        end
+    end
+
+    rmleases_desc = <<-EOT.unindent
+        Removes a lease from the Virtual Network
+    EOT
+
+    command :rmleases, rmleases_desc, :vnetid, :ip do
+        helper.perform_action(args[0],options,"lease removed") do |vn|
+            vn.rmleases(args[1])
+        end
+    end
+
+    hold_desc = <<-EOT.unindent
+        Holds a Virtual Network lease, marking it as used
+    EOT
+
+    command :hold, hold_desc, :vnetid, :ip do
+        helper.perform_action(args[0],options,"lease on hold") do |vn|
+            vn.hold(args[1])
+        end
+    end
+
+    release_desc = <<-EOT.unindent
+        Releases a Virtual Network lease on hold
+    EOT
+
+    command :release, release_desc, :vnetid, :ip do
+        helper.perform_action(args[0],options,"lease released") do |vn|
+            vn.release(args[1])
+        end
+    end
+
+    publish_desc = <<-EOT.unindent
+        DEPRECATED, use chmod instead. Publishes the given Virtual Network. 
+        A public Virtual Network can be seen and used by other users in the 
+        Virtual Network's group.
+    EOT
+
+    command :publish, publish_desc, [:range,:vnetid_list] do
+        helper.perform_actions(args[0],options,"published") do |vn|
+            vn.publish
+        end
+    end
+
+    unpublish_desc = <<-EOT.unindent
+        DEPRECATED, use chmod instead. Unpublishes the given Virtual Network. A 
+        private Virtual Network can't be used by any other user.
+    EOT
+
+    command :unpublish, unpublish_desc, [:range,:vnetid_list] do
+        helper.perform_actions(args[0],options,"unpublished") do |vn|
+            vn.unpublish
+        end
+    end
+
+    chgrp_desc = <<-EOT.unindent
+        Changes the Virtual Network group
+    EOT
+
+    command :chgrp, chgrp_desc,[:range, :vnetid_list], :groupid do
+        helper.perform_actions(args[0],options,"Group changed") do |vn|
+            vn.chown(-1, args[1].to_i)
+        end
+    end
+
+    chown_desc = <<-EOT.unindent
+        Changes the Virtual Network owner and group
+    EOT
+
+    command :chown, chown_desc, [:range, :vnetid_list], :userid,
+            [:groupid,nil] do
+        gid = args[2].nil? ? -1 : args[2].to_i
+        helper.perform_actions(args[0],options,"Owner/Group changed") do |vn|
+            vn.chown(args[1].to_i, gid)
+        end
+    end
+
+    chmod_desc = <<-EOT.unindent
+        Changes the Virtual Network permissions
+    EOT
+
+    command :chmod, chmod_desc, [:range, :vnetid_list], :octet do
+        helper.perform_actions(args[0],options, "Permissions changed") do |vn|
+            vn.chmod_octet(args[1])
+        end
+    end
+
+    list_desc = <<-EOT.unindent
+        Lists Virtual Networks in the pool
+    EOT
+
+    command :list, list_desc, [:filterflag, nil],
+            :options=>CLIHelper::OPTIONS+OpenNebulaHelper::OPTIONS+
+            [OpenNebulaHelper::DESCRIBE] do
+        helper.list_pool(options, false, args[0])
+    end
+
+    show_desc = <<-EOT.unindent
+        Shows information for the given Virtual Network
+    EOT
+
+    command :show, show_desc, :vnetid,
+            :options=>OpenNebulaHelper::XML do
+        helper.show_resource(args[0],options)
+    end
+
+    update_desc = <<-EOT.unindent
+        Update the template contents. If a path is not provided the editor will
+        be launched to modify the current content.
+    EOT
+
+    command :update, update_desc, :vnetid, [:file, nil] do
+        helper.perform_action(args[0],options,"modified") do |vnet|
+            str = OpenNebulaHelper.update_template(args[0], vnet, args[1])
+            vnet.update(str)
+        end
+    end
+end

data/lib/cli_helper.rb

@@ -0,0 +1,294 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2012, OpenNebula Project Leads (OpenNebula.org)             #
+#                                                                            #
+# Licensed under the Apache License, Version 2.0 (the "License"); you may    #
+# not use this file except in compliance with the License. You may obtain    #
+# a copy of the License at                                                   #
+#                                                                            #
+# http://www.apache.org/licenses/LICENSE-2.0                                 #
+#                                                                            #
+# Unless required by applicable law or agreed to in writing, software        #
+# distributed under the License is distributed on an "AS IS" BASIS,          #
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   #
+# See the License for the specific language governing permissions and        #
+# limitations under the License.                                             #
+#--------------------------------------------------------------------------- #
+
+module CLIHelper
+    LIST = {
+        :name  => "list",
+        :short => "-l x,y,z",
+        :large => "--list x,y,z",
+        :format => Array,
+        :description => "Selects columns to display with list command"
+    }
+
+    #ORDER = {
+    #    :name  => "order",
+    #    :short => "-o x,y,z",
+    #    :large => "--order x,y,z",
+    #    :format => Array,
+    #    :description => "Order by these columns, column starting with - means decreasing order"
+    #}
+    #
+    #FILTER = {
+    #    :name  => "filter",
+    #    :short => "-f x,y,z",
+    #    :large => "--filter x,y,z",
+    #    :format => Array,
+    #    :description => "Filter data. An array is specified with column=value pairs."
+    #}
+    #
+    #HEADER = {
+    #    :name  => "header",
+    #    :short => "-H",
+    #    :large => "--header",
+    #    :description => "Shows the header of the table"
+    #}
+
+    DELAY = {
+        :name  => "delay",
+        :short => "-d x",
+        :large => "--delay x",
+        :format => Integer,
+        :description => "Sets the delay in seconds for top command"
+    }
+
+    #OPTIONS = [LIST, ORDER, FILTER, HEADER, DELAY]
+    OPTIONS = [LIST, DELAY]
+
+    # Sets bold font
+    def CLIHelper.scr_bold
+        print "\33[1m"
+    end
+
+    # Sets underline
+    def CLIHelper.scr_underline
+        print "\33[4m"
+    end
+
+    # Restore normal font
+    def CLIHelper.scr_restore
+        print "\33[0m"
+    end
+
+    # Clears screen
+    def CLIHelper.scr_cls
+        print "\33[2J\33[H"
+    end
+
+    # Moves the cursor
+    def CLIHelper.scr_move(x,y)
+        print "\33[#{x};#{y}H"
+    end
+
+    def CLIHelper.scr_red
+        print "\33[31m"
+    end
+
+    def CLIHelper.scr_green
+        print "\33[32m"
+    end
+
+    ANSI_RED="\33[31m"
+    ANSI_GREEN="\33[32m"
+    ANSI_RESET="\33[0m"
+
+    OK_STATES=%w{runn rdy on}
+    BAD_STATES=%w{fail err err}
+
+    def CLIHelper.color_state(stat)
+        if $stdout.tty?
+            case stat.strip
+            when *OK_STATES
+                ANSI_GREEN+stat+ANSI_RESET
+            when *BAD_STATES
+                ANSI_RED+stat+ANSI_RESET
+            else
+                stat
+            end
+        else
+            stat
+        end
+    end
+
+    # Print header
+    def CLIHelper.print_header(str, underline=true)
+        if $stdout.tty?
+            scr_bold
+            scr_underline if underline
+            print str
+            scr_restore
+        else
+            print str
+        end
+        puts
+    end
+
+    class ShowTable
+        require 'yaml'
+
+        def initialize(conf=nil, ext=nil, &block)
+            @columns = Hash.new
+            @default_columns = Array.new
+
+            @ext = ext
+            @conf = conf
+
+            instance_eval(&block)
+        end
+
+        def helper
+            @ext
+        end
+
+        def column(name, desc, *conf, &block)
+            column = Hash.new
+            column[:desc] = desc
+            column[:size] = 5
+            conf.each{|c|
+                if c.instance_of?(Symbol)
+                    column[c]=true
+                elsif c.instance_of?(Hash)
+                    c.each{|key,value|
+                        column[key]=value
+                    }
+                end
+            }
+            column[:proc] = block
+            @columns[name.to_sym] = column
+            @default_columns<<name
+        end
+
+        def default(*args)
+            args.map!{|a| a.to_sym }
+            @default_columns=args
+        end
+
+        def show(data, options={})
+            update_columns(options)
+            print_table(data, options)
+        end
+
+        def top(options={}, &block)
+            delay=options[:delay] ? options[:delay] : 1
+
+            begin
+                while true
+                    CLIHelper.scr_cls
+                    CLIHelper.scr_move(0,0)
+
+                    data = block.call
+
+                    show(data, options)
+                    sleep delay
+                end
+            rescue Exception => e
+                puts e.message
+            end
+        end
+
+        def describe_columns
+            str="%-20s: %-20s"
+
+            @columns.each do |column, d|
+                puts str % [column, d[:desc]]
+            end
+        end
+
+        private
+
+        def print_table(data, options)
+            CLIHelper.print_header(header_str)
+            data ? print_data(data, options) : puts
+        end
+
+        def print_data(data, options)
+            ncolumns=@default_columns.length
+            res_data=data_array(data, options)
+
+            if options[:stat_column]
+                stat_column=@default_columns.index(
+                    options[:stat_column].upcase.to_sym)
+            else
+                stat_column=@default_columns.index(:STAT)
+            end
+
+            begin
+                print res_data.collect{|l|
+                    (0..ncolumns-1).collect{ |i|
+                        dat=l[i]
+                        col=@default_columns[i]
+
+                        str=format_str(col, dat)
+                        str=CLIHelper.color_state(str) if i==stat_column
+
+                        str
+                    }.join(' ')
+                }.join("\n")
+            rescue Errno::EPIPE
+            end
+
+            puts
+        end
+
+        def data_array(data, options)
+            res_data=data.collect {|d|
+                @default_columns.collect {|c|
+                    @columns[c][:proc].call(d).to_s if @columns[c]
+                }
+            }
+
+            if options
+                filter_data!(res_data, options[:filter]) if options[:filter]
+                sort_data!(res_data, options[:order]) if options[:order]
+            end
+
+            res_data
+        end
+
+        def format_str(field, data)
+            if @columns[field]
+                minus=( @columns[field][:left] ? "-" : "" )
+                size=@columns[field][:size]
+                return "%#{minus}#{size}.#{size}s" % [ data.to_s ]
+            else
+                exit -1, "Column #{field} not defined."
+            end
+        end
+
+        def update_columns(options)
+            begin
+                config = YAML.load_file(@conf)
+
+                default = config.delete(:default)
+                @default_columns = default unless default.empty?
+
+                # Filter show options with available columns
+                @default_columns &= @columns.keys
+
+                @columns.merge!(config) { |key, oldval, newval|
+                    oldval.merge(newval)
+                }
+            rescue Exception => e
+            end
+
+            @default_columns = options[:list].collect{|o| o.to_sym} if options[:list]
+        end
+
+        def header_str
+            @default_columns.collect {|c|
+                if @columns[c]
+                    format_str(c, c.to_s)
+                else
+                    puts "Column #{c} not defined."
+                    exit -1
+                end
+            }.compact.join(' ')
+        end
+
+        # TBD def filter_data!
+
+        # TBD def sort_data!
+    end
+end