opennebula-cli 7.0.2 → 7.2.0

data/lib/cli_helper.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2025, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2026, 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    #
@@ -265,6 +265,158 @@ module CLIHelper
         exit(-1)
     end
 
+    # Render a small HTML subset for terminal output
+    # Supports: p, br, ul/ol/li, strong/b, em/i, code, a[href]
+    def self.render_html(text)
+        return '' if text.nil? || text.empty?
+
+        use_ansi = $stdout.tty?
+
+        bold_on  = use_ansi ? "\33[1m"  : ''
+        faint_on = use_ansi ? "\33[2m"  : ''
+        reset    = use_ansi ? "\33[0m"  : ''
+        mono_on  = use_ansi ? "\33[36m" : ''
+        bullet   = use_ansi ? '•' : '*'
+
+        # OSC 8 hyperlink escape (clickable links)
+        osc8_link = lambda do |label, url|
+            return "#{label} (#{url})" unless use_ansi
+
+            "\e]8;;#{url}\a#{label}\e]8;;\a"
+        end
+
+        s = text.to_s.gsub("\r\n", "\n")
+
+        # Block tags -> newlines
+        s = s.gsub(%r{<\s*br\s*/?\s*>}i, "\n")
+        s = s.gsub(%r{<\s*/\s*p\s*>}i, "\n")
+        s = s.gsub(/<\s*p\b[^>]*>/i, '')
+        s = s.gsub(%r{<\s*/\s*(div|section|article)\s*>}i, "\n\n")
+        s = s.gsub(/<\s*(div|section|article)\b[^>]*>/i, '')
+
+        # Links: <a href="url">label</a>
+        s = s.gsub(%r{<\s*a\b[^>]*href\s*=\s*["']([^"']+)["'][^>]*>(.*?)<\s*/\s*a\s*>}im) do
+            url   = Regexp.last_match(1).strip
+            label = Regexp.last_match(2).to_s
+            osc8_link.call(label, url)
+        end
+
+        # Lists
+        s = s.gsub(/<\s*li\b[^>]*>/i, "#{bullet} ")
+
+        # Inline formatting
+        if use_ansi
+            s = s.gsub(%r{<\s*/\s*(strong|b)\s*>}i, reset)
+            s = s.gsub(/<\s*(strong|b)\b[^>]*>/i, bold_on)
+
+            s = s.gsub(%r{<\s*/\s*(em|i)\s*>}i, reset)
+            s = s.gsub(/<\s*(em|i)\b[^>]*>/i, faint_on)
+
+            # <code>
+            s = s.gsub(%r{<\s*code\b[^>]*>(.*?)<\s*/\s*code\s*>}im) do
+                "#{faint_on}#{mono_on}#{Regexp.last_match(1)}#{reset}"
+            end
+        else
+            s = s.gsub(%r{<\s*/?\s*(strong|b|em|i|code)\b[^>]*>}i, '')
+        end
+
+        # Remove any remaining tags
+        s = s.gsub(/<[^>]+>/, '')
+
+        # Decode minimal HTML entities
+        s = s.gsub('&amp;', '&')
+             .gsub('&lt;', '<')
+             .gsub('&gt;', '>')
+             .gsub('&quot;', '"')
+             .gsub('&#39;', "'")
+             .gsub('&nbsp;', ' ')
+
+        # Normalize whitespace
+        s = s.lines.map(&:rstrip).join("\n")
+        s.gsub(/\n{3,}/, "\n\n").strip
+    end
+
+    # Render a small Markdown subset for terminal output. Supports headings,
+    # bold, italic, inline code, and unordered lists.
+    def self.render_md(text)
+        return '' if text.nil? || text.empty?
+
+        use_ansi  = $stdout.tty?
+
+        bold_on   = use_ansi ? "\33[1m"  : ''
+        reset     = use_ansi ? "\33[0m"  : ''
+        faint_on  = use_ansi ? "\33[2m"  : ''
+        mono_on   = use_ansi ? "\33[36m" : ''
+        bullet    = use_ansi ? '•' : '*'
+
+        # OSC 8 hyperlink sequences
+        osc8_link = lambda do |label, url|
+            return "#{label} (#{url})" unless use_ansi
+
+            "\e]8;;#{url}\a#{label}\e]8;;\a"
+        end
+
+        lines = text.to_s.gsub("\r\n", "\n").split("\n", -1)
+
+        out = lines.map do |line|
+            # Preserve empty lines
+            if line.strip.empty?
+                ''
+            # Headings (#, ##, ###)
+            elsif (m = line.match(/\A\s{0,3}(\#{1,3})\s+(.*)\z/))
+                title = m[2].strip
+                "#{bold_on}#{title}#{reset}"
+            # Unordered list items (*, -, +)
+            elsif (m = line.match(/\A(\s*)[*+-]\s+(.*)\z/))
+                indent = m[1]
+                item   = m[2]
+                "#{indent}#{bullet} #{item}"
+            else
+                line
+            end
+        end.join("\n")
+
+        # Links [label](url)
+        out = out.gsub(/\[([^\]]+)\]\(([^)]+)\)/) do
+            label = Regexp.last_match(1)
+            url   = Regexp.last_match(2).strip
+            osc8_link.call(label, url)
+        end
+
+        # Autolinks <https://example.com>
+        out = out.gsub(/<((?:https?|mailto):[^>\s]+)>/) do
+            url = Regexp.last_match(1)
+            osc8_link.call(url, url)
+        end
+
+        # Inline formatting (simple, non-nested)
+        if use_ansi
+            # Inline code: `code`
+            out = out.gsub(/`([^`]+)`/) do
+                m = Regexp.last_match(1)
+                "#{faint_on}#{mono_on}#{m}#{reset}"
+            end
+
+            # Bold: **text**
+            out = out.gsub(/\*\*([^\*]+)\*\*/) do
+                m = Regexp.last_match(1)
+                "#{bold_on}#{m}#{reset}"
+            end
+
+            # Italic: *text*
+            out = out.gsub(/(^|[^*])\*([^*\n]+)\*(?!\*)/) do
+                m1 = Regexp.last_match(1)
+                m2 = Regexp.last_match(2)
+                "#{m1}#{faint_on}#{m2}#{reset}"
+            end
+        else
+            # Non-tty, keep markdown mostly as-is, but normalize list bullets
+            out = out.gsub(/\A(\s*)[*+-]\s+/m, "\\1#{bullet} ")
+        end
+
+        out
+    end
+
     # Check if value is in base64
     #
     # @param value [String] Value to check

data/lib/command_parser.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2025, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2026, 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/oneacct_helper.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2025, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2026, 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    #
@@ -16,6 +16,8 @@
 
 require 'one_helper'
 require 'optparse/time'
+require 'opennebula/virtual_machine'
+require 'opennebula/virtual_machine_pool'
 
 class AcctHelper < OpenNebulaHelper::OneHelper
     TIME_ZONE_CUR = {

data/lib/one_helper/oneacl_helper.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2025, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2026, 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    #
@@ -15,6 +15,8 @@
 #--------------------------------------------------------------------------- #
 
 require 'one_helper'
+require 'opennebula/acl'
+require 'opennebula/acl_pool'
 
 # Helper for oneacl command
 class OneAclHelper < OpenNebulaHelper::OneHelper

data/lib/one_helper/onebackupjob_helper.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2025, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2026, 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    #
@@ -15,6 +15,8 @@
 #--------------------------------------------------------------------------- #
 
 require 'one_helper'
+require 'opennebula/backupjob'
+require 'opennebula/backupjob_pool'
 
 # Helper for onebackupjob command
 class OneBackupJobHelper < OpenNebulaHelper::OneHelper

data/lib/one_helper/onecluster_helper.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2025, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2026, 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    #
@@ -15,6 +15,9 @@
 #--------------------------------------------------------------------------- #
 
 require 'one_helper'
+require 'opennebula/cluster'
+require 'opennebula/cluster_pool'
+require 'opennebula/host'
 
 # OneCluster CLI command helper
 class OneClusterHelper < OpenNebulaHelper::OneHelper

data/lib/one_helper/onedatastore_helper.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2025, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2026, 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    #
@@ -15,6 +15,9 @@
 #--------------------------------------------------------------------------- #
 
 require 'one_helper'
+require 'opennebula/datastore'
+require 'opennebula/datastore_pool'
+require 'opennebula/image'
 
 class OneDatastoreHelper < OpenNebulaHelper::OneHelper
     DATASTORE = {

data/lib/one_helper/oneflow_helper.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2025, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2026, 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/oneflowtemplate_helper.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2025, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2026, 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/oneform_helper.rb

@@ -0,0 +1,255 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2026, 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                                 #
+#                                                                            #
+# 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.                                             #
+#--------------------------------------------------------------------------- #
+
+require 'one_helper'
+
+# Oneflow Template command helper
+class OneFormHelper < OpenNebulaHelper::OneHelper
+
+    # Configuration file
+    def self.conf_file
+        'oneform.yaml'
+    end
+
+    # Get client to make request
+    #
+    # @options [Hash] CLI options
+    def client(options)
+        OneForm::Client.new(
+            :username => options[:username],
+            :password => options[:password],
+            :url => options[:server],
+            :api_version => options[:api_version],
+            :user_agent => USER_AGENT
+        )
+    end
+
+    def format_driver_pool
+        config_file = self.class.table_conf
+
+        CLIHelper::ShowTable.new(config_file, self) do
+            column :NAME, 'NAME', :left, :size => 15 do |d|
+                File.basename(d[:system_path])
+            end
+
+            column :DEPLOYMENTS, 'DEPLOYMENTS', :left, :expand => true do |d|
+                if d[:deployment_confs].nil? || d[:deployment_confs].empty?
+                    '--'
+                else
+                    d[:deployment_confs].map {|conf| conf[:inventory] || '--' }.join(', ')
+                end
+            end
+
+            column :STATE, 'Group', :left, :size => 10 do |d|
+                d[:state]
+            end
+
+            default :NAME, :DEPLOYMENTS, :STATE
+        end
+    end
+
+    # List drivers pool
+    #
+    # @param client  [OneForm::Client] Petition client
+    # @param options [Hash]            CLI options
+    def list_driver_pool(client, options, params = {})
+        response = client.list_drivers(params)
+
+        if CloudClient.is_error?(response)
+            [response[:err_code], response[:message]]
+        else
+            if options[:json]
+                [0, JSON.pretty_generate(response)]
+            elsif options[:yaml]
+                [0, response.to_yaml(:indent => 4)]
+            else
+                table = format_driver_pool
+
+                table.show(response, options)
+                table.describe_columns if options[:describe]
+
+                0
+            end
+        end
+    end
+
+    # List driver pool continiously
+    #
+    # @param client  [OneForm::Client] Petition client
+    # @param options [Hash]            CLI options
+    def top_driver_pool(client, options, params = {})
+        options[:delay] ? delay = options[:delay] : delay = 4
+
+        begin
+            loop do
+                CLIHelper.scr_cls
+                CLIHelper.scr_move(0, 0)
+
+                list_driver_pool(client, options, params)
+
+                sleep delay
+            end
+        rescue StandardError => e
+            STDERR.puts e.message
+            exit(-1)
+        end
+
+        0
+    end
+
+    # Show driver detailed information
+    #
+    # @param client           [OneForm::Client] Petition client
+    # @param driver_name         [String]          driver name
+    # @param options          [Hash]            CLI options
+    def format_resource(client, driver_name, options)
+        response = client.get_driver(driver_name)
+
+        if CloudClient.is_error?(response)
+            [response[:err_code], response[:message]]
+        else
+            if options[:json]
+                [0, JSON.pretty_generate(response)]
+            elsif options[:yaml]
+                [0, response.to_yaml(:indent => 4)]
+            else
+                str    = '%-20s: %-20s'
+                str_h1 = '%-80s'
+
+                driver_name = File.basename(response[:system_path])
+                CLIHelper.print_header(str_h1 % "#{driver_name.upcase} ONEFORM DRIVER INFORMATION")
+
+                puts Kernel.format str, 'NAME', response[:name]
+                puts Kernel.format str, 'DESCRIPTION', response[:description]
+                puts Kernel.format str, 'STATE', response[:state]
+                puts Kernel.format str, 'SOURCE', response[:registry]
+                puts Kernel.format str, 'VERSION', response[:version]
+
+                puts
+
+                connection_inputs = response[:connection] || {}
+
+                CLIHelper.print_header(str_h1 % 'CONNECTION INPUTS', false)
+                CLIHelper::ShowTable.new(nil, self) do
+                    column :NAME, '', :left, :size => 25, :adjust => true do |input|
+                        input[:name] || '--'
+                    end
+
+                    column :TYPE, '', :left, :size => 15 do |input|
+                        input[:type] || '--'
+                    end
+
+                    column :DEFAULT, '', :left, :size => 30 do |input|
+                        if input[:default].is_a?(Hash) || input[:default].is_a?(Array)
+                            input[:default].to_json
+                        else
+                            input[:default] || '--'
+                        end
+                    end
+
+                    default :NAME, :TYPE, :DEFAULT
+                end.show(connection_inputs, {})
+
+                puts
+
+                user_inputs = response[:user_inputs] || {}
+
+                CLIHelper.print_header(str_h1 % 'PROVISIONING INPUTS', false)
+                CLIHelper::ShowTable.new(nil, self) do
+                    column :NAME, '', :left, :size => 25, :adjust => true do |input|
+                        input[:name] || '--'
+                    end
+
+                    column :TYPE, '', :left, :size => 15 do |input|
+                        input[:type] || '--'
+                    end
+
+                    column :DEFAULT, '', :left, :size => 30 do |input|
+                        if input[:default].is_a?(Hash) || input[:default].is_a?(Array)
+                            input[:default].to_json
+                        else
+                            input[:default] || '--'
+                        end
+                    end
+
+                    default :NAME, :TYPE, :DEFAULT
+                end.show(user_inputs, {})
+
+                puts
+
+                CLIHelper.print_header(str_h1 % 'DEPLOYMENT CONFIGURATIONS', true)
+                puts
+
+                configs = response[:deployment_confs] || []
+
+                configs.each do |conf|
+                    CLIHelper.print_header(str_h1 % conf[:name].upcase, false)
+
+                    puts conf[:description].nil? ? '--' : CLIHelper.render_html(conf[:description])
+                    puts
+
+                    next unless conf[:user_inputs] && !conf[:user_inputs].empty?
+
+                    CLIHelper.print_header("#{conf[:inventory].upcase} CONFIGURATION INPUTS", false)
+                    CLIHelper::ShowTable.new(nil, self) do
+                        column :NAME, '', :left, :size => 25, :adjust => true do |input|
+                            input[:name] || '--'
+                        end
+
+                        column :TYPE, '', :left, :size => 15 do |input|
+                            input[:type] || '--'
+                        end
+
+                        column :DEFAULT, '', :left, :size => 30 do |input|
+                            if input[:default].is_a?(Hash) || input[:default].is_a?(Array)
+                                input[:default].to_json
+                            else
+                                input[:default] || '--'
+                            end
+                        end
+
+                        default :NAME, :TYPE, :DEFAULT
+                    end.show(conf[:user_inputs], {})
+
+                    puts
+                end
+
+                remaining = response.reject do |k, _|
+                    [
+                        :name,
+                        :description,
+                        :version,
+                        :registry,
+                        :state,
+                        :fireedge,
+                        :connection,
+                        :user_inputs,
+                        :deployment_confs,
+                        :system_path
+                    ].include?(k)
+                end
+
+                if remaining.any?
+                    CLIHelper.print_header('USER TEMPLATE', false)
+                    puts JSON.pretty_generate(remaining)
+                end
+
+                0
+            end
+        end
+    end
+
+end