vagrant-openstack-provider 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e111c9012b675ada99d43c5aa067faeb8d11270a
-  data.tar.gz: 3bf6027578550da5dd29ef24f87a845c677da8b6
+  metadata.gz: 8ee292bbda02fdc4f61b3d79ef0275edf0df7735
+  data.tar.gz: a0299d495eb5cb64c3d7dfc47690340ad2eb4ccf
 SHA512:
-  metadata.gz: 27ef526289abb14e29224195a7ba099de0dcd58194cae42a9bfcf42b72f38a98357372f68107da358473ac4d07e41a3c5d5d4ddc99caf76653831b1a19113f4d
-  data.tar.gz: f2ef73aebe3096576f0a3301dca1f65985b5991b709bda72705aa2517b00ecd4dcc22a675f57deaa3f0210ba504d4c0c5e7fef1415147d276253e3996884cafb
+  metadata.gz: f55aa6db29a728c9f5cd0e9940ca9b1697dc900925f5a444c1eb397b4dd1bd9d734f4c6b0f32470964ac1d56dc458a445b01049b3e7c79032595e85dc42a4db3
+  data.tar.gz: bf8c6aceaa67d1f65c458168191e5ec26ca1e7c4f8bb4ee00acc9e4d816306746bb22ce4d032723d65289f827fea4858baf011a61da6743a728e5b93bd420ffd

data/.rubocop.yml

@@ -3,6 +3,7 @@ AllCops:
     - '.bundle/**/*'
     - 'out/**/*'
     - '**/Vagrantfile'
+  DisplayCopNames: true
 
 Style/FileName:
   Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.10.0 ( April 11, 2017)
+
+IMPROVEMENTS:
+
+  - Add snapshot support #296
+
 # 0.9.0 (January 30, 2016)
 
 BUG FIXES:

data/lib/vagrant-openstack-provider/action.rb

@@ -18,6 +18,7 @@ module VagrantPlugins
               b2.use Message, I18n.t('vagrant_openstack.not_created')
             else
               b2.use(ProvisionerCleanup, :before)
+              b2.use SnapshotCleanup if Gem::Version.new(Vagrant::VERSION) >= Gem::Version.new('1.8.0')
               b2.use DeleteServer
               b2.use DeleteStack
             end
@@ -233,6 +234,77 @@ module VagrantPlugins
         end
       end
 
+      # TODO: Remove the if guard when Vagrant 1.8.0 is the minimum version.
+      # rubocop:disable IndentationWidth
+      if Gem::Version.new(Vagrant::VERSION) >= Gem::Version.new('1.8.0')
+      def self.action_snapshot_delete
+        new_builder.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectOpenstack
+          b.use Call, IsState, :not_created do |env, b2|
+            if env[:result]
+              b2.use Message, I18n.t('vagrant_openstack.not_created')
+            else
+              b2.use SnapshotDelete
+            end
+          end
+        end
+      end
+
+      def self.action_snapshot_list
+        new_builder.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectOpenstack
+          b.use Call, IsState, :not_created do |env, b2|
+            if env[:result]
+              b2.use Message, I18n.t('vagrant_openstack.not_created')
+            else
+              b2.use SnapshotList
+            end
+          end
+        end
+      end
+
+      def self.action_snapshot_restore
+        new_builder.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectOpenstack
+          b.use Call, IsState, :not_created do |env, b2|
+            if env[:result]
+              b2.use Message, I18n.t('vagrant_openstack.not_created')
+              next
+            end
+
+            b2.use SnapshotRestore
+            b2.use WaitForServerToBeActive
+            b2.use WaitForCommunicator
+
+            b2.use Call, IsEnvSet, :snapshot_delete do |env2, b3|
+              # Used by vagrant push/pop
+              b3.use action_snapshot_delete if env2[:result]
+            end
+
+            b2.use action_provision
+          end
+        end
+      end
+
+      def self.action_snapshot_save
+        new_builder.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectOpenstack
+          b.use Call, IsState, :not_created do |env, b2|
+            if env[:result]
+              b2.use Message, I18n.t('vagrant_openstack.not_created')
+            else
+              b2.use SnapshotSave
+            end
+          end
+        end
+      end
+      end # Vagrant > 1.8.0 guard
+      # rubocop:enable IndentationWidth
+
       # The autoload farm
       action_root = Pathname.new(File.expand_path('../action', __FILE__))
       autoload :Message, action_root.join('message')
@@ -251,6 +323,16 @@ module VagrantPlugins
       autoload :ProvisionWrapper, action_root.join('provision')
       autoload :WaitForServerToStop, action_root.join('wait_stop')
       autoload :WaitForServerToBeActive, action_root.join('wait_active')
+      # TODO: Remove the if guard when Vagrant 1.8.0 is the minimum version.
+      # rubocop:disable IndentationWidth
+      if Gem::Version.new(Vagrant::VERSION) >= Gem::Version.new('1.8.0')
+      autoload :SnapshotCleanup, action_root.join('snapshot_cleanup')
+      autoload :SnapshotDelete, action_root.join('snapshot_delete')
+      autoload :SnapshotList, action_root.join('snapshot_list')
+      autoload :SnapshotRestore, action_root.join('snapshot_restore')
+      autoload :SnapshotSave, action_root.join('snapshot_save')
+      end
+      # rubocop:enable IndentationWidth
 
       private
 

data/lib/vagrant-openstack-provider/action/snapshot_cleanup.rb

@@ -0,0 +1,32 @@
+require 'vagrant-openstack-provider/action/abstract_action'
+
+module VagrantPlugins
+  module Openstack
+    module Action
+      class SnapshotCleanup < AbstractAction
+        def initialize(app, _env)
+          @app = app
+        end
+
+        def call(env)
+          nova = env[:openstack_client].nova
+          machine_snapshots = nova.list_snapshots(env, env[:machine].id)
+
+          snapshots_to_clean = machine_snapshots.select do |s|
+            s.metadata.key?('vagrant_snapshot')
+          end
+
+          @app.call env
+
+          unless snapshots_to_clean.empty?
+            env[:ui].info("Deleting Vagrant snapshots: #{snapshots_to_clean.map(&:name)}")
+          end
+
+          snapshots_to_clean.each do |s|
+            nova.delete_snapshot(env, s.id)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-openstack-provider/action/snapshot_delete.rb

@@ -0,0 +1,32 @@
+require 'vagrant-openstack-provider/action/abstract_action'
+
+module VagrantPlugins
+  module Openstack
+    module Action
+      class SnapshotDelete < AbstractAction
+        def initialize(app, _env)
+          @app = app
+        end
+
+        def call(env)
+          nova = env[:openstack_client].nova
+          machine_snapshots = nova.list_snapshots(env, env[:machine].id)
+
+          snapshot = machine_snapshots.find { |s| s.name == env[:snapshot_name] }
+
+          unless snapshot.nil?
+            env[:ui].info(I18n.t('vagrant.actions.vm.snapshot.deleting',
+                                 name: snapshot.name))
+
+            nova.delete_snapshot(env, snapshot.id)
+
+            env[:ui].info(I18n.t('vagrant.actions.vm.snapshot.deleted',
+                                 name: snapshot.name))
+          end
+
+          @app.call env
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-openstack-provider/action/snapshot_list.rb

@@ -0,0 +1,22 @@
+require 'vagrant-openstack-provider/action/abstract_action'
+
+module VagrantPlugins
+  module Openstack
+    module Action
+      class SnapshotList < AbstractAction
+        def initialize(app, _env)
+          @app = app
+        end
+
+        def call(env)
+          nova = env[:openstack_client].nova
+          machine_snapshots = nova.list_snapshots(env, env[:machine].id)
+
+          env[:machine_snapshot_list] = machine_snapshots.map(&:name)
+
+          @app.call env
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-openstack-provider/action/snapshot_restore.rb

@@ -0,0 +1,29 @@
+require 'vagrant-openstack-provider/action/abstract_action'
+
+module VagrantPlugins
+  module Openstack
+    module Action
+      class SnapshotRestore < AbstractAction
+        def initialize(app, _env)
+          @app = app
+        end
+
+        def call(env)
+          nova = env[:openstack_client].nova
+          machine_snapshots = nova.list_snapshots(env, env[:machine].id)
+
+          snapshot = machine_snapshots.find { |s| s.name == env[:snapshot_name] }
+
+          unless snapshot.nil?
+            env[:ui].info(I18n.t('vagrant.actions.vm.snapshot.restoring',
+                                 name: snapshot.name))
+
+            nova.restore_snapshot(env, env[:machine].id, snapshot.id)
+          end
+
+          @app.call env
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-openstack-provider/action/snapshot_save.rb

@@ -0,0 +1,51 @@
+require 'vagrant-openstack-provider/action/abstract_action'
+
+module VagrantPlugins
+  module Openstack
+    module Action
+      class SnapshotSave < AbstractAction
+        def initialize(app, _env, retry_interval = 3)
+          @app = app
+          @retry_interval = retry_interval
+        end
+
+        def call(env)
+          nova = env[:openstack_client].nova
+          config = env[:machine].provider_config
+
+          env[:ui].info(I18n.t('vagrant.actions.vm.snapshot.saving',
+                               name: env[:snapshot_name]))
+
+          nova.create_snapshot(
+            env,
+            env[:machine].id, env[:snapshot_name])
+
+          image = nova.list_snapshots(env, env[:machine].id).find { |i| i.name == env[:snapshot_name] }
+
+          timeout(config.server_create_timeout, Errors::Timeout) do
+            loop do
+              image_status = nova.get_image_details(env, image.id)
+
+              break if image_status['status'] == 'ACTIVE'
+
+              unless image_status['progress'].nil?
+                env[:ui].clear_line
+                env[:ui].report_progress(image_status['progress'], 100, false)
+              end
+
+              sleep @retry_interval
+            end
+          end
+
+          # Clear progress output.
+          env[:ui].clear_line
+
+          env[:ui].success(I18n.t('vagrant.actions.vm.snapshot.saved',
+                                  name: env[:snapshot_name]))
+
+          @app.call env
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-openstack-provider/cap/snapshot_list.rb

@@ -0,0 +1,15 @@
+module VagrantPlugins
+  module Openstack
+    module Cap
+      module SnapshotList
+        # Returns a list of the snapshots that are taken on this machine.
+        #
+        # @return [Array<String>]
+        def self.snapshot_list(machine)
+          env = machine.action(:snapshot_list, lock: false)
+          env[:machine_snapshot_list]
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-openstack-provider/client/domain.rb

@@ -25,19 +25,23 @@ module VagrantPlugins
         attr_accessor :size
         attr_accessor :min_ram
         attr_accessor :min_disk
+        attr_accessor :metadata
 
-        def initialize(id, name, visibility = nil, size = nil, min_ram = nil, min_disk = nil)
+        # rubocop:disable Metrics/ParameterLists
+        def initialize(id, name, visibility = nil, size = nil, min_ram = nil, min_disk = nil, metadata = {})
           @visibility = visibility
           @size = size
           @min_ram = min_ram
           @min_disk = min_disk
+          @metadata = metadata
           super(id, name)
         end
+        # rubocop:enable Metrics/ParameterLists
 
         protected
 
         def state
-          [@id, @name, @visibility, @size, @min_ram, @min_disk]
+          [@id, @name, @visibility, @size, @min_ram, @min_disk, @metadata]
         end
       end
 

data/lib/vagrant-openstack-provider/client/nova.rb

@@ -42,9 +42,30 @@ module VagrantPlugins
         FloatingIP.new(floating_ip['ip'], floating_ip['pool'], floating_ip['instance_id'])
       end
 
-      def get_all_images(env)
-        images_json = get(env, "#{@session.endpoints[:compute]}/images")
-        JSON.parse(images_json)['images'].map { |fl| Image.new(fl['id'], fl['name'], 'unknown') }
+      def get_all_images(env, headers = {})
+        images_json = get(env, "#{@session.endpoints[:compute]}/images/detail", headers)
+        JSON.parse(images_json)['images'].map do |fl|
+          Image.new(
+            fl['id'],
+            fl['name'],
+            'unknown',
+            nil,
+            fl['minRam'],
+            fl['minDisk'],
+            fl['metadata']
+          )
+        end
+      end
+
+      # Get detailed information about an image
+      #
+      # @param env [Hash] Vagrant action environment
+      # @param image_id [String] Image UUID
+      #
+      # @return [Hash]
+      def get_image_details(env, image_id)
+        image_json = get(env, "#{@session.endpoints[:compute]}/images/#{image_id}")
+        JSON.parse(image_json)['image']
       end
 
       def create_server(env, options)
@@ -175,6 +196,63 @@ module VagrantPlugins
         end
       end
 
+      # List snapshot images associated with a particular server
+      #
+      # @param env [Hash] Vagrant action environment
+      # @param server_id [String] Server UUID
+      #
+      # @return [Array<VagrantPlugins::Openstack::Domain::Image>]
+      def list_snapshots(env, server_id)
+        get_all_images(env, params: { server: server_id })
+      end
+
+      # Create a named snapsot for a given VM
+      #
+      # @param env [Hash] Vagrant action environment
+      # @param server_id [String] Server UUID
+      # @param snapshot_name [String]
+      #
+      # @return [void]
+      def create_snapshot(env, server_id, snapshot_name)
+        instance_exists do
+          post(
+            env,
+            "#{@session.endpoints[:compute]}/servers/#{server_id}/action",
+            { createImage: {
+              name: snapshot_name,
+              metadata: { vagrant_snapshot: 'true' }
+            } }.to_json)
+        end
+      end
+
+      # Delete an identified snapshot
+      #
+      # @param env [Hash] Vagrant action environment
+      # @param snapshot_id [String] Snapshot UUID
+      #
+      # @return [void]
+      def delete_snapshot(env, snapshot_id)
+        delete(
+          env,
+          "#{@session.endpoints[:compute]}/images/#{snapshot_id}")
+      end
+
+      # Restore a VM to an identified snapshot
+      #
+      # @param env [Hash] Vagrant action environment
+      # @param server_id [String] Server UUID
+      # @param snapshot_id [String] Snapshot UUID
+      #
+      # @return [void]
+      def restore_snapshot(env, server_id, snapshot_id)
+        instance_exists do
+          post(
+            env,
+            "#{@session.endpoints[:compute]}/servers/#{server_id}/action",
+            { rebuild: { imageRef: snapshot_id } }.to_json)
+        end
+      end
+
       private
 
       VM_STATES =

data/lib/vagrant-openstack-provider/plugin.rb

@@ -35,6 +35,16 @@ module VagrantPlugins
         Provider
       end
 
+      # TODO: Remove the if guard when Vagrant 1.8.0 is the minimum version.
+      # rubocop:disable IndentationWidth
+      if Gem::Version.new(Vagrant::VERSION) >= Gem::Version.new('1.8.0')
+      provider_capability('openstack', 'snapshot_list') do
+        require_relative 'cap/snapshot_list'
+        Cap::SnapshotList
+      end
+      end
+      # rubocop:enable IndentationWidth
+
       command('openstack') do
         Openstack.init_i18n
         Openstack.init_logging

data/lib/vagrant-openstack-provider/version.rb

@@ -4,7 +4,7 @@ module VagrantPlugins
     # Stable versions must respect the pattern given
     # by VagrantPlugins::Openstack::VERSION_PATTERN
     #
-    VERSION = '0.9.0'
+    VERSION = '0.10.0'
 
     #
     # Stable version must respect the naming convention 'x.y.z'

data/spec/vagrant-openstack-provider/client/nova_spec.rb

@@ -101,7 +101,7 @@ describe VagrantPlugins::Openstack::NovaClient do
   describe 'get_all_images' do
     context 'with token and project_id acquainted' do
       it 'returns all images' do
-        stub_request(:get, 'http://nova/a1b2c3/images')
+        stub_request(:get, 'http://nova/a1b2c3/images/detail')
           .with(
             headers:
             {
@@ -110,13 +110,14 @@ describe VagrantPlugins::Openstack::NovaClient do
             })
           .to_return(
             status: 200,
-            body: '{ "images": [ { "id": "i1", "name": "image1"}, { "id": "i2", "name": "image2"} ] }')
+            body: '{ "images": [ { "id": "i1", "name": "image1", "metadata": {"customVal1": 1}}, { "id": "i2", "name": "image2"} ] }')
 
         images = @nova_client.get_all_images(env)
 
         expect(images.length).to eq(2)
         expect(images[0].id).to eq('i1')
         expect(images[0].name).to eq('image1')
+        expect(images[0].metadata['customVal1']).to eq(1)
         expect(images[1].id).to eq('i2')
         expect(images[1].name).to eq('image2')
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-openstack-provider
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Guillaume Giamarchi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-30 00:00:00.000000000 Z
+date: 2017-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -213,12 +213,18 @@ files:
 - lib/vagrant-openstack-provider/action/read_ssh_info.rb
 - lib/vagrant-openstack-provider/action/read_state.rb
 - lib/vagrant-openstack-provider/action/resume.rb
+- lib/vagrant-openstack-provider/action/snapshot_cleanup.rb
+- lib/vagrant-openstack-provider/action/snapshot_delete.rb
+- lib/vagrant-openstack-provider/action/snapshot_list.rb
+- lib/vagrant-openstack-provider/action/snapshot_restore.rb
+- lib/vagrant-openstack-provider/action/snapshot_save.rb
 - lib/vagrant-openstack-provider/action/start_server.rb
 - lib/vagrant-openstack-provider/action/stop_server.rb
 - lib/vagrant-openstack-provider/action/suspend.rb
 - lib/vagrant-openstack-provider/action/sync_folders.rb
 - lib/vagrant-openstack-provider/action/wait_active.rb
 - lib/vagrant-openstack-provider/action/wait_stop.rb
+- lib/vagrant-openstack-provider/cap/snapshot_list.rb
 - lib/vagrant-openstack-provider/catalog/openstack_catalog.rb
 - lib/vagrant-openstack-provider/client/cinder.rb
 - lib/vagrant-openstack-provider/client/domain.rb