ttytest2 0.9.11 → 0.9.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ee6dc964334b3c1a099faf8a5f4701b8a594fc0e948f02ae11f233d612c55bd
-  data.tar.gz: e27455bec4bbb72e73b264ccf4261c3ff75a47a6ae52459cc7d302fcb789c3a5
+  metadata.gz: '0509fd299994f0f61a308fe4f8fce559d9cd0f55d095ebac9e46a4889088d289'
+  data.tar.gz: 42db9936a321bce77fb11dbea796fd083291fac9c3bf3cc0611714815b3dca07
 SHA512:
-  metadata.gz: 8d15dba3585a6a82a3d6f67749bc90ad58d750ecf6c30971ab3b99df8be56343f03488dba2161c3ee299a4cfc6b9c3362b013e7c6e6b7870cf663defbac90ece
-  data.tar.gz: 49d7505801519f03ecd0b6dc2c0dadf8ed0cb7b3c203ddac23b25f1739942e21206a0aed6603443aadfa38e1d8bd86a38c01b64165e6bf0d4900b8a00ad64bf7
+  metadata.gz: 9c118f0b7542d4bcef07ec07a4df564e345d6fdcc76357c342a42a3b0ee6e48c1d2b5a75c2299b2f6d3c46f2ccf4f06f1bfd1fd565b73966cf0ae942f48cd312
+  data.tar.gz: 3130e6923dbd0513e545fd19636828790488adaeaeab416fb42bdb6ab934c226bf028356b0beaf8054592e81e7eb19c602069dba4dbd993d21ee24ad2f5ba7d4

data/README.md

@@ -2,9 +2,9 @@
 
 ttytest2 is an acceptance test framework for interactive console applications. It's like [capybara](https://github.com/teamcapybara/capybara) for the terminal.
 
-A drop-in replacement for [ttytest](https://github.com/jhawthorn/ttytest), because I had some features I needed for my own project.
+ttytest2 is a fork and a drop-in replacement for [ttytest](https://github.com/jhawthorn/ttytest), because I had some features I needed for my own project.
 
-It works by running commands inside a tmux session, capturing the pane, and comparing the content.
+It works by running commands inside a tmux session, capturing the pane, and comparing the content to your assertions.
 
 The assertions will wait a specified amount of time (default 2 seconds) for the expected content to appear.
 
@@ -14,17 +14,16 @@ The assertions will wait a specified amount of time (default 2 seconds) for the
 
 1. [Minimum Requirements](#minimum-requirements)
 2. [Usage](#usage)
-3. [Example for Canonical CLI or Shell](#example-for-canonical-cli-or-shell)
-4. [Example for Noncanonical CLI or Shell](#example-for-noncanonical-cli-or-shell)
-5. [Assertions](#assertions)
-6. [Output](#output)
-7. [Output Helpers](#output-helpers)
-8. [Troubleshooting](#troubleshooting)
-9. [Constants](#constants)
-10. [Tips](#tips)
-11. [Docker](#docker)
-12. [Contributing](#contributing)
-13. [License](#license)
+3. [Simple Example](#simple-example)
+4. [Assertions](#assertions)
+5. [Output](#output)
+6. [Output Helpers](#output-helpers)
+7. [Troubleshooting](#troubleshooting)
+8. [Constants](#constants)
+9. [Tips](#tips)
+10. [Docker](#docker)
+11. [Contributing](#contributing)
+12. [License](#license)
 
 ## Minimum Requirements
 
@@ -33,29 +32,25 @@ The assertions will wait a specified amount of time (default 2 seconds) for the
 
 ## Usage
 
-More documentation available at [ttytest2 docs](https://www.rubydoc.info/gems/ttytest2).
+* More documentation available at [ttytest2 docs](https://www.rubydoc.info/gems/ttytest2).
+* There are more examples in the examples folder.
 
-There are more examples in the examples folder.
-
-### Example for Canonical CLI or Shell
-
-Most people should use send_keys, if you are writing or working with a noncanonical shell/CLI, you will probably know it! Most shell/CLI applications are canonical.
+### Simple Example
 
 ``` ruby
 require 'ttytest'
-
-@tty = TTYtest.new_terminal(%{PS1='$ ' /bin/sh}, width: 80, height: 24)
+@tty = TTYtest.new_terminal(%(PS1='$ ' /bin/sh), width: 80, height: 7)
 @tty.assert_row(0, '$')
-@tty.assert_cursor_position(x: 2, y: 0)
+@tty.assert_cursor_position(2, 0)
 
-@tty.send_keys(%{echo "Hello, world"\n})
+@tty.send_line('echo "Hello, world"'))
 
-@tty.assert_contents <<TTY
-$ echo "Hello, world"
-Hello, world
-$
+@tty.assert_contents <<~TTY
+  $ echo "Hello, world"
+  Hello, world
+  $
 TTY
-@tty.assert_cursor_position(x: 2, y: 2)
+@tty.assert_cursor_position(2, 2)
 
 @tty.assert_contents_at(0, 0, '$ echo "Hello, world"')
 
@@ -64,44 +59,20 @@ TTY
 @tty.assert_row_starts_with(1, 'Hello')
 @tty.assert_row_ends_with(1, ', world')
 
-@tty.print_rows # => ["$ echo \"Hello, world\"", "Hello, world", "$", "", "", "", ...]
-
-@tty.print # prints out the contents of the terminal
-```
-
-### Example for Noncanonical CLI or Shell
-
-If you are working with a noncanonical shell, you need to use send_keys_one_at_a_time to have your shell/CLI process the input correctly.
-
-Also useful if you need to send input one character at a time for whatever reason.
-
-'Multi-character' characters like '\n' need to be sent with send-keys, though.
-
-``` ruby
-require 'ttytest'
-
-@tty = TTYtest.new_terminal(%{PS1='$ ' /bin/noncanonical-sh}, width: 80, height: 24)
-@tty.assert_row_starts_with(0, ENV['USER'])
-@tty.assert_row_ends_with(0, '$')
-
-@tty.send_keys_one_at_a_time('ls')
-@tty.assert_row_ends_with(0, 'ls')
-@tty.send_newline # builtins for common outputs line newline
+@tty.print_rows # prints out the contents of the terminal as an array:
+# ["$ echo \"Hello, world\"", "Hello, world", "$", "", "", "", ""]
 
-@tty.send_keys_one_at_a_time('ps')
-@tty.assert_row_ends_with(1, 'ps')
-@tty.send_keys(TTYtest:NEWLINE) # can use constants instead
-
-@tty.assert_row_starts_with(2, ENV['USER'])
-@tty.assert_row_ends_with(2, '$')
-@tty.send_newline
-
-puts "\n#{@tty.capture}" # prints out the contents of the terminal, equivalent to @tty.print
+@tty.print # prints out the contents of the terminal:
+# $ echo "Hello, world"
+# Hello, world
+# $
 ```
 
 ### Assertions
 
-The main way to use TTYtest is through assertions. When called on a `TTYtest::Terminal`, each of these will be retried (for up to 2 seconds).
+The main way to use TTYtest is through assertions.
+
+Assertions will be retried for up to 2 seconds when called through TTYtest::Terminal.
 
 Available assertions:
 
@@ -110,6 +81,7 @@ Available assertions:
 * `assert_row_like(row_number, expected_text)`
 * `assert_row_starts_with(row_number, expected_text)`
 * `assert_row_ends_with(row_number, expected_text)`
+* `assert_row_regexp(row_number, regexp_str)`
 * `assert_cursor_position(x: x, y: y)`
 * `assert_cursor_visible`
 * `assert_cursor_hidden`
@@ -120,19 +92,23 @@ Available assertions:
 
 You can send output to the terminal with the following calls.
 
-* `send_keys(output) # for canonical shells/CLI's (or multi-character keys for noncanonical shells/CLI's)`
-* `send_keys_one_at_a_time(output) # for noncanonical shells/CLI's`
-* `send_keys_exact(output) # for sending tmux specific keys (DC for delete, Escape for ESC, etc.)`
+Note: Most of the time send_line has the best ergonomics.
+
+* `send_line(line)`: simulate typing in a command in the terminal and hitting enter!
+* `send_line_then_sleep(line, sleep_time)`: simulate typing in a command in the terminal and hitting enter, then wait for sleep_time seconds.
+* `send_keys(output)`: for canonical shells/CLI's (or multi-character keys for noncanonical shells/CLI's).
+* `send_keys_one_at_a_time(output)`: for noncanonical shells/CLI's.
+* `send_keys_exact(output)`: for sending tmux specific keys (any supported send-keys arguments like: DC for delete, Escape for ESC, etc.)
 
 ### Output Helpers
 
 Helper functions to make sending output easier! They use the methods above under 'Sending Output' section under the hood.
 
-* `send_newline` # equivalent to @tty.send_keys(%(\n))
+* `send_newline` # simulate hitting enter, equivalent to @tty.send_keys(%(\n))
 * `send_newlines(number_of_times)` # equivalent to calling send_newline number_of_times
-* `send_backspace` # equivalent to @tty.send_keys(TTYtest::BACKSPACE)
+* `send_backspace` # simulate hitting backspace, equivalent to @tty.send_keys(TTYtest::BACKSPACE)
 * `send_backspaces(number_of_times)` # equivalent to calling send_backspace number_of_times
-* `send_delete` # equivalent to calling send_keys_exact(%(DC))
+* `send_delete` # simulate hitting delete, equivalent to calling send_keys_exact(%(DC))
 * `send_deletes` # equivalent to calling send_delete number_of_times
 * `send_right_arrow`
 * `send_right_arrows(number_of_times)`
@@ -180,15 +156,26 @@ You can configure max wait time as shown below.
 You can use the method rows to get all rows of the terminal as an array, of use the method capture to get the contents of the terminal window. This can be useful when troubleshooting.
 
 ``` ruby
-@tty = TTYtest::new_terminal('')
+@tty = TTYtest.new_terminal(%(PS1='$ ' /bin/sh), width: 80, height: 7)
+@tty.send_line('echo "Hello, world"'))
 
 # you can use @tty.rows to access the entire pane, split by line into an array.
-p @tty.rows # prints out the contents of the terminal as a array.
-@tty.print_rows # equivalent to above, just for ease of use.
+@tty.print_rows # prints out the contents of the terminal as an array:
+# ["$ echo \"Hello, world\"", "Hello, world", "$", "", "", "", ""]
+
+# if you want to programatically access the rows, you can do so using @tty.rows
+p @tty.rows # is equivalent to above statement @tty.print_rows
+
+
 
 # you can use @tty.capture to access the entire pane.
-p "\n#{@tty.capture}" # prints out the contents of the terminal
-@tty.print # equivalent to above, just for ease of use.
+@tty.print # prints out the contents of the terminal:
+# $ echo "Hello, world"
+# Hello, world
+# $
+
+# if you want to programatically access the entire pane, you can do so using @tty.capture
+p "\n#{@tty.capture}" # is equivalent to above statement @tty.print
 ```
 
 ### Constants
@@ -196,6 +183,8 @@ p "\n#{@tty.capture}" # prints out the contents of the terminal
 There are some commonly used keys available as constants to make interacting with your shell/CLI easy.
 
 ``` ruby
+  TTYtest::CTRLA
+  TTYtest::CTRLB
   TTYtest::CTRLC
   TTYtest::CTRLD
   TTYtest::CTRLF
@@ -205,8 +194,12 @@ There are some commonly used keys available as constants to make interacting wit
   TTYtest::NEWLINE # \n
   TTYtest::VERTICAL_TAB
   TTYtest::FORM_FEED # \f or New Page NP
+  TTYtest::CTRLL
   TTYtest::CARRIAGE_RETURN # \r
+  TTYtest::CTRLU
+  TTYtest::CTRLW
   TTYtest::ESCAPE # 27 decimal or ^[ or /033
+  TTYtest::CTRL_
   TTYtest::DELETE
 
   TTYtest::UP_ARROW
@@ -222,7 +215,7 @@ There are some commonly used keys available as constants to make interacting wit
 
 ### Tips
 
-If you are using ttyest2 to test your CLI, using sh is easier than bash because you don't have to worry about user, current working directory, etc. as shown in the examples above.
+If you are using ttyest2 to test your CLI, using sh is easier than bash because you don't have to worry about user, current working directory, etc. as shown in the examples.
 
 If you are using ttytest2 to test your shell, using assertions like assert_row_like, assert_row_starts_with, and assert_row_ends_with are going to be extremely helpful, especially if trying to test your shell in different environments or using a docker container.
 

data/examples/integration_tests.rb

@@ -0,0 +1,790 @@
+# !/usr/bin/env ruby
+# frozen_string_literal: true
+
+# this is from my personal project, ncsh.
+# it is an example of integration/acceptance tests using ttytest2.
+# ncsh is a noncanonical shell which I use ttytest2 to integration test.
+
+require 'ttytest'
+
+START_COL = 20
+WC_C_LENGTH = '225'
+SLEEP_TIME = 0.2
+LS_LINES = 3
+LS_ITEMS = 19
+LS_FIRST_ITEM = 'CMakeLists.txt'
+TAB_AUTOCOMPLETE_ROWS = 10
+
+def assert_check_new_row(row)
+  @tty.assert_row_starts_with(row, "#{ENV['USER']} ")
+  @tty.assert_row_like(row, 'ncsh')
+  @tty.assert_row_ends_with(row, ' ❱ ')
+  @tty.assert_cursor_position(START_COL, row)
+end
+
+def starting_tests(test)
+  puts "===== Starting #{test} tests ====="
+end
+
+def z_database_new_test(row)
+  @tty.assert_row(row, 'Error opening z database file: No such file or directory')
+  row += 1
+  @tty.assert_row(row, 'Trying to create z database file.')
+  row += 1
+  @tty.assert_row(row, 'Created z database file.')
+  row += 1
+  puts 'New z database test passed'
+  row
+end
+
+def startup_test(row)
+  @tty.assert_row_starts_with(row, 'ncsh: startup time: ')
+  row += 1
+  puts 'Startup time test passed'
+  row
+end
+
+def newline_sanity_test(row)
+  assert_check_new_row(row)
+  @tty.send_newline
+  row += 1
+  assert_check_new_row(row)
+  @tty.send_newline
+  row += 1
+  puts 'Newline sanity test passed'
+  row
+end
+
+def empty_line_arrow_check(row)
+  @tty.send_left_arrow
+  assert_check_new_row(row)
+  @tty.send_right_arrow
+  assert_check_new_row(row)
+end
+
+def empty_line_sanity_test(row)
+  assert_check_new_row(row)
+  empty_line_arrow_check(row)
+  @tty.send_backspace
+  assert_check_new_row(row)
+  @tty.send_delete
+  assert_check_new_row(row)
+  puts 'Empty line sanity test passed'
+  row
+end
+
+def startup_tests(row, run_z_database_new_tests)
+  starting_tests 'startup tests'
+
+  row = z_database_new_test row if run_z_database_new_tests
+  row = startup_test row
+  row = newline_sanity_test row
+
+  empty_line_sanity_test row
+end
+
+def basic_ls_test(row)
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(ls))
+  @tty.assert_cursor_position(START_COL + 2, row)
+  @tty.send_newline
+  @tty.assert_row_ends_with(row, 'ls')
+  row += 1
+  @tty.assert_row_starts_with(row, LS_FIRST_ITEM)
+  row += LS_LINES
+  puts 'Basic input (ls) test passed'
+  row
+end
+
+def basic_bad_command_test(row)
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(lss)) # send a bad command
+  @tty.assert_cursor_position(START_COL + 3, row)
+  @tty.send_newline
+  @tty.assert_row_ends_with(row, 'lss')
+  row += 1
+  @tty.assert_row(row, 'ncsh: Could not find command or directory: No such file or directory')
+  row += 1
+  puts 'Bad command test passed'
+  row
+end
+
+def basic_tests(row)
+  starting_tests 'basic'
+
+  row = basic_ls_test row
+  basic_bad_command_test row
+end
+
+def home_and_end_tests(row)
+  starting_tests 'home and end'
+
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(ss))
+  @tty.send_home
+  @tty.assert_cursor_position(START_COL, row)
+  @tty.send_end
+  @tty.assert_cursor_position(START_COL + 2, row)
+  @tty.send_backspaces(2)
+
+  puts 'Home and End tests passed'
+  row
+end
+
+def end_of_line_backspace_test(row)
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(l))
+  @tty.send_backspace
+  assert_check_new_row(row)
+  puts 'End of line backspace test passed'
+  row
+end
+
+def multiple_end_of_line_backspace_test(row)
+  @tty.send_keys_one_at_a_time(%(lsssss))
+  @tty.assert_row_ends_with(row, %(lsssss))
+  @tty.send_backspaces(4)
+  @tty.assert_row_ends_with(row, 'ls')
+  @tty.send_backspaces(2)
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(echo hello)) # make sure buffer is properly formed after backspaces
+  @tty.send_backspace
+  @tty.send_keys_one_at_a_time(%(o))
+  @tty.send_newline
+  row += 1
+  @tty.assert_row(row, 'hello')
+  row += 1
+  puts 'Multiple end of line backspace test passed'
+  row
+end
+
+def midline_backspace_test(row)
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(lsssss))
+  @tty.assert_cursor_position(START_COL + 6, row)
+  @tty.send_left_arrows(2)
+  @tty.assert_cursor_position(START_COL + 4, row)
+  @tty.send_backspaces(4)
+  @tty.assert_cursor_position(START_COL, row)
+  @tty.assert_row_ends_with(row, 'ss')
+  @tty.send_right_arrows(2)
+  @tty.assert_cursor_position(START_COL + 2, row)
+  @tty.send_backspaces(2)
+  @tty.assert_cursor_position(START_COL, row)
+  @tty.send_keys_one_at_a_time(%(echo hello)) # make sure buffer is properly formed after backspaces
+  @tty.send_newline
+  row += 1
+  @tty.assert_row(row, 'hello')
+  row += 1
+  puts 'Midline backspace test passed'
+  row
+end
+
+def backspace_tests(row)
+  starting_tests 'backspace'
+
+  row = end_of_line_backspace_test row
+  row = multiple_end_of_line_backspace_test row
+
+  midline_backspace_test row
+end
+
+def end_of_line_delete_test(row)
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time('s')
+  @tty.assert_cursor_position(START_COL + 1, row)
+  @tty.send_left_arrow
+  @tty.assert_cursor_position(START_COL, row)
+  @tty.send_delete
+  assert_check_new_row(row)
+  puts 'End of line delete test passed'
+  row
+end
+
+def midline_delete_test(row)
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(lssss))
+  @tty.assert_cursor_position(START_COL + 5, row)
+  @tty.send_left_arrows(4)
+  @tty.assert_cursor_position(START_COL + 1, row)
+  @tty.send_delete
+  @tty.assert_cursor_position(START_COL + 1, row)
+  @tty.send_deletes(3)
+  @tty.send_left_arrow
+  @tty.send_delete
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(echo hello))
+  @tty.send_newline
+  row += 1
+  @tty.assert_row(row, 'hello')
+  row += 1
+  puts 'Midline delete test passed'
+  row
+end
+
+def delete_tests(row)
+  starting_tests 'delete'
+
+  row = end_of_line_delete_test row
+  midline_delete_test row
+end
+
+def pipe_test(row)
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(ls | wc -c))
+  @tty.send_newline
+  row += 1
+  @tty.assert_row_ends_with(row, WC_C_LENGTH)
+  row += 1
+  puts 'Simple pipe test passed'
+  row
+end
+
+def multiple_pipes_test(row)
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(ls | sort | wc -c))
+  @tty.send_newline
+  row += 1
+  @tty.assert_row_ends_with(row, WC_C_LENGTH)
+  row += 1
+  puts 'Multiple pipes test passed'
+  row
+end
+
+def pipe_tests(row)
+  starting_tests 'pipe'
+
+  row = pipe_test row
+  multiple_pipes_test row
+end
+
+def basic_history_test(row)
+  assert_check_new_row(row)
+  @tty.send_up_arrow
+  @tty.assert_row_ends_with(row, 'ls | sort | wc -c')
+  @tty.send_up_arrow
+  @tty.assert_row_ends_with(row, 'ls | wc -c')
+  @tty.send_down_arrow
+  @tty.assert_row_ends_with(row, 'ls | sort | wc -c')
+  @tty.send_newline
+  row += 1
+  @tty.assert_row_ends_with(row, WC_C_LENGTH)
+  row += 1
+  puts 'Basic history test passed'
+  row
+end
+
+def history_delete_test(row)
+  assert_check_new_row(row)
+  @tty.send_up_arrow
+  @tty.assert_row_ends_with(row, 'ls | sort | wc -c')
+  @tty.send_left_arrows(12)
+  @tty.send_deletes(7)
+  @tty.send_newline
+  row += 1
+  @tty.assert_row_ends_with(row, WC_C_LENGTH)
+  row += 1
+  puts 'History delete test passed'
+  row
+end
+
+def history_backspace_test(row)
+  # TODO: implementation
+  puts 'History backspace test passed'
+  row
+end
+
+def history_clear_test(row)
+  # TODO: implementation
+  puts 'History clear test passed'
+  row
+end
+
+def history_tests(row)
+  starting_tests 'history'
+
+  row = basic_history_test row
+  # row =
+  history_delete_test row
+  # row = history_backspace_test
+  # history_clear_test
+end
+
+def basic_stdout_redirection_test(row)
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(ls > t.txt))
+  @tty.send_newline
+  sleep SLEEP_TIME
+  row += 1
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(head -1 t.txt))
+  @tty.send_newline
+  sleep SLEEP_TIME
+  row += 1
+  @tty.assert_row_starts_with(row, LS_FIRST_ITEM)
+  row += 1
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(rm t.txt))
+  @tty.send_newline
+  row += 1
+  puts 'Basic output redirection test passed'
+  row
+end
+
+def piped_stdout_redirection_test(row)
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(ls | sort -r > t2.txt))
+  @tty.assert_row_ends_with(row, %(ls | sort -r > t2.txt))
+  @tty.send_newline
+  sleep SLEEP_TIME
+  row += 1
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(head -1 t2.txt))
+  @tty.assert_row_ends_with(row, %(head -1 t2.txt))
+  @tty.send_newline
+  sleep SLEEP_TIME
+  row += 1
+  @tty.assert_row_starts_with(row, 'tests_z.sh')
+  row += 1
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(rm t2.txt))
+  @tty.send_newline
+  row += 1
+  puts 'Piped output redirection test passed'
+  row
+end
+
+def multiple_piped_stdout_redirection_test(row)
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(ls | sort | wc -c > t3.txt))
+  @tty.assert_row_ends_with(row, %(ls | sort | wc -c > t3.txt))
+  @tty.send_newline
+  sleep SLEEP_TIME
+  row += 1
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(head -1 t3.txt))
+  @tty.assert_row_ends_with(row, %(head -1 t3.txt))
+  @tty.send_newline
+  sleep SLEEP_TIME
+  row += 1
+  @tty.assert_row_starts_with(row, (WC_C_LENGTH.to_i + 't3.txt'.length + 1).to_s)
+  row += 1
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(rm t3.txt))
+  @tty.send_newline
+  row += 1
+  puts 'Multiple piped output redirection test passed'
+  row
+end
+
+def stdout_redirection_tests(row)
+  starting_tests 'stdout redirection'
+
+  row = basic_stdout_redirection_test row
+  row = piped_stdout_redirection_test row
+  multiple_piped_stdout_redirection_test row
+end
+
+def z_add_tests(row)
+  starting_tests 'z_add'
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(z add ~/.config\n))
+  row += 1
+  @tty.assert_row_ends_with(row, %(Added new entry to z database.))
+  row += 1
+  @tty.send_keys_one_at_a_time(%(z add ~/.config\n))
+  row += 1
+  @tty.assert_row_ends_with(row, 'Entry already exists in z database.')
+  row += 1
+  puts 'z add tests passed'
+  row
+end
+
+def basic_stdin_redirection_test(row)
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(ls > t.txt))
+  @tty.send_newline
+  sleep SLEEP_TIME
+  row += 1
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(sort < t.txt))
+  @tty.send_newline
+  sleep SLEEP_TIME
+  row += 1
+  @tty.assert_row_starts_with(row, LS_FIRST_ITEM)
+  row += LS_ITEMS
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(rm t.txt))
+  @tty.send_newline
+  row += 1
+  puts 'Basic input redirection test passed'
+  row
+end
+
+def piped_stdin_redirection_test(row)
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(ls > t2.txt))
+  @tty.assert_row_ends_with(row, %(ls > t2.txt))
+  @tty.send_newline
+  sleep SLEEP_TIME
+  row += 1
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(sort | wc -c < t2.txt))
+  @tty.assert_row_ends_with(row, %(sort | wc -c < t2.txt))
+  @tty.send_newline
+  sleep SLEEP_TIME
+  row += 1
+  @tty.assert_row_starts_with(row, (WC_C_LENGTH.to_i + 't2.txt'.length + 1).to_s)
+  row += 1
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(rm t2.txt))
+  @tty.send_newline
+  row += 1
+  puts 'Piped input redirection test passed'
+  row
+end
+
+def multiple_piped_stdin_redirection_test(row)
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(ls > t3.txt))
+  @tty.assert_row_ends_with(row, %(ls > t3.txt))
+  @tty.send_newline
+  sleep SLEEP_TIME
+  row += 1
+  @tty.send_keys_one_at_a_time(%(sort | head -1 | wc -l < t3.txt))
+  @tty.assert_row_ends_with(row, %(sort | head -1 | wc -l < t3.txt))
+  @tty.send_newline
+  sleep SLEEP_TIME
+  row += 1
+  @tty.assert_row(row, '1')
+  row += 1
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(rm t3.txt))
+  @tty.send_newline
+  row += 1
+  puts 'Multiple piped input redirection test passed'
+  row
+end
+
+def stdin_redirection_tests(row)
+  starting_tests 'stdin redirection'
+
+  row = basic_stdin_redirection_test row
+  row = piped_stdin_redirection_test row
+  multiple_piped_stdin_redirection_test row
+end
+
+def basic_autocompletion_test(row)
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(l))
+  @tty.send_right_arrow
+  @tty.assert_row_ends_with(row, %(ls))
+  @tty.send_backspaces(2)
+
+  puts 'Basic autocompletion test passed'
+  row
+end
+
+def backspace_and_delete_autocompletion_test(row)
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(ls |))
+  @tty.send_right_arrow
+  @tty.assert_row_ends_with(row, %(ls | sort))
+
+  @tty.send_left_arrows(6)
+  @tty.send_deletes(6)
+  @tty.send_keys_one_at_a_time(%(|))
+  @tty.send_right_arrow
+  @tty.assert_row_ends_with(row, %(ls | sort))
+
+  @tty.send_keys_one_at_a_time(%( |))
+  @tty.send_right_arrow
+  @tty.assert_row_ends_with(row, %(ls | sort | wc -c))
+  @tty.send_newline
+  row += 1
+  @tty.assert_row(row, WC_C_LENGTH)
+  row += 1
+
+  puts 'Backspace and delete autocompletion test passed'
+  row
+end
+
+def autocompletion_tests(row)
+  starting_tests 'autocompletion'
+
+  row = basic_autocompletion_test row
+  backspace_and_delete_autocompletion_test row
+end
+
+def help_test(row)
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(help\n))
+  row += 1
+  @tty.assert_contents_at row, row + 6, <<~TERM
+    ncsh by Alex Eski: help
+
+    Builtin Commands {command} {args}
+    q:              To exit, type q, exit, or quit and press enter. You can also use Ctrl+D to exit.
+    cd/z:           You can change directory with cd or z.
+    echo:           You can write things to the screen using echo.
+    history:        You can see your command history using the history command.
+    alex /shells/ncsh ❱
+  TERM
+  row += 7
+  puts 'Help test passed'
+  row
+end
+
+def basic_echo_test(row)
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(echo hello))
+  @tty.assert_cursor_position(START_COL + 10, row)
+  @tty.send_newline
+  @tty.assert_row_ends_with(row, 'echo hello')
+  row += 1
+  @tty.assert_row(row, 'hello')
+  row += 1
+  puts 'echo hello test passed'
+  row
+end
+
+def builtin_tests(row)
+  starting_tests 'builtin'
+
+  row = help_test row
+  basic_echo_test row
+end
+
+def delete_line_tests(row)
+  starting_tests 'delete line'
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(ls | sort ))
+  @tty.send_keys_exact(TTYtest::CTRLU)
+  assert_check_new_row(row)
+  @tty.send_keys_exact(TTYtest::CTRLU)
+  puts 'Delete line test passed'
+  row
+end
+
+def delete_word_tests(row)
+  starting_tests 'delete word'
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(ls | sort ))
+  @tty.send_keys(TTYtest::CTRLW)
+  @tty.assert_row_ends_with(row, %(ls | sort))
+  @tty.send_keys(TTYtest::CTRLW)
+  @tty.assert_row_ends_with(row, %(ls |))
+  @tty.send_keys(TTYtest::CTRLW)
+  @tty.assert_row_ends_with(row, %(ls))
+  @tty.send_keys(TTYtest::CTRLW)
+  puts 'Delete word test passed'
+  row
+end
+
+def tab_out_autocompletion_test(row)
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(ls))
+  @tty.send_keys(TTYtest::TAB)
+  row += 1
+  @tty.assert_row_ends_with(row, %(ls > t.txt))
+  @tty.send_keys(TTYtest::TAB)
+  row += TAB_AUTOCOMPLETE_ROWS
+  assert_check_new_row(row)
+
+  puts 'Tab out of autocompletion test passed'
+  row
+end
+
+def arrows_move_tab_autocompletion_test(row)
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(ls))
+  @tty.send_keys(TTYtest::TAB)
+  row += 1
+  cursor_x_before = @tty.cursor_x
+  cursor_y_before = @tty.cursor_y
+  @tty.send_up_arrow
+  @tty.assert_cursor_position(cursor_x_before, cursor_y_before)
+  @tty.send_down_arrow
+  @tty.assert_cursor_position(cursor_x_before, cursor_y_before + 1)
+  @tty.send_down_arrows(TAB_AUTOCOMPLETE_ROWS + 1)
+  @tty.assert_cursor_position(cursor_x_before, cursor_y_before + 8)
+  @tty.send_keys(TTYtest::TAB)
+  row += TAB_AUTOCOMPLETE_ROWS
+
+  puts 'Arrows autocompletion test passed'
+  row
+end
+
+def select_tab_autocompletion_test(row)
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(ls))
+  @tty.send_keys(TTYtest::TAB)
+  row += 1
+  @tty.send_down_arrows(5)
+  @tty.send_newline
+  row += TAB_AUTOCOMPLETE_ROWS + 1
+  @tty.assert_row_ends_with(row, WC_C_LENGTH)
+  row += 1
+
+  puts 'Select tab autocompletion test passed'
+  row
+end
+
+def tab_autocompletion_tests(row)
+  starting_tests 'tab autocompletion'
+
+  row = tab_out_autocompletion_test row
+  row = arrows_move_tab_autocompletion_test row
+  select_tab_autocompletion_test row
+end
+
+def assert_check_syntax_error(row, input)
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(input)
+  @tty.send_newline
+  row += 1
+  @tty.assert_row_starts_with(row, 'ncsh: Invalid syntax:')
+  row += 1
+  row
+end
+
+def operators_invalid_syntax_first_position_test(row)
+  # tries sending operator as only character to ensure invalid syntax is shown to user
+  row = assert_check_syntax_error(row, '|') # pipe
+  row = assert_check_syntax_error(row, '>') # output redirection
+  row = assert_check_syntax_error(row, '>>') # output redirection append
+  row = assert_check_syntax_error(row, '<') # input redirection
+  row = assert_check_syntax_error(row, '2>') # error redirection
+  row = assert_check_syntax_error(row, '2>>') # error redirection append
+  row = assert_check_syntax_error(row, '&>') # output and error redirection
+  row = assert_check_syntax_error(row, '&>>') # output and error redirection append
+  row = assert_check_syntax_error(row, '&') # background job
+  puts 'Invalid syntax in first position test passed'
+  row
+end
+
+def operators_invalid_syntax_last_position_test(row)
+  row = assert_check_syntax_error(row, 'ls |') # pipe
+  row = assert_check_syntax_error(row, 'ls >') # output redirection
+  row = assert_check_syntax_error(row, 'ls >>') # output redirection append
+  row = assert_check_syntax_error(row, 'sort <') # input redirection
+  row = assert_check_syntax_error(row, 'ls 2>') # error redirection
+  row = assert_check_syntax_error(row, 'ls 2>>') # error redirection append
+  row = assert_check_syntax_error(row, 'ls &>') # output and error redirection
+  row = assert_check_syntax_error(row, 'ls &>>') # output and error redirection append
+  puts 'Invalid syntax in last position test passed'
+  row
+end
+
+# invalid operator usage to ensure invalid syntax is shown to user
+def syntax_error_tests(row)
+  starting_tests 'syntax errors'
+
+  row = operators_invalid_syntax_first_position_test row
+  operators_invalid_syntax_last_position_test row
+end
+
+def basic_stderr_redirection_test(row)
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(lss 2> t4.txt))
+  @tty.send_newline
+  sleep SLEEP_TIME
+  row += 1
+  @tty.send_keys_one_at_a_time(%(cat t4.txt))
+  @tty.send_newline
+  row += 1
+  @tty.assert_row_ends_with(row, 'No such file or directory')
+  row += 1
+  @tty.send_keys_one_at_a_time(%(rm t4.txt))
+  @tty.send_newline
+  row += 1
+
+  puts 'Basic stderr redirection test passed'
+  row
+end
+
+def stderr_redirection_tests(row)
+  starting_tests 'sterr redirection'
+
+  basic_stderr_redirection_test row
+end
+
+def basic_stdout_and_stderr_redirection_stderr_test(row)
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(lss &> t4.txt))
+  @tty.send_newline
+  sleep SLEEP_TIME
+  row += 1
+  @tty.send_keys_one_at_a_time(%(cat t4.txt))
+  @tty.send_newline
+  row += 1
+  @tty.assert_row_ends_with(row, 'No such file or directory')
+  row += 1
+  @tty.send_keys_one_at_a_time(%(rm t4.txt))
+  @tty.send_newline
+  row += 1
+
+  puts 'Basic stdout and stderr redirection stderr test passed'
+  row
+end
+
+def basic_stdout_and_stderr_redirection_stdout_test(row)
+  assert_check_new_row(row)
+  @tty.send_keys_one_at_a_time(%(ls &> t4.txt))
+  @tty.send_newline
+  sleep SLEEP_TIME
+  row += 1
+  @tty.send_keys_one_at_a_time(%(cat t4.txt | head -1))
+  @tty.send_newline
+  row += 1
+  @tty.assert_row_ends_with(row, LS_FIRST_ITEM)
+  row += 1
+  @tty.send_keys_one_at_a_time(%(rm t4.txt))
+  @tty.send_newline
+  row += 1
+
+  puts 'Basic stdout and stderr redirection stdout test passed'
+  row
+end
+
+def stdout_and_stderr_redirection_tests(row)
+  starting_tests 'stdout and sterr redirection'
+
+  row = basic_stdout_and_stderr_redirection_stderr_test row
+  basic_stdout_and_stderr_redirection_stdout_test row
+end
+
+row = 0
+@tty = TTYtest.new_terminal(%(PS1='$ ' ./bin/ncsh), width: 120, height: 120)
+
+row = startup_tests(row, true)
+row = basic_tests row
+row = home_and_end_tests row
+row = backspace_tests row
+row = delete_tests row
+row = pipe_tests row
+row = history_tests row
+row = stdout_redirection_tests row
+row = z_add_tests row
+row = stdin_redirection_tests row
+row = autocompletion_tests row
+row = builtin_tests row
+row = delete_line_tests row
+row = delete_word_tests row
+tab_autocompletion_tests row
+@tty.send_keys_exact(%(quit))
+@tty.send_newline
+
+row = 0
+@tty = TTYtest.new_terminal(%(PS1='$ ' ./bin/ncsh), width: 180, height: 150)
+row = startup_tests(row, false)
+row = syntax_error_tests row
+row = stderr_redirection_tests row
+stdout_and_stderr_redirection_tests row
+
+# troubleshooting
+# @tty.print
+# @tty.print_rows
+# p @tty.to_s
+
+puts 'All tests passed!'

data/lib/ttytest/terminal.rb

@@ -24,6 +24,10 @@ module TTYtest
     # @!method send_keys_one_at_a_time(keys)
     #   Simulate typing keys into the terminal. For noncanonical cli's/shells which read character by character.
     #   @param [String] keys keys to send to the terminal
+    # @!method send_line(line)
+    #   Simulate sending a line to the terminal and hitting enter.
+    # @!method send_line_then_sleep(line, sleep_time)
+    #   Simulate sending a line to the terminal and hitting enter, then wait for the sleep_time.
     # @!method send_newline
     #   Simulate typing enter by sending newline character to the terminal.
     # @!method send_newlines
@@ -74,6 +78,7 @@ module TTYtest
     #   @return [Capture] instantaneous state of the terminal when called
     def_delegators :@driver_terminal,
                    :send_keys, :send_keys_one_at_a_time,
+                   :send_line, :send_line_then_sleep,
                    :send_newline, :send_newlines,
                    :send_delete, :send_deletes,
                    :send_backspace, :send_backspaces,

data/lib/ttytest/tmux/session.rb

@@ -13,7 +13,8 @@ module TTYtest
         ObjectSpace.define_finalizer(@id, proc {
           begin
             driver.tmux(*%W[kill-session -t #{name}])
-          rescue ThreadError => _e # final session always throws, ThreadError can't alloc new
+          rescue ThreadError => _e # final session always throws during testing (running rake),
+            # throws error 'ThreadError can't alloc new'
           end
         })
       end
@@ -54,6 +55,18 @@ module TTYtest
         end
       end
 
+      # Send line to tmux, no need to worry about newline character
+      def send_line(line)
+        send_keys_one_at_a_time(line)
+        send_newline unless line[-1] == '\n'
+      end
+
+      # Send line then sleep for sleep_time
+      def send_line_then_sleep(line, sleep_time)
+        send_line(line)
+        sleep sleep_time
+      end
+
       def send_newline
         driver.tmux(*%W[send-keys -t #{name} -l], %(\n))
       end

data/lib/ttytest/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TTYtest
-  VERSION = '0.9.11'
+  VERSION = '0.9.12'
 end

data/notes.txt

@@ -1,7 +1,7 @@
 to push new version to github
-git tag v0.9.11
+git tag v0.9.12
 git push origin --tags
 
 to push new version to rubygems.org
 gem build ttytest2.gemspec
-gem push ttytest2-0.9.11.gem
+gem push ttytest2-0.9.12.gem

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ttytest2
 version: !ruby/object:Gem::Version
-  version: 0.9.11
+  version: 0.9.12
 platform: ruby
 authors:
 - Alex Eski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-06 00:00:00.000000000 Z
+date: 2025-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,8 +94,7 @@ files:
 - Gemfile
 - README.md
 - Rakefile
-- examples/canonical_integration_tests.rb
-- examples/noncanonical_integration_tests.rb
+- examples/integration_tests.rb
 - lib/ttytest.rb
 - lib/ttytest/capture.rb
 - lib/ttytest/constants.rb

data/examples/canonical_integration_tests.rb

@@ -1,85 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-# example testing a noncanonical shell, ncsh
-
-require 'ttytest'
-
-START_COL = 19
-
-def assert_check_new_row(row)
-  @tty.assert_row_starts_with(row, "#{ENV['USER']}:")
-  @tty.assert_row_like(row, 'ncsh')
-  @tty.assert_row_ends_with(row, '$')
-  @tty.assert_cursor_position(START_COL, row)
-end
-
-@tty = TTYtest.new_terminal(%(PS1='$ ' ./bin/ncsh), width: 80, height: 24)
-
-row = 0
-
-# # # # Basic Tests # # # #
-puts 'Starting basic tests'
-
-@tty.assert_row_starts_with(row, 'ncsh: startup time: ')
-row += 1
-
-assert_check_new_row(row)
-@tty.send_keys(%(ls))
-@tty.assert_cursor_position(START_COL + 2, 1)
-@tty.send_newline
-@tty.assert_row_ends_with(row, 'ls')
-row += 1
-@tty.assert_row_starts_with(row, 'LICENSE')
-row = 9
-
-assert_check_new_row(row)
-@tty.send_keys(%(echo hello))
-@tty.send_newline
-row += 1
-@tty.assert_row(row, 'hello')
-row += 1
-
-assert_check_new_row(row)
-@tty.send_keys(%(lss)) # send a bad command
-@tty.send_newline
-row += 1
-@tty.assert_row(row, 'ncsh: Could not find command or directory: No such file or directory')
-row += 1
-
-puts 'Starting backspace tests'
-
-# end of line backspace
-assert_check_new_row(row)
-@tty.send_keys(%(l))
-@tty.send_backspace
-assert_check_new_row(row)
-
-# multiple end of line backspaces
-@tty.send_keys(%(lsssss))
-@tty.send_backspaces(4)
-@tty.assert_row_ends_with(row, 'ls')
-@tty.send_backspaces(2)
-@tty.send_keys(%(echo hello)) # make sure buffer is properly formed after backspaces
-@tty.send_newline
-row += 1
-@tty.assert_row(row, 'hello')
-row += 1
-
-# midline backspace
-assert_check_new_row(row)
-@tty.send_keys(%(lsssss))
-@tty.assert_cursor_position(START_COL + 6, row)
-@tty.send_left_arrows(2)
-@tty.assert_cursor_position(START_COL + 4, row)
-@tty.send_backspaces(4)
-@tty.assert_cursor_position(START_COL, row)
-@tty.assert_row_ends_with(row, '$ ss')
-@tty.send_right_arrows(2)
-@tty.assert_cursor_position(START_COL + 2, row)
-@tty.send_backspaces(2)
-@tty.assert_cursor_position(START_COL, row)
-@tty.send_keys(%(echo hello)) # make sure buffer is properly formed after backspaces
-@tty.send_newline
-row += 1
-@tty.assert_row(row, 'hello')

data/examples/noncanonical_integration_tests.rb

@@ -1,80 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-# example testing a canonical shell called shl
-
-require 'ttytest'
-
-START_COL = 19
-
-def assert_check_new_row(row)
-  @tty.assert_row_starts_with(row, "#{ENV['USER']}:")
-  @tty.assert_row_like(row, 'shl')
-  @tty.assert_row_ends_with(row, '$')
-  @tty.assert_cursor_position(START_COL, row)
-end
-
-@tty = TTYtest.new_terminal(%(PS1='$ ' ./bin/shl), width: 80, height: 24)
-
-row = 0
-
-@tty.assert_row_starts_with(row, 'shl: startup time: ')
-row += 1
-
-assert_check_new_row(row)
-@tty.send_keys_one_at_a_time(%(ls))
-@tty.assert_cursor_position(START_COL + 2, 1)
-@tty.send_newline
-@tty.assert_row_ends_with(row, 'ls')
-row += 1
-@tty.assert_row_starts_with(row, 'LICENSE')
-row = 9
-
-assert_check_new_row(row)
-@tty.send_keys_one_at_a_time(%(echo hello))
-@tty.send_newline
-row += 1
-@tty.assert_row(row, 'hello')
-row += 1
-
-assert_check_new_row(row)
-@tty.send_keys_one_at_a_time(%(lss)) # send a bad command
-@tty.send_newline
-row += 1
-@tty.assert_row(row, 'shl: Could not find command or directory: No such file or directory')
-row += 1
-
-# end of line backspace
-assert_check_new_row(row)
-@tty.send_keys_one_at_a_time(%(l))
-@tty.send_backspace
-assert_check_new_row(row)
-
-# multiple end of line backspaces
-@tty.send_keys_one_at_a_time(%(lsssss))
-@tty.send_backspaces(4)
-@tty.assert_row_ends_with(row, '$ ls')
-@tty.send_backspaces(2)
-@tty.send_keys_one_at_a_time(%(echo hello)) # make sure buffer is properly formed after backspaces
-@tty.send_newline
-row += 1
-@tty.assert_row(row, 'hello')
-row += 1
-
-# midline backspace
-assert_check_new_row(row)
-@tty.send_keys_one_at_a_time(%(lsssss))
-@tty.assert_cursor_position(START_COL + 6, row)
-@tty.send_left_arrows(2)
-@tty.assert_cursor_position(START_COL + 4, row)
-@tty.send_backspaces(4)
-@tty.assert_cursor_position(START_COL, row)
-@tty.assert_row_ends_with(row, '$ ss')
-@tty.send_right_arrows(2)
-@tty.assert_cursor_position(START_COL + 2, row)
-@tty.send_backspaces(2)
-@tty.assert_cursor_position(START_COL, row)
-@tty.send_keys_one_at_a_time(%(echo hello)) # make sure buffer is properly formed after backspaces
-@tty.send_newline
-row += 1
-@tty.assert_row(row, 'hello')