vagrant-openstack-plugin-tom 0.12.0

data/Rakefile

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec/core/rake_task'
+
+# Immediately sync all stdout so that tools like buildbot can
+# immediately load in the output.
+$stdout.sync = true
+$stderr.sync = true
+
+# Change to the directory of this file.
+Dir.chdir(File.expand_path("../", __FILE__))
+
+# This installs the tasks that help with gem creation and
+# publishing.
+Bundler::GemHelper.install_tasks
+
+# Install the `spec` task so that we can run tests.
+RSpec::Core::RakeTask.new
+
+# Default task is to run the unit tests
+task :default => "spec"

data/example_box/README.md

@@ -0,0 +1,13 @@
+# Vagrant OpenStack Cloud Example Box
+
+Vagrant providers each require a custom provider-specific box format.
+This folder shows the example contents of a box for the `openstack` provider.
+To turn this into a box:
+
+```
+$ tar cvzf openstack.box ./metadata.json ./Vagrantfile
+```
+
+This box works by using Vagrant's built-in Vagrantfile merging to setup
+defaults for OpenStack. These defaults can easily be overwritten by higher-level
+Vagrantfiles (such as project root Vagrantfiles).

data/example_box/metadata.json

@@ -0,0 +1,3 @@
+{
+    "provider": "openstack"
+}

data/example_vagrant_file

@@ -0,0 +1,24 @@
+require 'vagrant-openstack-plugin'
+
+Vagrant.configure("2") do |config|
+  config.vm.box = "dummy"
+
+  # Make sure the private key from the key pair is provided
+  config.ssh.private_key_path = "~/.ssh/openstack_irad_key"
+
+  config.vm.provider :openstack do |os|
+    os.server_name = "thellier-vagrant-test"
+    os.username     = "thellier1"          # e.g. "#{ENV['OS_USERNAME']}"
+    os.api_key      = "#{ENV['OS_PASSWORD']}" # e.g. "#{ENV['OS_PASSWORD']}"
+    os.flavor       = /irad.nano/                # Regex or String
+    os.image        = /CentOS7-nano/                 # Regex or String
+    os.endpoint     = "http://openstack.irad.ng.co.uk:35357/v3/auth/tokens"      # e.g. "#{ENV['OS_AUTH_URL']}/tokens"
+    os.keypair_name = "openstack-shared-key"      # as stored in Nova
+    os.ssh_username = "centos"           # login for the VM
+    os.project_name = "smartdata"
+    os.project_domain = "default"
+    os.user_domain = "default"
+    os.network            = "smartdata_network"            # optional
+    os.metadata  = {"key" => "value"}                      # optional
+  end
+end

data/lib/vagrant-openstack-plugin.rb

@@ -0,0 +1,53 @@
+require "pathname"
+
+require "vagrant-openstack-plugin/plugin"
+
+module VagrantPlugins
+  module OpenStack
+    lib_path = Pathname.new(File.expand_path("../vagrant-openstack-plugin", __FILE__))
+    autoload :Errors, lib_path.join("errors")
+
+    # This initializes the i18n load path so that the plugin-specific
+    # translations work.
+    def self.init_i18n
+      I18n.load_path << File.expand_path("locales/en.yml", source_root)
+      I18n.reload!
+    end
+
+    # This initializes the logging so that our logs are outputted at
+    # the same level as Vagrant core logs.
+    def self.init_logging
+      # Initialize logging
+      level = nil
+      begin
+        level = Log4r.const_get(ENV["VAGRANT_LOG"].upcase)
+      rescue NameError
+        # This means that the logging constant wasn't found,
+        # which is fine. We just keep `level` as `nil`. But
+        # we tell the user.
+        level = nil
+      end
+
+      # Some constants, such as "true" resolve to booleans, so the
+      # above error checking doesn't catch it. This will check to make
+      # sure that the log level is an integer, as Log4r requires.
+      level = nil if !level.is_a?(Integer)
+
+      # Set the logging level on all "vagrant" namespaced
+      # logs as long as we have a valid level.
+      if level
+        logger = Log4r::Logger.new("vagrant_openstack")
+        logger.outputters = Log4r::Outputter.stderr
+        logger.level = level
+        logger = nil
+      end
+    end
+
+    # This returns the path to the source of this plugin.
+    #
+    # @return [Pathname]
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
+    end
+  end
+end

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

@@ -0,0 +1,268 @@
+require "pathname"
+
+require "vagrant/action/builder"
+
+module VagrantPlugins
+  module OpenStack
+    module Action
+      # Include the built-in modules so we can use them as top-level things.
+      include Vagrant::Action::Builtin
+
+      # This action is called when `vagrant destroy` is executed.
+      def self.action_destroy
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, DestroyConfirm do |env, b1|
+            if env[:result]
+              b1.use ConnectOpenStack
+              b1.use DeleteServer
+              b1.use DeleteOrchestrationStack
+            else
+              b1.use MessageWillNotDestroy
+            end
+          end
+        end
+      end
+
+      # This action is called to read the SSH info of the machine. The
+      # resulting state is expected to be put into the `:machine_ssh_info`
+      # key.
+      def self.action_read_ssh_info
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectOpenStack
+          b.use ReadSSHInfo
+        end
+      end
+
+      # This action is called to read the state of the machine. The
+      # resulting state is expected to be put into the `:machine_state_id`
+      # key.
+      def self.action_read_state
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectOpenStack
+          b.use ReadState
+        end
+      end
+
+      # This action is called when `vagrant ssh` is executed.
+      def self.action_ssh
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b1|
+            unless env[:result]
+              b1.use MessageNotCreated
+              next
+            end
+
+            b1.use SSHExec
+          end
+        end
+      end
+
+      def self.action_ssh_run
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b1|
+            unless env[:result]
+              b1.use MessageNotCreated
+              next
+            end
+
+            b1.use SSHRun
+          end
+        end
+      end
+
+      def self.action_prepare_boot
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use Provision
+          b.use SyncFolders
+          b.use SetHostname
+        end
+      end
+
+      # This action is called when `vagrant up` is executed.
+      def self.action_up
+        Vagrant::Action::Builder.new.tap do |b|
+          if Vagrant::VERSION < '1.6.0'
+            b.use HandleBoxUrl
+          else
+            b.use HandleBox
+          end
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b1|
+            unless env[:result]
+              b1.use action_prepare_boot
+              b1.use ConnectOpenStack
+              b1.use CreateOrchestrationStack
+              b1.use CreateServer
+              b1.use CreateNetworkInterfaces
+            else
+              b1.use action_resume
+            end
+          end
+        end
+      end
+
+      # This action is called when `vagrant provision` is executed.
+      def self.action_provision
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b1|
+            unless env[:result]
+              b1.use MessageNotCreated
+              next
+            end
+
+            b1.use ConnectOpenStack
+            b1.use Provision
+            b1.use SyncFolders
+          end
+        end
+      end
+
+      # This action is called when `vagrant reload` is executed.
+      def self.action_reload
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectOpenStack
+          b.use Call, IsPaused do |env, b1|
+            unless env[:result]
+              b1.use Call, IsSuspended do |env2, b2|
+                b2.use RebootServer
+              end
+            end
+
+            b1.use Call, WaitForState, [:active], 120 do |env2, b2|
+              unless env2[:result]
+                b2.use HardRebootServer
+              end
+            end
+          end
+        end
+      end
+
+      # This action is called when `vagrant halt` is executed.
+      def self.action_halt
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b1|
+            unless env[:result]
+              b1.use Call, IsSuspended do |env2, b2|
+                if env2[:result]
+                  b1.use MessageAlreadySuspended
+                  next
+                end
+              end
+            end
+
+            b1.use ConnectOpenStack
+            b1.use PauseServer
+          end
+        end
+      end
+
+      # This action is called when `vagrant resume` is executed.
+      def self.action_resume
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b1|
+            if env[:result]
+              b1.use MessageServerRunning
+              next
+            end
+
+            b1.use ConnectOpenStack
+            b1.use ResumeServer
+            b1.use SyncFolders
+          end
+        end
+      end
+
+      # This action is called when `vagrant suspend` is executed.
+      def self.action_suspend
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b1|
+            if env[:result]
+              b1.use ConnectOpenStack
+              b1.use SuspendServer
+            else
+              b1.use Call, IsPaused do |env2, b2|
+                if env2[:result]
+                  b2.use MessageAlreadyPaused
+                else
+                  b2.use MessageAlreadySuspended
+                end
+              end
+            end
+          end
+        end
+      end
+
+      def self.action_take_snapshot
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b1|
+            if env[:result]
+              b1.use ConnectOpenStack
+              b1.use Call, IsSnapshoting do |env,b2|
+                if env[:result]
+                  b2.use MessageSnapshotInProgress
+                else
+                  b2.use TakeSnapshot
+                end
+
+                b2.use Call, WaitForTask, [nil], 1200 do |env3, b3|
+                  if env3[:result]
+                    b3.use MessageSnapshotDone
+                  end
+                end
+
+
+              end
+            else
+              b1.use MessageNotCreated
+            end
+          end
+        end
+      end
+
+      # The autoload farm
+      action_root = Pathname.new(File.expand_path("../action", __FILE__))
+      autoload :ConnectOpenStack, action_root.join("connect_openstack")
+      autoload :CreateServer, action_root.join("create_server")
+      autoload :CreateNetworkInterfaces, action_root.join("create_network_interfaces")
+      autoload :DeleteServer, action_root.join("delete_server")
+      autoload :HardRebootServer, action_root.join("hard_reboot_server")
+      autoload :IsCreated, action_root.join("is_created")
+      autoload :IsPaused, action_root.join("is_paused")
+      autoload :IsSnapshoting, action_root.join("is_snapshoting")
+      autoload :IsSuspended, action_root.join("is_suspended")
+      autoload :MessageAlreadyCreated, action_root.join("message_already_created")
+      autoload :MessageAlreadyPaused, action_root.join("message_already_paused")
+      autoload :MessageAlreadySuspended, action_root.join("message_already_suspended")
+      autoload :MessageNotCreated, action_root.join("message_not_created")
+      autoload :MessageNotSuspended, action_root.join("message_not_suspended")
+      autoload :MessageSnapshotDone, action_root.join("message_snapshot_done")
+      autoload :MessageSnapshotInProgress, action_root.join("message_snapshot_in_progress")
+      autoload :MessageWillNotDestroy, action_root.join("message_will_not_destroy")
+      autoload :MessageServerRunning, action_root.join("message_server_running")
+      autoload :PauseServer, action_root.join("pause_server")
+      autoload :ReadSSHInfo, action_root.join("read_ssh_info")
+      autoload :ReadState, action_root.join("read_state")
+      autoload :RebootServer, action_root.join("reboot_server")
+      autoload :ResumeServer, action_root.join("resume_server")
+      autoload :SuspendServer, action_root.join("suspend_server")      
+      autoload :SyncFolders, action_root.join("sync_folders")
+      autoload :TakeSnapshot, action_root.join("take_snapshot")
+      autoload :WaitForState, action_root.join("wait_for_state")
+      autoload :WaitForTask, action_root.join("wait_for_task")
+      autoload :WarnNetworks, action_root.join("warn_networks")
+      autoload :CreateOrchestrationStack, action_root.join("create_orchestration_stack")
+      autoload :DeleteOrchestrationStack, action_root.join("delete_orchestration_stack")
+    end
+  end
+end

data/lib/vagrant-openstack-plugin/action/connect_openstack.rb

@@ -0,0 +1,90 @@
+require "fog"
+require "log4r"
+
+module VagrantPlugins
+  module OpenStack
+    module Action
+      # This action connects to OpenStack, verifies credentials work, and
+      # puts the OpenStack connection object into the `:openstack_compute` key
+      # in the environment.
+      class ConnectOpenStack
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant_openstack::action::connect_openstack")
+        end
+
+        def call(env)
+          # Get the configs
+          config   = env[:machine].provider_config
+          api_key  = config.api_key
+          endpoint = config.endpoint
+          username = config.username
+          tenant = config.tenant
+          region = config.region
+          project_name = config.project_name
+          project_domain = config.project_domain
+          user_domain = config.user_domain
+
+          # Pass proxy config down into the Fog::Connection object using
+          # the `connection_options` hash.
+          connection_options = {
+            :proxy           => config.proxy,
+            :ssl_verify_peer => config.ssl_verify_peer
+          }
+
+          # Prepare connection parameters for use with fog service
+          # initialization (compute, storage, orchestration, ...).
+          env[:fog_openstack_params] = {
+            :provider           => :openstack,
+            :connection_options => connection_options,
+            :openstack_username => username,
+            :openstack_api_key  => api_key,
+            :openstack_auth_url => endpoint,
+            :openstack_tenant   => tenant,
+            :openstack_region   => region,
+            :openstack_project_name   => project_name,
+            :openstack_project_domain => project_domain,
+            :openstack_user_domain    => user_domain
+          }
+
+          @logger.info("Connecting to OpenStack...")
+          @logger.debug("API connection params: #{connection_options.inspect}")
+          env[:openstack_compute] = Fog::Compute.new(
+            env[:fog_openstack_params])
+
+          if config.network || (config.networks && !config.networks.empty?)
+            env[:openstack_network] = Fog::Network.new({
+              :provider => :openstack,
+              :connection_options => connection_options,
+              :openstack_username => username,
+              :openstack_api_key => api_key,
+              :openstack_auth_url => endpoint,
+              :openstack_tenant => tenant,
+              :openstack_region => region,
+              :openstack_project_name   => project_name,
+              :openstack_project_domain => project_domain,
+              :openstack_user_domain    => user_domain
+            })
+          end
+
+          if config.disks && !config.disks.empty?
+            env[:openstack_volume] = Fog::Volume.new({
+              :provider => :openstack,
+              :connection_options => connection_options,
+              :openstack_username => username,
+              :openstack_api_key => api_key,
+              :openstack_auth_url => endpoint,
+              :openstack_tenant => tenant,
+              :openstack_region => region,
+              :openstack_project_name => project_name,
+              :openstack_project_domain => project_domain,
+              :openstack_user_domain => user_domain
+            })
+          end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end