foreman_fog_proxmox 0.12.1 → 0.13.2

data/app/{models/foreman_fog_proxmox/proxmox_token_expiration.rb → helpers/proxmox_vm_uuid_helper.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019 Tristan Robert
+# Copyright 2018 Tristan Robert
 
 # This file is part of ForemanFogProxmox.
 
@@ -11,20 +11,24 @@
 
 # ForemanFogProxmox is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
 
 # You should have received a copy of the GNU General Public License
 # along with ForemanFogProxmox. If not, see <http://www.gnu.org/licenses/>.
 
-module ForemanFogProxmox
-  module ProxmoxTokenExpiration
-    def token_expired?
-      Fog::Proxmox.credentials_has_expired?
-    end
+module ProxmoxVmUuidHelper
+  UUID_REGEXP = /(?<cluster_id>\d+)[_](?<vmid>\d+)/.freeze
+  def extract(uuid, name)
+    captures_h = uuid ? UUID_REGEXP.match(uuid.to_s) : { cluster_id: '', vmid: '' }
+    captures_h ? captures_h[name] : ''
+  end
+
+  def match_uuid?(uuid)
+    extract(uuid, :cluster_id) != ''
+  end
 
-    def token_deadline
-      Fog::Proxmox.credentials[:deadline]
-    end
+  def extract_vmid(uuid)
+    extract(uuid, :vmid)
   end
 end

data/app/helpers/proxmox_vm_volumes_helper.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+# Copyright 2018 Tristan Robert
+
+# This file is part of ForemanFogProxmox.
+
+# ForemanFogProxmox is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# ForemanFogProxmox is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with ForemanFogProxmox. If not, see <http://www.gnu.org/licenses/>.
+
+require 'fog/proxmox/helpers/disk_helper'
+require 'fog/proxmox/helpers/nic_helper'
+require 'foreman_fog_proxmox/value'
+require 'foreman_fog_proxmox/hash_collection'
+
+# Convert a foreman form server hash into a fog-proxmox server attributes hash
+module ProxmoxVmVolumesHelper
+  include ProxmoxVmCdromHelper
+  include ProxmoxVmCloudinitHelper
+  KILO = 1024
+  MEGA = KILO * KILO
+  GIGA = KILO * MEGA
+
+  def add_disk_options(disk, args)
+    options = ForemanFogProxmox::HashCollection.new_hash_reject_keys(args, ['id', 'volid', 'controller', 'device', 'storage', 'size', '_delete', 'storage_type'])
+    ForemanFogProxmox::HashCollection.remove_empty_values(options)
+    disk[:options] = options
+  end
+
+  def parsed_typed_volumes(args, type, parsed_vm)
+    logger.debug(format(_('parsed_typed_volumes(%<type>s): args=%<args>s'), args: args, type: type))
+    volumes_attributes = args['volumes_attributes']
+    volumes_attributes ||= args['config_attributes']['volumes_attributes'] unless ForemanFogProxmox::Value.empty?(args['config_attributes'])
+    volumes_attributes ||= args['vm_attrs']['volumes_attributes'] unless ForemanFogProxmox::Value.empty?(args['vm_attrs'])
+    volumes = parse_typed_volumes(volumes_attributes, type)
+    volumes.each { |volume| parsed_vm = parsed_vm.merge(volume) }
+    parsed_vm
+  end
+
+  def parse_hard_disk_volume(args)
+    disk = {}
+    disk[:id] = args['id'] if args.key?('id')
+    disk[:volid] = args['volid'] if args.key?('volid')
+    disk[:storage] = args['storage'].to_s if args.key?('storage')
+    disk[:size] = args['size'].to_i if args.key?('size')
+    add_disk_options(disk, args)
+    disk.key?(:storage) ? disk : {}
+  end
+
+  def volume_type?(args, type)
+    if args.key?('storage_type')
+      args['storage_type'] == type
+    else
+      Fog::Proxmox::DiskHelper.cloud_init?(args['volid']) if type == 'cloud_init'
+      Fog::Proxmox::DiskHelper.cdrom?(args['volid']) if type == 'cdrom'
+      Fog::Proxmox::DiskHelper.disk?(args['id']) if ['hard_disk', 'rootfs', 'mp'].include?(type)
+    end
+  end
+
+  def parse_typed_volume(args, type)
+    logger.debug(format(_('parse_typed_volume(%<type>s): args=%<args>s'), args: args, type: type))
+    disk = parse_hard_disk_volume(args) if volume_type?(args, 'hard_disk') || volume_type?(args, 'mp') || volume_type?(args, 'rootfs')
+    disk = parse_server_cloudinit(args) if volume_type?(args, 'cloud_init')
+    disk = parse_server_cdrom(args) if volume_type?(args, 'cdrom')
+    logger.debug(format(_('parse_typed_volume(%<type>s): disk=%<disk>s'), disk: disk, type: type))
+    Fog::Proxmox::DiskHelper.flatten(disk) unless disk.empty?
+  end
+
+  def add_typed_volume(volumes, value, type)
+    volume = parse_typed_volume(value, type)
+    volumes.push(volume) unless ForemanFogProxmox::Value.empty?(volume)
+  end
+
+  def parse_typed_volumes(args, type)
+    logger.debug(format(_('parse_typed_volumes(%<type>s): args=%<args>s'), args: args, type: type))
+    volumes = []
+    args&.each_value { |value| add_typed_volume(volumes, value, type) }
+    volumes
+  end
+
+  def convert_volumes_size(args)
+    args['volumes_attributes'].each_value { |value| value['size'] = (value['size'].to_i / GIGA).to_s unless ForemanFogProxmox::Value.empty?(value['size']) }
+  end
+
+  def convert_sizes(args)
+    convert_memory_size(args['config_attributes'], 'memory')
+    convert_memory_size(args['config_attributes'], 'balloon')
+    convert_memory_size(args['config_attributes'], 'shares')
+    convert_memory_size(args['config_attributes'], 'swap')
+    args['volumes_attributes'].each_value { |value| value['size'] = (value['size'].to_i / GIGA).to_s unless ForemanFogProxmox::Value.empty?(value['size']) }
+  end
+
+  def remove_volume_keys(args)
+    args['volumes_attributes'].each_value { |volume_attributes| ForemanFogProxmox::HashCollection.remove_keys(volume_attributes, ['_delete']) } if args.key?('volumes_attributes')
+  end
+end

data/app/models/concerns/fog_extensions/proxmox/disk.rb

@@ -21,8 +21,23 @@ module FogExtensions
   module Proxmox
     module Disk
       extend ActiveSupport::Concern
-      def templated?
-        volid ? volid.match(/^([\w-]+)[:]base-(\d+)-disk-(\d+)/) : false
+
+      attr_accessor :ciuser, :cipassword, :searchdomain, :nameserver, :sshkeys
+
+      def storage_type
+        return 'cdrom' if cdrom?
+
+        cloud_init? ? 'cloud_init' : 'hard_disk'
+      end
+
+      def cdrom
+        return 'none' unless cdrom? || volid.nil?
+
+        ['none', 'cdrom'].include?(volid) ? volid : 'image'
+      end
+
+      def cloudinit
+        cloud_init? ? 'disk' : 'none'
       end
     end
   end

data/app/models/concerns/fog_extensions/proxmox/interface.rb

@@ -23,17 +23,32 @@ module FogExtensions
   module Proxmox
     module Interface
       extend ActiveSupport::Concern
-      attr_accessor :dhcpv4, :dhcpv6, :gwv4, :gwv6
       def mac
         macaddr
       end
 
-      def cidrv4_prefix
+      def dhcp
+        ip == 'dhcp'
+      end
+
+      def dhcp6
+        ip6 == 'dhcp'
+      end
+
+      def dhcp=(value)
+        @dhcp = value
+      end
+
+      def dhcp6=(value)
+        @dhcp6 = value
+      end
+
+      def cidr
         Fog::Proxmox::IpHelper.prefix(ip) if ip
       end
 
-      def cidrv6_prefix
-        Fog::Proxmox::IpHelper.prefix6(ip) if ip
+      def cidr6
+        Fog::Proxmox::IpHelper.prefix6(ip6) if ip6
       end
     end
   end

data/app/models/concerns/fog_extensions/proxmox/server.rb

@@ -23,6 +23,10 @@ module FogExtensions
       extend ActiveSupport::Concern
       attr_accessor :image_id, :templated, :ostemplate_storage, :ostemplate_file, :password, :start_after_create
 
+      def unique_cluster_identity
+        compute_resource.name + '_' + identity
+      end
+
       def start
         action('start')
       end
@@ -55,7 +59,7 @@ module FogExtensions
       delegate :description, to: :config
 
       def vm_description
-        "Name=#{name}, vmid=#{vmid}"
+        format(_('Type %<type>s, node %<node>s, %<cpus>s CPUs and %<memory>s MB memory'), type: type, node: node_id, cpus: config.cores || '0', memory: config.memory / (1024 * 1024) || '0')
       end
 
       def select_nic(fog_nics, nic)
@@ -69,7 +73,7 @@ module FogExtensions
       end
 
       def volumes
-        config.disks.reject(&:cdrom?)
+        config.disks
       end
 
       def disks
@@ -78,6 +82,7 @@ module FogExtensions
 
       delegate :vga, to: :config
       delegate :pool, to: :config
+      delegate :cloud_init?, to: :config
 
       def interfaces_attributes=(attrs); end
 
@@ -86,7 +91,11 @@ module FogExtensions
       def config_attributes=(attrs); end
 
       def templated?
-        volumes.any?(&:templated?)
+        volumes.any?(&:template?)
+      end
+
+      def cdrom?
+        volumes.any?(&:cdrom?)
       end
     end
   end

data/app/models/concerns/fog_extensions/proxmox/server_config.rb

@@ -24,38 +24,12 @@ module FogExtensions
     module ServerConfig
       extend ActiveSupport::Concern
       def cpu_type
-        Fog::Proxmox::CpuHelper.extract_type(cpu)
+        Fog::Proxmox::CpuHelper.extract_cputype(cpu)
       end
 
-      def spectre
-        Fog::Proxmox::CpuHelper.has_spectre?(cpu)
-      end
-
-      def pcid
-        Fog::Proxmox::CpuHelper.has_pcid?(cpu)
-      end
-
-      def cdrom
-        if disks.cdrom
-          ['none', 'cdrom'].include?(disks.cdrom.volid) ? disks.cdrom.volid : 'image'
-        else
-          'none'
-        end
-      end
-
-      def cdrom_storage
-        disks.cdrom ? disks.cdrom.storage : ''
-      end
-
-      def cdrom_iso
-        disks.cdrom ? disks.cdrom.volid : ''
-      end
-
-      def cdrom_image
-        if disks.cdrom
-          ['none', 'cdrom'].include?(disks.cdrom.volid) ? disks.cdrom.volid : 'image'
-        else
-          'none'
+      Fog::Proxmox::CpuHelper.flags.each do |flag_key, flag_value|
+        define_method(flag_key) do
+          Fog::Proxmox::CpuHelper.flag_value(cpu, flag_value)
         end
       end
 
@@ -66,6 +40,10 @@ module FogExtensions
       def rootfs_file
         disks.rootfs&.volid
       end
+
+      def cloud_init?
+        disks.any?(&:cloud_init?)
+      end
     end
   end
 end

data/app/models/concerns/host_ext/proxmox/interfaces.rb

@@ -35,8 +35,12 @@ module HostExt
         end
       end
 
-      def cidr_ip(interface_attributes)
-        Fog::Proxmox::IpHelper.to_cidr(interface_attributes['ip'], interface_attributes['compute_attributes']['cidr_suffix'])
+      def cidr_ip(interface_attributes, v = 4)
+        key_ip = 'ip'
+        key_ip += '6' if v == 6
+        key_cidr = 'cidr'
+        key_cidr += '6' if v == 6
+        Fog::Proxmox::IpHelper.to_cidr(interface_attributes[key_ip], interface_attributes['compute_attributes'][key_cidr])
       end
 
       def add_interface_to_compute_attributes(index, interface_attributes, compute_attributes)
@@ -45,6 +49,7 @@ module HostExt
         compute_attributes[index].store('_delete', interface_attributes['_destroy'])
         compute_attributes[index].store('macaddr', interface_attributes['mac'])
         compute_attributes[index].store('ip', cidr_ip(interface_attributes))
+        compute_attributes[index].store('ip6', cidr_ip(interface_attributes, 6))
         compute_attributes[index].merge!(interface_attributes['compute_attributes'].reject { |k, _v| k == 'id' })
       end
     end

data/app/models/concerns/orchestration/proxmox/compute.rb

@@ -25,6 +25,7 @@ module Orchestration
       def setComputeUpdate
         logger.info "Update Proxmox Compute instance for #{name}"
         final_compute_attributes = compute_attributes.merge(compute_resource.host_compute_attrs(self))
+        logger.debug("setComputeUpdate: final_compute_attributes=#{final_compute_attributes}")
         compute_resource.save_vm uuid, final_compute_attributes
       rescue StandardError => e
         failure format(_('Failed to update a compute %<compute_resource>s instance %<name>s: %<e>s'), :compute_resource => compute_resource, :name => name, :e => e), e
@@ -37,6 +38,54 @@ module Orchestration
       rescue StandardError => e
         failure format(_('Failed to undo update compute %<compute_resource>s instance %<name>s: %<e>s'), :compute_resource => compute_resource, :name => name, :e => e), e
       end
+
+      def empty_provided_ips?(ip, ip6)
+        ip.blank? && ip6.blank? && (compute_provides?(:ip) || compute_provides?(:ip6))
+      end
+
+      def ips_keys
+        [:ip, :ip6]
+      end
+
+      def computeIp(foreman_attr, fog_attr)
+        vm.send(fog_attr) || find_address(foreman_attr)
+      end
+
+      def computeValue(foreman_attr, fog_attr)
+        value = ''
+        value += compute_resource.id.to_s + '_' if foreman_attr == :uuid
+        value += vm.send(fog_attr)
+        value
+      end
+
+      def setVmDetails
+        attrs = compute_resource.provided_attributes
+        result = true
+        attrs.each do |foreman_attr, fog_attr|
+          if foreman_attr == :mac
+            result = false unless match_macs_to_nics(fog_attr)
+          elsif ips_keys.include?(foreman_attr)
+            value = computeIp(foreman_attr, fog_attr)
+            send("#{foreman_attr}=", value)
+            result = false if send(foreman_attr).present? && !validate_foreman_attr(value, ::Nic::Base, foreman_attr)
+          else
+            value = computeValue(foreman_attr, fog_attr)
+            send("#{foreman_attr}=", value)
+            result = false unless validate_required_foreman_attr(value, Host, foreman_attr)
+          end
+        end
+        return failure(format(_('Failed to acquire IP addresses from compute resource for %<name>s'), name: name)) if empty_provided_ips?(ip, ip6)
+
+        result
+      end
+
+      def setComputeDetails
+        if vm
+          setVmDetails
+        else
+          failure format(_('failed to save %<name>s'), name: name)
+        end
+      end
     end
   end
 end

data/app/models/foreman_fog_proxmox/proxmox.rb

@@ -24,10 +24,7 @@ require 'foreman_fog_proxmox/value'
 module ForemanFogProxmox
   class Proxmox < ComputeResource
     include ProxmoxVmHelper
-    include ProxmoxServerHelper
-    include ProxmoxContainerHelper
     include ProxmoxConnection
-    include ProxmoxTokenExpiration
     include ProxmoxVmNew
     include ProxmoxVmCommands
     include ProxmoxVmQueries
@@ -39,9 +36,11 @@ module ForemanFogProxmox
     include ProxmoxVersion
     include ProxmoxConsole
     validates :url, :format => { :with => URI::DEFAULT_PARSER.make_regexp }, :presence => true
+    validates :auth_method, :presence => true, inclusion: { in: ['access_ticket', 'user_token'], message: ->(value) do format('%<value>s is not a valid authentication method', { value: value }) end }
     validates :user, :format => { :with => /(\w+)[@]{1}(\w+)/ }, :presence => true
-    validates :password, :presence => true
-    before_create :test_connection
+    validates :password, :presence => true, if: :access_ticket?
+    validates :token_id, :presence => true, if: :user_token?
+    validates :token, :presence => true, if: :user_token?
 
     def provided_attributes
       super.merge(
@@ -95,35 +94,79 @@ module ForemanFogProxmox
       attrs[:ssl_verify_peer] = value
     end
 
-    def renew
-      attrs[:renew].blank? ? false : Foreman::Cast.to_bool(attrs[:renew])
+    def auth_method
+      attrs[:auth_method] || 'access_ticket'
     end
 
-    def renew=(value)
-      attrs[:renew] = value
+    def auth_method=(value)
+      attrs[:auth_method] = value
+    end
+
+    def token_id
+      attrs[:token_id]
+    end
+
+    def token_id=(value)
+      attrs[:token_id] = value
+    end
+
+    def token
+      attrs[:token]
+    end
+
+    def token=(value)
+      attrs[:token] = value
     end
 
     private
 
+    def fog_credentials
+      hash = {
+        proxmox_url: url,
+        proxmox_auth_method: auth_method || 'access_ticket',
+        connection_options: connection_options
+      }
+      if access_ticket?
+        hash[:proxmox_username] = user
+        hash[:proxmox_password] = password
+      end
+      if user_token?
+        hash[:proxmox_userid] = user
+        hash[:proxmox_token] = token
+        hash[:proxmox_tokenid] = token_id
+      end
+      hash
+    end
+
+    def token_expired?(e)
+      e.response.reason_phrase == 'token expired'
+    end
+
     def client
       @client ||= ::Fog::Proxmox::Compute.new(fog_credentials)
+    rescue Excon::Errors::Unauthorized => e
+      raise ::Foreman::Exception, 'User token expired' if token_expired?(e)
     rescue StandardError => e
-      logger.error(e)
-      raise ::Foreman::Exception, format(N_('Failed retrieving proxmox compute client caused by %<e>s'), e: e)
+      logger.warn(format(_('failed to create compute client: %<e>s'), e: e))
+      raise e
     end
 
     def identity_client
       @identity_client ||= ::Fog::Proxmox::Identity.new(fog_credentials)
+    rescue Excon::Errors::Unauthorized => e
+      raise ::Foreman::Exception, 'User token expired' if token_expired?(e)
     rescue StandardError => e
-      logger.error(e)
-      raise ::Foreman::Exception, format(N_('Failed retrieving proxmox identity client caused by %<e>s'), e: e)
+      logger.warn(format(_('failed to create identity client: %<e>s'), e: e))
+      raise e
     end
 
     def network_client
       @network_client ||= ::Fog::Proxmox::Network.new(fog_credentials)
+    rescue Excon::Errors::Unauthorized => e
+      raise ::Foreman::Exception, 'User token expired' if token_expired?(e)
     rescue StandardError => e
-      logger.error(e)
-      raise ::Foreman::Exception, format(N_('Failed retrieving proxmox network client caused by %<e>s'), e: e)
+      logger.warn(format(_('failed to create network client: %<e>s'), e: e))
+      raise e
     end
 
     def host