te3270 0.6.0

data/spec/lib/te3270/emulators/x3270_spec.rb

@@ -0,0 +1,179 @@
+require 'spec_helper'
+
+describe TE3270::Emulators::X3270 do
+
+  let(:x3270) { TE3270::Emulators::X3270.new }
+
+  before(:each) do
+    @x3270_io = double('x3270_io')
+    Open3.stub(:popen2e).and_return [@x3270_io,@x3270_io,nil]
+    x3270.instance_variable_set(:@executable_command, "the_command")
+    x3270.instance_variable_set(:@host, "the_host")
+    @x3270_io.stub(:print)
+    @x3270_io.stub(:flush)
+    @x3270_io.stub(:gets).and_return('goo','ok')
+    end
+
+  describe "global behaviors" do
+    it 'should open pipe to x3270' do
+      Open3.should_receive(:popen2e).and_return(x3270_system)
+      x3270.connect
+    end
+   
+    it 'should take the timeout value from a block' do
+      x3270.should_receive(:executable_command=).with('path to the x3270 executable')
+      x3270.connect do |platform|
+        platform.executable_command = 'path to the x3270 executable'
+      end
+    end
+
+    it 'should take the host to connect to from a block' do
+      x3270.should_receive(:host=).with('name of host to connect to')
+      x3270.connect do |platform|
+        platform.host = 'name of host to connect to'
+      end
+    end
+
+    it 'should take the max timeout value from a block' do
+      x3270.should_receive(:max_wait_time=).with(42)
+      x3270.connect do |platform|
+        platform.max_wait_time = 42
+      end
+    end
+
+    it 'should display an error when the path to the executable is not set' do
+      x3270.instance_variable_set(:@executable_command, nil)
+      expect { x3270.connect }.to raise_error('The executable command must be set in a block when calling connect with the X3270 emulator.')
+    end
+
+    it 'should display an error when the host is not set' do
+      x3270.instance_variable_set(:@host, nil)
+      expect { x3270.connect }.to raise_error('The host must be set in a block when calling connect with the X3270 emulator.')
+    end
+
+    it 'should default to max_wait_time being 10 when not provided' do
+      #x3270.should_receive(:max_wait_time=).with(10)
+      x3270.connect
+      x3270.instance_variable_get(:@max_wait_time).should eq(10)
+    end
+
+    it 'should display an error when cannot popen supplied x3270 program' do
+      Open3.stub(:popen2e).and_raise('darn it, popen failed')
+      expect { x3270.connect }.to raise_error( "Could not start x3270 'the_command': darn it, popen failed")
+    end
+
+    it 'should close input and output on pipe when disconnect called' do
+      io = double('IO')
+      Open3.stub(:popen2e).and_return([io,io,io])
+      io.should_receive(:close).twice
+      x3270.connect
+      x3270.disconnect
+    end
+  end
+
+  describe "interacting with text fields" do
+    it 'should get the value from the screen' do
+      @x3270_io.should_receive(:print).with("ascii(0,1,7)\n")
+      @x3270_io.stub(:gets).and_return('data: blah','goo','ok')
+      #@x3270_io.stub(:gets).and_return('ok')
+      x3270.connect
+      x3270.get_string(1, 2, 7).should == 'blah'
+    end
+
+    it 'should put a value on the screen' do
+      @x3270_io.should_receive(:print).with("MoveCursor(14,55)\n")
+      @x3270_io.should_receive(:print).with('string "blah"'+"\n")
+      x3270.connect
+      x3270.put_string('blah', 15, 56)
+    end
+
+    it 'should put proper escape value on the screen' do
+      @x3270_io.should_receive(:print).with("MoveCursor(14,55)\n")
+      @x3270_io.should_receive(:print).with('string "ab\"cd"'+"\n")
+      x3270.connect
+      x3270.put_string('ab"cd', 15, 56)
+    end
+  end
+
+  describe "interacting with the screen" do
+    it 'should know how to send function keys' do
+      @x3270_io.should_receive(:print).with("Home\n")
+      @x3270_io.should_receive(:print).with("wait(output)\n")
+      x3270.connect
+      x3270.send_keys(TE3270.Home)
+    end
+
+    it 'should know how to send program function keys ' do
+      @x3270_io.should_receive(:print).with("Pf(13)\n")
+      @x3270_io.should_receive(:print).with("wait(output)\n")
+      x3270.connect
+      x3270.send_keys(TE3270.Pf13)
+    end
+
+    it 'should know how to send program attention keys ' do
+      @x3270_io.should_receive(:print).with("Pa(2)\n")
+      @x3270_io.should_receive(:print).with("wait(output)\n")
+      x3270.connect
+      x3270.send_keys(TE3270.Pa2)
+    end
+
+    it 'should wait for a string to appear' do
+      @x3270_io.should_receive(:print).with("ascii(2,9,6)\n")
+      @x3270_io.should_receive(:gets).and_return('data: string','goo','ok')
+      x3270.should_not_receive(:sleep)
+      x3270.connect
+      x3270.wait_for_string('string', 3, 10)
+    end
+
+    it 'should timeout when wait for a string does not appear' do
+      @x3270_io.should_receive(:print).with("ascii(2,9,6)\n").exactly(20).times
+      @x3270_io.should_receive(:gets).and_return('data: stuff','goo','ok')
+      x3270.should_receive(:sleep).exactly(20).times
+      x3270.connect
+      x3270.wait_for_string('string', 3, 10)
+    end
+
+    it 'should find string after one sleep when waiting for a string to appear' do
+      @x3270_io.should_receive(:print).with("ascii(2,9,6)\n").twice
+      @x3270_io.should_receive(:gets).and_return('data: blah','goo','ok','data: string','goo','ok')
+      x3270.stub(:sleep).with(0.5).once
+      x3270.connect
+      x3270.wait_for_string('string', 3, 10)
+    end
+
+    it 'should wait for host' do
+      @x3270_io.should_receive(:print).with("Wait(10,Output)\n")
+      x3270.connect
+      x3270.wait_for_host(10)
+    end
+
+    it 'should wait until the cursor is at a position' do
+      @x3270_io.should_receive(:print).with("MoveCursor(5,8)\n")
+      x3270.connect
+      x3270.wait_until_cursor_at(6,9)
+    end
+
+    it 'should take screenshots' do
+      File.should_receive(:exists?).and_return(false)
+      File.should_not_receive(:delete)
+      @x3270_io.should_receive(:print).with("printtext(file,image.txt)\n")
+      x3270.connect
+      x3270.screenshot("image.txt")
+    end
+
+    it 'should delete existing file when taking screenshots' do
+      File.should_receive(:exists?).and_return(true)
+      File.should_receive(:delete)
+      @x3270_io.should_receive(:print).with("printtext(file,image.txt)\n")
+      x3270.connect
+      x3270.screenshot("image.txt")
+    end
+
+    it 'should get all text from screen' do
+      @x3270_io.should_receive(:print).with("ascii(0,0,1920)\n")
+      @x3270_io.should_receive(:gets).and_return('data: string','goo','ok')
+      x3270.connect
+      x3270.text.should == 'string'
+    end
+  end
+end

data/spec/lib/te3270/screen_factory_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+class ScreenFactoryScreen
+  include TE3270
+end
+
+class WorldSuper
+  attr_reader :super_called
+  def on(screen_class, &block)
+    @super_called = true
+  end
+end
+
+class World < WorldSuper
+  include TE3270::ScreenFactory
+end
+
+describe TE3270::ScreenFactory do
+
+  let(:world) { World.new }
+
+  it 'should create a new screen object' do
+    emulator = double('platform')
+    world.instance_variable_set('@emulator', emulator)
+    world.on(ScreenFactoryScreen).should be_instance_of ScreenFactoryScreen
+  end
+
+  it 'should create a new screen object and execute a block' do
+    emulator = double('platform')
+    world.instance_variable_set('@emulator', emulator)
+    world.on(ScreenFactoryScreen) do |page|
+      page.should be_instance_of ScreenFactoryScreen
+    end
+  end
+
+  it 'should raise an error when an @emulator instance variable does not exist' do
+    expect { world.on(ScreenFactoryScreen) }.to raise_error("@emulator instance variable must be available to use the ScreenFactory methods")
+  end
+
+  it 'should pass control to super if passed a class that does not include TE3270' do
+    class NoTE
+    end
+    emulator = double('platform')
+    world.instance_variable_set('@emulator', emulator)
+    world.on(NoTE)
+    world.super_called.should be true
+  end
+end

data/spec/lib/te3270/screen_populator_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+class ScreenPopulatorScreen
+  include TE3270
+
+  text_field(:editable, 1, 2, 10, true)
+  text_field(:read_only, 2, 3, 12, false)
+end
+
+describe TE3270::ScreenPopulator do
+
+  let(:platform) { double('platform') }
+  let(:screen_object) { ScreenPopulatorScreen.new platform }
+
+  it 'should set a value in a text field' do
+    platform.should_receive(:put_string).with('the_value', 1, 2)
+    screen_object.populate_screen_with editable: 'the_value'
+  end
+
+  it 'should not set a value when a text field is read only' do
+    platform.should_not_receive(:put_string)
+    screen_object.populate_screen_with read_only: 'the_value'
+  end
+
+  it 'should attempt to set all values from the provided Hash' do
+    platform.should_receive(:put_string).with('the_value', 1, 2)
+    platform.should_not_receive(:put_string).with('read_only', 2, 3)
+    screen_object.populate_screen_with(editable: 'the_value', read_only: 'read_only')
+  end
+end

data/spec/lib/te3270_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+class TEScreenObject
+  include TE3270
+
+  attr_reader :initialize_screen
+
+  def initialize_screen
+    @initialize_screen = true
+  end
+end
+
+describe TE3270 do
+  let(:platform) { double('platform') }
+  let(:screen_object) { TEScreenObject.new platform }
+
+  before(:each) do
+    screen_object.stub(:platform).and_return platform
+  end
+
+  describe "interacting with the platform" do
+    it 'should use the platform to connect to an emulator' do
+      platform.should_receive(:connect)
+      screen_object.connect
+    end
+
+    it 'should use the platform to disconnect from an emulator' do
+      platform.should_receive(:disconnect)
+      screen_object.disconnect
+    end
+
+    it 'should use the platform to send keys to the screen' do
+      platform.should_receive(:send_keys).with('<Clear>')
+      screen_object.send_keys(TE3270.Clear)
+    end
+
+    it 'should use the platform to wait for a string to appear on the screen' do
+      platform.should_receive(:wait_for_string).with('The String', 2, 4)
+      screen_object.wait_for_string('The String', 2, 4)
+    end
+
+    it 'should use the platform to wait for the host to be quiet' do
+      platform.should_receive(:wait_for_host).with(4)
+      screen_object.wait_for_host(4)
+    end
+
+    it 'should default to five seconds when waiting for the host' do
+      platform.should_receive(:wait_for_host).with(5)
+      screen_object.wait_for_host
+    end
+
+    it 'should use the platform to wait until the cursor at a specific position' do
+      platform.should_receive(:wait_until_cursor_at).with(10, 10)
+      screen_object.wait_until_cursor_at(10, 10)
+    end
+
+    it 'should use the platform to take a screenshot of the screen' do
+      platform.should_receive(:screenshot).with('image.png')
+      screen_object.screenshot('image.png')
+    end
+
+    it 'should use the platform to get the text for the entire screen' do
+      platform.should_receive(:text).and_return('123abc')
+      screen_object.text.should == '123abc'
+    end
+  end
+
+  describe "module functionality" do
+    it 'should know the function keys' do
+      TE3270.Clear.should == '<Clear>'
+      TE3270.Pf24.should == '<Pf24>'
+    end
+
+    it 'should call initialize_screen if it exists' do
+      screen_object.initialize_screen.should be true
+    end
+
+    it 'should create an emulator and connect to terminal' do
+      TE3270::Emulators::Extra.should_receive(:new).and_return(platform)
+      platform.should_receive(:connect)
+      TE3270.emulator_for :extra
+    end
+
+    if Gem.win_platform?
+      it 'should accept a block when creating an emulator' do
+        WIN32OLE.stub(:new).and_return extra_system
+        extra_sessions.should_receive(:Open).with('blah.edp').and_return(extra_session)
+        TE3270.emulator_for :extra do |emulator|
+          emulator.session_file = 'blah.edp'
+        end
+      end
+    end
+    
+    it 'should allow one to disconnect using the module' do
+      platform.should_receive(:disconnect)
+      TE3270.disconnect(platform)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,73 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'te3270'
+if Gem.win_platform?
+  require 'win32ole'
+  require 'win32/screenshot'
+end
+
+RSpec.configure do |config|
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :should
+  end
+end
+
+def extra_system
+  @extra_system ||= double('system')
+  @extra_system.stub(:Sessions).and_return extra_sessions
+  @extra_system.stub(:Version).and_return("0")
+  @extra_system
+end
+
+def extra_sessions
+  @extra_sessions ||= double('sessions')
+  @extra_sessions.stub(:Count).and_return 0
+  @extra_sessions.stub(:Open).and_return extra_session
+  @extra_sessions
+end
+
+def extra_session
+  @extra_session ||= double('session')
+  @extra_session.stub(:Screen).and_return extra_screen
+  @extra_session.stub(:WindowState=)
+  @extra_session.stub(:Visible=)
+  @extra_session
+end
+
+def extra_screen
+  @extra_screen ||= double('screen')
+  @extra_screen.stub(:SelectAll).and_return extra_area
+  @extra_screen
+end
+
+def extra_area
+  @extra_area ||= double('area')
+  @extra_area
+end
+
+def quick_system
+  @quick_system ||= double('quick_system')
+  @quick_system.stub(:ActiveSession).and_return quick_session
+  @quick_system.stub(:Visible=)
+  @quick_system
+end
+
+def quick_session
+  @quick_session ||= double('quick_session')
+  @quick_session.stub(:Screen).and_return quick_screen
+  @quick_session.stub(:Open)
+  @quick_session.stub(:Connect)
+  @quick_session.stub(:Server_Name=)
+  @quick_session.stub(:Connected).and_return true
+  @quick_session
+end
+
+def quick_screen
+  @quick_screen ||= double('screen')
+  @quick_screen
+end
+
+def x3270_system
+  @x3270_system ||= double('x3270_system')
+  @x3270_system
+end

data/te3270.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'te3270/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "te3270"
+  spec.version       = TE3270::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.authors       = ["Jeffrey S. Morgan", "Nithin C. Reddy", "Glenn W. Waters"]
+  spec.email         = ["jeff.morgan@leandog.com","nithinreddyc@gmail.com", "gwwaters@gmail.com"]
+  spec.description   = %q{Automates a 3270 Terminal Emulator}
+  spec.summary       = %q{Automates a 3270 Terminal Emulator}
+  spec.homepage      = "http://github.com/cheezy/te3270"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.extensions    = ["ext/mkrf_conf.rb"]
+
+  spec.add_dependency 'page_navigation', '>= 0.9'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end
+