razorrisk-razor-control 0.1

data/test/unit/control/razor/tc_razor_instance.rb

@@ -0,0 +1,517 @@
+#! /usr/bin/env ruby
+
+# ######################################################################## #
+#
+#  Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+$:.unshift File.join(File.dirname(__FILE__), *(['..'] * 4), 'lib')
+
+unless $DEBUG
+
+    require 'pantheios/globals'
+    require 'pantheios/services/null_log_service'
+
+    ::Pantheios::Globals.INITIAL_SERVICE_CLASSES = [ ::Pantheios::Services::NullLogService ]
+end
+
+require 'razor_risk/razor/control/exceptions'
+
+require 'razor_risk/razor/control/razor/razor_instance'
+require 'razor_risk/razor/control/razor/executor'
+
+require 'xqsr3/extensions/test/unit'
+
+require 'test/unit'
+
+require 'fileutils'
+require 'tmpdir'
+
+class Test_Config < Test::Unit::TestCase
+
+    include ::RazorRisk::Razor::Control::Razor
+
+    def test_Config_is_a_class
+
+        assert_kind_of ::Class, Config
+    end
+
+    def test_can_be_initialised
+
+        assert_nothing_raised do
+            Config.new('Name', 'path', 'path', '1_start.cmd', '4_rebuild.cmd')
+        end
+    end
+
+    def test_sets_attributes
+
+        name           = 'name'
+        path           = 'path'
+        script_dir     = 'script_dir'
+        tod_script     = 'tod_script'
+        rebuild_script = 'rebuild_script'
+
+        config = Config.new(
+            name,
+            path,
+            script_dir,
+            tod_script,
+            rebuild_script,
+        )
+
+        assert_equal name, config.name
+        assert_equal path, config.path
+        assert_equal script_dir, config.script_dir
+        assert_equal tod_script, config.tod_script
+        assert_equal rebuild_script, config.rebuild_script
+    end
+end
+
+class Test_RazorInstance < Test::Unit::TestCase
+
+    include ::RazorRisk::Razor::Control::Exceptions
+    include ::RazorRisk::Razor::Control::Razor
+
+    def test_RazorInstance_is_a_class
+
+        assert_kind_of ::Class, RazorInstance
+    end
+
+    def test_initialize_fails_if_directory_does_not_exist
+
+        config = Config.new(
+            'StandardConfig',
+            'config/StandardConfig',
+            'config',
+            '1_start.cmd',
+            '4_rebuild.cmd',
+        )
+
+        assert_raise_with_message(
+            RazorControlException,
+            /Razor directory.*does not exist/
+        ) do
+            RazorInstance.new(
+                'some_dir',
+                'some_env',
+                [config],
+            )
+        end
+    end
+
+    def test_initialize_fails_if_directory_is_a_file
+
+        config = Config.new(
+            'StandardConfig',
+            'config/StandardConfig',
+            'config',
+            '1_start.cmd',
+            '4_rebuild.cmd',
+        )
+
+        Dir.mktmpdir do |dir|
+            file = File.join(dir, 'file')
+            FileUtils.touch(file)
+            assert_raise_with_message(
+                RazorControlException,
+                /Razor directory.*is not a directory/
+            ) do
+                RazorInstance.new(
+                    file,
+                    'some_env',
+                    [config],
+                )
+            end
+        end
+    end
+
+    def test_initialize_fails_if_no_configs_supplied
+
+        Dir.mktmpdir do |dir|
+            assert_raise_with_message(
+                RazorControlException,
+                /must have at least one config defined/
+            ) do
+                RazorInstance.new(
+                    dir,
+                    'some_env',
+                    [],
+                )
+            end
+        end
+    end
+
+    def test_initialize_fails_if_config_path_is_not_a_directory
+
+        Dir.mktmpdir do |dir|
+
+            file = File.join(dir, 'file')
+            FileUtils.touch(file)
+
+            config = Config.new(
+                'StandardConfig',
+                'file',
+                'config',
+                '1_start.cmd',
+                '4_rebuild.cmd',
+            )
+
+            assert_raise_with_message(
+                RazorControlException,
+                /did not have an existing directory path/
+            ) do
+                RazorInstance.new(
+                    dir,
+                    'some_env',
+                    [config],
+                )
+            end
+        end
+    end
+
+    def test_can_be_initialize
+
+        Dir.mktmpdir do |dir|
+
+            path = File.join(dir, 'path')
+            FileUtils.mkdir(path)
+
+            config = Config.new(
+                'StandardConfig',
+                'path',
+                'config',
+                '1_start.cmd',
+                '4_rebuild.cmd',
+            )
+
+            assert_nothing_raised do
+                RazorInstance.new(
+                    dir,
+                    'some_env',
+                    [config],
+                )
+            end
+        end
+    end
+
+    def test_kill_fails_if_file_does_not_exist
+
+        Dir.mktmpdir do |dir|
+
+            executor = MockExecutor.new([])
+
+            path = File.join(dir, 'path')
+            FileUtils.mkdir(path)
+
+            config = Config.new(
+                'StandardConfig',
+                'path',
+                'config',
+                '1_start.cmd',
+                '4_rebuild.cmd',
+            )
+
+            r = RazorInstance.new(
+                dir,
+                'some_env',
+                [ config ],
+                executor: executor,
+            )
+
+            assert_raise_with_message(
+                RazorControlException,
+                /file.*does not exist/
+            ) do
+                r.kill
+            end
+        end
+    end
+
+    def test_kill_uses_correct_command
+
+        Dir.mktmpdir do |dir|
+
+            env            = 'env'
+            name           = 'name'
+            path           = 'path'
+            script_dir     = 'script_dir'
+            tod_script     = 'tod_script'
+            rebuild_script = 'rebuild_script'
+            codes          = [ 0, 1, 2 ]
+
+            config = Config.new(
+                name,
+                path,
+                script_dir,
+                tod_script,
+                rebuild_script,
+            )
+
+            config_dir = File.join(dir, path)
+            Dir.mkdir(config_dir)
+
+            config_script_dir = File.join(config_dir, script_dir)
+            Dir.mkdir(config_script_dir)
+
+            FileUtils.touch(File.join(dir, 'razor_kill.cmd'))
+
+            executor = MockExecutor.new(*codes)
+
+            exp_opts = {
+                chdir: dir
+            }
+
+            r = RazorInstance.new(
+                dir,
+                env,
+                [ config ],
+                executor: executor,
+            )
+
+            assert_raise_with_message(::ArgumentError, /wrong number of arguments/i) do
+                r.kill 'abc'
+            end
+
+            assert_equal codes.shift, r.kill
+            assert_equal codes.shift, r.kill
+            assert_equal codes.shift, r.kill
+            assert_equal 'razor_kill.cmd', executor.commands.shift
+            assert_equal exp_opts, executor.opts.shift
+        end
+    end
+
+    def test_rebuild_fails_if_file_does_not_exist
+
+        Dir.mktmpdir do |dir|
+
+            executor = MockExecutor.new([])
+
+            path = File.join(dir, 'path')
+            FileUtils.mkdir(path)
+
+            script_dir = File.join(path, 'config')
+            FileUtils.mkdir(script_dir)
+
+            config = Config.new(
+                'StandardConfig',
+                'path',
+                'config',
+                '1_start.cmd',
+                '4_rebuild.cmd',
+            )
+
+            r = RazorInstance.new(
+                dir,
+                'some_env',
+                [ config ],
+                executor: executor,
+            )
+
+            assert_raise_with_message(
+                RazorControlException,
+                /file.*does not exist/
+            ) do
+                r.rebuild('StandardConfig')
+            end
+        end
+    end
+
+    def test_rebuild_uses_correct_command
+
+        Dir.mktmpdir do |dir|
+
+            codes    = [ 0, 1, 2 ]
+            executor = MockExecutor.new(*codes)
+
+            config = Config.new(
+                'StandardConfig',
+                'path',
+                'config',
+                '1_start.cmd',
+                '4_rebuild.cmd',
+            )
+
+            path = File.join(dir, config.path)
+            FileUtils.mkdir(path)
+
+            script_dir = File.join(path, config.script_dir)
+            FileUtils.mkdir(script_dir)
+
+            script = File.join(script_dir, config.rebuild_script)
+            FileUtils.touch(script)
+
+            exp_opts = {
+                chdir: script_dir
+            }
+
+            r = RazorInstance.new(
+                dir,
+                'some_env',
+                [ config ],
+                executor: executor,
+            )
+
+            assert_raise_with_message(
+                ::ArgumentError,
+                /wrong number of arguments/i
+            ) do
+                r.rebuild
+            end
+
+            assert_equal codes.shift, r.rebuild(config.name)
+            assert_equal codes.shift, r.rebuild(config.name)
+            assert_equal codes.shift, r.rebuild(config.name)
+            assert_equal config.rebuild_script, executor.commands.shift
+            assert_equal exp_opts, executor.opts.shift
+        end
+    end
+
+    def test_turn_of_day_fails_if_file_does_not_exist
+
+        Dir.mktmpdir do |dir|
+
+            executor = MockExecutor.new([])
+
+            config = Config.new(
+                'StandardConfig',
+                'path',
+                'config',
+                '1_start.cmd',
+                '4_rebuild.cmd',
+            )
+
+            path = File.join(dir, config.path)
+            FileUtils.mkdir(path)
+
+            script_dir = File.join(path, config.script_dir)
+            FileUtils.mkdir(script_dir)
+
+            config = Config.new(
+                'StandardConfig',
+                'path',
+                'config',
+                '1_start.cmd',
+                '4_rebuild.cmd',
+            )
+
+            r = RazorInstance.new(
+                dir,
+                'some_env',
+                [ config ],
+                executor: executor,
+            )
+
+            assert_raise_with_message(
+                RazorControlException,
+                /file.*does not exist/
+            ) do
+                r.turn_of_day('StandardConfig')
+            end
+        end
+    end
+
+    def test_turn_of_day_uses_correct_command
+
+        Dir.mktmpdir do |dir|
+
+            codes    = [ 0, 1, 2 ]
+            executor = MockExecutor.new(*codes)
+
+            config = Config.new(
+                'StandardConfig',
+                'path',
+                'config',
+                '1_start.cmd',
+                '4_rebuild.cmd',
+            )
+
+            path = File.join(dir, config.path)
+            FileUtils.mkdir(path)
+
+            script_dir = File.join(path, config.script_dir)
+            FileUtils.mkdir(script_dir)
+
+            script = File.join(script_dir, config.tod_script)
+            FileUtils.touch(script)
+
+            exp_opts = {
+                chdir: script_dir
+            }
+
+            r = RazorInstance.new(
+                dir,
+                'some_env',
+                [ config ],
+                executor: executor,
+            )
+
+            assert_raise_with_message(
+                ::ArgumentError,
+                /wrong number of arguments/i
+            ) do
+                r.rebuild
+            end
+
+            assert_equal codes.shift, r.turn_of_day(config.name)
+            assert_equal codes.shift, r.turn_of_day(config.name)
+            assert_equal codes.shift, r.turn_of_day(config.name)
+            assert_equal config.tod_script, executor.commands.shift
+            assert_equal exp_opts, executor.opts.shift
+        end
+    end
+
+    def test_works_with_no_script_directory
+
+        Dir.mktmpdir do |dir|
+
+            codes    = [ 0, 0, 0 ]
+            executor = MockExecutor.new(*codes)
+
+            config = Config.new(
+                'StandardConfig',
+                'path',
+                '',
+                '1_start.cmd',
+                '4_rebuild.cmd',
+            )
+
+            path = File.join(dir, config.path)
+            FileUtils.mkdir(path)
+
+            FileUtils.touch(File.join(dir, 'razor_kill.cmd'))
+            FileUtils.touch(File.join(path, config.rebuild_script))
+            FileUtils.touch(File.join(path, config.tod_script))
+
+            r = RazorInstance.new(
+                dir,
+                'some_env',
+                [ config ],
+                executor: executor,
+            )
+
+            assert_raise_with_message(
+                ::ArgumentError,
+                /wrong number of arguments/i
+            ) do
+                r.rebuild
+            end
+
+            assert_equal codes.shift, r.kill
+            assert_equal 'razor_kill.cmd', executor.commands.shift
+            assert_equal({ chdir: dir }, executor.opts.shift)
+
+            assert_equal codes.shift, r.turn_of_day(config.name)
+            assert_equal config.tod_script, executor.commands.shift
+            assert_equal({ chdir: "#{path}/" }, executor.opts.shift)
+
+            assert_equal codes.shift, r.rebuild(config.name)
+            assert_equal config.rebuild_script, executor.commands.shift
+            assert_equal({ chdir: "#{path}/" }, executor.opts.shift)
+        end
+    end
+end
+
+# ############################## end of file ############################# #
+
+

data/test/unit/control/razor/test_scripts/exit_failure.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+exit 1

data/test/unit/control/razor/test_scripts/exit_strange.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+exit 128

data/test/unit/control/razor/test_scripts/exit_success.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+exit 0

data/test/unit/control/razor/test_scripts/pause.cmd

@@ -0,0 +1,5 @@
+@echo off
+
+pause
+
+exit 0

data/test/unit/control/razor/test_scripts/print.cmd

@@ -0,0 +1,6 @@
+@echo off
+
+echo stdout
+echo stderr 1>&2
+
+exit 0

data/test/unit/control/tc_exceptions.rb

@@ -0,0 +1,120 @@
+#! /usr/bin/env ruby
+
+# ######################################################################## #
+#
+#  Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+$:.unshift File.join(File.dirname(__FILE__), *(['..'] * 3), 'lib')
+
+unless $DEBUG
+
+    require 'pantheios/globals'
+    require 'pantheios/services/null_log_service'
+
+    ::Pantheios::Globals.INITIAL_SERVICE_CLASSES = [ ::Pantheios::Services::NullLogService ]
+end
+
+require 'razor_risk/razor/control/exceptions'
+
+require 'xqsr3/extensions/test/unit'
+
+require 'test/unit'
+
+class Test_Control_Exceptions < Test::Unit::TestCase
+
+    class Test_ControlException < Test::Unit::TestCase
+
+        include ::RazorRisk::Razor::Control::Exceptions
+
+        class ArbitraryChildException < ControlException; end
+
+        def test_EntityConnectorException_is_a_class
+
+            assert_kind_of ::Class, ControlException
+        end
+
+        def test_EntityConnectorException_is_abstract
+
+            assert_raise_with_message(
+                ::NoMethodError,
+                /private method.*new.*called for.*RazorRisk::Razor::Control::Exceptions::ControlException/
+            ) do
+                ControlException.new
+            end
+        end
+
+        def test_ArbitraryChildException_is_not_abstract
+
+            assert_not_nil ArbitraryChildException.new('some message', an_option: true, another_option: false)
+        end
+    end
+
+    class Test_GemDeploymentException < Test::Unit::TestCase
+
+        include ::RazorRisk::Razor::Control::Exceptions
+
+        def test_GemDeploymentException_is_a_class
+
+            assert_kind_of ::Class, GemDeploymentException
+        end
+
+        def test_GemDeploymentException_can_be_constructed
+
+            assert_nothing_raised do
+                GemDeploymentException.new 'some message'
+            end
+        end
+
+        def test_GemDeploymentException_can_thrown
+
+            msg = 'some message'
+            assert_raise_with_message(GemDeploymentException, msg) do
+
+                raise GemDeploymentException.new msg
+            end
+        end
+    end
+
+    class Test_RazorControlException < Test::Unit::TestCase
+
+        include ::RazorRisk::Razor::Control::Exceptions
+
+        def test_RazorControlException_is_a_class
+
+            assert_kind_of ::Class, RazorControlException
+        end
+
+        def test_RazorControlException_can_be_constructed
+
+            assert_nothing_raised do
+                RazorControlException.new 'some message'
+            end
+        end
+
+        def test_RazorControlException_can_thrown
+
+            msg = 'some message'
+            assert_raise_with_message(RazorControlException, msg) do
+
+                raise RazorControlException.new msg
+            end
+        end
+    end
+
+    class Test_Control_exception_hierarchy < Test::Unit::TestCase
+
+        include ::RazorRisk::Razor::Control::Exceptions
+
+        def test_inheritance_relationships
+
+            assert_subclass_of(ControlException, GemDeploymentException)
+            assert_subclass_of(ControlException, RazorControlException)
+        end
+    end
+end
+
+# ############################## end of file ############################# #
+
+