foreman_snapshot_management 1.5.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d57bbba1e33d99aefa82a4af43d69810abd02fee0bd56a971083a6d83950bf5f
-  data.tar.gz: f79a6a83310c1b0ee3f05ea2204cded44d690df624773ad642e88a9a323f372a
+  metadata.gz: b21ddce3f89248da10faf11e3c9ed617c68b9500be5ef2f0a4557462e670912c
+  data.tar.gz: e345def34460802d4491dded6341ff0089c733cbeb1ce7b925e321f0c8be8caf
 SHA512:
-  metadata.gz: 40e538d6c79a89036baa265408dbeecd99ce7fcb2c4cb9693e1bc92111001f592e8ea13d003028160b366ce2332702e0c51fedb2c07ec2a6ecbaab99622d5d91
-  data.tar.gz: a1c2345211c2d5eb3a2a6d63c74ca952d74351e014ad0f3b1957afcf6a5ba8dc3d3b9ddac69bd52344eeee235676f732f654d7bebfb46d9b69a655b0c904297f
+  metadata.gz: 70868762e401d992c5aeeda419491ccbe294f57c20bd87c4eab30c9bb7299da128f6f50a8ab640fcf83058fd62018c1aecd851ccde34b372656fb72b40e3179e
+  data.tar.gz: 2542bb32f1efb8ba220b8a63342313e73994990336252529a5496dc3f95dd8e5c8e41da322042042b617bb8f46bd213141821d94ea1cbfc19fdbd0c7b3210de1

data/README.md

@@ -1,9 +1,12 @@
-[![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
 
 ForemanSnapshotManagement is a Foreman plugin to manage snapshots.
-As Hypervisor VMware vSphere is supported.
+As Hypervisor the following systems are supported:
+- VMware vSphere
+- [Proxmox](https://www.proxmox.com/)
 
 ## Features
 
@@ -20,10 +23,205 @@ 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       |
+| 1.21            | >= 1.5.0       |
+| 1.20            | >= 1.5.0       |
 | 1.19            | >= 1.5.0       |
 | 1.18            | >= 1.5.0       |
 | 1.17            | >= 1.5.0       |
 
+## Usage
+
+You will get a new tab named "Snapshots" in the hosts page in Foreman.
+
+Following rights are required to view snapshots:
+
+- Snapshot Viewer
+- Viewer
+
+Following **additional** rights are required for creating, modifying, deleting and rollback:
+
+- Snapshot Manger
+- Site Manager
+
+## API usage examples
+
+Documentation for the api v2 endpoints provided by this Plugin can be found at `https://<your.foreman.installation>/apidoc/v2/snapshots.html`.
+Some examples using `curl` and `jq` are given here.
+
+The api user requires the same rights as a normal one.
+
+### Environment
+
+Environment variables used in this examples, edit to your needs.
+
+```bash
+FOREMAN="foreman.example.lan"            # fqdn or ip to foreman
+AUTH="snapper:mysupersecretpassword123"  # foreman user
+HOST="vm001.example.lan"                 # the servers name or id
+```
+
+### List all snapshots
+
+```bash
+curl -s -u "$AUTH" \
+    -H 'Accept: application/json' \
+    "https://${FOREMAN}/api/v2/hosts/${HOST}/snapshots" \
+    | jq
+```
+
+```json
+{
+  "total": 2,
+  "subtotal": 2,
+  "page": 1,
+  "per_page": 30,
+  "search": null,
+  "sort": {
+    "by": null,
+    "order": null
+  },
+  "results": [
+    {
+      "description": "",
+      "id": "snapshot-646",
+      "name": "clean",
+      "created_at": "2018-10-08 08:07:30 UTC",
+      "parent_id": null,
+      "children_ids": [
+        "snapshot-658"
+      ]
+    },
+    {
+      "description": "test",
+      "id": "snapshot-658",
+      "name": "test",
+      "created_at": "2018-10-18 09:50:03 UTC",
+      "parent_id": null,
+      "children_ids": []
+    }
+  ]
+}
+```
+
+### Show a snapshot
+
+```bash
+curl -s -u "$AUTH" \
+    -H 'Accept: application/json' \
+    "https://${FOREMAN}/api/v2/hosts/${HOST}/snapshots/${SNAP_ID}" \
+    | jq
+```
+
+```json
+{
+  "description": "test",
+  "id": "snapshot-658",
+  "name": "test",
+  "created_at": "2018-10-18 09:50:03 UTC",
+  "parent_id": null,
+  "children_ids": []
+}
+```
+
+### Create a snapshot
+
+```bash
+curl -s -u "$AUTH" \
+    -X POST \
+    -H 'Accept: application/json' \
+    -H 'Content-Type: application/json' \
+    --data "{ \"name\": \"${SNAP_NAME}\", \"description\": \"${DESCRIPTION}\" }" \
+    "https://${FOREMAN}/api/v2/hosts/${HOST}/snapshots" \
+    | jq
+```
+
+```json
+{
+  "description": "A wonderful snapshot.",
+  "id": null,
+  "name": "wonderful",
+  "created_at": null,
+  "parent_id": null,
+  "children_ids": []
+}
+```
+
+### Delete a snashot
+
+```bash
+curl -s -u "$AUTH" \
+    -X DELETE \
+    -H 'Accept: application/json' \
+    -H 'Content-Type: application/json' \
+    "https://${FOREMAN}/api/v2/hosts/${HOST}/snapshots/${SNAP_ID}" \
+    | jq
+```
+
+```json
+{
+  "description": "A wonderful snapshot.",
+  "id": null,
+  "name": "wonderful",
+  "created_at": "2018-10-19 07:03:37 UTC",
+  "parent_id": null,
+  "children_ids": []
+}
+```
+
+### Update a snapshot
+
+This updates only name and description, not the data.
+
+```bash
+curl -s -u "$AUTH" \
+    -X PUT \
+    -H 'Accept: application/json' \
+    -H 'Content-Type: application/json' \
+    --data "{ \"name\": \"${SNAP_NAME}\", \"description\": \"${DESCRIPTION}\" }" \
+    "https://${FOREMAN}/api/v2/hosts/${HOST}/snapshots/${SNAP_ID}" \
+    | jq
+```
+
+```json
+{
+  "description": "An exceptional snapshot.",
+  "id": "snapshot-666",
+  "name": "exceptional",
+  "created_at": "2018-10-19 07:11:24 UTC",
+  "parent_id": null,
+  "children_ids": []
+}
+```
+
+### Revert a snapshot
+
+This request will block until the snapshot is reverted. Make sure to check your timeouts.
+
+```bash
+curl -s -u "$AUTH" \
+    --max-time 600 \
+    -X PUT \
+    -H 'Content-Type: application/json' \
+    -H 'Accept: application/json' \
+    "https://${FOREMAN}/api/v2/hosts/${HOST}/snapshots/${SNAP_ID}/revert" \
+    | jq
+```
+
+```json
+{
+  "description": "test",
+  "id": "snapshot-658",
+  "name": "test",
+  "created_at": "2018-10-18 09:50:03 UTC",
+  "parent_id": null,
+  "children_ids": []
+}
+```
+
 ## Contributing
 
 Fork and send a Pull Request. Thanks!

data/Rakefile

@@ -1,4 +1,6 @@
 #!/usr/bin/env rake
+# frozen_string_literal: true
+
 begin
   require 'bundler/setup'
 rescue LoadError
@@ -12,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'
@@ -20,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

@@ -1,17 +1,33 @@
+# frozen_string_literal: true
+
 module Api
   module V2
     class SnapshotsController < V2::BaseController
       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]
 
       api :GET, '/hosts/:host_id/snapshots', N_('List all snapshots')
       param :host_id, :identifier_dottable, :required => true
+      param_group :search_and_pagination, ::Api::V2::BaseController
+      meta :search => [{ :name => 'name', :type => 'string' }]
       def index
-        @snapshots = resource_scope_for_index
+        if params[:search]
+          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(@host, search[1])
+          @snapshots = if snapshot
+                         [snapshot].paginate(paginate_options)
+                       else
+                         []
+                       end
+        else
+          @snapshots = resource_scope_for_index
+        end
       end
 
       api :GET, '/hosts/:host_id/snapshots/:id', 'Show a snapshot'
@@ -33,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
 
@@ -43,7 +59,7 @@ module Api
       param_group :snapshot
 
       def update
-        process_response @snapshot.update_attributes(snapshot_params)
+        process_response @snapshot.update(snapshot_params)
       end
 
       api :DELETE, '/hosts/:host_id/snapshots/:id', N_('Delete a snapshot')
@@ -64,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
@@ -78,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 && @nested_obj.compute_resource.capabilities.include?(:snapshots)
+        not_found unless @host.compute_resource&.capabilities&.include?(:snapshots)
       end
 
       def action_permission

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Foreman::Controller::Parameters::Snapshot
   extend ActiveSupport::Concern
 

data/app/controllers/foreman_snapshot_management/snapshots_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanSnapshotManagement
   class SnapshotsController < ApplicationController
     include Foreman::Controller::ActionPermissionDsl
@@ -64,7 +66,7 @@ module ForemanSnapshotManagement
     #
     # This method renames a Snapshot from a given host.
     def update
-      if @snapshot.update_attributes(snapshot_params)
+      if @snapshot.update(snapshot_params)
         render json: { name: @snapshot.name, description: @snapshot.description }
       else
         msg = _('Failed to update Snapshot: %s') % @snapshot.errors.full_messages.to_sentence
@@ -87,8 +89,8 @@ module ForemanSnapshotManagement
           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
+      error _('Error occurred while creating Snapshot for:%s') % "<br /><dl>#{errors.map { |e| "<dt>#{e[0]}</dt><dd>#{e[1]}</dd>" }.join('<br />')}</dl>" unless errors.empty?
+      if snapshots_created.positive?
         msg = _('Created %{snapshots} for %{num} %{hosts}') % {
           snapshots: n_('Snapshot', 'Snapshots', snapshots_created),
           num: snapshots_created,
@@ -122,6 +124,7 @@ module ForemanSnapshotManagement
       end
       @host = Host.authorized("#{action_permission}_snapshots".to_sym, Host).friendly.find(host_id)
       return @host if @host
+
       not_found
       false
     end
@@ -140,10 +143,10 @@ module ForemanSnapshotManagement
       end
 
       @hosts
-    rescue StandardError => error
-      message = _('Something went wrong while selecting hosts - %s') % error
+    rescue StandardError => e
+      message = _('Something went wrong while selecting hosts - %s') % e
       error(message)
-      Foreman::Logging.exception(message, error)
+      Foreman::Logging.exception(message, e)
       redirect_to hosts_path
       false
     end
@@ -168,7 +171,7 @@ module ForemanSnapshotManagement
     end
 
     def check_snapshot_capability
-      not_found unless @host.compute_resource && @host.compute_resource.capabilities.include?(:snapshots)
+      not_found unless @host.compute_resource&.capabilities&.include?(:snapshots)
     end
 
     def enumerate_snapshots

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanSnapshotManagement
   module HostsHelperExtension
     def multiple_actions

data/app/helpers/foreman_snapshot_management/snapshot_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanSnapshotManagement
   module SnapshotHelper
     def foreman_snapshot_management_snapshot_path(snapshot)

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module FogExtensions
+  module Proxmox
+    module Snapshots
+      module Mock
+        def status_task(_node, _upid)
+          {
+            'type' => 'qmsnapshot',
+            'starttime' => 1_580_720_848,
+            'pstart' => 1_864_464_143,
+            'node' => 'proxmox',
+            'upid' => 'UPID:proxmox:00003E13:6F21770F:5E37E2D0:qmsnapshot:100:root@pam:',
+            'user' => 'root@pam',
+            'exitstatus' => 'OK',
+            'status' => 'stopped',
+            'id' => '100',
+            'pid' => 15_891
+          }
+        end
+      end
+    end
+  end
+end