barkest_core 1.5.3.0

data/test/models/barkest_core/database_config_test.rb

@@ -0,0 +1,33 @@
+module BarkestCore
+  class DatabaseConfigTest < ActiveSupport::TestCase
+
+    def setup
+      @item = BarkestCore::DatabaseConfig.new('my_db', adapter: :sqlite3, database: 'mydb.sqlite', pool: 5, timeout: 5000)
+    end
+
+    test 'should be valid' do
+      assert @item.valid?
+    end
+
+    test 'should require name' do
+      assert_required @item, :name
+    end
+
+    test 'should require adapter' do
+      assert_required @item, :adapter
+    end
+
+    test 'should require database' do
+      assert_required @item, :database
+    end
+
+    test 'should require pool' do
+      assert_required @item, :pool
+    end
+
+    test 'should require timeout' do
+      assert_required @item, :timeout
+    end
+
+  end
+end

data/test/models/barkest_core/date_parser_test.rb

@@ -0,0 +1,110 @@
+require 'test_helper'
+
+module BarkestCore
+  class DateParserTest < ActiveSupport::TestCase
+
+
+    test 'should parse valid date values' do
+      {
+          '1/1/2000'                => Time.utc(2000,1,1),
+          '01/01/00'                => Time.utc(2000,1,1),
+          '2000-01-01'              => Time.utc(2000,1,1),
+          '00-01-01'                => Time.utc(2000,1,1),
+          '0000-01-01'              => Time.utc(2000,1,1), # dates less than 100 are converted to 1940-2039.
+          '1/1/40'                  => Time.utc(1940,1,1),
+          '40-1-1'                  => Time.utc(1940,1,1),
+          '12/25/2016'              => Time.utc(2016,12,25),
+          '2016-12-25'              => Time.utc(2016,12,25),
+          '11/01/2015 1:45 PM'      => Time.utc(2015,11,1),
+          '2015-11-01 13:45'        => Time.utc(2015,11,1),
+      }.each do |k,v|
+        assert_equal v, BarkestCore::DateParser.parse_for_date_column(k), "#{k} should parse to #{v}"
+        assert_equal v.strftime("'%Y-%m-%d'"), BarkestCore::DateParser.parse_for_date_filter(k), "#{k} should filter to #{v.strftime("'%Y-%m-%d'")}"
+      end
+    end
+
+    test 'should nullify invalid date values' do
+      [
+          nil,
+          '',
+          '   ',
+          '25/12/2016',   # DD/MM/YYYY is not supported
+          '2016/12/25',   # YYYY/MM/DD is not supported
+          '2016.12.25',   # YYYY.MM.DD is not supported
+          '12-25-2016',   # MM-DD-YYYY is not supported
+          '25-12-2016',   # DD-MM-YYYY is not supported
+          '12.25.2016',   # MM.DD.YYYY is not supported
+          '0/0/0000',     # Invalid day & month.
+          '2/30/2000',    # Invalid day.
+          '13/13/2000',   # Invalid month.
+          '1/1/2000 24:01', # invalid time.
+          '1/1/2000 24:00:01', # invalid time.
+          'Sunday, December 25, 2016',  # only numeric dates are supported
+          'December 25, 2016',          # only numeric dates are supported
+      ].each do |v|
+        assert_nil BarkestCore::DateParser.parse_for_date_column(v), "#{v.inspect} should parse to nil"
+        assert_equal "NULL", BarkestCore::DateParser.parse_for_date_filter(v), "#{v.inspect} should parse to NULL"
+      end
+    end
+
+    test 'should parse valid time values' do
+      {
+          '1/1/2000 00:00'          => Time.utc(2000,1,1),
+          '01/01/00 00:00'          => Time.utc(2000,1,1),
+          '2000-01-01 00:00'        => Time.utc(2000,1,1),
+          '00-01-01 00:00'          => Time.utc(2000,1,1),
+          '1/1/40 00:00'            => Time.utc(1940,1,1),
+          '40-1-1 00:00'            => Time.utc(1940,1,1),
+          '12/25/2016 00:00'        => Time.utc(2016,12,25),
+          '2016-12-25 00:00'        => Time.utc(2016,12,25),
+          '11/01/2015 1:45 PM'      => Time.utc(2015,11,1,13,45),
+          '2015-11-01 13:45'        => Time.utc(2015,11,1,13,45),
+          '12:15 AM'                => Time.utc(1900,1,1,0,15),
+          '12:15 PM'                => Time.utc(1900,1,1,12,15),
+          '00:15'                   => Time.utc(1900,1,1,0,15),
+          '12:15'                   => Time.utc(1900,1,1,12,15),
+          '2:30 PM'                 => Time.utc(1900,1,1,14,30),
+          '2:30 AM'                 => Time.utc(1900,1,1,2,30),
+          '18:45:50'                => Time.utc(1900,1,1,18,45,50),
+          '6:45:50 AM'              => Time.utc(1900,1,1,6,45,50),
+          '6:45:50 PM'              => Time.utc(1900,1,1,18,45,50),
+          '12/25/2016 9:05:10 AM'   => Time.utc(2016,12,25,9,5,10),
+          '12/25/2016 9:05:10 PM'   => Time.utc(2016,12,25,21,5,10),
+          '1/1/2000 24:00'          => Time.utc(2000,1,2,0,0),   # 24:00 is 00:00 the next day.
+      }.each do |k,v|
+        assert_equal v, BarkestCore::DateParser.parse_for_time_column(k), "#{k} should parse to #{v}"
+        assert_equal v.strftime("'%Y-%m-%d %H:%M:%S'"), BarkestCore::DateParser.parse_for_time_filter(k), "#{k} should filter to #{v.strftime("'%Y-%m-%d %H:%M:%S'")}"
+      end
+    end
+
+    test 'should nullify invalid time values' do
+      [
+          nil,
+          '',
+          '   ',
+          '25/12/2016 00:00',   # DD/MM/YYYY is not supported
+          '2016/12/25 00:00',   # YYYY/MM/DD is not supported
+          '2016.12.25 00:00',   # YYYY.MM.DD is not supported
+          '12-25-2016 00:00',   # MM-DD-YYYY is not supported
+          '25-12-2016 00:00',   # DD-MM-YYYY is not supported
+          '12.25.2016 00:00',   # MM.DD.YYYY is not supported
+          '0/0/0000 00:00',     # Invalid day & month.
+          '2/30/2000 00:00',    # Invalid day.
+          '13/13/2000 00:00',   # Invalid month.
+          '25:00',              # invalid hour
+          '23:66',              # invalid minute
+          '23:59:66',           # invalid second
+          '13:00 PM',           # invalid mixed 12/24
+          '13:00 AM',           # invalid mixed 12/24
+          '00:00 PM',           # invalid mixed 12/24
+          '00:00 AM',           # invalid mixed 12/24
+          'Sunday, December 25, 2016 12:18 AM',  # only numeric dates are supported
+          'December 25, 2016 12:18 AM',          # only numeric dates are supported
+      ].each do |v|
+        assert_nil BarkestCore::DateParser.parse_for_date_column(v), "#{v.inspect} should parse to nil"
+        assert_equal "NULL", BarkestCore::DateParser.parse_for_date_filter(v), "#{v.inspect} should parse to NULL"
+      end
+    end
+
+  end
+end

data/test/models/barkest_core/email_config_test.rb

@@ -0,0 +1,57 @@
+module BarkestCore
+  class EmailConfigTest < ActiveSupport::TestCase
+
+    def setup
+      @item = BarkestCore::EmailConfig.new(config_mode: :none, default_sender: 'abc@xyz.com', default_recipient: 'abc@xyz.com', default_hostname: 'xyz.com')
+      @item2 = @item.dup
+      @item2.config_mode = 'smtp'
+      @item2.address = 'localhost'
+      @item2.port = 25
+      @item2.authentication = 'none'
+    end
+
+    test 'should be valid' do
+      assert @item.valid?, 'item 1 is invalid'
+      assert @item2.valid?, 'item 2 is invalid'
+    end
+
+    test 'should require config_mode' do
+      assert_required @item, :config_mode
+      assert_required @item2, :config_mode
+    end
+
+    test 'should require default_sender' do
+      assert_required @item, :default_sender
+      assert_required @item2, :default_sender
+    end
+
+    test 'should require default_recipient' do
+      assert_required @item, :default_recipient
+      assert_required @item2, :default_recipient
+    end
+
+    test 'should require default_hostname' do
+      assert_required @item, :default_hostname
+      assert_required @item2, :default_hostname
+    end
+
+    test 'switching to smtp should invalidate item1' do
+      @item.config_mode = 'smtp'
+      assert_not @item.valid?
+    end
+
+    test 'should require address for smtp' do
+      assert_required @item2, :address
+    end
+
+    test 'should require port for smtp' do
+      assert_required @item2, :port
+    end
+
+    test 'should require authentication for smtp' do
+      assert_required @item2, :authentication
+    end
+
+
+  end
+end

data/test/models/barkest_core/global_status_test.rb

@@ -0,0 +1,50 @@
+require 'test_helper'
+
+module BarkestCore
+  class GlobalStatusTest < ActiveSupport::TestCase
+
+    test 'should allow running code in a block' do
+      assert_not BarkestCore::GlobalStatus.locked?
+
+      BarkestCore::GlobalStatus.lock_for do |stat|
+        assert BarkestCore::GlobalStatus.locked?
+        assert stat
+
+        # set the status using our stat object.
+        stat.set_status 'Hello', 10
+        cur_stat = stat.get_status
+        assert_equal 'Hello', cur_stat[:message]
+        assert_equal 10, cur_stat[:percent].to_s.to_i
+
+        # verify the global status reports correctly.
+        cur_stat = BarkestCore::GlobalStatus.current
+        assert_equal 'Hello', cur_stat[:message]
+        assert_equal 10, cur_stat[:percent].to_s.to_i
+      end
+
+      # after the block, the status should be cleared.
+      cur_stat = BarkestCore::GlobalStatus.current
+      assert_not_equal 'Hello', cur_stat[:message]
+      assert_not_equal 10, cur_stat[:percent].to_s.to_i
+      assert_not BarkestCore::GlobalStatus.locked?
+    end
+
+    test 'should block code as necessary' do
+      stat = BarkestCore::GlobalStatus.new
+      assert_not BarkestCore::GlobalStatus.locked?
+      assert stat.acquire_lock
+      BarkestCore::GlobalStatus.lock_for do |my_stat|
+        assert BarkestCore::GlobalStatus.locked?
+        assert_not my_stat # should be false when already locked.
+      end
+      assert_raises BarkestCore::GlobalStatus::FailureToLock do
+        BarkestCore::GlobalStatus.lock_for(true) do |my_stat|
+          assert false, 'This block should not execute.'
+        end
+      end
+      assert BarkestCore::GlobalStatus.locked?
+      stat.release_lock
+    end
+
+  end
+end

data/test/models/barkest_core/ms_sql_db_updater_test.rb

@@ -0,0 +1,115 @@
+require 'test_helper'
+
+module BarkestCore
+  class MsSqlDbUpdaterTest < ActiveSupport::TestCase
+
+    TEST_DEFS = [
+        'CREATE TABLE [alpha_beta] ( [id] INTEGER IDENTITY NOT NULL PRIMARY KEY, [name] VARCHAR(30) NOT NULL )',
+        'CREATE VIEW [something] AS SELECT 1 AS [one], \'abc\' as [two]',
+        'CREATE FUNCTION [multiply] (@a INTEGER, @b INTEGER) RETURNS TABLE AS RETURN SELECT ISNULL(@a,0) * ISNULL(@b,0) AS [result]',
+        'CREATE VIEW [alpha_bravo] AS SELECT COUNT(*) AS [beta_count] FROM [@Z~alpha_beta]',    # referencing another object.
+        # A sample procedure that shows how a procedure can be used to enact more diverse updates.
+        # For instance, incremental table updates could be done with an ALTER, but they wouldn't necessarily be safe.
+        # Inside a procedure you can check for column existence and update as necessary, making the procedure safe to be
+        # called multiple times.  The updater only sees the procedure so it won't try to manage the updates carried out
+        # by the procedure.
+        <<-EOPROC
+CREATE PROCEDURE [add_delta]
+AS
+BEGIN
+  SET NOCOUNT ON;
+  DECLARE @cnt INTEGER;
+  SELECT @cnt=ISNULL((SELECT COUNT(*) FROM INFORMATION_SCHEMA.COLUMNS C WHERE C.[TABLE_NAME]='@Z~alpha_beta' AND C.[COLUMN_NAME]='delta'), 0);
+  IF @cnt <> 1
+  BEGIN
+    ALTER TABLE [@Z~alpha_beta] ADD [delta] FLOAT;
+    EXEC sp_sqlexec 'UPDATE [@Z~alpha_beta] SET [delta] = 1.0';
+    RETURN 1;
+  END
+  ELSE
+  BEGIN
+    RETURN 0;
+  END
+END
+EOPROC
+
+    ]
+
+    class CleanupConn < ActiveRecord::Base
+      self.abstract_class = true
+    end
+
+    test 'should be able to update MSSQL db' do
+      updater = ::BarkestCore::MsSqlDbDefinition.new
+
+      # add the sources.
+      TEST_DEFS.each do |test_def|
+        updater.add_source "-- #{Date.today.strftime('%Y-%m-%d')}\n" + test_def
+      end
+
+      cfg = BarkestCore.db_config(:ms_sql_test)
+      cntr = 0
+      begin
+        updater.update_db(
+            cfg,
+            before_update: Proc.new do |conn,user|
+              assert_equal cfg[:username], user
+              cntr = conn.exec_query("SELECT COUNT(*) AS [cnt] FROM [#{::BarkestCore::MsSqlDbDefinition::VERSION_TABLE_NAME}]").first['cnt']
+              updater.sources.each do |src|
+                assert_equal 0, conn.exec_query("SELECT COUNT(*) AS [cnt] FROM [#{::BarkestCore::MsSqlDbDefinition::VERSION_TABLE_NAME}] WHERE [object_name]='#{src.prefixed_name}'").first['cnt']
+                assert_not conn.object_exists?(src.prefixed_name)
+              end
+            end,
+            after_update: Proc.new do |conn,_|
+              assert_equal cntr + TEST_DEFS.count, conn.exec_query("SELECT COUNT(*) AS [cnt] FROM [#{::BarkestCore::MsSqlDbDefinition::VERSION_TABLE_NAME}]").first['cnt']
+              updater.sources.each do |src|
+                assert_equal 1, conn.exec_query("SELECT COUNT(*) AS [cnt] FROM [#{::BarkestCore::MsSqlDbDefinition::VERSION_TABLE_NAME}] WHERE [object_name]='#{src.prefixed_name}'").first['cnt']
+                assert conn.object_exists?(src.prefixed_name)
+              end
+              assert_not_equal 0, conn.exec_query("SELECT COUNT(*) AS [cnt] FROM [#{::BarkestCore::MsSqlDbDefinition::VERSION_TABLE_NAME}]").first['cnt']
+              assert_equal 1, conn.exec_query("SELECT [one] FROM [#{updater.object_name 'something'}]").first['one']
+              assert_equal 'abc', conn.exec_query("SELECT [two] FROM [#{updater.object_name 'something'}]").first['two']
+              assert_equal 20, conn.exec_query("SELECT [result] FROM [#{updater.object_name 'multiply'}](4, 5)").first['result']
+
+              (1..5).each do |i|
+                conn.exec_query "INSERT INTO [#{updater.object_name 'alpha_beta'}] ([name]) VALUES ('Number #{i}')"
+              end
+
+              # pass one, a return value of 1 indicates the SP made the necessary changes.
+              assert_equal 1, conn.exec_sp("EXECUTE [#{updater.object_name 'add_delta'}]")
+              # pass two, a return value of 0 indicates the SP didn't need to make changes.
+              assert_equal 0, conn.exec_sp("EXECUTE [#{updater.object_name 'add_delta'}]")
+
+              # Now we can directly access the new [delta] fields added to our table.
+              assert_equal 5, conn.exec_query("SELECT COUNT(*) AS [delta_count] FROM [#{updater.object_name 'alpha_beta'}] WHERE [delta]=1.0").first['delta_count']
+              # And the view should still work as well.
+              assert_equal 5, conn.exec_query("SELECT [beta_count] FROM [#{updater.object_name 'alpha_bravo'}]").first['beta_count']
+            end
+        )
+
+      rescue ::BarkestCore::MsSqlDbDefinition::NeedFullAccess => e
+        skip "Invalid test MSSQL configuration: #{e.message}"
+      ensure
+        begin
+          CleanupConn.remove_connection
+          CleanupConn.establish_connection cfg
+          conn = CleanupConn.connection
+          updater.sources.reverse.each do |test_def|
+            begin
+              conn.execute "DELETE FROM [#{::BarkestCore::MsSqlDbDefinition::VERSION_TABLE_NAME}] WHERE [object_name]='#{test_def.prefixed_name}'" rescue nil
+              conn.execute test_def.drop_sql rescue nil
+            rescue =>e
+              nil
+            end
+          end
+          CleanupConn.remove_connection
+        rescue
+          nil
+        end
+      end
+
+    end
+
+
+  end
+end

data/test/models/barkest_core/ms_sql_definition_test.rb

@@ -0,0 +1,102 @@
+require 'test_helper'
+
+module BarkestCore
+  class MsSqlDefinitionTest < ActiveSupport::TestCase
+
+    VALID_LIST = [
+        ['XYZ',     'VIEW', 'CREATE VIEW [XYZ] AS SELECT 123 AS [VALUE]'],
+        ['XYZ_123', 'VIEW', 'CREATE VIEW XYZ_123 AS SELECT \'ABC\'\'XYZ\' AS [123]'],
+        ['ABC',     'VIEW', "-- This is a comment about this view.\nCREATE VIEW [ABC] AS SELECT 1 AS [VALUE]\n/* Just a simple comment. */"],
+        ['ABC_123', 'VIEW', "CREATE VIEW ABC_123 AS SELECT 1 AS [Index]\nUNION SELECT 2\nUNION SELECT 3\n-- This is not a drop statement."],
+
+        ['AEIOU',   'FUNCTION', 'CREATE FUNCTION [AEIOU] (@num AS INTEGER) RETURNS TABLE AS SELECT ISNULL(@num,0) * 5 AS [five_times_more]'],
+
+        ['ZYX',     'TABLE', 'CREATE TABLE [ZYX] ([id] INTEGER NOT NULL PRIMARY KEY, [name] VARCHAR(200))'],
+        ['ZYX',     'TABLE', 'ALTER TABLE [ZYX] ADD COLUMN [col2] INTEGER'],
+    ]
+
+    INVALID_LIST = [
+        [
+            BarkestCore::MsSqlDefinition::EmptyDefinition,
+            ''
+        ],
+        [
+            BarkestCore::MsSqlDefinition::EmptyDefinition,
+            "-- This is a comment\n-- This is another comment\n/* And a final comment.\nNote that this definition still has no content.\n/* We should also support embedded comments */ because they may occur. */"
+        ],
+        [
+            BarkestCore::MsSqlDefinition::MissingCreateStatement,
+            'SELECT 1 AS Value'
+        ],
+        [
+            BarkestCore::MsSqlDefinition::ExtraDDL,
+            "CREATE VIEW XYZ AS SELECT 1 AS [Value]\nCREATE VIEW ABC AS SELECT 2 AS [Value]"
+        ],
+        [
+            BarkestCore::MsSqlDefinition::ExtraDDL,
+            "create view xyz as select 1 as [value]\ndrop view xyz"
+        ],
+        [
+            BarkestCore::MsSqlDefinition::UnmatchedBracket,
+            'create view xyz as select 1 as [value, 2 as [another_value]'
+        ],
+        [
+            BarkestCore::MsSqlDefinition::UnmatchedBracket,
+            'create view xyz as select 1 as [value]]'
+        ],
+        [
+            BarkestCore::MsSqlDefinition::UnclosedQuote,
+            "create view xyz as select 'hello as [value]"
+        ],
+        [
+            BarkestCore::MsSqlDefinition::UnclosedQuote,
+            "create view xyz as select 'hello 'world' as value"
+        ],
+        [
+            BarkestCore::MsSqlDefinition::UnclosedQuote,
+            "create view xyz as select 1 as \"value"
+        ],
+        [
+            BarkestCore::MsSqlDefinition::UnclosedQuote,
+            "create view xyz as select 1 as value\""
+        ],
+        [
+            BarkestCore::MsSqlDefinition::UnmatchedComment,
+            'create view xyz as select 1 as value /* /* a comment that was opened twice */'
+        ],
+        [
+            BarkestCore::MsSqlDefinition::UnmatchedComment,
+            'create view xyz as select 1 as value /* a comment that is closed twice */ */'
+        ],
+        [
+            BarkestCore::MsSqlDefinition::MissingReturnType,
+            'create function xyz (alpha integer) as select alpha'
+        ],
+        [   # alter is only valid for tables (for our purposes) since views and functions are recreated.
+            BarkestCore::MsSqlDefinition::MissingCreateStatement,
+            'alter function xyz (@alpha integer) returns table as select @alpha'
+        ],
+    ]
+
+    test 'should be valid samples' do
+      VALID_LIST.each_with_index do |(name,type,sql), index|
+        begin
+          d = MsSqlDefinition.new(sql)
+        rescue MsSqlDefinition::InvalidDefinition => e
+          raise Minitest::Assertion, "Encountered #{e.class} error when processing statement #{index}."
+        end
+        assert_equal name, d.name, "Name mismatch error #{d.name.inspect} <> #{name.inspect} for statement #{index}."
+        assert_equal type, d.type, "Type mismatch error #{d.type.inspect} <> #{type.inspect} for statement #{index}."
+      end
+    end
+
+    test 'should be invalid samples' do
+      INVALID_LIST.each_with_index do |(error,sql),index|
+        assert_raises error, "Expected error of type #{error} for statement #{index}." do
+          MsSqlDefinition.new(sql)
+        end
+      end
+    end
+
+  end
+end