proclib 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1fd39b5a0365da59054e4d5db583d327d907523a
-  data.tar.gz: 8300d876216aa45f651c6d10c37fd13574273878
+  metadata.gz: d6212650eff9983728f4fb27e15da5f0d1ecd0b9
+  data.tar.gz: da2f686f9549288c78a92f8a0c9797006398e00d
 SHA512:
-  metadata.gz: 1da481ea3fe20b531cdaefd39a57871fd762fc1ff8b31e45ced4933bcd43f9ef805594096fec262e3729482f0ce5be5966d4608338920a8674a8f1ec9988271d
-  data.tar.gz: 8a46ef334624bdb0705b4111e5b18f56fa2472b538d9cbcfe2ab242167d8c920f5d10f908286fa31a09e40c9edb482ac4089fe04852a5f7a547ccb8dbcbb4c58
+  metadata.gz: ec307361563e72615dff68ff55ebd5ad12a160331e08ff54d5a612541f943fedcf2d0ed32c9395f93bdb0474ad2a720d281038a02892f56aed901b72dea082f5
+  data.tar.gz: 5441bea3cc830c74e9ee62eaf7201c59b7114a46f66d1440b32142264a9a81f4e54024b7e9fed8c7d937a52b1ea5497162c56ef5c1f2e11e906eea2690cd56ed

data/lib/proclib.rb

@@ -12,7 +12,6 @@ module Proclib
     cwd: nil,
     ssh: nil
   )
-
     inv = Invocation.new(cmd,
       tag: tag,
       env: env,
@@ -30,4 +29,13 @@ module Proclib
   rescue Invocation::Invalid => e
     raise ArgumentError, e.message
   end
+
+  def self.ssh_session(user:, host:, password: nil, port: nil, paranoid: nil)
+    ssh_opts = { user: user, host: host }
+    ssh_opts[:port] = port unless port.nil?
+    ssh_opts[:paranoid] = paranoid unless paranoid.nil?
+    ssh_opts[:password] = password unless password.nil?
+
+    SshSession.new(ssh_opts)
+  end
 end

data/lib/proclib/commands/base.rb

@@ -0,0 +1,38 @@
+require 'ostruct'
+
+require 'proclib/errors'
+
+module Proclib
+  module Commands
+    class Base
+      NotYetRunning = Class.new(Error)
+      NotYetTerminated = Class.new(Error)
+
+      attr_reader :tag, :cmdline, :env, :run_dir
+
+      def initialize(tag: nil, cmdline:, env: {} , run_dir: nil)
+        @env = env.map {|k,v| [k.to_s, v.to_s]}.to_h
+        @cmdline = cmdline
+        @tag = tag || cmdline[0..20]
+        @run_dir = run_dir
+      end
+
+      def pipes
+        @pipes ||= OpenStruct.new
+      end
+
+      def spawn
+        raise NotImplementedError
+      end
+
+      def wait
+        raise NotImplementedError
+      end
+
+      def result
+        @result || raise(NotYetTerminated)
+      end
+    end
+    private_constant :Base
+  end
+end

data/lib/proclib/commands/local.rb

@@ -0,0 +1,30 @@
+require 'proclib/commands/base'
+require 'open3'
+
+module Proclib
+  module Commands
+    class Local < Base
+      def spawn
+        spawn = -> do
+          pipes.stdin, pipes.stdout, pipes.stderr, @wait_thread = Open3.popen3(env, cmdline)
+        end
+
+        if run_dir
+          Dir.chdir(run_dir) { spawn.call }
+        else
+          spawn.call
+        end
+      end
+
+      def wait
+        @result ||= wait_thread.value.to_i
+      end
+
+      private
+
+      def wait_thread
+        @wait_thread || raise(NotYetRunning)
+      end
+    end
+  end
+end

data/lib/proclib/commands/ssh.rb

@@ -0,0 +1,69 @@
+require 'net/ssh'
+require 'proclib/ssh_session'
+require 'proclib/commands/base'
+
+module Proclib
+  module Commands
+    class Ssh < Base
+      SSHError = Class.new(Error)
+
+      def initialize(ssh_session:, **args)
+        @ssh_session = ssh_session
+        super(**args)
+      end
+
+      def spawn
+        write_pipes
+
+        open_channel do |ch|
+          ch.exec(cmdline) do |_, success|
+            raise SSHError, "Command Failed" unless success
+          end
+        end
+      end
+
+      def wait
+        ssh_session.loop
+      end
+
+      def cmdline
+        if !run_dir.nil?
+          "cd #{run_dir}; #{super}"
+        else
+          super
+        end
+      end
+
+      private
+
+      attr_reader :ssh_session
+
+      def open_channel
+         ssh_session.open_channel do |channel|
+          channel.on_open_failed do |ch, code, desc, lang|
+            raise SSHError, desc
+          end
+
+          channel.on_data {|_, data| write_pipes[:stdout].write(data) }
+
+          channel.on_extended_data {|_, data| write_pipes[:stderr].write(data) }
+
+          channel.on_request("exit-status") do |_, data|
+            write_pipes.each {|k,v| v.close }
+            @result = data.read_long
+          end
+
+          yield channel
+        end
+      end
+
+      def write_pipes
+        @write_pipes ||= %i(stdout stderr).map do |type|
+          read, write = IO.pipe
+          pipes[type] = read
+          [type, write]
+        end.to_h
+      end
+    end
+  end
+end

data/lib/proclib/invocation.rb

@@ -1,7 +1,11 @@
 require 'pathname'
 
 require 'proclib/errors'
-require 'proclib/command'
+
+require 'proclib/commands/local'
+require 'proclib/commands/ssh'
+
+require 'net/ssh'
 
 module Proclib
   class Invocation
@@ -43,15 +47,15 @@ module Proclib
         run_dir: validated_cwd,
         cmdline: validated_cmd
       }.tap do |args|
-        args[:ssh] = validated_ssh if !validated_ssh.nil?
+        args[:ssh_session] = validated_ssh if !validated_ssh.nil?
       end
     end
 
     def command_class
       if validated_ssh.nil?
-        Commands::LocalCommand
+        Commands::Local
       else
-        Commands::SshCommand
+        Commands::Ssh
       end
     end
 
@@ -82,6 +86,7 @@ module Proclib
 
     def validated_ssh
       return if @ssh.nil?
+      return @ssh if @ssh.kind_of?(Net::SSH::Connection::Session)
 
       @validated_ssh ||= begin
         %i(host user).each do |k|

data/lib/proclib/ssh_session.rb

@@ -0,0 +1,48 @@
+module Proclib
+  class SshSession
+    attr_reader :ssh_opts
+
+    def initialize(ssh_opts)
+      @ssh_opts = ssh_opts.clone
+    end
+
+    def run(cmd,
+      tag: nil,
+      log_to_console: false,
+      capture_output: true,
+      env: {},
+      on_output: nil,
+      cwd: nil,
+      ssh: nil
+    )
+
+      inv = Invocation.new(cmd,
+        tag: tag,
+        env: env,
+        ssh: session,
+        cwd: cwd)
+
+      executor = Executor.new(inv.commands,
+        log_to_console: log_to_console,
+        cache_output: capture_output
+      ).tap do |ex|
+        ex.on_output(&on_output) unless on_output.nil?
+      end
+
+      executor.run_sync
+    rescue Invocation::Invalid => e
+      raise ArgumentError, e.message
+    end
+
+    private
+
+    def ssh_params
+      %i(host user).map {|i| ssh_opts.delete(i)}.compact
+    end
+
+    def session
+      @session ||= Net::SSH.start(*ssh_params, ssh_opts)
+    end
+  end
+  private_constant :SshSession
+end

data/lib/proclib/version.rb

@@ -1,3 +1,3 @@
 module Proclib
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proclib
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Jack Forrest
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-28 00:00:00.000000000 Z
+date: 2018-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -115,8 +115,10 @@ files:
 - bin/setup
 - lib/proclib.rb
 - lib/proclib/channel.rb
-- lib/proclib/command.rb
 - lib/proclib/command_monitor.rb
+- lib/proclib/commands/base.rb
+- lib/proclib/commands/local.rb
+- lib/proclib/commands/ssh.rb
 - lib/proclib/errors.rb
 - lib/proclib/executor.rb
 - lib/proclib/invocation.rb
@@ -124,8 +126,8 @@ files:
 - lib/proclib/output_cache.rb
 - lib/proclib/output_handler.rb
 - lib/proclib/process.rb
-- lib/proclib/process_group.rb
 - lib/proclib/result.rb
+- lib/proclib/ssh_session.rb
 - lib/proclib/string_formatting.rb
 - lib/proclib/version.rb
 - proclib.gemspec
@@ -149,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: Provides tools for subprocess management

data/lib/proclib/command.rb

@@ -1,129 +0,0 @@
-require 'open3'
-require 'ostruct'
-
-require 'proclib/errors'
-
-require 'net/ssh'
-
-module Proclib
-  module Commands
-    class Command
-      NotYetRunning = Class.new(Error)
-      NotYetTerminated = Class.new(Error)
-
-      attr_reader :tag, :cmdline, :env, :run_dir
-
-      def initialize(tag: nil, cmdline:, env: {} , run_dir: nil)
-        @env = env.map {|k,v| [k.to_s, v.to_s]}.to_h
-        @cmdline = cmdline
-        @tag = tag || cmdline[0..20]
-        @run_dir = run_dir
-      end
-
-      def pipes
-        @pipes ||= OpenStruct.new
-      end
-
-      def spawn
-        raise NotImplementedError
-      end
-
-      def wait
-        raise NotImplementedError
-      end
-
-      def result
-        @result || raise(NotYetTerminated)
-      end
-    end
-    private_constant :Command
-
-    class LocalCommand < Command
-      def spawn
-        spawn = -> do
-          pipes.stdin, pipes.stdout, pipes.stderr, @wait_thread = Open3.popen3(env, cmdline)
-        end
-
-        if run_dir
-          Dir.chdir(run_dir) { spawn.call }
-        else
-          spawn.call
-        end
-      end
-
-      def wait
-        @result ||= wait_thread.value.to_i
-      end
-
-      private
-
-      def wait_thread
-        @wait_thread || raise(NotYetRunning)
-      end
-    end
-
-    class SshCommand < Command
-      attr_reader :ssh_opts
-
-      SSHError = Class.new(Error)
-
-      def initialize(ssh:, **args)
-        @ssh_opts = ssh.clone
-        super(**args)
-      end
-
-      def spawn
-        write_pipes
-
-        open_channel do |ch|
-          ch.exec(cmdline) do |_, success|
-            raise SSHError, "Command Failed" unless success
-          end
-        end
-      end
-
-      def wait
-        ssh_session.loop
-      end
-
-      private
-
-      def open_channel
-         ssh_session.open_channel do |channel|
-          channel.on_open_failed do |ch, code, desc, lang|
-            raise SSHError, desc
-          end
-
-          channel.on_data {|_, data| write_pipes[:stdout].write(data) }
-
-          channel.on_extended_data {|_, data| write_pipes[:stderr].write(data) }
-
-          channel.on_request("exit-status") do |_, data|
-            write_pipes.each {|k,v| v.close }
-            @result = data.read_long
-          end
-
-          yield channel
-        end
-      end
-
-      def write_pipes
-        @write_pipes ||= %i(stdout stderr).map do |type|
-          read, write = IO.pipe
-          pipes[type] = read
-          [type, write]
-        end.to_h
-      end
-
-      def ssh_session
-        @ssh_session ||= Net::SSH.start(*ssh_params, ssh_opts).tap do |session|
-          session.chdir(run_dir) unless run_dir.nil?
-        end
-      end
-
-      def ssh_params
-        %i(host user).map {|i| ssh_opts.delete(i)}.compact
-      end
-    end
-  end
-end

data/lib/proclib/process_group.rb

@@ -1,41 +0,0 @@
-require 'proclib/event_emitter'
-
-module Proclib
-  class ProcessGroup
-    include EventEmitter::Producer
-
-    def initialize(processes)
-      @processes = processes
-    end
-
-    def spawn
-      processes.each do |process|
-        process.bind_to(channel)
-        process.spawn
-      end
-
-      start_watch_thread
-    end
-
-    def kill
-      processes.each(&:kill)
-    end
-
-    private
-    attr_reader :processes
-
-    def start_watch_thread
-      Thread.new { channel.watch }
-    end
-
-    def channel
-      @channel ||= EventEmitter::Channel.new.tap do |channel|
-        channel.on(:output) {|ev| push(ev) }
-        channel.on(:exit) do |ev|
-          emit(:complete) if processes.all?(&:complete?)
-        end
-      end
-    end
-  end
-  private_constant :ProcessGroup
-end