fog-proxmox 0.14.0 → 0.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e153a5fb10f314d09cc54eec5e8b2a6733120fe5c82ab6a809f203d2211fbfa
-  data.tar.gz: 7f2aa37e3830abb05c6717dc3f9e1705bfb8aebfa6cf52b2726a81a430ce1ac9
+  metadata.gz: b8570832df51a02eaf643d8ff711aded5ed8f664168eb2c1e0e8b3dec1f4b309
+  data.tar.gz: c162e5cddd1f8c809310d95b82bce305e2a48c19dad469c432ffd77f8f733723
 SHA512:
-  metadata.gz: 615ea980593082a11de74ad48d342df7ea3d5af4a39c9ae467280990ec6fcbc54c6589fe40e824b0ce7429f041707eb6953f71eb6bc3bcd23146ba37d3d98737
-  data.tar.gz: 73174f09ca4246a44b357d2f6c9b86daf01808623766877f04b59f210dcb581f056b32954aa9d2e919384d7a371bb0edbc720d3196867b9631cf8375d8f76e79
+  metadata.gz: caa4247e9c6f778ad157ba72561f04da0876a6e2d5acd185c93dc84c5ecba5168f1fb3ae3d6a87ddb803d26271963e101f51b8aef5955877ee2f3434cb8de60a
+  data.tar.gz: 8dee3cdb18fe8c1e6ec5103adfb311d6d5d946b44cf3b73acba3b66808321306ea0542c7d40111f53d2b681a1d39b87b2fd43949d5fd15468fd496b66e704184

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+## [0.15.1](https://github.com/fog/fog-proxmox/compare/v0.15.0...v0.15.1) (2025-02-25)
+
+
+### Bug Fixes
+
+* Fixes EOF OpenSSL error in Proxmox connection ([#102](https://github.com/fog/fog-proxmox/issues/102)) ([ac8b0e1](https://github.com/fog/fog-proxmox/commit/ac8b0e11a39da6b19703b4f4507edf19486899ba))
+
+## [0.15.0](https://github.com/fog/fog-proxmox/compare/v0.14.0...v0.15.0) (2022-12-01)
+
+
+### Features
+
+* :sparkles: memory unit is Mb and disk size is Gb ([c5410b5](https://github.com/fog/fog-proxmox/commit/c5410b5c79ed59a89bb4f0f2188613cbcc6a8f11))

data/README.md

@@ -3,8 +3,8 @@
 # Fog::Proxmox
 
 ![CI](https://github.com/fog/fog-proxmox/workflows/CI/badge.svg)
-[![Maintainability](https://api.codeclimate.com/v1/badges/33e619f2167cc9864b61/maintainability)](https://codeclimate.com/github/fog/fog-proxmox/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/33e619f2167cc9864b61/test_coverage)](https://codeclimate.com/github/fog/fog-proxmox/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/dfcdcc32f096abf1b2b4/maintainability)](https://codeclimate.com/github/fog/fog-proxmox/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/dfcdcc32f096abf1b2b4/test_coverage)](https://codeclimate.com/github/fog/fog-proxmox/test_coverage)
 [![Gem Version](https://badge.fury.io/rb/fog-proxmox.svg)](https://badge.fury.io/rb/fog-proxmox)
 
 This is a [FOG](http://fog.io/) (>= 2.1) module gem to support [Proxmox VE](https://www.proxmox.com/en/proxmox-ve)
@@ -62,16 +62,40 @@ To record your VCR cassettes:
 PROXMOX_URL=https://192.168.56.101:8006/api2/json DISABLE_PROXY=true SSL_VERIFY_PEER=false bundle exec rake spec
 ```
 
-To replay your recorded tests:
+To replay all your recorded tests:
 
 ```shell
 USE_VCR=true bundle exec rake spec
 ```
 
+To replay one group (compute, identity or network) of your recorded tests:
+
+```shell
+USE_VCR=true bundle exec rake spec:compute
+```
+
 Code formatting:
 
 ```shell
-bundle exec bin/rake rubocop  
+bundle exec rake rubocop
+```
+
+Auto correcting (safe):
+
+```shell
+bundle exec rake rubocop:autocorrect
+```
+
+Exclude cops in todo file:
+
+```shell
+bundle exec rubocop --auto-gen-config
+```
+
+See all available rake tasks:
+
+```shell
+bundle exec rake --tasks
 ```
 
 ## Contributing

data/lib/fog/proxmox/attributes.rb

@@ -24,9 +24,10 @@ module Fog
       def self.set_attr(attr_name, attributes, new_attributes)
         attributes[attr_name.to_sym] = new_attributes[attr_name] unless new_attributes[attr_name].nil?
       end
+
       def self.set_attr_and_sym(attr_name, attributes, new_attributes)
-        self.set_attr(attr_name, attributes, new_attributes)
-        self.set_attr(attr_name.to_sym, attributes, new_attributes)
+        set_attr(attr_name, attributes, new_attributes)
+        set_attr(attr_name.to_sym, attributes, new_attributes)
       end
     end
   end

data/lib/fog/proxmox/auth/token/access_ticket.rb

@@ -22,64 +22,75 @@ require 'fog/proxmox/variables'
 require 'fog/proxmox/json'
 
 module Fog
-    module Proxmox
-        # Core module
-        module Auth
-            module Token
-                class AccessTicket
-                    include Fog::Proxmox::Auth::Token
-
-                    NAME = 'access_ticket'
-
-                    attr_reader :csrf_token
-
-                    class URIError < RuntimeError; end
-
-                    EXPIRATION_DELAY = 2 * 60 * 60
-
-                    def auth_method
-                        'POST'
-                    end
-
-                    def auth_path(params = {})
-                        '/access/ticket'
-                    end
-
-                    def auth_body(params = {})
-                        raise URIError, 'URI params is required' if params.nil? || params.empty?
-                        raise URIError, 'proxmox_username is required' if params[:proxmox_username].nil? || params[:proxmox_username].empty?
-                        raise URIError, 'proxmox_password is required' if params[:proxmox_password].nil? || params[:proxmox_password].empty?
-                        URI.encode_www_form(username: params[:proxmox_username], password: params[:proxmox_password])
-                    end
-
-                    def headers(method = 'GET', params = {}, additional_headers = {})
-                        headers_hash = {}
-                        @data ||= {}
-                        unless @data.empty?
-                            headers_hash.store('Cookie', "PVEAuthCookie=#{@data['ticket']}")
-                            if %w[PUT POST DELETE].include? method
-                            headers_hash.store('CSRFPreventionToken', @data['CSRFPreventionToken'])
-                            end
-                        end
-                        headers_hash.merge! additional_headers
-                        headers_hash
-                    end
-
-                    def build_credentials(proxmox_options, data)
-                        @token = data['ticket']
-                        @expires = Time.now.utc.to_i + EXPIRATION_DELAY
-                        @userid = data['username']
-                        @csrf_token = data['CSRFPreventionToken']
-                    end
-
-                    def missing_credentials(options)
-                        missing_credentials = []
-                        missing_credentials << :proxmox_username unless options[:proxmox_username]
-                        missing_credentials << :proxmox_password unless options[:proxmox_password]
-                        raise ArgumentError, "Missing required arguments: #{missing_credentials.join(', ')}" unless missing_credentials.empty?
-                    end
-                end
+  module Proxmox
+    # Core module
+    module Auth
+      module Token
+        class AccessTicket
+          include Fog::Proxmox::Auth::Token
+
+          NAME = 'access_ticket'
+
+          attr_reader :csrf_token
+
+          class URIError < RuntimeError; end
+
+          EXPIRATION_DELAY = 2 * 60 * 60
+
+          def auth_method
+            'POST'
+          end
+
+          def auth_path(_params = {})
+            '/access/ticket'
+          end
+
+          def auth_body(params = {})
+            raise URIError, 'URI params is required' if params.nil? || params.empty?
+
+            if params[:proxmox_username].nil? || params[:proxmox_username].empty?
+              raise URIError,
+                    'proxmox_username is required'
+            end
+            if params[:proxmox_password].nil? || params[:proxmox_password].empty?
+              raise URIError,
+                    'proxmox_password is required'
+            end
+
+            URI.encode_www_form(username: params[:proxmox_username], password: params[:proxmox_password])
+          end
+
+          def headers(method = 'GET', _params = {}, additional_headers = {})
+            headers_hash = {}
+            @data ||= {}
+            unless @data.empty?
+              headers_hash.store('Cookie', "PVEAuthCookie=#{@data['ticket']}")
+              if %w[PUT POST DELETE].include? method
+                headers_hash.store('CSRFPreventionToken', @data['CSRFPreventionToken'])
+              end
             end
+            headers_hash.merge! additional_headers
+            headers_hash
+          end
+
+          def build_credentials(_proxmox_options, data)
+            @token = data['ticket']
+            @expires = Time.now.utc.to_i + EXPIRATION_DELAY
+            @userid = data['username']
+            @csrf_token = data['CSRFPreventionToken']
+          end
+
+          def missing_credentials(options)
+            missing_credentials = []
+            missing_credentials << :proxmox_username unless options[:proxmox_username]
+            missing_credentials << :proxmox_password unless options[:proxmox_password]
+            return if missing_credentials.empty?
+
+            raise ArgumentError,
+                  "Missing required arguments: #{missing_credentials.join(', ')}"
+          end
         end
+      end
     end
+  end
 end

data/lib/fog/proxmox/auth/token/user_token.rb

@@ -22,73 +22,86 @@ require 'fog/proxmox/variables'
 require 'fog/proxmox/json'
 
 module Fog
-    module Proxmox
-        # Core module
-        module Auth
-            module Token
-                class UserToken
-                    include Fog::Proxmox::Auth::Token
-
-                    NAME = 'user_token'
-
-                    attr_reader :token_id
-
-                    class URIError < RuntimeError; end
-
-                    def auth_method
-                        'GET'
-                    end
-
-                    def auth_path(params = {})
-                        raise URIError, 'URI params are required' if params.nil? || params.empty?
-                        raise URIError, 'proxmox_userid is required' if params[:proxmox_userid].nil? || params[:proxmox_userid].empty?
-                        raise URIError, 'proxmox_tokenid is required' if params[:proxmox_tokenid].nil? || params[:proxmox_tokenid].empty?
-                        "/access/users/#{URI.encode_www_form_component(params[:proxmox_userid])}/token/#{params[:proxmox_tokenid]}"
-                    end
-
-                    def auth_body(params = {})
-                        ''
-                    end        
-                    
-                    def no_token?(params)
-                        (params.respond_to?(:proxmox_token) || params[:proxmox_token].nil? || params[:proxmox_token].empty?) && (@token.nil? || @token.empty?)
-                    end
-
-                    def set_credentials(params)
-                        token = @token
-                        token = params[:proxmox_token] if token.empty?
-                        token_id = @token_id
-                        token_id = params[:proxmox_tokenid] if token_id.empty? 
-                        userid = @userid
-                        userid = params[:proxmox_userid] if userid.empty?
-                        {userid: userid, token_id: token_id, token: token }
-                    end
-
-                    def headers(method = 'GET', params = {}, additional_headers = {})
-                        raise URIError, 'User token is required' if no_token?(params)
-                        credentials = set_credentials(params)
-                        headers_hash = {}
-                        headers_hash.store('Authorization', "PVEAPIToken=#{credentials[:userid]}!#{credentials[:token_id]}=#{credentials[:token]}")
-                        headers_hash.merge! additional_headers
-                        headers_hash
-                    end
-
-                    def build_credentials(proxmox_options, data)
-                        @expires = data['expire']
-                        @token = proxmox_options[:proxmox_token]
-                        @token_id = proxmox_options[:proxmox_tokenid]
-                        @userid = proxmox_options[:proxmox_userid]
-                    end
-
-                    def missing_credentials(options)
-                        missing_credentials = []
-                        missing_credentials << :proxmox_userid unless options[:proxmox_userid]
-                        missing_credentials << :proxmox_tokenid unless options[:proxmox_tokenid]
-                        missing_credentials << :proxmox_token unless options[:proxmox_token]
-                        raise ArgumentError, "Missing required arguments: #{missing_credentials.join(', ')}" unless missing_credentials.empty?
-                    end
-                end
+  module Proxmox
+    # Core module
+    module Auth
+      module Token
+        class UserToken
+          include Fog::Proxmox::Auth::Token
+
+          NAME = 'user_token'
+
+          attr_reader :token_id
+
+          class URIError < RuntimeError; end
+
+          def auth_method
+            'GET'
+          end
+
+          def auth_path(params = {})
+            raise URIError, 'URI params are required' if params.nil? || params.empty?
+
+            if params[:proxmox_userid].nil? || params[:proxmox_userid].empty?
+              raise URIError,
+                    'proxmox_userid is required'
             end
+            if params[:proxmox_tokenid].nil? || params[:proxmox_tokenid].empty?
+              raise URIError,
+                    'proxmox_tokenid is required'
+            end
+
+            "/access/users/#{URI.encode_www_form_component(params[:proxmox_userid])}/token/#{params[:proxmox_tokenid]}"
+          end
+
+          def auth_body(_params = {})
+            ''
+          end
+
+          def no_token?(params)
+            (params.respond_to?(:proxmox_token) || params[:proxmox_token].nil? || params[:proxmox_token].empty?) && (@token.nil? || @token.empty?)
+          end
+
+          def set_credentials(params)
+            token = @token
+            token = params[:proxmox_token] if token.empty?
+            token_id = @token_id
+            token_id = params[:proxmox_tokenid] if token_id.empty?
+            userid = @userid
+            userid = params[:proxmox_userid] if userid.empty?
+            { userid: userid, token_id: token_id, token: token }
+          end
+
+          def headers(_method = 'GET', params = {}, additional_headers = {})
+            raise URIError, 'User token is required' if no_token?(params)
+
+            credentials = set_credentials(params)
+            headers_hash = {}
+            headers_hash.store('Authorization',
+                               "PVEAPIToken=#{credentials[:userid]}!#{credentials[:token_id]}=#{credentials[:token]}")
+            headers_hash.merge! additional_headers
+            headers_hash
+          end
+
+          def build_credentials(proxmox_options, data)
+            @expires = data['expire']
+            @token = proxmox_options[:proxmox_token]
+            @token_id = proxmox_options[:proxmox_tokenid]
+            @userid = proxmox_options[:proxmox_userid]
+          end
+
+          def missing_credentials(options)
+            missing_credentials = []
+            missing_credentials << :proxmox_userid unless options[:proxmox_userid]
+            missing_credentials << :proxmox_tokenid unless options[:proxmox_tokenid]
+            missing_credentials << :proxmox_token unless options[:proxmox_token]
+            return if missing_credentials.empty?
+
+            raise ArgumentError,
+                  "Missing required arguments: #{missing_credentials.join(', ')}"
+          end
         end
+      end
     end
+  end
 end

data/lib/fog/proxmox/auth/token.rb

@@ -23,66 +23,72 @@ require 'fog/proxmox/variables'
 require 'fog/proxmox/json'
 
 module Fog
-    module Proxmox
-        # Core module
-        module Auth
-            module Token
-
-                autoload :AccessTicket, 'fog/proxmox/auth/token/access_ticket'
-                autoload :UserToken, 'fog/proxmox/auth/token/user_token'
-
-                attr_reader :userid, :token, :expires, :data
-
-                class ExpiryError < RuntimeError; end
-                class URLError < RuntimeError; end
-
-                def initialize(proxmox_options, options = {})
-                    raise URLError, 'No proxmox_url provided' if proxmox_options[:proxmox_url].nil? || proxmox_options[:proxmox_url].empty?                    
-                    @token ||= ''
-                    @token_id ||= ''
-                    @userid ||= ''                
-                    @data = authenticate(proxmox_options, options)    
-                    build_credentials(proxmox_options, data)
-                end
-
-                def self.build(proxmox_options, options)
-                    raise ArgumentError, "Missing required proxmox_auth_method in options." unless proxmox_options.key? :proxmox_auth_method
-                    auth_method = proxmox_options[:proxmox_auth_method]
-                    if auth_method == Fog::Proxmox::Auth::Token::AccessTicket::NAME
-                        Fog::Proxmox::Auth::Token::AccessTicket.new(proxmox_options, options)
-                    elsif auth_method == Fog::Proxmox::Auth::Token::UserToken::NAME
-                        Fog::Proxmox::Auth::Token::UserToken.new(proxmox_options, options)
-                    else
-                        raise ArgumentError, "Unkown authentication method: #{auth_method}. Only #{Fog::Proxmox::Auth::Token::AccessTicket::NAME} or #{Fog::Proxmox::Auth::Token::UserToken::NAME} are accepted."
-                    end
-                end
-
-                def authenticate(proxmox_options, connection_options = {})
-                    uri = URI.parse(proxmox_options[:proxmox_url])
-                    request = {
-                        expects: [200, 201],
-                        headers: headers(auth_method, proxmox_options, { Accept: 'application/json' }),
-                        body: auth_body(proxmox_options),
-                        method: auth_method,
-                        path: uri.path + auth_path(proxmox_options)
-                    }
-                    connection = Fog::Core::Connection.new(
-                        uri.to_s,
-                        false,
-                        connection_options
-                    )
-                    response  = connection.request(request)
-                    Json.get_data(response)
-                end
-
-                def expired?
-                    if @expires.nil? || @expires.empty?
-                        raise ExpiryError, 'Missing token expiration data'
-                    end
-                    Time.at(@expires) < Time.now.utc
-                end
-                
-            end
+  module Proxmox
+    # Core module
+    module Auth
+      module Token
+        autoload :AccessTicket, 'fog/proxmox/auth/token/access_ticket'
+        autoload :UserToken, 'fog/proxmox/auth/token/user_token'
+
+        attr_reader :userid, :token, :expires, :data
+
+        class ExpiryError < RuntimeError; end
+        class URLError < RuntimeError; end
+
+        def initialize(proxmox_options, options = {})
+          if proxmox_options[:proxmox_url].nil? || proxmox_options[:proxmox_url].empty?
+            raise URLError,
+                  'No proxmox_url provided'
+          end
+
+          @token ||= ''
+          @token_id ||= ''
+          @userid ||= ''
+          @data = authenticate(proxmox_options, options)
+          build_credentials(proxmox_options, data)
+        end
+
+        def self.build(proxmox_options, options)
+          unless proxmox_options.key? :proxmox_auth_method
+            raise ArgumentError,
+                  'Missing required proxmox_auth_method in options.'
+          end
+
+          auth_method = proxmox_options[:proxmox_auth_method]
+          if auth_method == Fog::Proxmox::Auth::Token::AccessTicket::NAME
+            Fog::Proxmox::Auth::Token::AccessTicket.new(proxmox_options, options)
+          elsif auth_method == Fog::Proxmox::Auth::Token::UserToken::NAME
+            Fog::Proxmox::Auth::Token::UserToken.new(proxmox_options, options)
+          else
+            raise ArgumentError,
+                  "Unkown authentication method: #{auth_method}. Only #{Fog::Proxmox::Auth::Token::AccessTicket::NAME} or #{Fog::Proxmox::Auth::Token::UserToken::NAME} are accepted."
+          end
+        end
+
+        def authenticate(proxmox_options, connection_options = {})
+          uri = URI.parse(proxmox_options[:proxmox_url])
+          request = {
+            expects: [200, 201],
+            headers: headers(auth_method, proxmox_options, { Accept: 'application/json' }),
+            body: auth_body(proxmox_options),
+            method: auth_method,
+            path: uri.path + auth_path(proxmox_options)
+          }
+          connection = Fog::Core::Connection.new(
+            uri.to_s,
+            false,
+            connection_options
+          )
+          response = connection.request(request)
+          Json.get_data(response)
+        end
+
+        def expired?
+          raise ExpiryError, 'Missing token expiration data' if @expires.nil? || @expires.empty?
+
+          Time.at(@expires) < Time.now.utc
         end
+      end
     end
+  end
 end

data/lib/fog/proxmox/compute/models/disk.rb

@@ -23,7 +23,8 @@ require 'fog/proxmox/helpers/controller_helper'
 module Fog
   module Proxmox
     class Compute
-      # class Disk model
+      # class Disk model: https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/{qemu|lxc}/{vmid}/config
+      # size is in Gb
       class Disk < Fog::Model
         identity  :id
         attribute :volid
@@ -83,6 +84,10 @@ module Fog
         def to_s
           Fog::Proxmox::Hash.flatten(flatten)
         end
+
+        def has_volume?
+          !volid.empty?
+        end
       end
     end
   end

data/lib/fog/proxmox/compute/models/disks.rb

@@ -31,7 +31,7 @@ module Fog
         end
 
         def get(id)
-          all.find { |disk| disk.identity === id }
+          all.find { |disk| disk.identity == id }
         end
 
         def next_device(controller)

data/lib/fog/proxmox/compute/models/interface.rb

@@ -17,7 +17,7 @@
 
 # frozen_string_literal: true
 
-require "fog/proxmox/helpers/nic_helper"
+require 'fog/proxmox/helpers/nic_helper'
 
 module Fog
   module Proxmox

data/lib/fog/proxmox/compute/models/interfaces.rb

@@ -32,7 +32,7 @@ module Fog
         end
 
         def get(id)
-          all.find { |interface| interface.identity === id }
+          all.find { |interface| interface.identity == id }
         end
 
         def next_nicid

data/lib/fog/proxmox/compute/models/node.rb

@@ -61,14 +61,13 @@ module Fog
         end
 
         def backup(options = {})
-          task_upid = service.backup({ node: node }, options)
-          task_upid
+          service.backup({ node: node }, options)
         end
 
-        def statistics(output = 'rrddata', options = { timeframe: 'hour', cf: 'AVERAGE'})
+        def statistics(output = 'rrddata', options = { timeframe: 'hour', cf: 'AVERAGE' })
           path_params = { node: node, output: output }
           query_params = options
-          service.get_node_statistics(path_params,query_params)
+          service.get_node_statistics(path_params, query_params)
         end
 
         private
@@ -88,7 +87,6 @@ module Fog
         def initialize_storages
           attributes[:storages] = Fog::Proxmox::Compute::Storages.new(service: service, node_id: node)
         end
-
       end
     end
   end

data/lib/fog/proxmox/compute/models/nodes.rb

@@ -31,7 +31,7 @@ module Fog
         end
 
         def get(id)
-          all.find { |node| node.identity === id }
+          all.find { |node| node.identity == id }
         end
       end
     end