smart_proxy_remote_execution_ssh_core 0.0.13

data/lib/smart_proxy_remote_execution_ssh_core/session.rb

@@ -0,0 +1,215 @@
+module Proxy
+  module RemoteExecution
+    module Ssh
+      # Service that handles running external commands for Actions::Command
+      # Dynflow action. It runs just one (actor) thread for all the commands
+      # running in the system and updates the Dynflow actions periodically.
+      class Session < ::Dynflow::Actor
+        EXPECTED_POWER_ACTION_MESSAGES = ["restart host", "shutdown host"]
+
+        def initialize(options = {})
+          @clock = options[:clock] || Dynflow::Clock.spawn('proxy-dispatcher-clock')
+          @logger = options[:logger] || Logger.new($stderr)
+          @connector_class = options[:connector_class] || Connector
+          @local_working_dir = options[:local_working_dir] || Settings.instance.local_working_dir
+          @remote_working_dir = options[:remote_working_dir] || Settings.instance.remote_working_dir
+          @refresh_interval = options[:refresh_interval] || 1
+          @client_private_key_file = Settings.instance.ssh_identity_key_file
+          @command = options[:command]
+
+          @command_buffer = []
+          @refresh_planned = false
+
+          reference.tell(:initialize_command)
+        end
+
+        def initialize_command
+          @logger.debug("initalizing command [#{@command}]")
+          open_connector
+          remote_script = cp_script_to_remote
+          output_path = File.join(File.dirname(remote_script), 'output')
+
+          # pipe the output to tee while capturing the exit code
+          script = <<-SCRIPT
+            exec 4>&1
+            exit_code=`((#{su_prefix}#{remote_script}; echo $?>&3 ) | /usr/bin/tee #{output_path} ) 3>&1 >&4`
+            exec 4>&-
+            exit $exit_code
+          SCRIPT
+          @logger.debug("executing script:\n#{script.lines.map { |line| "  | #{line}" }.join}")
+          @connector.async_run(script) do |data|
+            @command_buffer << data
+          end
+        rescue => e
+          @logger.error("error while initalizing command #{e.class} #{e.message}:\n #{e.backtrace.join("\n")}")
+          @command_buffer.concat(CommandUpdate.encode_exception("Error initializing command #{@command}", e))
+          refresh
+        ensure
+          plan_next_refresh
+        end
+
+        def refresh
+          @connector.refresh if @connector
+
+          unless @command_buffer.empty?
+            status = refresh_command_buffer
+            if status
+              finish_command
+            end
+          end
+        rescue Net::SSH::Disconnect => e
+          check_expecting_disconnect
+          if @expecting_disconnect
+            @command_buffer << CommandUpdate::StatusData.new(0)
+          else
+            @command_buffer.concat(CommandUpdate.encode_exception("Failed to refresh the connector", e, true))
+          end
+          refresh_command_buffer
+          finish_command
+        rescue => e
+          @command_buffer.concat(CommandUpdate.encode_exception("Failed to refresh the connector", e, false))
+        ensure
+          @refresh_planned = false
+          plan_next_refresh
+        end
+
+        def refresh_command_buffer
+          @logger.debug("command #{@command} got new output: #{@command_buffer.inspect}")
+          command_update = CommandUpdate.new(@command_buffer)
+          check_expecting_disconnect
+          @command.suspended_action << command_update
+          @command_buffer = []
+          if command_update.exit_status
+            @logger.debug("command [#{@command}] finished with status #{command_update.exit_status}")
+            return command_update.exit_status
+          end
+        end
+
+        def kill
+          @logger.debug("killing command [#{@command}]")
+          if @connector
+            @connector.run("pkill -f #{remote_command_file('script')}")
+          else
+            @logger.debug("connection closed")
+          end
+        rescue => e
+          @command_buffer.concat(CommandUpdate.encode_exception("Failed to kill the command", e, false))
+          plan_next_refresh
+        end
+
+        def finish_command
+          close
+          dispatcher.tell([:finish_command, @command])
+        end
+
+        def dispatcher
+          self.parent
+        end
+
+        def start_termination(*args)
+          super
+          close
+          finish_termination
+        end
+
+        private
+
+        def su_prefix
+          return if @command.effective_user.nil? || @command.effective_user == @command.ssh_user
+          case @command.effective_user_method
+          when 'sudo'
+            "sudo -n -u #{@command.effective_user} "
+          when 'su'
+            "su - #{@command.effective_user} -c "
+          else
+            raise "effective_user_method ''#{@command.effective_user_method}'' not supported"
+          end
+        end
+
+        def open_connector
+          raise 'Connector already opened' if @connector
+          options = { :logger => @logger }
+          options[:known_hosts_file] = prepare_known_hosts
+          options[:client_private_key_file] = @client_private_key_file
+          @connector = @connector_class.new(@command.host, @command.ssh_user, options)
+        end
+
+        def local_command_dir
+          File.join(@local_working_dir, 'foreman-proxy', "foreman-ssh-cmd-#{@command.id}")
+        end
+
+        def local_command_file(filename)
+          File.join(local_command_dir, filename)
+        end
+
+        def remote_command_dir
+          File.join(@remote_working_dir, "foreman-ssh-cmd-#{@command.id}")
+        end
+
+        def remote_command_file(filename)
+          File.join(remote_command_dir, filename)
+        end
+
+        def ensure_local_directory(path)
+          if File.exist?(path)
+            raise "#{path} expected to be a directory" unless File.directory?(path)
+          else
+            FileUtils.mkdir_p(path)
+          end
+          return path
+        end
+
+        def cp_script_to_remote
+          local_script_file = write_command_file_locally('script', sanitize_script(@command.script))
+          File.chmod(0777, local_script_file)
+          remote_script_file = remote_command_file('script')
+          @connector.upload_file(local_script_file, remote_script_file)
+          return remote_script_file
+        end
+
+        def sanitize_script(script)
+          script.tr("\r", '')
+        end
+
+        def write_command_file_locally(filename, content)
+          path = local_command_file(filename)
+          ensure_local_directory(File.dirname(path))
+          File.write(path, content)
+          return path
+        end
+
+        def prepare_known_hosts
+          path = local_command_file('known_hosts')
+          if @command.host_public_key
+            write_command_file_locally('known_hosts', "#{@command.host} #{@command.host_public_key}")
+          end
+          return path
+        end
+
+        def close
+          @connector.close if @connector
+          @connector = nil
+        end
+
+        def plan_next_refresh
+          if @connector && !@refresh_planned
+            @logger.debug("planning to refresh")
+            @clock.ping(reference, Time.now + @refresh_interval, :refresh)
+            @refresh_planned = true
+          end
+        end
+
+        # when a remote server disconnects, it's hard to tell if it was on purpose (when calling reboot)
+        # or it's an error. When it's expected, we expect the script to produce 'restart host' as
+        # its last command output
+        def check_expecting_disconnect
+          last_output = @command_buffer.reverse.find { |d| d.is_a? CommandUpdate::StdoutData }
+          return unless last_output
+          if EXPECTED_POWER_ACTION_MESSAGES.any? { |message| last_output.data =~ /^#{message}/ }
+            @expecting_disconnect = true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/smart_proxy_remote_execution_ssh_core/settings.rb

@@ -0,0 +1,41 @@
+require 'ostruct'
+
+module Proxy
+  module RemoteExecution
+    module Ssh
+      class Settings < OpenStruct
+
+        DEFAULT_SETTINGS = {
+          :enabled => true,
+          :ssh_identity_key_file => '~/.ssh/id_rsa_foreman_proxy',
+          :local_working_dir => '/var/tmp',
+          :remote_working_dir => '/var/tmp'
+        }
+
+        def initialize(settings = {})
+          super(DEFAULT_SETTINGS.merge(settings))
+        end
+
+        def load_settings_from_proxy
+          DEFAULT_SETTINGS.keys.each do |key|
+            self.class.instance[key] = Proxy::RemoteExecution::Ssh::Plugin.settings[key]
+          end
+        end
+
+        def self.create!(input = {})
+          settings = Proxy::RemoteExecution::Ssh::Settings.new input
+          self.instance = settings
+        end
+
+        def self.instance
+          SmartProxyDynflowCore::SETTINGS.plugins['smart_proxy_remote_execution_ssh_core']
+        end
+
+        def self.instance=(settings)
+          SmartProxyDynflowCore::SETTINGS.plugins['smart_proxy_remote_execution_ssh_core'] = settings
+        end
+      end
+    end
+  end
+end
+Proxy::RemoteExecution::Ssh::Settings.create!

data/lib/smart_proxy_remote_execution_ssh_core/version.rb

@@ -0,0 +1,9 @@
+module Proxy
+  module RemoteExecution
+    module Ssh
+      module Core
+        VERSION = '0.0.13'
+      end
+    end
+  end
+end

data/settings.d/remote_execution_ssh.yml.example

@@ -0,0 +1,5 @@
+---
+:enabled: true
+:ssh_identity_key_file: '~/.ssh/id_rsa_foreman_proxy'
+:local_working_dir: '/var/tmp'
+:remote_working_dir: '/var/tmp'

data/settings.d/smart_proxy_remote_execution_ssh.yml.example

@@ -0,0 +1,5 @@
+---
+:enabled: true
+:ssh_identity_key_file: '~/.ssh/id_rsa_foreman_proxy'
+:local_working_dir: '/var/tmp'
+:remote_working_dir: '/var/tmp'

metadata

@@ -0,0 +1,201 @@
+--- !ruby/object:Gem::Specification
+name: smart_proxy_remote_execution_ssh_core
+version: !ruby/object:Gem::Version
+  version: 0.0.13
+platform: ruby
+authors:
+- Ivan Nečas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.32.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.32.1
+- !ruby/object:Gem::Dependency
+  name: smart_proxy_dynflow_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 2.9.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 2.9.4
+- !ruby/object:Gem::Dependency
+  name: net-scp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "    Ssh remote execution provider for Foreman Smart-Proxy\n"
+email:
+- inecas@redhat.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- LICENSE
+- README.md
+- bundler.d/Gemfile.local.rb
+- bundler.d/remote_execution_ssh.rb
+- lib/smart_proxy_remote_execution_ssh_core.rb
+- lib/smart_proxy_remote_execution_ssh_core/command_action.rb
+- lib/smart_proxy_remote_execution_ssh_core/command_update.rb
+- lib/smart_proxy_remote_execution_ssh_core/connector.rb
+- lib/smart_proxy_remote_execution_ssh_core/dispatcher.rb
+- lib/smart_proxy_remote_execution_ssh_core/session.rb
+- lib/smart_proxy_remote_execution_ssh_core/settings.rb
+- lib/smart_proxy_remote_execution_ssh_core/version.rb
+- settings.d/remote_execution_ssh.yml.example
+- settings.d/smart_proxy_remote_execution_ssh.yml.example
+homepage: https://github.com/theforeman/smart_proxy_remote_execution_ssh
+licenses:
+- GPLv3
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Ssh remote execution provider for Foreman Smart-Proxy
+test_files: []
+has_rdoc: