te3270 0.6.0

data/lib/te3270/function_keys.rb

@@ -0,0 +1,78 @@
+
+module TE3270
+  #
+  # Creates methods that are mixed in with the +TE3270+ module that represent all of the
+  # function keys that can be send to the system.  These keys would typically be sent to
+  # the +send_keys_ method.
+  #
+  # @example Using a function key
+  #   on(MyScreen).send_keys TE3270.Enter
+  #
+  module FunctionKeys
+
+    KEYS = [
+        'Attn',
+        'BackSpace',
+        'BackTab',
+        'CapsLock',
+        'Clear',
+        'Down',
+        'Left',
+        'Left2',
+        'Right',
+        'Right2',
+        'CursorSelect',
+        'Up',
+        'Delete',
+        'Dup',
+        'Enter',
+        'EraseEOF',
+        'EraseInput',
+        'FieldMark',
+        'Home',
+        'Insert',
+        'BackTab',
+        'NewLIne',
+        'PenSel',
+        'Print',
+        'Reset',
+        'ShiftOn',
+        'SysReq',
+        'Tab',
+        'Pa1',
+        'Pa2',
+        'Pa3',
+        'Pf1',
+        'Pf2',
+        'Pf3',
+        'Pf4',
+        'Pf5',
+        'Pf6',
+        'Pf7',
+        'Pf8',
+        'Pf9',
+        'Pf10',
+        'Pf11',
+        'Pf12',
+        'Pf13',
+        'Pf14',
+        'Pf15',
+        'Pf16',
+        'Pf17',
+        'Pf18',
+        'Pf19',
+        'Pf20',
+        'Pf21',
+        'Pf22',
+        'Pf23',
+        'Pf24',
+    ]
+
+    KEYS.each do |key|
+      define_method(key) do
+        "<#{key}>"
+      end
+    end
+
+  end
+end

data/lib/te3270/screen_factory.rb

@@ -0,0 +1,50 @@
+require 'page_navigation'
+
+module TE3270
+  #
+  # Module to facilitate to creating of screen objects in step definitions.  You
+  # can make the methods below available to all of your step definitions by adding
+  # this module to World.
+  #
+  # @example Making the ScreenFactory available to your step definitions
+  #   World TE3270::ScreenFactory
+  #
+  # @example using a screen in a Scenario
+  #   on MyScreen do |screen|
+  #     screen.name = 'Cheezy'
+  #   end
+  #
+  # If you plan to use the +navigate_to+ method you will need to ensure
+  # you setup the possible routes ahead of time.  You must always have
+  # a default route in order for this to work.  Here is an example of
+  # how you define routes:
+  #
+  # @example Example routes defined in env.rb
+  #   TE3270::ScreenFactory.routes = {
+  #     :default => [[ScreenOne,:method1], [ScreenTwo,:method2], [ScreenThree,:method3]],
+  #     :another_route => [[ScreenOne,:method1, "arg1"], [ScreenTwo,:method2b], [ScreenThree,:method3]]
+  #   }
+  #
+  # Notice the first entry of :another_route is passing an argument
+  # to the method.
+  #
+  module ScreenFactory
+    include PageNavigation
+
+    #
+    # Create a screen object.  Also sets an instance variable +@current_screen
+    #
+    # @param [Class]  screen_class a class that has included the TE3270 module
+    # @param [block]  an optional block to be called
+    # @return [ScreenObject] the newly created screen object
+    #
+    def on(screen_class, &block)
+      return super(screen_class, &block) unless screen_class.ancestors.include? TE3270
+      raise '@emulator instance variable must be available to use the ScreenFactory methods' unless @emulator
+      @current_screen = screen_class.new @emulator
+      block.call @current_screen if block
+      @current_screen
+    end
+
+  end
+end

data/lib/te3270/screen_populator.rb

@@ -0,0 +1,33 @@
+
+module TE3270
+  module ScreenPopulator
+
+    #
+    # This method will populate all matched screen text fields from the
+    # Hash passed as an argument.  The way it find an element is by
+    # matching the Hash key to the name you provided when declaring
+    # the text field on your screen.
+    #
+    # @example
+    #   class ExampleScreen
+    #     include TE3270
+    #
+    #     text_field(:username, 1, 2, 20)
+    #   end
+    #
+    #   ...
+    #
+    #   @emulator = TE3270::emulator_for :quick3270
+    #   example_screen = ExampleScreen.new(@emulator)
+    #   example_screen.populate_screen_with :username => 'a name'
+    #
+    # @param [Hash] hsh the data to use to populate this screen.
+    #
+    def populate_screen_with(hsh)
+      hsh.each do |key, value|
+        self.send("#{key}=", value) if self.respond_to? "#{key}=".to_sym
+      end
+    end
+
+  end
+end

data/lib/te3270/version.rb

@@ -0,0 +1,4 @@
+module TE3270
+  VERSION = "0.6.0"
+end
+

data/spec/lib/te3270/accessors_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+class AccessorsTestScreen
+  include TE3270
+
+  text_field(:method_name, 1, 2, 10, true)
+  text_field(:read_only, 2, 3, 12, false)
+  text_field(:default_editable, 3, 4, 14)
+end
+
+describe TE3270::Accessors do
+
+  let(:platform) { double('platform') }
+  let(:screen_object) { AccessorsTestScreen.new platform }
+
+  before(:each) do
+    screen_object.stub(:platform).and_return platform
+  end
+
+  describe "text_field accessors" do
+
+    it 'should generate a method to retrieve the value' do
+      screen_object.should respond_to :method_name
+    end
+
+    it 'should generate a method to set the value' do
+      screen_object.should respond_to :method_name=
+    end
+
+    it 'should not generate a method to set the value if it is not editable' do
+      screen_object.should_not respond_to :read_only=
+    end
+
+    it 'should default to being editable when it is not specified' do
+      screen_object.should respond_to :default_editable=
+    end
+
+    it 'should use the platform to get the text value' do
+      platform.should_receive(:get_string).with(1, 2, 10).and_return('abc')
+      screen_object.method_name.should == 'abc'
+    end
+
+    it 'should use the platform to set the text value' do
+      platform.should_receive(:put_string).with('abc', 1, 2)
+      screen_object.method_name = 'abc'
+    end
+
+  end
+
+end

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

@@ -0,0 +1,186 @@
+if Gem.win_platform?
+
+  require 'spec_helper'
+
+  describe TE3270::Emulators::Extra do
+
+    let(:extra) { TE3270::Emulators::Extra.new }
+
+    before(:each) do
+      WIN32OLE.stub(:new).and_return extra_system
+      extra.instance_variable_set(:@session_file, 'the_file')
+      File.stub(:exists).and_return false
+    end
+
+
+    describe "global behaviors" do
+      it 'should start a new terminal' do
+        WIN32OLE.should_receive(:new).and_return(extra_system)
+        extra.connect
+      end
+
+      it 'should open a session' do
+        extra_sessions.should_receive(:Open).and_return(extra_session)
+        extra.connect
+      end
+
+      it 'should not display the splash screen if version is higher than 9' do
+        extra_system.should_receive(:Version).and_return("9.2")
+        extra_sessions.should_receive(:VisibleOnStartup=).with(true)
+        extra.connect
+      end
+
+      it 'should call a block allowing the session file to be set' do
+        extra_sessions.should_receive(:Open).with('blah.edp').and_return(extra_session)
+        extra.connect do |platform|
+          platform.session_file = 'blah.edp'
+        end
+      end
+
+      it 'should raise an error when the session file is not set' do
+        extra.instance_variable_set(:@session_file, nil)
+        expect { extra.connect }.to raise_error('The session file must be set in a block when calling connect with the Extra emulator.')
+      end
+
+      it 'should take the visible value from a block' do
+        extra_session.should_receive(:Visible=).with(false)
+        extra.connect do |platform|
+          platform.visible = false
+        end
+      end
+
+      it 'should default to visible when not specified' do
+        extra_session.should_receive(:Visible=).with(true)
+        extra.connect
+      end
+
+      it 'should take the window state value from the block' do
+        extra_session.should_receive(:WindowState=).with(2)
+        extra.connect do |platform|
+          platform.window_state = :maximized
+        end
+      end
+
+      it 'should default to window state normal when not specified' do
+        extra_session.should_receive(:WindowState=).with(1)
+        extra.connect
+      end
+
+      it 'should default to being visible' do
+        extra_session.should_receive(:Visible=).with(true)
+        extra.connect
+      end
+
+      it 'should get the screen for the active session' do
+        extra_session.should_receive(:Screen).and_return(extra_screen)
+        extra.connect
+      end
+
+      it 'should get the area from the screen' do
+        extra_screen.should_receive(:SelectAll).and_return(extra_area)
+        extra.connect
+      end
+
+      it 'should disconnect from a session' do
+        extra_session.should_receive(:Close)
+        extra.connect
+        extra.disconnect
+      end
+    end
+
+    describe "interacting with text fields" do
+      it 'should get the value from the screen' do
+        extra_screen.should_receive(:GetString).with(1, 2, 10).and_return('blah')
+        extra.connect
+        extra.get_string(1, 2, 10).should == 'blah'
+      end
+
+      it 'should put the value on the screen' do
+        wait_collection = double('wait')
+        extra_screen.should_receive(:PutString).with('blah', 1, 2)
+        extra_screen.should_receive(:WaitHostQuiet).and_return(wait_collection)
+        wait_collection.should_receive(:Wait).with(1000)
+        extra.connect
+        extra.put_string('blah', 1, 2)
+      end
+    end
+
+    describe "interacting with the screen" do
+      it 'should know how to send function keys' do
+        wait_collection = double('wait')
+        extra_screen.should_receive(:SendKeys).with('<Clear>')
+        extra_screen.should_receive(:WaitHostQuiet).and_return(wait_collection)
+        wait_collection.should_receive(:Wait).with(1000)
+        extra.connect
+        extra.send_keys(TE3270.Clear)
+      end
+
+      it 'should wait for a string to appear' do
+        wait_col = double('wait')
+        extra_screen.should_receive(:WaitForString).with('The String', 3, 10).and_return(wait_col)
+        extra_system.should_receive(:TimeoutValue).and_return(30000)
+        wait_col.should_receive(:Wait).with(30000)
+        extra.connect
+        extra.wait_for_string('The String', 3, 10)
+      end
+
+      it 'should wait for the host to be quiet' do
+        wait_col = double('wait')
+        extra_screen.should_receive(:WaitHostQuiet).and_return(wait_col)
+        wait_col.should_receive(:Wait).with(4000)
+        extra.connect
+        extra.wait_for_host(4)
+      end
+
+      it 'should wait until the cursor is at a position' do
+        wait_col = double('wait')
+        extra_screen.should_receive(:WaitForCursor).with(5, 8).and_return(wait_col)
+        extra_system.should_receive(:TimeoutValue).and_return(30000)
+        wait_col.should_receive(:Wait).with(30000)
+        extra.connect
+        extra.wait_until_cursor_at(5, 8)
+      end
+
+      it 'should take screenshots' do
+        take = double('Take')
+        extra_session.should_receive(:WindowHandle).and_return(123)
+        Win32::Screenshot::Take.should_receive(:of).with(:window, hwnd: 123).and_return(take)
+        take.should_receive(:write).with('image.png')
+        extra.connect
+        extra.screenshot('image.png')
+      end
+
+      it 'should make the window visible before taking a screenshot' do
+        take = double('Take')
+        extra_session.should_receive(:WindowHandle).and_return(123)
+        Win32::Screenshot::Take.should_receive(:of).with(:window, hwnd: 123).and_return(take)
+        take.should_receive(:write).with('image.png')
+        extra_session.should_receive(:Visible=).once.with(true)
+        extra_session.should_receive(:Visible=).twice.with(false)
+        extra.connect do |emulator|
+          emulator.visible = false
+        end
+        extra.screenshot('image.png')
+      end
+
+      it 'should delete the file for the screenshot if it already exists' do
+        File.should_receive(:exists?).and_return(true)
+        File.should_receive(:delete)
+        take = double('Take')
+        extra_session.should_receive(:WindowHandle).and_return(123)
+        Win32::Screenshot::Take.should_receive(:of).with(:window, hwnd: 123).and_return(take)
+        take.should_receive(:write).with('image.png')
+        extra.connect
+        extra.screenshot('image.png')
+      end
+
+      it "should get the screen text" do
+        extra_area.should_receive(:Value).and_return('blah')
+        extra.connect
+        extra.text.should == 'blah'
+      end
+
+    end
+  end
+
+end

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

@@ -0,0 +1,170 @@
+if Gem.win_platform?
+
+  require 'spec_helper'
+
+  describe TE3270::Emulators::Quick3270 do
+
+    let(:quick) { TE3270::Emulators::Quick3270.new }
+
+    before(:each) do
+      WIN32OLE.stub(:new).and_return quick_system
+      quick.instance_variable_set(:@session_file, 'the_host')
+    end
+
+    describe "global behaviors" do
+      it 'should start new terminal' do
+        WIN32OLE.should_receive(:new).and_return(quick_system)
+        quick.connect
+      end
+
+      it 'should establish a session' do
+        quick_system.should_receive(:ActiveSession).and_return(quick_session)
+        quick.connect
+      end
+
+      it 'should get the screen from the active session' do
+        quick_session.should_receive(:Screen).and_return(quick_screen)
+        quick.connect
+      end
+
+      it 'should take the Visible value from a block' do
+        quick_system.should_receive(:Visible=).with(false)
+        quick.connect do |platform|
+          platform.visible = false
+        end
+      end
+
+      it 'should take the session file from a block' do
+        quick.should_receive(:session_file=).with('blah.txt')
+        quick.connect do |platform|
+          platform.session_file = 'blah.txt'
+        end
+      end
+
+      it 'should display an error when the session file is not set' do
+        quick.instance_variable_set(:@session_file, nil)
+        expect { quick.connect }.to raise_error('The session file must be set in a block when calling connect with the Quick3270 emulator.')
+      end
+
+      it 'should open the connection using the sesion file' do
+        quick_session.should_receive(:Open).with('blah.txt')
+        quick.connect do |platform|
+          platform.session_file = 'blah.txt'
+        end
+      end
+
+      it 'should default to Visible being true when not provided' do
+        quick_system.should_receive(:Visible=).with(true)
+        quick.connect
+      end
+
+      it 'should make the connection via the session' do
+        quick_session.should_receive(:Connect)
+        quick.connect
+      end
+
+      it 'should check to make sure the connection is successful before continuing' do
+        quick_session.should_receive(:Connected).once.and_return(false)
+        quick_screen.should_receive(:WaitHostQuiet).once.with(1000)
+        quick_session.should_receive(:Connected).once.and_return(true)
+        quick.connect
+      end
+
+      it 'should disconnect from a session' do
+        application = double('application')
+        quick_session.should_receive(:Disconnect)
+        quick_system.should_receive(:Application).and_return(application)
+        application.should_receive(:Quit)
+        quick.connect
+        quick.disconnect
+      end
+    end
+
+    describe "interacting with text fields" do
+      it 'should get the value from the screen' do
+        quick_screen.should_receive(:GetString).with(1, 2, 7).and_return('blah')
+        quick.connect
+        quick.get_string(1, 2, 7).should == 'blah'
+      end
+
+      it 'should put a value on the screen' do
+        quick_screen.should_receive(:MoveTo).with(15, 56)
+        quick_screen.should_receive(:PutString).with('blah')
+        quick_screen.should_receive(:WaitHostQuiet).with(3000)
+        quick.connect
+        quick.put_string('blah', 15, 56)
+      end
+    end
+
+    describe "interacting with the screen" do
+      it 'should know how to send function keys' do
+        quick_screen.should_receive(:SendKeys).with('<Home>')
+        quick_screen.should_receive(:WaitHostQuiet).with(3000)
+        quick.connect
+        quick.send_keys(TE3270.Home)
+      end
+
+      it 'should wait for a string to appear' do
+        quick_screen.should_receive(:WaitForString).with('string', 3, 10)
+        quick.connect
+        quick.wait_for_string('string', 3, 10)
+      end
+
+      it 'should wait for the host to be quiet' do
+        quick_screen.should_receive(:WaitHostQuiet).with(6000)
+        quick.connect
+        quick.wait_for_host(6)
+      end
+
+      it 'should wait until the cursor is at a position' do
+        quick_screen.should_receive(:WaitForCursor).with(5, 8)
+        quick.connect
+        quick.wait_until_cursor_at(5,8)
+      end
+
+      it 'should take screenshots' do
+        take = double('Take')
+        quick_system.should_receive(:WindowTitle).and_return('The Title')
+        Win32::Screenshot::Take.should_receive(:of).with(:window, title: 'The Title').and_return(take)
+        take.should_receive(:write).with('image.png')
+        quick.connect
+        quick.screenshot('image.png')
+      end
+
+      it 'should delete the file for the screenshot if it already exists' do
+        File.should_receive(:exists?).and_return(true)
+        File.should_receive(:delete)
+        take = double('Take')
+        quick_system.should_receive(:WindowTitle).and_return('The Title')
+        Win32::Screenshot::Take.should_receive(:of).with(:window, title: 'The Title').and_return(take)
+        take.should_receive(:write).with('image.png')
+        quick.connect
+        quick.screenshot('image.png')
+      end
+
+      it 'should make the window visible before taking a screenshot' do
+        take = double('Take')
+        quick_system.should_receive(:WindowTitle).and_return('The Title')
+        Win32::Screenshot::Take.should_receive(:of).with(:window, title: 'The Title').and_return(take)
+        take.should_receive(:write).with('image.png')
+        quick_system.should_receive(:Visible=).once.with(true)
+        quick_system.should_receive(:Visible=).twice.with(false)
+        quick.connect do |emulator|
+          emulator.visible = false
+        end
+        quick.screenshot('image.png')
+      end
+
+      it 'should get the screen text' do
+        quick_screen.should_receive(:Rows).and_return(3)
+        quick_screen.should_receive(:Cols).and_return(10)
+        3.times do |time|
+          quick_screen.should_receive(:GetString).with(time+1, 1, 10).and_return("row #{time}")
+        end
+        quick.connect
+        quick.text.should == 'row 0\nrow 1\nrow 2\n'
+      end
+    end
+  end
+
+end