ass_tests 1.0.0.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: acb1038346a0074cd225e0b28448550f6dd491dd
+  data.tar.gz: 841ebc7201ba1cb6f59843e65001c4fe0d92d9e3
+SHA512:
+  metadata.gz: d2aef05c2225fca10ef9d90350516820d7d6d7fc11e77e8132e14610fee9535da19cbe11e38d0eb854837131dbdd9b2ab09d80f4e6d9336aec274b653d584899
+  data.tar.gz: 0bbcaf34554b63eb3ac1570fca81213102dff28f28158af8a73303eabe49df4f31177e1b84607cc8648806755cb11e37529319e37445e79a4262e44196889147

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.simplecov

@@ -0,0 +1 @@
+SimpleCov.start if ENV['SIMPLECOV']

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.10.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ass_tests.gemspec
+gemspec

data/README.md

@@ -0,0 +1,139 @@
+# AssTests
+
+
+Framework for unit testing code written on [1C:Enterprise](http://1c.ru)
+embedded programming language.
+
+It make possible to write tests for 1C:Enterprise on Ruby easy.
+
+**Warning! Access to 1C runtime via ```WIN32OLE```. Works only in Windows or Cygwin**
+
+## Benefits
+
+- Write tests on Ruby and keep it under ```git``` as text  vs write tests on 1C embedded language and keep it as external 1C binary objects.
+- Write tests powered by ```Minitest```, ```RSpec```, ```mocha```, ```cucumber``` and other great Ruby libraries.
+- ```WIN32OLE``` automatically convert Ruby objects into IDispatch objects when it passed as argument on to other side. It make possible passes ```mocha``` ```mock``` objects in to 1C runtime side!!!
+
+## Trouble
+
+- Works only in Windows or Cygwin.
+- Not available methods ```eval``` and ```execute``` of 1C "Global context"
+- Unpossible attach to 1C debugger.
+- Now support ```Minitest::Test``` only
+- Other unknown now :(
+
+## Features
+
+- Provides DSL for describe 1C:Enterprise application (aka "Information base")
+- Support to describe many different 1C Information bases.
+- Support describe exists Information bases as ```external```. Such Information bases is persistent and can't be build or remove.
+- Automatically build described Information base on demand.
+- Automatically rebuild Information base on demand.
+- Passes required instance of class `InfoBase` into tests for connect to Information base for testing.
+- Hold pool of opened connection with 1C information bases for decrease costs on wakeup 1C application.
+- Automatically close all opened connection after all tests executed.
+- Provides assertions for tests 1C values in Ruby side
+- Provides features for testing of 1C externals like as ExternalDataProcessor and ExternalReport
+- Provides features for fill data in infobases under test.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ass_tests'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ass_tests
+
+## Usage
+
+
+### Smal example for ```Minitest```
+
+- ```test_helper.rb```:
+```ruby
+require 'ass_tests/autorun'
+require 'ass_tests/info_bases'
+
+# Describe empty InfoBase
+AssTests::InfoBases.describe do
+  file :empty_ib
+end
+```
+- ```small_test.rb```:
+```ruby
+
+class SmalTest < AssTests::MiniTest::Test
+  # Demands described :empty_ib information base
+  use :empty_ib
+  # Declare to run :empty_ib in :context of :thick application
+  # and we ask keep alive connection while tests executing
+  # Default :keep_alive => true.
+  # If set :keep_alive => false for :thick or :thin context
+  # wakeup connection will be very slowly for big applications
+  context :thick, :keep_alive => true
+  # If we want login in information base as some user we say:
+  #   login :as => 'user', :with => 'password'
+  # In this example we use empty information base without any users
+
+  # If we say :keep_alive => true and in tests we want to manipulate
+  # with data, each test mast be wrapped in 1C transaction
+  # for tests isolation.
+  # In this example we aren't manipulate with data
+  # Warning! 1C transaction not define for :thin context,
+  # for :thin context require patch information base application
+  def setup
+    ole.BeginTransaction
+  end
+
+  # Transaction mast be rollback for tests isolation
+  def teardown
+    ole.RollbackTransaction
+  end
+
+  puts infobase.name    # => "empty_ib"
+  puts infobase.exists? # => "true"
+  puts ole.__opened__?  # => "false"
+  puts ole.class # => "AssLauncher::Enterprise::Ole::ThickApplication"
+
+  def test_hello_world
+    puts ole.__opened__?  # => "true"
+    a = ole.newObject 'array'
+    a.add 'Hello world'
+    assert_equal 'Hello world', ole.string(a.get(0))
+  end
+
+  def test_other
+    assert ole.__opened__?
+  end
+end
+```
+- also you can write native ```Minitest::Test``` for testing
+  other things like this ```ordinary_test.rb```:
+```ruby
+# Also you can write native Minitest::Test
+
+class OrdinaryTest < Minitest::Test
+  def test_fail
+    assert false
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/leoniv/ass_tests.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb'] + FileList['examples/*.rb']
+end
+
+task :default => :test

data/ass_tests.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ass_tests/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ass_tests"
+  spec.version       = AssTests::VERSION
+  spec.authors       = ["Leonid Vlasov"]
+  spec.email         = ["leoniv.vlasov@gmail.com"]
+
+  spec.summary       = %q{Framework for unit testing code written on 1C:Enterprise embedded programming language}
+  spec.description   = %q{It make possible to write tests for 1C:Enterprise on Ruby easy. Access to 1C runtime via OLE. Works only in Windows or Cygwin!!!}
+  spec.homepage      = "https://github.com/leoniv/ass_tests"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "ass_launcher"
+  spec.add_dependency "ass_maintainer-info_base"
+  spec.add_dependency "minitest", "> 5"
+  spec.add_dependency "minitest-hooks"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "mocha"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ass_tests"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/describe_infobase.rb

@@ -0,0 +1,81 @@
+require 'test_helper'
+require 'ass_tests/info_bases'
+
+AssTests::InfoBases.describe do
+  file :empty_ib do
+  # DescribeOptions
+    template nil # Путь к шаблону ИБ
+    fixtures nil # Объект реализующий интрфейс AssTests::FixturesInterface для
+     # заполнения ИБ
+    maker nil # Объект реализующий интерфейс AssTests::IbMakerInterface создающий
+     # ИБ
+    destroyer nil # Объект реализующий интерфейс AssTests::IbDistroyerInterface
+     # уничтожающий ИБ
+    platform_require ENV['ASS_PLATFORM']
+    before_make ->(ib) { puts "Before make #{ib.name}"}
+    after_make ->(ib) { puts "After make #{ib.name}"}
+    before_rm ->(ib) { puts "Before rm #{ib.name}"}
+    after_rm ->(ib) { puts "After rm #{ib.name}"}
+  # CommonDescriber
+    locale nil
+    user 'name'
+    password 'password'
+  # FileIb
+    directory File.expand_path('../../tmp', __FILE__)
+  end
+
+  server :empty_server_ib do
+  # DescribeOptions
+    template nil
+    fixtures nil
+    maker nil
+    destroyer nil
+    platform_require '~> 8.3.8'
+    before_make nil
+    after_make nil
+    before_rm nil
+    after_rm nil
+  # CommonDescriber
+    locale nil
+    user 'name'
+    password 'password'
+  # ServerIb
+    agent ENV['ASS_SERVER_AGENT'] # --host 'host:port' --user 'admin' --password 'password'
+    claster ENV['ASS_CLASTER'] # --host 'host:port' --user 'admin' --password 'password'
+    db ENV['EMPTY_DATA_BASE'] # --host 'host:port' --dbms 'MSSQLServer' --db-name 'db_name' --user 'admin' --password 'password' --create-db
+    #db "--host 'host:port' --dbms 'MSSQLServer' --db-name 'db_name' --user 'admin' --password 'password' --create-db"
+    schjobdn # Запрет заданий см строка соединения
+  end
+
+  external :acc30, AssTestsTest::Tmp::EXTERNAL_IB_CS do
+    platform_require '>= 8.3'
+  end
+end
+
+module ExampleTest
+  describe 'smoky test' do
+    it 'empty_ib exists' do
+      AssTests::InfoBases[:empty_ib].must_be_instance_of\
+        AssTests::InfoBases::InfoBase
+      AssTests::InfoBases[:empty_ib].is?(:file).must_equal true
+      AssTests::InfoBases[:empty_ib].read_only?.must_equal false
+    end
+
+    it 'empty_server_ib exists' do
+      proc {
+        AssTests::InfoBases[:empty_server_ib].must_be_instance_of\
+          AssTests::InfoBases::InfoBase
+        AssTests::InfoBases[:empty_server_ib].is?(:server).must_equal true
+        AssTests::InfoBases[:empty_server_ib].read_only?.must_equal false
+      }.must_raise NotImplementedError
+    end
+
+    it 'acc30 exists' do
+      AssTests::InfoBases[:acc30].must_be_instance_of\
+        AssTests::InfoBases::InfoBase
+      AssTests::InfoBases[:acc30].is?(:file).must_equal true
+      AssTests::InfoBases[:acc30].read_only?.must_equal true
+      AssTests::InfoBases[:acc30].platform_require.must_equal '>= 8.3'
+    end
+  end
+end

data/lib/ass_tests.rb

@@ -0,0 +1,16 @@
+module AssTests
+  class ConfigureError < StandardError; end
+  require 'ass_tests/version'
+  require 'ass_tests/config'
+  require 'ass_tests/fixt'
+  require 'ass_tests/externals'
+  require 'ass_tests/info_bases'
+end
+
+class WIN32OLERuntimeError
+  old_message = instance_method(:message)
+  define_method(:message) do
+    old_message.bind(self).call.force_encoding('ASCII-8BIT')\
+      .split('HRESULT')[0].force_encoding('UTF-8').strip
+  end
+end

data/lib/ass_tests/ass_dummy.rb

@@ -0,0 +1,24 @@
+module AssTests
+  module AssDummy
+    def ass_dummy(obj)
+      eval("#{obj}").new
+    end
+    class Query
+      attr_accessor :МенеджерВременныхТаблиц, :TempTablesManager,
+        :Параметры, :Parameters,
+        :Текст, :Text
+      attr_reader :Выполнить, :Execute,
+        :ВыполнитьПакет, :ExecuteBatch,
+        :ВыполнитьПакетСПромежуточнымиДанными, :ExecuteBatchWithIntermediateData,
+        :НайтиПараметры, :FindParameters,
+        :УстановитьПараметр, :SetParameter
+    end
+
+    class QueryResult
+      attr_reader :Колонки, :Columns,
+        :Выбрать, :Select,
+        :Выгрузить, :Unload,
+        :Пустой, :IsEmpty
+    end
+  end
+end

data/lib/ass_tests/config.rb

@@ -0,0 +1,47 @@
+module AssTests
+  require 'ass_launcher'
+  require 'tmpdir'
+  TEST_INFOBASE_DIRECTORY = Dir.tmpdir
+  ASS_PLATFORM_REQUIRE = ENV['ASS_PLATFORM_REQUIRE'] || '> 0'
+  TEST_INFOBASE_DB = ENV['TEST_INFOBASE_DB'] ||\
+    '--dbms MSSQLServer --host 127.0.0.1,1433 --user USR1CV8'
+  TEST_INFOBASE_CLASTER = ENV['TEST_INFOBASE_CLASTER'] ||\
+    '--host 127.0.0.1:1541'
+  TEST_INFOBASE_SERVER_AGENT = ENV['TEST_INFOBASE_SERVER_AGENT'] ||\
+    '--host 127.0.0.1:1540'
+
+  def self.configure
+    yield config
+  end
+
+  def self.config
+    @config ||= Config.new
+  end
+
+  class Config
+    attr_writer :platform_require
+    def platform_require
+      @platform_require ||= ASS_PLATFORM_REQUIRE
+    end
+
+    attr_writer :test_infobase_directory
+    def test_infobase_directory
+      @test_infobase_directory ||= TEST_INFOBASE_DIRECTORY
+    end
+
+    attr_writer :test_infobase_db
+    def test_infobase_db
+      @test_infobase_db ||= TEST_INFOBASE_DB
+    end
+
+    attr_writer :test_infobase_claster
+    def test_infobase_claster
+      @test_infobase_claster ||= TEST_INFOBASE_CLASTER
+    end
+
+    attr_writer :test_infobase_server_agent
+    def test_infobase_server_agent
+      @test_infobase_server_agent ||= TEST_INFOBASE_SERVER_AGENT
+    end
+  end
+end

data/lib/ass_tests/externals.rb

@@ -0,0 +1,135 @@
+module AssTests
+  module Support
+    def underscore(camel_cased_word)
+      return camel_cased_word unless camel_cased_word =~ /[A-Z-]|::/
+      word = camel_cased_word.to_s.gsub(/::/, '/')
+#      word.gsub!(/(?:(?<=([A-Za-z\d]))|\b)(#{inflections.acronym_regex})(?=\b|[^a-z])/) { "#{$1 && '_'}#{$2.downcase}" }
+      word.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
+      word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+      word.tr!("-", "_")
+      word.downcase!
+      word
+    end
+
+    extend self
+  end
+  # Externals 1C dataprocessor and report
+  module Externals
+    require 'ass_launcher'
+    class Processor
+      attr_reader :path, :root
+      def initialize(path, root)
+        @path = AssLauncher::Support::Platforms.path(path.to_s).realpath
+        @root = AssLauncher::Support::Platforms.path(root)
+      end
+
+      def exist?
+        path.exist?
+      end
+
+      def manager
+        :ExternalDataProcessors
+      end
+
+      def self.file_ext
+        '.epf'
+      end
+
+      def file_ext
+        self.class.file_ext
+      end
+
+      # It work only for :thick, :external
+      def create(ole_connector, safe_mode = false)
+        ole_connector.send(manager).create(connect(ole_connector, safe_mode))
+      end
+
+      def connect(ole_connector, safe_mode = false)
+        fail "External not exist `#{path}'" unless exist?
+        dd = ole_connector.newObject('BinaryData', path.win_string)
+        link = ole_connector.PutToTempStorage(dd)
+        ole_connector.send(manager).connect(link, name_for_ass, safe_mode)
+      end
+
+      def connected?(ole_connector)
+        begin
+          ole_connector.send(manager).create(name_for_ass)
+        rescue WIN32OLERuntimeError
+          return false
+        end
+        return true
+      end
+
+      # It work only :thick
+      # @todo implemets form opts
+      def get_form(ole_connector, name, safe_mode = false, **opts)
+        #ole_connector.send(manager).getForm(path.win_string, name.to_s)
+      #  create(ole_connector).getForm(name.to_s)
+        ole_connector.getForm(form_full_name(connect(ole_connector, safe_mode),
+                                             name))
+      end
+
+      def form_full_name(external_name, form_name)
+        "#{manager.to_s.gsub(/s\z/,'')}.#{external_name}.Form.#{form_name}"
+      end
+
+      def name
+        path.relative_path_from(root).to_s
+      end
+
+      def name_for_ass
+        name.gsub('.','_').gsub(/(\/\\)/,'_')
+      end
+    end
+
+    class Report < Processor
+      def manager
+        :ExternalReports
+      end
+
+      def self.file_ext
+        '.erf'
+      end
+    end
+
+    def self.root=(path)
+      @root = path
+    end
+
+    def self.root
+      fail 'Specify AssTests::Externals.root= path'\
+        unless @root
+      @root
+    end
+
+    def self.externals
+      r = {}
+      Dir.glob(File.join(root,'**/*.{epf,erf}')) do |f|
+        ext = new(f)
+        r[ext.name] = ext
+      end
+      r
+    end
+
+    def self.get(name)
+      externals[name] || fail(ArgumentError, "Uncknown external `#{name}'")
+    end
+
+    def self.new(path)
+      klass(path).new(path, root)
+    end
+
+    KLASES = {'.epf' => Processor,
+              '.erf' => Report
+    }
+
+    def self.klass(path)
+      KLASES[File.extname(path).downcase] ||\
+        fail(ArgumentError, "Uncknown external `#{path}'")
+    end
+
+    def external
+      @external ||= AssTests::Externals.get(external_name)
+    end
+  end
+end