GithubHelp home page GithubHelp logo

greenletters's Introduction

Greenletters README

Synopsis

See introductory blog post HERE.

require 'greenletters'

adv = Greenletters::Process.new("adventure", :transcript => $stdout)

# Install a handler which may be triggered at any time
adv.on(:output, /welcome to adventure/i) do |process, match_data|
  adv << "no\n"
end

puts "Starting adventure..."
adv.start!

# Wait for the specified pattern before proceeding
adv.wait_for(:output, /you are standing at the end of a road/i)
adv << "east\n"
adv.wait_for(:output, /inside a building/i)
adv << "quit\n"
adv.wait_for(:output, /really want to quit/i)
adv << "yes\n"
adv.wait_for(:exit)
puts "Adventure has exited."

Or, in Cucumber format:

Given process activity is logged to "greenletters.log"
Given a process "adventure" from command "adventure"
Given I reply "no" to output "Would you like instructions?" from process "adventure"
Given I reply "yes" to output "Do you really want to quit" from process "adventure"
When I execute the process "adventure"
Then I should see the following output from process "adventure":
"""
You are standing at the end of a road before a small brick building.
Around you is a forest.  A small stream flows out of the building and
down a gully.
"""
When I enter "east" into process "adventure"
Then I should see the following output from process "adventure":
"""
You are inside a building, a well house for a large spring.
"""

What

Greenletters is a console interaction automation library similar to GNU Expect. You can use it to script interactions with command-line programs.

Why

Because Ruby’s built-in expect.rb is pretty underpowered and I wanted to drive command-line applications from Ruby, not TCL.

Who

Greenletters is by Avdi Grimm.

Where

http://github.com/avdi/greenletters

How

Greenletters uses the pty.rb library under the covers to create a UNIX pseudoterminal under Ruby’s control. Of course, this means that it is MacOSX/Linux/*NIX-only; Windows users need not apply.

The advantage of using a PTY is that any output - including output written to the console instead of STDOUT/STDERR - will be captured by Greenletters.

Cucumber

To use the Cucumber steps in your own feature files, put the following in your env.rb:

require 'greenletters'
require 'greenletters/cucumber_steps'

LICENSE

(The MIT License)

Copyright (c) 2010 Avdi Grimm

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.

greenletters's People

Contributors

adamlamar avatar grosser avatar nicoder avatar padgett avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

greenletters's Issues

Newline character not triggering input Ubuntu

I'm using Ruby 2.0.0 and trying to automate password protecting a zip file using the zip command. It asks for a password and then the verification, but sending '\n' isn't triggering the next step. It works on a mac with the same ruby version.

zip = Greenletters::Process.new("zip -e #{zipfile_name} #{filename}", :transcript => $stdout)
zip.start!

zip.wait_for(:output, /Enter password:/i)
zip << "#{password}\n"
zip.wait_for(:output, /Verify password:/i)
zip << "#{password}\n"

The error is:

<path>/vendor/bundle/ruby/2.0.0/gems/greenletters-0.3.0/lib/greenletters.rb:648:in `process_interruption': Interrupted (timeout) while waiting for output matching /Verify password:/. (Greenletters::SystemError)

Any suggestions?

Support for removal of terminal colour markup from output.

Colourised terminal output prevents correct matching.

I've fixed this in greenletters.rb by modifying the beginning of OutputTrigger#match_one. This should be patched and the same change made to OutputTrigger#match_multiple also.

    def match_one(process)
        #scanner = process.output_buffer

        # Patched to strip term colour output from process stdout.
        # Author:: N David Brown
        scanner = StringScanner.new(process.output_buffer.string.gsub(/(\e\[([\d;]+)m)+/,''))

ExitTrigger error on ruby 1.8.6

Platform: Mandriva 2008.0
Ruby version: ruby 1.8.6 (2007-03-13 patchlevel 0) [i586-linux-gnu]

The following code:
#!/usr/bin/ruby
require 'rubygems'
require 'greenletters'

target = Greenletters::Process.new("echo Hello, World!", :transcript => $stdout)
target.on(:exit) do |process|
    puts "end"
end

puts "Start test 1"

target.start!

target.wait_for(:output, /World/)

puts "End"

produces error:

/usr/lib/ruby/gems/1.8/gems/greenletters-0.1.0/lib/greenletters.rb:245:in `call': undefined method `exitstatus' for nil:NilClass (NoMethodError)
        from /usr/lib/ruby/gems/1.8/gems/greenletters-0.1.0/lib/greenletters.rb:549:in `check_trigger'
        from /usr/lib/ruby/gems/1.8/gems/greenletters-0.1.0/lib/greenletters.rb:635:in `catchup_trigger!'
        from /usr/lib/ruby/gems/1.8/gems/greenletters-0.1.0/lib/greenletters.rb:339:in `add_nonblocking_trigger'
        from /usr/lib/ruby/gems/1.8/gems/greenletters-0.1.0/lib/greenletters.rb:324:in `on'
        from ./greenbug.rb:6

Is this ruby version supported?

Thank you
Andrea Galimberti

:"default" vs "default"

I believe there's a typo in the timeout cucumber step definition, namely that :"default" is used whereas elsewhere "default" is used.

This causes a default process to not be found when specifying a timeout for it.

The two possible fixes are:

  1. Replace :"default" with "default"
  2. Replace all references to default with the symbol :default.

I chose the latter when rebuilding the gem locally, though also confirmed the former fixed the issue.

Misspelling

You have a step containing succesfully. This should be successfully, note the extra 's'.

Unable to control time_to_live using `wait_for`

In certain cases, time_to_live could be high, but there is no way to control this with wait_for. You can control it at instantiation, using timeout: xx, but for some applications you may only want to control it for a single wait.

process_error() (NotImplementedError)

I am on Mac OS X 10.8 using ruby 1.9.3p194 and greenletters gem version 0.2.0.

When executing the following relevant code..

    cmd = "avidemux2_cli --rebuild-index --load \"#{ifile}\" --output-format MP4 --save \"#{ofile}\" --quit"  
    # set up process    
    mux = Greenletters::Process.new(cmd)
    # handle safe mode question    
    mux.on(:output, /do you want to use that mode/i) do |process, match_data|
      mux << "n\n"
    end
    mux.start!  
    mux.wait_for(:exit)
    puts "ok" if $? == 0

I get an exception

greenletters-0.2.0/lib/greenletters.rb:525:in `process_error': process_error() (NotImplementedError)
    from /Users/Tim/.rvm/gems/ruby-1.9.3-p194@global/gems/greenletters-0.2.0/lib/greenletters.rb:471:in `block (2 levels) in process_events'
    from /Users/Tim/.rvm/gems/ruby-1.9.3-p194@global/gems/greenletters-0.2.0/lib/greenletters.rb:471:in `each'
    from /Users/Tim/.rvm/gems/ruby-1.9.3-p194@global/gems/greenletters-0.2.0/lib/greenletters.rb:471:in `block in process_events'
    from /Users/Tim/.rvm/gems/ruby-1.9.3-p194@global/gems/greenletters-0.2.0/lib/greenletters.rb:605:in `block in handle_child_exit'
    from /Users/Tim/.rvm/gems/ruby-1.9.3-p194@global/gems/greenletters-0.2.0/lib/greenletters.rb:614:in `handle_eio'
    from /Users/Tim/.rvm/gems/ruby-1.9.3-p194@global/gems/greenletters-0.2.0/lib/greenletters.rb:604:in `handle_child_exit'
    from /Users/Tim/.rvm/gems/ruby-1.9.3-p194@global/gems/greenletters-0.2.0/lib/greenletters.rb:456:in `process_events'
    from /Users/Tim/.rvm/gems/ruby-1.9.3-p194@global/gems/greenletters-0.2.0/lib/greenletters.rb:337:in `wait_for'
    from /Users/Tim/bin/muxtest.rb:82:in `remux'

Any idea what I'm doing wrong here?

Also, will my check of $? return the exit status of the child process or is there some other way I should check for successful execution?

Cheers,
Tim

Parse Buffer?

A question more than an issue...

I am interacting with a shell a la: @adv = Greenletters::Process.new("/bin/sh",:transcript => $stdout)

I want to parse what is returned from the shell in order to make decisions about which command to send next. I can see what is returned in $stdout. Ok. If I send the transcript elsewhere - like to @transcript, I get peculiar behavior related to IO issues that are a little above my comfort zone.

Can you describe a way of accessing / parsing what is returned after I send a @adv << command + "\n" ?

Thanks,

M

Trying to automate ssh

Hey,

So code:

require 'greenletters'

adv = Greenletters::Process.new("ssh [email protected]", :transcript => $stdout)

Install a handler which may be triggered at any time

adv.on(:output, /password/i) do |process, match_data|
adv << "mypassword\n"
end

puts "Starting adventure..."
adv.start!

Wait for the specified pattern before proceeding

adv.wait_for(:output, /Last /i)
adv << "touch afile\n"

adv.wait_for(:output, /inside a building/i)

adv << "quit\n"

adv.wait_for(:output, /really want to quit/i)

adv << "yes\n"

adv.wait_for(:exit)

puts "Adventure has exited."

command line output:

ruby cc.rb
/home/jumpingcloud/.rvm/gems/ruby-1.9.3-p194/gems/greenletters-0.1.0/lib/greenletters.rb:275: Use RbConfig instead of obsolete and deprecated Config.
Starting adventure...
[email protected]'s password: /home/jumpingcloud/.rvm/gems/ruby-1.9.3-p194/gems/greenletters-0.1.0/lib/greenletters.rb:131:in block in initialize': wrong number of arguments (2 for 0) (ArgumentError) from /home/jumpingcloud/.rvm/gems/ruby-1.9.3-p194/gems/greenletters-0.1.0/lib/greenletters.rb:167:incall'
from /home/jumpingcloud/.rvm/gems/ruby-1.9.3-p194/gems/greenletters-0.1.0/lib/greenletters.rb:167:in match_one' from /home/jumpingcloud/.rvm/gems/ruby-1.9.3-p194/gems/greenletters-0.1.0/lib/greenletters.rb:158:incall'
from /home/jumpingcloud/.rvm/gems/ruby-1.9.3-p194/gems/greenletters-0.1.0/lib/greenletters.rb:549:in check_trigger' from /home/jumpingcloud/.rvm/gems/ruby-1.9.3-p194/gems/greenletters-0.1.0/lib/greenletters.rb:540:inblock in handle_triggers'
from /home/jumpingcloud/.rvm/gems/ruby-1.9.3-p194/gems/greenletters-0.1.0/lib/greenletters.rb:538:in each' from /home/jumpingcloud/.rvm/gems/ruby-1.9.3-p194/gems/greenletters-0.1.0/lib/greenletters.rb:538:inhandle_triggers'
from /home/jumpingcloud/.rvm/gems/ruby-1.9.3-p194/gems/greenletters-0.1.0/lib/greenletters.rb:478:in process_output' from /home/jumpingcloud/.rvm/gems/ruby-1.9.3-p194/gems/greenletters-0.1.0/lib/greenletters.rb:455:inblock (2 levels) in process_events'
from /home/jumpingcloud/.rvm/gems/ruby-1.9.3-p194/gems/greenletters-0.1.0/lib/greenletters.rb:455:in each' from /home/jumpingcloud/.rvm/gems/ruby-1.9.3-p194/gems/greenletters-0.1.0/lib/greenletters.rb:455:inblock in process_events'
from /home/jumpingcloud/.rvm/gems/ruby-1.9.3-p194/gems/greenletters-0.1.0/lib/greenletters.rb:588:in block in handle_child_exit' from /home/jumpingcloud/.rvm/gems/ruby-1.9.3-p194/gems/greenletters-0.1.0/lib/greenletters.rb:597:inhandle_eio'
from /home/jumpingcloud/.rvm/gems/ruby-1.9.3-p194/gems/greenletters-0.1.0/lib/greenletters.rb:587:in handle_child_exit' from /home/jumpingcloud/.rvm/gems/ruby-1.9.3-p194/gems/greenletters-0.1.0/lib/greenletters.rb:440:inprocess_events'
from /home/jumpingcloud/.rvm/gems/ruby-1.9.3-p194/gems/greenletters-0.1.0/lib/greenletters.rb:330:in wait_for' from cc.rb:14:in

'
[workspace]$ ruby --version
ruby 1.9.3p194 (2012-04-20 revision 35410) [x86_64-linux]

It's getting in but not touching that file.
What am I doing wrong?

Thanks,
Chris

PTY is limited to 80 characters width.

Is there any way to update this? or is this a limitation of the ruby library? I attempted to use .kill! with SIGWINCH to force it to update to my terminal width, but unsurprisingly that didn't work. I'm not experienced with PTYs at all, so this is all a bit of a mystery to me.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.