elecksee 1.0.22 → 1.1.0

data/lib/elecksee/storage/overlay_directory.rb

@@ -1,50 +1,81 @@
-require 'elecksee/helpers/base'
+require 'elecksee'
 
 class Lxc
-  class OverlayDirectory
-    
-    attr_reader :name
-    attr_reader :tmp_dir
-
-    include Helpers
-    
-    def initialize(name, args={})
-      @name = name
-      @tmp_dir = args[:tmp_dir] || '/tmp/lxc/ephemerals'
-      create
-    end
+  module Storage
+    # Overlay directory backed storage
+    class OverlayDirectory
 
-    def overlay_path
-      File.join(tmp_dir, 'virt-overlays', name)
-    end
-    alias_method :target_path, :overlay_path
+      # @return [String] storage name (usually container name)
+      attr_reader :name
+      # @return [String] path to temporary directory
+      attr_reader :tmp_dir
 
-    def create
-      unless(File.directory?(overlay_path))
-        FileUtils.mkdir_p(overlay_path)
+      include Helpers
+
+      # Create new instance
+      #
+      # @param name [String] storage name (usually container name)
+      # @param args [Hash]
+      # @option args [String] :tmp_dir path to temporary directory
+      def initialize(name, args={})
+        @name = name
+        @tmp_dir = args[:tmp_dir] || '/tmp/lxc/ephemerals'
+        create
       end
-    end
 
-    def destroy
-      if(File.directory?(overlay_path))
-        command("rm -rf #{overlay_path}", :sudo => true)
+      # @return [String] path to overlay directory
+      def overlay_path
+        File.join(tmp_dir, 'virt-overlays', name)
+      end
+      alias_method :target_path, :overlay_path
+
+      # Create the storage
+      #
+      # @return [TrueClass, FalseClass]
+      def create
+        unless(File.directory?(overlay_path))
+          FileUtils.mkdir_p(overlay_path)
+          true
+        else
+          false
+        end
+      end
+
+      # Destroy the storage
+      #
+      # @return [TrueClass, FalseClass]
+      def destroy
+        if(File.directory?(overlay_path))
+          command("rm -rf #{overlay_path}", :sudo => true)
+          true
+        else
+          false
+        end
       end
-    end
-    
-  end
 
-  # Clone directory does the same as the overlay, just in
-  # a persistent place
-  class CloneDirectory < OverlayDirectory
-    def initialize(name, args={})
-      args[:tmp_dir] = args[:dir] if args[:dir]
-      args[:tmp_dir] || '/var/lib/lxc'
-      super
     end
 
-    def overlay_path
-      File.join(tmp_dir, name)
+    # Clone directory does the same as the overlay, just in
+    # a persistent location
+    class CloneDirectory < OverlayDirectory
+
+      # Create new instance
+      #
+      # @param name [String] name of storage (usually container name)
+      # @param args [Hash]
+      # @option args [String] :dir persistent storage path
+      def initialize(name, args={})
+        args[:tmp_dir] = args[:dir] if args[:dir]
+        args[:tmp_dir] || '/var/lib/lxc'
+        super
+      end
+
+      # @return [String]
+      def overlay_path
+        File.join(tmp_dir, name)
+      end
+      alias_method :target_path, :overlay_path
     end
-    alias_method :target_path, :overlay_path
+
   end
 end

data/lib/elecksee/storage/overlay_mount.rb

@@ -1,60 +1,95 @@
-require 'elecksee/helpers/base'
+require 'elecksee'
 
 class Lxc
-  class OverlayMount
-
-    include Helpers
-    
-    attr_reader :base
-    attr_reader :overlay
-    attr_reader :target
-    attr_reader :overlay_type
-    
-    def initialize(args={})
-      validate!(args)
-      @base = args[:base]
-      @overlay = args[:overlay]
-      @target = args[:target]
-      @overlay_type = args[:overlay_type] || 'overlayfs'
-    end
+  module Storage
+    # Overlay mount backed storage
+    class OverlayMount
+
+      include Helpers
+
+      # @return [String] base path to overlay
+      attr_reader :base
+      # @return [String] path to overlay storage
+      attr_reader :overlay
+      # @return [String] path to mount overlay
+      attr_reader :target
+      # @return [String] type of overlay to implement
+      attr_reader :overlay_type
+
+      # Create new instance
+      #
+      # @param args [Hash]
+      # @option args [String] :base base path to overlay
+      # @option args [String] :overlay path to overlay storage
+      # @option args [String] :target path to mount overlay
+      # @option args [String] :overlay_type type of overlay to implement
+      # @note :overlay_type defaults to overlayfs
+      def initialize(args={})
+        validate!(args)
+        @base = args[:base]
+        @overlay = args[:overlay]
+        @target = args[:target]
+        @overlay_type = args[:overlay_type] || 'overlayfs'
+      end
 
-    def mount
-      unless(mounted?)
-        case overlay_type
-        when 'aufs'
-          cmd = "mount -t aufs -o br=#{overlay}=rw:#{base}=ro,noplink none #{target}"
-        when 'overlayfs'
-          cmd = "mount -t overlayfs -oupperdir=#{overlay},lowerdir=#{base} none #{target}"
+      # Mount the overlay
+      #
+      # @return [TrueClass, FalseClass]
+      def mount
+        unless(mounted?)
+          case overlay_type
+          when 'aufs'
+            cmd = "mount -t aufs -o br=#{overlay}=rw:#{base}=ro,noplink none #{target}"
+          when 'overlayfs'
+            cmd = "mount -t overlayfs -oupperdir=#{overlay},lowerdir=#{base} none #{target}"
+          else
+            raise "Invalid overlay type provided: #{overlay_type}"
+          end
+          command(cmd, :sudo => true)
+          true
         else
-          raise "Invalid overlay type provided: #{overlay_type}"
+          false
         end
-        command(cmd, :sudo => true)
-        true
       end
-    end
 
-    def mounted?
-      command("mount").stdout.include?(target)
-    end
-    
-    def unmount
-      if(mounted?)
-        command("umount #{target}", :sudo => true, :allow_failure => true)
-        true
+      # @return [TrueClass, FalseClass]
+      def mounted?
+        command("mount").stdout.include?(target)
       end
-    end
-
-    private
 
-    def validate!(args)
-      [:base, :overlay, :target].each do |required|
-        unless(args[required])
-          raise ArgumentError.new "Missing required argument: #{required}"
+      # Unmount the overlay
+      #
+      # @return [TrueClass, FalseClass]
+      def unmount
+        if(mounted?)
+          command("umount #{target}", :sudo => true, :allow_failure => true)
+          true
+        else
+          false
         end
-        unless(File.directory?(args[required]))
-          raise TypeError.new "Provided argument is not a valid directory for #{required}: #{args[required]}"
+      end
+
+      private
+
+      # Validate the provide arguments
+      #
+      # @param args [Hash]
+      # @option args [String] :base
+      # @option args [String] :overlay
+      # @option args [String] :target
+      # @return [TrueClass]
+      def validate!(args)
+        [:base, :overlay, :target].each do |required|
+          unless(args[required])
+            raise ArgumentError.new "Missing required argument: #{required}"
+          end
+          unless(File.directory?(args[required]))
+            raise TypeError.new "Provided argument is not a valid directory for #{required}: #{args[required]}"
+          end
         end
+        true
       end
+
     end
   end
 end

data/lib/elecksee/storage/virtual_device.rb

@@ -1,84 +1,128 @@
-require 'elecksee/helpers/base'
+require 'elecksee'
 
 class Lxc
+  module Storage
+    # Virtual device backed storage
+    class VirtualDevice
 
-  class VirtualDevice
+      include Helpers
 
-    include Helpers
+      # @return [String] storage name (usually container name)
+      attr_reader :name
+      # @return [String] path to temporary directory
+      attr_reader :tmp_dir
+      # @return [Integer] device size
+      attr_reader :size
+      # @return [TrueClass, FalseClass] use tmpfs
+      attr_reader :tmp_fs
+      # @return [String] file system to format (defaults ext4)
+      attr_reader :fs_type
 
-    attr_reader :name
-    attr_reader :tmp_dir
-    attr_reader :size
-    attr_reader :tmp_fs
-    attr_reader :fs_type
-
-    def initialize(name, args={})
-      @name = name
-      @tmp_dir = args[:tmp_dir] || '/tmp/lxc/ephemerals'
-      @size = args[:size] || 2000
-      @fs_type = args[:fs_type] || 'ext4'
-      @tmp_fs = !!args[:tmp_fs]
-      @fs_type = 'tmpfs' if @tmp_fs
-      create
-    end
+      # Create new instance
+      #
+      # @param name [String] generally container name
+      # @param args [Hash]
+      # @option args [String] :tmp_dir temporary directory
+      # @option args [Integer] :size size of device
+      # @option args [String] :fs_type file system to format
+      # @option args [TrueClass, FalseClass] :tmp_fs
+      def initialize(name, args={})
+        @name = name
+        @tmp_dir = args[:tmp_dir] || '/tmp/lxc/ephemerals'
+        @size = args[:size] || 2000
+        @fs_type = args[:fs_type] || 'ext4'
+        @tmp_fs = !!args[:tmp_fs]
+        @fs_type = 'tmpfs' if @tmp_fs
+        create
+      end
 
-    def device_path
-      tmp_fs ? :none : File.join(tmp_dir, 'virt-imgs', name)
-    end
+      # @return [String] path to device
+      def device_path
+        tmp_fs ? :none : File.join(tmp_dir, 'virt-imgs', name)
+      end
 
-    def mount_path
-      File.join(tmp_dir, 'virt-mnts', name)
-    end
-    alias_method :target_path, :mount_path
+      # @return [String] path to mount
+      def mount_path
+        File.join(tmp_dir, 'virt-mnts', name)
+      end
+      alias_method :target_path, :mount_path
 
-    def create
-      make_directories!
-      unless(tmp_fs)
-        command("dd if=/dev/zero of=#{@device_path} bs=1k seek=#{sive}k count=1 > /dev/null")
-        command("echo \"y\" | mkfs -t #{fs_type} #{size} > /dev/null")
+      # Create the storage
+      #
+      # @return [TrueClass, FalseClass]
+      def create
+        make_directories!
+        unless(tmp_fs)
+          command("dd if=/dev/zero of=#{@device_path} bs=1k seek=#{sive}k count=1 > /dev/null")
+          command("echo \"y\" | mkfs -t #{fs_type} #{size} > /dev/null")
+          true
+        else
+          false
+        end
       end
-    end
 
-    def mounted?
-      command("mount").stdout.include?(mount_path)
-    end
+      # @return [TrueClass, FalseClass] device currently mounted
+      def mounted?
+        command("mount").stdout.include?(mount_path)
+      end
 
-    def mount
-      unless(mounted?)
-        command("mount -t #{fs_type}#{mount_options} #{device_path} #{mount_path}", :sudo => true)
-        true
+      # @return [TrueClass, FalseClass] mount device
+      def mount
+        unless(mounted?)
+          command("mount -t #{fs_type}#{mount_options} #{device_path} #{mount_path}", :sudo => true)
+          true
+        else
+          false
+        end
       end
-    end
 
-    def unmount
-      if(mounted?)
-        command("umount #{mount_path}", :sudo => true)
-        true
+      # @return [TrueClass, FalseClass] unmount device
+      def unmount
+        if(mounted?)
+          command("umount #{mount_path}", :sudo => true)
+          true
+        else
+          false
+        end
       end
-    end
 
-    def destroy
-      unmount
-      unless(device_path == :none)
-        File.delete(device_path) if File.file?(device_path)
-        FileUtils.rm_rf(device_path) if File.directory?(device_path)
+      # Destroy the storage device
+      #
+      # @return [TrueClass]
+      def destroy
+        unmount
+        unless(device_path == :none)
+          File.delete(device_path) if File.file?(device_path)
+          FileUtils.rm_rf(device_path) if File.directory?(device_path)
+        end
+        unless(mount_path == :none)
+          if(File.directory?(mount_path))
+            FileUtils.rmdir(mount_path)
+          end
+        end
+        true
       end
-      FileUtils.rmdir(mount_path) if File.directory?(mount_path) unless mount_path == :none
-    end
 
-    private
+      private
 
-    def mount_options
-      ' -o loop' unless tmp_fs
-    end
+      # @return [String] options for device mount
+      def mount_options
+        ' -o loop' unless tmp_fs
+      end
 
-    def make_directories!
-      [device_path, mount_path].each do |path|
-        next if path == :none
-        unless(File.directory?(path))
-          FileUtils.mkdir_p(path)
+      # Create required directories
+      #
+      # @return [TrueClass]
+      def make_directories!
+        [device_path, mount_path].each do |path|
+          next if path == :none
+          unless(File.directory?(path))
+            FileUtils.mkdir_p(path)
+          end
         end
+        true
       end
+
     end
   end
 end

data/lib/elecksee/storage.rb

@@ -0,0 +1,13 @@
+require 'elecksee'
+
+class Lxc
+  # Container storage backers
+  module Storage
+
+    autoload :CloneDirectory, 'elecksee/storage/overlay_directory'
+    autoload :OverlayDirectory, 'elecksee/storage/overlay_directory'
+    autoload :OverlayMount, 'elecksee/storage/overlay_mount'
+    autoload :VirtualDevice, 'elecksee/storage/virtual_device'
+
+  end
+end

data/lib/elecksee/version.rb

@@ -1,3 +1,4 @@
 module Elecksee
-  VERSION = Gem::Version.new('1.0.22')
+  # Current library version
+  VERSION = Gem::Version.new('1.1.0')
 end

data/lib/elecksee.rb

@@ -1 +1,14 @@
 require 'elecksee/version'
+
+# LXC interface
+class Lxc
+  autoload :Clone, 'elecksee/clone'
+  autoload :Ephemeral, 'elecksee/ephemeral'
+  autoload :Helpers, 'elecksee/helpers'
+  autoload :CommandFailed, 'elecksee/helpers'
+  autoload :Timeout,'elecksee/helpers'
+  autoload :CommandResult, 'elecksee/helpers'
+  autoload :Storage, 'elecksee/storage'
+end
+
+require 'elecksee/lxc'

metadata

@@ -1,46 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: elecksee
 version: !ruby/object:Gem::Version
-  version: 1.0.22
-  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-13 00:00:00.000000000 Z
+date: 2015-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: mixlib-shellout
+  name: childprocess
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: net-ssh
+  name: rye
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: LXC helpers
@@ -50,49 +45,47 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE
+- README.md
+- bin/lxc-awesome-ephemeral
 - elecksee.gemspec
+- lib/elecksee.rb
 - lib/elecksee/clone.rb
-- lib/elecksee/version.rb
-- lib/elecksee/lxc_file_config.rb
+- lib/elecksee/ephemeral.rb
+- lib/elecksee/helpers.rb
 - lib/elecksee/helpers/copies.rb
 - lib/elecksee/helpers/options.rb
-- lib/elecksee/helpers/base.rb
-- lib/elecksee/knife/config.rb
+- lib/elecksee/lxc.rb
+- lib/elecksee/lxc_file_config.rb
+- lib/elecksee/storage.rb
+- lib/elecksee/storage/overlay_directory.rb
 - lib/elecksee/storage/overlay_mount.rb
 - lib/elecksee/storage/virtual_device.rb
-- lib/elecksee/storage/overlay_directory.rb
-- lib/elecksee/ephemeral.rb
-- lib/elecksee/lxc.rb
-- lib/elecksee.rb
-- Gemfile
-- README.md
-- LICENSE
-- bin/lxc-awesome-ephemeral
-- CHANGELOG.md
-- Gemfile.lock
+- lib/elecksee/version.rb
 homepage: http://github.com/chrisroberts/elecksee
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: LXC helpers
 test_files: []
 has_rdoc: 

data/Gemfile

@@ -1,5 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'childprocess'
-
-gemspec

data/Gemfile.lock

@@ -1,22 +0,0 @@
-PATH
-  remote: .
-  specs:
-    elecksee (1.0.21)
-      mixlib-shellout
-      net-ssh
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    childprocess (0.3.9)
-      ffi (~> 1.0, >= 1.0.11)
-    ffi (1.9.3)
-    mixlib-shellout (1.3.0)
-    net-ssh (2.7.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  childprocess
-  elecksee!

data/lib/elecksee/knife/config.rb

@@ -1,37 +0,0 @@
-require 'chef/mash'
-require 'chef/json_compat'
-
-class Lxc
-  class Knife
-    class Config
-
-      attr_reader :base_path
-      attr_reader :store
-
-      def initialize(args={})
-        
-        
-      def initialize(path='/etc/knife-lxc/config.json')
-        if(File.exists?(path))
-          @base_path = path
-          @store = Chef::JSONCompat.from_json(File.read(path))
-        else
-          raise ArgumentError.new("Provided path is not valid: #{path}")
-        end
-      end
-
-      def [](k)
-        @store[k]
-      end
-
-      def 
-      
-      def used_addresses
-      end
-
-      def available_addresses
-      end
-      
-    end
-  end
-end