foreman_snapshot_management 1.5.1 → 2.0.0

data/test/controllers/foreman_snapshot_management/snapshots_controller_test.rb

@@ -1,37 +1,61 @@
-require 'test_helper'
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
 
 module ForemanSnapshotManagement
   class SnapshotsControllerTest < ActionController::TestCase
-    let(:tax_location) { Location.find_by_name('Location 1') }
-    let(:tax_organization) { Organization.find_by_name('Organization 1') }
+    let(:tax_location) { Location.find_by(name: 'Location 1') }
+    let(:tax_organization) { Organization.find_by(name: 'Organization 1') }
     let(:compute_resource) do
       cr = FactoryBot.create(:compute_resource, :vmware, :uuid => 'Solutions', :locations => [tax_location], organizations: [tax_organization])
-      ComputeResource.find_by_id(cr.id)
+      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' }
+    let(:proxmox_compute_resource) do
+      FactoryBot.create(:proxmox_cr)
+      ComputeResource.find_by(type: 'ForemanFogProxmox::Proxmox')
+    end
+    let(:vmid) { '1_100' }
+    let(:proxmox_host) { FactoryBot.create(:host, :managed, :compute_resource => proxmox_compute_resource, :uuid => vmid) }
+    let(:proxmox_snapshot) { 'snapshot1' }
     setup { ::Fog.mock! }
     teardown { ::Fog.unmock! }
 
     context 'GET #index' do
-      test 'should get index' do
+      test 'should get VMware snapshot index' do
         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'
       end
+
+      test 'should get Proxmox index' do
+        Host::Managed.any_instance.stubs(:vm_exists?).returns(false)
+        get :index, params: { :host_id => proxmox_host.to_param }, session: set_session_user
+        assert_response :success
+        assert_not_nil assigns(:snapshots)
+        assert_template 'foreman_snapshot_management/snapshots/_index'
+      end
     end
 
     context 'POST #create' do
-      test 'create valid' do
+      test 'create valid VMware snapshot' 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] || flash[:success], 'Successfully created Snapshot.'
       end
 
+      test 'create valid proxmox snapshot' do
+        Host::Managed.any_instance.stubs(:vm_exists?).returns(false)
+        post :create, params: { :host_id => proxmox_host.to_param, :snapshot => { :name => 'test' } }, session: set_session_user
+        assert_redirected_to host_url(proxmox_host, :anchor => 'snapshots')
+        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
@@ -60,6 +84,13 @@ module ForemanSnapshotManagement
         assert_includes flash[:notice] || flash[:success], 'Successfully deleted Snapshot.'
       end
 
+      test 'destroy successful' do
+        Host::Managed.any_instance.stubs(:vm_exists?).returns(false)
+        delete :destroy, params: { :host_id => proxmox_host.to_param, :id => proxmox_snapshot }, session: set_session_user
+        assert_redirected_to host_url(proxmox_host, :anchor => 'snapshots')
+        assert_includes flash[:notice] || flash[:success], 'Successfully deleted Snapshot.'
+      end
+
       test 'destroy with error' do
         ForemanSnapshotManagement::Snapshot.any_instance.stubs(:destroy).returns(false)
         delete :destroy, params: { :host_id => host.to_param, :id => snapshot_id }, session: set_session_user
@@ -69,12 +100,19 @@ module ForemanSnapshotManagement
     end
 
     context 'PUT #revert' do
-      test 'revert successful' do
+      test 'revert successful VMware' 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] || flash[:success], 'VM successfully rolled back.'
       end
 
+      test 'revert successful proxmox snapshot' do
+        Host::Managed.any_instance.stubs(:vm_exists?).returns(false)
+        put :revert, params: { :host_id => proxmox_host.to_param, :id => proxmox_snapshot }, session: set_session_user
+        assert_redirected_to host_url(proxmox_host, :anchor => 'snapshots')
+        assert_includes flash[:notice] || flash[:success], 'VM successfully rolled back.'
+      end
+
       test 'revert with error' do
         ForemanSnapshotManagement::Snapshot.any_instance.stubs(:revert).returns(false)
         put :revert, params: { :host_id => host.to_param, :id => snapshot_id }, session: set_session_user
@@ -84,7 +122,7 @@ module ForemanSnapshotManagement
     end
 
     context 'PUT #update' do
-      test 'update successful' do
+      test 'update successful VMware snapsoht' do
         data = { 'name' => 'test 2', 'description' => '' }
         put :update, params: { :host_id => host.to_param, :id => snapshot_id, :snapshot => data }, session: set_session_user
         assert_response :success
@@ -92,11 +130,27 @@ module ForemanSnapshotManagement
         assert_equal(data, body)
       end
 
-      test 'update with error' do
+      test 'update successful proxmox' do
+        Host::Managed.any_instance.stubs(:vm_exists?).returns(false)
+        data = { 'name' => 'snapshot1', 'description' => 'updated snapshot1' }
+        put :update, params: { :host_id => proxmox_host.to_param, :id => proxmox_snapshot, :snapshot => data }, session: set_session_user
+        assert_response :success
+        body = ActiveSupport::JSON.decode(@response.body)
+        assert_equal(data, body)
+      end
+
+      test 'update with error VMware snapshot' do
         ForemanSnapshotManagement::Snapshot.any_instance.stubs(:save).returns(false)
         put :update, params: { :host_id => host.to_param, :id => snapshot_id, :snapshot => { :name => 'test 2' } }, session: set_session_user
         assert_response :unprocessable_entity
       end
+
+      test 'update with error proxmox snapshot' do
+        Host::Managed.any_instance.stubs(:vm_exists?).returns(false)
+        ForemanSnapshotManagement::Snapshot.any_instance.stubs(:save).returns(false)
+        put :update, params: { :host_id => proxmox_host.to_param, :id => proxmox_snapshot, :snapshot => { :name => 'snapshot1', :description => 'fail' } }, session: set_session_user
+        assert_response :unprocessable_entity
+      end
     end
   end
 end

data/test/factories/proxmox_factory.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :proxmox_resource, :class => ComputeResource do
+    sequence(:name) { |n| "compute_resource_proxmox#{n}" }
+    organizations { [Organization.find_by(name: 'Organization 1')] }
+    locations { [Location.find_by(name: 'Location 1')] }
+
+    trait :proxmox do
+      provider { 'Proxmox' }
+      user { 'root@pam' }
+      password { 'proxmox01' }
+      url { 'https://192.168.56.101:8006/api2/json' }
+    end
+
+    factory :proxmox_cr, :class => ForemanFogProxmox::Proxmox, :traits => [:proxmox]
+  end
+end

data/test/test_plugin_helper.rb

@@ -1,2 +1,7 @@
+# frozen_string_literal: true
+
 # This calls the main test_helper in Foreman-core
 require 'test_helper'
+
+FactoryBot.definition_file_paths << File.join(File.dirname(__FILE__), 'factories')
+FactoryBot.reload

data/webpack/components/SnapshotManagement/SnapshotManagement.js

@@ -0,0 +1,84 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { Button } from 'patternfly-react';
+
+import { translate as __ } from 'foremanReact/common/I18n';
+
+import SnapshotFormModal from './components/SnapshotFormModal';
+import useSnapshotFormModal from './components/SnapshotFormModal/useSnapshotFormModal';
+import SnapshotList from './components/SnapshotList/SnapshotList';
+import './snapshotManagement.scss';
+
+const SnapshotManagement = ({ canCreate, host, ...props }) => {
+  const children = [];
+  const { setModalOpen, setModalClosed } = useSnapshotFormModal();
+
+  const onCreateClick = () => {
+    setModalOpen();
+  };
+  const allowedHostAttr = ['id', 'name'];
+  const filteredHost = Object.keys(host)
+    .filter(key => allowedHostAttr.includes(key))
+    .reduce(
+      (obj, key) => ({
+        ...obj,
+        [key]: host[key],
+      }),
+      {}
+    );
+
+  if (canCreate) {
+    children.push(
+      <SnapshotFormModal
+        key="snapshot-form-modal"
+        setModalClosed={setModalClosed}
+        host={filteredHost}
+        hostId={host.id}
+        {...props}
+      />
+    );
+    children.push(
+      <Button
+        key="snapshot-create-button"
+        onClick={onCreateClick}
+        className="snapshot-create"
+      >
+        {__('Create Snapshot')}
+      </Button>
+    );
+  }
+
+  children.push(
+    <SnapshotList key="snapshot-list" host={filteredHost} {...props} />
+  );
+
+  return <div>{children}</div>;
+};
+
+SnapshotManagement.propTypes = {
+  host: PropTypes.shape({
+    id: PropTypes.number.isRequired,
+    name: PropTypes.string.isRequired,
+  }).isRequired,
+  canCreate: PropTypes.bool,
+  canUpdate: PropTypes.bool,
+  canRevert: PropTypes.bool,
+  canDelete: PropTypes.bool,
+  capabilities: PropTypes.shape({
+    editSnapshotName: PropTypes.bool,
+    limitSnapshotNameFormat: PropTypes.bool,
+  }),
+};
+
+SnapshotManagement.defaultProps = {
+  canCreate: false,
+  canUpdate: false,
+  canRevert: false,
+  canDelete: false,
+  capabilities: {
+    editSnapshotName: true,
+    limitSnapshotNameFormat: false,
+  },
+};
+
+export default SnapshotManagement;

data/webpack/components/SnapshotManagement/SnapshotManagementActions.js

@@ -0,0 +1,212 @@
+import { API, actionTypeGenerator } from 'foremanReact/redux/API';
+import { sprintf, translate as __ } from 'foremanReact/common/I18n';
+import { addToast } from 'foremanReact/redux/actions/toasts';
+
+import {
+  SNAPSHOT_LIST,
+  SNAPSHOT_LIST_URL,
+  SNAPSHOT_DELETE,
+  SNAPSHOT_DELETE_URL,
+  SNAPSHOT_UPDATE,
+  SNAPSHOT_UPDATE_URL,
+  SNAPSHOT_ROLLBACK,
+  SNAPSHOT_ROLLBACK_URL,
+} from './SnapshotManagementConstants';
+
+export const loadSnapshotList = hostId => async dispatch => {
+  const { REQUEST, SUCCESS, FAILURE } = actionTypeGenerator(SNAPSHOT_LIST);
+
+  dispatch({
+    type: REQUEST,
+    payload: { hostId },
+  });
+  try {
+    const { data } = await API.get(
+      SNAPSHOT_LIST_URL.replace(':host_id', hostId)
+    );
+    return dispatch({
+      type: SUCCESS,
+      payload: { hostId },
+      response: data,
+    });
+  } catch (error) {
+    return dispatch({
+      type: FAILURE,
+      payload: { hostId },
+      response: error,
+    });
+  }
+};
+
+export const snapshotDeleteAction = (host, rowData) => async dispatch => {
+  const { REQUEST, SUCCESS, FAILURE } = actionTypeGenerator(SNAPSHOT_DELETE);
+
+  dispatch({
+    type: REQUEST,
+    payload: {
+      host,
+      id: rowData.id,
+    },
+  });
+  try {
+    const { data } = await API.delete(
+      sprintf(SNAPSHOT_DELETE_URL, host.id, rowData.id)
+    );
+
+    dispatch(
+      addToast({
+        type: 'success',
+        message: sprintf(
+          __('Successfully removed Snapshot "%s" from host %s'),
+          rowData.name,
+          host.name
+        ),
+        key: SUCCESS,
+      })
+    );
+    dispatch(loadSnapshotList(host.id));
+    return dispatch({
+      type: SUCCESS,
+      payload: {
+        host,
+        id: rowData.id,
+      },
+      response: data,
+    });
+  } catch (error) {
+    dispatch(
+      addToast({
+        type: 'error',
+        message: sprintf(
+          __('Error occurred while removing Snapshot: %s'),
+          error
+        ),
+        key: FAILURE,
+      })
+    );
+    return dispatch({
+      type: FAILURE,
+      payload: {
+        host,
+        id: rowData.id,
+      },
+      response: error,
+    });
+  }
+};
+
+export const snapshotUpdateAction = (host, rowData) => async dispatch => {
+  const { REQUEST, SUCCESS, FAILURE } = actionTypeGenerator(SNAPSHOT_UPDATE);
+
+  dispatch({
+    type: REQUEST,
+    payload: {
+      host,
+      id: rowData.id,
+      snapshot: {
+        name: rowData.name,
+        description: rowData.description,
+      },
+    },
+  });
+  try {
+    const { data } = await API.put(
+      sprintf(SNAPSHOT_UPDATE_URL, host.id, rowData.id),
+      {
+        snapshot: {
+          name: rowData.name,
+          description: rowData.description,
+        },
+      }
+    );
+    dispatch(
+      addToast({
+        type: 'success',
+        message: sprintf(
+          __('Successfully updated Snapshot "%s"'),
+          rowData.name
+        ),
+        key: SUCCESS,
+      })
+    );
+    return dispatch({
+      type: SUCCESS,
+      payload: {
+        host,
+        id: rowData.id,
+      },
+      response: data,
+    });
+  } catch (error) {
+    dispatch(
+      addToast({
+        type: 'error',
+        message: sprintf(
+          __('Error occurred while updating Snapshot: %s'),
+          error
+        ),
+        key: FAILURE,
+      })
+    );
+    return dispatch({
+      type: FAILURE,
+      payload: {
+        host,
+        id: rowData.id,
+      },
+      response: error,
+    });
+  }
+};
+
+export const snapshotRollbackAction = (host, rowData) => async dispatch => {
+  const { REQUEST, SUCCESS, FAILURE } = actionTypeGenerator(SNAPSHOT_ROLLBACK);
+
+  dispatch({
+    type: REQUEST,
+    payload: {
+      host,
+      id: rowData.id,
+    },
+  });
+  try {
+    const { data } = await API.put(
+      sprintf(SNAPSHOT_ROLLBACK_URL, host.id, rowData.id)
+    );
+    dispatch(
+      addToast({
+        type: 'success',
+        message: sprintf(
+          __('Successfully rolled back Snapshot "%s" on host %s'),
+          rowData.name,
+          host.name
+        ),
+        key: SUCCESS,
+      })
+    );
+    return dispatch({
+      type: SUCCESS,
+      payload: {
+        host,
+        id: rowData.id,
+      },
+      response: data,
+    });
+  } catch (error) {
+    dispatch(
+      addToast({
+        type: 'error',
+        message: sprintf(__('Error occurred while rolling back VM: %s'), error),
+        key: FAILURE,
+      })
+    );
+    return dispatch({
+      type: FAILURE,
+      payload: {
+        host,
+        id: rowData.id,
+      },
+      response: error,
+    });
+  }
+};