kitchen-lxd_sling 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fe1612ee7b8c294ef3cab3e2d3f61fd608f90c46a70a8e5a26f2138a42b491b
-  data.tar.gz: f8186476231397d15aa660aa2012e9b012d86af138546b3db9ae5b46f373658f
+  metadata.gz: b7556790d91c1247582f98d881977477f69bf3722f2309f5ad4f5ebc0d63d771
+  data.tar.gz: 55106364c0752164bd48376d83a9baf4f02bbfea0fb3af3a415daab21650f528
 SHA512:
-  metadata.gz: 1d5878def3ebcd2c771b7e8908b50b28f1180a5d05d8bf66d22e9f97a80b3dfab0f26f64026fd9192671d17f139f419be6b345a0cbd2bb805d758a385fef68b9
-  data.tar.gz: 616416879a3b16b3ca32f7eb2136e895fd1bd0bcc0c6feb16a91aff769faf3f648085ea727c57d2ca5329467c950b14b0b6495d8cfe5a44dbea0a8169b25da1d
+  metadata.gz: cff8a63f51e3c7225a58514bfe45242035892ced3e4d00775f5ee133596ef3f7ba0f53453df95611c384955e8feebde76853b002270f21732bbdc34c102eafc4
+  data.tar.gz: 147604fd1caec7c1499c71feff72f5c88150e3576d73eb1ca4645544230d0d3b3b0ec826fb53becf32dba30f0e60a7799a58eae9837ab39b723f836623bfed24

data/README.md

@@ -1,39 +1,101 @@
-# Kitchen::LxdNexus
+# kitchen-lxd_sling [![Build Status](https://travis-ci.org/NexusSW/kitchen-lxd_sling.svg?branch=master)](https://travis-ci.org/NexusSW/kitchen-lxd_sling) [![Dependency Status](https://gemnasium.com/badges/github.com/NexusSW/kitchen-lxd_sling.svg)](https://gemnasium.com/github.com/NexusSW/kitchen-lxd_sling)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/kitchen/lxd_sling`. To experiment with that code, run `bin/console` for an interactive prompt.
+Test Kitchen driver for LXD.  This gem provides a driver, and a transport allowing native access to your containers running under LXD.
 
-TODO: Delete this and the text above, and describe your gem
+## Requirements
 
-## Installation
-
-Add this line to your application's Gemfile:
+* [test-kitchen](https://github.com/test-kitchen/test-kitchen/)
+* LXD host running version >= 2.0
+* Authority to access your LXD host:
+  * be a member of the lxd group if accessing LXD locally
+  * or have an already trusted client cert if accessing remotely
 
-```ruby
-gem 'kitchen-lxd_sling'
-```
+## Installation
 
-And then execute:
+    $ gem install kitchen-lxd_sling
 
-    $ bundle
+And if you're testing with inspec, you'll also need to install our Train transport:  (Requires `kitchen-inspec ~> 0.22`)
 
-Or install it yourself as:
-
-    $ gem install kitchen-lxd_sling
+    $ gem install train-lxd
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
+Basic kitchen.yml entries with a local LXD host:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```yaml
+driver: lxd
+transport: lxd
+...
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+And if your host is remote to where you're running kitchen, then this is 'likely' all that you will need:
 
-## Contributing
+```yaml
+driver:
+  name: lxd
+  server: <hostname>
+  rest_options:
+    verify_ssl: false
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/kitchen-lxd_sling.
+transport: lxd
+...
+```
 
-## License
+### Available options
+
+```yaml
+driver:
+  name: lxd
+  server: <hostname>
+  port: 8443
+  username: ubuntu
+  image_server:
+    server: https://images.linuxcontainers.org
+    protocol: simplestreams
+  alias: ubuntu/xenial
+  fingerprint: ce8d746a8567
+  properties:
+    architecture: amd64
+    os: Ubuntu
+    release: xenial
+  profiles:
+    - default
+    - kitchen
+    ...
+  config:
+    security.privileged: true
+    security.nesting: true
+    linux.kernel_modules: ip_tables,ip6_tables
+    ...
+  ssh_login:
+    username: ubuntu
+    public_key: <local path to file: ~/.ssh/id_rsa.pub>
+  rest_options:
+    verify_ssl: false
+    ssl:
+      verify: false
+      client_cert: <local path to file: ~/.config/lxc/client.crt>
+      client_key: <local path to file: ~/.config/lxc/client.key>
+...
+```
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+#### Options (explained)
+
+option | default | description
+|---|:---:|---|
+server | | Hostname of a remote LXD server.  If left unspecified, then local CLI commands will be issued via `lxc`.
+port | 8443 | Port on **server** where LXD is listening.  Ignored unless **server** is specified.
+username | root | If the base image has additional user accounts built-in, then change this value to run all commands as a different user.  **Warning**: _passwordless sudo may be required by the remainder of the test suite_
+image_server.server | https://images.linuxcontainers.org | Default source for base container images
+image_server.protocol | _\<calculated>_ | `simplestreams` or `lxd` protocol with which to communicate with the **image_server**
+alias | _\<calculated>_ | Name of the image on the **image_server**.  Derived from platform name in kitchen.yml's `platforms:` section unless specified here, and unless **fingerprint** or **properties** are specified.
+fingerprint | | Fingerprint of a specific image on the **image_server**
+properties | | Search parameters for finding an image on the **image_server**
+profiles | default | Profiles on the LXD host to apply to any newly created containers
+config | | Additional container properties passed verbatim to the LXD Host.  Refer to LXD's documentation for valid values https://github.com/lxc/lxd/blob/master/doc/containers.md
+ssh_login.username | | If the base image has sshd enabled and running, specify the username here and the driver will set up the container for ssh access.  Overrides the base **username**
+ssh_login.public_key | ~/.ssh/id_rsa.pub | Public key to use for authenticating ssh connections.
+rest_options.verify_ssl | true | _Convenience option_ When connecting to a remote LXD host, should the hosts SSL certificate be verified
+rest_options.ssl.verify | true | Overrides **rest_options.verify_ssl**.
+rest_options.ssl.client_cert | ~/.config/lxc/client.crt | Client certificate authenticating access to the LXD host.
+rest_options.ssl.client_key | ~/.config/lxc/client.key | Private key for the client certificate.

data/lib/kitchen/driver/lxd.rb

@@ -54,29 +54,31 @@ module Kitchen
         # Which also means that you might need to do 'ssh_login: false' in the config if you're using a cloud-image and aren't routable
         # think ahead for default behaviour once LXD can port forward
         # FUTURE: If I get time I'll look into faking a port forward with something under /dev/ until then
+        info 'Waiting for an IP address...'
+        state[:ip_address] = state[:hostname] = container_ip(state)
         if use_ssh?
           # Normalize [:ssh_login]
           config[:ssh_login] = { username: config[:ssh_login] } if config[:ssh_login].is_a? String
-          config[:ssh_login] = {} if config[:ssh_login] && !config.to_hash[:ssh_login].is_a?(Hash)
+          config[:ssh_login] ||= {} # if config[:ssh_login] && !config.to_hash[:ssh_login].is_a?(Hash)
 
-          state[:username] = config[:ssh_login][:username] if config[:ssh_login]
+          state[:username] = config[:ssh_login][:username] if config[:ssh_login].key? :username
           state[:username] ||= 'root'
-          # TODO: make public key configurable
-          info 'Waiting for an IP address...'
-          state[:ip_address] = state[:hostname] = container_ip(state)
-          setup_ssh(state[:username], "#{ENV['HOME']}/.ssh/id_rsa.pub", state)
+          setup_ssh(state[:username], config[:ssh_login][:public_key] || "#{ENV['HOME']}/.ssh/id_rsa.pub", state)
           info "SSH access enabled on #{state[:ip_address]}"
         else
           # TODO: this section is only for the base images on linuxcontainers.org... (and I still need to account for yum)
           # they need patched because they don't have wget, or anything else with which to download the chef client
           # Custom images should account for this, so I won't run this patch for them (in the name of testing speed)
-          info 'Waiting for network access...'
-          state[:ip_address] = container_ip(state) # This is only here to wait until the net is up so we can download packages
           unless cloud_image?
-            info 'Installing additional dependencies...'
             transport = nx_transport(state)
             transport.reset_user
-            transport.execute('apt-get install openssl wget ca-certificates -y').error!
+            # only centos/7 and various ubuntu versions have been tested here
+            #   - ubuntu non-cloud has no download utilities in order to dl the chef package so we must adapt that
+            #   - centos/7 needs sudo installed, or you need to use sudo:false on the provisioner...  leaving it explicit for the user to fix
+            unless transport.execute('test -d /etc/apt').error?
+              info 'Installing additional dependencies...'
+              transport.execute('apt-get install openssl curl ca-certificates -y').error!
+            end
           end
         end
       end

data/lib/kitchen/driver/lxd_version.rb

@@ -2,6 +2,6 @@
 
 module Kitchen
   module Driver
-    LXD_VERSION = '0.5.0'.freeze
+    LXD_VERSION = '0.5.1'.freeze
   end
 end

data/lib/kitchen/transport/lxd.rb

@@ -49,7 +49,7 @@ module Kitchen
             logger << stdout_chunk if stdout_chunk
             logger << stderr_chunk if stderr_chunk
           end
-          res.error!
+          raise TransportFailed.new(res.command, res.exitstatus) if res.error?
         end
 
         def upload(locals, remote)
@@ -61,6 +61,8 @@ module Kitchen
               nx_transport.upload_folder local, remote
             end
           end
+        rescue NexusSW::LXD::RestAPI::Error => ex
+          raise TransportFailed, ex
         end
 
         def download(remotes, local)
@@ -68,6 +70,8 @@ module Kitchen
           [remotes].flatten.each do |remote|
             nx_transport.download_folder remote.to_s, local, auto_detect: true
           end
+        rescue NexusSW::LXD::RestAPI::Error => ex
+          raise TransportFailed, ex
         end
 
         def login_command

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-lxd_sling
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Sean Zachariasen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-20 00:00:00.000000000 Z
+date: 2018-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lxd-common