opennebula-cli 5.10.5 → 5.12.0.1

data/bin/onevmgroup

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2019, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2020, OpenNebula Project, OpenNebula Systems                #
 #                                                                            #
 # 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    #
@@ -27,7 +27,9 @@ else
 end
 
 if File.directory?(GEMS_LOCATION)
-    Gem.use_paths(GEMS_LOCATION)
+    $LOAD_PATH.reject! {|l| l =~ /vendor_ruby/ }
+    require 'rubygems'
+    Gem.use_paths(File.realpath(GEMS_LOCATION))
 end
 
 $LOAD_PATH << RUBY_LIB_LOCATION

data/bin/onevnet

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2019, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2020, OpenNebula Project, OpenNebula Systems                #
 #                                                                            #
 # 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    #
@@ -27,7 +27,9 @@ else
 end
 
 if File.directory?(GEMS_LOCATION)
-    Gem.use_paths(GEMS_LOCATION)
+    $LOAD_PATH.reject! {|l| l =~ /vendor_ruby/ }
+    require 'rubygems'
+    Gem.use_paths(File.realpath(GEMS_LOCATION))
 end
 
 $LOAD_PATH << RUBY_LIB_LOCATION
@@ -71,6 +73,13 @@ CommandParser::CmdParser.new(ARGV) do
         :description => 'lock all actions'
     }
 
+    FORCE = {
+        :name => 'force',
+        :large => '--force',
+        :description => 'Force execution of action, ' \
+                        'bypass the consistency checks'
+    }
+
     ########################################################################
     # Global Options
     ########################################################################
@@ -169,9 +178,9 @@ CommandParser::CmdParser.new(ARGV) do
         Removes an address range from the Virtual Network
     EOT
 
-    command :rmar, rmar_desc, :vnetid, :ar_id do
+    command :rmar, rmar_desc, :vnetid, :ar_id, :options => FORCE do
         helper.perform_action(args[0], options, 'address range removed') do |vn|
-            vn.rm_ar(args[1])
+            vn.rm_ar(args[1], options[:force] || false)
         end
     end
 

data/bin/onevntemplate

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2019, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2020, OpenNebula Project, OpenNebula Systems                #
 #                                                                            #
 # 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    #
@@ -27,7 +27,9 @@ else
 end
 
 if File.directory?(GEMS_LOCATION)
-    Gem.use_paths(GEMS_LOCATION)
+    $LOAD_PATH.reject! {|l| l =~ /vendor_ruby/ }
+    require 'rubygems'
+    Gem.use_paths(File.realpath(GEMS_LOCATION))
 end
 
 $LOAD_PATH << RUBY_LIB_LOCATION

data/bin/onevrouter

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2019, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2020, OpenNebula Project, OpenNebula Systems                #
 #                                                                            #
 # 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    #
@@ -27,7 +27,9 @@ else
 end
 
 if File.directory?(GEMS_LOCATION)
-    Gem.use_paths(GEMS_LOCATION)
+    $LOAD_PATH.reject! {|l| l =~ /vendor_ruby/ }
+    require 'rubygems'
+    Gem.use_paths(File.realpath(GEMS_LOCATION))
 end
 
 $LOAD_PATH << RUBY_LIB_LOCATION

data/bin/onezone

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2019, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2020, OpenNebula Project, OpenNebula Systems                #
 #                                                                            #
 # 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    #
@@ -27,7 +27,9 @@ else
 end
 
 if File.directory?(GEMS_LOCATION)
-    Gem.use_paths(GEMS_LOCATION)
+    $LOAD_PATH.reject! {|l| l =~ /vendor_ruby/ }
+    require 'rubygems'
+    Gem.use_paths(File.realpath(GEMS_LOCATION))
 end
 
 $LOAD_PATH << RUBY_LIB_LOCATION
@@ -230,6 +232,9 @@ CommandParser::CmdParser.new(ARGV) do
 
     command :serversync, sync_desc, :server, :options => [DATABASE] do
         begin
+            # Suppress augeas require warning message
+            $VERBOSE = nil
+
             gem 'augeas', '~> 0.6'
             require 'augeas'
         rescue Gem::LoadError

data/lib/cli_helper.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2019, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2020, OpenNebula Project, OpenNebula Systems                #
 #                                                                            #
 # 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    #
@@ -181,9 +181,15 @@ module CLIHelper
     ANSI_YELLOW = "\33[33m"
 
     # CLI states
-    OK_STATES      = %w[runn rdy on configured SUCCESS]
-    BAD_STATES     = %w[fail err error ERROR]
-    REGULAR_STATES = %w[pending]
+    OK_STATES      = %w[runn rdy on configured SUCCESS RUNNING]
+    BAD_STATES     = %w[fail
+                        err
+                        error
+                        ERROR
+                        FAILED_DEPLOYING
+                        FAILED_UNDEPLOYING
+                        FAILED_SCALING]
+    REGULAR_STATES = %w[pending WARNING]
 
     # Set state color
     #
@@ -350,6 +356,12 @@ module CLIHelper
         # @param options [Hash] Object with CLI user options
         # @param top     [Boolean]     True to not update columns again
         def show(data, options = {}, top = false)
+            if options[:list]
+                @cli_columns = options[:list].collect {|o| o.upcase.to_sym }
+            else
+                @cli_columns = @default_columns
+            end
+
             update_columns(options) unless top
 
             if data.is_a? Hash
@@ -471,7 +483,7 @@ module CLIHelper
 
         # Get header in string format
         def header_str
-            @default_columns.collect do |c|
+            @cli_columns.collect do |c|
                 if @columns[c]
                     format_str(c, c.to_s)
                 else
@@ -489,12 +501,12 @@ module CLIHelper
 
             update_columns_size(options)
 
+            options[:csv_del] ? del = options[:csv_del] : del = ','
+
             if !options[:csv] && (!options.key? :no_header)
                 CLIHelper.print_header(header_str)
-            end
-
-            if options[:csv] && (!options.key? :no_header)
-                print_csv_data([@default_columns], options[:csv_del])
+            elsif options[:csv] && (!options.key? :no_header)
+                puts CSV.generate_line(@cli_columns, :col_sep => del)
             end
 
             @res_data ? print_data(@res_data, options) : puts
@@ -522,7 +534,13 @@ module CLIHelper
             del ? del = del : del = ','
 
             data.each do |l|
-                puts CSV.generate_line(l, :col_sep => del)
+                result = []
+
+                @cli_columns.each do |col|
+                    result << l[@default_columns.index(col)]
+                end
+
+                puts CSV.generate_line(result, :col_sep => del)
             end
         end
 
@@ -531,25 +549,26 @@ module CLIHelper
         # @param data        [Array]  Array with data to show
         # @param stat_column [String] Name of the state column
         def print_normal_data(data, stat_column)
-            ncolumns = @default_columns.length
-
             if stat_column
-                stat        = stat_column.upcase.to_sym
-                stat_column = @default_columns.index(stat)
+                stat = stat_column.upcase.to_sym
             else
-                stat_column = @default_columns.index(:STAT)
+                stat = :STAT
             end
 
             data.each do |l|
                 result = []
 
-                ncolumns.times do |i|
+                @cli_columns.each do |col|
+                    i = @default_columns.index(col)
+
+                    # Column might not exist
+                    next unless i
+
                     dat = l[i]
-                    col = @default_columns[i]
 
                     str = format_str(col, dat)
 
-                    str = CLIHelper.color_state(str) if i == stat_column
+                    str = CLIHelper.color_state(str) if col == stat
 
                     result << str
                 end
@@ -564,8 +583,17 @@ module CLIHelper
         #
         # @return        [Array] Array with selected columns information
         def data_array(data, options)
+            # Take default table columns and desired ones by the user
+            cols = @default_columns
+
+            @cli_columns.each do |col|
+                next if @default_columns.include?(col)
+
+                @default_columns.insert(@cli_columns.index(col) + 1, col)
+            end
+
             res_data = data.collect do |d|
-                @default_columns.collect do |c|
+                cols.collect do |c|
                     @columns[c][:proc].call(d).to_s if @columns[c]
                 end
             end
@@ -602,7 +630,7 @@ module CLIHelper
         def config_expand_data
             ret = []
 
-            @default_columns.each do |column|
+            @cli_columns.each do |column|
                 expand_c = @columns[column][:expand]
 
                 next unless expand_c
@@ -623,7 +651,7 @@ module CLIHelper
         def config_adjust_data
             ret = []
 
-            @default_columns.each do |column|
+            @cli_columns.each do |column|
                 next unless @columns[column][:adjust]
 
                 ret << column.to_s.downcase
@@ -647,13 +675,13 @@ module CLIHelper
 
             return if terminal_size.nil?
 
-            default_columns = columns_info(@default_columns)
+            default_columns = columns_info(@cli_columns)
             expand_columns  = columns_info(expand_columns)
 
             total_size     = total_columns_size(default_columns)
             columns_size   = total_columns_size(expand_columns)
 
-            terminal_size -= (@default_columns.size - 1)
+            terminal_size -= (@cli_columns.size - 1)
             left_size      = terminal_size - total_size
             remaining_size = left_size
 
@@ -725,7 +753,7 @@ module CLIHelper
             expand_data = []
 
             if expand_all
-                expand_data = @default_columns
+                expand_data = @cli_columns
             elsif expand
                 expand_data += options[:expand]
             end
@@ -739,7 +767,7 @@ module CLIHelper
             unless expand_all
                 adjust.each do |column|
                     column = column.upcase.to_sym
-                    size   = max_size(@default_columns.index(column))
+                    size   = max_size(@cli_columns.index(column))
 
                     if size && size > @columns[column][:size]
                         @columns[column][:adjust] = true
@@ -791,10 +819,6 @@ module CLIHelper
             rescue StandardError => e
                 CLIHelper.fail(e.message)
             end
-
-            return unless options[:list]
-
-            @default_columns = options[:list].collect {|o| o.upcase.to_sym }
         end
 
         # Filter data
@@ -815,7 +839,7 @@ module CLIHelper
                 m = s.match(/^(.*?)#{operators}(.*?)$/)
 
                 if m
-                    index = @default_columns.index(m[1].to_sym)
+                    index = @default_columns.index(m[1].upcase.to_sym)
 
                     if index
                         {

data/lib/command_parser.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2019, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2020, OpenNebula Project, OpenNebula Systems                #
 #                                                                            #
 # 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    #
@@ -140,6 +140,7 @@ module CommandParser
         # @option options [String] :name
         # @option options [String] :short
         # @option options [String] :large
+        # @option options [Boolean] :multiple
         # @option options [String] :description
         # @option options [Class] :format
         # @option options [Block] :proc The block receives the value of the
@@ -452,7 +453,7 @@ module CommandParser
 
             if comm.nil?
                 print_help
-                exit -1
+                exit 0
             end
 
             if comm[:deprecated]
@@ -463,16 +464,27 @@ module CommandParser
             parse(extra_options)
 
             if comm
-                @before_proc.call if @before_proc
+                begin
+                    @before_proc.call if @before_proc
+                rescue StandardError => e
+                    STDERR.puts e.message
+                    exit(-1)
+                end
 
                 check_args!(comm_name, comm[:arity], comm[:args_format])
 
-                rc = comm[:proc].call
-                if rc.instance_of?(Array)
-                    puts rc[1]
-                    exit rc.first
-                else
-                    exit(@exit_code || rc)
+                begin
+                    rc = comm[:proc].call
+
+                    if rc.instance_of?(Array)
+                        puts rc[1]
+                        exit rc.first
+                    else
+                        exit(@exit_code || rc)
+                    end
+                rescue StandardError => e
+                    STDERR.puts e.message
+                    exit(-1)
                 end
             end
         end
@@ -490,21 +502,28 @@ module CommandParser
                     args = []
                     args << e[:short] if e[:short]
                     args << e[:large]
+                    args << e[:multiple] if e[:multiple]
                     args << e[:format]
                     args << e[:description]
 
                     opts.on(*args) do |o|
-                        if e[:proc]
+                        if e[:proc] && !e[:multiple]
                             @options[e[:name].to_sym]=o
                             with_proc<<e
                         elsif e[:name]=="help"
                             print_help
-                            exit
+                            exit 0
                         elsif e[:name]=="version"
                             puts @version
-                            exit
-                        else
+                            exit 0
+                        elsif !e[:multiple]
                             @options[e[:name].to_sym]=o
+                        else
+                            if @options[e[:name].to_sym].nil?
+                                @options[e[:name].to_sym] = []
+                            end
+
+                            @options[e[:name].to_sym] << o
                         end
                     end
                 end
@@ -630,7 +649,7 @@ module CommandParser
             print_formatters
             puts
             if @version
-                puts "## LICENSE"
+                puts "## VERSION"
                 puts @version
             end
         end

data/lib/one_helper.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2019, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2020, OpenNebula Project, OpenNebula Systems                #
 #                                                                            #
 # 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    #
@@ -30,11 +30,7 @@ include OpenNebula
 module OpenNebulaHelper
     ONE_VERSION=<<-EOT
 OpenNebula #{OpenNebula::VERSION}
-Copyright 2002-2019, OpenNebula Project, OpenNebula Systems
-
-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
+Copyright 2002-2020, OpenNebula Project, OpenNebula Systems
 EOT
 
     if ONE_LOCATION
@@ -1203,6 +1199,18 @@ EOT
         end
     end
 
+    def OpenNebulaHelper.bytes_to_unit(value, unit = 'K')
+        j = 0
+        i = BinarySufix.index(unit).to_i
+
+        while j < i do
+            value /= 1024.0
+            j += 1
+        end
+
+        value
+    end
+
     # If the cluster name is empty, returns a '-' char.
     #
     # @param str [String || Hash] Cluster name, or empty Hash (when <CLUSTER/>)
@@ -1696,4 +1704,248 @@ EOT
             "-"
         end
     end
+
+    def OpenNebulaHelper.parse_user_inputs(inputs, get_defaults = false)
+        unless get_defaults
+            puts 'There are some parameters that require user input. ' \
+                 'Use the string <<EDITOR>> to launch an editor ' \
+                 '(e.g. for multi-line inputs)'
+        end
+
+        answers = {}
+
+        inputs.each do |key, val|
+            input_cfg = val.split('|', -1)
+
+            if input_cfg.length < 3
+                STDERR.puts 'Malformed user input. It should have at least 3 '\
+                            "parts separated by '|':"
+                STDERR.puts "  #{key}: #{val}"
+                exit(-1)
+            end
+
+            mandatory, type, description, params, initial = input_cfg
+            optional = mandatory.strip == 'O'
+            type.strip!
+            description.strip!
+
+            if input_cfg.length > 3
+                if input_cfg.length != 5
+                    STDERR.puts 'Malformed user input. It should have 5 parts'\
+                                " separated by '|':"
+                    STDERR.puts "  #{key}: #{val}"
+                    exit(-1)
+                end
+
+                params.strip!
+                initial.strip!
+            end
+
+            if get_defaults
+                answers[key]= initial unless mandatory == 'M'
+                next
+            end
+
+            puts "  * (#{key}) #{description}"
+
+            header = '    '
+            if !initial.nil? && initial != ''
+                header += "Press enter for default (#{initial}). "
+            end
+
+            case type
+            when 'text', 'text64'
+                print header
+
+                answer = STDIN.readline.chop
+
+                if answer == '<<EDITOR>>'
+                    answer = OpenNebulaHelper.editor_input
+                end
+
+                # use default in case it's empty
+                answer = initial if answer.empty?
+
+                if type == 'text64'
+                    answer = Base64.encode64(answer).strip.delete("\n")
+                end
+
+            when 'boolean'
+                print header
+
+                answer = STDIN.readline.chop
+
+                # use default in case it's empty
+                answer = initial if answer.empty?
+
+                unless %w[YES NO].include?(answer)
+                    STDERR.puts "Invalid boolean '#{answer}'"
+                    STDERR.puts 'Boolean has to be YES or NO'
+                    exit(-1)
+                end
+
+            when 'password'
+                print header
+
+                answer = OpenNebulaHelper::OneHelper.get_password
+
+                # use default in case it's empty
+                answer = initial if answer.empty?
+
+            when 'number', 'number-float'
+                if type == 'number'
+                    header += 'Integer: '
+                    exp = INT_EXP
+                else
+                    header += 'Float: '
+                    exp = FLOAT_EXP
+                end
+
+                begin
+                    print header
+                    answer = STDIN.readline.chop
+
+                    answer = initial if answer == ''
+                        noanswer = ((answer == '') && optional)
+                end while !noanswer && (answer =~ exp) == nil
+
+                if noanswer
+                    next
+                end
+
+            when 'range', 'range-float'
+                min, max = params.split('..')
+
+                if min.nil? || max.nil?
+                    STDERR.puts 'Malformed user input. '\
+                                "Parameters should be 'min..max':"
+                    STDERR.puts "  #{key}: #{val}"
+                    exit(-1)
+                end
+
+                if type == 'range'
+                    exp = INT_EXP
+                    min = min.to_i
+                    max = max.to_i
+
+                    header += "Integer in the range [#{min}..#{max}]: "
+                else
+                    exp = FLOAT_EXP
+                    min = min.to_f
+                    max = max.to_f
+
+                    header += "Float in the range [#{min}..#{max}]: "
+                end
+
+                begin
+                    print header
+                    answer = STDIN.readline.chop
+
+                    answer = initial if answer == ''
+
+                    noanswer = (answer == '') && optional
+                end while !noanswer && ((answer =~ exp) == nil ||
+                          answer.to_f < min || answer.to_f > max)
+
+                if noanswer
+                    next
+                end
+
+            when 'list'
+                options = params.split(',')
+
+                options.each_with_index do |opt, i|
+                    puts "    #{i}  #{opt}"
+                end
+
+                puts
+
+                header += 'Please type the selection number: '
+
+                begin
+                    print header
+                    answer = STDIN.readline.chop
+
+                    if answer == ''
+                        answer = initial
+                    else
+                        answer = options[answer.to_i]
+                    end
+
+                    noanswer = ((answer == '') && optional)
+                end while !noanswer && !options.include?(answer)
+
+                if noanswer
+                    next
+                end
+
+            when 'fixed'
+                puts "    Fixed value of (#{initial}). Cannot be changed"
+                answer = initial
+
+            else
+                STDERR.puts 'Wrong type for user input:'
+                STDERR.puts "  #{key}: #{val}"
+                exit(-1)
+            end
+
+            answers[key] = answer
+        end
+
+        answers
+    end
+
+    # Returns plot object to print it on the CLI
+    #
+    # @param x     [Array]  Data to x axis (Time axis)
+    # @param y     [Array]  Data to y axis
+    # @param attr  [String] Parameter to y axis
+    # @param title [String] Plot title
+    #
+    # @return Gnuplot plot object
+    def OpenNebulaHelper.get_plot(x, y, attr, title)
+        # Require gnuplot gem only here
+        begin
+            require 'gnuplot'
+        rescue LoadError, Gem::LoadError
+            STDERR.puts(
+                'Gnuplot gem is not installed, run `gem install gnuplot` '\
+                'to install it'
+            )
+            exit(-1)
+        end
+
+        # Check if gnuplot is installed on the system
+        unless system('gnuplot --version')
+            STDERR.puts(
+                'Gnuplot is not installed, install it depending on your distro'
+            )
+            exit(-1)
+        end
+
+        Gnuplot.open do |gp|
+            Gnuplot::Plot.new(gp) do |p|
+                p.title title
+
+                p.xlabel 'Time'
+                p.ylabel attr
+
+                p.xdata   'time'
+                p.timefmt "'%H:%M'"
+                p.format  "x '%H:%M'"
+
+                p.style    'data lines'
+                p.terminal 'dumb'
+
+                p.data << Gnuplot::DataSet.new([x, y]) do |ds|
+                    ds.with      = 'linespoints'
+                    ds.linewidth = '3'
+                    ds.using     = '1:2'
+
+                    ds.notitle
+                end
+            end
+        end
+    end
+
 end