foreman_snapshot_management 1.6.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7fe9653d419d1bbb857d758ce0bf7edb2f34a60344995ccc4ce420b9bc37c4f
-  data.tar.gz: 12b830b6f2a268d0d0a95a522dba69c5ca2a2583bb04803184249e997f479242
+  metadata.gz: f1f7ac4fa53eca310f5b7effafa4fca21cfdf0ce1f97981892165dfa9ebc1f19
+  data.tar.gz: 1440f1529c9d5c02428dac9371f1d02faca2ea6c95064e51c4efa900bed5126a
 SHA512:
-  metadata.gz: 3926abe02b802ebafd9753441760f49b4ded0c1f10fdd4c56749830d7b25598756742bdc53956ed61e43e935c79b23c5c6fef06a4226a33f216bf1af9e793a53
-  data.tar.gz: 1d8935a1c0678ac93cba42099524b2fcb25482840fb4d1c2b6ea45623216086e279d7cef73aeeb80e3b452f06edfa99625c5dae4012ad9c61b80f0dfbc138f7f
+  metadata.gz: 41df800a5a9d08c2dac58f5bc1319840dbdaa39ee1e4cf79ef71677645cc9d64cee3de0cf310d49e0d16ba9fc41a820ae42bf31f848398d040610b42ecd88649
+  data.tar.gz: ca5116f54a696fbe6062d05369747a02898a283276252ae118884b075ac01fe05a3864cbf583f2cfcf6b57801283e278ac4c0949f9bf0c5ae918262cf6a7468f

data/Rakefile

@@ -1,4 +1,6 @@
 #!/usr/bin/env rake
+# frozen_string_literal: true
+
 begin
   require 'bundler/setup'
 rescue LoadError

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Api
   module V2
     class SnapshotsController < V2::BaseController
@@ -83,7 +85,7 @@ module Api
       end
 
       def check_snapshot_capability
-        not_found unless @nested_obj.compute_resource && @nested_obj.compute_resource.capabilities.include?(:snapshots)
+        not_found unless @nested_obj.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
@@ -88,7 +90,7 @@ module ForemanSnapshotManagement
         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
+      if snapshots_created.positive?
         msg = _('Created %{snapshots} for %{num} %{hosts}') % {
           snapshots: n_('Snapshot', 'Snapshots', snapshots_created),
           num: snapshots_created,
@@ -169,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/vsphere/snapshots/mock.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FogExtensions
   module Vsphere
     module Snapshots

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FogExtensions
   module Vsphere
     module Snapshots

data/app/models/foreman_snapshot_management/snapshot.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'date'
 
 module ForemanSnapshotManagement

data/app/models/foreman_snapshot_management/vmware_extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanSnapshotManagement
   module VmwareExtensions
     # Extend VMWare's capabilities with snapshots.

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 object @snapshot
 
 attributes :id, :name

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 object @snapshot
 
 extends 'api/v2/snapshots/show'

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 object @snapshot
 
 extends 'api/v2/snapshots/show'

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 collection @snapshots
 
 extends 'api/v2/snapshots/main'

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 object @snapshot
 
 extends 'api/v2/snapshots/base'

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 object @snapshot
 
 extends 'api/v2/snapshots/show'

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 object @snapshot
 
 extends 'api/v2/snapshots/main'

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 object @snapshot
 
 extends 'api/v2/snapshots/show'

data/config/routes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Rails.application.routes.draw do
   namespace :api, :defaults => { :format => 'json' } do
     scope '(:apiv)', :module => :v2,

data/lib/foreman_snapshot_management.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'foreman_snapshot_management/engine'
 
 module ForemanSnapshotManagement

data/lib/foreman_snapshot_management/engine.rb

@@ -1,4 +1,4 @@
-require 'deface'
+# frozen_string_literal: true
 
 module ForemanSnapshotManagement
   class Engine < ::Rails::Engine
@@ -51,6 +51,13 @@ module ForemanSnapshotManagement
           :destroy_snapshots,
           :revert_snapshots
         ]
+
+        extend_page('hosts/show') do |context|
+          context.add_pagelet :main_tabs,
+                              :name => N_('Snapshots'),
+                              :partial => 'hosts/snapshots_tab',
+                              :onlyif => proc { |host| host&.compute_resource&.capable?(:snapshots) }
+        end
       end
     end
 

data/lib/foreman_snapshot_management/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanSnapshotManagement
-  VERSION = '1.6.0'.freeze
+  VERSION = '1.6.1'
 end

data/lib/tasks/foreman_snapshot_management_tasks.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Tests
 namespace :test do
   desc 'Test ForemanSnapshotManagement'
@@ -10,20 +12,39 @@ namespace :test do
   end
 end
 
-namespace :foreman_snapshot_management do
-  task :rubocop do
-    begin
-      require 'rubocop/rake_task'
+begin
+  require 'rubocop/rake_task'
+
+  test_patterns = ["#{ForemanSnapshotManagement::Engine.root}/app/**/*.rb",
+                   "#{ForemanSnapshotManagement::Engine.root}/lib/**/*.rb",
+                   "#{ForemanSnapshotManagement::Engine.root}/test/**/*.rb"]
+
+  namespace :foreman_snapshot_management do
+    task :rubocop do
       RuboCop::RakeTask.new(:rubocop_foreman_snapshot_management) do |task|
-        task.patterns = ["#{ForemanSnapshotManagement::Engine.root}/app/**/*.rb",
-                         "#{ForemanSnapshotManagement::Engine.root}/lib/**/*.rb",
-                         "#{ForemanSnapshotManagement::Engine.root}/test/**/*.rb"]
+        task.patterns = test_patterns
       end
-    rescue StandardError
-      puts 'Rubocop not loaded.'
+
+      Rake::Task['rubocop_foreman_snapshot_management'].invoke
     end
 
-    Rake::Task['rubocop_foreman_snapshot_management'].invoke
+    desc 'Runs Rubocop style checker with xml output for Jenkins'
+    RuboCop::RakeTask.new('rubocop:jenkins') do |task|
+      task.patterns = test_patterns
+      task.requires = ['rubocop/formatter/checkstyle_formatter']
+      task.formatters = ['RuboCop::Formatter::CheckstyleFormatter']
+      task.options = ['--no-color', '--out', 'rubocop.xml']
+    end
+  end
+rescue LoadError
+  puts 'Rubocop not loaded.'
+end
+
+namespace :jenkins do
+  desc 'Test ForemanSnapshotManagement with XML output for jenkins'
+  task 'foreman_snapshot_management' do
+    Rake::Task['jenkins:setup:minitest'].invoke
+    Rake::Task['rake:test:foreman_snapshot_management'].invoke
   end
 end
 

data/locale/gemspec.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 # Matches foreman_snapshot_management.gemspec
 _('Foreman-plugin to manage snapshots in a vSphere environment.')

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class Api::V2::SnapshotsControllerTest < ActionController::TestCase

data/test/controllers/foreman_snapshot_management/snapshots_controller_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 module ForemanSnapshotManagement

data/test/test_plugin_helper.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 # This calls the main test_helper in Foreman-core
 require 'test_helper'

metadata

@@ -1,57 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: foreman_snapshot_management
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.6.1
 platform: ruby
 authors:
 - ATIX AG
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-11 00:00:00.000000000 Z
+date: 2019-09-17 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: deface
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: 0.54.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: 0.54.0
 description: Foreman-plugin to manage snapshots in a vSphere environment.
 email:
 - info@atix.de
@@ -69,10 +55,8 @@ files:
 - 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
-- app/models/foreman_snapshot_management/proxmox_extensions.rb
 - app/models/foreman_snapshot_management/snapshot.rb
 - app/models/foreman_snapshot_management/vmware_extensions.rb
-- app/overrides/hosts/add_tab_to_host_overview.rb
 - app/views/api/v2/snapshots/base.json.rabl
 - app/views/api/v2/snapshots/create.json.rabl
 - app/views/api/v2/snapshots/destroy.json.rabl
@@ -81,10 +65,9 @@ files:
 - app/views/api/v2/snapshots/revert.json.rabl
 - app/views/api/v2/snapshots/show.json.rabl
 - app/views/api/v2/snapshots/update.json.rabl
-- 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
+- app/views/hosts/_snapshots_tab.html.erb
 - config/routes.rb
 - lib/foreman_snapshot_management.rb
 - lib/foreman_snapshot_management/engine.rb

data/app/models/foreman_snapshot_management/proxmox_extensions.rb

@@ -1,75 +0,0 @@
-module ForemanSnapshotManagement
-  module ProxmoxExtensions
-    # Extend Proxmox's capabilities with snapshots.
-    def capabilities
-      super + [:snapshots]
-    end
-
-    # Create a Snapshot.
-    #
-    # This method creates a Snapshot with a given name and optional description.
-    def create_snapshot(uuid, name, description, include_ram = false)
-      server = node.servers.get uuid
-      snapshot = server.snapshots.create name
-      snapshot.description = description
-      snapshot.update
-    end
-
-    # Remove Snapshot
-    #
-    # This method removes a Snapshot from a given host.
-    def remove_snapshot(snapshot, remove_children)
-      task = client.remove_snapshot('snapshot' => snapshot, 'removeChildren' => remove_children)
-      task_successful?(task)
-    rescue RbVmomi::Fault => e
-      Foreman::Logging.exception('Error removing VMWare Snapshot', e)
-      raise ::Foreman::WrappedException.new(e, N_('Unable to remove VMWare Snapshot'))
-    end
-
-    # Revert Snapshot
-    #
-    # This method revert a host to a given Snapshot.
-    def revert_snapshot(snapshot)
-      task = client.revert_to_snapshot(snapshot)
-      task_successful?(task)
-    rescue RbVmomi::Fault => e
-      Foreman::Logging.exception('Error reverting VMWare Snapshot', e)
-      raise ::Foreman::WrappedException.new(e, N_('Unable to revert VMWare 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)
-      true
-    rescue RbVmomi::Fault => e
-      Foreman::Logging.exception('Error updating VMWare Snapshot', e)
-      raise ::Foreman::WrappedException.new(e, N_('Unable to update VMWare Snapshot'))
-    end
-
-    # Get Snapshot
-    #
-    # This methods returns a specific Snapshot for a given host.
-    def get_snapshot(server_id, snapshot_id)
-      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
-      snapshot = snapshot.get_child(snapshot_id) while snapshot && snapshot.ref != snapshot_id
-      snapshot
-    end
-
-    # Get Snapshots
-    #
-    # This methods returns Snapshots from a given host.
-    def get_snapshots(server_id)
-      client.snapshots(server_id: server_id).all(recursive: true)
-    end
-
-    private
-
-    def task_successful?(task)
-      task['task_state'] == 'success' || task['state'] == 'success'
-    end
-  end
-end

data/app/overrides/hosts/add_tab_to_host_overview.rb

@@ -1,11 +0,0 @@
-# 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',
-                     partial: 'foreman_snapshot_management/hosts/snapshots_tab')
-
-# Load content of Snapshots tab
-Deface::Override.new(virtual_path: 'hosts/show',
-                     name: 'add_host_snapshots_tab_content',
-                     insert_bottom: 'div#myTabContent',
-                     partial: 'foreman_snapshot_management/hosts/snapshots_tab_content')

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

@@ -1,3 +0,0 @@
-<% if @host.compute_resource && @host.compute_resource.capabilities.include?(:snapshots) && authorized_for(:auth_object => @host, :permission => :view_snapshots) %>
-  <li><a href='#snapshots' data-toggle='tab'><%= _('Snapshots') %></a></li>
-<% end %>