foreman_snapshot_management 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 92825bf181cfd185b7005b4ae8484a45fb76be22
-  data.tar.gz: 69df917d45d4c2fee44194a275aad9b3a93b0484
+SHA256:
+  metadata.gz: 7507324502c4b729cde6774cf001a3783ac85729317a579c7b9bd94f5f21fefd
+  data.tar.gz: 8a4c85f4afb3d6ef0e27c204a9dcd72b6d297c7f775bc1f00f36f30b49c77f75
 SHA512:
-  metadata.gz: 1c6fe6bf1cd7b925a20bdd929e519901d193fecbf5817736c4056ffebe2f35bf8c293d313b820cf134bedf8489ccebf1ebd94ba30ff852f62e3ea7b0b9bfbf40
-  data.tar.gz: a24566a0193ce31c7dc8060cee2d82a6c2ca82a232cdd813d7c7595d2211d378768511093e1084f88e5f7040283ace1cf63b37f49f76febe466c156ed1863c41
+  metadata.gz: 9e3dc6c2ef546c2ebf8c0945dade24a16cdc27fb0fc8bdd7e73b42e2e4c66869bf1c9769511ea3b53796cbb039f1b975aba40d755447886fa8bbbd0a73251e9d
+  data.tar.gz: a325a2bc81c54066b4579a50a4622b944bda27c9aedc42c19f7894c6ad90196aa93581dc2b12d5f639b052d8496ca3efac2d1c9013701caba6a3fa79d364d13a

data/Rakefile

@@ -38,7 +38,7 @@ task default: :test
 begin
   require 'rubocop/rake_task'
   RuboCop::RakeTask.new
-rescue => _
+rescue StandardError => _
   puts 'Rubocop not loaded.'
 end
 

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

@@ -29,10 +29,11 @@ module Api
 
       api :POST, '/hosts/:host_id/snapshots/', N_('Create a snapshot')
       param :host_id, :identifier_dottable, :required => true
+      param :include_ram, :bool, :default_value => false, :desc => N_('Whether to include the RAM state in the snapshot')
       param_group :snapshot, :as => :create
 
       def create
-        @snapshot = resource_class.new(snapshot_params.to_h.merge(host: @nested_obj))
+        @snapshot = resource_class.new(snapshot_params.to_h.merge(host: @nested_obj).merge(include_ram: params[:include_ram]))
         process_response @snapshot.save
       end
 

data/app/controllers/foreman_snapshot_management/snapshots_controller.rb

@@ -21,7 +21,7 @@ module ForemanSnapshotManagement
     #
     # This method creates a Snapshot with a given name and optional description.
     def create
-      @snapshot = Snapshot.new(snapshot_params.merge(host: @host))
+      @snapshot = Snapshot.new(snapshot_params.merge(host: @host).merge(include_ram: params[:snapshot][:include_ram]))
 
       if @snapshot.create
         process_success
@@ -67,12 +67,12 @@ module ForemanSnapshotManagement
       end
     end
 
+    private
+
     # Find Host
     #
     # This method is responsible that methods of the controller know the current host.
 
-    private
-
     def find_host
       host_id = params[:host_id]
       if host_id.blank?
@@ -80,10 +80,9 @@ module ForemanSnapshotManagement
         return false
       end
       @host = Host.authorized("#{action_permission}_snapshots".to_sym, Host).friendly.find(host_id)
-      unless @host
-        not_found
-        return(false)
-      end
+      return @host if @host
+      not_found
+      false
     end
 
     def action_permission

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

@@ -5,8 +5,7 @@ module FogExtensions
         # Overwrite this to stop infinite recursion
         # TODO: Add proper test data
         def list_child_snapshots(_snapshot, _opts = {})
-          [
-          ]
+          []
         end
 
         def remove_snapshot(options = {})

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

@@ -7,9 +7,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'
 
-          unless ::Fog::Compute::Vsphere::Snapshot === options['snapshot']
-            raise ArgumentError, 'snapshot is a required parameter'
-          end
+          raise ArgumentError, 'snapshot is a required parameter' unless ::Fog::Compute::Vsphere::Snapshot === options['snapshot']
 
           task = options['snapshot'].mo_ref.RemoveSnapshot_Task(
             removeChildren: options['removeChildren']
@@ -28,9 +26,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'
 
-          unless ::Fog::Compute::Vsphere::Snapshot === options['snapshot']
-            raise ArgumentError, 'snapshot is a required parameter'
-          end
+          raise ArgumentError, 'snapshot is a required parameter' unless ::Fog::Compute::Vsphere::Snapshot === options['snapshot']
 
           options['snapshot'].mo_ref.RenameSnapshot(
             name: options['name'],

data/app/models/foreman_snapshot_management/snapshot.rb

@@ -9,11 +9,13 @@ module ForemanSnapshotManagement
     include ActiveModel::ForbiddenAttributesProtection
 
     define_model_callbacks :create, :save, :destroy, :revert
-    attr_accessor :id, :raw_snapshot, :name, :description, :host_id, :parent, :create_time
-    define_attribute_methods :name, :description
+    attr_accessor :id, :raw_snapshot, :parent
+    attr_writer :create_time
+    attr_reader :name, :description, :include_ram, :host_id
+    define_attribute_methods :name, :description, :include_ram
 
     def self.all_for_host(host)
-      snapshots = host.compute_resource.get_snapshots(host.uuid).map do |raw_snapshot|
+      host.compute_resource.get_snapshots(host.uuid).map do |raw_snapshot|
         new_from_vmware(host, raw_snapshot)
       end
     end
@@ -51,8 +53,8 @@ module ForemanSnapshotManagement
       _('Snapshot')
     end
 
-    def formatted_create_time()
-      create_time.strftime("%F %H:%M")
+    def formatted_create_time
+      create_time.strftime('%F %H:%M')
     end
 
     def persisted?
@@ -69,23 +71,26 @@ module ForemanSnapshotManagement
       @description = value
     end
 
+    def include_ram=(value)
+      raise Exception('Cannot modify include_ram on existing snapshots.') if persisted?
+      @include_ram = value
+    end
+
     # host accessors
     def host
       @host ||= Host.find(@host_id)
     end
 
     def host_id=(host_id)
-      if @host_id != host_id
-        @host_id = host_id
-        @host = nil
-      end
+      return if @host_id == host_id
+      @host_id = host_id
+      @host = nil
     end
 
     def host=(host)
-      if @host_id != host.id
-        @host_id = host.id
-        @host = host
-      end
+      return if @host_id == host.id
+      @host_id = host.id
+      @host = host
     end
 
     def create_time
@@ -111,7 +116,7 @@ module ForemanSnapshotManagement
         handle_snapshot_errors do
           host.audit_comment = "Create snapshot #{name}"
           host.save!
-          host.compute_resource.create_snapshot(host.uuid, name, description)
+          host.compute_resource.create_snapshot(host.uuid, name, description, include_ram)
           changes_applied
         end
       end

data/app/models/foreman_snapshot_management/vmware_extensions.rb

@@ -8,8 +8,8 @@ module ForemanSnapshotManagement
     # Create a Snapshot.
     #
     # This method creates a Snapshot with a given name and optional description.
-    def create_snapshot(uuid, name, description)
-      task = client.vm_take_snapshot('instance_uuid' => uuid, 'name' => name, 'description' => 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)
       task_successful?(task)
     rescue RbVmomi::Fault => e
       Foreman::Logging.exception('Error creating VMWare Snapshot', e)
@@ -56,9 +56,7 @@ module ForemanSnapshotManagement
       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
-      while snapshot && snapshot.ref != snapshot_id
-        snapshot = snapshot.get_child(snapshot_id)
-      end
+      snapshot = snapshot.get_child(snapshot_id) while snapshot && snapshot.ref != snapshot_id
       snapshot
     end
 

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

@@ -4,6 +4,7 @@
   <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>
@@ -17,7 +18,10 @@
           <%= f.text_field :description, class: 'form-control' %>
         </td>
         <td>
-          <%= f.submit _('Create'), class: 'btn btn-success' %>
+          <%= 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 %>
@@ -38,10 +42,12 @@
             <%= 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?")}),
-            display_delete_if_authorized(hash_for_host_snapshot_path(host_id: @host, id: snapshot.id).merge(:auth_object => @host, :permission => :delete_snapshots), 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).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>

data/lib/foreman_snapshot_management/engine.rb

@@ -80,7 +80,7 @@ module ForemanSnapshotManagement
           Fog::Compute::Vsphere::Real.send(:prepend, FogExtensions::Vsphere::Snapshots::Real)
           Fog::Compute::Vsphere::Mock.send(:prepend, FogExtensions::Vsphere::Snapshots::Mock)
         end
-      rescue => e
+      rescue StandardError => e
         Rails.logger.warn "ForemanSnapshotManagement: skipping engine hook (#{e})"
       end
     end

data/lib/foreman_snapshot_management/version.rb

@@ -1,3 +1,3 @@
 module ForemanSnapshotManagement
-  VERSION = '1.3.0'.freeze
+  VERSION = '1.4.0'.freeze
 end

data/lib/tasks/foreman_snapshot_management_tasks.rake

@@ -19,7 +19,7 @@ namespace :foreman_snapshot_management do
                          "#{ForemanSnapshotManagement::Engine.root}/lib/**/*.rb",
                          "#{ForemanSnapshotManagement::Engine.root}/test/**/*.rb"]
       end
-    rescue
+    rescue StandardError
       puts 'Rubocop not loaded.'
     end
 
@@ -30,6 +30,4 @@ end
 Rake::Task[:test].enhance ['test:foreman_snapshot_management']
 
 load 'tasks/jenkins.rake'
-if Rake::Task.task_defined?(:'jenkins:unit')
-  Rake::Task['jenkins:unit'].enhance ['test:foreman_snapshot_management', 'foreman_snapshot_management:rubocop']
-end
+Rake::Task['jenkins:unit'].enhance ['test:foreman_snapshot_management', 'foreman_snapshot_management:rubocop'] if Rake::Task.task_defined?(:'jenkins:unit')

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

@@ -12,7 +12,7 @@ class Api::V2::SnapshotsControllerTest < ActionController::TestCase
   teardown { ::Fog.unmock! }
 
   test 'should get index' do
-    get :index, { :host_id => host.to_param }
+    get :index, params: { :host_id => host.to_param }
     assert_response :success
     assert_not_nil assigns(:snapshots)
     body = ActiveSupport::JSON.decode(@response.body)
@@ -21,7 +21,7 @@ class Api::V2::SnapshotsControllerTest < ActionController::TestCase
   end
 
   test 'should show snapshot' do
-    get :show, { :host_id => host.to_param, :id => snapshot_id }
+    get :show, params: { :host_id => host.to_param, :id => snapshot_id }
     assert_not_nil assigns(:snapshot)
     assert_response :success
     body = ActiveSupport::JSON.decode(@response.body)
@@ -29,29 +29,29 @@ class Api::V2::SnapshotsControllerTest < ActionController::TestCase
   end
 
   test 'should 404 for unknown snapshot' do
-    get :show, { :host_id => host.to_param, :id => 'does-not-exist' }
+    get :show, params: { :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' }
+    post :create, params: { :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 }
+    put :update, params: { :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 }
+    delete :destroy, params: { :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 }
+    put :revert, params: { :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

@@ -14,7 +14,7 @@ module ForemanSnapshotManagement
 
     context 'GET #index' do
       test 'should get index' do
-        get :index, { :host_id => host.to_param }, set_session_user
+        get :index, params: { :host_id => host.to_param }, session: set_session_user
         assert_response :success
         assert_not_nil assigns(:snapshots)
         assert_template 'foreman_snapshot_management/snapshots/_index'
@@ -23,14 +23,14 @@ module ForemanSnapshotManagement
 
     context 'POST #create' do
       test 'create valid' do
-        post :create, { :host_id => host.to_param, :snapshot => { :name => 'test' } }, set_session_user
+        post :create, params: { :host_id => host.to_param, :snapshot => { :name => 'test' } }, session: 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
+        post :create, params: { :host_id => host.to_param, :snapshot => { :name => nil } }, session: set_session_user
         assert_redirected_to host_url(host, :anchor => 'snapshots')
         assert_includes flash[:error], 'Error occurred while creating Snapshot'
       end
@@ -38,14 +38,14 @@ module ForemanSnapshotManagement
 
     context 'DELETE #destroy' do
       test 'destroy successful' do
-        delete :destroy, { :host_id => host.to_param, :id => snapshot_id }, set_session_user
+        delete :destroy, params: { :host_id => host.to_param, :id => snapshot_id }, session: 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
+        delete :destroy, params: { :host_id => host.to_param, :id => snapshot_id }, session: set_session_user
         assert_redirected_to host_url(host, :anchor => 'snapshots')
         assert_includes flash[:error], 'Error occurred while removing Snapshot'
       end
@@ -53,14 +53,14 @@ module ForemanSnapshotManagement
 
     context 'PUT #revert' do
       test 'revert successful' do
-        put :revert, { :host_id => host.to_param, :id => snapshot_id }, set_session_user
+        put :revert, params: { :host_id => host.to_param, :id => snapshot_id }, session: 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
+        put :revert, params: { :host_id => host.to_param, :id => snapshot_id }, session: set_session_user
         assert_redirected_to host_url(host, :anchor => 'snapshots')
         assert_includes flash[:error], 'Error occurred while rolling back VM'
       end
@@ -69,7 +69,7 @@ module ForemanSnapshotManagement
     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
+        put :update, params: { :host_id => host.to_param, :id => snapshot_id, :snapshot => data }, session: set_session_user
         assert_response :success
         body = ActiveSupport::JSON.decode(@response.body)
         assert_equal(data, body)
@@ -77,7 +77,7 @@ module ForemanSnapshotManagement
 
       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
+        put :update, params: { :host_id => host.to_param, :id => snapshot_id, :snapshot => { :name => 'test 2' } }, session: set_session_user
         assert_response :unprocessable_entity
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_snapshot_management
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - ATIX AG
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-15 00:00:00.000000000 Z
+date: 2018-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface
@@ -25,33 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.49.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.49.1
 description: Foreman-plugin to manage snapshots in a vSphere environment.
 email:
 - info@atix.de
@@ -113,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Snapshot Management for VMware vSphere