vagrant_filoo 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c9b0385a665c31b877a060d18231e12bc264b1a9
+  data.tar.gz: 5d9de96e77ef02d20f5736c816099d10ee669bd0
+SHA512:
+  metadata.gz: 61964f5d18997c8ecd44ea7d4c7e53c325e8cdec0506dcdeeef55d028d5a6d7fd7c4d87771a8a71806dde8ac8356cc49c2f7fefb5f91f45f7967d6c71dbb35bd
+  data.tar.gz: f5e5a0125cddf965b1ba302e1fed58cc74027a009ca09c1000cdf2ef56634d6e0d494ceaa4a9ddc34be21d3221416e2ef3f2058af5f787fafccccc21d452ac0c

data/.gitignore

@@ -0,0 +1,61 @@
+*.gem
+*.rbc
+.bundle
+.bundle
+pkg/*
+tags
+Gemfile.lock
+
+.buildpath
+.project
+
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+# RVM files for gemset/ruby setting
+.ruby-*
+.rvmrc
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea
+
+# Vagrant
+.vagrant
+Vagrantfile
+!example_box/Vagrantfile

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  # We depend on Vagrant for development, but we don't add it as a
+  # gem dependency because we expect to be installed within the
+  # Vagrant environment itself using `vagrant plugin`.
+  gem "vagrant", :git => "https://github.com/mitchellh/vagrant.git"
+end
+
+group :plugins do
+  gem 'vagrant_filoo', path: "."
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Huf Secure Mobile
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,207 @@
+# vagrant_filoo 0.0.2
+Vagrant filoo provisioner
+
+This is a Vagrant 1.7x plugin that adds an  provider for filoo hosting to Vagrant, allowing Vagrant to control and provision machines within the filoo public and private cloud.
+
+
+![htps://www.filoo.de/vserver.html](/doc/img_res/filoo_logo.png?raw=true )
+
+htps://www.filoo.de/vserver.html
+
+**NOTE:** This plugin requires Vagrant 1.7x
+
+#TODO
+- set servername 4.1.16 vserver/setcustomname
+- Publish to public gem repository
+
+## Usage
+
+Install using standard Vagrant 1.1+ plugin installation methods. After installing, `vagrant up` and specify the `filoo` provider. An example is shown below. dummy
+
+```
+$ vagrant plugin install vagrant-filoo
+...
+$ vagrant up --provider=filoo
+...
+```
+
+Of course prior to doing this, you'll need to obtain an Filoo-compatible box file for Vagrant.
+
+## Quick Start
+
+After installing the plugin (instructions above), the quickest way to get started is to actually use a dummy Filoo box and specify all the details manually within a `config.vm.provider` block. So first, add the dummy box using any name you want:
+
+```
+$ vagrant box add filoo <url to filoo box>
+...
+```
+
+And then make a Vagrantfile that looks like the following, filling in your information where necessary.
+
+It is good practice to access the filoo api key via system environment variable. To use environment variable FILOO_API_KEY add following line in the Vagrantfile
+```
+filoo.filoo_api_key = ENV['FILOO_API_KEY']
+```
+
+as seen in the commented line of config beneath.
+
+```
+Vagrant.configure("2") do |config|
+  config.vm.box = "filoo"
+
+  config.vm.provider :filoo do |filoo, override|
+   filoo.filoo_api_key = "your filoo api access key"
+   # or to use environment variable uncomment this
+   #filoo.filoo_api_key = ENV['FILOO_API_KEY']
+
+   filoo.filoo_api_entry_point = "https://api.filoo.de/api/v1"
+   filoo.cd_image_name = "Debian 7.7 - 64bit"
+   filoo.type =  "dynamic"
+   filoo.cpu = 1
+   filoo.ram = 128
+   filoo.hdd = 10
+   filoo.additional_nic = true # defaults to false
+  end
+end
+```
+
+And then run 'vagrant up --provider=filoo'.
+
+This will start an Debian 6.0 - 64bit instance in the Filoo infrastructure
+
+Note that normally a lot of this boilerplate is encoded within the box
+file, but the box file used for the quick start, the "dummy" box, has
+no preconfigured defaults.
+
+
+## Box Format
+
+Every provider in Vagrant must introduce a custom box format. This
+provider introduces `filoo` boxes. You can view an example box in
+the [example_box/ directory](<path to repository>/example_box).
+That directory also contains instructions on how to build a box.
+
+The box format is basically just the required `metadata.json` file
+along with a `Vagrantfile` that does default settings for the
+provider-specific configuration for this provider.
+
+## Configuration
+
+This provider exposes quite a few provider-specific configuration options:
+
+* `filoo_api_key` - The api key for accessing Filoo
+* `cd_image_name` - The Filoo omage name to boot, such as ""Debian 6.0 - 64bit"
+* `filoo_api_entry_point` - The base url to the api "https://api.filoo.de/api/v1"
+
+These can be set like typical provider-specific configuration:
+
+```ruby
+Vagrant.configure("2") do |config|
+  # ... other stuff
+
+  config.vm.provider :filoo do |filoo|
+    filoo.filoo_api_key = "foo"
+    filoo.filoo_api_entry_point = "bar"
+    filoo.cd_image_name = "foo-bar"
+  end
+end
+```
+
+## Networks
+
+Networking features in the form of `config.vm.network` are not
+supported with `vagrant-filoo`, currently. If any of these are
+specified, Vagrant will emit a warning, but will otherwise boot
+the filoo machine.
+
+## Synced Folders
+
+Shared folders are not supported at the current state.
+
+Linux and Windows clients optionally can use sshfs to mount a folder on the network or to connect a network drive. While the Linux implementation via fuse is quite stable the windows variant is not. We have successfully  tested under Windows 7. Under Windows the re-connect after a network cut-off sometimes fails.
+
+General Information: https://de.wikipedia.org/wiki/SSHFS
+Windows build: https://code.google.com/p/win-sshfs/
+
+See [Vagrant Synced folders: rsync](https://docs.vagrantup.com/v2/synced-folders/rsync.html)
+
+
+## Other Examples
+
+
+
+## Development
+
+The easiest way to setup the environment is to install ruby with the Rails Installer (http://railsinstaller.org). Also you have to install vagrant on your machine to develop the plugin
+
+To work on the `vagrant-filoo` plugin, clone this repository out, and use
+[Bundler](http://gembundler.com) to get the dependencies:
+
+or run from your "command prompt with ruby and rails"
+
+```
+$ gem install bundler
+```
+
+in the project folder run from your "command prompt with ruby and rails"
+
+```
+$ bundle
+```
+
+If you get an ssl error follow instructions on https://gist.github.com/luislavena/f064211759ee0f806c88
+
+Once you have the dependencies, verify the unit tests pass with `rake`:
+
+```
+$ bundle exec rake
+```
+
+If those pass, you're ready to start developing the plugin. You can test
+the plugin without installing it into your Vagrant environment by just
+creating a `Vagrantfile` in the top level of this directory (it is gitignored)
+and add the following line to your `Vagrantfile`
+```ruby
+Vagrant.require_plugin "vagrant_filoo"
+```
+
+create a box
+
+```
+$ cd example_box
+$ tar cvzf filoo.box ./metadata.json ./Vagrantfile
+$ mv filoo.box ../filoo.box
+$ cd ..
+```
+
+Use vagrant to add the box
+
+```
+$ vagrant box add filoo.box
+```
+
+Copy the example Vagrantfile
+
+```
+cp example_config/Vagrantfile_example Vagrantfile
+```
+
+Edit your filoo api key in Vagrantfile or access Api Key via Environment Variable
+
+```
+    filoo.filoo_api_key = "your filoo api access key"
+    # or to use environment variable uncomment this
+    #filoo.filoo_api_key = ENV['FILOO_API_KEY']
+```
+
+Use bundler to execute Vagrant:
+```
+$ bundle exec vagrant up --provider=filoo
+```
+
+Package and publish the plugin (see https://www.noppanit.com/create-simple-vagrant-plugin/)
+
+```
+$ rake build
+$ gem push pkg/vagrant_filoo-0.0.1.gem
+```

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rubygems'
+require 'bundler/setup'
+Bundler::GemHelper.install_tasks
+

data/example_box/README.md

@@ -0,0 +1,13 @@
+# Vagrant FILOO Example Box
+
+Vagrant providers each require a custom provider-specific box format.
+This folder shows the example contents of a box for the `filoo` provider.
+To turn this into a box:
+
+```
+$ tar cvzf filoo.box ./metadata.json ./Vagrantfile
+```
+
+This box works by using Vagrant's built-in Vagrantfile merging to setup
+defaults for Filoo. 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": "filoo"
+}

data/lib/vagrant_filoo/action/create_server.rb

@@ -0,0 +1,51 @@
+require_relative "../cloud_compute"
+require_relative '../errors'
+require 'vagrant_filoo/util/timer'
+
+module VagrantPlugins
+  module Filoo
+    module Action
+      class CreateServer
+        def initialize(app, env)
+          @app    = app
+          @baseUrl =env[:machine].provider_config.filoo_api_entry_point
+          @apiKey = env[:machine].provider_config.filoo_api_key
+        end
+        
+        def call(env)
+
+          if (env[:images].nil?)
+            raise Errors::ImagesNotLoaded
+          end
+          config  = env[:machine].provider_config
+          if env[:images][config.cd_image_name].nil?
+            raise VagrantPlugins::Filoo::Errors::ConfigError, 
+              message: "Filoo Configuration parameter 'cd_image_name' with value #{config.cd_image_name} references not a filoo image that has autoinstall flag set. Please use one of the folowing image names #{env[:images].keys.join(' | ')}"
+          end
+
+          imageId = "#{env[:images][config.cd_image_name]}".to_i
+
+          params = {
+            :type => config.type,
+            :cpu => config.cpu,
+            :ram => config.ram,
+            :hdd => config.hdd,
+            :cd_imageid => imageId
+          }
+
+          env[:ui].info("vagrant_filoo creating_instance")
+          env[:ui].info(" -- Type: #{config.type}")
+          env[:ui].info(" -- CPUs: #{config.cpu}")
+          env[:ui].info(" -- Ram: #{config.ram}")
+          env[:ui].info(" -- Image Id: #{imageId}")
+          env[:ui].info(" -- Image Name: #{config.cd_image_name}")
+          env[:result] = VagrantPlugins::Filoo::CloudCompute::createServer(params, @baseUrl, @apiKey)
+          env[:machine].id = env[:result]["vmid"]
+          #env[:machine].name  = env[:result]["custom_vmname"]
+          env[:ui].info(" -- Server created, server state #{env[:result]}")      
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant_filoo/action/get_images.rb

@@ -0,0 +1,21 @@
+require_relative '../errors'
+
+module VagrantPlugins
+  module Filoo
+    module Action
+      class GetImages
+
+        def initialize(app, env)
+          @app    = app
+          @baseUrl =env[:machine].provider_config.filoo_api_entry_point()
+          @apiKey = env[:machine].provider_config.filoo_api_key()
+        end
+        def call(env)
+          env[:images]= VagrantPlugins::Filoo::CloudCompute::getAutoInstallImages(@baseUrl, @apiKey)
+          env[:result] = env[:images]
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant_filoo/action/is_created.rb

@@ -0,0 +1,22 @@
+module VagrantPlugins
+  module Filoo
+    module Action
+      class IsCreated
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:result] = true
+          if env[:machine].state.id == :not_created
+            env[:result] = false
+          end
+          if env[:machine].state.id == :deleted
+            env[:result] = false
+          end
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant_filoo/action/is_stopped.rb

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

data/lib/vagrant_filoo/action/message_already_created.rb

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

data/lib/vagrant_filoo/action/message_not_created.rb

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

data/lib/vagrant_filoo/action/read_ssh_info.rb

@@ -0,0 +1,40 @@
+require 'json'
+require_relative "../cloud_compute"
+
+
+module VagrantPlugins
+  module Filoo
+    module Action
+      class ReadSSHInfo
+        def initialize(app, env)
+          @app    = app
+          @baseUrl =env[:machine].provider_config.filoo_api_entry_point()
+          @apiKey = env[:machine].provider_config.filoo_api_key()
+        end
+        def call(env)
+          vmid = vmid = env[:machine].id
+          serverStatus = VagrantPlugins::Filoo::CloudCompute::getServerStatus(vmid, @baseUrl, @apiKey)
+          if serverStatus["network_settings"].nil?
+            raise VagrantPlugins::Filoo::Errors::UnexpectedStateError,
+              resource: VagrantPlugins::Filoo::CloudCompute::SERVERSTATUS_RESOURCE,
+              state: serverStatus,
+              message: "Unexpected State of server status " + serverList.to_json,
+              description: "Server with vmid #{vmid} should have server status with field network_settings present"
+          end
+          
+          if serverStatus["network_settings"].length < 1 or serverStatus["network_settings"][0]["ipadress"].nil?
+            raise VagrantPlugins::Filoo::Errors::UnexpectedStateError,
+                   resource: VagrantPlugins::Filoo::CloudCompute::SERVERSTATUS_RESOURCE,
+                   state: serverStatus,
+            description: "Server with vmid #{vmid} should have server status with subfield field ipadress network_settings present"
+          end
+          env[:machine_ssh_info] = { :host => serverStatus["network_settings"][0]["ipadress"], 
+            :port => 22 , 
+            :username => "root"
+            }
+          @app.call(env)
+        end
+      end
+    end
+end
+end

data/lib/vagrant_filoo/action/read_state.rb

@@ -0,0 +1,65 @@
+require_relative "../cloud_compute"
+require "vagrant/machine_state"
+require 'json'
+
+module VagrantPlugins
+  module Filoo
+    module Action
+      class  ReadState
+        include VagrantPlugins::Filoo::CloudCompute
+        SERVERSTATUS_RESOURCE = '/vserver/status'
+        def initialize(app, env)
+          @app    = app
+          @baseUrl ="#{env[:machine].provider_config.filoo_api_entry_point}"
+          @apiKey = env[:machine].provider_config.filoo_api_key()
+        end
+        
+        def call(env)
+          if env[:machine].nil? or env[:machine].id.nil?
+            env[:machine_state_id] = :not_created
+          else   
+            vmid = env[:machine].id
+            begin
+              serverStatus = VagrantPlugins::Filoo::CloudCompute::getServerStatus(vmid, @baseUrl, @apiKey)
+              env[:machine_state_id] = machineStateIdFromState(serverStatus)
+            rescue VagrantPlugins::Filoo::Errors::FilooApiError => e
+              errorCode = nil;
+              begin
+                errorCode = JSON.parse(e.message)["code"]
+              rescue JSON::ParserError => jsonErr
+                raise e
+              end
+              if  errorCode == 403
+                env[:machine_state_id] = :not_created
+              else
+                raise e
+              end
+              en
+            end
+          end
+         @app.call(env)
+        end
+        
+        def machineStateIdFromState(serverStatus)
+          case serverStatus["vmstatus"]
+          when "running"
+            return :running
+          when "stopped"
+            return :stopped
+          when "processing_autoinstall"
+            return :processing_autoinstall
+          when "disabled"
+            return :disabled
+          when "activated"
+            return :activated
+          when "deleted"
+            return :deleted
+          when "unknown"
+            return :unknown
+          end
+        end
+        
+      end
+    end
+  end
+end

data/lib/vagrant_filoo/action/start_instance.rb

@@ -0,0 +1,48 @@
+require "log4r"
+require_relative "../cloud_compute"
+require 'vagrant_filoo/util/timer'
+
+module VagrantPlugins
+  module Filoo
+    module Action
+      class StartInstance
+        include VagrantPlugins::Filoo::CloudCompute
+        
+        def initialize(app, env)
+          @app    = app
+          @baseUrl =env[:machine].provider_config.filoo_api_entry_point
+          @apiKey = env[:machine].provider_config.filoo_api_key
+          @filooConfig = env[:machine].provider_config
+          @logger = Log4r::Logger.new("vagrant_filoo::action::start_instance")
+        end
+
+        def call(env)
+          env[:metrics] ||= {}
+          vmid = env[:machine].id
+          env[:result] = VagrantPlugins::Filoo::CloudCompute::startInstance(vmid, @baseUrl, @apiKey, @filooConfig) 
+          env[:ui].info("Machine #{vmid} successfully started, state #{env[:result].to_json}")
+          @logger.info("Time to instance ready: #{env[:metrics]["instance_ready_time"]}")
+
+          if !env[:interrupted]
+            env[:metrics]["instance_ssh_time"] = Util::Timer.time do
+              # Wait for SSH to be ready.
+              env[:ui].info(I18n.t("vagrant_filoo.waiting_for_ssh"))
+              while true
+                # If we're interrupted then just back out
+                break if env[:interrupted]
+                break if env[:machine].communicate.ready?
+                sleep 2
+              end
+            end
+
+            @logger.info("Time for SSH ready: #{env[:metrics]["instance_ssh_time"]}")
+
+            # Ready and booted!
+            env[:ui].info(I18n.t("vagrant_filoo.ready"))
+          end
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant_filoo/action/stop_instance.rb

@@ -0,0 +1,31 @@
+require_relative "../cloud_compute"
+
+module VagrantPlugins
+  module Filoo
+    module Action
+      # This starts a stopped instance.
+      class StopInstance
+        STOP_RESOURCE = "/vserver/stop"
+        STOP_INSTANCE_TIMEOUT = 60
+        def initialize(app, env)
+          @app    = app
+          @baseUrl =env[:machine].provider_config.filoo_api_entry_point
+          @apiKey = env[:machine].provider_config.filoo_api_key
+        end
+
+        def call(env)
+          if env[:machine].state.id == :stopped
+            env[:ui].info(I18n.t("vagrant_filoo.already_status", :status => env[:machine].state.id))
+          else
+            vmid = env[:machine].id
+            env[:ui].info("Halt machine #{vmid}")
+            env[:result] = VagrantPlugins::Filoo::CloudCompute::stopInstance vmid, @baseUrl, @apiKey
+            env[:ui].info("Machine #{vmid} successfully halted, state #{env[:result].to_json}")
+          end      
+          @app.call(env)
+        end
+        
+      end
+    end
+  end
+end