lxc 0.0.1 → 0.0.2

data/.gitignore

@@ -15,3 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+*log
+.rvmrc

data/.rspec

@@ -0,0 +1 @@
+-c -b -fd

data/.rvmrc.template

@@ -0,0 +1 @@
+rvm use ruby-1.9.3@lxc --create

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+
+before_install:
+  - sudo apt-get -qq --force-yes update
+
+bundler_args: --binstubs
+
+script: "bin/rake test"
+
+notifications:
+  irc: "irc.freenode.net#jovelabs"

data/LICENSE

@@ -1,22 +1,202 @@
-Copyright (c) 2012 Zachary Patten
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+                                 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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

@@ -1,29 +1,41 @@
+[![Build Status](https://secure.travis-ci.org/zpatten/lxc.png)](http://travis-ci.org/zpatten/lxc)
+[![Code Climate](https://codeclimate.com/github/zpatten/lxc.png)](https://codeclimate.com/github/zpatten/lxc)
+[![Dependency Status](https://gemnasium.com/zpatten/lxc.png)](https://gemnasium.com/zpatten/lxc)
+
 # LXC
 
-Gem for controlling local or remote Linux Containers (LXC)
+An interface for controlling local or remote Linux Containers (LXC).
+
+# RESOURCES
+
+Documentation:
 
-## Installation
+* http://zpatten.github.io/lxc/
 
-Add this line to your application's Gemfile:
+Source:
 
-    gem 'lxc'
+* https://github.com/zpatten/lxc
 
-And then execute:
+Issues:
 
-    $ bundle
+* https://github.com/zpatten/lxc/issues
 
-Or install it yourself as:
+# LICENSE
 
-    $ gem install lxc
+LXC - An interface for controlling local or remote Linux Containers (LXC)
 
-## Usage
+* Author: Zachary Patten <zachary@jovelabs.com> [![endorse](http://api.coderwall.com/zpatten/endorsecount.png)](http://coderwall.com/zpatten)
+* Copyright: Copyright (c) Zachary Patten
+* License: Apache License, Version 2.0
 
-TODO: Write usage instructions here
+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
 
-## Contributing
+    http://www.apache.org/licenses/LICENSE-2.0
 
-1. Fork it
-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
+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

@@ -1,2 +1,82 @@
-#!/usr/bin/env rake
-require "bundler/gem_tasks"
+################################################################################
+#
+#      Author: Zachary Patten <zachary@jovelabs.net>
+#   Copyright: Copyright (c) Zachary Patten
+#     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 'bundler/gem_tasks'
+
+################################################################################
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+task :test => :spec
+
+################################################################################
+
+desc "Run RSpec with code coverage"
+task :coverage do
+  `rake spec COVERAGE=true`
+  case RUBY_PLATFORM
+  when /darwin/
+    `open coverage/index.html`
+  when /linux/
+    `google-chrome coverage/index.html`
+  end
+end
+
+################################################################################
+
+require 'yard'
+require 'yard/rake/yardoc_task'
+
+GEM_NAME = File.basename(Dir.pwd)
+DOC_PATH = File.expand_path(File.join("..", "/", "#{GEM_NAME}.doc"))
+
+namespace :doc do
+  YARD::Rake::YardocTask.new(:pages) do |t|
+
+    # t.files = ['lib/**/*.rb']
+    t.options = ['--verbose', '-o', DOC_PATH]
+  end
+
+  namespace :pages do
+
+    desc 'Generate and publish YARD Documentation to GitHub pages'
+    task :publish => ['doc:pages'] do
+      describe = %x(git describe).chomp
+      stats = %x(bundle exec yard stats).chomp
+
+      commit_message = Array.new
+      commit_message << "Generated YARD Documentation for #{GEM_NAME.upcase} #{describe}\n\n"
+      commit_message << stats
+
+      Dir.chdir(DOC_PATH) do
+        puts(%x{git add -Av})
+        puts(%x{git commit -m"#{commit_message.join}"})
+        puts(%x{git push origin gh-pages})
+      end
+    end
+
+  end
+
+end
+desc 'Alias to doc:yard'
+task 'doc' => 'doc:yard'
+
+################################################################################

data/bin/lxc-console

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+def lxc_console
+  require 'pry'
+  require 'lxc'
+
+  ##
+  #
+  # Welcome to the LXC RubyGem console!
+  #
+  ##
+  binding.pry
+end
+
+begin
+  lxc_console
+rescue LoadError => e
+  puts "This command should only be executed in development environments; this does not appear to be one!"
+end

data/lib/lxc.rb

@@ -1,5 +1,180 @@
-require "lxc/version"
+require 'ztk'
+
+require 'lxc/version'
+
+# Main LXC (Linux Container) Class
+#
+# @author Zachary Patten <zachary@jovelabs.net>
+class LXC
+
+  # Top-Level Error Class
+  class Error < StandardError; end
+
+  autoload :Container, 'lxc/container'
+
+  # Controls if sudo is prefixed on all executed commands.
+  #
+  # @overload use_sudo=(value)
+  #   Sets if all executed commands should be prefixed with sudo.
+  #   @param [Boolean] value
+  #
+  # @overload use_sudo
+  #   Gets if we are prefixing all executed commands with sudo.
+  #
+  # @return [Boolean] Returns true if we are prefixing commands with "sudo";
+  #   otherwise false.
+  attr_accessor :use_sudo
+
+  # Controls if executed commands run locally or remotely via a Net::SSH
+  # Session.
+  #
+  # @overload use_ssh=(value)
+  #   Sets if all executed commands should be run locally or remotely.
+  #   To force commands to run locally, assign a value of nil (default).
+  #   To force commands to run remotely, assign a valid, active, Net::SSH
+  #   Session.
+  #
+  # @overload use_ssh
+  #   Gets if we are executing commands locally or remotely.
+  #
+  # @return [Net::SSH::Connection::Session] Returns nil if disabled; otherwise
+  #   returns the assigned Net::SSH Session object.
+  attr_accessor :use_ssh
+
+  # RegEx pattern for extracting the LXC Version from the "lxc-version" command
+  # output.
+  REGEX_VERSION = /^lxc version:\s+([\w\W]+)$/
+
+  def initialize
+    @use_sudo = false
+    @use_ssh  = nil
+  end
+
+  # Initialize container object
+  #
+  # Initalizes an LXC::Container class for the supplied container name.
+  #
+  # @param [String] name The container name to initalize.
+  # @return [LXC::Container] Returns the container object.
+  def container(name)
+    LXC::Container.new(self, name)
+  end
+
+  # Current containers
+  #
+  # Initalizes an LXC::Container object for all containers and returns them in
+  # an Array.
+  #
+  # @return [Array<LXC::Container>]
+  def containers
+    container_names = self.ls
+    container_names.map do |container_name|
+      LXC::Container.new(self, container_name)
+    end
+  end
+
+  # List of containers
+  #
+  # Runs the "lxc-ls" command.
+  #
+  # @param [Array] args Additional command-line arguments.
+  # @return [Array<String>] A list of container names.
+  def ls(*args)
+    self.exec("ls", *args).split("\n").uniq
+  end
+
+  # Check if a container exists
+  #
+  # Checks the container name list to see if the name supplied is an existing
+  # container.
+  #
+  # @param [String] name The name of the container to check.
+  # @return [Boolean] Returns true of the container exists, false otherwise.
+  def exists?(name)
+    self.ls.include?(name)
+  end
+
+  # Linux container processes
+  #
+  # Runs the "lxc-ps" command.
+  #
+  # @param [Array] args Additional command-line arguments.
+  # @return [Array<String>] Output text of the "lxc-ps" command.
+  def ps(*args)
+    self.exec("ps", *args).split("\n")
+  end
+
+  # Linux container version
+  #
+  # Runs the "lxc-version" command.
+  #
+  # @param [Array] args Additional command-line arguments.
+  # @return [String] The installed version of LXC.
+  def version(*args)
+    result = self.exec("version", *args).scan(REGEX_VERSION)
+    result.flatten!.compact!
+
+    result.first.strip
+  end
+
+  # Linux container configuration check
+  #
+  # Runs the "lxc-checkconfig" command.
+  #
+  # @param [Array] args Additional command-line arguments.
+  # @return [Array<String>] Output text of the "lxc-ps" command.
+  def checkconfig(*args)
+    self.exec("checkconfig", *args).split("\n")
+  end
+
+  # Linux container command execution wrapper
+  #
+  # Runs the supplied LXC command.  The first element in the "args" splat is the
+  # command to be execute, the rest of the elements are treated as command line
+  # arguments.
+  #
+  # If use_sudo is true then all commands will be prefix with "sudo".
+  # If use_ssh is non-nil then all commands will be execute via the assigned
+  # Net::SSH Session.
+  #
+  # No internal checking is performed against the object assigned to use_ssh as
+  # to avoid an un-necessary direct dependency on the net-ssh gems.
+  #
+  # @param [Array] args Additional command-line arguments.
+  # @return [Array<String>] Stripped output text of the executed command.
+  def exec(*args)
+    command = args.shift
+
+    arguments = Array.new
+    arguments << "sudo" if (@use_sudo == true)
+    arguments << "lxc-#{command}"
+    arguments << args
+    arguments = arguments.flatten.compact.join(' ')
+
+    output = Array.new
+
+    if @use_ssh.nil?
+      ::ZTK::PTY.spawn(arguments) do |reader, writer, pid|
+        while (buffer = reader.readpartial(1024))
+          output << buffer
+        end
+      end
+    else
+      output << @use_ssh.exec!(arguments)
+    end
+
+    output.join.strip
+  end
+
+  # Provides a concise string representation of the class
+  # @return [String]
+  def inspect
+    tags = Array.new
+    tags << "use_sudo=#{@use_sudo}" if @use_sudo
+    tags << (@use_ssh.nil? ? "use_ssh=false" : "use_ssh=true")
+    tags = tags.join(' ')
+
+    "#<LXC #{tags}>"
+  end
 
-module Lxc
-  # Your code goes here...
 end