tty-command 0.8.1 → 0.8.2

data/spec/unit/dry_run_spec.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Command, 'dry run' do
+  let(:output) { StringIO.new }
+
+  it "queries for dry mode" do
+    command = TTY::Command.new(dry_run: false)
+    expect(command.dry_run?).to eq(false)
+  end
+
+  it "runs command in dry run mode" do
+    uuid= 'xxxx'
+    allow(SecureRandom).to receive(:uuid).and_return(uuid)
+    command = TTY::Command.new(output: output, dry_run: true)
+
+    command.run(:echo, 'hello', 'world')
+
+    output.rewind
+    expect(output.read).to eq(
+      "[\e[32m#{uuid}\e[0m] \e[34m(dry run)\e[0m \e[33;1mecho hello world\e[0m\n")
+  end
+
+  it "allows to run command in dry mode" do
+    uuid= 'xxxx'
+    allow(SecureRandom).to receive(:uuid).and_return(uuid)
+    command = TTY::Command.new(output: output)
+
+    command.run(:echo, 'hello', 'world', dry_run: true)
+
+    output.rewind
+    expect(output.read).to eq(
+      "[\e[32m#{uuid}\e[0m] \e[34m(dry run)\e[0m \e[33;1mecho hello world\e[0m\n")
+  end
+
+  it "doesn't collect printout to stdin or stderr" do
+    cmd = TTY::Command.new(output: output, dry_run: true)
+    out, err = cmd.run(:echo, 'hello', 'world')
+
+    expect(out).to be_empty
+    expect(err).to be_empty
+  end
+end

data/spec/unit/exit_error_spec.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Command::ExitError, 'info' do
+  it "displays stdin & stdout" do
+    result = double(exit_status: 157, out: 'out content', err: 'err content')
+    error = described_class.new(:cat, result)
+    expect(error.message).to eq([
+      "Running `cat` failed with\n",
+      "  exit status: 157\n",
+      "  stdout: out content\n",
+      "  stderr: err content\n"
+    ].join)
+  end
+
+  it "explains no stdin & stdout" do
+    result = double(exit_status: 157, out: '', err: '')
+    error = described_class.new(:cat, result)
+    expect(error.message).to eq([
+      "Running `cat` failed with\n",
+      "  exit status: 157\n",
+      "  stdout: Nothing written\n",
+      "  stderr: Nothing written\n"
+    ].join)
+  end
+end

data/spec/unit/input_spec.rb

@@ -0,0 +1,11 @@
+RSpec.describe TTY::Command, 'input' do
+  it "reads user input data" do
+    cli = fixtures_path('cli')
+    output = StringIO.new
+    command = TTY::Command.new(output: output)
+
+    out, _ = command.run("ruby #{cli}", input: "Piotr\n")
+
+    expect(out.chomp).to eq("Your name: Piotr")
+  end
+end

data/spec/unit/output_spec.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+require 'fileutils'
+
+RSpec.describe TTY::Command, ':output', type: :cli do
+  it 'runs command and prints to a file' do
+    stub_const('Tee', Class.new do
+      def initialize(file)
+        @file = file
+      end
+      def <<(message)
+        @file << message
+        @file.close
+      end
+    end)
+
+    file = tmp_path('foo.log')
+    output = Tee.new(File.open(file, 'w'))
+
+    command = TTY::Command.new(output: output, printer: :quiet)
+    command = command.run("echo hello")
+
+    expect(File.read(file).chomp).to eq("hello")
+  end
+end

data/spec/unit/printer_spec.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Command, ':printer' do
+  it "fails to find printer for nil" do
+    expect {
+      TTY::Command.new(printer: nil)
+    }.to raise_error(ArgumentError, /Unknown printer type ""/)
+  end
+
+  it "fails to find printer based on name" do
+    expect {
+      TTY::Command.new(printer: :unknown)
+    }.to raise_error(ArgumentError, /Unknown printer type "unknown"/)
+  end
+
+  it "detects null printer" do
+    cmd = TTY::Command.new(printer: :null)
+    expect(cmd.printer).to be_an_instance_of(TTY::Command::Printers::Null)
+  end
+
+  it "detects printer based on name" do
+    cmd = TTY::Command.new(printer: :progress)
+    expect(cmd.printer).to be_an_instance_of(TTY::Command::Printers::Progress)
+  end
+
+  it "uses printer based on class name" do
+    output = StringIO.new
+    printer = TTY::Command::Printers::Pretty
+    cmd = TTY::Command.new(output: output, printer: printer)
+    expect(cmd.printer).to be_an_instance_of(TTY::Command::Printers::Pretty)
+  end
+
+  it "uses printer based on instance" do
+    output = StringIO.new
+    printer = TTY::Command::Printers::Pretty.new(output)
+    cmd = TTY::Command.new(printer: printer)
+    expect(cmd.printer).to be_an_instance_of(TTY::Command::Printers::Pretty)
+  end
+
+  it "uses custom printer" do
+    stub_const('CustomPrinter', Class.new(TTY::Command::Printers::Abstract) do
+      def write(message)
+        output << message
+      end
+    end)
+    printer = CustomPrinter
+    cmd = TTY::Command.new(printer: printer)
+    expect(cmd.printer).to be_an_instance_of(CustomPrinter)
+  end
+end

data/spec/unit/printers/custom_spec.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+RSpec.describe 'Custom Printer' do
+  let(:output) { StringIO.new }
+
+  before do
+    stub_const('CustomPrinter', Class.new(TTY::Command::Printers::Abstract) do
+      def write(message)
+        output << message
+      end
+    end)
+  end
+
+  it "prints command start" do
+    printer = CustomPrinter.new(output)
+    cmd = TTY::Command::Cmd.new(:echo, "'hello world'")
+
+    printer.print_command_start(cmd)
+    output.rewind
+
+    expect(output.string).to eq("echo \\'hello\\ world\\'")
+  end
+
+  it "prints command stdout data" do
+    printer = CustomPrinter.new(output)
+    cmd = TTY::Command::Cmd.new(:echo, 'hello world')
+
+    printer.print_command_out_data(cmd, 'data')
+    output.rewind
+
+    expect(output.string).to eq("data")
+  end
+
+  it "prints command exit" do
+    printer = CustomPrinter.new(output)
+    cmd = TTY::Command::Cmd.new(:echo, 'hello world')
+
+    printer.print_command_exit(cmd)
+    output.rewind
+
+    expect(output.string).to be_empty
+  end
+
+  it "accepts options" do
+    printer = CustomPrinter.new(output, foo: :bar)
+    expect(printer.options[:foo]).to eq(:bar)
+  end
+end

data/spec/unit/printers/null_spec.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Command::Printers::Null do
+  let(:output) { StringIO.new }
+
+  it "doesn't print command start or exit" do
+    printer = TTY::Command::Printers::Null.new(output)
+    cmd = TTY::Command::Cmd.new("echo hello")
+
+    printer.print_command_start(cmd)
+    printer.print_command_exit(cmd, 0)
+    output.rewind
+
+    expect(output.string).to be_empty
+  end
+
+  it "doesn't print command stdout data" do
+    printer = TTY::Command::Printers::Null.new(output)
+    cmd = TTY::Command::Cmd.new("echo hello")
+
+    printer.print_command_out_data(cmd, 'hello', 'world')
+    output.rewind
+
+    expect(output.string).to be_empty
+  end
+
+  it "doesn't print command stderr data" do
+    printer = TTY::Command::Printers::Null.new(output)
+    cmd = TTY::Command::Cmd.new("echo hello")
+
+    printer.print_command_err_data(cmd, 'hello', 'world')
+    output.rewind
+
+    expect(output.string).to be_empty
+  end
+end

data/spec/unit/printers/pretty_spec.rb

@@ -0,0 +1,172 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Command::Printers::Pretty do
+  let(:output) { StringIO.new }
+  let(:uuid) { 'aaaaaa-xxx' }
+
+  it "prints command start in color" do
+    allow(SecureRandom).to receive(:uuid).and_return(uuid)
+    printer = TTY::Command::Printers::Pretty.new(output)
+    cmd = TTY::Command::Cmd.new(:echo, 'hello')
+
+    printer.print_command_start(cmd)
+    output.rewind
+
+    expect(output.string).
+      to eq("[\e[32maaaaaa\e[0m] Running \e[33;1mecho hello\e[0m\n")
+  end
+
+  it "prints command start without color" do
+    allow(SecureRandom).to receive(:uuid).and_return(uuid)
+    printer = TTY::Command::Printers::Pretty.new(output, color: false)
+    cmd = TTY::Command::Cmd.new(:echo, 'hello')
+
+    printer.print_command_start(cmd)
+    output.rewind
+
+    expect(output.string).to eq("[aaaaaa] Running echo hello\n")
+  end
+
+  it "prints command start without uuid" do
+    allow(SecureRandom).to receive(:uuid).and_return(uuid)
+    printer = TTY::Command::Printers::Pretty.new(output, uuid: false)
+    cmd = TTY::Command::Cmd.new(:echo, 'hello')
+
+    printer.print_command_start(cmd)
+    output.rewind
+
+    expect(output.string).to eq("Running \e[33;1mecho hello\e[0m\n")
+  end
+
+  it "prints command stdout data" do
+    allow(SecureRandom).to receive(:uuid).and_return(uuid)
+    printer = TTY::Command::Printers::Pretty.new(output)
+    cmd = TTY::Command::Cmd.new(:echo, 'hello')
+
+    printer.print_command_out_data(cmd, 'hello', 'world')
+    output.rewind
+
+    expect(output.string).to eq("[\e[32maaaaaa\e[0m] \thello world\n")
+  end
+
+  it "prints command stderr data" do
+    allow(SecureRandom).to receive(:uuid).and_return(uuid)
+    printer = TTY::Command::Printers::Pretty.new(output)
+    cmd = TTY::Command::Cmd.new(:echo, 'hello')
+
+    printer.print_command_err_data(cmd, 'hello', 'world')
+    output.rewind
+
+    expect(output.string).
+      to eq("[\e[32maaaaaa\e[0m] \t\e[31mhello world\e[0m\n")
+  end
+
+  it "prints successful command exit in color" do
+    allow(SecureRandom).to receive(:uuid).and_return(uuid)
+    printer = TTY::Command::Printers::Pretty.new(output)
+    cmd = TTY::Command::Cmd.new(:echo, 'hello')
+
+    printer.print_command_exit(cmd, 0, 5.321)
+    output.rewind
+
+    expect(output.string).to eq("[\e[32maaaaaa\e[0m] Finished in 5.321 seconds with exit status 0 (\e[32;1msuccessful\e[0m)\n")
+  end
+
+  it "prints failure command exit in color" do
+    allow(SecureRandom).to receive(:uuid).and_return(uuid)
+    printer = TTY::Command::Printers::Pretty.new(output)
+    cmd = TTY::Command::Cmd.new(:echo, 'hello')
+
+    printer.print_command_exit(cmd, 1, 5.321)
+    output.rewind
+
+    expect(output.string).to eq("[\e[32maaaaaa\e[0m] Finished in 5.321 seconds with exit status 1 (\e[31;1mfailed\e[0m)\n")
+  end
+
+  it "prints command exit without exit status in color" do
+    allow(SecureRandom).to receive(:uuid).and_return(uuid)
+    printer = TTY::Command::Printers::Pretty.new(output)
+    cmd = TTY::Command::Cmd.new(:echo, 'hello')
+
+    printer.print_command_exit(cmd, nil, 5.321)
+    output.rewind
+
+    expect(output.string).to eq("[\e[32maaaaaa\e[0m] Finished in 5.321 seconds (\e[31;1mfailed\e[0m)\n")
+  end
+
+  it "doesn't print output on success when only_output_on_error is true" do
+    zero_exit = fixtures_path('zero_exit')
+    allow(SecureRandom).to receive(:uuid).and_return(uuid)
+    printer = TTY::Command::Printers::Pretty
+    cmd = TTY::Command.new(output: output, printer: printer)
+
+    cmd.run!(:ruby, zero_exit, only_output_on_error: true)
+    cmd.run!(:ruby, zero_exit)
+
+    output.rewind
+
+    lines = output.readlines
+    lines.each { |line| line.gsub!(/\d+\.\d+(?= seconds)/, 'x') }
+
+    expect(lines).to eq([
+      "[\e[32maaaaaa\e[0m] Running \e[33;1mruby #{zero_exit}\e[0m\n",
+      "[\e[32maaaaaa\e[0m] Finished in x seconds with exit status 0 (\e[32;1msuccessful\e[0m)\n",
+      "[\e[32maaaaaa\e[0m] Running \e[33;1mruby #{zero_exit}\e[0m\n",
+      "[\e[32maaaaaa\e[0m] \tyess\n",
+      "[\e[32maaaaaa\e[0m] Finished in x seconds with exit status 0 (\e[32;1msuccessful\e[0m)\n"
+    ])
+  end
+
+  it "prints output on error & raises ExitError when only_output_on_error is true" do
+    non_zero_exit = fixtures_path('non_zero_exit')
+    allow(SecureRandom).to receive(:uuid).and_return(uuid)
+    printer = TTY::Command::Printers::Pretty
+    cmd = TTY::Command.new(output: output, printer: printer)
+
+    cmd.run!(:ruby, non_zero_exit, only_output_on_error: true)
+    cmd.run!(:ruby, non_zero_exit)
+
+    output.rewind
+
+    lines = output.readlines
+    lines.each { |line| line.gsub!(/\d+\.\d+(?= seconds)/, 'x') }
+
+    expect(lines).to eq([
+      "[\e[32maaaaaa\e[0m] Running \e[33;1mruby #{non_zero_exit}\e[0m\n",
+      "[\e[32maaaaaa\e[0m] \tnooo\n",
+      "[\e[32maaaaaa\e[0m] Finished in x seconds with exit status 1 (\e[31;1mfailed\e[0m)\n",
+      "[\e[32maaaaaa\e[0m] Running \e[33;1mruby #{non_zero_exit}\e[0m\n",
+      "[\e[32maaaaaa\e[0m] \tnooo\n",
+      "[\e[32maaaaaa\e[0m] Finished in x seconds with exit status 1 (\e[31;1mfailed\e[0m)\n"
+    ])
+  end
+
+  it "prints output on error when only_output_on_error is true" do
+    non_zero_exit = fixtures_path('non_zero_exit')
+    allow(SecureRandom).to receive(:uuid).and_return(uuid)
+    printer = TTY::Command::Printers::Pretty
+    cmd = TTY::Command.new(output: output, printer: printer)
+
+    expect {
+      cmd.run(:ruby, non_zero_exit, only_output_on_error: true)
+    }.to raise_error(TTY::Command::ExitError)
+
+    expect {
+      cmd.run(:ruby, non_zero_exit)
+    }.to raise_error(TTY::Command::ExitError)
+
+    output.rewind
+
+    lines = output.readlines
+    lines.each { |line| line.gsub!(/\d+\.\d+(?= seconds)/, 'x') }
+
+    expect(lines).to eq([
+      "[\e[32maaaaaa\e[0m] Running \e[33;1mruby #{non_zero_exit}\e[0m\n",
+      "[\e[32maaaaaa\e[0m] \tnooo\n",
+      "[\e[32maaaaaa\e[0m] Finished in x seconds with exit status 1 (\e[31;1mfailed\e[0m)\n",
+      "[\e[32maaaaaa\e[0m] Running \e[33;1mruby #{non_zero_exit}\e[0m\n",
+      "[\e[32maaaaaa\e[0m] \tnooo\n",
+      "[\e[32maaaaaa\e[0m] Finished in x seconds with exit status 1 (\e[31;1mfailed\e[0m)\n"
+    ])
+  end
+end

data/spec/unit/printers/progress_spec.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Command::Printers::Progress do
+  let(:output) { StringIO.new }
+
+  it "doesn't print command start" do
+    printer = TTY::Command::Printers::Progress.new(output)
+    cmd = TTY::Command::Cmd.new(:echo, 'hello')
+
+    printer.print_command_start(cmd)
+    output.rewind
+
+    expect(output.string).to be_empty
+  end
+
+  it "doesn't print command stdout data" do
+    printer = TTY::Command::Printers::Progress.new(output)
+    cmd = TTY::Command::Cmd.new(:echo, 'hello')
+
+    printer.print_command_out_data(cmd, 'hello', 'world')
+    output.rewind
+
+    expect(output.string).to be_empty
+  end
+
+  it "prints successful command exit in color" do
+    printer = TTY::Command::Printers::Progress.new(output)
+    cmd = TTY::Command::Cmd.new(:echo, 'hello')
+
+    printer.print_command_exit(cmd, 0, 5.321)
+    output.rewind
+
+    expect(output.string).to eq("\e[32m.\e[0m")
+  end
+
+  it "prints failure command exit in color" do
+    printer = TTY::Command::Printers::Progress.new(output)
+    cmd = TTY::Command::Cmd.new(:echo, 'hello')
+
+    printer.print_command_exit(cmd, 1, 5.321)
+    output.rewind
+
+    expect(output.string).to eq("\e[31mF\e[0m")
+  end
+end