foreman_snapshot_management 1.5.1 → 2.0.0

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FogExtensions
   module Vsphere
     module Snapshots

data/app/models/concerns/fog_extensions/vsphere/snapshots/real.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FogExtensions
   module Vsphere
     module Snapshots
@@ -7,7 +9,7 @@ module FogExtensions
           raise ArgumentError, 'snapshot is a required parameter' unless options.key? 'snapshot'
           raise ArgumentError, 'removeChildren is a required parameter' unless options.key? 'removeChildren'
 
-          raise ArgumentError, 'snapshot is a required parameter' unless ::Fog::Compute::Vsphere::Snapshot === options['snapshot']
+          raise ArgumentError, 'snapshot is a required parameter' unless ::ForemanSnapshotManagement.fog_vsphere_namespace::Snapshot === options['snapshot']
 
           task = options['snapshot'].mo_ref.RemoveSnapshot_Task(
             removeChildren: options['removeChildren']
@@ -26,7 +28,7 @@ module FogExtensions
           raise ArgumentError, 'name is a required parameter' unless options.key? 'name'
           raise ArgumentError, 'description is a required parameter' unless options.key? 'description'
 
-          raise ArgumentError, 'snapshot is a required parameter' unless ::Fog::Compute::Vsphere::Snapshot === options['snapshot']
+          raise ArgumentError, 'snapshot is a required parameter' unless ::ForemanSnapshotManagement.fog_vsphere_namespace::Snapshot === options['snapshot']
 
           options['snapshot'].mo_ref.RenameSnapshot(
             name: options['name'],

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

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 require 'date'
 
 module ForemanSnapshotManagement
   class Snapshot
     extend ActiveModel::Callbacks
+    extend ActiveModel::Naming
     include ActiveModel::Conversion
     include ActiveModel::Model
     include ActiveModel::Dirty
@@ -14,39 +17,39 @@ module ForemanSnapshotManagement
     attr_reader :name, :description, :include_ram, :host_id
     define_attribute_methods :name, :description, :include_ram
 
+    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.any?
+      true
+    end
+
+    def self.new_for_host(host)
+      host.compute_resource.new_snapshot(host)
+    end
+
     def self.all_for_host(host)
-      host.compute_resource.get_snapshots(host.uuid).map do |raw_snapshot|
-        new_from_vmware(host, raw_snapshot)
-      end
+      host.compute_resource.get_snapshots(host)
     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
-    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
-      )
-    end
-
-    def children
-      return [] unless raw_snapshot
-      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)
+      host.compute_resource.get_snapshot(host, id)
+    end
+
+    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
@@ -54,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?
@@ -73,6 +76,7 @@ module ForemanSnapshotManagement
 
     def include_ram=(value)
       raise Exception('Cannot modify include_ram on existing snapshots.') if persisted?
+
       @include_ram = value
     end
 
@@ -83,12 +87,14 @@ module ForemanSnapshotManagement
 
     def host_id=(host_id)
       return if @host_id == host_id
+
       @host_id = host_id
       @host = nil
     end
 
     def host=(host)
       return if @host_id == host.id
+
       @host_id = host.id
       @host = host
     end
@@ -105,7 +111,7 @@ module ForemanSnapshotManagement
       end
     end
 
-    def update_attributes(new_attributes)
+    def update(new_attributes)
       assign_attributes(new_attributes)
       save if changed?
     end
@@ -116,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
@@ -138,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

@@ -1,15 +1,17 @@
+# frozen_string_literal: true
+
 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)
@@ -19,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
@@ -52,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

data/app/views/api/v2/snapshots/base.json.rabl

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
 object @snapshot
 
 attributes :id, :name
+
+node(:formatted_created_at) { |snapshot| snapshot.create_time&.httpdate }

data/app/views/api/v2/snapshots/create.json.rabl

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 object @snapshot
 
 extends 'api/v2/snapshots/show'

data/app/views/api/v2/snapshots/destroy.json.rabl

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 object @snapshot
 
 extends 'api/v2/snapshots/show'

data/app/views/api/v2/snapshots/index.json.rabl

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 collection @snapshots
 
 extends 'api/v2/snapshots/main'

data/app/views/api/v2/snapshots/main.json.rabl

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 object @snapshot
 
 extends 'api/v2/snapshots/base'
@@ -5,5 +7,5 @@ extends 'api/v2/snapshots/base'
 attributes :description
 
 node(:created_at, &:create_time)
-node(:parent_id) { |snapshot| snapshot.parent.try(:id) }
-node(:children_ids) { |snapshot| snapshot.children.map(&:id) }
+node(:parent_id) { |snapshot| snapshot.try(:parent).try(:id) }
+node(:children_ids) { |snapshot| snapshot.try(:children).try(:map, &:id) }

data/app/views/api/v2/snapshots/revert.json.rabl

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 object @snapshot
 
 extends 'api/v2/snapshots/show'

data/app/views/api/v2/snapshots/show.json.rabl

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 object @snapshot
 
 extends 'api/v2/snapshots/main'

data/app/views/api/v2/snapshots/update.json.rabl

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 object @snapshot
 
 extends 'api/v2/snapshots/show'

data/app/views/foreman_snapshot_management/snapshots/_index.html.erb

@@ -1,74 +1,12 @@
-<%= form_for @new_snapshot, as: :snapshot, url: host_snapshots_path(@host), html: {class: ""} do |f| %>
-<table class="<%= table_css_classes %>">
-  <thead>
-  <tr>
-    <th class="col-md-1"><%= _('Snapshot') %></th>
-    <th class="col-md-2"><%= _('Description') %></th>
-    <th class="col-md-1"><%= _('Include RAM') %></th>
-    <th class="col-md-1"><%= _('Action') %></th>
-  </tr>
-  </thead>
-  <tbody>
-    <% if authorized_for(:auth_object => @host, :permission => :create_snapshots) %>
-      <tr>
-        <td>
-          <%= f.text_field :name, class: 'form-control' %>
-        </td>
-        <td>
-          <%= f.text_field :description, class: 'form-control' %>
-        </td>
-        <td>
-          <%= f.check_box :include_ram, class: 'form-control' %>
-        </td>
-        <td>
-          <%= f.submit _('Create'), class: 'btn btn-success', :onclick => "$(this).attr('disabled', 'disabled'); $(this).parents('form').submit();" %>
-        </td>
-      </tr>
-    <% end %>
-  <% @snapshots.each do |snapshot| %>
-      <tr>
-        <td>
-          <% if authorized_for(:auth_object => @host, :permission => :edit_snapshots) %>
-            <%= edit_textfield snapshot, :name %>
-          <% else %>
-            <%= snapshot.name %>
-          <% end %>
-          <br /><%= snapshot.formatted_create_time() %>
-        </td>
-        <td>
-          <% if authorized_for(:auth_object => @host, :permission => :edit_snapshots) %>
-            <%= edit_textarea snapshot, :description %>
-          <% else %>
-            <%= snapshot.description %>
-          <% end %>
-        </td>
-        <td>
-        </td>
-        <td>
-          <%= action_buttons(
-            display_link_if_authorized(_('Rollback'), hash_for_revert_host_snapshot_path(host_id: @host, id: snapshot.id).merge(:auth_object => @host, :permission => :revert_snapshots), method: :put, class: 'btn btn-primary', data: {confirm: _('Are you sure to revert this Snapshot?'), 'disable-with': _('Reverting...')}),
-            display_delete_if_authorized(hash_for_host_snapshot_path(host_id: @host, id: snapshot.id).merge(:auth_object => @host, :permission => :destroy_snapshots), data: {confirm: _("Are you sure to delete this Snapshot?"), 'disable-with': _('Deleting...')}),
-          ) %>
-        </td>
-      </tr>
-    <% end %>
-  </tbody>
-</table>
-<% end %>
-
-<script type="text/javascript">
-//<![CDATA[
-  $(document).ready(function() {
-    $('.editable').editable({
-      params: {
-        authenticity_token: AUTH_TOKEN
-      },
-      error: function(response) {
-        return $.parseJSON(response.responseText).errors;
-      }
-    });
-    var hash = window.location.hash;
-    hash && $('ul.nav a[href="' + hash + '"]').tab('show');
-  });
-//]]>
-</script>
+<%= react_component('SnapshotManagement', {
+  host: @host,
+  canCreate: authorized_for(:auth_object => @host, :permission => :create_snapshots),
+  canUpdate: authorized_for(:auth_object => @host, :permission => :edit_snapshots),
+  canRevert: authorized_for(:auth_object => @host, :permission => :revert_snapshots),
+  canDelete: authorized_for(:auth_object => @host, :permission => :destroy_snapshots),
+  capabilities:
+  {
+    editableSnapshotName: @host.compute_resource.capable?(:editable_snapshot_name),
+    limitSnapshotNameFormat: @host.compute_resource.type == "ForemanFogProxmox::Proxmox"
+  }
+}) %>