ass_maintainer-info_base 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76b566844f8ecfe1c6f46a8683ecd5c976683ada
-  data.tar.gz: 241193394974bbb8e83bb51c585cccfce7bbe659
+  metadata.gz: 50e50193d3052bdea87880539a64bc138c7e2081
+  data.tar.gz: '03469ca21025660f741ea514e2dec991f86d14fa'
 SHA512:
-  metadata.gz: a9d32a901ca070a19b7bac6a4f06accfdd4b4dee60014e38d4bd6267a106b59c7a99303a6f989b64dcc907ab4ed7eaa6cb89df1545e0e8ef800866ddcf88b153
-  data.tar.gz: 663ae4abd9c6da3999ffa7bd19a623c05c2fd60787a4e0aadc0d511e8cf3651477ee0352b6848f2ceb2ee8ba321a992f32940b543c624005118ecd466be44a6b
+  metadata.gz: 2db4da3e0a521d58b5ffe3f90bf5e0e41932f0d3cad9fb2ba995d9356d7bc31aa52010c64118ed83b995ae72c63e4fa631f8191bf1811aef273e8df91acefe2d
+  data.tar.gz: bfa963a1384e6135faa8024fd4ca125adf7250b0f8cffb253a4b15b64f1fab8de1140a5fdb4179a257cb43f010f45f4413eff3ff0538734bdf28f8550fc57e0b

data/README.md

@@ -1,18 +1,36 @@
 # AssMaintainer::InfoBase
 
+Gem for juggle with the [1C:Enterprise](http://1c.ru) application instances
+(aka infobase or information base) as easy as possible.
+Main thing of this gem is the class `AssMaintainer::InfoBase` which provides
+features to do it.
 
-Gem provides features for manipulate with 1C:Enterprise applications as easy
-as possible.
+In this gem defined two types of 1C application instance:
 
-Main thing of this gem `class AssMaintainer::InfoBase` provides
-some methods for manipulate with information base;
+1. application deployed on a 1C:Enterprise application server aka *server infobase*
+2. application deployed as a file aka *file infobase*
 
-## Realase note
+Class `AssMaintainer::InfoBase` implements both types of applications but using
+difference mixins for each of them in constructor. Type of application,
+detects per type of [connection string](https://github.com/leoniv/ass_launcher/blob/master/lib/ass_launcher/support/connection_string.rb).
 
-### v.0.1.0
+## Restriction
 
-- Not support infobases deployed on 1C:Enterprise server
-- Not support configuration extensions
+Fully work with server infobse possible in Windows(Cygwin)
+x86 Ruby only. Cause of this is in-process OLE server `V83.COMConnector` which
+used for connect to 1C:Enterprise application server when require check for
+infobase exist or get infobase sessions or drop infobase or etc. actions.
+
+Furthermore, for fully working with server infobse require logging on a
+1C:Enterprise application server as a central-server administrator and
+as a cluster administrator.
+
+Structure 1C:Enterprise application server is complex and confusing.
+For more info about 1C:Enterprise server look 1C documentation.
+
+Some examples for restrictions look in
+[example](./test/ass_maintainer/examples_test.rb) defined as `Restrictions for`
+spec
 
 ## Installation
 
@@ -32,7 +50,7 @@ Or install it yourself as:
 
 ## Usage
 
-Small example:
+### Small example:
 
 ```ruby
 reqiure 'ass_maintainer/info_base'
@@ -43,30 +61,91 @@ reqiure 'ass_maintainer/info_base'
 connection_string = 'File="infobase_path";'
 
 # Get InfoBase instance
-ib = AssMaintainer::InfoBase.new('infobase_name', connection_string, read_only)
+ib = AssMaintainer::InfoBase.new('infobase_name', connection_string)
 
 # Dump data
 ib.dump(dump_path)
 
-
 # As 1C application developer you should make dump of infobase configuration
 
 # Dump configuration
 ib.cfg.dump(cf_dump_path)
 
 # ... etc
+```
+
+### Destructive actions protection
+
+On default all instance of `AssMaintainer::InfoBase` marked as `read_only`. If
+infobase is `read_only` all destructive actions denied,
+`MethodDenied` exception will be raised. For control it behavior uses
+`read_only` parameter of constructor.
 
+```ruby
+ib = AssMaintainer::InfoBase.new('ib_name', 'File="path"')
+ib.rm! :yes #raised AssMaintainer::InfoBase::MethodDenied
+
+ib = AssMaintainer::InfoBase.new('ib_name', 'File="path"', false)
+ib.rm! :yes #=> nil
 ```
 
+### Define 1C:Enterprise version requirement
+
+On default using last installed 1C:Enterprise version. But
+`AssMaintainer::InfoBase` provides feature for define 1C:Enterprise version
+manually.
+
+Example for define 1C:Enterprise platform requirement
+
+```ruby
+# Define platform version for single instance
+ib = AssMaintainer::InfoBase.new('ib_name', 'File="path"', platform_require: '~> 8.3.10.0')
+ib.platform_require #=> "~> 8.3.10.0"
+
+# Define platform verion for all instances
+AssMaintainer::InfoBase.configure do |conf|
+  conf.platform_require = '~> 8.3.9.0'
+end
+
+ib = AssMaintainer::InfoBase.new('ib_name', 'File="path"')
+ib.platform_require #=> "~> 8.3.9.0"
+```
+
+### More examples
+
 For more examples see [examples](./test/ass_maintainer/examples_test.rb)
 
 ## Test
 
-For running tests require installs 1C:Enterprise platform version defined in constant
-`PLATFORM_REQUIRE` from
-[test_helper.rb](./test/test_helper.rb)
+For execute all tests require 1C:Enterprise platform installed.
+Version defined in constant `PLATFORM_REQUIRE` in
+[platform_require.rb](./test/test_helper/platform_require.rb)
+
+For execute server infobase tests defined in
+[examples](./test/ass_maintainer/examples_test.rb) require:
+- running 1C:Enterprise application server. Version defined in `PLATFORM_REQUIRE`
+- running data base(DBMS) server suitable for 1C:Enterprise.
+
+On default, server infobase tests skipped. For execute server infobase tests
+require to pass server parameters in `ENV[ESRV_ENV]` like this:
+
+```
+$export ESRV_ENV="--ragent user:pass@host:port \
+  --rmngr user:pass@host:port \
+  --dbms MSSQLServer \
+  --dbsrv user:pass@localhost\\sqlexpress"
+```
+
+For running local 1C:Enterprise application server instance can use
+[bin/runsrv](bin/runsrv):
+
+    $bin/runsrv -h
+
+But `runsrv` running 1C server only! DBMS server must be already running manually
+
+Running all tests:
 
-    $export SIMPLECOV=YES && rake test
+    $bundler exec rake test SIMPLECOV=YES
 
 ## Development
 

data/ass_maintainer-info_base.gemspec

@@ -19,7 +19,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "ass_launcher", "~> 0.2.0"
+  spec.add_dependency "ass_launcher", "~> 0.3"
+  spec.add_dependency "ass_ole"
+  spec.add_dependency "net-ping", "~> 2.0.0"
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
@@ -27,5 +29,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "mocha"
+  spec.add_development_dependency "clamp"
 
 end

data/bin/runsrv

@@ -0,0 +1,241 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require_relative '../test/test_helper/platform_require'
+require_relative '../test/test_helper/helper'
+require 'net/ping/tcp'
+
+module AssMaintainer::InfoBaseTest
+  module Tmp
+    SRVINFO = File.join Dir.tmpdir, "ass_maintainer_infobase_test.srvinfo"
+  end
+
+  module Server
+    PORT = '11540'
+    REGPORT = '11541'
+    RANGE = '11560:11591'
+    RAGENT_ADMIN = 'ragent'
+    RAGENT_PASS = '0000'
+    RMNGR_ADMIN = 'rmngr'
+    RMNGR_PASS = '1111'
+
+    class Ragent
+      BIN = 'ragent.exe'
+      attr_reader :platform_require, :port, :regport, :range
+
+      def initialize(platform_require, port = nil, regport = nil, range = nil)
+        @platform_require = platform_require
+        @port = port || PORT
+        @regport = regport || REGPORT
+        @range = range || RANGE
+      end
+
+      def thick
+        @thick ||= Helper.thicks(platform_require).last
+      end
+
+      def exists?
+        path && File.file?(path)
+      end
+
+      def path
+        return unless thick
+        @path ||= thick.path.class.new("#{thick.path.dirname}/#{BIN}")
+      end
+
+      def version
+        return unless exists?
+        thick.version
+      end
+
+      def srvinfo
+        return unless exists?
+        thick.path.class.new(@srvinfo).realpath.to_s
+      end
+
+      def args
+        ['-port', port,
+         '-regport', regport,
+         '-range', range,
+         '-agent',
+         '-d', srvinfo]
+      end
+
+      def cmd
+        path.to_s
+      end
+
+      def running?
+        tcp_ping.ping?
+      end
+
+      def tcp_ping
+        @tcp_ping ||= Net::Ping::TCP.new(host, port)
+      end
+
+      def host
+        'localhost'
+      end
+
+      def run(srvinfo, make_admins_)
+        @srvinfo = srvinfo
+        fail "service on the tcp port `#{port}' is already running" if running?
+        fail "`#{BIN}' v#{version} isn't instaled!" unless exists?
+        Process.spawn "\"#{cmd}\" #{args.join(' ')}"
+        sleep(3)
+        make_admins if make_admins_
+      end
+
+      def runtime_new
+        Module.new do
+          is_ole_runtime :agent
+        end
+      end
+
+      def run_ole_runtime
+        require 'ass_ole'
+        self.class.like_ole_runtime runtime_new
+        ole_runtime_get.run "localhost:#{port}", platform_require
+      end
+
+      def make_admins
+        run_ole_runtime
+        make_rmngr_admin
+        make_ragent_admin
+      end
+
+      def make_ragent_admin
+        authenticateAgent('', '')
+        regAgentAdmin ragent_admin_get
+      end
+
+      def ragent_admin_get
+        ai = createClusterAdminInfo
+        ai.Name = RAGENT_ADMIN
+        ai.Password = RAGENT_PASS
+        ai.PasswordAuthAllowed = true
+        ai
+      end
+
+      def make_rmngr_admin
+        cl = cluster_get
+        Authenticate(cl, '', '')
+        regClusterAdmin(cl, cluster_admin_get)
+      end
+
+      def cluster_get
+        getClusters[0]
+      end
+
+      def cluster_admin_get
+        ai = createClusterAdminInfo
+        ai.Name = RMNGR_ADMIN
+        ai.Password = RMNGR_PASS
+        ai.PasswordAuthAllowed = true
+        ai
+      end
+    end
+
+    require 'clamp'
+    class CMD < Clamp::Command
+      def prepare_srv_info
+        FileUtils.rm_r Tmp::SRVINFO if File.exist? Tmp::SRVINFO
+        FileUtils.mkdir_p Tmp::SRVINFO
+        Tmp::SRVINFO
+      end
+
+      def exists?
+        ragent.exists?
+      end
+
+      def running?
+        ragent.running?
+      end
+
+      def ragent
+        @ragent ||= Ragent
+          .new(PLATFORM_REQUIRE, port, regport, range)
+      end
+      alias_method :ra, :ragent
+
+      def srvinfo_get
+        return prepare_srv_info if srvinfo == Tmp::SRVINFO
+        srvinfo || prepare_srv_info
+      end
+
+      def errno_enotempty_mess
+        "rm -r #{srvinfo}: Device or resource busy\n"\
+        "Cause of this: \n"\
+        " 1) other ragent.exe is running and locking srvinfo directory\n"\
+        " 2) other rmngr.exe is running and locking srvinfo directory\n"\
+        "Kill suitable ragent.exe and rmngr.exe processes and try again:\n"\
+        "  #{netstat.join("\n  ")}"
+      end
+
+      def netstat
+        `netstat -abn -p tcp`.force_encoding('ASCII-8BIT')
+          .split("\r\n"*2)
+          .map {|i| i.gsub(/\s+/, ' ')}
+          .select {|i| i =~ %r{LISTENING.+r(agent|mngr)\.exe}}
+          .sort_by {|i| i.split(" ").last}
+      end
+
+      def rmngr_host
+        `hostname`.strip
+      end
+
+      def ragent_usr
+        "#{Server::RAGENT_ADMIN}:#{Server::RAGENT_PASS}@" if make_admins?
+      end
+
+      def rmngr_usr
+        "#{Server::RMNGR_ADMIN}:#{Server::RMNGR_PASS}@" if make_admins?
+      end
+
+      def success_mess
+        "for pass ESRV_ENV to test execute:\n"\
+        "export ESRV_ENV=\"--ragent #{ragent_usr}#{ra.host}:#{ra.port} \\\n"\
+        "  --rmngr #{rmngr_usr}#{rmngr_host}:#{ra.regport} \\\n"\
+        "  --dbms YOUR_DBMS \\\n"\
+        "  --dbsrv user:pass@your_dbms_host:port\""
+      end
+
+      def execute
+        signal_usage_error 'Run in cygwin or windows only!' if Helper.linux?
+        ragent.run(srvinfo_get, make_admins?)
+        puts success_mess
+      rescue RuntimeError => e
+        raise Clamp::ExecutionError.new(e.message, '', 1)
+      rescue Errno::ENOTEMPTY => e
+        raise Clamp::ExecutionError.new(errno_enotempty_mess, '', 1)
+      end
+
+      option '--port', 'PORT', 'ragent.exe tcp port', default: PORT do |s|
+        Integer(s)
+      end
+
+      option '--regport', 'PORT', 'rmngr.exe tcp port', default: REGPORT do |s|
+        Integer(s)
+      end
+
+      option '--range', 'FROM:TO', 'rphost.exe tcp ports range', default: RANGE do |s|
+        from, to = s.split(':')
+        "#{Integer(from)}:#{Integer(to)}"
+      end
+
+      parameter '[SRVINFO]', 'path to ragent.exe srvinfo directory', default: Tmp::SRVINFO do |s|
+        signal_usage_error "Path `#{s}' not found or isn't directory!" unless File.directory? s
+        s
+      end
+
+      option '--plist', :flag, 'show netstat for rphost.exe and rmngr.exe and exit' do
+        $stderr.puts netstat.join("\n")
+        exit 0
+      end
+
+      option '--[no-]make-admins', :flag, 'default admins for ragent.exe and rmngr.exe will be maked'
+    end
+  end
+end
+
+AssMaintainer::InfoBaseTest::Server::CMD.run

data/lib/ass_maintainer/info_base.rb

@@ -7,26 +7,26 @@ module AssMaintainer
   # Class for manipulate with 1C:Enterprise application instance aka
   # +information base+ or +infobase+
   #
-  # Instances of this class have dinamicly generated interfaece
+  # Instances of this class has dynamically generated interface
   #
   # 1C:Enterprise application may be deployed as file (aka file infobase) or
   # on a 1C:Enterprise server (aka server infobase). In the {#initialize}
-  # instance of this class will be extended suitable module:
-  # - server infobase instance will be extend module {ServerIb}
-  # - file infobase instance will be exten module {FileIb}
+  # instance of will be extended by suitable module:
+  # - server infobase instance will be extended by {ServerIb} module
+  # - file infobase instance will be extended by {FileIb} module
   #
-  # Both instance type inherits methods from {Interfaces::InfoBaseWrapper}
+  # Both instances types inherits methods from {Interfaces::InfoBase}
   #
-  # All instances get methods wrappers for access to {#options} see
+  # All instances gets methods for access to {#options} see
   # {.build_options_wrapper}
   class InfoBase
     extend AssLauncher::Api
     require 'ass_maintainer/info_base/config'
     require 'ass_maintainer/info_base/interfaces'
+    require 'ass_maintainer/info_base/default_maker'
     require 'ass_maintainer/info_base/file_ib'
     require 'ass_maintainer/info_base/server_ib'
     require 'ass_maintainer/info_base/cfg'
-    require 'ass_maintainer/info_base/default_maker'
 
     # :nodoc:
     class MethodDenied < StandardError
@@ -35,7 +35,7 @@ module AssMaintainer
       end
     end
 
-    # Deafult port for connect to 1C:Enterprise serever agent
+    # Deafult port for connect to 1C:Enterprise server agent
     DEFAULT_SAGENT_PORT = '1540'
 
     # Hooks before and after make and remove infobase. Hooks may be passed as
@@ -57,25 +57,23 @@ module AssMaintainer
       destroyer: nil
     }
 
-    # - +:latform_require+ Required 1C:Enterprise version
-    # - +:agent_host+ Host name of 1C:Enterprise server agent
-    # - +:agent_port+ TCP port of 1C:Enterprise server agent on
+    # - +:platform_require+ Required 1C:Enterprise version
+    # - +:sagent_host+ Host name of 1C:Enterprise server agent
+    # - +:sagent_port+ TCP port of 1C:Enterprise server agent on
     #   default {DEFAULT_SAGENT_PORT}
-    # - +:agent_usr+ Admin for 1C:Enterprise server agent
-    # - +:agent_pwd+ Admin password for 1C:Enterprise server agent
-    # - +:laster_usr+ Admin for 1C:Enterprise claster.
-    #   See {ServerIb#claster_usr}
-    # - +:laster_pwd+ Pasword Admin for 1C:Enterprise claster.
-    #   See {ServerIb#claster_pwd}
-    # - +:nlock_code+ Code for connect to locked infobase aka "/UC" parameter
+    # - +:sagent_usr+ Admin for 1C:Enterprise server agent
+    # - +:sagent_pwd+ Admin password for 1C:Enterprise server agent
+    # - +:cluster_usr+ Admin for 1C:Enterprise cluster.
+    # - +:cluster_pwd+ Pasword Admin for 1C:Enterprise cluster.
+    # - +:unlock_code+ Code for connect to locked infobase aka "/UC" parameter
     ARGUMENTS = {
       platform_require: nil,
       sagent_host: nil,
       sagent_port: nil,
       sagent_usr: nil,
       sagent_pwd: nil,
-      claster_usr: nil,
-      claster_pwd: nil,
+      cluster_usr: nil,
+      cluster_pwd: nil,
       unlock_code: nil
     }
 
@@ -105,7 +103,7 @@ module AssMaintainer
     # see {#initialize} +options+
     attr_reader :options
     # InfoBase is read only
-    # destructive methods will be fail with {MethodDenied} error
+    # destructive methods fails with {MethodDenied} error
     attr_reader :read_only
     alias_method :read_only?, :read_only
 
@@ -117,7 +115,7 @@ module AssMaintainer
       @name = name
       @connection_string = self.class.cs(connection_string.to_s)
       @read_only = read_only
-      @options = OPTIONS.merge(options)
+      @options = validate_options(options)
       case self.connection_string.is
       when :file then extend FileIb
       when :server then extend ServerIb
@@ -126,6 +124,13 @@ module AssMaintainer
       yield self if block_given?
     end
 
+    def validate_options(options)
+      _opts = options.keys - OPTIONS.keys
+      fail ArgumentError, "Unknown options: #{_opts}" unless _opts.empty?
+      OPTIONS.merge(options)
+    end
+    private :validate_options
+
     # Add hook. In all hook whill be passed +self+
     # @raise [ArgumentError] if invalid hook name or not block given
     # @param hook [Symbol] hook name
@@ -186,52 +191,6 @@ module AssMaintainer
     end
     private :rm_infobase!
 
-    # Returns type of infobase
-    # @return [Symbol] +:file+ or +:server+
-    def is
-      connection_string.is
-    end
-
-    # Check type of infobase
-    # @param type [Symbol] +:file+ or +:server+
-    def is?(type)
-      connection_string.is?(type)
-    end
-
-    # Set user name
-    def usr=(user_name)
-      connection_string.usr = user_name
-    end
-
-    # User name
-    # @return [String]
-    def usr
-      connection_string.usr
-    end
-
-    # Set locale
-    # @param l [String] locale code +en+, +ru+ etc
-    def locale=(l)
-      connection_string.locale = l
-    end
-
-    # Get locale
-    # @return [String]
-    def locale
-      connection_string.locale
-    end
-
-    # Set user password
-    def pwd=(password)
-      connection_string.pwd = password
-    end
-
-    # User password
-    # @return [String]
-    def pwd
-      connection_string.pwd
-    end
-
     # @return [AssLauncher::Enterprise::BinaryWrapper::ThickClient]
     def thick
       self.class.thicks(platform_require).last ||
@@ -318,7 +277,7 @@ module AssMaintainer
     # Returns instance for manipuate with
     # InfoBase database. If infobase not
     # exists returns nil
-    # @return [Dbase nil]
+    # @return [DbCfg nil]
     def db_cfg
       @db_cfg ||= DbCfg.new(self) if exists?
     end
@@ -331,10 +290,57 @@ module AssMaintainer
       @cfg ||= Cfg.new(self) if exists?
     end
 
-    require 'forwardable'
-    extend Forwardable
-    def_delegators :infobase_wrapper,
-                   *Interfaces::InfoBaseWrapper.instance_methods
+    # Returns type of infobase
+    # @return [Symbol] +:file+ or +:server+
+    def is
+      connection_string.is
+    end
+
+    # Check type of infobase
+    # @param type [Symbol] +:file+ or +:server+
+    def is?(type)
+      connection_string.is?(type)
+    end
+
+    # Set user name
+    def usr=(user_name)
+      connection_string.usr = user_name
+    end
+    alias_method :user=, :usr=
+
+    # User name
+    # @return [String]
+    def usr
+      connection_string.usr
+    end
+    alias_method :user, :usr
+
+    # Set locale
+    # @param l [String] locale code +en+, +ru+ etc
+    def locale=(l)
+      connection_string.locale = l
+    end
+
+    # Get locale
+    # @return [String]
+    def locale
+      connection_string.locale
+    end
+
+    # Set user password
+    def pwd=(password)
+      connection_string.pwd = password
+    end
+    alias_method :password=, :pwd=
+
+    # User password
+    # @return [String]
+    def pwd
+      connection_string.pwd
+    end
+    alias_method :password, :pwd
+
+    include Interfaces::InfoBase
   end
   # rubocop:enable Metrics/ClassLength
 end