Sha256: e6adb5b7b3fc0e41f439f30493248f1d79fc0632b8781cb4e312a66733057aed
Contents?: true
Size: 1.65 KB
Versions: 23
Compression:
Stored size: 1.65 KB
Contents
# frozen_string_literal: true
require 'open3'
# Helper commands for running Linux shell commands
module Diffend
module Shell
class << self
# Allows to execute shell commands and handle errors, etc later
# (won't raise any errors but instead will catch all things)
# @param command_with_options [String] command that should be executed with
# all the arguments and options
# @param raise_on_invalid_exit [Boolean] raise exception when exit code is not 0
# @return [Hash] hash with 3 keys describing output
# (stdout, stderr, exit_code)
# @example Run ls
# SupportEngine::Shell.('ls') =>
# { stdout: "test.rb\n", stderr: '', exit_code: 0}
def call(command_with_options, raise_on_invalid_exit: true)
stdout_str, stderr_str, status = Open3.capture3(command_with_options)
result = {
stdout: stdout_str,
stderr: stderr_str,
exit_code: status.exitstatus
}
raise Diffend::Errors::FailedShellCommand, result.values.join(': ') \
if raise_on_invalid_exit && result[:exit_code] != 0
result
end
# @param path [String, Pathname] to a place where git repo is
# @param command [String] that we want to execute in path context
# @param raise_on_invalid_exit [Boolean] raise exception when exit code is not 0
# @return [Hash] hash with 3 keys describing output (stdout, stderr, exit_code)
def call_in_path(path, command, raise_on_invalid_exit: true)
command = ['cd', path.to_s, '&&', command]
call(command.join(' '), raise_on_invalid_exit: raise_on_invalid_exit)
end
end
end
end
Version data entries
23 entries across 23 versions & 2 rubygems