kitchen-opennebula 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4aa2f07facce9d15588344222e675ad9ecb5fe9f
+  data.tar.gz: 5ec519944e3a5ff31aeb1964287a1b3d6ae67734
+SHA512:
+  metadata.gz: ad95628a34b8415e54cc0b0f7e8a12757c4392631fca308e758322b055e64a00bf5f3c389d6d94ff2820a83dfd7041e627a2938c7b0911556ccedd4b6f222116
+  data.tar.gz: 9b91c666fce2d0da921c83c75c98f40e61d448657c6fad7d2d2937e6c78401f8d225639d2c1e9afe3b85744d2f71bd0e1130bbb2e563665c1a8caf0abb444a39

data/.gitignore

@@ -0,0 +1 @@
+.project

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0 / Unreleased
+
+* Initial release

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,15 @@
+Author:: Andrew J. Brown (<anbrown@blackberry.com>)
+
+Copyright (C) 2014, BlackBerry, Ltd.
+
+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,157 @@
+# <a name="title"></a> Kitchen::Opennebula
+
+A Test Kitchen Driver for Opennebula.
+
+## <a name="requirements"></a> Requirements
+
+This driver depends on BlackBerry patches to Fog (https://github.com/fog/fog)
+for better support for OpenNebula.  These patches can be found at
+https://github.com/blackberry/fog until they are merged to upstream.
+
+## <a name="installation"></a> Installation and Setup
+
+Please read the [Driver usage][driver_usage] page for more details.
+
+## Virtual Machine Requirements
+
+This driver requires an OpenNebula OS image that conforms to a number of requirements
+
+* The VM puts the ssh key defined in the SSH\_PUBLIC\_KEY context variable into `$HOME/.ssh/authorized_keys`
+* The VM ensures the user has passwordless sudo access
+
+## <a name="config"></a> Configuration
+
+### <a name="opennebula_endpoint"></a> opennebula\_endpoint
+
+URL where the OpenNebula daemon is listening.  
+The default value is taken from the ONE\_XMLRPC environment variable, or `http://127.0.0.1:2633/RPC2` if unset.
+
+### <a name="oneauth_file"></a> oneauth\_file
+
+Path to the file containing OpenNebula authentication information.  It should contain a single line stating "username:password".
+The default value is taken from the ONE\_AUTH environment variable, or `$HOME/.one/one_auth` if unset.
+
+### <a name="template_name"></a> template\_name
+
+Name of the VM definition file (OpenNebula template) registered with OpenNebula.  Can be used with `template_uname` or `template_uid` to further restrict which template to use if multiple users have the same template name.  Only one of `template_name` or `template_id` must be specified in the .kitchen.yml file.
+The default value is unset, or `nil`.
+
+### <a name="template_id"></a> template\_id
+
+ID of the VM definition file (OpenNebula template) registered with OpenNebula.  Only one of `template_name` or `template_id` must be specified in the .kitchen.yml file.
+The default value is unset, or `nil`.
+
+### <a name="template_uname"></a> template\_uname
+
+Username who owns the VM definition file (OpenNebula template).  Can be used with `template_name` to address naming conflicts where multiple users have the same template name.
+The default value is unset, or `nil`.
+
+### <a name="template_uid"></a> template\_uid
+
+UID of the user who owns the VM definition file (OpenNebula template).  Can be used with `template_name` to address naming conflicts where multiple users have the same template name.
+The default value is unset, or `nil`.
+
+### <a name="vm_hostname"></a> vm\_hostname
+
+Hostname to set for the newly created VM.
+The default value is `driver.instance.name`
+
+### <a name="public_key_path"></a> public\_key\_path
+
+Path to SSH public key to pass to the VM, to use to authenticate with `username` when logging in or converging a node.
+The default value is `~/.ssh/id_rsa.pub`, `~/.ssh/id_dsa.pub`, `~/.ssh/identity.pub`, or `~/.ssh/id_ecdsa.pub`, whichever is present on the filesystem.
+
+### <a name="username"></a> username
+
+This is the username used for SSH authentication to the new VM.
+The default value is `local`.
+
+### <a name="memory"></a> memory
+
+The amount of memory to provision for the new VM.  This parameter will override the memory settings provided in the VM template.
+The default value is 512MB.
+
+### <a name="user_variables"></a> user\_variables
+
+A hash of variables to pass into the "user template" section of the VM, to customize the virtual machine.
+The default value is `{}`.
+
+### <a name="context_variables"></a> context\_variables
+
+A hash of variables to pass into the "CONTEXT" section of the VM, to further customize the virtual machine.  These variables override any existing context variables that are provided as part of the specified VM template.
+The default value is `{}`.
+
+### <a name="config-require-chef-omnibus"></a> require\_chef\_omnibus
+
+Determines whether or not a Chef [Omnibus package][chef_omnibus_dl] will be
+installed. There are several different behaviors available:
+
+* `true` - the latest release will be installed. Subsequent converges
+  will skip re-installing if chef is present.
+* `latest` - the latest release will be installed. Subsequent converges
+  will always re-install even if chef is present.
+* `<VERSION_STRING>` (ex: `10.24.0`) - the desired version string will
+  be passed the the install.sh script. Subsequent converges will skip if
+  the installed version and the desired version match.
+* `false` or `nil` - no chef is installed.
+
+The default value is unset, or `nil`.
+
+### <a name="wait_for"></a> wait_for
+
+This variable is used to override timeout for Fog's common `wait_for` method which states that it "takes a block and waits for either the block to return true for the object or for a timeout (defaults to 10 minutes)".
+
+### <a name="no_ssh_tcp_check"></a> no\_ssh\_tcp\_check
+
+To avoid test-kitchen's ssh tcp check in the create phase you can set `no_ssh_tcp_check` to `true` and do single sleep instead. Sleep period is configured by `no_ssh_tcp_check_sleep`. The default for `no_ssh_tcp_check` is set to `false`.
+
+### <a name="no_ssh_tcp_check_sleep"></a> no\_ssh\_tcp\_check\_sleep
+
+This variable configures a single sleep used when `no_ssh_tcp_check` is set to `true`. The default for `no_ssh_tcp_check` is 2 minutes.
+
+### <a name="no_passwordless_sudo_check"></a> no\_passwordless\_sudo\_check
+
+To avoid test-kitchen's passwordless sudo check in the create phase you can set `no_passwordless_sudo_check` to `true` and do single sleep instead. Sleep period is configured by `no_passwordless_sudo_sleep`. The default for `no_passwordless_sudo_check` is set to `false`.
+
+### <a name="no_passwordless_sudo_sleep"></a> no\_passwordless\_sudo\_sleep
+
+This variable configures a single sleep used when `no_passwordless_sudo_check` is set to `true`. The default for `no_passwordless_sudo_sleep` is 2 minutes.
+
+### <a name="passwordless_sudo_timeout"></a> passwordless\_sudo\_timeout
+
+This variable configures the max timeout will wait in the create phase for passwordless sudo to be setup. The variable is used when `no_passwordless_sudo_check` is set to `false`. The default for `passwordless_sudo_timeout` is 5 minutes.
+
+### <a name="passwordless_sudo_retry_interval"></a> passwordless\_sudo\_retry\_interval
+
+This variable configures retry interval in the create phase to periodically check that passwordless sudo is setup. It does this until max timeout (set by `passwordless_sudo_timeout`) is reached. The variable is used when `no_passwordless_sudo_check` is set to `false`. The default for `passwordless_sudo_retry_interval` is 10 seconds.
+
+## <a name="development"></a> Development
+
+* Source hosted at [GitHub][repo]
+* Report issues/questions/feature requests on [GitHub Issues][issues]
+
+Pull requests are very welcome! Make sure your patches are well tested.
+Ideally create a topic branch for every separate change you make. For
+example:
+
+1. Fork the repo
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## <a name="authors"></a> Authors
+
+Created and maintained by [Andrew Brown][author] (<anbrown@blackberry.com>)
+
+## <a name="license"></a> License
+
+Apache 2.0 (see [LICENSE][license])
+
+
+[author]:           https://github.com/andrewjamesbrown
+[issues]:           https://github.com/test-kitchen/kitchen-opennebula/issues
+[license]:          https://github.com/test-kitchen/kitchen-opennebula/blob/master/LICENSE
+[repo]:             https://github.com/test-kitchen/kitchen-opennebula
+[driver_usage]:     http://docs.kitchen-ci.org/drivers/usage
+[chef_omnibus_dl]:  http://www.getchef.com/chef/install/

data/Rakefile

@@ -0,0 +1,21 @@
+require "bundler/gem_tasks"
+require 'cane/rake_task'
+require 'tailor/rake_task'
+
+desc "Run cane to check quality metrics"
+Cane::RakeTask.new do |cane|
+  cane.canefile = './.cane'
+end
+
+Tailor::RakeTask.new
+
+desc "Display LOC stats"
+task :stats do
+  puts "\n## Production Code Stats"
+  sh "countloc -r lib"
+end
+
+desc "Run all quality tasks"
+task :quality => [:cane, :tailor, :stats]
+
+task :default => [:quality]

data/kitchen-opennebula.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kitchen/driver/opennebula_version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'kitchen-opennebula'
+  spec.version       = Kitchen::Driver::OPENNEBULA_VERSION
+  spec.authors       = ['Andrew J. Brown']
+  spec.email         = ['anbrown@blackberry.com']
+  spec.description   = %q{A Test Kitchen Driver for Opennebula}
+  spec.summary       = spec.description
+  spec.homepage      = ''
+  spec.license       = 'Apache 2.0'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = []
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'test-kitchen', '~> 1.2'
+  spec.add_dependency 'fog', '~> 1.26'
+  spec.add_dependency 'opennebula'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+
+  spec.add_development_dependency 'cane'
+  spec.add_development_dependency 'tailor'
+  spec.add_development_dependency 'countloc'
+end

data/lib/kitchen/driver/opennebula.rb

@@ -0,0 +1,189 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Andrew J. Brown (<anbrown@blackberry.com>)
+#
+# Copyright (C) 2014, BlackBerry, Ltd.
+#
+# 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.
+
+require 'fog'
+require 'kitchen'
+
+module Kitchen
+
+  module Driver
+
+    # Opennebula driver for Kitchen.
+    #
+    # @author Andrew J. Brown <anbrown@blackberry.com>
+    class Opennebula < Kitchen::Driver::SSHBase
+      default_config :opennebula_endpoint,
+        ENV.fetch('ONE_XMLRPC', 'http://127.0.0.1:2633/RPC2')
+
+      default_config :oneauth_file,
+        ENV.fetch('ONE_AUTH', "#{ENV['HOME']}/.one/one_auth")
+
+      default_config :vm_hostname do |driver|
+        "#{driver.instance.name}"
+      end
+
+      default_config :public_key_path do
+        [
+          File.expand_path('~/.ssh/id_rsa.pub'),
+          File.expand_path('~/.ssh/id_dsa.pub'),
+          File.expand_path('~/.ssh/identity.pub'),
+          File.expand_path('~/.ssh/id_ecdsa.pub')
+        ].find { |path| File.exist?(path) }
+      end
+
+      default_config :username, 'local'
+      default_config :memory, 512
+      default_config :user_variables, { }
+      default_config :context_variables, { }
+
+      default_config :wait_for, 600
+      default_config :no_ssh_tcp_check, false
+      default_config :no_ssh_tcp_check_sleep, 120
+      default_config :no_passwordless_sudo_check, false
+      default_config :no_passwordless_sudo_sleep, 120
+      
+      def initialize(config)
+        super
+        Fog.timeout = config[:wait_for].to_i
+      end
+
+      def create(state)
+        conn = opennebula_connect
+
+        # Check if VM is already created.
+        if state[:vm_id] && !conn.list_vms({:id => state[:vm_id]}).empty?
+          info("OpenNebula instance #{instance.to_str} already created.")
+          return
+        end
+   
+        if config[:template_id].nil? and config[:template_name].nil? 
+          raise "template_name or template_id not specified in .kitchen.yml"
+        elsif !config[:template_id].nil? and !config[:template_name].nil?
+          raise "Only one of template_name or template_id should be specified in .kitchen.yml"
+        end
+
+        newvm = conn.servers.new
+        if config[:template_id]
+          newvm.flavor = conn.flavors.get config[:template_id]
+        elsif config[:template_name]
+          filter = {
+            :name  => config[:template_name],
+            :uname => config[:template_uname],
+            :uid   => config[:template_uid]
+          }
+          newvm.flavor = conn.flavors.get_by_filter filter
+          if !newvm.flavor.nil? and newvm.flavor.length > 1
+            raise 'More than one template found.  Please restrict using template_uname'
+          end
+          newvm.flavor = newvm.flavor.first unless newvm.flavor.nil?
+        end
+        if newvm.flavor.nil?
+          raise "Could not find template to create VM."
+        end
+        newvm.name = config[:vm_hostname]
+        
+        newvm.flavor.user_variables = {} if newvm.flavor.user_variables.nil? || newvm.flavor.user_variables.empty?
+        config[:user_variables].each do |key, val|
+          newvm.flavor.user_variables[key.to_s] = val
+        end
+        
+        newvm.flavor.context = {} if newvm.flavor.context.nil? || newvm.flavor.context.empty?
+        newvm.flavor.context['SSH_PUBLIC_KEY'] = File.read(config[:public_key_path]).chomp
+        newvm.flavor.context['TEST_KITCHEN'] = "YES"
+        # Support for overriding context variables in the VM template
+        config[:context_variables].each do |key, val|
+          newvm.flavor.context[key.to_s] = val
+        end
+        newvm.flavor.memory = config[:memory]
+       
+        # TODO: Set up NIC and disk if not specified in template
+        vm = newvm.save
+        vm.wait_for { ready? }
+        state[:vm_id] = vm.id
+        state[:hostname] = vm.ip
+        state[:username] = config[:username]
+        tcp_check(state)
+        passwordless_sudo_check(state)
+        info("OpenNebula instance #{instance.to_str} created.")
+      end
+
+      def tcp_check(state)
+        wait_for_sshd(state[:hostname]) unless config[:no_ssh_tcp_check]
+        sleep(config[:no_ssh_tcp_check_sleep]) if config[:no_ssh_tcp_check]
+        debug("SSH ready on #{instance.to_str}")
+      end
+      
+      def passwordless_sudo_check(state)
+        wait_for_passwordless_sudo(state) unless config[:no_passwordless_sudo_check]
+        sleep(config[:no_passwordless_sudo_sleep]) if config[:no_passwordless_sudo_check]
+        debug("Passwordless sudo ready on #{instance.to_str}")
+      end
+      
+      def wait_for_passwordless_sudo(state)
+        Kitchen::SSH.new(*build_ssh_args(state)) do |conn|
+          retries = config[:passwordless_sudo_timeout] || 300
+          retry_interval = config[:passwordless_sudo_retry_interval] || 10
+          begin
+            logger.info("Waiting #{retries.to_s} seconds for #{config[:username]} user to be granted passwordless sudo on #{state[:hostname]}...")
+            retries -= retry_interval
+            run_remote("sudo -n true", conn)
+          rescue ActionFailed => e
+            if (e.message.eql? "SSH exited (1) for command: [sudo -n true]") && (retries >= 0)
+              sleep retry_interval
+              retry
+            end
+            raise ActionFailed, e.message
+          end        
+        end
+      end
+      
+      def converge(state)
+        super
+      end
+
+      def verify(state)
+        super
+      end
+
+      def destroy(state)
+        conn = opennebula_connect
+        conn.servers.destroy(state[:vm_id])
+      end
+
+      protected
+
+      def opennebula_connect()        
+        opennebula_creds = nil
+        if File.exists?(config[:oneauth_file])
+          opennebula_creds = File.read(config[:oneauth_file])
+        else
+          raise ActionFailed, "Could not find one_auth file #{config[:oneauth_file]}"
+        end
+        opennebula_username = opennebula_creds.split(':')[0]
+        opennebula_password = opennebula_creds.split(':')[1]
+        conn = Fog::Compute.new( {
+          :provider => 'OpenNebula',
+          :opennebula_username => opennebula_username,
+          :opennebula_password => opennebula_password,
+          :opennebula_endpoint => config[:opennebula_endpoint]
+        } )
+        conn
+      end
+    end
+  end
+end

data/lib/kitchen/driver/opennebula_version.rb

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Andrew Brown (<anbrown@blackberry.com>)
+#
+# Copyright (C) 2014, BlackBerry, Ltd.
+#
+# 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.
+
+module Kitchen
+
+  module Driver
+
+    # Version string for Opennebula Kitchen driver
+    OPENNEBULA_VERSION = "0.1.1"
+  end
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: kitchen-opennebula
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Andrew J. Brown
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-kitchen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: fog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.26'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.26'
+- !ruby/object:Gem::Dependency
+  name: opennebula
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tailor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: countloc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Test Kitchen Driver for Opennebula
+email:
+- anbrown@blackberry.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- kitchen-opennebula.gemspec
+- lib/kitchen/driver/opennebula.rb
+- lib/kitchen/driver/opennebula_version.rb
+homepage: ''
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: A Test Kitchen Driver for Opennebula
+test_files: []
+has_rdoc: