vos 0.0.4 → 0.1.0

data/Rakefile

@@ -2,8 +2,8 @@ require 'rake_ext'
 
 project(
   name: "vos",
-  version: "0.0.4",
-  summary: "Tiny wrapper over Net::SSH/SFTP + small rake addon for cluster configuration management",
+  version: "0.1.0",
+  summary: "Virtual Operating System",
 
   author: "Alexey Petrushin",
   homepage: "http://github.com/alexeypetrushin/vos"

data/lib/vos/box/marks.rb

@@ -0,0 +1,31 @@
+module Vos
+  class Box
+    module Marks
+      def mark key
+        ensure_mark_requrements!
+        file("#{marks_dir}/#{key}").create!
+      end
+
+      def has_mark? key
+        ensure_mark_requrements!
+        entry["#{marks_dir}/#{key}"].exist?
+      end
+    
+      def clear_marks
+        bash "rm -r #{marks_dir}"
+      end
+    
+      protected
+        def marks_dir
+          home "/.marks"
+        end
+
+        def ensure_mark_requrements!
+          unless @ensure_mark_requrements
+            self.dir(marks_dir).create
+            @ensure_mark_requrements = true
+          end
+        end
+    end
+  end
+end

data/lib/vos/box/shell.rb

@@ -0,0 +1,87 @@
+module Vos
+  class Box
+    module Shell                
+      def bash cmd, *args
+        self['/'].bash cmd, *args
+      end
+      
+      def bash_without_path cmd, *args
+        check = args.shift if args.first.is_a?(Regexp)
+        options = args.last || {}
+
+        cmd = env cmd
+        code, stdout_and_stderr = open{driver.bash cmd}
+
+        unless code == 0
+          puts stdout_and_stderr
+          raise "can't execute '#{cmd}'!" 
+        end
+
+        if check and (stdout_and_stderr !~ check)
+          puts stdout_and_stderr
+          raise "output not match with #{check.inspect}!"
+        end
+
+        stdout_and_stderr
+      end
+    
+      def exec cmd
+        open{driver.exec(env(cmd))}
+      end
+      
+      attr_writer :env
+      def env command_or_env_variables = nil, &block
+        @env ||= default_env
+        
+        if block                    
+          before = env.clone
+          begin            
+            if variables = command_or_env_variables
+              raise 'invalid arguments' unless variables.is_a? Hash
+              @env.merge! variables
+            end
+            block.call
+          ensure
+            @env = before
+          end
+        else
+          if command_or_env_variables == nil
+            @env
+          elsif command_or_env_variables.is_a? String
+            cmd = command_or_env_variables
+            env_str = env.to_a.collect{|k, v| "#{k}=#{v}"}.join(' ')
+            wrap_cmd env_str, cmd
+          elsif command_or_env_variables.is_a? Hash
+            variables = command_or_env_variables
+            @env.merge! variables
+          else
+            raise 'invalid arguments'
+          end
+        end
+      end      
+      def default_env
+        {}
+      end
+      def wrap_cmd env_str, cmd
+        %(#{env_str}#{' && ' unless env_str.empty?}#{cmd})
+      end
+      
+    
+      def home path = nil
+        open{@home = bash('cd ~; pwd').gsub("\n", '')} unless @home
+        path ? self[@home][path] : self[@home]
+      end    
+    
+      # def generate_tmp_dir_name
+      #   open do
+      #     driver.generate_tmp_dir_name
+      #   end
+      # end
+    
+      # def inspect
+      #   "<Box: #{options[:host]}>"
+      # end
+      # alias_method :to_s, :inspect
+    end
+  end
+end

data/lib/vos/box/vfs.rb

@@ -0,0 +1,43 @@
+module Vos
+  class Box
+    module Vfs
+      def open_fs &block
+        open &block
+      end
+      
+      def to_entry
+        '/'.to_entry_on(self)
+      end
+      
+      def to_file
+        to_entry.file
+      end
+      
+      def to_dir
+        to_entry
+      end
+      
+      # def [] path
+      #   to_entry[path]
+      # end
+      # alias_method :/, :[]
+            
+      %w(dir file entry entries [] / tmp).each do |m|
+        script = <<-RUBY
+          def #{m} *a, &b
+            to_entry.#{m} *a, &b
+          end
+        RUBY
+        eval script, binding, __FILE__, __LINE__
+      end
+    end
+  end
+end
+
+module Vfs
+  class Dir
+    def bash cmd, *args      
+      storage.bash_without_path "cd #{path} && #{cmd}", *args
+    end
+  end
+end

data/lib/vos/box.rb

@@ -0,0 +1,45 @@
+module Vos
+  class Box
+    include Shell, Marks, Vfs
+    
+    attr_accessor :options
+    
+    def initialize options = {}
+      @options = options
+      options[:host] ||= 'localhost'
+    end
+
+
+    # 
+    # driver
+    # 
+    def driver
+      unless @driver
+        klass = options[:host] == 'localhost' ? Drivers::Local : Drivers::Ssh
+        @driver = klass.new options
+      end
+      @driver
+    end
+    
+    def open &block
+      driver.open &block
+    end    
+    def close
+      driver.close
+    end
+
+    
+    # 
+    # Micelaneous
+    # 
+    def inspect
+      host = options[:host]
+      if host == 'localhost'
+        ''
+      else
+        host
+      end
+    end
+    alias_method :to_s, :inspect
+  end
+end

data/lib/{rsh → vos}/drivers/abstract.rb

@@ -1,4 +1,4 @@
-module Rsh
+module Vos
   module Drivers
     class Abstract
       attr_reader :options
@@ -6,10 +6,6 @@ module Rsh
       def initialize options = {}
         @options = options
       end
-        
-      def generate_tmp_dir_name
-        "/tmp/ssh_tmp_dir_#{rand(10**6)}"
-      end
     end
   end
 end

data/lib/vos/drivers/local.rb

@@ -0,0 +1,38 @@
+require 'vfs/storages/local'
+
+module Vos
+  module Drivers
+    class Local < Abstract
+      # 
+      # Vfs
+      # 
+      include Vfs::Storages::Local::LocalVfsHelper
+      def open &block
+        block.call self if block
+      end
+      alias_method :open_fs, :open
+      def close; end
+      
+      
+      # 
+      # Shell
+      # 
+      def exec command        
+        code, stdout, stderr = Open3.popen3 command do |stdin, stdout, stderr, waitth|  
+          [waitth.value.to_i, stdout.read, stderr.read]
+        end
+      
+        return code, stdout, stderr
+      end
+      
+      
+      def bash command
+        code, stdout_and_stderr = Open3.popen2e command do |stdin, stdout_and_stderr, wait_thread|  
+          [wait_thread.value.to_i, stdout_and_stderr.read]
+        end
+      
+        return code, stdout_and_stderr
+      end
+    end
+  end
+end

data/lib/vos/drivers/specification.rb

@@ -0,0 +1,15 @@
+shared_examples_for 'vos driver' do  
+  describe "shell" do
+    it 'exec' do
+      @driver.open do |d|
+        d.exec("echo 'ok'").should == [0, "ok\n", ""]
+      end
+    end  
+    
+    it 'bash' do
+      @driver.open do |d|
+        d.bash("echo 'ok'").should == [0, "ok\n"]
+      end
+    end
+  end
+end

data/lib/vos/drivers/ssh.rb

@@ -0,0 +1,256 @@
+require 'net/ssh'
+require 'net/sftp'
+
+module Vos
+  module Drivers
+    class Ssh < Abstract      
+      module VfsStorage
+        # 
+        # Attributes
+        # 
+        def attributes path
+
+          stat = sftp.stat! fix_path(path)
+          attrs = {}
+          attrs[:file] = stat.file?
+          attrs[:dir] = stat.directory?
+          # stat.symlink?
+          attrs                  
+        rescue Net::SFTP::StatusException
+          {}
+        end
+
+        def set_attributes path, attrs      
+          raise 'not supported'
+        end
+
+        # 
+        # File
+        # 
+        def read_file path, &block
+          sftp.file.open fix_path(path), 'r' do |is|
+            while buff = is.gets
+              block.call buff
+            end
+          end
+        end
+
+        def write_file path, append, &block  
+          # there's no support for :append in Net::SFTP, so we just mimic it      
+          if append          
+            attrs = attributes(path)
+            data = if attrs
+              if attrs[:file]
+                os = ""
+                read_file(path){|buff| os << buff}
+                delete_file path                
+                os
+              else
+                raise "can't append to dir!"
+              end
+            else
+              ''
+            end
+            write_file path, false do |writer|
+              writer.call data
+              block.call writer
+            end
+          else
+            sftp.file.open fix_path(path), 'w' do |os|
+              writer = -> buff {os.write buff}
+              block.call writer
+            end
+          end          
+        end   
+
+        def delete_file remote_file_path
+          sftp.remove! fix_path(remote_file_path)
+        end
+
+        # def move_file path
+        #   raise 'not supported'
+        # end
+
+
+        # 
+        # Dir
+        # 
+        def create_dir path
+          sftp.mkdir! path
+        end
+
+        def delete_dir path
+          exec "rm -r #{path}"
+        end
+
+        def each path, &block
+          sftp.dir.foreach path do |stat|
+            next if stat.name == '.' or stat.name == '..'
+            if stat.directory?
+              block.call stat.name, :dir
+            else
+              block.call stat.name, :file
+            end
+          end
+        end
+        
+        def efficient_dir_copy from, to
+          from.storage.open_fs do |from_fs|          
+            to.storage.open_fs do |to_fs|
+              if from_fs.local? 
+                sftp.upload! from.path, fix_path(to.path)
+                true
+              elsif to_fs.local?
+                sftp.download! fix_path(to.path), from.path, :recursive => true
+                true
+              else
+                false
+              end
+            end
+          end
+        end
+
+        # def move_dir path
+        #   raise 'not supported'
+        # end
+
+
+        # 
+        # Special
+        # 
+        def tmp &block
+          tmp_dir = "/tmp/vfs_#{rand(10**3)}"        
+          if block
+            begin
+              create_dir tmp_dir
+              block.call tmp_dir
+            ensure
+              delete_dir tmp_dir
+            end
+          else
+            create_dir tmp_dir
+            tmp_dir
+          end
+        end
+        
+        def local?; false end
+      end
+      
+      def initialize options = {}
+        super
+        raise "ssh options not provided!" unless options[:ssh]
+        raise "invalid ssh options!" unless options[:ssh].is_a?(Hash)
+      end
+      
+      
+      # 
+      # Establishing SSH channel
+      # 
+      def open &block
+        if block
+          if @ssh
+            block.call self
+          else
+            begin            
+              open
+              block.call self
+            ensure
+              close
+            end
+          end
+        else
+          unless @ssh
+            ssh_options = self.options[:ssh].clone
+            host = options[:host] || raise('host not provided!')
+            user = ssh_options.delete(:user) || raise('user not provied!')
+            @ssh = Net::SSH.start(host, user, ssh_options)
+            @sftp = @ssh.sftp.connect
+          end
+        end
+      end            
+    
+      def close                        
+        if @ssh
+          @ssh.close
+          # @sftp.close not needed
+          @ssh, @sftp = nil
+        end
+      end
+
+      def to_s; options[:host] end
+      
+      
+      # 
+      # Vfs
+      # 
+      include VfsStorage
+      alias_method :open_fs, :open
+      
+      
+      # 
+      # Shell
+      # 
+      def exec command
+        # somehow net-ssh doesn't executes ~/.profile, so we need to execute it manually
+        # command = ". ~/.profile && #{command}"
+
+        stdout, stderr, code, signal = hacked_exec! ssh, command
+
+        return code, stdout, stderr
+      end                              
+      
+      def bash command
+        # somehow net-ssh doesn't executes ~/.profile, so we need to execute it manually
+        # command = ". ~/.profile && #{command}"
+
+        stdout_and_stderr, stderr, code, signal = hacked_exec! ssh, command, true
+
+        return code, stdout_and_stderr
+      end
+      
+      
+      protected
+        attr_accessor :ssh, :sftp
+      
+        def fix_path path
+          path.sub(/^\~/, home)
+        end
+        
+        def home
+          unless @home
+            command = 'cd ~; pwd'
+            code, stdout, stderr = exec command
+            raise "can't execute '#{command}'!" unless code == 0
+            @home = stdout.gsub("\n", '')    
+          end
+          @home
+        end
+      
+        # taken from here http://stackoverflow.com/questions/3386233/how-to-get-exit-status-with-rubys-netssh-library/3386375#3386375
+        def hacked_exec!(ssh, command, merge_stdout_and_stderr = false, &block)
+          stdout_data = ""
+          stderr_data = ""
+          exit_code = nil
+          exit_signal = nil
+        
+          channel = ssh.open_channel do |channel|
+            channel.exec(command) do |ch, success|
+              raise "could not execute command: #{command.inspect}" unless success
+
+              channel.on_data{|ch2, data| stdout_data << data}
+              channel.on_extended_data do |ch2, type, data| 
+                stdout_data << data if merge_stdout_and_stderr
+                stderr_data << data
+              end
+              channel.on_request("exit-status"){|ch,data| exit_code = data.read_long}
+              channel.on_request("exit-signal"){|ch, data| exit_signal = data.read_long}
+            end          
+          end  
+        
+          channel.wait      
+        
+          [stdout_data, stderr_data, exit_code, exit_signal]
+        end    
+    end
+  end
+end

data/lib/vos/gems.rb

@@ -0,0 +1,6 @@
+# gem 'net-ssh'
+# gem 'net-sftp'
+
+if respond_to? :fake_gem
+  fake_gem 'vfs'
+end

data/lib/vos/helpers/ubuntu.rb

@@ -0,0 +1,40 @@
+module Vos
+  module Helpers
+    module Ubuntu
+      def default_env
+        {:DEBIAN_FRONTEND => 'noninteractive'}
+      end
+      def wrap_cmd env_str, cmd
+        %(. #{env_file.path} && #{env_str}#{' && ' unless env_str.empty?}#{cmd})
+      end
+      
+      def env_file
+        file '/etc/profile' ## file '/etc/environment'
+      end
+      
+      def append_to_environment file, reload = true
+        raise "#{file} must be an Entry" unless file.is_a? Vfs::Entry        
+        
+        env_ext = dir '/etc/profile_ext'
+        
+        remote_file = env_ext[file.name]
+        file.copy_to! remote_file
+
+        require_clause = "source #{remote_file.path}"
+        env_file.append "\n#{require_clause}\n" unless env_file.content.include? require_clause
+        
+        reload_env if reload
+      end
+      
+      def reload_env
+        bash ". #{env_file.path}"
+      end
+    end
+  end
+end
+
+module Vfs
+  class File
+    
+  end
+end

data/lib/{rsh → vos}/support.rb

@@ -2,6 +2,8 @@ require 'fileutils'
 require 'net/ssh'
 require 'net/sftp'
 
+require 'vfs'
+
 # class File
 #   class << self
 #     def ensure_dir_exist directory, options = {}       
@@ -23,7 +25,7 @@ require 'net/sftp'
 #       FileUtils.cp_r from, to
 #     end
 #     
-#     def remove_dir dir
+#     def delete_dir dir
 #       FileUtils.rm_r dir
 #     end
 #   end

data/lib/{rsh.rb → vos.rb}

@@ -1,11 +1,9 @@
 raise 'ruby 1.9.2 or higher required!' if RUBY_VERSION < '1.9.2'
 
-require 'rsh/gems'
+require 'vos/gems'
 
 require 'open3'
 
-require 'net/ssh'
-require 'net/sftp'
 
 %w(
   support
@@ -14,6 +12,10 @@ require 'net/sftp'
   drivers/local
   drivers/ssh
 
-  box/marks
+  box/shell
+  box/marks  
+  box/vfs
   box
-).each{|f| require "rsh/#{f}"}
+  
+  helpers/ubuntu
+).each{|f| require "vos/#{f}"}