foreman_snapshot_management 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7507324502c4b729cde6774cf001a3783ac85729317a579c7b9bd94f5f21fefd
-  data.tar.gz: 8a4c85f4afb3d6ef0e27c204a9dcd72b6d297c7f775bc1f00f36f30b49c77f75
+  metadata.gz: 398453ebe0f63f659d1431bc72ffb86f7f911d2d34798ee705e31ecb6d9a6258
+  data.tar.gz: 1b87ef1a4f9b1ee6801a6e92374bafdbbe5e186bbe7631c0eb77a0eefec00863
 SHA512:
-  metadata.gz: 9e3dc6c2ef546c2ebf8c0945dade24a16cdc27fb0fc8bdd7e73b42e2e4c66869bf1c9769511ea3b53796cbb039f1b975aba40d755447886fa8bbbd0a73251e9d
-  data.tar.gz: a325a2bc81c54066b4579a50a4622b944bda27c9aedc42c19f7894c6ad90196aa93581dc2b12d5f639b052d8496ca3efac2d1c9013701caba6a3fa79d364d13a
+  metadata.gz: 99977335ef42eec7289476e3571206d3542551d22731e2e72dff9027d6aff81aaffb665e692a83cd3674ae422670322b90577531202772e29f305af8914e2c8a
+  data.tar.gz: fb935d293dd020528086ec7b55d6226ee8a401b08d0dd94ee73268a00e032200fc48e94f074d13cfed38baed97f516137320beeb20135d4b66d097026d666809

data/README.md

@@ -16,6 +16,16 @@ As Hypervisor VMware vSphere is supported.
 
 See [How_to_Install_a_Plugin](http://projects.theforeman.org/projects/foreman/wiki/How_to_Install_a_Plugin) for how to install Foreman plugins
 
+## Compatibility
+
+| Foreman Version | Plugin Version |
+| --------------- | -------------- |
+| 1.17            | >= 1.5.0       |
+
+## Contributing
+
+Fork and send a Pull Request. Thanks!
+
 ## Copyright
 Copyright (c) 2017 ATIX AG - http://www.atix.de
 

data/Rakefile

@@ -20,28 +20,6 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
 
 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 StandardError => _
-  puts 'Rubocop not loaded.'
-end
-
-task :default do
-  Rake::Task['rubocop'].execute
-end

data/app/controllers/foreman_snapshot_management/snapshots_controller.rb

@@ -1,9 +1,14 @@
 module ForemanSnapshotManagement
   class SnapshotsController < ApplicationController
+    include Foreman::Controller::ActionPermissionDsl
     include ::Foreman::Controller::Parameters::Snapshot
 
-    before_action :find_host
-    before_action :check_snapshot_capability
+    MULTIPLE_ACTIONS = %w[select_multiple_host create_multiple_host].freeze
+
+    before_action :find_hosts, only: MULTIPLE_ACTIONS
+    before_action :find_host, except: MULTIPLE_ACTIONS
+    before_action :check_snapshot_capability, except: MULTIPLE_ACTIONS
+    before_action :check_multiple_snapshot_capability, only: MULTIPLE_ACTIONS
     before_action :enumerate_snapshots, only: [:index]
     before_action :find_snapshot, only: %i[destroy revert update]
     helper_method :xeditable?
@@ -67,8 +72,44 @@ module ForemanSnapshotManagement
       end
     end
 
+    define_action_permission ['select_multiple_host', 'create_multiple_host'], :create
+    def select_multiple_host; end
+
+    def create_multiple_host
+      data = snapshot_params
+      snapshots_created = 0
+      errors = []
+      @hosts.each do |h|
+        s = Snapshot.new(data.merge(host: h))
+        if s.create
+          snapshots_created += 1
+        else
+          errors << [h.name, s.errors.full_messages.to_sentence]
+        end
+      end
+      error _('Error occurred while creating Snapshot for<br /><dl>%s</dl>') % errors.map { |e| "<dt>#{e[0]}</dt><dd>#{e[1]}</dd>" }.join('<br />') unless errors.empty?
+      if snapshots_created > 0
+        msg = _('Created %{snapshots} for %{num} %{hosts}') % {
+          snapshots: n_('Snapshot', 'Snapshots', snapshots_created),
+          num: snapshots_created,
+          hosts: n_('host', 'hosts', snapshots_created)
+        }
+        # for backwards compatibility
+        if respond_to? :success
+          success msg
+        else
+          notice msg
+        end
+      end
+      redirect_back_or_to hosts_path
+    end
+
     private
 
+    def snapshot_params
+      params.require(:snapshot).permit(:name, :description, :include_ram)
+    end
+
     # Find Host
     #
     # This method is responsible that methods of the controller know the current host.
@@ -85,6 +126,28 @@ module ForemanSnapshotManagement
       false
     end
 
+    def find_hosts
+      resource_base = Host.authorized("#{action_permission}_snapshots".to_sym, Host).friendly
+
+      # Lets search by name or id and make sure one of them exists first
+      @hosts = resource_base.search_for(params[:search]) if params.key?(:search)
+      @hosts ||= resource_base.where('hosts.id IN (?) or hosts.name IN (?)', params[:host_ids], params[:host_names]) if params.key?(:host_names) || params.key?(:host_ids)
+
+      if @hosts.empty?
+        error _('No hosts were found with that id, name or query filter')
+        redirect_to(hosts_path)
+        return false
+      end
+
+      @hosts
+    rescue StandardError => error
+      message = _('Something went wrong while selecting hosts - %s') % error
+      error(message)
+      Foreman::Logging.exception(message, error)
+      redirect_to hosts_path
+      false
+    end
+
     def action_permission
       case params[:action]
       when 'revert'
@@ -94,6 +157,16 @@ module ForemanSnapshotManagement
       end
     end
 
+    def check_multiple_snapshot_capability
+      capable_hosts = @hosts.select { |h| h.capabilities.include?(:snapshots) }
+      if capable_hosts.empty?
+        warning _('No capable hosts found.')
+        @hosts = Host.where('false')
+      else
+        @hosts = Host.where('hosts.id IN (?)', capable_hosts.map(&:id))
+      end
+    end
+
     def check_snapshot_capability
       not_found unless @host.compute_resource && @host.compute_resource.capabilities.include?(:snapshots)
     end

data/app/helpers/concerns/foreman_snapshot_management/hosts_helper_extension.rb

@@ -0,0 +1,7 @@
+module ForemanSnapshotManagement
+  module HostsHelperExtension
+    def multiple_actions
+      super + [[_('Create Snapshot'), select_multiple_host_snapshots_path]]
+    end
+  end
+end

data/app/models/foreman_snapshot_management/snapshot.rb

@@ -162,6 +162,9 @@ module ForemanSnapshotManagement
     rescue Foreman::WrappedException => e
       errors.add(:base, e.wrapped_exception.message)
       false
+    rescue ActiveRecord::RecordInvalid => e
+      errors.add(:base, e.message)
+      false
     end
   end
 end

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

@@ -0,0 +1,17 @@
+<%= render 'hosts/selected_hosts', :hosts => @hosts %>
+
+<% if @hosts.empty? %>
+  <%= _('No capable hosts selected') %>
+<% else %>
+  <%= form_for :snapshot, :url => create_multiple_host_snapshots_path(:host_ids => @hosts.map{ | h| h.id}) do |f| %>
+    <%= text_f f, :name,
+      { :label => _("Snapshot")}
+    %>
+    <%= textarea_f f, :description,
+      { :label => _("Description")}
+    %>
+    <%= checkbox_f f, :include_ram,
+      { :label => _("Include RAM")}
+    %>
+  <% end %>
+<% end %>

data/config/routes.rb

@@ -25,4 +25,10 @@ Rails.application.routes.draw do
       end
     end
   end
+  resources :snapshots, module: 'foreman_snapshot_management', only: [] do
+    collection do
+      post :select_multiple_host
+      post :create_multiple_host
+    end
+  end
 end

data/lib/foreman_snapshot_management/engine.rb

@@ -6,10 +6,11 @@ module ForemanSnapshotManagement
 
     config.autoload_paths += Dir["#{config.root}/app/models/concerns"]
     config.autoload_paths += Dir["#{config.root}/app/controllers/concerns"]
+    config.autoload_paths += Dir["#{config.root}/app/helpers/concerns"]
 
     initializer 'foreman_snapshot_management.register_plugin', before: :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_snapshot_management do
-        requires_foreman '>= 1.14'
+        requires_foreman '>= 1.17'
 
         apipie_documented_controllers ["#{ForemanSnapshotManagement::Engine.root}/app/controllers/api/v2/*.rb"]
 
@@ -74,6 +75,7 @@ module ForemanSnapshotManagement
       begin
         # Load Foreman extensions
         ::Foreman::Model::Vmware.send(:prepend, ForemanSnapshotManagement::VmwareExtensions)
+        ::HostsHelper.send(:prepend, ForemanSnapshotManagement::HostsHelperExtension)
 
         # Load Fog extensions
         if Foreman::Model::Vmware.available?
@@ -92,7 +94,7 @@ module ForemanSnapshotManagement
     end
 
     initializer 'foreman_snapshot_management.register_gettext', after: :load_config_initializers do |_app|
-      locale_dir = File.join(File.expand_path('../../..', __FILE__), 'locale')
+      locale_dir = File.join(File.expand_path('../..', __dir__), 'locale')
       locale_domain = 'foreman_snapshot_management'
       Foreman::Gettext::Support.add_text_domain locale_domain, locale_dir
     end

data/lib/foreman_snapshot_management/version.rb

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

data/test/controllers/foreman_snapshot_management/snapshots_controller_test.rb

@@ -7,7 +7,9 @@ module ForemanSnapshotManagement
       ComputeResource.find_by_id(cr.id)
     end
     let(:uuid) { '5032c8a5-9c5e-ba7a-3804-832a03e16381' }
+    let(:uuid2) { 'a7169e20-74d3-4367-afc2-d355716e7555' }
     let(:host) { FactoryBot.create(:host, :managed, :compute_resource => compute_resource, :uuid => uuid) }
+    let(:host2) { FactoryBot.create(:host, :managed, :compute_resource => compute_resource, :uuid => uuid2) }
     let(:snapshot_id) { 'snapshot-0101' }
     setup { ::Fog.mock! }
     teardown { ::Fog.unmock! }
@@ -25,7 +27,13 @@ module ForemanSnapshotManagement
       test 'create valid' do
         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.'
+        assert_includes flash[:notice] || flash[:success], 'Successfully created Snapshot.'
+      end
+
+      test 'create valid multiple' do
+        post :create_multiple_host, params: { :host_ids => [host.id, host2.id], :snapshot => { :name => 'test' } }, session: set_session_user
+        assert_redirected_to hosts_url
+        assert_includes flash[:notice] || flash[:success], 'Created Snapshots for 2 hosts'
       end
 
       test 'create invalid' do
@@ -34,13 +42,20 @@ module ForemanSnapshotManagement
         assert_redirected_to host_url(host, :anchor => 'snapshots')
         assert_includes flash[:error], 'Error occurred while creating Snapshot'
       end
+
+      test 'create invalid multiple' do
+        ForemanSnapshotManagement::Snapshot.any_instance.stubs(:create).returns(false)
+        post :create_multiple_host, params: { :host_ids => [host.id, host2.id], :snapshot => { :name => nil } }, session: set_session_user
+        assert_redirected_to hosts_url
+        assert_match(/^Error occurred while creating Snapshot for/, flash[:error])
+      end
     end
 
     context 'DELETE #destroy' do
       test 'destroy successful' do
         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.'
+        assert_includes flash[:notice] || flash[:success], 'Successfully deleted Snapshot.'
       end
 
       test 'destroy with error' do
@@ -55,7 +70,7 @@ module ForemanSnapshotManagement
       test 'revert successful' do
         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.'
+        assert_includes flash[:notice] || flash[:success], 'VM successfully rolled back.'
       end
 
       test 'revert with error' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_snapshot_management
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - ATIX AG
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-19 00:00:00.000000000 Z
+date: 2018-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface
@@ -65,6 +65,7 @@ files:
 - 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/concerns/foreman_snapshot_management/hosts_helper_extension.rb
 - app/helpers/foreman_snapshot_management/snapshot_helper.rb
 - app/models/concerns/fog_extensions/vsphere/snapshots/mock.rb
 - app/models/concerns/fog_extensions/vsphere/snapshots/real.rb
@@ -82,6 +83,7 @@ files:
 - 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
+- app/views/foreman_snapshot_management/snapshots/select_multiple_host.html.erb
 - config/routes.rb
 - lib/foreman_snapshot_management.rb
 - lib/foreman_snapshot_management/engine.rb