ttytest 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 58e7cfbcc044cae295f1667619da61dbff469b00
+  data.tar.gz: b7a3fde532a3a2eb07098e648fefb472a7996d3f
+SHA512:
+  metadata.gz: 9f99ff25102a617841af7ede0537860c71a431826082666d3fe605d55fad9208ff2c2edcc3eb6d2ee505bf3d56f290f52c287c0ca505e53e0ba90f5bf3f99404
+  data.tar.gz: a9acb9d56b24443740c51df19f338aaa77279e56876b4ac170976922605d783db214d7ae6f829e0d06e2d2750e802bc71e3c7d8aee3a84a76dc13916127f8efe

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+pkg/

data/.travis.yml

@@ -0,0 +1,14 @@
+dist: trusty
+language: ruby
+cache: bundler
+sudo: false
+before_script:
+  - tmux -V
+rvm:
+  - 2.2.6
+  - 2.3.3
+  - 2.4.0
+addons:
+  apt:
+    packages:
+    - tmux

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,47 @@
+TTYtest is an integration test framework for interactive tty applications. It's like [capybara](https://github.com/teamcapybara/capybara) for the terminal.
+
+[![Build Status](https://travis-ci.org/jhawthorn/ttytest.svg?branch=master)](https://travis-ci.org/jhawthorn/ttytest)
+
+## Requirements
+
+* tmux >= 1.8
+* Ruby >= 2.1
+
+## 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
+```
+
+## 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.
+
+Ensure the following is in your `.travis.yml` (see [this project's .travis.yml](./.travis.yml) for an example)
+
+``` yaml
+dist: trusty
+addons:
+  apt:
+    packages:
+    - tmux
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jhawthorn/execjs-fastnode.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/lib/ttytest.rb

@@ -0,0 +1,14 @@
+require 'ttytest/tmux/driver'
+require 'ttytest/tmux/session'
+
+module TTYtest
+  class << self
+    attr_accessor :driver
+    attr_accessor :default_max_wait_time
+  end
+
+  class MatchError < StandardError; end
+
+  self.driver = TTYtest::Tmux::Driver.new
+  self.default_max_wait_time = 2
+end

data/lib/ttytest/capture.rb

@@ -0,0 +1,36 @@
+module TTYtest
+  class Capture
+    include TTYtest::Matchers
+
+    attr_reader :cursor_x, :cursor_y, :cursor_visible
+
+    def initialize(contents, cursor_x: 0, cursor_y: 0, cursor_visible: true)
+      @rows = (contents+"\nEND").split("\n")[0...-1].map do |row|
+        row || ""
+      end
+      @cursor_x = cursor_x
+      @cursor_y = cursor_y
+      @cursor_visible = cursor_visible
+    end
+
+    def cursor_position
+      [@cursor_x, @cursor_y]
+    end
+
+    def rows
+      @rows
+    end
+
+    def row(row)
+      rows[row]
+    end
+
+    def capture
+      self
+    end
+
+    def to_s
+      rows.join("\n")
+    end
+  end
+end

data/lib/ttytest/dummy.rb

@@ -0,0 +1,15 @@
+module TTYtest
+  class Dummy
+    attr_accessor :contents, :cursor_position
+
+    def initialize
+      @contents = "\n"*23
+      @cursor_position = [0,0]
+    end
+
+    def capture
+      x, y = cursor_position
+      Capture.new(contents, cursor_x: x, cursor_y: y)
+    end
+  end
+end

data/lib/ttytest/matchers.rb

@@ -0,0 +1,20 @@
+module TTYtest
+  module Matchers
+    def assert_row(row_number, expected)
+      actual = row(row_number)
+      if actual != expected
+        raise MatchError, "expected row #{row_number} to be #{expected.inspect} but got #{actual.inspect}\nEntire screen:\n#{to_s}"
+      end
+    end
+
+    def assert_cursor_position(x, y)
+      expected = [x, y]
+      actual = cursor_position
+      if actual != expected
+        raise MatchError, "expected cursor to be at #{expected.inspect} but was at #{actual.inspect}\nEntire screen:\n#{to_s}"
+      end
+    end
+
+    METHODS = public_instance_methods
+  end
+end

data/lib/ttytest/terminal.rb

@@ -0,0 +1,40 @@
+require 'forwardable'
+require 'ttytest/matchers'
+require 'ttytest/capture'
+
+module TTYtest
+  class Terminal
+    extend Forwardable
+
+    def initialize(driver_terminal, max_wait_time: nil)
+      @driver_terminal = driver_terminal
+      @max_wait_time = max_wait_time
+    end
+
+    def max_wait_time
+      @max_wait_time || TTYtest.default_max_wait_time
+    end
+
+    def_delegators :@driver_terminal, :send_keys, :send_raw, :capture
+    def_delegators :capture, :rows, :row, :cursor_position
+
+    def synchronize(seconds=max_wait_time)
+      start_time = Time.now
+      begin
+        yield
+      rescue MatchError => e
+        raise e if (Time.now - start_time) >= seconds
+        sleep 0.05
+        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/driver.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'securerandom'
+
+require 'ttytest/terminal'
+require 'ttytest/tmux/session'
+
+module TTYtest
+  module Tmux
+    class Driver
+      COMMAND = 'tmux'
+      SOCKET_NAME = 'ttytest'
+      REQUIRED_TMUX_VERSION = '1.8'
+
+      class TmuxError < StandardError; end
+
+      def initialize(debug: false, command: COMMAND, socket_name: SOCKET_NAME)
+        @debug = debug
+        @tmux_cmd = command
+        @socket_name = socket_name
+      end
+
+      def new_terminal(cmd, width: 80, height: 24)
+        session_name = "ttytest-#{SecureRandom.uuid}"
+        tmux(*%W[new-session -s #{session_name} -d -x #{width} -y #{height} #{cmd}])
+        session = Session.new(self, session_name)
+        Terminal.new(session)
+      end
+
+      def tmux(*args)
+        ensure_available
+        puts "tmux(#{args.inspect[1...-1]})" if debug?
+
+        stdout, stderr, status = Open3.capture3(@tmux_cmd, '-L', SOCKET_NAME, *args)
+        raise TmuxError, "tmux(#{args.inspect[1...-1]}) failed\n#{stderr}" unless status.success?
+        stdout
+      end
+
+      def available?
+        @available ||= (Gem::Version.new(tmux_version) >= Gem::Version.new(REQUIRED_TMUX_VERSION))
+      end
+
+      def debug?
+        @debug
+      end
+
+      private
+
+      def ensure_available
+        if !available?
+          if !tmux_version
+            raise TmuxError, "tmux doesn't seem to be unstalled" unless available?
+          else
+            raise TmuxError, "tmux version #{tmux_version} does not meet requirement >= #{REQUIRED_TMUX_VERSION}" unless available?
+          end
+        end
+      end
+
+      def tmux_version
+        @tmux_version ||= `#{@tmux_cmd} -V`[/tmux (\d+.\d+)/, 1]
+      rescue Errno::ENOENT
+        nil
+      end
+    end
+  end
+end

data/lib/ttytest/tmux/session.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module TTYtest
+  module Tmux
+    class Session
+      attr_reader :driver, :name
+
+      def initialize(driver, name)
+        @driver = driver
+        @name = name
+
+        ObjectSpace.define_finalizer(self, self.class.finalize(driver, name))
+      end
+
+      def self.finalize(driver, name)
+        proc { driver.tmux(*%W[kill-session -t #{name}]) }
+      end
+
+      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)
+      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
+  end
+end

data/lib/ttytest/version.rb

@@ -0,0 +1,3 @@
+module TTYtest
+  VERSION = '0.1.0'
+end

data/ttytest.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ttytest/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ttytest"
+  spec.version       = TTYtest::VERSION
+  spec.authors       = ["John Hawthorn"]
+  spec.email         = ["john.hawthorn@gmail.com"]
+
+  spec.summary       = %q{TTYtest is an integration test framework for interactive tty applications}
+  spec.description   = %q{TTYtest allows running applications inside of a terminal emulator (like tmux) and making assertions on the output.}
+  spec.homepage      = "https://github.com/jhawthorn/ttytest"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: ttytest
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John Hawthorn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-28 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: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: TTYtest allows running applications inside of a terminal emulator (like
+  tmux) and making assertions on the output.
+email:
+- john.hawthorn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/ttytest.rb
+- lib/ttytest/capture.rb
+- lib/ttytest/dummy.rb
+- lib/ttytest/matchers.rb
+- lib/ttytest/terminal.rb
+- lib/ttytest/tmux/driver.rb
+- lib/ttytest/tmux/session.rb
+- lib/ttytest/version.rb
+- ttytest.gemspec
+homepage: https://github.com/jhawthorn/ttytest
+licenses:
+- MIT
+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.5.2
+signing_key: 
+specification_version: 4
+summary: TTYtest is an integration test framework for interactive tty applications
+test_files: []