vagrant-fifo 0.2.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vagrant-fifo.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright 2013 Brian Akins <brian@akins.org>
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,91 @@
+# vagrant-fifo Vagrant plugin
+
+vagrant-fifo is a Vagrant provider for [Project-Fifo](http://project-fifo.net/)
+
+Note: this is under development and is probably broken. Patches welcome.
+
+## Installation
+
+### From Source
+
+    git clone https://github.com/bakins/vagrant-fifo.git
+    cd vagrant-fifo
+    gem build vagrant-fifo.gemspec
+    vagrant plugin install vagrant-fifo-<version>.gem
+    cd example_box
+    tar cvzf fifo.box ./metadata.json ./Vagrantfile
+    vagrant box add fifo fifo.box --provider fifo
+
+### From Rubygems
+
+     vagrant plugin install vagrant-fifo
+
+## Usage
+
+Check out a chef-repo with a Fifo compatible Vagrantfile, then run "vagrant up"
+
+    vagrant up --provider=fifo
+    vagrant provision
+    vagrant ssh
+    vagrant destroy
+
+Example Vagrantfile:
+
+    Vagrant.configure("2") do |config|
+      config.vm.box = "fifo"
+
+      config.vm.provider :fifo do |fifo|
+        fifo.dataset = "ubuntu-12.04"
+        fifo.api_url = "http://192.168.1.100/api/v1/"
+        fifo.username = "my-username"
+        fifo.password = "my-password
+        fifo.node_name = "node-name"
+        fifo.ssh_username = "root"
+        fifo.ssh_private_key_path = "/path/to/my/private/key"
+      end
+    end
+
+You can also use a box url, rather than building the example box on
+your local machine:
+
+    Vagrant.configure("2") do |config|
+       config.vm.box = "fifo"
+       config.vm.box_url = "http://www.akins.org/vagrant/fifo.box"
+       ...
+    end
+
+Feel free to mirror your own copy of `fifo.box`
+
+#### Configuration
+
+The following options are availible. These are used like:
+
+    config.vm.provider :fifo do |fifo|
+        fifo.dataset = "ubuntu-12.04"
+	...
+    end
+
+* dataset - "OS Image" to use. Can be name or ID
+* api_url - api endpoint for project-fifo installation
+* username - api username
+* password - api password
+* node_name - the project-fifo node\name/alias for this vm- not this
+  is not the hostname
+* ssh_username - username to use for ssh
+* ssh\_private\_key - ssh private key to use for ssh. This should be
+  the private key for the public key you registered in project-fifo
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Thanks
+
+Based on [vagrant-joyent](https://github.com/someara/vagrant-joyent)
+
+## License
+Apache 2

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/example_box/README.md

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

data/example_box/Vagrantfile

@@ -0,0 +1,8 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure("2") do |config|
+  config.vm.provider :fifo do |fifo|
+    fifo.dataset = "ubuntu-12.04"
+  end
+end

data/example_box/metadata.json

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

data/lib/vagrant-fifo/action/connect_fifo.rb

@@ -0,0 +1,34 @@
+require 'project-fifo'
+require "log4r"
+require "pp"
+
+module VagrantPlugins
+  module Fifo
+    module Action
+      # This action connects to Fifo, verifies credentials work, and
+      # puts the Fifo connection object into the `:fifo_compute` key
+      # in the environment.
+      class ConnectFifo
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant_fifo::action::connect_fifo")
+        end
+
+        def call(env)
+
+          fifo_username = env[:machine].provider_config.username
+          fifo_password = env[:machine].provider_config.password
+          fifo_api_url  = env[:machine].provider_config.api_url
+
+          @logger.info("Connecting to Fifo...")
+          env[:fifo_compute] = begin
+                                 fifo = ProjectFifo.new(fifo_api_url, fifo_username, fifo_password)
+                                 fifo.connect
+                                 fifo
+                               end
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-fifo/action/is_created.rb

@@ -0,0 +1,18 @@
+module VagrantPlugins
+  module Fifo
+    module Action
+      # This can be used with "Call" built-in to check if the machine
+      # is created and branch in the middleware.
+      class IsCreated
+        def initialize(app, env)
+          @app = app
+        end
+        
+        def call(env)
+          env[:result] = env[:machine].state.id != :not_created
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-fifo/action/message_already_created.rb

@@ -0,0 +1,16 @@
+module VagrantPlugins
+  module Fifo
+    module Action
+      class MessageAlreadyCreated
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info(I18n.t("vagrant_fifo.already_created"))
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-fifo/action/message_not_created.rb

@@ -0,0 +1,16 @@
+module VagrantPlugins
+  module Fifo
+    module Action
+      class MessageNotCreated
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info(I18n.t("vagrant_fifo.not_created"))
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-fifo/action/message_will_not_destroy.rb

@@ -0,0 +1,16 @@
+module VagrantPlugins
+  module Fifo
+    module Action
+      class MessageWillNotDestroy
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info(I18n.t("vagrant_fifo.will_not_destroy", name: env[:machine].name))
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-fifo/action/read_ssh_info.rb

@@ -0,0 +1,50 @@
+require "log4r"
+require 'ipaddr'
+
+module VagrantPlugins
+  module Fifo
+    module Action
+      # This action reads the SSH info for the machine and puts it into the
+      # `:machine_ssh_info` key in the environment.
+      class ReadSSHInfo
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant_fifo::action::read_ssh_info")
+        end
+
+        def call(env)
+          env[:machine_ssh_info] = read_ssh_info(env[:fifo_compute], env[:machine])
+
+          @app.call(env)
+        end
+
+        def read_ssh_info(fifo, machine)
+          return nil if machine.id.nil?
+
+          # Find the machine
+          server = fifo.vms.get(machine.id)
+          if server.nil?
+            # The machine can't be found
+            @logger.info("Machine couldn't be found, assuming it got destroyed.")
+            machine.id = nil
+            return nil
+          end
+          
+          # IP address to bootstrap
+          bootstrap_ip_address = server['config']['networks'].first['ip']
+
+          config = machine.provider_config
+
+          
+          # Read the DNS info
+          return {
+            :host => bootstrap_ip_address,
+            :port => 22,
+            :username => config.ssh_username,
+            :private_key_path => config.ssh_private_key_path
+          }
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-fifo/action/read_state.rb

@@ -0,0 +1,38 @@
+require "log4r"
+
+module VagrantPlugins
+  module Fifo
+    module Action
+      # This action reads the state of the machine and puts it in the
+      # `:machine_state_id` key in the environment.
+      class ReadState
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant_fifo::action::read_state")
+        end
+
+        def call(env)
+          env[:machine_state_id] = read_state(env[:fifo_compute], env[:machine])
+
+          @app.call(env)
+        end
+
+        def read_state(fifo, machine)
+          return :not_created if machine.id.nil?
+
+          # Find the machine
+          server = fifo.vms.get(machine.id)
+          if server.nil? || [:"shutting-down", :terminated].include?(server['state'].to_sym)
+            # The machine can't be found
+            @logger.info("Machine not found or terminated, assuming it got destroyed.")
+            machine.id = nil
+            return :not_created
+          end
+
+          # Return the state
+          return server['state'].to_sym
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-fifo/action/run_instance.rb

@@ -0,0 +1,113 @@
+require "log4r"
+require 'vagrant/util/retryable'
+require 'vagrant-fifo/util/timer'
+
+module VagrantPlugins
+  module Fifo
+    module Action
+
+      # This runs the configured instance.
+      class RunInstance
+        include Vagrant::Util::Retryable
+
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant_fifo::action::run_instance")
+        end
+
+        def wait_for_server(connection, server)
+          id = server["uuid"]
+          while true do
+            s = connection.vms.get(id)
+            break if s['state'] == "running"
+            print "."
+            sleep 10
+          end
+          sleep 10
+        end
+
+        def call(env)
+          # Initialize metrics if they haven't been
+          env[:metrics] ||= {}
+
+          # Get the configs
+          dataset = env[:machine].provider_config.dataset
+          package = env[:machine].provider_config.package
+          iprange = env[:machine].provider_config.iprange
+          node_name = env[:machine].provider_config.node_name || env[:machine].name
+
+          # Launch!
+          env[:ui].info(I18n.t("vagrant_fifo.launching_instance"))
+          env[:ui].info(" -- Package: #{package}")
+          env[:ui].info(" -- Dataset: #{dataset}")
+          env[:ui].info(" -- IPrange: #{iprange}")
+          env[:ui].info(" -- Node name: #{node_name}")
+
+          options = {
+            dataset: env[:fifo_compute].datasets.get_by_name(dataset).last['dataset'],
+            package: env[:fifo_compute].packages.get_by_name(package).first['uuid'],
+            config: {
+              alias: node_name,
+              resolvers: [ "8.8.8.8" ],
+              ssh_keys: env[:fifo_compute].ssh_keys,
+              networks: {
+                net0: env[:fifo_compute].ipranges.get_by_name(iprange).first['uuid']
+              }
+            }
+          }
+
+          server = env[:fifo_compute].vms.create(options)
+
+          # Immediately save the ID since it is created at this point.
+          env[:machine].id = server["uuid"]
+
+          wait_for_server(env[:fifo_compute], server)
+
+          if !env[:interrupted]
+            env[:metrics]["instance_ssh_time"] = Util::Timer.time do
+              # Wait for SSH to be ready.
+              env[:ui].info(I18n.t("vagrant_fifo.waiting_for_ssh"))
+              while true
+                # If we're interrupted then just back
+                # out
+                break if env[:interrupted]
+                break if env[:machine].communicate.ready?
+                puts "sleeping"
+                sleep 2
+              end
+            end
+
+            @logger.info("Time for SSH ready: #{env[:metrics]["instance_ssh_time"]}")
+
+            # Ready and booted!
+            env[:ui].info(I18n.t("vagrant_fifo.ready"))
+          end
+
+          # Terminate the instance if we were interrupted
+          terminate(env) if env[:interrupted]
+
+          @app.call(env)
+        end
+
+        def recover(env)
+          return if env["vagrant.error"].is_a?(Vagrant::Errors::VagrantError)
+
+          if env[:machine].provider.state.id != :not_created
+            # Undo the import
+            terminate(env)
+          end
+        end
+
+        def terminate(env)
+          destroy_env = env.dup
+          destroy_env.delete(:interrupted)
+          destroy_env[:config_validate] = false
+          destroy_env[:force_confirm_destroy] = true
+          env[:action_runner].run(Action.action_destroy, destroy_env)
+        end
+      end
+    end
+  end
+end
+
+