foreman_snapshot_management 1.7.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9efa1f527f44cb80179813e24eef241905760743d411098da6627d6ee8975c2
-  data.tar.gz: 569d6387f7a18d74b7f3bdd916de43aefb91d9938618cba15763a9b18e9e08ae
+  metadata.gz: b21ddce3f89248da10faf11e3c9ed617c68b9500be5ef2f0a4557462e670912c
+  data.tar.gz: e345def34460802d4491dded6341ff0089c733cbeb1ce7b925e321f0c8be8caf
 SHA512:
-  metadata.gz: 7b04015470b2427bc450c69c5e008a33250c2decdebc45a52a7a092f221c34a38d1dd184da7938a400491332b97ac393e79e3fb502c2e0ff82de9ea19b1718a7
-  data.tar.gz: 70a2bca8aea94deda793f1434c7935587ea43beb983db1c9a3e583fee84d5bc73f3d61f2eaa44a83bf19e3d02f3725697b6c4dd84a861a582c439814fd37128e
+  metadata.gz: 70868762e401d992c5aeeda419491ccbe294f57c20bd87c4eab30c9bb7299da128f6f50a8ab640fcf83058fd62018c1aecd851ccde34b372656fb72b40e3179e
+  data.tar.gz: 2542bb32f1efb8ba220b8a63342313e73994990336252529a5496dc3f95dd8e5c8e41da322042042b617bb8f46bd213141821d94ea1cbfc19fdbd0c7b3210de1

data/README.md

@@ -1,4 +1,5 @@
-[![Build Status](https://travis-ci.org/ATIX-AG/foreman_snapshot_management.svg?branch=master)](https://travis-ci.org/ATIX-AG/foreman_snapshot_management)
+[![React Testing](https://github.com/ATIX-AG/foreman_snapshot_management/actions/workflows/react.yml/badge.svg)](https://github.com/ATIX-AG/foreman_snapshot_management/actions/workflows/react.yml)
+[![Ruby Testing](https://github.com/ATIX-AG/foreman_snapshot_management/actions/workflows/ruby.yml/badge.svg)](https://github.com/ATIX-AG/foreman_snapshot_management/actions/workflows/ruby.yml)
 
 # ForemanSnapshotManagement
 
@@ -22,6 +23,7 @@ See [How_to_Install_a_Plugin](http://projects.theforeman.org/projects/foreman/wi
 
 | Foreman Version | Plugin Version |
 | --------------- | -------------- |
+| 2.3             | >= 2.0.0       |
 | 1.24            | >= 1.7.0       |
 | 1.23            | >= 1.7.0       |
 | 1.22            | >= 1.6.0       |

data/Rakefile

@@ -14,6 +14,13 @@ rescue LoadError
   RDoc::Task = Rake::RDocTask
 end
 
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue StandardError => _e
+  puts 'Rubocop not loaded.'
+end
+
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'ForemanSnapshotManagement'
@@ -22,6 +29,4 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
-
 Bundler::GemHelper.install_tasks

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

@@ -6,7 +6,7 @@ module Api
       include Api::Version2
       include Foreman::Controller::Parameters::Snapshot
 
-      before_action :find_required_nested_object
+      before_action :find_host
       before_action :check_snapshot_capability
       before_action :find_resource, :only => %w[show update destroy revert]
 
@@ -19,7 +19,7 @@ module Api
           search = params[:search].match(/^\s*name\s*=\s*(\w+)\s*$/) || params[:search].match(/^\s*name\s*=\s*\"([^"]+)\"\s*$/)
           raise "Field '#{params[:search]}' not recognized for searching!" unless search
 
-          snapshot = resource_class.find_for_host_by_name(@nested_obj, search[1])
+          snapshot = resource_class.find_for_host_by_name(@host, search[1])
           @snapshots = if snapshot
                          [snapshot].paginate(paginate_options)
                        else
@@ -49,7 +49,7 @@ module Api
       param_group :snapshot, :as => :create
 
       def create
-        @snapshot = resource_class.new(snapshot_params.to_h.merge(host: @nested_obj).merge(include_ram: params[:include_ram]))
+        @snapshot = resource_class.new(snapshot_params.to_h.merge(host: @host).merge(include_ram: params[:include_ram]))
         process_response @snapshot.create
       end
 
@@ -80,9 +80,25 @@ module Api
 
       private
 
+      # Find Host
+      #
+      # This method is responsible that methods of the controller know the current host.
+      def find_host
+        host_id = params[:host_id]
+        if host_id.blank?
+          not_found
+          return false
+        end
+        @host = Host.authorized("#{action_permission}_snapshots".to_sym, Host).friendly.find(host_id)
+        return @host if @host
+
+        not_found
+        false
+      end
+
       def resource_scope(_options = {})
         # TODO: Ask host for snapshots
-        @resource_scope ||= resource_class.all_for_host(@nested_obj)
+        @resource_scope ||= resource_class.all_for_host(@host)
       end
 
       def resource_scope_for_index
@@ -94,12 +110,12 @@ module Api
       end
 
       def find_resource
-        @snapshot = resource_class.find_for_host(@nested_obj, params[:id])
+        @snapshot = resource_class.find_for_host(@host, params[:id])
         not_found unless @snapshot
       end
 
       def check_snapshot_capability
-        not_found unless @nested_obj.compute_resource&.capabilities&.include?(:snapshots)
+        not_found unless @host.compute_resource&.capabilities&.include?(:snapshots)
       end
 
       def action_permission

data/app/models/foreman_snapshot_management/proxmox_extensions.rb

@@ -12,7 +12,7 @@ module ForemanSnapshotManagement
     # This method creates a Snapshot with a given name and optional description.
     def create_snapshot(host, name, description, _include_ram = false)
       server = find_vm_by_uuid host.uuid
-      raise _('Name must contain at least 2 characters starting with alphabet. Valid characters are A-Z a-z 0-9 _') unless name =~ /^[A-Za-z][\w]{1,}$/
+      raise _('Name must contain at least 2 characters starting with alphabet. Valid characters are A-Z a-z 0-9 _') unless /^[A-Za-z][\w]{1,}$/.match?(name)
 
       snapshot = server.snapshots.create(name: name)
       snapshot.description = description

data/app/models/foreman_snapshot_management/snapshot.rb

@@ -28,6 +28,10 @@ module ForemanSnapshotManagement
                  )
     end
 
+    def self.any?
+      true
+    end
+
     def self.new_for_host(host)
       host.compute_resource.new_snapshot(host)
     end

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

@@ -3,3 +3,5 @@
 object @snapshot
 
 attributes :id, :name
+
+node(:formatted_created_at) { |snapshot| snapshot.create_time&.httpdate }

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

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

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

@@ -1,4 +1,12 @@
 <% if @host.compute_resource && @host.compute_resource.capabilities.include?(:snapshots) && authorized_for(:auth_object => @host, :permission => :view_snapshots) %>
+
+<% content_for(:javascripts) do %>
+  <%= webpacked_plugins_js_for :foreman_snapshot_management %>
+<% end %>
+<% content_for(:stylesheets) do %>
+  <%= webpacked_plugins_css_for :foreman_snapshot_management %>
+<% end %>
+
 <div id='snapshots' class='tab-pane'
   data-ajax-url='<%= host_snapshots_path(host_id: @host)%>'
   data-on-complete='onContentLoad'>

data/lib/foreman_snapshot_management/engine.rb

@@ -10,7 +10,10 @@ module ForemanSnapshotManagement
 
     initializer 'foreman_snapshot_management.register_plugin', before: :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_snapshot_management do
-        requires_foreman '>= 1.17'
+        requires_foreman '>= 2.0.0'
+
+        # Add Global files for extending foreman-core components and routes
+        register_global_js_file 'global'
 
         apipie_documented_controllers ["#{ForemanSnapshotManagement::Engine.root}/app/controllers/api/v2/*.rb"]
 
@@ -83,33 +86,31 @@ module ForemanSnapshotManagement
 
     # Include concerns in this config.to_prepare block
     config.to_prepare do
-      begin
-        # Load Foreman extensions
-        ::HostsHelper.prepend ForemanSnapshotManagement::HostsHelperExtension
+      # Load Foreman extensions
+      ::HostsHelper.prepend ForemanSnapshotManagement::HostsHelperExtension
 
-        begin
-          ::ForemanFogProxmox::Proxmox.prepend ForemanSnapshotManagement::ProxmoxExtensions
+      begin
+        ::ForemanFogProxmox::Proxmox.prepend ForemanSnapshotManagement::ProxmoxExtensions
 
-          # Load Fog extensions
-          Fog::Proxmox::Compute::Mock.prepend FogExtensions::Proxmox::Snapshots::Mock if ForemanFogProxmox::Proxmox.available?
-        rescue StandardError => e
-          Rails.logger.warn "Failed to load Proxmox extension #{e}"
-        end
+        # Load Fog extensions
+        Fog::Proxmox::Compute::Mock.prepend FogExtensions::Proxmox::Snapshots::Mock if ForemanFogProxmox::Proxmox.available?
+      rescue StandardError => e
+        Rails.logger.warn "Failed to load Proxmox extension #{e}"
+      end
 
-        begin
-          ::Foreman::Model::Vmware.prepend ForemanSnapshotManagement::VmwareExtensions
+      begin
+        ::Foreman::Model::Vmware.prepend ForemanSnapshotManagement::VmwareExtensions
 
-          # Load Fog extensions
-          if Foreman::Model::Vmware.available?
-            ForemanSnapshotManagement.fog_vsphere_namespace::Real.prepend FogExtensions::Vsphere::Snapshots::Real
-            ForemanSnapshotManagement.fog_vsphere_namespace::Mock.prepend FogExtensions::Vsphere::Snapshots::Mock
-          end
-        rescue StandardError => e
-          Rails.logger.warn "Failed to load VMware extension #{e}"
+        # Load Fog extensions
+        if Foreman::Model::Vmware.available?
+          ForemanSnapshotManagement.fog_vsphere_namespace::Real.prepend FogExtensions::Vsphere::Snapshots::Real
+          ForemanSnapshotManagement.fog_vsphere_namespace::Mock.prepend FogExtensions::Vsphere::Snapshots::Mock
         end
       rescue StandardError => e
-        Rails.logger.warn "ForemanSnapshotManagement: skipping engine hook (#{e})"
+        Rails.logger.warn "Failed to load VMware extension #{e}"
       end
+    rescue StandardError => e
+      Rails.logger.warn "ForemanSnapshotManagement: skipping engine hook (#{e})"
     end
 
     rake_tasks do

data/lib/foreman_snapshot_management/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ForemanSnapshotManagement
-  VERSION = '1.7.1'
+  VERSION = '2.0.0'
 end

data/lib/tasks/foreman_snapshot_management_tasks.rake

@@ -20,7 +20,7 @@ begin
                    "#{ForemanSnapshotManagement::Engine.root}/test/**/*.rb"]
 
   namespace :foreman_snapshot_management do
-    task :rubocop do
+    task rubocop: :environment do
       RuboCop::RakeTask.new(:rubocop_foreman_snapshot_management) do |task|
         task.patterns = test_patterns
       end
@@ -42,7 +42,7 @@ end
 
 namespace :jenkins do
   desc 'Test ForemanSnapshotManagement with XML output for jenkins'
-  task 'foreman_snapshot_management' do
+  task 'foreman_snapshot_management' => :environment do
     Rake::Task['jenkins:setup:minitest'].invoke
     Rake::Task['rake:test:foreman_snapshot_management'].invoke
   end

data/locale/de/foreman_snapshot_management.po

@@ -5,19 +5,19 @@
 #
 # Translators:
 # Lukáš Zapletal, 2019
-# Ettore Atalan <atalanttore@googlemail.com>, 2019
 # Wiederoder <stefanwiederoder@googlemail.com>, 2019
-# Bryan Kearney <bryan.kearney@gmail.com>, 2019
 # Martin Zimmermann <martin.zimmermann@gmx.com>, 2019
-# Markus Bucher <bucher@atix.de>, 2020
+# Ettore Atalan <atalanttore@googlemail.com>, 2021
+# Bryan Kearney <bryan.kearney@gmail.com>, 2021
+# Markus Bucher <bucher@atix.de>, 2021
 #
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: foreman_snapshot_management 1.7.0\n"
+"Project-Id-Version: foreman_snapshot_management 1.8.1\n"
 "Report-Msgid-Bugs-To: \n"
 "PO-Revision-Date: 2019-10-22 11:54+0000\n"
-"Last-Translator: Markus Bucher <bucher@atix.de>, 2020\n"
+"Last-Translator: Markus Bucher <bucher@atix.de>, 2021\n"
 "Language-Team: German (https://www.transifex.com/foreman/teams/114/de/)\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=UTF-8\n"
@@ -28,30 +28,30 @@ msgstr ""
 msgid "Action"
 msgstr "Aktion"
 
-msgid "Are you sure to delete this Snapshot?"
-msgstr "Wollen Sie diesen Snapshot wirklich löschen?"
-
-msgid "Are you sure to revert this Snapshot?"
-msgstr "Sind Sie sicher, dass Sie diesen Snapshot wiederherstellen wollen?"
-
-msgid "Create"
-msgstr "Erstellen"
+msgid "Action with sub plans"
+msgstr "Aktion mit Unterplänen"
 
 msgid "Create Snapshot"
 msgstr "Snapshot erstellen"
 
+msgid "Create Snapshot for %s"
+msgstr "Snapshot anlegen für %s"
+
 msgid "Create a snapshot"
 msgstr "Einen Snapshot erstellen"
 
 msgid "Created %{snapshots} for %{num} %{hosts}"
 msgstr "%{snapshots} für %{num} %{hosts} erstellt"
 
+msgid "Delete"
+msgstr "Löschen"
+
+msgid "Delete Snapshot \"%s\"?"
+msgstr "\"%s\" wirklich löschen?"
+
 msgid "Delete a snapshot"
 msgstr "Snapshot löschen"
 
-msgid "Deleting..."
-msgstr "Löschen..."
-
 msgid "Description"
 msgstr "Beschreibung"
 
@@ -70,12 +70,24 @@ msgstr "Beim Löschen des Snapshots ist ein Fehler aufgetreten: %s"
 msgid "Error occurred while rolling back VM: %s"
 msgstr "Beim Zurücksetzen der VM ist ein Fehler aufgetreten: %s"
 
+msgid "Error occurred while updating Snapshot: %s"
+msgstr "Fehler beim Aktualisieren des Snapshots: %s"
+
+msgid "Failed to load snapshot list"
+msgstr "Fehler beim Laden der Snapshotliste"
+
 msgid "Failed to update Snapshot: %s"
 msgstr "Das Aktualisieren des Snapshots ist fehlgeschlagen: %s"
 
 msgid "Foreman-plugin to manage snapshots in a virtual-hardware environments."
 msgstr "Ein Foremanplugin, welches Snapshots in Umgebungen mit virtueller Hardware nutzbar macht."
 
+msgid "Import Puppet classes"
+msgstr "Puppet-Klassen importieren"
+
+msgid "Import facts"
+msgstr "Fakten importieren"
+
 msgid "Include RAM"
 msgstr "RAM einbeziehen"
 
@@ -85,6 +97,12 @@ msgstr "Alle Snapshots auflisten"
 msgid "Loading Snapshots information ..."
 msgstr "Lade Snapshot Informationen ..."
 
+msgid "N/A"
+msgstr "N/A"
+
+msgid "Name"
+msgstr "Name"
+
 msgid "Name must contain at least 2 characters starting with alphabet. Valid characters are A-Z a-z 0-9 _"
 msgstr "Der Name muss aus mindestens 2 Zeichen bestehen und mit einem Buchstaben beginnen. Gültige Zeichen: A-Z a-z 0-9 _"
 
@@ -103,12 +121,12 @@ msgstr "Keine Hosts wurden mit dieser Kennung, Name oder Abfrage-Filter gefunden
 msgid "Revert Host to a snapshot"
 msgstr "Host auf einen Snapshot zurücksetzen"
 
-msgid "Reverting..."
-msgstr "Zurücksetzen..."
-
 msgid "Rollback"
 msgstr "Wiederherstellen"
 
+msgid "Rollback to \"%s\"?"
+msgstr "\"%s\" wirklich wiederherstellen?"
+
 msgid "Snapshot"
 msgid_plural "Snapshots"
 msgstr[0] "Snapshot"
@@ -117,12 +135,24 @@ msgstr[1] "Snapshots"
 msgid "Snapshot name cannot be changed"
 msgstr "Der Name des Snapshots kann nicht geändert werden"
 
+msgid "Snapshot successfully created!"
+msgstr "Snapshot erfolgreich erzeugt!"
+
 msgid "Snapshots"
 msgstr "Snapshots"
 
 msgid "Something went wrong while selecting hosts - %s"
 msgstr "Fehler beim Auswählen der Hosts – %s"
 
+msgid "Successfully removed Snapshot \"%s\" from host %s"
+msgstr "Snapshot \"%s\" erfolgreich von Host %s entfernt."
+
+msgid "Successfully rolled back Snapshot \"%s\" on host %s"
+msgstr "Snapshot \"%s\" erfolgreich auf Host %s zurückgesetzt."
+
+msgid "Successfully updated Snapshot \"%s\""
+msgstr "Snapshot \"%s\" erfolgreich aktualisiert."
+
 msgid "Unable to create Proxmox Snapshot"
 msgstr "Proxmox Snapshot konnte nicht erstellt werden"
 
@@ -156,6 +186,9 @@ msgstr "Die VM wurde erfolgreich zurückgesetzt."
 msgid "Whether to include the RAM state in the snapshot"
 msgstr "Ob auch der aktuelle Hauptspeicherstand im Snapshot gespeichert werden soll"
 
+msgid "edit entry"
+msgstr "Eintrag bearbeiten"
+
 msgid "host"
 msgid_plural "hosts"
 msgstr[0] "Host"