chef-provisioning-lxc 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa53dc604984221d5f6f52a9cf23db3dd9ba5070
-  data.tar.gz: edbcbb541604b5e31c3d38fd251a67bb7204accf
+  metadata.gz: e716f7488e9a91724608e3cbeb4ffa88e4bbf5f9
+  data.tar.gz: e8bc3b5f4b0773447e9d4ea9a60e7893b291762b
 SHA512:
-  metadata.gz: 40e497dd182a9e1885801d64335701f94e444cb6cc1dd8c756726fbd426f8e9d67413ea3e95ebe3e311ea4ca5ca511c6dc6c6d16565a38b748daf56dcb58b0d0
-  data.tar.gz: 8a0a1387a5d8a9f5b0b19a5692dd8301c76deb44034c407e663a0d0eda30a028a8256e9fa936fc7ecba21f3c718683acf041c01334993256d11137a52afcfdf8
+  metadata.gz: 72644cf2cb034eb64dcb0c4c3f4549f7bf8a2535bd993dc7fde92ec9d217f7b485c2e2edda9148eee0038740f26ac0cc90a34b5ddc888d8bb3d05da8628e856e
+  data.tar.gz: 322357ab6e178b1d86f50e355ff4f310fb1aff324e1d5311331cfa9dcf21f1961e1f9632ab74310b0fd663a4373ef0dda76c8183a21b924eef570e02fa1871d9

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+gemfile
+gemspec
+
+gem 'chef-provisioning', github: 'chef/chef-provisioning'
+
+group :development do
+  gem 'pry'
+end

data/README.md

@@ -1,18 +1,34 @@
+# MAINTAINERS WANTED
+
+We are actively seeking maintainers for the chef-provisioning-lxc driver. This project is not under active maintenance by CHEF, and does not currently pass tests with the latest version of [chef-provisioning](https://github.com/chef/chef-provisioning). If you are interested in maintaining it, please contact us in the [gitter](https://github.com/chef/chef-provisioning-lxc).
+
 # chef-provisioning-lxc
 
+[![Build Status](https://travis-ci.org/chef/chef-provisioning-lxc.svg?branch=master)](https://travis-ci.org/chef/chef-provisioning-lxc) [![Gem Version](https://badge.fury.io/rb/chef-provisioning-lxc.svg)](https://badge.fury.io/rb/chef-provisioning-lxc)
+
 This is the LXC provisioner for chef-provisioning.
 
 ## Quick Start
 
-To run the tests, which creates an Ubuntu machine and installs this into it:
+Assuming you have host with working LXC setup already, you can directly invoke an example recipe using chef localmode
 
-```
-gem install chef-provisioning
-rake build
-cd test/
-set -x CHEF_DRIVER 'lxc'
-chef-client -z lxc.rb simple.rb
-```
+- Clone chef-provisioning-lxc repo
+
+  ```sh
+  git clone https://github.com/chef/chef-provisioning-lxc
+  ```
+
+- Run bundle install
+
+  ```sh
+  bundle install
+  ```
+
+- Execute the test recipe to create a linux container
+
+  ```sh
+  bundle exec chef-client -z -o recipe[lxctests::simple] -c test/client.rb
+  ```
 
 ## Basic Usage
 
@@ -35,6 +51,6 @@ with_machine_options :template => <template name>,
 
 These options correspond to the options in [lxc create](https://qa.linuxcontainers.org/master/current/doc/man/lxc-create.1.html):
 
-* **template**: the LXC template name to use.
-* **template_options**: An array of string arguments to pass to the template.
-* **backing_store**: The backing store to use for the file system.
+- **template**: the LXC template name to use.
+- **template_options**: An array of string arguments to pass to the template.
+- **backing_store**: The backing store to use for the file system.

data/Rakefile

@@ -1,6 +1,11 @@
 require 'bundler'
 require 'bundler/gem_tasks'
 
-task :spec do
-  require File.expand_path('spec/run')
+require "github_changelog_generator/task"
+
+GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+  config.future_release = Chef::Provisioning::LXCDriver::VERSION
+  config.enhancement_labels = "enhancement,Enhancement,New Feature".split(",")
+  config.bug_labels = "bug,Bug,Improvement,Upstream Bug".split(",")
+  config.exclude_labels = "duplicate,question,invalid,wontfix,no_changelog,Exclude From Changelog,Question".split(",")
 end

data/chef-provisioning-lxc.gemspec

@@ -0,0 +1,28 @@
+$:.unshift(File.dirname(__FILE__) + '/lib')
+require 'chef/provisioning/lxc_driver/version'
+
+Gem::Specification.new do |s|
+  s.name = 'chef-provisioning-lxc'
+  s.version = Chef::Provisioning::LXCDriver::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.extra_rdoc_files = ['README.md', 'LICENSE' ]
+  s.summary = 'Provisioner for creating LXC containers in Chef Provisioning.'
+  s.description = s.summary
+  s.author = 'Ranjib Dey'
+  s.email = 'dey.ranjib@gmail.com'
+  s.homepage = 'https://github.com/chef/chef-provisioning-lxc'
+
+  s.add_dependency 'chef-provisioning', '>= 1.0', '< 3.0'
+  s.add_dependency 'lxc-extra', '~> 0.0', '>= 0.0.3'
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'github_changelog_generator'
+
+  s.bindir       = "bin"
+  s.executables  = %w( )
+
+  s.require_path = 'lib'
+  s.files = %w(Gemfile Rakefile LICENSE README.md) + Dir.glob("*.gemspec") +
+      Dir.glob("{distro,lib,tasks,spec}/**/*", File::FNM_DOTMATCH).reject {|f| File.directory?(f) }
+end

data/lib/chef/provisioning/lxc_driver/driver.rb

@@ -76,8 +76,13 @@ module LXCDriver
 
           #
           # Create the machine
-          #
-          ct.create(machine_options[:template], machine_options[:backingstore], machine_options[:devspecs], 0, machine_options[:template_options])
+          ct.create(
+            machine_options[:template],
+            machine_options[:backingstore],
+            machine_options[:devspecs] || {},
+            machine_options[:flags] || 0,
+            machine_options[:template_options] || []
+          )
 
           machine_spec.location = {
             'driver_url' => driver_url,
@@ -101,21 +106,9 @@ module LXCDriver
       end
 
       # Get stopped containers running
-      unless ct.running?
+      if ct.defined? and not ct.running?
         action_handler.perform_action "start lxc container #{machine_spec.location['name']} (state is #{ct.state})" do
-          # Have to shell out to lxc-start for now, ct.start holds server sockets open!
-          lxc_start = "lxc-start -d -n #{Shellwords.escape(machine_spec.location['name'])}"
-# TODO add ability to change options on start
-#          if machine_options[:config_file]
-#            lxc_start << " -f #{Shellwords.escape(machine_options[:config_file])}"
-#          end
-#          if machine_options[:extra_config]
-#            machine_options[:extra_config].each_pair do |key,value|
-#              lxc_start << " -s #{Shellwords.escape("#{key}=#{value}")}"
-#            end
-#          end
-          shell_out!(lxc_start)
-#          ct.start
+          ct.start
         end
       end
 

data/lib/chef/provisioning/lxc_driver/lxc_transport.rb

@@ -1,6 +1,6 @@
 require 'chef/provisioning/transport'
 require 'lxc/extra'
-require 'chef/mixin/shell_out'
+require 'mixlib/shellout'
 require 'lxc/extra/proxy_client_side'
 require 'lxc/extra/proxy_server_side'
 require 'lxc/extra/channel'
@@ -8,149 +8,155 @@ require 'uri'
 require 'socket'
 
 class Chef
-module Provisioning
-module LXCDriver
-  class LXCTransport < Chef::Provisioning::Transport
-    @@active_transports = []
-
-    class LXCExecuteResult < Struct.new(:command, :options, :stdout, :stderr, :exitstatus)
-      def error!
-        raise "Error: '#{command}' failed with exit code #{exitstatus}.\nSTDOUT:#{stdout}\nSTDERR:#{stderr}" if exitstatus != 0
-      end
-    end
-
-    attr_reader :name, :options, :lxc_path
-
-    include Chef::Mixin::ShellOut
-
-    def initialize(name, lxc_path, options={})
-      @options = options
-      @name = name
-      @lxc_path = lxc_path
-      @port_forwards = {}
-      @@active_transports << self
-    end
+  module Provisioning
+    module LXCDriver
+      class LXCTransport < Chef::Provisioning::Transport
+        @@active_transports = []
+
+        class LXCExecuteResult < Struct.new(:command, :options, :stdout, :stderr, :exitstatus)
+          def error!
+            raise "Error: '#{command}' failed with exit code #{exitstatus}.\nSTDOUT:#{stdout}\nSTDERR:#{stderr}" if exitstatus != 0
+          end
+        end
 
-    def container
-      @container ||= LXC::Container.new(name, lxc_path)
-    end
+        attr_reader :name, :options, :lxc_path
 
-    def rootfs
-      container.config_item('lxc.rootfs')
-    end
+        include Chef::Mixin::ShellOut
 
-    def container_path(path)
-      File.join(rootfs, path)
-    end
+        def initialize(name, lxc_path, options={})
+          @options = options
+          @name = name
+          @lxc_path = lxc_path
+          @port_forwards = {}
+          @@active_transports << self
+        end
 
-    def execute(command, options = {})
-      Chef::Log.info("Executing #{command} on #{name}")
-      container.execute(:timeout => (execute_timeout(options) || 0)) do
-        begin
-          # TODO support streaming (shell out needs work)
-          out = shell_out(command)
-          LXCExecuteResult.new(command, options, out.stdout, out.stderr, out.exitstatus)
-        rescue Exception => e
-          LXCExecuteResult.new('', e.message, -1)
+        def container
+          @container ||= LXC::Container.new(name, lxc_path)
         end
-      end
-    end
 
-    def make_url_available_to_remote(local_url)
-      uri = URI(local_url)
-      host = Socket.getaddrinfo(uri.host, uri.scheme, nil, :STREAM)[0][3]
-      if host == '127.0.0.1' || host == '::1'
-        unless @port_forwards[uri.port]
+        def rootfs
+          container.config_item('lxc.rootfs')
+        end
 
-          Chef::Log.debug("Forwarding container port #{uri.port} to local port #{uri.port}")
-          # Create the channel that will let the container and the host talk to each other
-          channel = LXC::Extra::Channel.new
+        def container_path(path)
+          File.join(rootfs, path)
+        end
 
-          # Start the container side of the proxy, listening for client connections
-          pid = container.attach do
+        def execute(command, options = {})
+          timeout = options[:timeout] || 3600
+          Chef::Log.info("Executing #{command} on #{name}")
+          container.execute(timeout: timeout) do
+            cmd = Mixlib::ShellOut.new(command)
+            cmd.timeout = timeout
             begin
-              server = TCPServer.new(host, uri.port)
-              proxy = LXC::Extra::ProxyClientSide.new(channel, server)
-              proxy.start
-            rescue
-              Chef::Log.error("ERROR in proxy (container side): #{$!}\n#{$!.backtrace.join("\n")}")
-              raise
+              cmd.run_command
+              LXCExecuteResult.new(command, {}, cmd.stdout, cmd.stderr, cmd.exitstatus)
+            rescue Errno::ENOENT => e
+              LXCExecuteResult.new(command, {} , '', e.message, 2)
             end
           end
+        end
 
-          # Start the host side of the proxy, which contacts the real server
-          thread = Thread.new do
-            proxy = LXC::Extra::ProxyServerSide.new(channel) do
-              TCPSocket.new(host, uri.port)
+        def make_url_available_to_remote(local_url)
+          uri = URI(local_url)
+          uri_scheme = uri.scheme
+          uri_scheme = nil if uri.scheme == 'chefzero'
+          host = Socket.getaddrinfo(uri.host, uri_scheme, nil, :STREAM)[0][3]
+          if host == '127.0.0.1' || host == '::1'
+            unless @port_forwards[uri.port]
+
+              Chef::Log.debug("Forwarding container port #{uri.port} to local port #{uri.port}")
+              # Create the channel that will let the container and the host talk to each other
+              channel = LXC::Extra::Channel.new
+
+              # Start the container side of the proxy, listening for client connections
+              pid = container.attach do
+                begin
+                  server = TCPServer.new(host, uri.port)
+                  proxy = LXC::Extra::ProxyClientSide.new(channel, server)
+                  proxy.start
+                rescue
+                  Chef::Log.error("ERROR in proxy (container side): #{$!}\n#{$!.backtrace.join("\n")}")
+                  raise
+                end
+              end
+
+              # Start the host side of the proxy, which contacts the real server
+              thread = Thread.new do
+                proxy = LXC::Extra::ProxyServerSide.new(channel) do
+                  TCPSocket.new(host, uri.port)
+                end
+                proxy.start
+              end
+
+              Chef::Log.debug("Forwarded #{uri.port} on container #{name} to local port #{uri.port}.  Container listener id PID #{pid}")
+
+              @port_forwards[uri.port] = [ pid, thread, channel ]
             end
-            proxy.start
-          end
-
-          Chef::Log.debug("Forwarded #{uri.port} on container #{name} to local port #{uri.port}.  Container listener id PID #{pid}")
 
-          @port_forwards[uri.port] = [ pid, thread, channel ]
+          end
+          local_url
         end
 
-      end
-      local_url
-    end
-
-    def read_file(path)
-      if File.exists?(container_path(path))
-        File.read(container_path(path))
-      end
-    end
-
-    def download_file(path, local_path)
-      Chef::Log.debug("Copying file #{path} from #{name} to local #{local_path}")
-      FileUtils.cp_r(container_path(path), local_path)
-    end
+        def read_file(path)
+          container.execute(wait: true) do
+            if File.exists?(container_path(path))
+              File.read(container_path(path))
+            end
+          end
+        end
 
-    def write_file(path, content)
-      File.open(container_path(path), 'w') do |f|
-        f.write(content)
-      end
-    end
+        def download_file(path, local_path)
+          Chef::Log.debug("Copying file #{path} from #{name} to local #{local_path}")
+          data = read_file(path)
+          File.open(local_path, 'w') do |f|
+            f.write(data)
+          end
+        end
 
-    def upload_file(local_path, path)
-      FileUtils.cp_r(local_path, container_path(path))
-    end
+        def write_file(path, content)
+          container.execute(wait: true) do
+            File.open(path, 'w') do |f|
+              f.write(content)
+            end
+          end
+        end
 
-    def disconnect
-      @port_forwards.each_pair do |port, (pid, thread, channel)|
-        Chef::Log.debug("stopping port forward #{port} for container #{name}")
-        begin
-          Chef::Log.debug("Killing PID #{pid}")
-          Process.kill('KILL', pid)
-        rescue
+        def upload_file(local_path, path)
+          write_file(path, File.read(local_path))
         end
-        begin
-          thread.kill
-        rescue
+
+        def disconnect
+          @port_forwards.each_pair do |port, (pid, thread, channel)|
+            Chef::Log.debug("stopping port forward #{port} for container #{name}")
+            begin
+              Chef::Log.debug("Killing PID #{pid}")
+              Process.kill('KILL', pid)
+            rescue
+            end
+            begin
+              thread.kill
+            rescue
+            end
+          end
+          @port_forwards = {}
+          @@active_transports.delete(self)
         end
-      end
-      @port_forwards = {}
-      @@active_transports.delete(self)
-    end
 
-    def available?
-      begin
-        execute('pwd')
-        true
-      rescue Exception =>e
-        false
-      end
-    end
+        def available?
+          container.running?
+        end
 
-    def self.disconnect_active_transports
-      @@active_transports.to_a.dup.each do |transport|
-        transport.disconnect
+        def self.disconnect_active_transports
+          @@active_transports.to_a.dup.each do |transport|
+            transport.disconnect
+          end
+        end
       end
     end
   end
 end
-end
-end
 
 at_exit do
   Chef::Provisioning::LXCDriver::LXCTransport.disconnect_active_transports

data/lib/chef/provisioning/lxc_driver/version.rb

@@ -1,7 +1,7 @@
 class Chef
-module Provisioning
-module LXCDriver
-  VERSION = '0.6.1'
-end
-end
+  module Provisioning
+    module LXCDriver
+      VERSION = '0.7.0'
+    end
+  end
 end

metadata

@@ -1,57 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: chef-provisioning-lxc
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Ranjib Dey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-26 00:00:00.000000000 Z
+date: 2016-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: chef
+  name: chef-provisioning
   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: chef-provisioning
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: '1.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.11'
-- !ruby/object:Gem::Dependency
-  name: ruby-lxc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: '1.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: lxc-extra
   requirement: !ruby/object:Gem::Requirement
@@ -100,7 +78,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Provisioner for creating LXC containers in Chef Metal.
+- !ruby/object:Gem::Dependency
+  name: github_changelog_generator
+  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: Provisioner for creating LXC containers in Chef Provisioning.
 email: dey.ranjib@gmail.com
 executables: []
 extensions: []
@@ -108,15 +100,17 @@ extra_rdoc_files:
 - README.md
 - LICENSE
 files:
+- Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- chef-provisioning-lxc.gemspec
 - lib/chef/provisioning/driver_init/lxc.rb
 - lib/chef/provisioning/lxc_driver.rb
 - lib/chef/provisioning/lxc_driver/driver.rb
 - lib/chef/provisioning/lxc_driver/lxc_transport.rb
 - lib/chef/provisioning/lxc_driver/version.rb
-homepage: https://github.com/opscode/chef-provisioning-lxc
+homepage: https://github.com/chef/chef-provisioning-lxc
 licenses: []
 metadata: {}
 post_install_message: 
@@ -135,9 +129,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Provisioner for creating LXC containers in Chef Metal.
+summary: Provisioner for creating LXC containers in Chef Provisioning.
 test_files: []
-has_rdoc: