ttytest 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec223f6306af46c375d8682b34246d96a35bfeb2
-  data.tar.gz: '08f13d79052c316a5890b396004dae0d4b00c748'
+  metadata.gz: 78021e6870947818ac2d9be3fe3d83fe5070662d
+  data.tar.gz: d3cc412b912956ef3ea44948f6a656b3bfca644f
 SHA512:
-  metadata.gz: 1ce7169be0b7222a5becc34ff849d76d401b64596e7538796da2425b6bc8eb8d3bb7dba19eaa247ef48ac65ba9ff9c71270237ab842c79e9ad1fec55e370ca0c
-  data.tar.gz: 3a4c6dcc1a0c6d7360344fca24d2eac9b5c1b218f42efb58fe1318b09164f76e0bf6d10a93aa191688cc7173dff5a3ca5e11777747e91cdef1ca9f36ba49fba2
+  metadata.gz: 6fc3b334c3c43bbe3fe518f74ca5be4b262f60014f564443433a41fb2b503905264ff2df725379cd173729ce5fdca7638848a991a78ee6056f36c75c8c838669
+  data.tar.gz: 371818454cdc7df5cd7d6ceef162ddf0075ad5f6bd425122457fb0ef1e4c02e99d776c9eda2faf3adf31a01530fdbe57e04905a31f52fc216c76b6359c589df3

data/README.md

@@ -1,4 +1,6 @@
-TTYtest is an integration test framework for interactive tty applications. It's like [capybara](https://github.com/teamcapybara/capybara) for the terminal.
+TTYtest is an integration test framework for interactive console applications. It's like [capybara](https://github.com/teamcapybara/capybara) for the terminal.
+
+It works by running commands inside a tmux session, capturing the pane, and comparing the content. The assertions will wait a specified amount of time (default 2 seconds) for the expected content to appear.
 
 [![Build Status](https://travis-ci.org/jhawthorn/ttytest.svg?branch=master)](https://travis-ci.org/jhawthorn/ttytest)
 
@@ -10,20 +12,21 @@ TTYtest is an integration test framework for interactive tty applications. It's
 ## Usage
 
 ``` ruby
-class TTYtestTest < Minitest::Test
-  def test_shell_hello_world
-    @tty = TTYtest.driver.new_terminal(%{PS1='$ ' /bin/sh})
-    @tty.assert_row(0, '$')
-
-    @tty.send_raw('echo "Hello, world"', "\n")
-
-    @tty.assert_row(0, '$ echo "Hello, world"')
-    @tty.assert_row(1, 'Hello, world')
-    @tty.assert_cursor_position(2, 2)
-  end
-end
+@tty = TTYtest.new_terminal(%{PS1='$ ' /bin/sh}, width: 80, height: 24)
+@tty.assert_row(0, '$')
+@tty.assert_cursor_position(x: 2, y: 0)
+
+@tty.send_keys(%{echo "Hello, world"\n})
+
+@tty.assert_row(0, '$ echo "Hello, world"')
+@tty.assert_row(1, 'Hello, world')
+@tty.assert_cursor_position(x: 2, y: 2)
+
+p @tty.rows # => ["$ echo \"Hello, world\"", "Hello, world", "$", "", "", "", ...]
 ```
 
+See also [fzy's integration test](https://github.com/jhawthorn/fzy/blob/master/test/integration/integration_test.rb) for a full example.
+
 ## TravisCI
 
 TTYtest can run on [TravisCI](https://travis-ci.org/), but the version of tmux made available with their default ubuntu 12.04 environment is too old. However the TravisCI ubuntu 14.04 "trusty" image provides tmux 1.8, which works great.

data/lib/ttytest.rb

@@ -1,3 +1,4 @@
+require 'forwardable'
 require 'ttytest/tmux/driver'
 require 'ttytest/tmux/session'
 
@@ -5,6 +6,9 @@ module TTYtest
   class << self
     attr_accessor :driver
     attr_accessor :default_max_wait_time
+
+    extend Forwardable
+    def_delegators :driver, :new_terminal
   end
 
   class MatchError < StandardError; end

data/lib/ttytest/capture.rb

@@ -2,14 +2,17 @@ module TTYtest
   class Capture
     include TTYtest::Matchers
 
-    attr_reader :cursor_x, :cursor_y, :cursor_visible
+    attr_reader :cursor_x, :cursor_y
+    attr_reader :width, :height
 
-    def initialize(contents, cursor_x: 0, cursor_y: 0, cursor_visible: true)
+    def initialize(contents, cursor_x: 0, cursor_y: 0, width: nil, height: nil, cursor_visible: true)
       @rows = (contents+"\nEND").split("\n")[0...-1].map do |row|
         row || ""
       end
       @cursor_x = cursor_x
       @cursor_y = cursor_y
+      @width = width
+      @height = height
       @cursor_visible = cursor_visible
     end
 
@@ -25,6 +28,14 @@ module TTYtest
       rows[row]
     end
 
+    def cursor_visible?
+      @cursor_visible
+    end
+
+    def cursor_hidden?
+      !cursor_visible?
+    end
+
     def capture
       self
     end

data/lib/ttytest/matchers.rb

@@ -15,6 +15,18 @@ module TTYtest
       end
     end
 
+    def assert_cursor_visible
+      if !cursor_visible?
+        raise MatchError, "expected cursor to be visible was hidden\nEntire screen:\n#{to_s}"
+      end
+    end
+
+    def assert_cursor_hidden
+      if !cursor_hidden?
+        raise MatchError, "expected cursor to be hidden was visible\nEntire screen:\n#{to_s}"
+      end
+    end
+
     METHODS = public_instance_methods
   end
 end

data/lib/ttytest/terminal.rb

@@ -16,7 +16,17 @@ module TTYtest
     end
 
     def_delegators :@driver_terminal, :send_keys, :send_raw, :capture
-    def_delegators :capture, :rows, :row, :cursor_position
+    def_delegators :capture, :rows, :row, :cursor_position, :width, :height, :cursor_visible?, :cursor_hidden?
+
+    TTYtest::Matchers::METHODS.each do |matcher_name|
+      define_method matcher_name do |*args|
+        synchronize do
+          capture.public_send(matcher_name, *args)
+        end
+      end
+    end
+
+    private
 
     def synchronize(seconds=max_wait_time)
       start_time = Time.now
@@ -28,13 +38,5 @@ module TTYtest
         retry
       end
     end
-
-    TTYtest::Matchers::METHODS.each do |matcher_name|
-      define_method matcher_name do |*args|
-        synchronize do
-          capture.public_send(matcher_name, *args)
-        end
-      end
-    end
   end
 end

data/lib/ttytest/tmux/session.rb

@@ -18,17 +18,19 @@ module TTYtest
 
       def capture
         contents = driver.tmux(*%W[capture-pane -t #{name} -p])
-        str = driver.tmux(*%W[display-message -t #{name} -p #\{cursor_x},#\{cursor_y},#\{cursor_flag}])
-        x, y, cursor_flag = str.split(',').map(&:to_i)
-        cursor_visible = (cursor_flag != 0)
-        TTYtest::Capture.new(contents, cursor_x: x, cursor_y: y, cursor_visible: cursor_visible)
+        str = driver.tmux(*%W[display-message -t #{name} -p #\{cursor_x},#\{cursor_y},#\{cursor_flag},#\{pane_width},#\{pane_height}])
+        x, y, cursor_flag, width, height = str.split(',')
+        TTYtest::Capture.new(
+          contents.chomp("\n"),
+          cursor_x: x.to_i,
+          cursor_y: y.to_i,
+          width: width.to_i,
+          height: height.to_i,
+          cursor_visible: (cursor_flag != '0')
+        )
       end
 
       def send_keys(*keys)
-        driver.tmux(*%W[send-keys -t #{name}], *keys)
-      end
-
-      def send_raw(*keys)
         driver.tmux(*%W[send-keys -t #{name} -l], *keys)
       end
     end

data/lib/ttytest/tmux/tmux.conf

@@ -0,0 +1 @@
+set -g status off

data/lib/ttytest/version.rb

@@ -1,3 +1,3 @@
 module TTYtest
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ttytest
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - John Hawthorn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-28 00:00:00.000000000 Z
+date: 2016-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: TTYtest is an integration test framework for interactive tty applications