kitchen-lxd 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66958532b083530043a7897ffca23ef14d1322a5
-  data.tar.gz: 42c74aec7000ea99bc219fe850a719f718198005
+  metadata.gz: bb8e8006b752908610c409c5d138e712fc11472c
+  data.tar.gz: a62b71d6d1504c16479809006124444918fb901e
 SHA512:
-  metadata.gz: 20ee77c76546f2cf7782951e42bc0cff1d7f15448403970967a915c13aa229281ed6ec2803d1b74ca3fea2aa926e9275007afebe759f340979b4dd15f9fd3232
-  data.tar.gz: 2e3a72ccb0c16b6ae775b6bf479e4973689d2f65502025b16d40ef1d76005a520acad5167d2453326004f32b1e30af65d230179d5e118a4efcfc520eb6348397
+  metadata.gz: f0e9d5a7a1fee40803833b21ddd7c4070abb9ad39fc3a152f3c834c94045e1e61f62c2ad0c3b1922877a05cf5028193dd466be668a010d73d82f7bf389a1d60b
+  data.tar.gz: d46312416e606f2ac76c0d57a2f49f2f5301d85a87cb5bb6307379e40868b1e664fb15dd737699fdab9bcc36ee605dba95292632c55a87b96a4453b4e5ddf8ea

data/CHANGELOG.md

@@ -1,7 +1,15 @@
-## 0.1.1
+## 0.2.0 (2017-10-11)
+
+- Add LXD transport.
+- Remove ssh transport support.
+- Allow specifying network bridge to attach to.
+- Allow specifying path to lxc executable.
+- Support downloading image from remote, if it's not available locally.
+
+## 0.1.1 (2017-02-08)
 
 - Support Lxd version 2.8.
 
-## 0.1.0
+## 0.1.0 (2017-02-07)
 
-- Initial release
+- Initial release.

data/README.md

@@ -1,21 +1,33 @@
-# <a name="title"></a> Kitchen::Lxd
+# Kitchen::Lxd
 
 [![Build Status](https://travis-ci.org/zeroturnaround/kitchen-lxd.svg?branch=master)](https://travis-ci.org/zeroturnaround/kitchen-lxd)
 
-A Test Kitchen Driver for Lxd.
+- [Requirements](#requirements)
+	- [Lxd](#lxd)
+- [Installation and Setup](#installation-and-setup)
+- [Configuration](#configuration)
+	- [Driver](#driver)
+	- [Transport](#transport)
+- [Development](#development)
+- [Authors](#authors)
+- [License](#license)
 
-## <a name="requirements"></a> Requirements
+A Test Kitchen Driver (with Transport) for Lxd.
+
+## Requirements
 
 ### Lxd
 
-Lxd version of 2.3 (the one where "lxc network" commands were introduced) or higher is required for
-this driver which means that a native package must be installed on the system running Test Kitchen.
-You must also prepare a container to be used by Test Kitchen. For that make sure there is ssh daemon
-installed and starting on boot. ( On Ubuntu it can be done by simply installing 'openssh-server'
-package. ) You can also install Chef Client there, if you do not want Test Kitchen to install it
-every time the container is started.
+Lxd version of 2.3 (the one where "lxc network" commands were introduced) or higher is required
+for this driver which means that a native package must be installed on the system running Test
+Kitchen.
+
+You do not have to prepare any container image specifically, like downloading it or installing ssh
+server. The driver will download container image automatically from the provided remote server,
+if it's not available locally. Also you can use `lxd` transport instead of default `ssh`. Which
+means files will be uploaded to container using `lxc file push` command.
 
-## <a name="installation"></a> Installation and Setup
+## Installation and Setup
 
 Install using command line:
 
@@ -23,74 +35,43 @@ Install using command line:
 gem install kitchen-lxd
 ```
 
-## <a name="config"></a> Configuration
-
-Available options:
-
-- image
-- container
-- require_chef_omnibus
-
-### image
+## Configuration
 
-Define from which lxd image the container will be created.
+Example config file may look like this:
 
 ```yaml
 ---
 driver:
-  image: ubuntu/xenial/amd64
-```
-
-The default is value of `platform name`.
-
-```yaml
----
-platforms:
-  - name: kitchen-xenial64
-```
-
-In this case: 'kitchen-xenial64', expecting to have an lxd image with this name locally.
-
-### container
+  name: lxd
+  binary: lxc # this is default
+  remote: images # this is default
+  network: lxdbr0 # this is default
 
-Created container name.
-
-```yaml
----
-driver:
-  container_name: my_name
+transport:
+  name: lxd
 ```
 
-The default is value of `kitchen instance name`.
+Default values can be omitted, so the minimal config file looks like this:
 
 ```yaml
 ---
-platforms:
-  - name: kitchen-xenial64
+driver: lxd
 
-suites:
-  - name: webserver
+transport: lxd
 ```
 
-In this case: 'webserver-kitchen-xenial64'.
-
-### <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:
+### Driver
 
-- `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.
+Available options:
 
-The default value is unset, or `nil`.
+Name | Description | Type | Default
+-----|-------------|------|--------
+binary | Path to lxc executable | String | `lxc`
+remote | Remote LXD server to download image from, if it does not exist locally | String | `images`
+network | Network bridge to attach to container | String | `lxdbr0`
+wait_until_ready | Wait for the network to come up | Boolean | `true`
 
-## <a name="development"></a> Development
+## Development
 
 - Source hosted at [GitHub][repo]
 - Report issues/questions/feature requests on [GitHub Issues][issues]
@@ -105,18 +86,15 @@ example:
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-## <a name="authors"></a> Authors
+## Authors
 
-Created and maintained by [ZeroTurnaround][author].
+Created and maintained by [Juri Timošin][author].
 
-## <a name="license"></a> License
+## License
 
 Apache 2.0 (see [LICENSE][license])
 
-
-[author]:           https://github.com/zeroturnaround
-[issues]:           https://github.com/zeroturnaround/kitchen-lxd/issues
-[license]:          https://github.com/zeroturnaround/kitchen-lxd/blob/master/LICENSE
-[repo]:             https://github.com/zeroturnaround/kitchen-lxd
-[driver_usage]:     http://docs.kitchen-ci.org/drivers/usage
-[chef_omnibus_dl]:  http://www.chef.io/chef/install/
+[author]:           https://github.com/DracoAter
+[issues]:           https://github.com/DracoAter/kitchen-lxd/issues
+[license]:          https://github.com/DracoAter/kitchen-lxd/blob/master/LICENSE
+[repo]:             https://github.com/DracoAter/kitchen-lxd

data/lib/kitchen/driver/lxd.rb

@@ -8,7 +8,7 @@
 # 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
+# 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,
@@ -25,21 +25,31 @@ module Kitchen
 		#
 		# @author Juri Timošin <draco.ater@gmail.com>
 		class Lxd < Kitchen::Driver::Base
+			MIN_LXD_VERSION = '2.3'
+
 			kitchen_driver_api_version 2
 
-			default_config( :image ){|driver| driver.instance.platform.name }
-			default_config( :container ){|driver| driver.instance.name }
+			default_config :binary, 'lxc'
+			default_config :remote, 'images'
+			default_config :network, 'lxdbr0'
+			default_config :wait_until_ready, true
+			default_config :fix_chef_install, false
 
-			attr_accessor :container
+			default_config :image do |driver|
+				driver.instance.platform.name
+			end
+
+			default_config :container do |driver|
+				driver.instance.name
+			end
 
 			def create( state )
 				container.init
-				container.attach_network 'lxdbr0'
+				container.attach_network config[:network] if config[:network]
 				container.start
-				container.prepare_ssh
 
-				state[:hostname] = container.wait_for_ipv4
-				instance.transport.connection( state ).wait_until_ready
+				state[:hostname] = instance.transport.connection( state ).wait_until_ready if config[:wait_until_ready]
+				container.fix_chef_install( instance.platform.name ) if config[:fix_chef_install]
 			end
 
 			def destroy( state )
@@ -48,10 +58,17 @@ module Kitchen
 				container.destroy
 			end
 
-			private
+			def verify_dependencies
+				return
+				version = run_command( "#{config[:binary]} --version" ).strip
+				if Gem::Version.new( version ) < Gem::Version.new( MIN_LXD_VERSION )
+					raise UserError, "Detected old version of Lxd (#{version}), please upgrade to version "\
+						"#{MIN_LXD_VERSION} or higher."
+				end
+			end
 
 			def container
-				@container = Lxd::Container.new( config[:container], config[:image], logger ) if @container.nil?
+				@container = Lxd::Container.new( logger, config ) if @container.nil?
 				@container
 			end
 		end

data/lib/kitchen/driver/lxd/container.rb

@@ -8,7 +8,7 @@
 # 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
+# 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,
@@ -29,77 +29,99 @@ module Kitchen
 				attr_reader :logger
 				attr_reader :state
 
-				def initialize( name, image, logger )
-					@name = name
-					@image = image
+				def initialize( logger, opts )
 					@logger = logger
-					update_state
+					@name = opts[:container]
+					@image = opts[:image]
+					@remote = opts[:remote]
+					@binary = opts[:binary]
 				end
 
 				def init
-					unless created?
-						run_command "lxc init #@image #@name"
-						update_state
-					end
+					return if created?
+					download_image unless image_exists?
+					run_command "#@binary init #@image #@name"
 				end
 
 				def attach_network( network )
-					unless device_attached? network
-						run_command "lxc network attach #{network} #@name"
-						update_state
-					end
+					return if device_attached? network
+					run_command "#@binary network attach #{network} #@name"
 				end
 
 				def start
-					unless running?
-						run_command "lxc start #@name"
-						update_state
-					end
-				end
-
-				def prepare_ssh
-					run_command "lxc exec #@name mkdir -- -p /root/.ssh"
-					run_command "lxc file push ~/.ssh/id_rsa.pub #@name/root/.ssh/authorized_keys"
-					run_command "lxc exec #@name chown -- root:root /root/.ssh/authorized_keys"
+					return if running?
+					run_command "#@binary start #@name"
 				end
 
 				def destroy
-					if created?
-						run_command "lxc delete #@name --force"
-						update_state
-					end
+					return unless created?
+					run_command "#@binary delete #@name --force"
 				end
 
-				def wait_for_ipv4
+				def wait_until_ready
 					info 'Wait for network to become ready.'
 					9.times do
-						update_state
-						s = @state['state'].nil? ? @state['State'] : @state['state']
-						inet = s['network']['eth0']['addresses'].detect do |i|
-							i['family'] == 'inet'
+						s = fetch_state[:state].nil? ? @state[:State] : @state[:state]
+						inet = s[:network][:eth0][:addresses].detect do |i|
+							i[:family] == 'inet'
 						end
-						return inet['address'] if inet
+						return inet[:address] if inet
 						sleep 1 unless defined?( Minitest )
 					end
 					nil
 				end
 
+				def download_image
+					run_command "#@binary image copy --copy-aliases #@remote:#@image local:"
+				end
+
+				def execute( command )
+					return if command.nil?
+					run_command "#@binary exec #@name -- #{command}"
+				end
+
+				def login_command
+					LoginCommand.new( "#@binary exec #@name -- bash", {} )
+				end
+
+				def upload( locals, remote )
+					locals.each do |local|
+						run_command "#@binary file push -rp #{local} #@name/#{remote}"
+					end
+				end
+
+				def fix_chef_install( platform )
+					case platform
+					when /ubuntu/, /debian/
+						execute "apt install -y wget"
+					when /rhel/, /centos/
+						execute 'yum install -y sudo wget'
+					end
+				end
 				private
 
-				def update_state
-					@state = JSON.parse( run_command "lxc list #@name --format json" ).first
+				def image_exists?
+					!JSON.parse(
+						run_command( "#@binary image list #@image --format json" ), symbolize_names: true
+					).empty?
+				end
+
+				def fetch_state
+					@state = JSON.parse(
+						run_command( "#@binary list #@name --format json" ), symbolize_names: true
+					).first
 				end
 
 				def running?
-					@state['status'] == 'Running'
+					fetch_state[:status] == 'Running'
 				end
 
 				def created?
-					!@state.nil?
+					!fetch_state.nil?
 				end
 
 				def device_attached?( network )
-					@state['devices'] and @state['devices'][network.to_s]
+					fetch_state[:devices] and @state[:devices][network.to_sym]
 				end
 			end
 		end

data/lib/kitchen/driver/version.rb

@@ -8,7 +8,7 @@
 # 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
+#		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,
@@ -16,9 +16,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'kitchen'
+
 module Kitchen
 	module Driver
-		# Version string for Lxd Kitchen driver
-		LXD_VERSION = '0.1.1'
+		class Lxd < Kitchen::Driver::Base
+			# Version string for Lxd Kitchen driver
+			VERSION = '0.2.0'
+		end
 	end
 end

data/lib/kitchen/transport/lxd.rb

@@ -0,0 +1,50 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Juri Timošin (<draco.ater@gmail.com>)
+#
+# Copyright (C) 2017, Juri Timošin
+#
+# 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 'kitchen'
+require 'forwardable'
+
+module Kitchen
+	module Transport
+		# Transport for Lxd driver for Kitchen.
+		#
+		# @author Juri Timošin <draco.ater@gmail.com>
+		class Lxd < Base
+			kitchen_transport_api_version 2
+
+			default_config :container do |transport|
+				transport.instance.driver.container
+			end
+
+			def connection( state, &block )
+				@connection = Connection.new( config.to_hash.merge( state ), &block )
+			end
+
+			class Connection < Base::Connection
+				extend Forwardable
+
+				def initialize( opts )
+					@container = opts[:container]
+					super( opts )
+				end
+
+				def_delegators :@container, :execute, :login_command, :upload, :wait_until_ready
+			end
+		end
+	end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-lxd
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Juri Timošin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-30 00:00:00.000000000 Z
+date: 2017-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-kitchen
@@ -97,7 +97,6 @@ dependencies:
 description: Kitchen::Driver::Lxd - an Lxd driver for Test Kitchen.
 email:
 - draco.ater@gmail.com
-- juri.timoshin@zeroturnaround.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -108,7 +107,8 @@ files:
 - lib/kitchen/driver/lxd.rb
 - lib/kitchen/driver/lxd/container.rb
 - lib/kitchen/driver/version.rb
-homepage: https://github.com/zeroturnaround/kitchen-lxd
+- lib/kitchen/transport/lxd.rb
+homepage: https://github.com/DracoAter/kitchen-lxd
 licenses:
 - Apache-2.0
 metadata: {}
@@ -128,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: An Lxd driver for Test Kitchen.