foreman_snapshot_management 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87811e930d27da1d7f48e95773f5ecbbf5b3749b
-  data.tar.gz: 0c087f9e4acf4e7e9f2641bc3273f7ac664cc7f7
+  metadata.gz: '048b5bbc495a00c7caf44380c5ee03ccd319e592'
+  data.tar.gz: 7d331abbbb267a00c70485e8a74bb1e76d30f684
 SHA512:
-  metadata.gz: 885cd0c2fbe5618f983515f92311be0d96b4c63eabee541545991716aa9ca0819cacf40ead72c94f1c4d5bed49a0ad69dc6613d9c4417fcc59e687f07e24ec64
-  data.tar.gz: 130883c8f6a36407ef07d8724530d29ba06397d69b404b0927a6210fcd2c90d5d3e2d0e5070136da787a8a7950ecf71e6df2741daffbec2d3e86ea0cc6432ec8
+  metadata.gz: c2f5363bbd5646c3cd7383968fa0529ba483c9e42a0adcf1d483c6668cb5c5e43c8fdf19f46449658ceb07864022ce108644f0697724e4499fe1a493852e0018
+  data.tar.gz: 473771e206b8768650d3085c7494f5b7b4a07c3859894bb7573a2acfff2e4501c44915eb0c545bcadc4938a3efa862d1b1e070aff1ce6525bea147d34971ed74

data/README.md

@@ -13,3 +13,12 @@ As Hypervisor VMware vSphere is supported.
 ## Installation
 
 See [How_to_Install_a_Plugin](http://projects.theforeman.org/projects/foreman/wiki/How_to_Install_a_Plugin) for how to install Foreman plugins
+
+## Copyright
+Copyright (c) 2017 ATIX AG - http://www.atix.de
+
+This program 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.
+
+This program 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 this program. If not, see http://www.gnu.org/licenses/.

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

@@ -0,0 +1,107 @@
+module Api
+  module V2
+    class SnapshotsController < V2::BaseController
+      include Api::Version2
+      include Foreman::Controller::Parameters::Snapshot
+
+      before_action :find_required_nested_object
+      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
+      def index
+        @snapshots = resource_scope_for_index
+      end
+
+      api :GET, '/hosts/:host_id/snapshots/:id', 'Show a snapshot'
+      param :host_id, :identifier_dottable, :required => true
+      param :id, :identifier_dottable, :required => true
+
+      def show; end
+
+      def_param_group :snapshot do
+        param :snapshot, Hash, :required => true, :action_aware => true do
+          param :name, String, :required => true, :desc => N_('Name of this snapshot')
+          param :description, String, :desc => N_('Description of this snapshot')
+        end
+      end
+
+      api :POST, '/hosts/:host_id/snapshots/', N_('Create a snapshot')
+      param :host_id, :identifier_dottable, :required => true
+      param_group :snapshot, :as => :create
+
+      def create
+        @snapshot = resource_class.new(snapshot_params.to_h.merge(host: @nested_obj))
+        process_response @snapshot.save
+      end
+
+      api :PUT, '/hosts/:host_id/snapshots/:id/', N_('Update a snapshot')
+      param :host_id, :identifier_dottable, :required => true
+      param :id, :identifier_dottable, :required => true
+      param_group :snapshot
+
+      def update
+        process_response @snapshot.update_attributes(snapshot_params)
+      end
+
+      api :DELETE, '/hosts/:host_id/snapshots/:id', N_('Delete a snapshot')
+      param :host_id, :identifier_dottable, :required => true
+      param :id, :identifier_dottable, :required => true
+
+      def destroy
+        process_response @snapshot.destroy
+      end
+
+      api :PUT, '/hosts/:host_id/snapshots/:id/revert', N_('Revert Host to a snapshot')
+      param :host_id, :identifier_dottable, :required => true
+      param :id, :identifier_dottable, :required => true
+
+      def revert
+        process_response @snapshot.revert
+      end
+
+      private
+
+      def resource_scope(_options = {})
+        # TODO: Ask host for snapshots
+        @resource_scope ||= resource_class.all_for_host(@nested_obj)
+      end
+
+      def resource_scope_for_index
+        resource_scope.paginate(paginate_options)
+      end
+
+      def resource_class
+        ::ForemanSnapshotManagement::Snapshot
+      end
+
+      def find_resource
+        @snapshot = resource_class.find_for_host(@nested_obj, params[:id])
+        not_found unless @snapshot
+      end
+
+      def check_snapshot_capability
+        not_found unless @nested_obj.compute_resource && @nested_obj.compute_resource.capabilities.include?(:snapshots)
+      end
+
+      def action_permission
+        case params[:action]
+        when 'revert'
+          :revert
+        else
+          super
+        end
+      end
+
+      def parent_permission(child_permission)
+        case child_permission.to_s
+        when 'revert'
+          :edit
+        else
+          super
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Foreman::Controller::Parameters::Snapshot
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def snapshot_params_filter
+      Foreman::ParameterFilter.new(::ForemanSnapshotManagement::Snapshot).tap do |filter|
+        filter.permit :name, :description
+      end
+    end
+  end
+
+  def snapshot_params
+    self.class.snapshot_params_filter.filter_params(params, parameter_filter_context)
+  end
+end

data/app/controllers/foreman_snapshot_management/snapshots_controller.rb

@@ -1,6 +1,9 @@
 module ForemanSnapshotManagement
   class SnapshotsController < ApplicationController
+    include ::Foreman::Controller::Parameters::Snapshot
+
     before_action :find_host
+    before_action :check_snapshot_capability
     before_action :enumerate_snapshots, only: [:index]
     before_action :find_snapshot, only: %i[destroy revert update]
     helper_method :xeditable?
@@ -18,26 +21,13 @@ module ForemanSnapshotManagement
     #
     # This method creates a Snapshot with a given name and optional description.
     def create
-      # Create snapshot
-      name = params['snapshot']['name']
-      description = params['snapshot']['description'] || ''
-      snapshot = Snapshot.new(host: @host, name: name, description: description)
-      begin
-        task = snapshot.create
-
-        # Check state of Snapshot creation
-        if task['task_state'] == 'success'
-          status = _('Snapshot successfully created')
-        else
-          status = _('Error occurred while creating snapshot: %s') % task['task_state']
-        end
-
-        # Redirect to specific Host page
-        redirect_to host_path(@host, anchor: 'snapshots'), flash: { notice: status }
-      rescue
-        logger.error 'Failed to take snapshot.'
-        status = _('Error occurred while creating snapshot.')
-        redirect_to host_path(@host, anchor: 'snapshots'), flash: { error: status }
+      @snapshot = Snapshot.new(snapshot_params.merge(host: @host))
+
+      if @snapshot.create
+        process_success
+      else
+        msg = _('Error occurred while creating Snapshot: %s') % @snapshot.errors.full_messages.to_sentence
+        process_error :error_msg => msg
       end
     end
 
@@ -45,51 +35,35 @@ module ForemanSnapshotManagement
     #
     # This method removes a Snapshot from a given host.
     def destroy
-      # Remove Snapshot
-      task = @snapshot.destroy
-
-      # Check state of Snapshot creation
-      if task['task_state'] == 'success'
-        status = 'Snapshot successfully deleted'
+      if @snapshot.destroy
+        process_success
       else
-        status = 'Error occurred while removing Snapshot: ' + task['task_state']
+        msg = _('Error occurred while removing Snapshot: %s') % @snapshot.errors.full_messages.to_sentence
+        process_error :error_msg => msg
       end
-
-      # Redirect to specific Host page
-      redirect_to host_path(@host, anchor: 'snapshots'), flash: { notice: status }
     end
 
     # Revert Snapshot
     #
     # This method reverts a host to a given Snapshot.
     def revert
-      # Revert Snapshot
-      task = @snapshot.revert
-
-      # Check state of Snapshot creation
-      if task['state'] == 'success'
-        status = _('VM successfully rolled back')
+      if @snapshot.revert
+        process_success :success_msg => _('VM successfully rolled back.')
       else
-        status = _('Error occurred while rolling back VM: %s') % task['state']
+        msg = _('Error occurred while rolling back VM: %s') % @snapshot.errors.full_messages.to_sentence
+        process_error :error_msg => msg
       end
-
-      # Redirect to specific Host page
-      redirect_to host_path(@host, anchor: 'snapshots'), flash: { notice: status }
     end
 
     # Update Snapshot
     #
     # This method renames a Snapshot from a given host.
     def update
-      # Rename Snapshot
-      @snapshot.name = params['snapshot']['name'] if params['snapshot']['name']
-      @snapshot.description = params['snapshot']['description'] if params['snapshot']['description']
-      begin
-        task = @snapshot.save
+      if @snapshot.update_attributes(snapshot_params)
         render json: { name: @snapshot.name, description: @snapshot.description }
-      rescue
-        logger.error "Failed to update snapshot #{@snapshot.id}."
-        render json: { errors: _('Failed to update snapshot.') }, status: :unprocessable_entity
+      else
+        msg = _('Failed to update Snapshot: %s') % @snapshot.errors.full_messages.to_sentence
+        render json: { errors: msg }, status: :unprocessable_entity
       end
     end
 
@@ -100,18 +74,62 @@ module ForemanSnapshotManagement
     private
 
     def find_host
-      @host = Host.find_by! name: params['host_id']
-    rescue => e
-      process_ajax_error e, 'Host not found!'
+      host_id = params[:host_id]
+      if host_id.blank?
+        not_found
+        return false
+      end
+      @host = Host.authorized(host_permission).friendly.find(host_id)
+      unless @host
+        not_found
+        return(false)
+      end
+    end
+
+    def host_permission
+      case action_permission.to_s
+      when 'create', 'destroy'
+        'edit'
+      when 'edit', 'view'
+        'view'
+      when 'revert'
+        'revert'
+      else
+        raise ::Foreman::Exception.new(N_('unknown host permission for %s'), "#{params[:controller]}##{action_permission}")
+      end
+    end
+
+    def action_permission
+      case params[:action]
+      when 'revert'
+        :revert
+      else
+        super
+      end
+    end
+
+    def check_snapshot_capability
+      not_found unless @host.compute_resource && @host.compute_resource.capabilities.include?(:snapshots)
     end
 
     def enumerate_snapshots
-      # Hash of Snapshot
-      @snapshots = Snapshot.all_for_host @host
+      # Array of Snapshot Objects
+      @snapshots = Snapshot.all_for_host(@host)
     end
 
     def find_snapshot
-      @snapshot = Snapshot.find_for_host @host, params['id']
+      @snapshot = Snapshot.find_for_host(@host, params['id'])
+      not_found unless @snapshot
+    end
+
+    def process_success(hash = {})
+      hash[:success_redirect] ||= host_path(@host, anchor: 'snapshots')
+      super(hash)
+    end
+
+    def process_error(hash = {})
+      hash[:redirect] ||= host_path(@host, anchor: 'snapshots')
+      super(hash)
     end
   end
 end

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

@@ -0,0 +1,33 @@
+module FogExtensions
+  module Vsphere
+    module Snapshots
+      module Mock
+        # Overwrite this to stop infinite recursion
+        # TODO: Add proper test data
+        def list_child_snapshots(_snapshot, _opts = {})
+          [
+          ]
+        end
+
+        def remove_snapshot(options = {})
+          raise ArgumentError, 'snapshot is a required parameter' unless options.key? 'snapshot'
+          raise ArgumentError, 'removeChildren is a required parameter' unless options.key? 'removeChildren'
+
+          {
+            'task_state' => 'success'
+          }
+        end
+
+        def rename_snapshot(options = {})
+          raise ArgumentError, 'snapshot is a required parameter' unless options.key? 'snapshot'
+          raise ArgumentError, 'name is a required parameter' unless options.key? 'name'
+          raise ArgumentError, 'description is a required parameter' unless options.key? 'description'
+
+          {
+            'task_state' => 'success'
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+module FogExtensions
+  module Vsphere
+    module Snapshots
+      module Real
+        # Extends fog-vsphere gem for a remove Snapshot method.
+        def remove_snapshot(options = {})
+          raise ArgumentError, 'snapshot is a required parameter' unless options.key? 'snapshot'
+          raise ArgumentError, 'removeChildren is a required parameter' unless options.key? 'removeChildren'
+
+          unless ::Fog::Compute::Vsphere::Snapshot === options['snapshot']
+            raise ArgumentError, 'snapshot is a required parameter'
+          end
+
+          task = options['snapshot'].mo_ref.RemoveSnapshot_Task(
+            removeChildren: options['removeChildren']
+          )
+          task.wait_for_completion
+
+          {
+            'task_state' => task.info.state
+          }
+        end
+
+        # Extends fog-vsphere gem for a rename Snapshot method.
+        # Does not have a return value, VMWare API throws a fault if there are errors
+        def rename_snapshot(options = {})
+          raise ArgumentError, 'snapshot is a required parameter' unless options.key? 'snapshot'
+          raise ArgumentError, 'name is a required parameter' unless options.key? 'name'
+          raise ArgumentError, 'description is a required parameter' unless options.key? 'description'
+
+          unless ::Fog::Compute::Vsphere::Snapshot === options['snapshot']
+            raise ArgumentError, 'snapshot is a required parameter'
+          end
+
+          options['snapshot'].mo_ref.RenameSnapshot(
+            name: options['name'],
+            description: options['description']
+          )
+        end
+      end
+    end
+  end
+end

data/app/models/foreman_snapshot_management/snapshot.rb

@@ -1,73 +1,131 @@
+require 'date'
+
 module ForemanSnapshotManagement
   class Snapshot
     extend ActiveModel::Callbacks
     include ActiveModel::Conversion
     include ActiveModel::Model
     include ActiveModel::Dirty
+    include ActiveModel::ForbiddenAttributesProtection
 
     define_model_callbacks :create, :save, :destroy, :revert
-    attr_accessor :id, :vmware_snapshot, :name, :description, :host_id
+    attr_accessor :id, :raw_snapshot, :name, :description, :host_id, :parent, :create_time
 
-    def self.add_snapshot_with_children(snapshots, host, vmware_snapshot)
-      snapshots[vmware_snapshot.ref] = new_from_vmware(host, vmware_snapshot)
-      vmware_snapshot.child_snapshots.each do |snap|
-        add_snapshot_with_children(snapshots, host, snap)
+    def self.all_for_host(host)
+      snapshots = host.compute_resource.get_snapshots(host.uuid).map do |raw_snapshot|
+        new_from_vmware(host, raw_snapshot)
       end
     end
 
-    def self.all_for_host(host)
-      snapshots = {}
-      root_snapshot = host.compute_resource.get_snapshots(host.uuid).first
-      add_snapshot_with_children(snapshots, host, root_snapshot) if root_snapshot
-      snapshots
+    def self.find_for_host(host, id)
+      raw_snapshot = host.compute_resource.get_snapshot(host.uuid, id)
+      new_from_vmware(host, raw_snapshot)
     end
 
-    def self.find_for_host(host, id)
-      all_for_host(host)[id]
+    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)
+    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}>"
+    end
+
+    def to_s
+      _('Snapshot')
     end
 
-    def self.new_from_vmware(host, vmware_snapshot)
-      new(host: host, id: vmware_snapshot.ref, vmware_snapshot: vmware_snapshot, name: vmware_snapshot.name, description: vmware_snapshot.description)
+    def formatted_create_time()
+      create_time.strftime("%F %H:%M")
     end
 
     def persisted?
-      @id.present?
+      self.id.present?
     end
 
     # host accessors
     def host
-      Host.find(@host_id)
+      Host.find(self.host_id)
     end
 
     def host=(host)
-      @host_id = host.id
+      self.host_id = host.id
+    end
+
+    def create_time
+      raw_snapshot.try(:create_time)
+    end
+
+    def assign_attributes(new_attributes)
+      attributes = new_attributes.stringify_keys
+      attributes = sanitize_for_mass_assignment(attributes)
+      attributes.each do |k, v|
+        public_send("#{k}=", v)
+      end
+    end
+
+    def update_attributes(new_attributes)
+      assign_attributes(new_attributes)
+      save
     end
 
     # crud
     def create
       run_callbacks(:create) do
-        host.compute_resource.create_snapshot(host.uuid, name, description)
+        handle_snapshot_errors do
+          host.compute_resource.create_snapshot(host.uuid, name, description)
+        end
       end
     end
 
     def save
       run_callbacks(:save) do
-        host.compute_resource.update_snapshot(vmware_snapshot, name, description)
+        handle_snapshot_errors do
+          host.compute_resource.update_snapshot(raw_snapshot, name, description)
+        end
       end
     end
 
     def destroy
       run_callbacks(:destroy) do
-        result = host.compute_resource.remove_snapshot(vmware_snapshot, false)
-        id = nil
+        result = handle_snapshot_errors do
+          result = host.compute_resource.remove_snapshot(raw_snapshot, false)
+        end
+        self.id = nil
         result
       end
     end
 
     def revert
       run_callbacks(:revert) do
-        host.compute_resource.revert_snapshot(vmware_snapshot)
+        handle_snapshot_errors do
+          host.compute_resource.revert_snapshot(raw_snapshot)
+        end
       end
     end
+
+    private
+
+    def handle_snapshot_errors
+      yield
+    rescue Foreman::WrappedException => e
+      errors.add(:base, e.wrapped_exception.message)
+      false
+    end
   end
 end

data/app/models/foreman_snapshot_management/vmware_extensions.rb

@@ -1,26 +1,41 @@
 module ForemanSnapshotManagement
   module VmwareExtensions
-    extend ActiveSupport::Concern
+    # Extend VMWare'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(uuid, name, description)
-      client.vm_take_snapshot('instance_uuid' => uuid, 'name' => name, 'description' => description)
+      task = client.vm_take_snapshot('instance_uuid' => uuid, 'name' => name, 'description' => description)
+      task_successful?(task)
+    rescue RbVmomi::Fault => e
+      Foreman::Logging.exception('Error creating VMWare Snapshot', e)
+      raise ::Foreman::WrappedException.new(e, N_('Unable to create VMWare Snapshot'))
     end
 
     # Remove Snapshot
     #
     # This method removes a Snapshot from a given host.
-    def remove_snapshot(snapshot, removeChildren)
-      client.remove_snapshot('snapshot' => snapshot, 'removeChildren' => removeChildren)
+    def remove_snapshot(snapshot, remove_children)
+      task = client.remove_snapshot('snapshot' => snapshot, 'removeChildren' => remove_children)
+      task_successful?(task)
+    rescue RbVmomi::Fault => e
+      Foreman::Logging.exception('Error removing VMWare Snapshot', e)
+      raise ::Foreman::WrappedException.new(e, N_('Unable to remove VMWare Snapshot'))
     end
 
     # Revert Snapshot
     #
     # This method revert a host to a given Snapshot.
     def revert_snapshot(snapshot)
-      client.revert_to_snapshot(snapshot)
+      task = client.revert_to_snapshot(snapshot)
+      task_successful?(task)
+    rescue RbVmomi::Fault => e
+      Foreman::Logging.exception('Error reverting VMWare Snapshot', e)
+      raise ::Foreman::WrappedException.new(e, N_('Unable to revert VMWare Snapshot'))
     end
 
     # Update Snapshot
@@ -28,13 +43,30 @@ module ForemanSnapshotManagement
     # This method renames a Snapshot from a given host.
     def update_snapshot(snapshot, name, description)
       client.rename_snapshot('snapshot' => snapshot, 'name' => name, 'description' => description)
+      true
+    rescue RbVmomi::Fault => e
+      Foreman::Logging.exception('Error updating VMWare Snapshot', e)
+      raise ::Foreman::WrappedException.new(e, N_('Unable to update VMWare Snapshot'))
+    end
+
+    # Get Snapshot
+    #
+    # This methods returns a specific Snapshot for a given host.
+    def get_snapshot(server_id, snapshot_id)
+      client.snapshots(server_id: server_id).get(snapshot_id)
     end
 
     # Get Snapshots
     #
     # This methods returns Snapshots from a given host.
     def get_snapshots(server_id)
-      client.snapshots(server_id: server_id)
+      client.snapshots(server_id: server_id).all(recursive: true)
+    end
+
+    private
+
+    def task_successful?(task)
+      task['task_state'] == 'success' || task['state'] == 'success'
     end
   end
 end

data/app/overrides/hosts/add_tab_to_host_overview.rb

@@ -1,21 +1,11 @@
-tab = "<%  if @host.provider == 'VMware' %>
-        <li><a href='#snapshots' data-toggle='tab'><%= _('Snapshots') %></a></li>
-       <% end %>"
-
-tab_content = "<div id='snapshots' class='tab-pane'
-                data-ajax-url='<%= host_snapshots_path(host_id: @host)%>'
-                data-on-complete='onContentLoad'>
-  <%= spinner(_('Loading Parameters information ...')) %>
-</div>"
-
 # Add a Snapshots tab in the view of a host
 Deface::Override.new(virtual_path: 'hosts/show',
                      name: 'add_host_snapshot_tab',
                      insert_bottom: 'ul',
-                     text: tab)
+                     partial: 'foreman_snapshot_management/hosts/snapshots_tab')
 
 # Load content of Snapshots tab
 Deface::Override.new(virtual_path: 'hosts/show',
                      name: 'add_host_snapshots_tab_content',
                      insert_bottom: 'div#myTabContent',
-                     text: tab_content)
+                     partial: 'foreman_snapshot_management/hosts/snapshots_tab_content')

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

@@ -0,0 +1,3 @@
+object @snapshot
+
+attributes :id, :name

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

@@ -0,0 +1,3 @@
+object @snapshot
+
+extends 'api/v2/snapshots/show'

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

@@ -0,0 +1,3 @@
+object @snapshot
+
+extends 'api/v2/snapshots/show'

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

@@ -0,0 +1,3 @@
+collection @snapshots
+
+extends 'api/v2/snapshots/main'

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

@@ -0,0 +1,9 @@
+object @snapshot
+
+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) }

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

@@ -0,0 +1,3 @@
+object @snapshot
+
+extends 'api/v2/snapshots/show'

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

@@ -0,0 +1,3 @@
+object @snapshot
+
+extends 'api/v2/snapshots/main'

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

@@ -0,0 +1,3 @@
+object @snapshot
+
+extends 'api/v2/snapshots/show'

data/app/views/foreman_snapshot_management/hosts/_snapshots_tab.html.erb

@@ -0,0 +1,3 @@
+<% if @host.compute_resource && @host.compute_resource.capabilities.include?(:snapshots) && authorized_for(:controller => 'foreman_snapshot_management/snapshots', :action => :index) %>
+  <li><a href='#snapshots' data-toggle='tab'><%= _('Snapshots') %></a></li>
+<% end %>

data/app/views/foreman_snapshot_management/hosts/_snapshots_tab_content.html.erb

@@ -0,0 +1,7 @@
+<% if @host.compute_resource && @host.compute_resource.capabilities.include?(:snapshots) && authorized_for(:controller => 'foreman_snapshot_management/snapshots', :action => :index) %>
+<div id='snapshots' class='tab-pane'
+  data-ajax-url='<%= host_snapshots_path(host_id: @host)%>'
+  data-on-complete='onContentLoad'>
+  <%= spinner(_('Loading Snapshots information ...')) %>
+</div>
+<% end %>

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

@@ -8,29 +8,40 @@
   </tr>
   </thead>
   <tbody>
-    <tr>
-      <td>
-        <%= f.text_field :name, class: 'form-control' %>
-      </td>
-      <td>
-        <%= f.text_field :description, class: 'form-control' %>
-      </td>
-      <td>
-        <%= f.submit _('Create'), class: 'btn btn-success' %>
-      </td>
-    </tr>
-  <% @snapshots.each do |ref, snap| %>
+    <% if authorized_for(:controller => 'foreman_snapshot_management/snapshots', :action => :create) %>
       <tr>
         <td>
-          <%= edit_textfield snap, :name %>
+          <%= f.text_field :name, class: 'form-control' %>
         </td>
         <td>
-          <%= edit_textarea snap, :description %>
+          <%= f.text_field :description, class: 'form-control' %>
+        </td>
+        <td>
+          <%= f.submit _('Create'), class: 'btn btn-success' %>
+        </td>
+      </tr>
+    <% end %>
+  <% @snapshots.each do |snapshot| %>
+      <tr>
+        <td>
+          <% if authorized_for(:controller => 'foreman_snapshot_management/snapshots', :action => :edit) %>
+            <%= edit_textfield snapshot, :name %>
+          <% else %>
+            <%= snapshot.name %>
+          <% end %>
+          <br /><%= snapshot.formatted_create_time() %>
+        </td>
+        <td>
+          <% if authorized_for(:controller => 'foreman_snapshot_management/snapshots', :action => :edit) %>
+            <%= edit_textarea snapshot, :description %>
+          <% else %>
+            <%= snapshot.description %>
+          <% end %>
         </td>
         <td>
           <%= action_buttons(
-            display_link_if_authorized(_('Rollback'), hash_for_revert_host_snapshot_path(host_id: @host, id: ref), method: :put, class: 'btn btn-primary', data: {confirm: _("Are you sure to revert this Snapshot?")}),
-            display_delete_if_authorized(hash_for_host_snapshot_path(host_id: @host, id: ref), data: {confirm: _("Are you sure to delete this Snapshot?")}),
+            display_link_if_authorized(_('Rollback'), hash_for_revert_host_snapshot_path(host_id: @host, id: snapshot.id), method: :put, class: 'btn btn-primary', data: {confirm: _("Are you sure to revert this Snapshot?")}),
+            display_delete_if_authorized(hash_for_host_snapshot_path(host_id: @host, id: snapshot.id), data: {confirm: _("Are you sure to delete this Snapshot?")}),
           ) %>
         </td>
       </tr>

data/config/routes.rb

@@ -1,4 +1,21 @@
 Rails.application.routes.draw do
+  namespace :api, :defaults => { :format => 'json' } do
+    scope '(:apiv)', :module => :v2,
+                     :defaults => { :apiv => 'v2' },
+                     :apiv => /v1|v2/,
+                     :constraints => ApiConstraints.new(:version => 2, :default => true) do
+      constraints(:host_id => /[^\/]+/) do
+        resources :hosts, :only => [] do
+          constraints(:id => /[^\/]+/) do
+            resources :snapshots, except: [:new, :edit] do
+              put :revert, :on => :collection
+            end
+          end
+        end
+      end
+    end
+  end
+
   constraints(host_id: %r{[^\/]+}) do
     resources :hosts, only: [] do
       resources :snapshots, module: 'foreman_snapshot_management' do

data/lib/foreman_snapshot_management/engine.rb

@@ -4,25 +4,52 @@ module ForemanSnapshotManagement
   class Engine < ::Rails::Engine
     engine_name 'foreman_snapshot_management'
 
-    config.autoload_paths += Dir["#{config.root}/app/controllers/foreman_snapshot_management/"]
-    config.autoload_paths += Dir["#{config.root}/app/helpers/foreman_snapshot_management/"]
-    config.autoload_paths += Dir["#{config.root}/app/models/foreman_snapshot_management"]
-    config.autoload_paths += Dir["#{config.root}/app/overrides"]
+    config.autoload_paths += Dir["#{config.root}/app/models/concerns"]
+    config.autoload_paths += Dir["#{config.root}/app/controllers/concerns"]
 
     initializer 'foreman_snapshot_management.register_plugin', before: :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_snapshot_management do
         requires_foreman '>= 1.14'
 
+        apipie_documented_controllers ["#{ForemanSnapshotManagement::Engine.root}/app/controllers/api/v2/*.rb"]
+
         # Add permissions
         security_block :foreman_snapshot_management do
-          permission :view_foreman_snapshot_management, :'foreman_snapshot_management/hosts' => [:new_action]
-          permission :view_foreman_snapshot_management, :'foreman_snapshot_management/virtualmachines' => [:index]
-          permission :view_foreman_snapshot_management, :'foreman_snapshot_management/createsnapshot' => [:index]
-          permission :view_foreman_snapshot_management, :'foreman_snapshot_management/createsnapshot' => [:createSnapshot]
+          permission :view_snapshots, {
+            :'foreman_snapshot_management/snapshots' => [:index],
+            :'api/v2/snapshots' => [:index, :show]
+          }, :resource_type => 'Host'
+
+          permission :create_snapshots, {
+            :'foreman_snapshot_management/snapshots' => [:create],
+            :'api/v2/snapshots' => [:create]
+          }, :resource_type => 'Host'
+
+          permission :edit_snapshots, {
+            :'foreman_snapshot_management/snapshots' => [:update],
+            :'api/v2/snapshots' => [:update]
+          }, :resource_type => 'Host'
+
+          permission :destroy_snapshots, {
+            :'foreman_snapshot_management/snapshots' => [:destroy],
+            :'api/v2/snapshots' => [:destroy]
+          }, :resource_type => 'Host'
+
+          permission :revert_snapshots, {
+            :'foreman_snapshot_management/snapshots' => [:revert],
+            :'api/v2/snapshots' => [:revert]
+          }, :resource_type => 'Host'
         end
 
-        # Add a new role called 'ForemanSnapshotManagement' if it doesn't exist
-        role 'ForemanSnapshotManagement', [:view_foreman_snapshot_management]
+        # Adds roles if they do not exist
+        role 'Snapshot Viewer', [:view_snapshots]
+        role 'Snapshot Manager', [
+          :view_snapshots,
+          :create_snapshots,
+          :edit_snapshots,
+          :destroy_snapshots,
+          :revert_snapshots
+        ]
       end
     end
 
@@ -45,7 +72,14 @@ module ForemanSnapshotManagement
     # Include concerns in this config.to_prepare block
     config.to_prepare do
       begin
-        ::Foreman::Model::Vmware.send(:include, ForemanSnapshotManagement::VmwareExtensions)
+        # Load Foreman extensions
+        ::Foreman::Model::Vmware.send(:prepend, ForemanSnapshotManagement::VmwareExtensions)
+
+        # Load Fog extensions
+        if Foreman::Model::Vmware.available?
+          Fog::Compute::Vsphere::Real.send(:prepend, FogExtensions::Vsphere::Snapshots::Real)
+          Fog::Compute::Vsphere::Mock.send(:prepend, FogExtensions::Vsphere::Snapshots::Mock)
+        end
       rescue => e
         Rails.logger.warn "ForemanSnapshotManagement: skipping engine hook (#{e})"
       end

data/lib/foreman_snapshot_management/version.rb

@@ -1,3 +1,3 @@
 module ForemanSnapshotManagement
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/test/controllers/api/v2/snapshots_test.rb

@@ -0,0 +1,57 @@
+require 'test_helper'
+
+class Api::V2::SnapshotsControllerTest < ActionController::TestCase
+  let(:compute_resource) do
+    cr = FactoryGirl.create(:compute_resource, :vmware, :uuid => 'Solutions')
+    ComputeResource.find_by_id(cr.id)
+  end
+  let(:uuid) { '5032c8a5-9c5e-ba7a-3804-832a03e16381' }
+  let(:host) { FactoryGirl.create(:host, :managed, :compute_resource => compute_resource, :uuid => uuid) }
+  let(:snapshot_id) { 'snapshot-0101' }
+  setup { ::Fog.mock! }
+  teardown { ::Fog.unmock! }
+
+  test 'should get index' do
+    get :index, { :host_id => host.to_param }
+    assert_response :success
+    assert_not_nil assigns(:snapshots)
+    body = ActiveSupport::JSON.decode(@response.body)
+    refute_empty body
+    refute_empty body['results']
+  end
+
+  test 'should show snapshot' do
+    get :show, { :host_id => host.to_param, :id => snapshot_id }
+    assert_not_nil assigns(:snapshot)
+    assert_response :success
+    body = ActiveSupport::JSON.decode(@response.body)
+    refute_empty body
+  end
+
+  test 'should 404 for unknown snapshot' do
+    get :show, { :host_id => host.to_param, :id => 'does-not-exist' }
+    assert_response :not_found
+  end
+
+  test 'should create snapshot' do
+    post :create, { :host_id => host.to_param, :name => 'test' }
+    assert_response :created
+    assert_not_nil assigns(:snapshot)
+  end
+
+  test 'should update snapshot' do
+    name = 'test'
+    put :update, { :host_id => host.to_param, :id => snapshot_id.to_param, :name => name.to_param }
+    assert_response :success
+  end
+
+  test 'should destroy snapshot' do
+    delete :destroy, { :host_id => host.to_param, :id => snapshot_id.to_param }
+    assert_response :success
+  end
+
+  test 'should revert snapshot' do
+    put :revert, { :host_id => host.to_param, :id => snapshot_id.to_param }
+    assert_response :success
+  end
+end

data/test/controllers/foreman_snapshot_management/snapshots_controller_test.rb

@@ -0,0 +1,85 @@
+require 'test_helper'
+
+module ForemanSnapshotManagement
+  class SnapshotsControllerTest < ActionController::TestCase
+    let(:compute_resource) do
+      cr = FactoryGirl.create(:compute_resource, :vmware, :uuid => 'Solutions')
+      ComputeResource.find_by_id(cr.id)
+    end
+    let(:uuid) { '5032c8a5-9c5e-ba7a-3804-832a03e16381' }
+    let(:host) { FactoryGirl.create(:host, :managed, :compute_resource => compute_resource, :uuid => uuid) }
+    let(:snapshot_id) { 'snapshot-0101' }
+    setup { ::Fog.mock! }
+    teardown { ::Fog.unmock! }
+
+    context 'GET #index' do
+      test 'should get index' do
+        get :index, { :host_id => host.to_param }, set_session_user
+        assert_response :success
+        assert_not_nil assigns(:snapshots)
+        assert_template 'foreman_snapshot_management/snapshots/_index'
+      end
+    end
+
+    context 'POST #create' do
+      test 'create valid' do
+        post :create, { :host_id => host.to_param, :snapshot => { :name => 'test' } }, set_session_user
+        assert_redirected_to host_url(host, :anchor => 'snapshots')
+        assert_includes flash[:notice], 'Successfully created Snapshot.'
+      end
+
+      test 'create invalid' do
+        ForemanSnapshotManagement::Snapshot.any_instance.stubs(:create).returns(false)
+        post :create, { :host_id => host.to_param, :snapshot => { :name => nil } }, set_session_user
+        assert_redirected_to host_url(host, :anchor => 'snapshots')
+        assert_includes flash[:error], 'Error occurred while creating Snapshot'
+      end
+    end
+
+    context 'DELETE #destroy' do
+      test 'destroy successful' do
+        delete :destroy, { :host_id => host.to_param, :id => snapshot_id }, set_session_user
+        assert_redirected_to host_url(host, :anchor => 'snapshots')
+        assert_includes flash[:notice], 'Successfully deleted Snapshot.'
+      end
+
+      test 'destroy with error' do
+        ForemanSnapshotManagement::Snapshot.any_instance.stubs(:destroy).returns(false)
+        delete :destroy, { :host_id => host.to_param, :id => snapshot_id }, set_session_user
+        assert_redirected_to host_url(host, :anchor => 'snapshots')
+        assert_includes flash[:error], 'Error occurred while removing Snapshot'
+      end
+    end
+
+    context 'PUT #revert' do
+      test 'revert successful' do
+        put :revert, { :host_id => host.to_param, :id => snapshot_id }, set_session_user
+        assert_redirected_to host_url(host, :anchor => 'snapshots')
+        assert_includes flash[:notice], 'VM successfully rolled back.'
+      end
+
+      test 'revert with error' do
+        ForemanSnapshotManagement::Snapshot.any_instance.stubs(:revert).returns(false)
+        put :revert, { :host_id => host.to_param, :id => snapshot_id }, set_session_user
+        assert_redirected_to host_url(host, :anchor => 'snapshots')
+        assert_includes flash[:error], 'Error occurred while rolling back VM'
+      end
+    end
+
+    context 'PUT #update' do
+      test 'update successful' do
+        data = { 'name' => 'test 2', 'description' => '' }
+        put :update, { :host_id => host.to_param, :id => snapshot_id, :snapshot => data }, set_session_user
+        assert_response :success
+        body = ActiveSupport::JSON.decode(@response.body)
+        assert_equal(data, body)
+      end
+
+      test 'update with error' do
+        ForemanSnapshotManagement::Snapshot.any_instance.stubs(:save).returns(false)
+        put :update, { :host_id => host.to_param, :id => snapshot_id, :snapshot => { :name => 'test 2' } }, set_session_user
+        assert_response :unprocessable_entity
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_snapshot_management
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - ATIX AG
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-11 00:00:00.000000000 Z
+date: 2017-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -48,12 +48,25 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- app/controllers/api/v2/snapshots_controller.rb
+- app/controllers/concerns/foreman/controller/parameters/snapshot.rb
 - app/controllers/foreman_snapshot_management/snapshots_controller.rb
 - app/helpers/foreman_snapshot_management/snapshot_helper.rb
-- app/helpers/foreman_snapshot_management/snapshotadministration_helper.rb
+- app/models/concerns/fog_extensions/vsphere/snapshots/mock.rb
+- app/models/concerns/fog_extensions/vsphere/snapshots/real.rb
 - app/models/foreman_snapshot_management/snapshot.rb
 - app/models/foreman_snapshot_management/vmware_extensions.rb
 - app/overrides/hosts/add_tab_to_host_overview.rb
+- app/views/api/v2/snapshots/base.json.rabl
+- app/views/api/v2/snapshots/create.json.rabl
+- app/views/api/v2/snapshots/destroy.json.rabl
+- app/views/api/v2/snapshots/index.json.rabl
+- app/views/api/v2/snapshots/main.json.rabl
+- app/views/api/v2/snapshots/revert.json.rabl
+- app/views/api/v2/snapshots/show.json.rabl
+- app/views/api/v2/snapshots/update.json.rabl
+- app/views/foreman_snapshot_management/hosts/_snapshots_tab.html.erb
+- app/views/foreman_snapshot_management/hosts/_snapshots_tab_content.html.erb
 - app/views/foreman_snapshot_management/snapshots/_index.html.erb
 - config/routes.rb
 - lib/foreman_snapshot_management.rb
@@ -64,8 +77,9 @@ files:
 - locale/en/foreman_snapshot_management.po
 - locale/foreman_snapshot_management.pot
 - locale/gemspec.rb
+- test/controllers/api/v2/snapshots_test.rb
+- test/controllers/foreman_snapshot_management/snapshots_controller_test.rb
 - test/test_plugin_helper.rb
-- test/unit/foreman_snapshot_management_test.rb
 homepage: http://www.orcharhino.com
 licenses: []
 metadata: {}
@@ -85,10 +99,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: Snapshot Management for VMware vSphere
 test_files:
+- test/controllers/api/v2/snapshots_test.rb
+- test/controllers/foreman_snapshot_management/snapshots_controller_test.rb
 - test/test_plugin_helper.rb
-- test/unit/foreman_snapshot_management_test.rb

data/app/helpers/foreman_snapshot_management/snapshotadministration_helper.rb

@@ -1,72 +0,0 @@
-module ForemanSnapshotManagement
-  module SnapshotadministrationHelper
-  end
-end
-
-module Fog
-  module Compute
-    class Vsphere
-      class Real
-        # Extends fog-vsphere gem for a remove Snapshot method.
-        def remove_snapshot(options = {})
-          raise ArgumentError, 'snapshot is a required parameter' unless options.key? 'snapshot'
-          raise ArgumentError, 'removeChildren is a required parameter' unless options.key? 'removeChildren'
-
-          unless Snapshot === options['snapshot']
-            raise ArgumentError, 'snapshot is a required parameter'
-          end
-
-          task = options['snapshot'].mo_ref.RemoveSnapshot_Task(
-            removeChildren: options['removeChildren']
-          )
-          task.wait_for_completion
-
-          {
-            'task_state' => task.info.state
-          }
-        end
-
-        # Extends fog-vsphere gem for a rename Snapshot method.
-        # TODO: Add info state
-        def rename_snapshot(options = {})
-          raise ArgumentError, 'snapshot is a required parameter' unless options.key? 'snapshot'
-          raise ArgumentError, 'name is a required parameter' unless options.key? 'name'
-          raise ArgumentError, 'description is a required parameter' unless options.key? 'description'
-
-          unless Snapshot === options['snapshot']
-            raise ArgumentError, 'snapshot is a required parameter'
-          end
-
-          task = options['snapshot'].mo_ref.RenameSnapshot(
-            name: options['name'],
-            description: options['description']
-          )
-          # task.wait_for_completion
-
-          # {
-          #    'task_state' => task.info.state
-          # }
-        end
-      end
-      class Mock
-        def remove_snapshot(snapshot)
-          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' if snapshot.nil?
-          {
-            'task_state' => 'success'
-          }
-        end
-
-        def rename_snapshot(_snapshot)
-          raise ArgumentError, 'snapshot is a required parameter' unless options.key? 'snapshot'
-          raise ArgumentError, 'name is a required parameter' unless options.key? 'name'
-          raise ArgumentError, 'description is a required parameter' unless options.key? 'description'
-          {
-            'task_state' => 'success'
-          }
-        end
-      end
-    end
-  end
-end

data/test/unit/foreman_snapshot_management_test.rb

@@ -1,11 +0,0 @@
-require 'test_plugin_helper'
-
-class ForemanSnapshotManagementTest < ActiveSupport::TestCase
-  setup do
-    User.current = User.find_by_login 'admin'
-  end
-
-  test 'the truth' do
-    assert true
-  end
-end