foreman_snapshot_management 1.6.1 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1f7ac4fa53eca310f5b7effafa4fca21cfdf0ce1f97981892165dfa9ebc1f19
-  data.tar.gz: 1440f1529c9d5c02428dac9371f1d02faca2ea6c95064e51c4efa900bed5126a
+  metadata.gz: 852f360b2e273ab1e59ba5b2e7960633cdfc169acd60e98f8fc9abeb2616a098
+  data.tar.gz: 9c292f218d3f01ef7e3cba1eab5caaac82e94a65891d88a1b11f19952da39c8a
 SHA512:
-  metadata.gz: 41df800a5a9d08c2dac58f5bc1319840dbdaa39ee1e4cf79ef71677645cc9d64cee3de0cf310d49e0d16ba9fc41a820ae42bf31f848398d040610b42ecd88649
-  data.tar.gz: ca5116f54a696fbe6062d05369747a02898a283276252ae118884b075ac01fe05a3864cbf583f2cfcf6b57801283e278ac4c0949f9bf0c5ae918262cf6a7468f
+  metadata.gz: ca9602895984df366f86addc657df08ce8c2c2e69fedd9d554115829f36bd956838fb05d2eb3a7d5a6c9a4d0af9f5385ac40573804bb54e9766be6014a49acf9
+  data.tar.gz: 949d446c4f72c2ad58c4098d5866d53259151bb35597444f402b3fd08a3d68ba5f4e76a975bab5be16098b13e4ebbb16531b841869cbd6e53ca31ff99cd924ae

data/README.md

@@ -1,9 +1,12 @@
-[![Build Status](https://travis-ci.org/ATIX-AG/foreman_snapshot_management.svg?branch=master)](https://travis-ci.org/ATIX-AG/foreman_snapshot_management)
+[![React Testing](https://github.com/ATIX-AG/foreman_snapshot_management/actions/workflows/react.yml/badge.svg)](https://github.com/ATIX-AG/foreman_snapshot_management/actions/workflows/react.yml)
+[![Ruby Testing](https://github.com/ATIX-AG/foreman_snapshot_management/actions/workflows/ruby.yml/badge.svg)](https://github.com/ATIX-AG/foreman_snapshot_management/actions/workflows/ruby.yml)
 
 # ForemanSnapshotManagement
 
 ForemanSnapshotManagement is a Foreman plugin to manage snapshots.
-As Hypervisor VMware vSphere is supported.
+As Hypervisor the following systems are supported:
+- VMware vSphere
+- [Proxmox](https://www.proxmox.com/)
 
 ## Features
 
@@ -20,6 +23,9 @@ See [How_to_Install_a_Plugin](http://projects.theforeman.org/projects/foreman/wi
 
 | Foreman Version | Plugin Version |
 | --------------- | -------------- |
+| 2.3             | >= 2.0.0       |
+| 1.24            | >= 1.7.0       |
+| 1.23            | >= 1.7.0       |
 | 1.22            | >= 1.6.0       |
 | 1.21            | >= 1.5.0       |
 | 1.20            | >= 1.5.0       |

data/Rakefile

@@ -14,6 +14,13 @@ rescue LoadError
   RDoc::Task = Rake::RDocTask
 end
 
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue StandardError => _e
+  puts 'Rubocop not loaded.'
+end
+
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'ForemanSnapshotManagement'
@@ -22,6 +29,4 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
-
 Bundler::GemHelper.install_tasks

data/app/controllers/api/v2/snapshots_controller.rb

@@ -6,14 +6,28 @@ module Api
       include Api::Version2
       include Foreman::Controller::Parameters::Snapshot
 
-      before_action :find_required_nested_object
+      before_action :find_host
       before_action :check_snapshot_capability
       before_action :find_resource, :only => %w[show update destroy revert]
 
       api :GET, '/hosts/:host_id/snapshots', N_('List all snapshots')
       param :host_id, :identifier_dottable, :required => true
+      param_group :search_and_pagination, ::Api::V2::BaseController
+      meta :search => [{ :name => 'name', :type => 'string' }]
       def index
-        @snapshots = resource_scope_for_index
+        if params[:search]
+          search = params[:search].match(/^\s*name\s*=\s*(\w+)\s*$/) || params[:search].match(/^\s*name\s*=\s*\"([^"]+)\"\s*$/)
+          raise "Field '#{params[:search]}' not recognized for searching!" unless search
+
+          snapshot = resource_class.find_for_host_by_name(@host, search[1])
+          @snapshots = if snapshot
+                         [snapshot].paginate(paginate_options)
+                       else
+                         []
+                       end
+        else
+          @snapshots = resource_scope_for_index
+        end
       end
 
       api :GET, '/hosts/:host_id/snapshots/:id', 'Show a snapshot'
@@ -35,7 +49,7 @@ module Api
       param_group :snapshot, :as => :create
 
       def create
-        @snapshot = resource_class.new(snapshot_params.to_h.merge(host: @nested_obj).merge(include_ram: params[:include_ram]))
+        @snapshot = resource_class.new(snapshot_params.to_h.merge(host: @host).merge(include_ram: params[:include_ram]))
         process_response @snapshot.create
       end
 
@@ -45,7 +59,7 @@ module Api
       param_group :snapshot
 
       def update
-        process_response @snapshot.update_attributes(snapshot_params)
+        process_response @snapshot.update(snapshot_params)
       end
 
       api :DELETE, '/hosts/:host_id/snapshots/:id', N_('Delete a snapshot')
@@ -66,9 +80,25 @@ module Api
 
       private
 
+      # Find Host
+      #
+      # This method is responsible that methods of the controller know the current host.
+      def find_host
+        host_id = params[:host_id]
+        if host_id.blank?
+          not_found
+          return false
+        end
+        @host = Host.authorized("#{action_permission}_snapshots".to_sym, Host).friendly.find(host_id)
+        return @host if @host
+
+        not_found
+        false
+      end
+
       def resource_scope(_options = {})
         # TODO: Ask host for snapshots
-        @resource_scope ||= resource_class.all_for_host(@nested_obj)
+        @resource_scope ||= resource_class.all_for_host(@host)
       end
 
       def resource_scope_for_index
@@ -80,12 +110,12 @@ module Api
       end
 
       def find_resource
-        @snapshot = resource_class.find_for_host(@nested_obj, params[:id])
+        @snapshot = resource_class.find_for_host(@host, params[:id])
         not_found unless @snapshot
       end
 
       def check_snapshot_capability
-        not_found unless @nested_obj.compute_resource&.capabilities&.include?(:snapshots)
+        not_found unless @host.compute_resource&.capabilities&.include?(:snapshots)
       end
 
       def action_permission

data/app/controllers/concerns/foreman/controller/parameters/snapshot.rb

@@ -6,7 +6,7 @@ module Foreman::Controller::Parameters::Snapshot
   class_methods do
     def snapshot_params_filter
       Foreman::ParameterFilter.new(::ForemanSnapshotManagement::Snapshot).tap do |filter|
-        filter.permit :name, :description
+        filter.permit :name, :description, :include_ram, :host_id
       end
     end
   end

data/app/controllers/foreman_snapshot_management/snapshots_controller.rb

@@ -66,7 +66,7 @@ module ForemanSnapshotManagement
     #
     # This method renames a Snapshot from a given host.
     def update
-      if @snapshot.update_attributes(snapshot_params)
+      if @snapshot.update(snapshot_params)
         render json: { name: @snapshot.name, description: @snapshot.description }
       else
         msg = _('Failed to update Snapshot: %s') % @snapshot.errors.full_messages.to_sentence
@@ -89,7 +89,7 @@ module ForemanSnapshotManagement
           errors << [h.name, s.errors.full_messages.to_sentence]
         end
       end
-      error _('Error occurred while creating Snapshot for<br /><dl>%s</dl>') % errors.map { |e| "<dt>#{e[0]}</dt><dd>#{e[1]}</dd>" }.join('<br />') unless errors.empty?
+      error _('Error occurred while creating Snapshot for:%s') % "<br /><dl>#{errors.map { |e| "<dt>#{e[0]}</dt><dd>#{e[1]}</dd>" }.join('<br />')}</dl>" unless errors.empty?
       if snapshots_created.positive?
         msg = _('Created %{snapshots} for %{num} %{hosts}') % {
           snapshots: n_('Snapshot', 'Snapshots', snapshots_created),
@@ -143,10 +143,10 @@ module ForemanSnapshotManagement
       end
 
       @hosts
-    rescue StandardError => error
-      message = _('Something went wrong while selecting hosts - %s') % error
+    rescue StandardError => e
+      message = _('Something went wrong while selecting hosts - %s') % e
       error(message)
-      Foreman::Logging.exception(message, error)
+      Foreman::Logging.exception(message, e)
       redirect_to hosts_path
       false
     end

data/app/models/concerns/fog_extensions/proxmox/snapshots/mock.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module FogExtensions
+  module Proxmox
+    module Snapshots
+      module Mock
+        def status_task(_node, _upid)
+          {
+            'type' => 'qmsnapshot',
+            'starttime' => 1_580_720_848,
+            'pstart' => 1_864_464_143,
+            'node' => 'proxmox',
+            'upid' => 'UPID:proxmox:00003E13:6F21770F:5E37E2D0:qmsnapshot:100:root@pam:',
+            'user' => 'root@pam',
+            'exitstatus' => 'OK',
+            'status' => 'stopped',
+            'id' => '100',
+            'pid' => 15_891
+          }
+        end
+      end
+    end
+  end
+end

data/app/models/foreman_snapshot_management/proxmox_extensions.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module ForemanSnapshotManagement
+  module ProxmoxExtensions
+    # Extend Proxmox's capabilities with snapshots.
+    def capabilities
+      super + [:snapshots]
+    end
+
+    # Create a Snapshot.
+    #
+    # This method creates a Snapshot with a given name and optional description.
+    def create_snapshot(host, name, description, _include_ram = false)
+      server = find_vm_by_uuid host.uuid
+      raise _('Name must contain at least 2 characters starting with alphabet. Valid characters are A-Z a-z 0-9 _') unless /^[A-Za-z][\w]{1,}$/.match?(name)
+
+      snapshot = server.snapshots.create(name: name)
+      snapshot.description = description
+      snapshot.update
+    rescue StandardError => e
+      Foreman::Logging.exception('Error creating Proxmox Snapshot', e)
+      raise ::Foreman::WrappedException.new(e, N_('Unable to create Proxmox Snapshot'))
+    end
+
+    # Remove Snapshot
+    #
+    # This method removes a Snapshot from a given host.
+    def remove_snapshot(snapshot)
+      snapshot.destroy
+    rescue StandardError => e
+      Foreman::Logging.exception('Error removing Proxmox Snapshot', e)
+      raise ::Foreman::WrappedException.new(e, N_('Unable to remove Proxmox Snapshot'))
+    end
+
+    # Revert Snapshot
+    #
+    # This method revert a host to a given Snapshot.
+    def revert_snapshot(snapshot)
+      snapshot.rollback
+    rescue StandardError => e
+      Foreman::Logging.exception('Error reverting Proxmox Snapshot', e)
+      raise ::Foreman::WrappedException.new(e, N_('Unable to revert Proxmox Snapshot'))
+    end
+
+    # Update Snapshot
+    #
+    # This method renames a Snapshot from a given host.
+    def update_snapshot(snapshot, name, description)
+      raise _('Snapshot name cannot be changed') if snapshot.name != name
+
+      snapshot.description = description
+      snapshot.update
+    rescue StandardError => e
+      Foreman::Logging.exception('Error updating Proxmox Snapshot', e)
+      raise ::Foreman::WrappedException.new(e, N_('Unable to update Proxmox Snapshot'))
+    end
+
+    # Get Snapshot
+    #
+    # This methods returns a specific Snapshot for a given host.
+    def get_snapshot(host, snapshot_id)
+      server = find_vm_by_uuid host.uuid
+      snapshot = server.snapshots.get(snapshot_id)
+      raw_to_snapshot(host, snapshot)
+    end
+
+    # Get Snapshot by name
+    #
+    # This method returns a specific Snapshot for a given host.
+    def get_snapshot_by_name(host, name)
+      server = find_vm_by_uuid host.uuid
+      snapshot = server.snapshots.get(name)
+      raw_to_snapshot(host, snapshot) if snapshot
+    end
+
+    # Get Snapshots
+    #
+    # This methods returns Snapshots for a given host.
+    def get_snapshots(host)
+      server = find_vm_by_uuid host.uuid
+      server.snapshots.delete(server.snapshots.get('current'))
+      server.snapshots.map do |snapshot|
+        raw_to_snapshot(host, snapshot)
+      end
+    end
+
+    private
+
+    def raw_to_snapshot(host, raw_snapshot)
+      if raw_snapshot
+        Snapshot.new(
+          host: host,
+          id: raw_snapshot.name,
+          raw_snapshot: raw_snapshot,
+          name: raw_snapshot.name,
+          description: raw_snapshot.description
+        )
+      end
+    end
+  end
+end

data/app/models/foreman_snapshot_management/snapshot.rb

@@ -5,6 +5,7 @@ require 'date'
 module ForemanSnapshotManagement
   class Snapshot
     extend ActiveModel::Callbacks
+    extend ActiveModel::Naming
     include ActiveModel::Conversion
     include ActiveModel::Model
     include ActiveModel::Dirty
@@ -16,40 +17,39 @@ module ForemanSnapshotManagement
     attr_reader :name, :description, :include_ram, :host_id
     define_attribute_methods :name, :description, :include_ram
 
-    def self.all_for_host(host)
-      host.compute_resource.get_snapshots(host.uuid).map do |raw_snapshot|
-        new_from_vmware(host, raw_snapshot)
-      end
+    def self.model_name
+      Struct.new(:name, :klass, :singular, :plural, :element,
+                 :human, :collection, :param_key, :i18n_key, :route_key, :singular_route_key).new(
+                   'ForemanSnapshotManagement::Snapshot', ForemanSnapshotManagement::Snapshot,
+                   'foreman_snapshot_management_snapshot', 'foreman_snapshot_management_snapshots',
+                   'snapshot', 'Snapshot', 'foreman_snapshot_management/snapshots',
+                   'snapshot', :'foreman_snapshot_management/snapshot', 'foreman_snapshot_management_snapshots',
+                   'foreman_snapshot_management_snapshot'
+                 )
     end
 
-    def self.find_for_host(host, id)
-      raw_snapshot = host.compute_resource.get_snapshot(host.uuid, id)
-      new_from_vmware(host, raw_snapshot) if raw_snapshot
+    def self.any?
+      true
+    end
+
+    def self.new_for_host(host)
+      host.compute_resource.new_snapshot(host)
     end
 
-    def self.new_from_vmware(host, raw_snapshot, opts = {})
-      new(
-        host: host,
-        id: raw_snapshot.ref,
-        raw_snapshot: raw_snapshot,
-        name: raw_snapshot.name,
-        description: raw_snapshot.description,
-        parent: opts[:parent],
-        create_time: raw_snapshot.create_time
-      )
+    def self.all_for_host(host)
+      host.compute_resource.get_snapshots(host)
     end
 
-    def children
-      return [] unless raw_snapshot
+    def self.find_for_host(host, id)
+      host.compute_resource.get_snapshot(host, id)
+    end
 
-      child_snapshots = raw_snapshot.child_snapshots.flat_map do |child_snapshot|
-        self.class.new_from_vmware(host, child_snapshot, parent: self)
-      end
-      child_snapshots + child_snapshots.flat_map(&:children)
+    def self.find_for_host_by_name(host, name)
+      host.compute_resource.get_snapshot_by_name(host, name)
     end
 
     def inspect
-      "#<#{self.class}:0x#{self.__id__.to_s(16)} name=#{name} id=#{id} description=#{description} host_id=#{host_id} parent=#{parent.try(:id)} children=#{children.map(&:id).inspect}>"
+      "#<#{self.class}:0x#{self.__id__.to_s(16)} name=#{name} id=#{id} description=#{description} host_id=#{host_id} parent=#{parent.try(:id)}>"
     end
 
     def to_s
@@ -57,7 +57,7 @@ module ForemanSnapshotManagement
     end
 
     def formatted_create_time
-      create_time.strftime('%F %H:%M')
+      create_time&.strftime('%F %H:%M')
     end
 
     def persisted?
@@ -111,7 +111,7 @@ module ForemanSnapshotManagement
       end
     end
 
-    def update_attributes(new_attributes)
+    def update(new_attributes)
       assign_attributes(new_attributes)
       save if changed?
     end
@@ -122,7 +122,7 @@ module ForemanSnapshotManagement
         handle_snapshot_errors do
           host.audit_comment = "Create snapshot #{name}"
           host.save!
-          host.compute_resource.create_snapshot(host.uuid, name, description, include_ram)
+          host.compute_resource.create_snapshot(host, name, description, include_ram)
           changes_applied
         end
       end
@@ -144,7 +144,7 @@ module ForemanSnapshotManagement
         result = handle_snapshot_errors do
           host.audit_comment = "Destroy snapshot #{name}"
           host.save!
-          result = host.compute_resource.remove_snapshot(raw_snapshot, false)
+          result = host.compute_resource.remove_snapshot(raw_snapshot)
         end
         @id = nil
         result

data/app/models/foreman_snapshot_management/vmware_extensions.rb

@@ -4,14 +4,14 @@ module ForemanSnapshotManagement
   module VmwareExtensions
     # Extend VMWare's capabilities with snapshots.
     def capabilities
-      super + [:snapshots]
+      super + [:snapshots, :snapshot_include_ram, :editable_snapshot_name]
     end
 
     # Create a Snapshot.
     #
     # This method creates a Snapshot with a given name and optional description.
-    def create_snapshot(uuid, name, description, include_ram = false)
-      task = client.vm_take_snapshot('instance_uuid' => uuid, 'name' => name, 'description' => description, 'memory' => include_ram)
+    def create_snapshot(host, name, description, include_ram = false)
+      task = client.vm_take_snapshot('instance_uuid' => host.uuid, 'name' => name, 'description' => description, 'memory' => include_ram)
       task_successful?(task)
     rescue RbVmomi::Fault => e
       Foreman::Logging.exception('Error creating VMWare Snapshot', e)
@@ -21,7 +21,7 @@ module ForemanSnapshotManagement
     # Remove Snapshot
     #
     # This method removes a Snapshot from a given host.
-    def remove_snapshot(snapshot, remove_children)
+    def remove_snapshot(snapshot, remove_children = false)
       task = client.remove_snapshot('snapshot' => snapshot, 'removeChildren' => remove_children)
       task_successful?(task)
     rescue RbVmomi::Fault => e
@@ -54,23 +54,50 @@ module ForemanSnapshotManagement
     # Get Snapshot
     #
     # This methods returns a specific Snapshot for a given host.
-    def get_snapshot(server_id, snapshot_id)
-      snapshot = client.snapshots(server_id: server_id).get(snapshot_id)
-      # Workaround for https://github.com/fog/fog-vsphere/commit/d808255cd19c3d43d3227825f1e0d72d3f6ee6b9
-      # Remove, when fog-vshpere 1.11 lands in foreman
-      snapshot = snapshot.get_child(snapshot_id) while snapshot && snapshot.ref != snapshot_id
-      snapshot
+    def get_snapshot(host, snapshot_id)
+      raw_snapshot = client.snapshots(server_id: host.uuid).get(snapshot_id)
+      raw_to_snapshot(host, raw_snapshot)
+    end
+
+    # Get Snapshot by name
+    #
+    # This method returns a specific Snapshot for a given host.
+    def get_snapshot_by_name(host, name)
+      raw_snapshot = nil
+      client.snapshots(server_id: host.uuid).all(recursive: true).each do |snapshot|
+        if name == snapshot.name
+          raw_snapshot = snapshot
+          break
+        end
+      end
+      raw_to_snapshot(host, raw_snapshot)
     end
 
     # Get Snapshots
     #
-    # This methods returns Snapshots from a given host.
-    def get_snapshots(server_id)
-      client.snapshots(server_id: server_id).all(recursive: true)
+    # This methods returns Snapshots for a given host.
+    def get_snapshots(host)
+      client.snapshots(server_id: host.uuid).all(recursive: true).map do |raw_snapshot|
+        raw_to_snapshot(host, raw_snapshot)
+      end
     end
 
     private
 
+    def raw_to_snapshot(host, raw_snapshot, opts = {})
+      if raw_snapshot
+        Snapshot.new(
+          host: host,
+          id: raw_snapshot.ref,
+          raw_snapshot: raw_snapshot,
+          name: raw_snapshot.name,
+          description: raw_snapshot.description,
+          parent: opts[:parent],
+          create_time: raw_snapshot.create_time
+        )
+      end
+    end
+
     def task_successful?(task)
       task['task_state'] == 'success' || task['state'] == 'success'
     end