opennebula-cli 5.12.7 → 6.0.0

data/lib/one_helper/onequota_helper.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2020, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2021, 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    #

data/lib/one_helper/onesecgroup_helper.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2020, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2021, 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    #

data/lib/one_helper/onetemplate_helper.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2020, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2021, 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    #
@@ -87,6 +87,17 @@ EOT
 
         if options[:xml]
             return 0, resource.to_xml(true)
+        elsif options[:json]
+            # If body is set, the resource contains a JSON inside
+            if options[:body]
+                return 0, check_resource_xsd(resource)
+            else
+                return 0, ::JSON.pretty_generate(
+                    check_resource_xsd(resource)
+                )
+            end
+        elsif options[:yaml]
+            return 0, check_resource_xsd(resource).to_yaml(:indent => 4)
         else
             format_resource(resource, options)
             return 0

data/lib/one_helper/oneuser_helper.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2020, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2021, 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    #
@@ -284,6 +284,14 @@ class OneUserHelper < OpenNebulaHelper::OneHelper
                 d["NAME"]
             end
 
+            column :ENABLED, "User is enabled", :left, :size=>4 do |d|
+                if d["ENABLED"] == "1"
+                    "yes"
+                else
+                    "no"
+                end
+            end
+
             column :GROUP, "Group of the User", :left, :size=>10 do |d|
                 helper.group_name(d, options)
             end
@@ -434,7 +442,7 @@ class OneUserHelper < OpenNebulaHelper::OneHelper
                 d['PASSWORD']
             end
 
-            default :ID, :NAME, :GROUP, :AUTH, :VMS, :MEMORY, :CPU
+            default :ID, :NAME, :ENABLED, :GROUP, :AUTH, :VMS, :MEMORY, :CPU
         end
 
         table
@@ -556,7 +564,7 @@ class OneUserHelper < OpenNebulaHelper::OneHelper
             CLIHelper::ShowTable.new(nil, self) do
                 column :ID, "", :size=>7 do |d|
                     d["TOKEN"]
-               end
+                end
 
                 column :EGID, "", :left, :size=>5 do |d|
                     d["EGID"].to_i == -1 ? "*" + gid : d["EGID"]

data/lib/one_helper/onevcenter_helper.rb

@@ -1,6 +1,5 @@
-
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2020, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2021, 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    #
@@ -17,16 +16,21 @@
 
 require 'one_helper'
 
+##############################################################################
+# Module OneVcenterHelper
+##############################################################################
 class OneVcenterHelper < OpenNebulaHelper::OneHelper
 
     #
     # vCenter importer will divide rvmomi resources
     # in this group, makes parsing easier.
     module VOBJECT
-      DATASTORE = 1
-      TEMPLATE = 2
-      NETWORK = 3
-      IMAGE = 4
+
+        DATASTORE = 1
+        TEMPLATE = 2
+        NETWORK = 3
+        IMAGE = 4
+
     end
 
     #
@@ -37,45 +41,53 @@ class OneVcenterHelper < OpenNebulaHelper::OneHelper
     # struct:   [Array] LIST FORMAT for opennebula cli
     #           related methods: * cli_format
     #
-    # columns:  [Hash(column => Integer)] Will be used in the list command, Integer represent nbytes
+    # columns:  [Hash(column => Integer)] Will be used in the list command,
+    #           Integer represent nbytes
     #           related methods: * format_list
     #
-    # cli:      [Array] with mandatory args, for example image listing needs a datastore
+    # cli:      [Array] with mandatory args, for example image
+    #           listing needs a datastore
     #           related methods: * parse_opts
     #
-    # dialogue: [Lambda] Used only for Vobject that require a previous dialogue with the user, will be triggered
+    # dialogue: [Lambda] Used only for Vobject that require a previous
+    #                    dialogue with the user, will be triggered
     #                    on importation process
     #           related methods: * network_dialogue
     #                            * template_dialogue
     #
     TABLE = {
         VOBJECT::DATASTORE => {
-            :struct  => ["DATASTORE_LIST", "DATASTORE"],
-            :columns => {:IMID => 5, :REF => 15, :NAME => 50, :CLUSTERS => 10},
+            :struct  => %w[DATASTORE_LIST DATASTORE],
+            :columns =>
+                { :IMID => 5, :REF => 15, :NAME => 50, :CLUSTERS => 10 },
             :cli     => [:host],
-            :dialogue => ->(arg){}
+            :dialogue => ->(arg) {}
         },
         VOBJECT::TEMPLATE => {
-            :struct  => ["TEMPLATE_LIST", "TEMPLATE"],
-            :columns => {:IMID => 5, :REF => 10, :NAME => 50},
+            :struct  => %w[TEMPLATE_LIST TEMPLATE],
+            :columns => { :IMID => 5, :REF => 10, :NAME => 50 },
             :cli     => [:host],
-            :dialogue => ->(arg){ OneVcenterHelper.template_dialogue(arg) }
+            :dialogue => ->(arg) { OneVcenterHelper.template_dialogue(arg) }
         },
         VOBJECT::NETWORK => {
-            :struct  => ["NETWORK_LIST", "NETWORK"],
-            :columns => {:IMID => 5, :REF => 15, :NAME => 30, :CLUSTERS => 20},
+            :struct  => %w[NETWORK_LIST NETWORK],
+            :columns => {
+                :IMID => 5,
+                :REF => 15,
+                :NAME => 30,
+                :CLUSTERS => 20
+            },
             :cli     => [:host],
-            :dialogue => ->(arg){ OneVcenterHelper.network_dialogue(arg) }
+            :dialogue => ->(arg) { OneVcenterHelper.network_dialogue(arg) }
         },
         VOBJECT::IMAGE => {
-            :struct  => ["IMAGE_LIST", "IMAGE"],
-            :columns => {:IMID => 5,:REF => 35, :PATH => 60},
+            :struct  => %w[IMAGE_LIST IMAGE],
+            :columns => { :IMID => 5, :REF => 35, :PATH => 60 },
             :cli     => [:host, :datastore],
-            :dialogue => ->(arg){}
+            :dialogue => ->(arg) {}
         }
     }
 
-
     ################################################################
     # CLI ARGS
     ################################################################
@@ -83,28 +95,27 @@ class OneVcenterHelper < OpenNebulaHelper::OneHelper
     # these methods will be used by table :cli property
     # the purpose is to inject code when -d option in this case is used
     #
-	# @param arg [String] The parameter passed to the option:w
+    # @param arg [String] The parameter passed to the option:w
     #
 
     def datastore(arg)
         ds = VCenterDriver::VIHelper.one_item(OpenNebula::Datastore, arg)
 
         {
-            ds_ref: ds['TEMPLATE/VCENTER_DS_REF'],
-            one_item: ds
+            :ds_ref => ds['TEMPLATE/VCENTER_DS_REF'],
+            :one_item => ds
         }
     end
 
     def host(arg)
-        return arg
+        arg
     end
 
     ########################
 
-
     # In list command you can use this method to print a header
     #
-	# @param vcenter_host [String] this text will be displayed
+    # @param vcenter_host [String] this text will be displayed
     #
     def show_header(vcenter_host)
         CLIHelper.scr_bold
@@ -112,33 +123,33 @@ class OneVcenterHelper < OpenNebulaHelper::OneHelper
         puts "# vCenter: #{vcenter_host}".ljust(50)
         CLIHelper.scr_restore
         puts
-
     end
 
     # Using for parse a String into a VOBJECT
     # We will use VOBJECT instances for handle any operatiion
     #
-	# @param type [String] String representing the vCenter resource
+    # @param type [String] String representing the vCenter resource
     #
-    def set_object(type)
-        raise "you need to use -o option!" unless type
+    def object_update(type)
+        raise 'you need to use -o option!' unless type
 
         type = type.downcase
-        if (type == "datastores")
+        case type
+        when 'datastores'
             @vobject = VOBJECT::DATASTORE
-        elsif (type == "templates")
+        when 'templates'
             @vobject = VOBJECT::TEMPLATE
-        elsif (type =="networks")
+        when 'networks'
             @vobject = VOBJECT::NETWORK
-        elsif (type == "images")
+        when 'images'
             @vobject = VOBJECT::IMAGE
         else
             puts "unknown #{type} type option"
-            puts "  -o options:"
-            puts "      datastores"
-            puts "      templates"
-            puts "      networks"
-            puts "      images"
+            puts '  -o options:'
+            puts '      datastores'
+            puts '      templates'
+            puts '      networks'
+            puts '      images'
 
             exit 0
         end
@@ -146,11 +157,11 @@ class OneVcenterHelper < OpenNebulaHelper::OneHelper
 
     # Handles connection to vCenter.
     #
-	# @param options [Hash] options for the connection
+    # @param options [Hash] options for the connection
     #
     def connection_options(object_name, options)
         if  options[:vuser].nil? || options[:vcenter].nil?
-            raise "vCenter connection parameters are mandatory to import"\
+            raise 'vCenter connection parameters are mandatory to import'\
                   " #{object_name}:\n"\
                   "\t --vcenter vCenter hostname\n"\
                   "\t --vuser username to login in vcenter"
@@ -158,23 +169,29 @@ class OneVcenterHelper < OpenNebulaHelper::OneHelper
 
         password = options[:vpass] || OpenNebulaHelper::OneHelper.get_password
         {
-           :user     => options[:vuser],
-           :password => password,
-           :host     => options[:vcenter],
-           :port     => options[:port]
+            :user     => options[:vuser],
+            :password => password,
+            :host     => options[:vcenter],
+            :port     => options[:port]
         }
     end
 
-    def cli_format( hash)
-        {TABLE[@vobject][:struct].first => {TABLE[@vobject][:struct].last => hash.values}}
+    def cli_format(hash)
+        {
+            TABLE[@vobject][:struct].first =>
+                {
+                    TABLE[@vobject][:struct].last =>
+                        hash.values
+                }
+        }
     end
 
     # This method will print a list for a vcenter_resource.
     #
-    def list_object(options, list)
+    def list_object(_options, list)
         vcenter_host = list.keys[0]
         list = cli_format(list.values.first)
-        table = format_list()
+        table = format_list
 
         show_header(vcenter_host)
 
@@ -184,11 +201,12 @@ class OneVcenterHelper < OpenNebulaHelper::OneHelper
     # handles :cli section of TABLE
     # used for executing the dialogue in some VOBJECTS
     #
-    # @param object_info [Hash] This is the object with all the info related to the object
+    # @param object_info [Hash] This is the object
+    #                           with all the info related to the object
     #                           that will be imported
     #
     def cli_dialogue(object_info)
-        return TABLE[@vobject][:dialogue].(object_info)
+        TABLE[@vobject][:dialogue].call(object_info)
     end
 
     # This method iterates over the possible options for certain resources
@@ -197,17 +215,18 @@ class OneVcenterHelper < OpenNebulaHelper::OneHelper
     # @param opts [Hash] options object passed to the onecenter tool
     #
     def parse_opts(opts)
-        set_object(opts[:object])
+        object_update(opts[:object])
 
         res = {}
         TABLE[@vobject][:cli].each do |arg|
             raise "#{arg} it's mandadory for this op" if opts[arg].nil?
-            res[arg] = self.method(arg).call(opts[arg])
+
+            res[arg] = method(arg).call(opts[arg])
         end
 
         res[:config] = parse_file(opts[:configuration]) if opts[:configuration]
 
-        return res
+        res
     end
 
     # This method will parse a yaml
@@ -218,8 +237,8 @@ class OneVcenterHelper < OpenNebulaHelper::OneHelper
     #
     def parse_file(path)
         begin
-            config = YAML::load(File.read(path))
-        rescue Exception => e
+            _config = YAML.safe_load(File.read(path))
+        rescue StandardError => _e
             str_error="Unable to read '#{path}'. Invalid YAML syntax:\n"
 
             raise str_error
@@ -230,42 +249,44 @@ class OneVcenterHelper < OpenNebulaHelper::OneHelper
     # with the purpose of build a complete CLI list
     # OpenNebula way
     #
-    def format_list()
+    def format_list
         config = TABLE[@vobject][:columns]
-        table = CLIHelper::ShowTable.new() do
-            column :IMID, "identifier for ...", :size=>config[:IMID] || 4 do |d|
+        CLIHelper::ShowTable.new do
+            column :IMID, 'identifier for ...', :size=>config[:IMID] || 4 do |d|
                 d[:import_id]
             end
 
-            column :REF, "ref", :left, :adjust, :size=>config[:REF] || 15 do |d|
+            column :REF, 'ref', :left, :adjust, :size=>config[:REF] || 15 do |d|
                 d[:ref]
             end
 
-            column :NAME, "Name", :left, :expand, :size=>config[:NAME] || 20 do |d|
+            column :NAME, 'Name', :left, :expand,
+                   :size=>config[:NAME] || 20 do |d|
                 d[:name] || d[:simple_name]
             end
 
-            column :CLUSTERS, "CLUSTERS", :left, :size=>config[:CLUSTERS] || 10 do |d|
+            column :CLUSTERS, 'CLUSTERS', :left,
+                   :size=>config[:CLUSTERS] || 10 do |d|
                 d = d[:clusters] if d[:clusters]
                 d[:one_ids] || d[:cluster].to_s
             end
 
-            column :PATH, "PATH", :left, :expand, :size=>config[:PATH] || 10 do |d|
+            column :PATH, 'PATH', :left, :expand,
+                   :size=>config[:PATH] || 10 do |d|
                 d[:path]
             end
 
             default(*config.keys)
         end
-
-        table
     end
 
     ################################################################
     # CLI DIALOGUES
     ################################################################
     def self.template_dialogue(t)
-        rps_list = -> {
-            return "" if t[:rp_list].empty?
+        rps_list = lambda {
+            return '' if t[:rp_list].empty?
+
             puts
             t[:rp_list].each do |rp|
                 puts "      #{rp[:name]}"
@@ -277,91 +298,96 @@ class OneVcenterHelper < OpenNebulaHelper::OneHelper
 
         # default opts
         opts = {
-            linked_clone: '0',
-            copy: '0',
-            name: '',
-            folder: '',
-            resourcepool: [],
-            type: ''
+            :linked_clone => '0',
+            :copy => '0',
+            :name => '',
+            :folder => '',
+            :resourcepool => [],
+            :type => ''
         }
 
         STDOUT.print "\n- Template: \e[92m#{t[:template_name]}\e[39m\n\n"\
 
         # LINKED CLONE OPTION
         STDOUT.print "\n    For faster deployment operations"\
-                     " and lower disk usage, OpenNebula"\
-                     " can create new VMs as linked clones."\
-                     "\n    Would you like to use Linked Clones with VMs based on this template (y/[n])? "
+                     ' and lower disk usage, OpenNebula'\
+                     ' can create new VMs as linked clones.'\
+                     "\n    Would you like to use Linked Clones"\
+                     ' with VMs based on this template (y/[n])? '
 
         if STDIN.gets.strip.downcase == 'y'
             opts[:linked_clone] = '1'
 
-
             # CREATE COPY OPTION
             STDOUT.print "\n    Linked clones requires that delta"\
-                         " disks must be created for each disk in the template."\
-                         " This operation may change the template contents."\
-                         " \n    Do you want OpenNebula to create a copy of the template,"\
-                         " so the original template remains untouched ([y]/n)? "
+                         ' disks must be created for '\
+                         'each disk in the template.'\
+                         ' This operation may change the template contents.'\
+                         " \n    Do you want OpenNebula to "\
+                         'create a copy of the template,'\
+                         ' so the original template remains untouched ([y]/n)? '
 
             if STDIN.gets.strip.downcase != 'n'
                 opts[:copy] = '1'
 
                 # NAME OPTION
                 STDOUT.print "\n    The new template will be named"\
-                             " adding a one- prefix to the name"\
+                             ' adding a one- prefix to the name'\
                              " of the original template. \n"\
-                             "    If you prefer a different name"\
-                             " please specify or press Enter"\
-                             " to use defaults: "
+                             '    If you prefer a different name'\
+                             ' please specify or press Enter'\
+                             ' to use defaults: '
 
                 template_name = STDIN.gets.strip.downcase
                 opts[:name] = template_name
 
-                STDOUT.print "\n    WARNING!!! The cloning operation can take some time"\
+                STDOUT.print "\n    WARNING!!! The cloning "\
+                             'operation can take some time'\
                              " depending on the size of disks.\n"
             end
         end
 
-        STDOUT.print "\n\n    Do you want to specify a folder where"\
-                        " the deployed VMs based on this template will appear"\
-                        " in vSphere's VM and Templates section?"\
-                        "\n    If no path is set, VMs will be placed in the same"\
-                        " location where the template lives."\
-                        "\n    Please specify a path using slashes to separate folders"\
-                        " e.g /Management/VMs or press Enter to use defaults: "\
+        sdtout_print = "\n\n    Do you want to specify a folder where"\
+        ' the deployed VMs based on this template will appear'\
+        " in vSphere's VM and Templates section?"\
+        "\n    If no path is set, VMs will be placed in the same"\
+        ' location where the template lives.'\
+        "\n    Please specify a path using slashes to separate folders"\
+        ' e.g /Management/VMs or press Enter to use defaults: '\
+
+        STDOUT.print sdtout_print
 
         vcenter_vm_folder = STDIN.gets.strip
         opts[:folder] = vcenter_vm_folder
 
         STDOUT.print "\n\n    This template is currently set to "\
-            "launch VMs in the default resource pool."\
+            'launch VMs in the default resource pool.'\
             "\n    Press y to keep this behaviour, n to select"\
-            " a new resource pool or d to delegate the choice"\
-            " to the user ([y]/n/d)? "
+            ' a new resource pool or d to delegate the choice'\
+            ' to the user ([y]/n/d)? '
 
-        answer =  STDIN.gets.strip.downcase
+        answer = STDIN.gets.strip.downcase
 
         case answer.downcase
         when 'd' || 'delegate'
             opts[:type]='list'
             puts "separate with commas ',' the list that you want to deleate:"
 
-            opts[:resourcepool] = rps_list.call.gsub(/\s+/, "").split(",")
+            opts[:resourcepool] = rps_list.call.gsub(/\s+/, '').split(',')
 
         when 'n' || 'no'
             opts[:type]='fixed'
-            puts "choose the proper name"
+            puts 'choose the proper name'
             opts[:resourcepool] = rps_list.call
         else
             opts[:type]='default'
         end
 
-        return opts
+        opts
     end
 
     def self.network_dialogue(n)
-        ask = ->(question, default = ""){
+        ask = lambda {|question, default = ''|
             STDOUT.print question
             answer = STDIN.gets.strip
 
@@ -372,59 +398,63 @@ class OneVcenterHelper < OpenNebulaHelper::OneHelper
 
         STDOUT.print "\n- Network: \e[92m#{n[:name]}\e[39m\n\n"\
 
-        opts = { size: "255", type: "ether" }
+        opts = { :size => '255', :type => 'ether' }
 
-		question =  "    How many VMs are you planning"\
-					" to fit into this network [255]? "
-        opts[:size] = ask.call(question, "255")
+        question =  '    How many VMs are you planning'\
+                    ' to fit into this network [255]? '
+        opts[:size] = ask.call(question, '255')
 
-		question = "    What type of Virtual Network"\
-				   " do you want to create (IPv[4],IPv[6], [E]thernet)? "
-        type_answer = ask.call(question, "ether")
+        question = '    What type of Virtual Network'\
+                   ' do you want to create (IPv[4],IPv[6], [E]thernet)? '
+        type_answer = ask.call(question, 'ether')
 
-        supported_types = ["4","6","ether", "e", "ip4", "ip6" ]
+        supported_types = %w[4 6 ether e ip4 ip6]
         if !supported_types.include?(type_answer)
-            type_answer =  'e'
-			STDOUT.puts "    Type [#{type_answer}] not supported,"\
-						" defaulting to Ethernet."
+            type_answer = 'e'
+            STDOUT.puts "    Type [#{type_answer}] not supported,"\
+                        ' defaulting to Ethernet.'
         end
-        question_ip  = "    Please input the first IP in the range: "
-        question_mac = "    Please input the first MAC in the range [Enter for default]: "
+        question_ip =
+            '    Please input the first IP in the range: '
+        question_mac =
+            '    Please input the first MAC in the range [Enter for default]: '
 
         case type_answer.downcase
-		when "4", "ip4"
-			opts[:ip]  = ask.call(question_ip)
-			opts[:mac] = ask.call(question_mac)
-            opts[:type] = "ip"
-		when "6", "ip6"
-			opts[:mac] = ask.call(question_mac)
-
-			question =   "    Do you want to use SLAAC "\
-						 "Stateless Address Autoconfiguration? ([y]/n): "
+        when '4', 'ip4'
+            opts[:ip]  = ask.call(question_ip)
+            opts[:mac] = ask.call(question_mac)
+            opts[:type] = 'ip'
+        when '6', 'ip6'
+            opts[:mac] = ask.call(question_mac)
+
+            question =   '    Do you want to use SLAAC '\
+                         'Stateless Address Autoconfiguration? ([y]/n): '
             slaac_answer = ask.call(question, 'y').downcase
 
-			if slaac_answer == 'n'
-				question =  "    Please input the IPv6 address (cannot be empty): "
-				opts[:ip6] = ask.call(question)
+            if slaac_answer == 'n'
+                question =
+                    '    Please input the IPv6 address (cannot be empty): '
+                opts[:ip6] = ask.call(question)
 
-				question =  "    Please input the Prefix length (cannot be empty): "
-				opts[:prefix_length] = ask.call(question)
+                question =
+                    '    Please input the Prefix length (cannot be empty): '
+                opts[:prefix_length] = ask.call(question)
                 opts[:type] = 'ip6_static'
-			else
-				question =  "    Please input the GLOBAL PREFIX "\
-							"[Enter for default]: "
-				opts[:global_prefix] = ask.call(question)
-
-				question=  "    Please input the ULA PREFIX "\
-						   "[Enter for default]: "
-				opts[:ula_prefix] = ask.call(question)
-                opts[:type]       = 'ip6'
-			end
-		when "e", "ether"
-			opts[:mac] = ask.call(question_mac)
-		end
-
-        return opts
+            else
+                question = '    Please input the GLOBAL PREFIX '\
+                            '[Enter for default]: '
+                opts[:global_prefix] = ask.call(question)
+
+                question= '    Please input the ULA PREFIX '\
+                           '[Enter for default]: '
+                opts[:ula_prefix] = ask.call(question)
+                opts[:type] = 'ip6'
+            end
+        when 'e', 'ether'
+            opts[:mac] = ask.call(question_mac)
+        end
+
+        opts
     end
 
     def clear_tags(vmid)
@@ -469,7 +499,7 @@ class OneVcenterHelper < OpenNebulaHelper::OneHelper
             end
         end
 
-        return vm, keys_to_remove
+        [vm, keys_to_remove]
     end
 
     def remove_keys(vm, keys_to_remove)