expect-behaviors 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c8e49f4c01b13e382732ef998726de1eff8b6c4f
+  data.tar.gz: b3c03d88f5651851aebe59a9b9a0ce67726494d3
+SHA512:
+  metadata.gz: 4583cb4d126badafc6070e5f78d556503d559a4e53d5b6fc3803f32d1d3f9bb8e66903aebee4210abf502a90f006730413d4502b967e72a3990d040f892c97a8
+  data.tar.gz: d86ad237e6d44d7424da9d191d503e57e652970623561e4d236770478923faca0a37e32c8a6a96e6e579b5009ff40715774c1e43021e3b1c4ab158cedca7b373

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.1

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+rvm:
+- 2.2.0
+- 2.0.0
+install:
+- bundle install
+script:
+- uname -s
+- rake test
+addons:
+  code_climate:
+    repo_token: da682865771c5c7d9c6f59c442013c80989a6f19a25a960cecf46aca0f8d0f0d
+deploy:
+  provider: rubygems
+  api_key:
+    secure: YZdbnjpyIZXeoQVizdAWU1MI5zLKsDmHjIMFuAa/sKptsZxqBA6amFGF7uUdmvHvRXlCxN/b3WliXuUJhvsRdzMU28a2/GEfjiCuEfXJm5vmoGH122UxgTBVYw8j9FsxteD09xTZE0eg+XP08CAfBKcgbbAfuhdfVPtW+pvnBx8=
+  gem: expect-behaviors
+  on:
+    tags: true
+    repo: francisluong/expect-behaviors

data/Gemfile

@@ -0,0 +1,21 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+
+gem 'net-ssh', '~> 2.9', '>= 2.9.2'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "codeclimate-test-reporter", '~> 0', group: :test, require: nil
+  gem "mocha", '~> 1.1', '>= 1.1.0'
+  gem "pry", "~>0.10.1"
+  gem "shoulda", '~> 3.5', '>= 3.5.0'
+  gem "shoulda-context", '~> 1.2', '>= 1.2.1'
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", '~> 2.0', '>= 2.0.0'
+  gem 'test-unit', '~> 2.5', '>= 2.5.5'
+end

data/Gemfile.lock

@@ -0,0 +1,99 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.2.0)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.3.6)
+    builder (3.2.2)
+    codeclimate-test-reporter (0.4.7)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coderay (1.1.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    docile (1.1.5)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.9.1)
+    github_api (0.12.2)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.3)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.3)
+      oauth2
+    hashie (3.3.2)
+    highline (1.6.21)
+    i18n (0.7.0)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.2)
+    jwt (1.2.0)
+    metaclass (0.0.4)
+    method_source (0.8.2)
+    mini_portile (0.6.2)
+    minitest (5.5.1)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    net-ssh (2.9.2)
+    nokogiri (1.6.5)
+      mini_portile (~> 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.6.0)
+    rake (10.4.2)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.1)
+    shoulda-matchers (2.7.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.9.2)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.9.0)
+    simplecov-html (0.9.0)
+    slop (3.6.0)
+    test-unit (2.5.5)
+    thread_safe (0.3.4)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  codeclimate-test-reporter (~> 0)
+  jeweler (~> 2.0, >= 2.0.0)
+  mocha (~> 1.1, >= 1.1.0)
+  net-ssh (~> 2.9, >= 2.9.2)
+  pry (~> 0.10.1)
+  rdoc (~> 3.12)
+  shoulda (~> 3.5, >= 3.5.0)
+  shoulda-context (~> 1.2, >= 1.2.1)
+  test-unit (~> 2.5, >= 2.5.5)

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Francis Luong (Franco)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,16 @@
+# expect-behaviors
+Ruby Mixin to add Expect Behaviors to SSH/Serial/Telnet controllers
+
+[![Build Status](https://travis-ci.org/francisluong/expect-behaviors.svg?branch=master)](https://travis-ci.org/francisluong/expect-behaviors)
+[![Code Climate](https://codeclimate.com/github/francisluong/expect-behaviors/badges/gpa.svg)](https://codeclimate.com/github/francisluong/expect-behaviors)
+[![Test Coverage](https://codeclimate.com/github/francisluong/expect-behaviors/badges/coverage.svg)](https://codeclimate.com/github/francisluong/expect-behaviors)
+
+# Contributing to expect-behaviors
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

data/Rakefile

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+require 'rake'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+task :default => :test
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |raketask| load raketask }

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/examples/example_ssh_localhost.rb

@@ -0,0 +1,36 @@
+require 'expect/ssh'
+
+hostname = 'localhost'
+@ssh = Expect::SSH.new(hostname, ENV['USER'], ignore_known_hosts: true)
+@ssh.start
+prompt = /.*\$/
+@ssh.expect { when_matching(prompt) { @exp_match } } # first prompt
+
+def strip_command_and_prompt(expect_match)
+  expect_match.buffer.lines[1..-2].join.strip
+end
+
+@ssh.send_data('date')
+result = @ssh.expect do
+  when_matching(prompt) {@exp_match}
+end
+date = strip_command_and_prompt(result)
+
+@ssh.send_data('uname -a')
+result = @ssh.expect do
+  when_matching(prompt) {@exp_match}
+end
+uname = strip_command_and_prompt(result)
+
+puts "[date=#{date}]"
+puts "[uname=#{uname}]"
+
+print "[TEST timeout action: "
+@ssh.send_data('sleep 3')
+result = @ssh.expect do
+  when_matching(prompt) {"FAILED - got prompt"}
+  when_timeout(1)       {"PASSED"}
+end
+puts result + ']'
+
+@ssh.stop

data/expect-behaviors.gemspec

@@ -0,0 +1,95 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: expect-behaviors 0.1.1 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "expect-behaviors"
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Francis Luong (Franco)"]
+  s.date = "2016-03-14"
+  s.description = "Ruby Mixin to add Expect Behaviors to SSH/Serial/Telnet controllers"
+  s.email = "me@francisluong.com"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".ruby-version",
+    ".travis.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "examples/example_ssh_localhost.rb",
+    "expect-behaviors.gemspec",
+    "lib/expect/behavior.rb",
+    "lib/expect/match.rb",
+    "lib/expect/ssh.rb",
+    "lib/expect/timeout_error.rb",
+    "tasks/doc.rake",
+    "tasks/jeweler.rake",
+    "tasks/test.rake",
+    "test/acceptance/sshd/erb/ssh_config.erb",
+    "test/acceptance/sshd/erb/sshd_config.erb",
+    "test/acceptance/test_expect_behaviors_slow_tests.rb",
+    "test/acceptance/test_expect_ssh.rb",
+    "test/class_including_expect_behavior.rb",
+    "test/helper.rb",
+    "test/sshd.rb",
+    "test/unit/expect/test_expect_behaviors.rb",
+    "test/unit/expect/test_expect_match.rb",
+    "test/unit/expect/test_includer_class.rb"
+  ]
+  s.homepage = "http://github.com/francisluong/expect-behaviors"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.6"
+  s.summary = "Ruby Mixin to add Expect Behaviors"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<net-ssh>, [">= 2.9.2", "~> 2.9"])
+      s.add_development_dependency(%q<codeclimate-test-reporter>, ["~> 0"])
+      s.add_development_dependency(%q<mocha>, [">= 1.1.0", "~> 1.1"])
+      s.add_development_dependency(%q<pry>, ["~> 0.10.1"])
+      s.add_development_dependency(%q<shoulda>, [">= 3.5.0", "~> 3.5"])
+      s.add_development_dependency(%q<shoulda-context>, [">= 1.2.1", "~> 1.2"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 2.0.0", "~> 2.0"])
+      s.add_development_dependency(%q<test-unit>, [">= 2.5.5", "~> 2.5"])
+    else
+      s.add_dependency(%q<net-ssh>, [">= 2.9.2", "~> 2.9"])
+      s.add_dependency(%q<codeclimate-test-reporter>, ["~> 0"])
+      s.add_dependency(%q<mocha>, [">= 1.1.0", "~> 1.1"])
+      s.add_dependency(%q<pry>, ["~> 0.10.1"])
+      s.add_dependency(%q<shoulda>, [">= 3.5.0", "~> 3.5"])
+      s.add_dependency(%q<shoulda-context>, [">= 1.2.1", "~> 1.2"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, [">= 2.0.0", "~> 2.0"])
+      s.add_dependency(%q<test-unit>, [">= 2.5.5", "~> 2.5"])
+    end
+  else
+    s.add_dependency(%q<net-ssh>, [">= 2.9.2", "~> 2.9"])
+    s.add_dependency(%q<codeclimate-test-reporter>, ["~> 0"])
+    s.add_dependency(%q<mocha>, [">= 1.1.0", "~> 1.1"])
+    s.add_dependency(%q<pry>, ["~> 0.10.1"])
+    s.add_dependency(%q<shoulda>, [">= 3.5.0", "~> 3.5"])
+    s.add_dependency(%q<shoulda-context>, [">= 1.2.1", "~> 1.2"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, [">= 2.0.0", "~> 2.0"])
+    s.add_dependency(%q<test-unit>, [">= 2.5.5", "~> 2.5"])
+  end
+end
+

data/lib/expect/behavior.rb

@@ -0,0 +1,134 @@
+require 'expect/match'
+require 'expect/timeout_error'
+
+module Expect
+
+  ##
+  # Add Expect behaviors to Accessor classes that have an input buffer: e.g. telnet/ssh
+  # :Required methods to be created by the class mixing Expect::Behaviors :
+  #   #exp_process - should do one iteration of handle input and append buffer
+  #   #exp_buffer - provide the current buffer contents and empty it
+  module Behavior
+
+    attr_reader :exp_match
+    attr_accessor :exp_timeout_sec
+    attr_accessor :exp_sleep_interval_sec
+
+    EXP_TIMEOUT_SEC_DEFAULT = 10
+    EXP_SLEEP_INTERVAL_SEC_DEFAULT = 0.1
+
+    def expect(&block)
+      #pre-action
+      initialize_expect if @__exp_buffer.nil?
+      @exp_match_registry = {}
+      #register callbacks
+      instance_eval(&block)
+      #action
+      result = execute_expect_loop
+      #post-action
+      @exp_timeout_sec_ephemeral = @exp_timeout_sec
+      result
+    end
+
+
+    ##################
+    private
+    ##################
+
+    def clear_expect_buffer
+      @__exp_buffer = ''
+    end
+
+    def current_time
+      Time.now.to_f
+    end
+
+    def exp_registered_matches
+      match_object = nil
+      unless @__exp_buffer.nil?
+        @exp_match_registry.each_pair do |expr, block|
+          expr = expr.to_s unless expr.is_a?(Regexp)
+          if @__exp_buffer.match(expr)
+            result = block.call
+            match_object = result.eql?('exp_continue') ? nil : Expect::Match.new(expr, @__exp_full_buffer)
+            break # don't try to match more than one
+          end
+        end
+      end
+      @exp_match = match_object
+      @exp_match
+    end
+
+    ##
+    # reset timeout and continue expect loop
+    def expect_continue
+      init_timeout
+      @__exp_buffer = '' # avoid matching the same text twice
+      "exp_continue"
+    end
+    alias_method :exp_continue, :expect_continue
+    alias_method :reset_timeout, :expect_continue
+
+    def execute_expect_loop
+      init_timeout
+      @exp_match = nil
+      result = nil
+      @__exp_buffer = ''
+      @__exp_full_buffer = ''
+      while result.nil?
+        if timeout?
+          result = @exp_timeout_block.nil? ? timeout_action_default : @exp_timeout_block.call
+        else
+          raise unless respond_to?(:exp_buffer)
+          raise unless respond_to?(:exp_process)
+          # call process/buffer and then check for match
+          exp_process
+          newbuffertext = exp_buffer.to_s
+          @__exp_buffer << newbuffertext
+          @__exp_full_buffer << newbuffertext
+          if exp_registered_matches
+            result = @exp_match
+          else
+            sleep(@exp_sleep_interval_sec)
+          end
+        end
+      end
+      result
+    end
+
+    def initialize_expect
+      @exp_match_registry ||= {}
+      @exp_match = nil
+      @exp_sleep_interval_sec ||= EXP_SLEEP_INTERVAL_SEC_DEFAULT
+      @exp_timeout_sec ||= EXP_TIMEOUT_SEC_DEFAULT
+      @exp_timeout_sec_ephemeral = @exp_timeout_sec
+      @exp_timeout_block ||= nil
+      @__exp_buffer ||= ''
+      @__exp_full_buffer ||= ''
+    end
+
+    def init_timeout
+      @start_time = current_time
+    end
+
+    def timeout?
+      (current_time - @start_time) > @exp_timeout_sec_ephemeral
+    end
+
+    def timeout_action_default
+      raise(TimeoutError, "Expect Timeout [start_time=#{@start_time}] [time=#{current_time}]")
+    end
+
+    def when_matching(expression, &block)
+      @exp_match_registry[expression] = block
+    end
+    alias_method :when_match, :when_matching
+
+    def when_timeout(timeout_sec = nil, &block)
+      @exp_timeout_sec_ephemeral = timeout_sec unless timeout_sec.nil?
+      @exp_timeout_block = block
+    end
+
+
+  end
+end