kitchen-lxd_cli 0.1.0.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 90f808190b07d50dd9404d55a80c7e5bdf23fcb6
+  data.tar.gz: 6697d367bfd6ebcd472429ac3a63c156a65fc1bc
+SHA512:
+  metadata.gz: 760fcae5bb6f14e0d6df9067160f7e0676dc826b6c43dcefb46773fc4902df2a37dbccf8fd8afef5679820f3f662c216977af6d37869cb2ee1a382f645373348
+  data.tar.gz: 8217561471842586e3e39492cd6e348dd1c72913904653a30d5a8d620f4a19f0c444eb248b106f089a573a10c956ce67ce0800ca1ff600efb0ed2da86ef109d1

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/.tailor

@@ -0,0 +1,4 @@
+Tailor.config do |config|
+  config.formatters "text"
+  config.file_set 'lib/**/*.rb'
+end

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+
+rvm:
+- 2.0.0
+- 1.9.3
+- 1.9.2
+- ruby-head
+
+matrix:
+  allow_failures:
+  - rvm: ruby-head

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:: Braden Wright (<braden.m.wright@gmail.com>)
+
+Copyright (C) 2015, Braden Wright
+
+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,131 @@
+# <a name="title"></a> Kitchen::LxdCli
+
+A Test Kitchen Driver for LxdCli.
+
+## <a name="overview"></a> Overview
+
+This is a test-kitchen driver for lxd, which controls lxc.  I named it LxdCli because this is my first plugin and I wanted to leave LXD driver name in case a more extensive project is put together.
+
+Basics are working.  I'm running lxd --version 0.20 on ubuntu 15.10.
+
+I started the project because I really like the idea of developing containers, but kitchen-lxc wouldn't work with my version.  I also tried docker but preferred how lxd is closer to a hypervisor virtual machine.  For instance kitchen-docker my recipes that had worked on virtual machies for mongodb, the service would not start when using docker.  Ultimately I was interested in LXD and there wasn't anything out there.  I was quickly able to get my mongodb recipe working.  I figured I'd clean things up, and some features and publish it.  At least if someone like me wants to play with lxd, chef, test-kitchen they can test some basics without having to recreate the wheel.
+
+I AM VERY OPEN TO SUGGESTIONS/HELP.  As I mentioned I haven't written a kitchen driver or published any ruby gems before so I was hesitant to even release it.
+
+```yaml
+---
+driver:
+  name: lxd_cli
+  # optional: searches ~/.ssh/ by default for public key
+#  public_key_path: "~/.ssh/id_rsa.pub"
+
+provisioner:
+  name: chef_zero
+#  name: nodes
+
+platforms:
+# Following 3 will all use the same image (LTS), but it will be named accordingly
+- name: ubuntu-14.04
+- name: ubuntu-1404
+- name: ubuntu-trusty
+# Following 3 will all use the same image (Latest Release as of now), but it will be named accordingly
+- name: ubuntu-15.10
+- name: ubuntu-1510
+- name: ubuntu-wily
+```
+
+As of now if you install lxd, and have a public key setup in ~/.ssh/ then you should be able to use plugin without manual intervention.  I have only tested with ubuntu container.  What does it do:
+
+Kitchen Create
+
+1) Creates image if its missing.  If a platform is specified LXD will check if an image with the same name exists, if not it will parse the platform name, and install the appropriate image.  If the image exists it will use that image.
+
+2) If container does not exists, creates container.  Using the instance name as the container name, and using the image from previous step.
+
+3) If container exists, starts it
+
+4) copies public key from ~/.ssh/ to container /root/.ssh/
+
+
+Note: if you have troubles with the public key, you can always manually setup public key on container, and publish it to an image.  If the image already exists it will not be download via test-kitchen.
+
+Kitchen Destroy
+
+1) Stops container if its running
+
+2) Destroys container if it exists
+
+LXD Links:
+
+[LXD Basics](https://insights.ubuntu.com/2015/03/20/installing-lxd-and-the-command-line-tool/)
+
+[LXD Publish Image](https://insights.ubuntu.com/2015/06/30/publishing-lxd-images/)
+
+## <a name="installation"></a> Installation and Setup
+
+Please read the [Driver usage][driver_usage] page for more details.
+
+## <a name="config"></a> Configuration
+
+public_key_path config can be manual set or is derived by default based 
+~/.ssh/ directory, specifically the setting is derived by searching for:
+- `~/.ssh/id_rsa.pub`
+- `~/.ssh/id_dsa.pub`
+- `~/.ssh/identity.pub`
+- `~/.ssh/id_ecdsa.pub`
+
+### <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="roadmap"></a> Roadmap 
+* Update/Clean README 
+* Config option for remote host, remote user, etc.  So lxc can be launched on a remote server, not just locally
+* Config option for adding/using lxc remote command
+* Config option to publish container on verify
+* Config options for static ip, cpu, mem
+* Config option to install upstart (not used by default in containers)
+* Config option for proxy/cache
+
+## <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 [Braden Wright][author] (<braden.m.wright@gmail.com>)
+
+## <a name="license"></a> License
+
+Apache 2.0 (see [LICENSE][license])
+
+
+[author]:           https://github.com/enter-github-user
+[issues]:           https://github.com/enter-github-user/kitchen-lxd_cli/issues
+[license]:          https://github.com/enter-github-user/kitchen-lxd_cli/blob/master/LICENSE
+[repo]:             https://github.com/enter-github-user/kitchen-lxd_cli
+[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-lxd_cli.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kitchen/driver/lxd_cli_version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'kitchen-lxd_cli'
+  spec.version       = Kitchen::Driver::LXD_CLI_VERSION
+  spec.authors       = ['Braden Wright']
+  spec.email         = ['braden.m.wright@gmail.com']
+  spec.description   = %q{A Test Kitchen Driver for LxdCli}
+  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.4.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  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/lxd_cli.rb

@@ -0,0 +1,144 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Braden Wright (<braden.m.wright@gmail.com>)
+#
+# Copyright (C) 2015, Braden Wright
+#
+# 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'
+
+module Kitchen
+
+  module Driver
+
+    # LxdCli driver for Kitchen.
+    #
+    # @author Braden Wright <braden.m.wright@gmail.com>
+    class LxdCli < Kitchen::Driver::SSHBase
+      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
+
+      def create(state)
+        if exists?
+          if running?
+            debug("#{instance.name} already exists, and is already running.  Nothing to do")
+          else
+            debug("#{instance.name} already exists, starting instead")
+            run_command("lxc start #{instance.name}")
+          end
+        else
+          create_image_if_missing
+          run_command("lxc launch #{instance.platform.name} #{instance.name}")
+        end
+        ip_address(state)
+        setup_ssh_access
+      end
+
+      def destroy(state)
+        if exists?
+          if running?
+            run_command("lxc stop #{instance.name}")
+          else
+            debug("#{instance.name} isn't running, just destroying instead")
+          end
+          run_command("lxc delete #{instance.name}")
+        else
+          debug("#{instance.name} doesn't exist.  Nothing to do")
+        end
+        state.delete(:hostname)
+      end
+
+      private
+        def exists?
+          status = `lxc info #{instance.name} > /dev/null 2>&1 && echo $?`.chomp
+          if "#{status}" == "0"
+            debug("#{instance.name} exists")
+            return true
+          else
+            debug("#{instance.name} doesn't exist")
+            return false
+          end
+        end
+
+        def running?
+          status = `lxc info #{instance.name}`.match(/Status: ([a-zA-Z]+)[\n]/).captures[0].upcase
+          if status == "RUNNING"
+            debug("#{instance.name} is running")
+            return true
+          else
+            debug("#{instance.name} isn't running")
+            return false
+          end
+        end
+
+        def create_image_if_missing
+          status = `lxc image show #{instance.name} > /dev/null 2>&1 && echo $?`.chomp
+          if "#{status}" == "0"
+            debug("Image #{instance.name} exists")
+            return false
+          else
+            debug("Image #{instance.name} doesn't exist, creating now.")
+            image = get_ubuntu_image_info
+            debug("lxd-images import #{image[:os]} #{image[:release]} --alias #{instance.platform.name}")
+            run_command("lxd-images import #{image[:os]} #{image[:release]} --alias #{instance.platform.name}")
+            return true
+          end
+        end
+
+        def get_ubuntu_image_info
+          platform, release = instance.platform.name.split('-')
+          if platform.downcase == "ubuntu"
+            case release.downcase
+            when "14.04", "1404", "trusty", "", nil
+              image = { :os => platform, :release => "trusty" }
+            when "14.10", "1410", "utopic"
+              image = { :os => platform, :release => "utopic" }
+            when "15.04", "1504", "vivid"
+              image = { :os => platform, :release => "vivid" }
+            when "15.10", "1510", "wily"
+              image = { :os => platform, :release => "wily" }
+            when "16.04", "1604", "xenial"
+              image = { :os => platform, :release => "xenial" }
+            else
+              image = { :os => platform, :release => release }
+            end
+            return image
+          end
+        end
+
+        def ip_address(state)
+          begin
+            lxc_info = `lxc info #{instance.name}`
+          end while (!lxc_info.match(/eth0:[\t]IPV[46][\t]([0-9.]+)[\n]/))
+          lxc_ip = lxc_info.match(/eth0:[\t]IPV[46][\t]([0-9.]+)[\n]/).captures[0].to_s
+          state[:hostname] = lxc_ip
+          return lxc_ip
+        end
+
+        def setup_ssh_access
+          info("Copying public key from #{config[:public_key_path]} to #{instance.name}")
+          begin
+            sleep 1
+            status = `lxc file push #{config[:public_key_path]} #{instance.name}/root/.ssh/authorized_keys 2> /dev/null && echo $?`.chomp
+          end while ("#{status}" != "0")
+        end
+    end
+  end
+end

data/lib/kitchen/driver/lxd_cli_version.rb

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Braden Wright (<braden.m.wright@gmail.com>)
+#
+# Copyright (C) 2015, Braden Wright
+#
+# 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 LxdCli Kitchen driver
+    LXD_CLI_VERSION = "0.1.0.beta"
+  end
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: kitchen-lxd_cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0.beta
+platform: ruby
+authors:
+- Braden Wright
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-30 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.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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 LxdCli
+email:
+- braden.m.wright@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".cane"
+- ".gitignore"
+- ".tailor"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- kitchen-lxd_cli.gemspec
+- lib/kitchen/driver/lxd_cli.rb
+- lib/kitchen/driver/lxd_cli_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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A Test Kitchen Driver for LxdCli
+test_files: []
+has_rdoc: