specinfra-backend-docker_lxc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a1c14192777898a3b3aa32dc8b8f9da1c63b7b94
+  data.tar.gz: 77ad983a32d05ab822792931e4dfd46292c2643b
+SHA512:
+  metadata.gz: b758cc718f35faee74d97e85fa018dedbf90809232e3ceac19061f292490c78640d362d40021e5e466a9ff691a23ad5299fc2484ce8b8190ec41046955a478f5
+  data.tar.gz: 8d6295e0d1aae74f40bff56d3f0e5ef6a63ff502cf6d643d6a0fffb7421db57b2c4dada2e8d4a25ae957070a1e58803f3263bb9f3a9a715000eb45e6b60b1420

data/.yardopts

@@ -0,0 +1,7 @@
+--markup markdown
+-
+CHANGELOG.md
+CONTRIBUTING.md
+README.md
+TESTING.md
+TODO.md

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# CHANGELOG for specinfra-backend-docker_lxc
+
+This file is used to list changes made in each version of `specinfra-backend-docker_lxc`.
+
+## 0.1.0 (2015-11-14)
+
+* Initial release of `specinfra-backend-docker_lxc`

data/CONTRIBUTING.md

@@ -0,0 +1,13 @@
+# Contributing
+
+1. [Fork the repository on GitHub](https://help.github.com/articles/fork-a-repo).
+2. Create a named feature branch (`$ git checkout -b my-new-feature`).
+3. Write tests for your change (if applicable).
+4. Write your change.
+5. Add documentation to your change.
+6. [Run the tests](https://github.com/zuazo/specinfra-backend-docker_lxc/blob/master/TESTING.md), ensuring they all pass (`$ bundle exec rake`). Try as much as possible **not to reduce coverage**.
+7. Commit your change (`$ git commit -am 'Add some feature'`).
+8. Push to the branch (`$ git push origin my-new-feature`).
+9. [Submit a Pull Request using GitHub](https://help.github.com/articles/creating-a-pull-request).
+
+You can see the [TODO.md](https://github.com/zuazo/specinfra-backend-docker_lxc/blob/master/TODO.md) file if you're looking for inspiration.

data/LICENSE

@@ -0,0 +1,190 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+Copyright 2015 Xabier de Zuazo
+
+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,100 @@
+# Specinfra Docker LXC Backend
+[![Gem Version](http://img.shields.io/gem/v/specinfra-backend-docker_lxc.svg?style=flat)](http://badge.fury.io/rb/specinfra-backend-docker_lxc)
+[![Dependency Status](http://img.shields.io/gemnasium/zuazo/specinfra-backend-docker_lxc.svg?style=flat)](https://gemnasium.com/zuazo/specinfra-backend-docker_lxc)
+[![Code Climate](http://img.shields.io/codeclimate/github/zuazo/specinfra-backend-docker_lxc.svg?style=flat)](https://codeclimate.com/github/zuazo/specinfra-backend-docker_lxc)
+[![Circle CI](https://circleci.com/gh/zuazo/specinfra-backend-docker_lxc/tree/master.svg?style=shield)](https://circleci.com/gh/zuazo/specinfra-backend-docker_lxc/tree/master)
+[![Travis CI](http://img.shields.io/travis/zuazo/specinfra-backend-docker_lxc/0.1.0.svg?style=flat)](https://travis-ci.org/zuazo/specinfra-backend-docker_lxc)
+[![Coverage Status](http://img.shields.io/coveralls/zuazo/specinfra-backend-docker_lxc/0.1.0.svg?style=flat)](https://coveralls.io/r/zuazo/specinfra-backend-docker_lxc?branch=0.1.0)
+[![Inline docs](http://inch-ci.org/github/zuazo/specinfra-backend-docker_lxc.svg?branch=master&style=flat)](http://inch-ci.org/github/zuazo/specinfra-backend-docker_lxc)
+
+[Serverspec](http://serverspec.org/)/[Specinfra](https://github.com/mizzy/specinfra) backend for Docker LXC execution driver.
+
+## Requirements
+
+* Recommended Docker `1.7.0` or higher.
+* `sudo` installed (not in the container).
+* `lxc-attach` binary installed (included in the `lxc` package).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+# Gemfile
+
+gem 'specinfra-backend-docker_lxc', '~> 0.1.0'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install specinfra-backend-docker_lxc
+
+## Usage
+
+```ruby
+require 'serverspec'
+require 'specinfra/backend/docker_lxc'
+
+set :docker_image, ENV['DOCKER_IMAGE_ID']
+set :backend, :docker_lxc
+
+describe 'Dockerfile run' do
+  describe service('httpd') do
+    it { should be_enabled }
+    it { should be_running }
+  end
+end
+```
+
+## Configuration
+
+Uses the following `Specinfra` configuration options:
+
+- `:sudo_options`: Sudo command argument list as string or as array.
+- `:sudo_path`: Sudo binary directory.
+- `:sudo_password`
+- `:disable_sudo`: whether to disable Sudo (enabled by default).
+
+For example:
+
+```ruby
+set :sudo_password, 'mBnriM8SKhRtIww7xgUi'
+```
+
+## Testing
+
+See [TESTING.md](https://github.com/zuazo/specinfra-backend-docker_lxc/blob/master/TESTING.md).
+
+## Contributing
+
+Please do not hesitate to [open an issue](https://github.com/zuazo/specinfra-backend-docker_lxc/issues/new) with any questions or problems.
+
+See [CONTRIBUTING.md](https://github.com/zuazo/specinfra-backend-docker_lxc/blob/master/CONTRIBUTING.md).
+
+## TODO
+
+See [TODO.md](https://github.com/zuazo/specinfra-backend-docker_lxc/blob/master/TODO.md).
+
+## License and Author
+
+|                      |                                          |
+|:---------------------|:-----------------------------------------|
+| **Author:**          | [Xabier de Zuazo](https://github.com/zuazo) (<xabier@zuazo.org>)
+| **Copyright:**       | Copyright (c) 2015 Xabier de Zuazo
+| **License:**         | Apache License, Version 2.0
+
+    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/Rakefile

@@ -0,0 +1,57 @@
+# encoding: UTF-8
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# More info at https://github.com/ruby/rake/blob/master/doc/rakefile.rdoc
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+desc 'Clean some generated files'
+task :clean do
+  %w(
+    .bundle
+    .cache
+    coverage
+    doc
+    *.gem
+    Gemfile.lock
+    .inch
+    vendor
+    .yardoc
+  ).each { |f| FileUtils.rm_rf(Dir.glob(f)) }
+end
+
+desc 'Generate Ruby documentation'
+task :yard do
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    t.stats_options = %w(--list-undoc)
+  end
+end
+
+task doc: %w(yard)
+
+desc 'Run RuboCop style checks'
+task :rubocop do
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+end
+
+desc 'Run all style checks'
+task style: %w(rubocop)
+
+require 'rspec/core/rake_task'
+
+{
+  test: '{unit,integration}',
+  unit: 'unit',
+  integration: 'integration'
+}.each do |test, dir|
+  RSpec::Core::RakeTask.new(test) do |t|
+    t.pattern = "spec/#{dir}/**{,/*/**}/*_spec.rb"
+    t.verbose = true
+  end
+end
+
+task default: %w(style test)

data/TESTING.md

@@ -0,0 +1,30 @@
+# Testing
+
+## Installing the Requirements
+
+You can install gem dependencies with bundler:
+
+    $ gem install bundler
+    $ bundler install
+
+## Generate Documentation
+
+    $ bundle exec rake doc
+
+This will generate the HTML documentation in the `doc/` directory.
+
+## All the Tests
+
+    $ bundle exec rake test
+
+## Running the Syntax Style Tests
+
+    $ bundle exec rake style
+
+## Running the Unit Tests
+
+    $ bundle exec rake unit
+
+## Running the Integration Tests
+
+    $ bundle exec rake integration

data/TODO.md

@@ -0,0 +1,4 @@
+# TODO for specinfra-backend-docker_lxc
+
+* [ ] Add `.available?` method to check the availability of `lxc-attach` command.
+* [ ] Add `lxc_attach_path` option.

data/lib/specinfra/backend/docker_lxc.rb

@@ -0,0 +1,88 @@
+# encoding: UTF-8
+#
+# Author:: Xabier de Zuazo (<xabier@zuazo.org>)
+# Copyright:: Copyright (c) 2015 Xabier de Zuazo
+# License:: Apache License, Version 2.0
+#
+# 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 'specinfra/backend/docker'
+require 'specinfra/backend/docker_lxc/shell_helpers'
+require 'specinfra/backend/docker_lxc/exceptions'
+
+# Command Execution Framework for Serverspec, Itamae and so on.
+module Specinfra
+  # Specinfra backend types.
+  module Backend
+    # Specinfra and Serverspec backend for Docker LXC execution driver.
+    class DockerLxc < Docker
+      include Specinfra::Backend::DockerLxc::ShellHelpers
+
+      protected
+
+      # Generates `lxc-attach` command to run.
+      #
+      # @param cmd [String] the commands to run inside docker.
+      # @return [Array] the command to run as unescaped array.
+      def lxc_attach_command(cmd)
+        id = @container.id
+        ['lxc-attach', '-n', id, '--', 'sh', '-c', cmd]
+      end
+
+      # Parses `lxc-attach` command output and raises an exception if it is an
+      # error from the `lxc-attach` program.
+      #
+      # @param stderr [String] command *stderr* output.
+      # @param exit_status [Fixnum] command exit status.
+      # @return nil
+      def lxc_attach_result_assert(stderr, exit_status)
+        return if exit_status == 0
+        return if stderr.match(/\A(lxc-attach|lxc_container|sudo): /).nil?
+        fail LxcAttachError, stderr
+      end
+
+      # Parses a rescued exception and returns the command result.
+      #
+      # @param exception [Exception] the exception to parse.
+      # @param stdout [String] the *stdout* output.
+      # @param stderr [String] the *stderr* output.
+      # @param status [Fixnum] the command exit status.
+      # @return [Specinfra::CommandResult] the generated result object.
+      def erroneous_result(exception, stdout, stderr, status)
+        err =
+          stderr.nil? ? ([exception.message] + exception.backtrace) : [stderr]
+        sta = status.is_a?(Fixnum) && status != 0 ? status : 1
+        CommandResult.new(stdout: stdout, stderr: err.join, exit_status: sta)
+      end
+
+      # Runs a command inside a Docker container.
+      #
+      # @param cmd [String] the command to run.
+      # @param opts [Hash] options to pass to {Open3.popen3}.
+      # @return [Specinfra::CommandResult] the result.
+      def docker_run!(cmd, opts = {})
+        stdout, stderr, status = shell_command!(lxc_attach_command(cmd), opts)
+        lxc_attach_result_assert(stderr, status)
+        CommandResult.new(
+          stdout: stdout, stderr: stderr, exit_status: status
+        )
+      rescue LxcAttachError
+        raise
+      rescue => e
+        @container.kill
+        erroneous_result(e, stdout, stderr, status)
+      end
+    end
+  end
+end

data/lib/specinfra/backend/docker_lxc/exceptions.rb

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+#
+# Author:: Xabier de Zuazo (<xabier@zuazo.org>)
+# Copyright:: Copyright (c) 2015 Xabier de Zuazo
+# License:: Apache License, Version 2.0
+#
+# 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 Specinfra
+  module Backend
+    class DockerLxc < Docker
+      # Exception raised for `lxc-attach` command errors.
+      class LxcAttachError < RuntimeError; end
+    end
+  end
+end

data/lib/specinfra/backend/docker_lxc/shell_helpers.rb

@@ -0,0 +1,222 @@
+# encoding: UTF-8
+#
+# Author:: Xabier de Zuazo (<xabier@zuazo.org>)
+# Copyright:: Copyright (c) 2015 Xabier de Zuazo
+# License:: Apache License, Version 2.0
+#
+# 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 'open3'
+require 'shellwords'
+require 'etc'
+
+module Specinfra
+  module Backend
+    class DockerLxc < Docker
+      # Helpers to work with the shell and with `sudo`.
+      #
+      # Uses the following `Specinfra` configuration options:
+      #
+      # - `:sudo_options`: Sudo command argument list as string or as array.
+      # - `:sudo_path`: Sudo binary directory.
+      # - `:sudo_password`
+      # - `:disable_sudo`: whether to disable Sudo (enabled by default).
+      #
+      # Based on the official `Specinfra::Backend::Ssh` code.
+      #
+      # @example
+      #   class MyBackend < Specinfra::Backend::Base
+      #     include Specinfra::Backend::DockerLxc::ShellHelpers
+      #
+      #     def my_backend_run!
+      #       stdout, stderr, status = shell_command!('uname -a')
+      #       CommandResult.new(
+      #         stdout: stdout, stderr: stderr, exit_status: status
+      #       )
+      #     end
+      #   end
+      module ShellHelpers
+        protected
+
+        # Returns the prompt used by Sudo to ask for the password.
+        #
+        # @return [String] the prompt.
+        # @example
+        #   sudo_prompt #=> "Password: "
+        def sudo_prompt
+          'Password: '
+        end
+
+        # Reads the `:sudo_password` configuration option.
+        #
+        # @return [String] the password.
+        # @example
+        #   set :sudo_password, 'y0mVT1CYM0uRiHxjLfNV'
+        #   sudo_password #=> "y0mVT1CYM0uRiHxjLfNV"
+        def sudo_password
+          Specinfra.configuration.sudo_password
+        end
+
+        # Whether the `:sudo_password` is configured.
+        #
+        # @return [TrueClass, FalseClass] true if password is configured.
+        # @example
+        #   sudo_password? #=> false
+        def sudo_password?
+          sudo_password ? true : false
+        end
+
+        # Returns the Sudo program arguments to use by default.
+        #
+        # @return [String] the arguments properly escaped.
+        # @example
+        #   default_sudo_args #=> ""
+        #   default_sudo_args #=> "-S -p Password:\\ "
+        def default_sudo_args
+          args = []
+          args += ['-S', '-p', sudo_prompt] if sudo_password?
+          args.shelljoin
+        end
+
+        # Returns the Sudo program arguments.
+        #
+        # Includes both the default and the arguments configured using `set`.
+        #
+        # @return [String] the arguments properly escaped.
+        # @example
+        #   set :sudo_options, '-a -b -c'
+        #   sudo_args #=> "-S -p Password:\\  -a -b -c"
+        def sudo_args
+          sudo_options = Specinfra.configuration.sudo_options
+          if sudo_options
+            sudo_options = sudo_options.shelljoin if sudo_options.is_a?(Array)
+            "#{default_sudo_args} #{sudo_options}"
+          else
+            default_sudo_args
+          end
+        end
+
+        # Gets the Sudo binary path.
+        #
+        # @return [String] the Sudo binary.
+        # @example
+        #   sudo_bin #=> "sudo"
+        #   set :sudo_path, '/opt/sudo/bin'
+        #   sudo_bin #=> "/opt/sudo/bin/sudo"
+        def sudo_bin
+          sudo_path = Specinfra.configuration.sudo_path
+          sudo_bin = sudo_path ? "#{sudo_path}/sudo" : 'sudo'
+          sudo_bin.shellescape
+        end
+
+        # Adds Sudo to a command.
+        #
+        # @param cmd_str [String] the command to run. Must be escaped.
+        # @return [String] the command escaped and including `sudo`.
+        # @example
+        #   set :sudo_password, 'y0mVT1CYM0uRiHxjLfNV'
+        #   sudo_command('uname -a') #=> "sudo -S -p Password:\\  -- uname -a"
+        #   set :disable_sudo, true
+        #   sudo_command('uname -a') #=> "uname -a"
+        def sudo_command(cmd_str)
+          "#{sudo_bin} #{sudo_args} -- #{cmd_str}"
+        end
+
+        # Checks if we need to use Sudo.
+        #
+        # @return [TrueClass, FalseClass] whether we need to use Sudo.
+        # @example
+        #   sudo? #=> true
+        #   set :disable_sudo, true
+        #   sudo? #=> false
+        def sudo?
+          disable_sudo = Specinfra.configuration.disable_sudo
+          Etc.getlogin != 'root' && !disable_sudo
+        end
+
+        # Escapes a shell command.
+        #
+        # It only escapes it when passed as array.
+        #
+        # @param cmd [Array<String>, String] the command.
+        # @return [String] the command escaped.
+        # @example
+        #   escape_command(['sudo', '-p', 'Password: ')
+        #     #=> "sudo -p Password:\\ "
+        #   escape_command('uname -a') #=> "uname -a"
+        def escape_command(cmd)
+          return cmd if cmd.is_a?(String)
+          cmd.shelljoin
+        end
+
+        # Generates the command to run including the Sudo prefix if configured.
+        #
+        # The command needs to be escaped only if passed as string.
+        #
+        # @param cmd [Array<String>, String] the command.
+        # @return [String] the command escaped.
+        # @example
+        #   generate_escaped_command('uname -a') #=> "sudo uname -a"
+        #   set :sudo_password, 'y0mVT1CYM0uRiHxjLfNV'
+        #   generate_escaped_command('uname -a')
+        #     #=> "sudo -p Password:\\  uname -a"
+        #   set :disable_sudo, true
+        #   generate_escaped_command('uname -a') #=> "uname -a"
+        def generate_escaped_command(cmd)
+          if sudo?
+            sudo_command(escape_command(cmd))
+          else
+            escape_command(cmd)
+          end
+        end
+
+        # Writes the password to the *stdin* when asked on *stderr*.
+        #
+        # @param stdin [IO] stdin file descriptor.
+        # @param stderr [IO] stderr file descriptor.
+        # @return [String] the string read from stderr without including the
+        #   password prompt.
+        # @example
+        #   write_sudo_password(stdin, stderr) #=> ""
+        def write_sudo_password(stdin, stderr)
+          return '' unless sudo_password?
+          read = stderr.gets(sudo_prompt.length)
+          return read.to_s unless read == sudo_prompt
+          stdin.puts "#{sudo_password}\n"
+          ''
+        end
+
+        # Runs a command, including Sudo if required.
+        #
+        # If the command is passed as string, must be properly escaped.
+        #
+        # @param cmd [Array<String>, String] the command.
+        # @return [Array<String, Fixnum>] the array contents: *stdout*, *stderr*
+        #   and the *exit status*.
+        # @example
+        #   shell_command!('id')
+        #     #=> ["", "uid=0(root) gid=0(root) groups=0(root)\n", 0]
+        # @api public
+        def shell_command!(cmd, opts = {})
+          cmd_escaped = generate_escaped_command(cmd)
+          Open3.popen3(cmd_escaped, opts) do |stdin, stdout, stderr, wait_thr|
+            read = write_sudo_password(stdin, stderr)
+            stdin.close
+            [stdout.read, read + stderr.read, wait_thr.value.exitstatus]
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,56 @@
+# encoding: UTF-8
+#
+# Author:: Xabier de Zuazo (<xabier@zuazo.org>)
+# Copyright:: Copyright (c) 2015 Xabier de Zuazo
+# License:: Apache License, Version 2.0
+#
+# 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 'simplecov'
+if ENV['TRAVIS']
+  require 'coveralls'
+  SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+end
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+require 'specinfra'
+require 'specinfra/backend/docker_lxc'
+require 'docker'
+
+Specinfra.configuration.backend(:base)
+
+require 'should_not/rspec'
+
+require 'support/docker_logger'
+require 'support/rspec_filters'
+require 'support/disabled_docker_lxc'
+require 'support/docker_lxc_helpers'
+
+RSpec.configure do |config|
+  # Prohibit using the should syntax
+  config.expect_with :rspec do |spec|
+    spec.syntax = :expect
+  end
+
+  config.order = 'random'
+
+  config.color = true
+  config.tty = true
+
+  config.filter_run_excluding lxc_driver: true unless lxc_execution_driver?
+
+  config.before(:each) { DockerLxcHelpers.configuration_reset }
+end

metadata

@@ -0,0 +1,225 @@
+--- !ruby/object:Gem::Specification
+name: specinfra-backend-docker_lxc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Xabier de Zuazo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: specinfra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: should_not
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.35.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.35.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: docker-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+- !ruby/object:Gem::Dependency
+  name: serverspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.24'
+description: Serverspec/Specinfra backend for Docker LXC execution driver.
+email: xabier@zuazo.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE
+- README.md
+- Rakefile
+- TESTING.md
+- TODO.md
+- lib/specinfra/backend/docker_lxc.rb
+- lib/specinfra/backend/docker_lxc/exceptions.rb
+- lib/specinfra/backend/docker_lxc/shell_helpers.rb
+- spec/spec_helper.rb
+homepage: https://github.com/zuazo/specinfra-backend-docker_lxc
+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: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Specinfra Docker LXC Backend
+test_files:
+- spec/spec_helper.rb
+has_rdoc: