ass_launcher 0.1.1.alpha → 0.2.0

data/examples/connection_string_example.rb

@@ -0,0 +1,59 @@
+require 'example_helper'
+
+module Examples
+  module ConnectionString
+    require 'ass_launcher'
+
+    describe 'Parse connection string from string: Api.cs method' do
+      it 'File infobase connection string' do
+        extend AssLauncher::Api
+        conns = cs 'File="path";Usr="user name";Pwd="pass"'
+
+        conns.must_be_instance_of AssLauncher::Support::ConnectionString::File
+        conns.is?(:file) .must_equal true
+      end
+
+      it 'Server connection string' do
+        extend AssLauncher::Api
+        conns = cs 'srvr="host";ref="infibase";usr="user name";pwd="pass"'
+
+        conns.must_be_instance_of AssLauncher::Support::ConnectionString::Server
+        conns.is?(:server) .must_equal true
+      end
+
+      it 'HTTP connection string' do
+        extend AssLauncher::Api
+        conns = cs 'ws="http://example.org/ib";usr="user name";pwd="pass"'
+
+        conns.must_be_instance_of AssLauncher::Support::ConnectionString::Http
+        conns.is?(:http) .must_equal true
+      end
+    end
+
+    describe 'New connection string' do
+      it 'File connection string: Api.cs_file method' do
+        extend AssLauncher::Api
+        conns = cs_file file: 'path', usr: 'user name', pwd: 'pass'
+
+        conns.must_be_instance_of AssLauncher::Support::ConnectionString::File
+        conns.is?(:file) .must_equal true
+      end
+
+      it 'Server connection string Api.cs_srv method' do
+        extend AssLauncher::Api
+        conns = cs_srv srvr: 'host', ref: 'infibase', usr: 'user name', pwd: 'pass'
+
+        conns.must_be_instance_of AssLauncher::Support::ConnectionString::Server
+        conns.is?(:server) .must_equal true
+      end
+
+      it 'HTTP connection string: Api.cs_http method' do
+        extend AssLauncher::Api
+        conns = cs_http ws: 'http://example.org/ib', usr: 'user name', pwd: 'pass'
+
+        conns.must_be_instance_of AssLauncher::Support::ConnectionString::Http
+        conns.is?(:http) .must_equal true
+      end
+    end
+  end
+end

data/examples/create_infobase_example.rb

@@ -0,0 +1,45 @@
+require 'example_helper'
+
+module Examples
+  module CreateInfobase
+    require 'ass_launcher'
+
+    describe 'Create new 1C:Enterprise application aka "information base"' do
+      extend AssLauncher::Api
+
+      # Get 1C:Enterprise binary wrapper or fail
+      binary = thicks(PLATFORM_VER).last
+      fail "Enterprise v #{PLATFORM_VER} not installed" if binary.nil?
+
+      # Build connection string for new infobase.
+      # In this case uses file 1C:Enterprise application type but
+      # we can create infobase on 1C:Enterprise server. For it we should use
+      # Api.cs_srv method which returns server connection string
+      conns = cs_file(file: File.join(Dir.tmpdir,'examples.create_infobase.ib'))
+      # 1C:Enterprise application Template
+      template = Examples::TEMPLATES::CF
+
+      # Build command whith ArgumentsBuilder
+      command = binary.command(:createinfobase) do
+        connection_string conns
+        useTemplate template
+        _L 'en'
+      end
+
+      # Running and waiting until process executing
+      # because it executing in forked process
+      process_holder = command.run.wait
+
+      it 'New infobase created whithout errors' do
+        # verify execution result
+        process_holder.result.verify!
+        # 1C:Enterprise application directory really exists
+        File.directory?(conns.file).must_equal true
+      end
+
+      after do
+        FileUtils.rm_rf conns.file if File.exists?(conns.file)
+      end
+    end
+  end
+end

data/examples/enterprise_ole_example.rb

@@ -0,0 +1,238 @@
+require 'example_helper'
+
+module Examples
+  module EnterpriseOle
+    fail 'OLE in UNIX??? :)' if PLATFORM::LINUX
+    module HRESULT
+      RPC_SERVER_UNAVALIBLE = '0x800706ba'
+    end
+
+    # 1C:Enterprise provides three OLE servers:
+    # v8x.Application - thick client standalone OLE server
+    # v8xC.Application - thin client standalone OLE server
+    # v8x.ComConnector - inproc ole server for connect to:
+    #  - 1C:Enterprise application aka infobases
+    #  - 1C:Enterprise server agent
+    #  - 1C:Enterprise server working process
+
+    describe 'AssLauncher provides wrappers for 1C:Enterprise Ole servers' do
+      extend AssLauncher::Api
+
+      # Wrappers returned AssLauncher::Api#ole method
+
+      thick_app = ole(:thick, PLATFORM_VER)
+      it 'Wrapper for "Thick application ole server" (aka v83.Application)' do
+        thick_app.must_be_instance_of AssLauncher::Enterprise::Ole::ThickApplication
+      end
+
+      thin_app = ole(:thin, PLATFORM_VER)
+      it 'Wrapper for "Thin application ole server" (aka v83c.Application)' do
+        thin_app.must_be_instance_of AssLauncher::Enterprise::Ole::ThinApplication
+      end
+
+      external = ole(:external, PLATFORM_VER)
+      it 'Wrapper for "External connection with infobase" (childe v83.ComConnector)' do
+        external.must_be_instance_of AssLauncher::Enterprise::Ole::IbConnection
+      end
+
+      wpconn = ole(:wprocess, PLATFORM_VER)
+      it 'Wrapper for "1C:Enterprise server working process connection" (childe v83.ComConnector)' do
+        wpconn.must_be_instance_of AssLauncher::Enterprise::Ole::WpConnection
+      end
+
+      saconn = ole(:sagent, PLATFORM_VER)
+      it 'Wrapper for "1C:Enterprise server agent connection" (childe v83.ComConnector)' do
+        saconn.must_be_instance_of AssLauncher::Enterprise::Ole::AgentConnection
+      end
+    end
+
+    describe 'Example for basic to use' do
+      extend AssLauncher::Api
+
+      # Get ole wrapper
+      external = ole(:external, PLATFORM_VER)
+
+      it 'Example' do
+        # Open connection with connection string
+        # For WpConnection and AgentConnection __connect__
+        # expects URI string
+        external.__open__ TMP::EMPTY_IB_CS
+
+        # Call 1C:Enterprise method #InfoBaseConnectionString
+        external.InfoBaseConnectionString.must_equal\
+          TMP::EMPTY_IB_CS.to_ole_string
+
+        # Close connection
+        external.__close__
+      end
+
+      after do
+        external.__close__
+      end
+    end
+
+    describe 'Closing connection' do
+      describe 'For standalone server it working perfect' do
+        extend AssLauncher::Api
+        thick_app = ole(:thick, PLATFORM_VER)
+
+        it 'Connection realy closed of thick_app' do
+          thick_app.__open__ TMP::EMPTY_IB_CS
+
+          ole_array = thick_app.newObject('Array')
+          ole_array.Count.must_equal 0
+
+          thick_app.__close__
+
+          # Fails because OLE server is down
+          e = proc {
+            ole_array.Count
+          }.must_raise NoMethodError
+
+          e.message.must_match %r{error code:#{HRESULT::RPC_SERVER_UNAVALIBLE}}
+        end
+
+        after do
+          thick_app.__close__
+        end
+      end
+
+      describe 'For inproc server close connection working with restrictions' do
+        # 1C inproc OLE servers haven't method for closing connection!
+        # Connection keep alive while live ruby process.
+        #
+        # If in one ruby script we want to use inproc connection for some work
+        # do in the infobase and after them we want run other connection
+        # or application or designer with flag of exclusive mode, in this case
+        # opened inproc connection doesn't give us to do it
+        #
+        # AssLauncher provide feature for closing inproc connection  but
+        # it working with restrictions.
+        #
+        # AssLauncher patching WIN32OLE and collect all ole objects which
+        # generated and try kill refs calling #ole_free method for them when
+        # #__close__ method call.
+        #
+        # But it works not always. Connection keep alive while have any alive
+        # WIN32OLE refs generated this connection
+
+        describe 'Case when inproc server connection realy closed' do
+          extend AssLauncher::Api
+
+          # Get standalone ole server wrapper
+          # It is service connector
+          thick_app = ole(:thick, PLATFORM_VER)
+
+          # Get inproc ole server wrapper
+          # It object under test
+          external = ole(:external, PLATFORM_VER)
+
+          it 'External connection realy closed' do
+            thick_app.__open__ TMP::EMPTY_IB_CS
+            external.__open__ TMP::EMPTY_IB_CS
+
+            # We have two working sessions
+            thick_app.GetInfoBaseSessions.Count.must_equal 2
+
+            ole_array = external.newObject('Array')
+            ole_array.Count.must_equal 0
+
+            external.__close__
+
+            # External connection was closed
+            # and only one working session is alive
+            thick_app.GetInfoBaseSessions.Count.must_equal 1
+
+            # Fails 'failed to get Dispatch Interface'
+            # because #ole_free was called while external.__close__
+            e = proc {
+              ole_array.Count
+            }.must_raise RuntimeError
+            e.message.must_match %r{failed to get Dispatch Interface}i
+          end
+
+          after do
+            thick_app.__close__
+            external.__close__
+          end
+        end
+      end
+    end
+
+    describe 'We can chose version of 1C:Enterprise ole server' do
+      # We can choosing 1C ole server's version.
+      # AssLauncher automatically register needed server version
+      # and returns suitable wrapper.
+      #
+      # Registration version of ole server working correct only for standalone
+      # servers such as Thin and Thick applications.
+      #
+      # We don't get new version of inproc ole server until old version
+      # is loaded in memory
+
+      it "Fail if 1C:Enterprise version doesn't instaled" do
+        extend AssLauncher::Api
+        external = ole(:external, '~> 999')
+        e = proc {
+          external.__open__ ''
+        }.must_raise RuntimeError
+        e.message.must_match %r{Platform version `~> 999' not instaled}
+      end
+
+      describe 'Choosing version of standalone ole server working perfect' do
+        extend AssLauncher::Api
+
+        thick_app = ole(:thick, PLATFORM_VER)
+
+        it 'Ole server have suitable version' do
+          thick_app.__open__ TMP::EMPTY_IB_CS
+          system_info = thick_app.newObject('SystemInfo')
+
+          real_ole_app_version = Gem::Version.new(system_info.AppVersion)
+
+          real_ole_app_version.must_equal\
+            thick_app.instance_variable_get(:@__ole_binary__).version
+
+          thick_app.__close__
+        end
+
+        after do
+          thick_app.__close__
+        end
+      end
+    end
+
+    describe 'AssLauncher patching WIN32OLE for some reason' do
+      describe 'Getting real Ruby objects from WIN32OLE wrapper' do
+
+        # Ruby WIN32OLE automatically convert Ruby objects into IDispatch
+        # when they passed as parameter in to OLE server's side.
+        # When such objects returns on the Ruby's side they will keep as WIN32OLE
+        # AssLauncher provides feature for getting real Ruby object
+
+        it 'Example' do
+          ole_server = WIN32OLE.new('Scripting.Dictionary')
+
+          ruby_obj = Object.new
+
+          skip 'It Segmentation fault in:'\
+          ' ruby 2.0.0p645 (2015-04-13 revision 50299)'\
+          ' [i386-cygwin]' if RUBY_VERSION == '2.0.0'
+
+          # Call OLE server
+          ole_server.add(1, ruby_obj)
+          wrapped_obj = ole_server.items[0]
+
+          # Ruby object wrapped into WIN32OLE
+          wrapped_obj.must_be_instance_of WIN32OLE
+
+          # Ask: Is it Ryuby object?
+          wrapped_obj.__ruby__?.must_equal true
+
+          # Get Ruby object
+          wrapped_obj.__real_obj__.must_equal ruby_obj
+        end
+      end
+    end
+  end
+end

data/examples/enterprise_out_example.rb

@@ -0,0 +1,87 @@
+require 'example_helper'
+
+module Examples
+  module EneterpriseOut
+    # 1C:Enterprise not work with stdout and stderr
+    # For out 1C use /OUT"file" parameter and write message into. Message
+    # encoding 'cp1251' for windows and 'utf-8' for Linux
+
+    describe 'AssLauncher provides automaticaly capturing 1C:Enterprise out' do
+      enterprise = CLIENTS::THICK.command :enterprise do
+        connection_string TMP::EMPTY_IB_CS
+        _Execute TEMPLATES::HELLO_EPF
+        _C 'Hello World'
+      end
+
+      it 'Out Hello World' do
+        enterprise.run.wait
+        enterprise_output = enterprise.process_holder.result.assout
+        enterprise_output.strip.must_equal 'Hello World'
+      end
+    end
+
+    describe "AssLauncher checks duplication of /OUT parameter and fails if it's true" do
+      it 'Fails' do
+        e = proc {
+          enterprise = CLIENTS::THICK.command :enterprise, ['/OUT', 'path']
+        }.must_raise ArgumentError
+        e.message.must_match %r{set option capture_assout: false}i
+      end
+    end
+
+    describe 'Arguments builder checks for /OUT file exists' do
+      it 'Fails' do
+        e = proc {
+          enterprise = CLIENTS::THICK.command :enterprise do
+            connection_string TMP::EMPTY_IB_CS
+            _OUT './fake_out_file'
+          end
+        }.must_raise ArgumentError
+        e.message.must_match %r{fake_out_file not exists}i
+      end
+
+    end
+
+    describe 'We can define owner /OUT file but we must set :capture_assout => false' do
+      # method #command having option :capture_assout which
+      # control automatically capturing behavior.
+      # On default :capture_assout => true
+
+      out_file = File.join(Dir.tmpdir, 'enterprise_out_example.out')
+      FileUtils.touch out_file
+
+      enterprise = CLIENTS::THICK\
+        .command :enterprise, [], capture_assout: false do
+        connection_string TMP::EMPTY_IB_CS
+        _Execute TEMPLATES::HELLO_EPF
+        _OUT out_file
+        _C 'Hello World'
+      end
+
+      it 'Out Hello World' do
+        enterprise.run.wait
+        enterprise_output = File.read(out_file)
+        enterprise_output.strip.must_equal 'Hello World'
+      end
+
+      def after
+        FileUtils.rm_f out_file if Fail.exists? out_file
+      end
+    end
+
+    describe "1C:Enterprise thin client doesn't puts messages into /OUT :(" do
+      enterprise = CLIENTS::THIN.command do
+        connection_string TMP::EMPTY_IB_CS
+        _Execute TEMPLATES::HELLO_EPF
+        _C 'Hello World'
+      end
+
+      it "Out empty" do
+        enterprise.run.wait
+
+        enterprise_output = enterprise.process_holder.result.assout
+        enterprise_output.strip.must_equal ''
+      end
+    end
+  end
+end

data/examples/enterprise_running_example.rb

@@ -0,0 +1,103 @@
+require 'example_helper'
+
+module Examples
+  module EnterpriseRun
+    describe 'Basic examples for running 1C:Enterprise' do
+      it 'Running thick client in :designer run mode' do
+        # 1) Get AssLauncher::Api helper
+        extend AssLauncher::Api
+
+        # 2) Get 1C:Enterprise binary wrappers which satisfied by version
+        #    requirement and choose last version from them
+        thick_client = thicks('~> 8.3').last
+
+        # 3) Fail if required 1C:Enterprise installation not found
+        fail '1C:Enterprise ~> 8.3 not found' if thick_client.nil?
+
+        # 4) Build command for required run mode.
+        designer = thick_client.command(:designer) do
+          # This block writes on DSL and
+          # will be passed to arguments builder instance
+          connection_string "File=\"#{TMP::EMPTY_IB}\";"
+          checkModules do
+            _Server
+          end
+          _L 'en'
+        end
+
+        # 5) Running 1C:Enterprise and waiting
+        designer.run.wait
+
+        # 6) Verify result
+        designer.process_holder.result.verify!
+      end
+
+      it 'Running thin client' do
+        # 1) Get AssLauncher::Api helper
+        extend AssLauncher::Api
+
+        # 2) Get 1C:Enterprise binary wrappers which satisfied by version
+        #    requirement and choose last version from them
+        thin_client = thins('~> 8.3').last
+
+        # 3) Fail if required 1C:Enterprise installation not found
+        fail '1C:Enterprise ~> 8.3 not found' if thin_client.nil?
+
+        # 4) Build command
+        enterprise = thin_client.command do
+          # This block writes on DSL and
+          # will be passed to arguments builder instance
+          connection_string "File=\"#{TMP::EMPTY_IB}\";"
+          _L 'en'
+          _Debug
+          _DebuggerUrl 'tcp://localhost'
+        end
+
+        # 5) Run enterprise
+        enterprise.run
+
+        # 6) Kill enterprise
+        enterprise.process_holder.kill
+      end
+
+      it 'Running web client' do
+        # 1) Get AssLauncher::Api helper
+        extend AssLauncher::Api
+
+        # 2) Get wrapper for specified 1C:Enterprise version
+        wc = web_client('http://host/path/infobase', '8.3.6')
+
+        # 3) Build URI
+        loc = wc.location do
+          # Buld arguments
+          _N 'user name'
+          _P 'pass'
+          _L 'en'
+          testClientID 'id'
+          debuggerURL 'http://debugger:5668'
+        end
+
+        # 4) Navigate to location
+        # `firefox #{loc}`
+      end
+
+      it 'Running ole sever' do
+        # 1) Get AssLauncher::Api helper
+        extend AssLauncher::Api
+
+        # 2) Get wrapper for last version of 1C:Enterprise
+        #    which satisfied by version requirement
+        external_connection = ole(:external, '~> 8.3.0')
+
+        # 3) Open connection
+        begin
+          external_connection.__open__ 'connection_string'
+        rescue
+        end
+
+        # 4) Close connection
+        external_connection.__close__
+      end
+    end
+  end
+end