fog-proxmox 0.13.0

data/lib/fog/network/proxmox/requests/update_network.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# Copyright 2018 Tristan Robert
+
+# This file is part of Fog::Proxmox.
+
+# Fog::Proxmox 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.
+
+# Fog::Proxmox 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 Fog::Proxmox. If not, see <http://www.gnu.org/licenses/>.
+
+module Fog
+  module Proxmox
+    class Network
+      # class Real update_network request
+      class Real
+        def update_network(path_params, body_params)
+          node = path_params[:node]
+          iface = path_params[:iface]
+          request(
+            expects: [200],
+            method: 'PUT',
+            path: "nodes/#{node}/network/#{iface}",
+            body: URI.encode_www_form(body_params)
+          )
+        end
+      end
+
+      # class Mock update_network request
+      class Mock
+      end
+    end
+  end
+end

data/lib/fog/proxmox.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+# Copyright 2018 Tristan Robert
+
+# This file is part of Fog::Proxmox.
+
+# Fog::Proxmox 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.
+
+# Fog::Proxmox 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 Fog::Proxmox. If not, see <http://www.gnu.org/licenses/>.
+
+# frozen_string_literal: true
+
+require 'fog/proxmox/version'
+require 'fog/proxmox/core'
+require 'fog/proxmox/json'
+require 'fog/core'
+require 'fog/json'
+
+module Fog
+  # Proxmox module
+  module Proxmox
+    extend Fog::Provider
+    autoload :Identity, File.expand_path('identity/proxmox', __dir__)
+    autoload :Compute, File.expand_path('compute/proxmox', __dir__)
+    autoload :Storage, File.expand_path('storage/proxmox', __dir__)
+    autoload :Network, File.expand_path('network/proxmox', __dir__)
+    service(:identity, 'Identity')
+    service(:compute, 'Compute')
+    service(:storage, 'Storage')
+    service(:network, 'Network')
+
+    @credentials = {}
+
+    class << self
+      attr_reader :credentials
+      attr_reader :version
+    end
+
+    def self.clear_credentials
+      @credentials = {}
+    end
+
+    def self.authenticate(options, connection_options = {})
+      get_credentials(options, connection_options)
+      self
+    end
+
+    def self.authenticated?
+      !@credentials.empty?
+    end
+
+    def self.credentials_has_expired?
+      authenticated? && @credentials[:deadline] < Time.now
+    end
+
+    def self.extract_password(options)
+      ticket = options[:pve_ticket]
+      ticket ? ticket : options[:pve_password].to_s
+    end
+
+    def self.get_credentials(options, connection_options = {})
+      pve_ticket_lifetime   = options[:pve_ticket_lifetime]
+      # Default lifetime ticket is 2 hours
+      ticket_lifetime = pve_ticket_lifetime ? pve_ticket_lifetime : 2 * 60 * 60
+      username          = options[:pve_username].to_s
+      password          = extract_password(options)
+      url               = options[:pve_url]
+      uri = URI.parse(url)
+      @api_path = uri.path
+      connection_options = connection_options.merge(path_prefix: @api_path)
+      password = @credentials[:ticket] if credentials_has_expired?
+      request_credentials(uri, connection_options, username, password, ticket_lifetime)
+    end
+
+    def self.request_credentials(uri, connection_options, username, password, ticket_lifetime)
+      request = {
+        expects: [200, 204],
+        headers: { 'Accept' => 'application/json' },
+        body: URI.encode_www_form(username: username, password: password),
+        method: 'POST',
+        path: 'access/ticket'
+      }
+      connection = Fog::Core::Connection.new(
+        uri.to_s,
+        false,
+        connection_options
+      )
+      response  = connection.request(request)
+      data      = Json.get_data(response)
+      ticket    = data['ticket']
+      username  = data['username']
+      csrftoken = data['CSRFPreventionToken']
+      epoch = Time.now.to_i + ticket_lifetime
+      deadline = Time.at(epoch)
+      save_credentials(username, ticket, csrftoken, deadline)
+    end
+
+    def self.save_credentials(username, ticket, csrftoken, deadline)
+      @credentials = {
+        username: username,
+        ticket: ticket,
+        csrftoken: csrftoken,
+        deadline: deadline
+      }
+    end
+  end
+end

data/lib/fog/proxmox/attributes.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# Copyright 2018 Tristan Robert
+
+# This file is part of Fog::Proxmox.
+
+# Fog::Proxmox 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.
+
+# Fog::Proxmox 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 Fog::Proxmox. If not, see <http://www.gnu.org/licenses/>.
+
+module Fog
+  module Proxmox
+    # module Attributes mixins
+    module Attributes
+      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)
+      end
+    end
+  end
+end

data/lib/fog/proxmox/core.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+# Copyright 2018 Tristan Robert
+
+# This file is part of Fog::Proxmox.
+
+# Fog::Proxmox 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.
+
+# Fog::Proxmox 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 Fog::Proxmox. If not, see <http://www.gnu.org/licenses/>.
+
+require 'fog/json'
+require 'fog/proxmox/variables'
+require 'fog/proxmox/json'
+
+module Fog
+  module Proxmox
+    # Core module
+    module Core
+      attr_accessor :pve_ticket
+      attr_reader :pve_csrftoken
+      attr_reader :pve_username
+      attr_reader :deadline
+      attr_reader :principal
+
+      # fallback
+      def self.not_found_class
+        Fog::Proxmox::Compute::NotFound
+      end
+
+      def initialize_identity(options)
+        @principal = nil
+        @pve_ticket = nil
+        Fog::Proxmox::Variables.to_variables(self, options, 'pve')
+        @pve_uri = URI.parse(@pve_url)
+        missing_credentials = []
+        missing_credentials << :pve_username unless @pve_username
+
+        unless @pve_ticket
+          missing_credentials << :pve_password unless @pve_password
+        end
+
+        raise ArgumentError, "Missing required arguments: #{missing_credentials.join(', ')}" unless missing_credentials.empty?
+      end
+
+      def credentials
+        options = {
+          provider: 'proxmox',
+          pve_url: @pve_uri.to_s,
+          pve_ticket: @pve_ticket,
+          pve_csrftoken: @pve_csrftoken,
+          pve_username: @pve_username
+        }
+        pve_options.merge options
+      end
+
+      def reload
+        @connection.reset
+      end
+
+      private
+
+      def request(params)
+        retried = false     
+        begin
+          response = @connection.request(params.merge(
+                                           headers: headers(params[:method], params[:headers])
+          ))
+        rescue Excon::Errors::Unauthorized => error
+          # token expiration and token renewal possible
+          if error.response.body != 'Bad username or password' && !retried
+            authenticate
+            retried = true
+            retry
+          # bad credentials or token renewal not possible
+          else
+            raise error
+          end
+        rescue Excon::Errors::HTTPStatusError => error
+          raise case error
+                when Excon::Errors::NotFound
+                  self.class.not_found_class.slurp(error)
+                else
+                  error
+                end
+        end
+        Fog::Proxmox::Json.get_data(response)
+      end
+
+      def headers(method, additional_headers)
+        additional_headers ||= {}
+        headers_hash = { 'Accept' => 'application/json' }
+        # CSRF token is required to PUT, POST and DELETE http requests
+        if %w[PUT POST DELETE].include? method
+          headers_hash.store('CSRFPreventionToken', @pve_csrftoken)
+        end
+        # ticket must be present in cookie
+        headers_hash.store('Cookie', "PVEAuthCookie=#{@pve_ticket}") if @pve_ticket
+        headers_hash.merge additional_headers
+        headers_hash
+      end
+
+      def pve_options
+        Fog::Proxmox::Variables.to_hash(self, 'pve')
+      end
+
+      def authenticate
+        options = pve_options
+        @pve_ticket = options[:pve_ticket]
+        Fog::Proxmox.authenticate(options, @connection_options)
+        @principal = Fog::Proxmox.credentials
+        @pve_username = Fog::Proxmox.credentials[:username]
+        @pve_ticket = Fog::Proxmox.credentials[:ticket]
+        @pve_deadline = Fog::Proxmox.credentials[:deadline]
+        @pve_csrftoken = Fog::Proxmox.credentials[:csrftoken]
+
+        @host       = @pve_uri.host
+        @api_path   = @pve_uri.path
+        @api_path.sub!(%r{/$}, '')
+        @port       = @pve_uri.port
+        @scheme     = @pve_uri.scheme
+
+        true
+      end
+    end
+  end
+end

data/lib/fog/proxmox/errors.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# Copyright 2018 Tristan Robert
+
+# This file is part of Fog::Proxmox.
+
+# Fog::Proxmox 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.
+
+# Fog::Proxmox 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 Fog::Proxmox. If not, see <http://www.gnu.org/licenses/>.
+
+module Fog
+  module Proxmox
+    module Errors
+      # class ServiceError
+      class ServiceError < Fog::Errors::Error
+        attr_reader :response_data
+
+        def self.slurp(error)
+          if error.response.body.empty?
+            data = nil
+            message = nil
+          else
+            data = Fog::JSON.decode(error.response.body)
+            message = data['message']
+            data1 = data.values.first
+            message = data1['message'] if message.nil? && !data1.nil?
+          end
+
+          new_error = super(error, message)
+          new_error.instance_variable_set(:@response_data, data)
+          new_error
+        end
+      end
+
+      # class ServiceUnavailable error
+      class ServiceUnavailable < ServiceError; end
+
+      # class BadRequest error
+      class BadRequest < ServiceError
+        attr_reader :validation_errors
+
+        def self.slurp(error)
+          new_error = super(error)
+          unless new_error.response_data.nil? || new_error.response_data['badRequest'].nil?
+            new_error.instance_variable_set(:@validation_errors, new_error.response_data['badRequest']['validationErrors'])
+          end
+          new_error
+        end
+      end
+
+      # class InterfaceNotImplemented error
+      class InterfaceNotImplemented < Fog::Errors::Error; end
+    end
+  end
+end

data/lib/fog/proxmox/hash.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Copyright 2018 Tristan Robert
+
+# This file is part of Fog::Proxmox.
+
+# Fog::Proxmox 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.
+
+# Fog::Proxmox 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 Fog::Proxmox. If not, see <http://www.gnu.org/licenses/>.
+
+module Fog
+  module Proxmox
+    # module Hash mixins
+    module Hash
+
+      def self.stringify(hash)
+        filtered = hash.reject { |_key,value| value.to_s.empty? }
+        a = filtered.to_a.collect { |item| item.join('=') }
+        a.join(',')
+      end
+
+      def self.flatten(hash)
+        filtered = hash.reject { |_key,value| value.to_s.empty? }
+        a = filtered.to_a.collect { |item| item.join(': ') }
+        a.join(',')
+      end
+
+    end
+  end
+end

data/lib/fog/proxmox/helpers/controller_helper.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# Copyright 2018 Tristan Robert
+
+# This file is part of Fog::Proxmox.
+
+# Fog::Proxmox 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.
+
+# Fog::Proxmox 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 Fog::Proxmox. If not, see <http://www.gnu.org/licenses/>.
+
+module Fog
+  module Proxmox
+    # module ControllerHelper mixins
+    module ControllerHelper
+
+      CONTROLLERS = %w[ide sata scsi virtio mp rootfs].freeze
+      def self.extract(name, controller_value)
+        matches = controller_value.match(/[,]{0,1}#{name}[=]{1}(?<name_value>[\w\/\.\:]+)/)
+        matches ? matches[:name_value] : matches
+      end
+
+      def self.extract_index(name, key)
+        matches = key.to_s.match(/#{name}(?<index>\d+)/)
+        index = matches ? matches[:index] : matches
+        index ? index.to_i : -1
+      end
+
+      def self.valid?(name, key)
+        key.to_s.match(/^#{name}(\d*)$/)
+      end
+
+      def self.last_index(name, values)
+        return -1 if values.empty?
+        indexes = []
+        values.each do |value|
+          index = extract_index(name, value)
+          indexes.push(index) if index
+        end
+        indexes.sort
+        indexes.empty? ? -1 : indexes.last
+      end
+
+      def self.select(hash,name)
+        hash.select { |key| valid?(name, key.to_s) }
+      end
+
+      def self.collect_controllers(attributes)
+        controllers = {}
+        CONTROLLERS.each { |controller| controllers.merge!(select(attributes, controller)) }
+        controllers
+      end
+
+    end
+  end
+end