foreman_snapshot_management 1.0.0

data/README.md

@@ -0,0 +1,15 @@
+# ForemanSnapshotManagement
+
+ForemanSnapshotManagement is a Foreman plugin to manage snapshots.
+As Hypervisor VMware vSphere is supported.
+
+## Features
+
+- List existing snapshots of a virtual machine.
+- Create a snapshot of a virtual machine.
+- Revert existing virtual machine to a previously created snapshot.
+- Remove existing snapshots of a virtual machine.
+
+## 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

data/Rakefile

@@ -0,0 +1,47 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ForemanSnapshotManagement'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test
+
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue => _
+  puts 'Rubocop not loaded.'
+end
+
+task :default do
+  Rake::Task['rubocop'].execute
+end

data/app/controllers/foreman_snapshot_management/snapshots_controller.rb

@@ -0,0 +1,117 @@
+module ForemanSnapshotManagement
+  class SnapshotsController < ApplicationController
+    before_action :find_host
+    before_action :enumerate_snapshots, only: [:index]
+    before_action :find_snapshot, only: %i[destroy revert update]
+    helper_method :xeditable?
+
+    def xeditable?(_object = nil)
+      true
+    end
+
+    def index
+      @new_snapshot = Snapshot.new(host: @host)
+      render partial: 'index'
+    end
+
+    # Create a Snapshot.
+    #
+    # 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 }
+      end
+    end
+
+    # Remove Snapshot
+    #
+    # 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'
+      else
+        status = 'Error occurred while removing Snapshot: ' + task['task_state']
+      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')
+      else
+        status = _('Error occurred while rolling back VM: %s') % task['state']
+      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
+        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
+      end
+    end
+
+    # Find Host
+    #
+    # This method is responsible that methods of the controller know the current host.
+
+    private
+
+    def find_host
+      @host = Host.find_by! name: params['host_id']
+    rescue => e
+      process_ajax_error e, 'Host not found!'
+    end
+
+    def enumerate_snapshots
+      # Hash of Snapshot
+      @snapshots = Snapshot.all_for_host @host
+    end
+
+    def find_snapshot
+      @snapshot = Snapshot.find_for_host @host, params['id']
+    end
+  end
+end

data/app/helpers/foreman_snapshot_management/snapshot_helper.rb

@@ -0,0 +1,7 @@
+module ForemanSnapshotManagement
+  module SnapshotHelper
+    def foreman_snapshot_management_snapshot_path(snapshot)
+      host_snapshot_path(host_id: snapshot.host, id: snapshot.id)
+    end
+  end
+end

data/app/helpers/foreman_snapshot_management/snapshotadministration_helper.rb

@@ -0,0 +1,72 @@
+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/app/models/foreman_snapshot_management/snapshot.rb

@@ -0,0 +1,73 @@
+module ForemanSnapshotManagement
+  class Snapshot
+    extend ActiveModel::Callbacks
+    include ActiveModel::Conversion
+    include ActiveModel::Model
+    include ActiveModel::Dirty
+
+    define_model_callbacks :create, :save, :destroy, :revert
+    attr_accessor :id, :vmware_snapshot, :name, :description, :host_id
+
+    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)
+      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
+    end
+
+    def self.find_for_host(host, id)
+      all_for_host(host)[id]
+    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)
+    end
+
+    def persisted?
+      @id.present?
+    end
+
+    # host accessors
+    def host
+      Host.find(@host_id)
+    end
+
+    def host=(host)
+      @host_id = host.id
+    end
+
+    # crud
+    def create
+      run_callbacks(:create) do
+        host.compute_resource.create_snapshot(host.uuid, name, description)
+      end
+    end
+
+    def save
+      run_callbacks(:save) do
+        host.compute_resource.update_snapshot(vmware_snapshot, name, description)
+      end
+    end
+
+    def destroy
+      run_callbacks(:destroy) do
+        result = host.compute_resource.remove_snapshot(vmware_snapshot, false)
+        id = nil
+        result
+      end
+    end
+
+    def revert
+      run_callbacks(:revert) do
+        host.compute_resource.revert_snapshot(vmware_snapshot)
+      end
+    end
+  end
+end

data/app/models/foreman_snapshot_management/vmware_extensions.rb

@@ -0,0 +1,40 @@
+module ForemanSnapshotManagement
+  module VmwareExtensions
+    extend ActiveSupport::Concern
+
+    # 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)
+    end
+
+    # Remove Snapshot
+    #
+    # This method removes a Snapshot from a given host.
+    def remove_snapshot(snapshot, removeChildren)
+      client.remove_snapshot('snapshot' => snapshot, 'removeChildren' => removeChildren)
+    end
+
+    # Revert Snapshot
+    #
+    # This method revert a host to a given Snapshot.
+    def revert_snapshot(snapshot)
+      client.revert_to_snapshot(snapshot)
+    end
+
+    # Update Snapshot
+    #
+    # This method renames a Snapshot from a given host.
+    def update_snapshot(snapshot, name, description)
+      client.rename_snapshot('snapshot' => snapshot, 'name' => name, 'description' => description)
+    end
+
+    # Get Snapshots
+    #
+    # This methods returns Snapshots from a given host.
+    def get_snapshots(server_id)
+      client.snapshots(server_id: server_id)
+    end
+  end
+end

data/app/overrides/hosts/add_tab_to_host_overview.rb

@@ -0,0 +1,21 @@
+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)
+
+# 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)

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

@@ -0,0 +1,57 @@
+<%= 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"><%= _('Action') %></th>
+  </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| %>
+      <tr>
+        <td>
+          <%= edit_textfield snap, :name %>
+        </td>
+        <td>
+          <%= edit_textarea snap, :description %>
+        </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?")}),
+          ) %>
+        </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>