razorrisk-cassini-common 0.26.24

data/test/unit/applications/route_verb_adaptors/utilities/tc_collection_get_helper.rb

@@ -0,0 +1,236 @@
+#! /usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *(['..'] * 5), 'lib')
+
+require 'simplecov'
+
+require 'razor_risk/cassini/testing/suppress_pantheios_logging' unless $DEBUG
+
+require 'razor_risk/cassini/applications/route_verb_adaptors/utilities/collection_get_helper'
+
+require 'xqsr3/extensions/test/unit'
+require 'test/unit'
+
+class Test_CollectionGetHelper_validate_exclusive_search_parameters < Test::Unit::TestCase
+
+    include ::RazorRisk::Cassini::Applications::RouteVerbAdaptors::Utilities::CollectionGetHelper
+
+    def halt code, headers, body_lines
+
+        if code && headers.nil?
+
+            headers = {}
+        end
+
+        if code && body_lines.nil?
+
+            body_lines = []
+        end
+
+        if ::String === body_lines
+
+            body_lines = [ body_lines ]
+        end
+
+
+        @code       =   code
+        @headers    =   headers
+        @body_lines =   body_lines
+
+        nil
+    end
+
+    attr_reader :code
+    attr_reader :headers
+    attr_reader :body_lines
+
+    def test_empty_params
+
+        halt nil, nil, nil
+
+        r   =   validate_exclusive_search_parameters({})
+
+        assert r
+
+
+        halt nil, nil, nil
+
+        r   =   validate_exclusive_search_parameters({}, 'filter-name')
+
+        assert r
+        assert_nil code
+        assert_nil headers
+        assert_nil body_lines
+
+
+        halt nil, nil, nil
+
+        r   =   validate_exclusive_search_parameters({}, 'field-search', 'filter-name', 'quick-search')
+
+        assert r
+        assert_nil code
+        assert_nil headers
+        assert_nil body_lines
+    end
+
+    def test_non_conflicts
+
+        param_names =   [
+
+            'field-search',
+            'filter-name',
+            'quick-search',
+        ]
+
+        halt nil, nil, nil
+
+        r   =   validate_exclusive_search_parameters({}, *param_names)
+
+        assert r
+        assert_nil code
+        assert_nil headers
+        assert_nil body_lines
+
+
+        halt nil, nil, nil
+
+        r   =   validate_exclusive_search_parameters({ 'field-search' => 'abc' }, *param_names)
+
+        assert r
+        assert_nil code
+        assert_nil headers
+        assert_nil body_lines
+
+
+        halt nil, nil, nil
+
+        r   =   validate_exclusive_search_parameters({ 'filter-name' => 'abc' }, *param_names)
+
+        assert r
+        assert_nil code
+        assert_nil headers
+        assert_nil body_lines
+
+
+        halt nil, nil, nil
+
+        r   =   validate_exclusive_search_parameters({ 'quick-search' => 'abc' }, *param_names)
+
+        assert r
+        assert_nil code
+        assert_nil headers
+        assert_nil body_lines
+
+
+        halt nil, nil, nil
+
+        r   =   validate_exclusive_search_parameters({ 'other-param' => 'xyz', 'field-search' => 'abc' }, *param_names)
+
+        assert r
+        assert_nil code
+        assert_nil headers
+        assert_nil body_lines
+
+
+        halt nil, nil, nil
+
+        r   =   validate_exclusive_search_parameters({ 'other-param' => 'xyz', 'filter-name' => 'abc' }, *param_names)
+
+        assert r
+        assert_nil code
+        assert_nil headers
+        assert_nil body_lines
+
+
+        halt nil, nil, nil
+
+        r   =   validate_exclusive_search_parameters({ 'other-param' => 'xyz', 'quick-search' => 'abc' }, *param_names)
+
+        assert r
+        assert_nil code
+        assert_nil headers
+        assert_nil body_lines
+    end
+
+    def test_conflicts
+
+        param_names =   [
+
+            'quick-search',
+            'field-search',
+            'filter-name',
+        ]
+
+
+        halt nil, nil, nil
+
+        validate_exclusive_search_parameters({ 'field-search' => 'abc', 'filter-name' => 'xyz' }, *param_names)
+
+        assert_equal 422, code
+        assert_not_nil headers
+        assert_empty headers
+        assert_match /invalid search specifier: cannot specify 'field-search' and 'filter-name' together/, body_lines[0]
+
+
+        halt nil, nil, nil
+
+        validate_exclusive_search_parameters({ 'filter-name' => 'abc', 'quick-search' => 'xyz' }, *param_names)
+
+        assert_equal 422, code
+        assert_not_nil headers
+        assert_empty headers
+        assert_match /invalid search specifier: cannot specify 'filter-name' and 'quick-search' together/, body_lines[0]
+
+
+        halt nil, nil, nil
+
+        validate_exclusive_search_parameters({ 'quick-search' => 'abc', 'field-search' => 'xyz' }, *param_names)
+
+        assert_equal 422, code
+        assert_not_nil headers
+        assert_empty headers
+        assert_match /invalid search specifier: cannot specify 'field-search' and 'quick-search' together/, body_lines[0]
+    end
+
+    def test_conflicts_with_custom_message_scope_and_halt_code
+
+        param_names =   [
+
+            'quick-search',
+            'field-search',
+            'filter-name',
+        ]
+
+
+        halt nil, nil, nil
+
+        validate_exclusive_search_parameters({ 'field-search' => 'abc', 'filter-name' => 'xyz' }, *param_names, halt_code: 555, message_scope: 'incompatible search specifiers')
+
+        assert_equal 555, code
+        assert_not_nil headers
+        assert_empty headers
+        assert_match /incompatible search specifiers: cannot specify 'field-search' and 'filter-name' together/, body_lines[0]
+
+
+        halt nil, nil, nil
+
+        validate_exclusive_search_parameters({ 'filter-name' => 'abc', 'quick-search' => 'xyz' }, *param_names, halt_code: 555, message_scope: '')
+
+        assert_equal 555, code
+        assert_not_nil headers
+        assert_empty headers
+        assert_match /cannot specify 'filter-name' and 'quick-search' together/, body_lines[0]
+
+
+        halt nil, nil, nil
+
+        validate_exclusive_search_parameters({ 'quick-search' => 'abc', 'field-search' => 'xyz' }, *param_names, halt_code: 555, message_scope: nil)
+
+        assert_equal 555, code
+        assert_not_nil headers
+        assert_empty headers
+        assert_match /invalid search specifier: cannot specify 'field-search' and 'quick-search' together/, body_lines[0]
+    end
+end
+
+

data/test/unit/applications/tc_verb_handler.rb

@@ -0,0 +1,130 @@
+#!/usr/bin/env ruby
+
+# ######################################################################## #
+#
+#  Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+$:.unshift File.join(File.dirname(__FILE__), *(['..'] * 4), 'lib')
+
+require 'simplecov'
+
+unless $DEBUG
+
+    require 'pantheios/globals'
+    require 'pantheios/services/null_log_service'
+
+    ::Pantheios::Globals.INITIAL_SERVICE_CLASSES = [ ::Pantheios::Services::NullLogService ]
+end
+
+# ##########################################################
+# requires
+
+require 'razor_risk/cassini/applications/rest_framework/verb_handler'
+
+require 'xqsr3/extensions/test/unit'
+require 'test/unit'
+
+# ##########################################################
+# tests
+
+class Test_VerbHandler < Test::Unit::TestCase
+
+    include ::RazorRisk::Cassini::Applications::RESTFramework
+
+    App      = Struct.new(:credentials)
+    Settings = Struct.new(:authentication_scheme, :auth_test_mode)
+
+    def test_get_required_credentials_with_basic
+
+        username = 'name'
+        password = 'pass'
+        domain   = 'dom'
+        app      = App.new([
+            username,
+            password,
+            domain,
+        ])
+        settings = Settings.new(:basic)
+        vh       = VerbHandler.new(app, settings)
+
+        cr = vh.get_required_credentials
+
+        assert_kind_of Hash, cr
+        assert_equal username, cr[:username]
+        assert_equal password, cr[:password]
+        assert_equal domain,   cr[:domain]
+        assert_nil   cr[:impersonatee]
+    end
+
+    def test_get_required_credentials_with_basic_in_auth_test_mode
+
+        username = 'name'
+        password = 'pass'
+        domain   = 'dom'
+        app      = App.new([
+            username,
+            password,
+            domain,
+        ])
+        settings = Settings.new(:basic, true)
+        vh       = VerbHandler.new(app, settings)
+
+        cr = vh.get_required_credentials
+
+        assert_kind_of Hash, cr
+        assert_nil   cr[:username]
+        assert_nil   cr[:password]
+        assert_nil   cr[:domain]
+        assert_equal username, cr[:impersonatee]
+    end
+
+    def test_get_required_credentials_with_jwt
+
+        user_id    = 'name'
+        user_name  = 'Name'
+        session_id = 'session'
+        app        = App.new([
+            session_id,
+            user_id,
+            user_name,
+        ])
+        settings = Settings.new(:jwt)
+        vh       = VerbHandler.new(app, settings)
+
+        cr = vh.get_required_credentials
+
+        assert_kind_of Hash, cr
+        assert_equal session_id, cr[:session_id]
+        assert_equal user_id,    cr[:user_id]
+        assert_equal user_name,  cr[:user_name]
+        assert_nil   cr[:impersonatee]
+    end
+
+    def test_get_required_credentials_with_jwt_in_auth_test_mode
+
+        user_id    = 'name'
+        user_name  = 'Name'
+        session_id = 'session'
+        app        = App.new([
+            session_id,
+            user_id,
+            user_name,
+        ])
+        settings = Settings.new(:jwt)
+        vh       = VerbHandler.new(app, settings)
+
+        cr = vh.get_required_credentials
+
+        assert_kind_of Hash, cr
+        assert_equal session_id, cr[:session_id]
+        assert_equal user_id,    cr[:user_id]
+        assert_equal user_name,  cr[:user_name]
+        assert_nil   cr[:impersonatee]
+    end
+end
+
+# ############################## end of file ############################# #
+
+

data/test/unit/mixin/tc_razor_response_validator.rb

@@ -0,0 +1,328 @@
+# encoding: utf-8
+
+# ##########################################################################
+#
+# Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ##########################################################################
+
+# ##########################################################
+# load path
+
+$:.unshift File.join(File.dirname(__FILE__), *(['..'] * 3), 'lib')
+
+
+# ##########################################################
+# diagnostics
+
+require 'razor_risk/cassini/testing/suppress_pantheios_logging' unless $DEBUG
+
+
+# ##########################################################
+# code coverage
+
+require 'simplecov'
+
+
+# ##########################################################
+# requires
+
+require 'razor_risk/cassini/mixin/razor_response_validator'
+
+require 'xqsr3/extensions/test/unit'
+
+require 'test/unit'
+
+
+# ##########################################################
+# tests
+
+class Test_RazorResponseValidator < Test::Unit::TestCase
+
+    include ::RazorRisk::Cassini::Mixin
+
+    Reason           = Struct.new(:code, :message, :details)
+    Reasons          = Struct.new(:reasons) do
+        def lookup? code
+            reasons.select { |r| r.code == code }.first
+        end
+        def map &block
+            reasons.map(&block)
+        end
+        def empty?
+            reasons.empty?
+        end
+    end
+    FailureQualifier = Struct.new(:reasons)
+    QualifiedResult  = Struct.new(:succeeded?, :failure_qualifier)
+
+    def test_is_a_module
+
+        assert_kind_of Module, RazorResponseValidator
+    end
+
+    def test_has_required_methods
+
+        assert_respond_to(
+            RazorResponseValidator,
+            :validate_qualified_razor_response
+        )
+    end
+
+    def test_can_be_called_on_module
+
+        assert_nothing_raised do
+            RazorResponseValidator.validate_qualified_razor_response nil
+        end
+    end
+
+    def test_can_be_called_when_included
+
+        assert_nothing_raised do
+
+            app = Struct.new(:dummy) do
+                include RazorResponseValidator
+            end.new
+
+            app.validate_qualified_razor_response nil
+        end
+    end
+
+    def test_adds_custom_error_handler
+
+        app_class = Struct.new(:dummy) do
+
+            @error_handler_called = false
+
+            def self.error_handler_called
+                @error_handler_called
+            end
+
+            def self.error *args
+                @error_handler_called = true
+            end
+        end
+
+        assert_false app_class.error_handler_called
+        app_class.include RazorResponseValidator
+        assert_true app_class.error_handler_called
+    end
+
+    def test_validates_RZ0002
+
+        qr = QualifiedResult.new(
+            false,
+            FailureQualifier.new(
+                Reasons.new([
+                    Reason.new('RZ0002', 'test message', 'test details'),
+                    Reason.new('RZ0008', 'anther test message', 'another test details'),
+                ])
+            )
+        )
+
+        exp = RazorResponseValidator::RazorErrorException.new(
+            500,
+            'test message: test details',
+        )
+
+        begin
+            RazorResponseValidator.validate_qualified_razor_response qr
+        rescue => x
+            assert_equal exp.message, x.message
+            assert_equal exp.http_status, x.http_status
+        end
+    end
+
+    def test_validates_RZ0007
+
+        qr = QualifiedResult.new(
+            false,
+            FailureQualifier.new(
+                Reasons.new([
+                    Reason.new('RZ0007', 'test message', 'test details')
+                ])
+            )
+        )
+
+        exp = RazorResponseValidator::RazorErrorException.new(
+            401,
+            'Invalid credentials',
+        )
+
+        begin
+            RazorResponseValidator.validate_qualified_razor_response qr
+        rescue => x
+            assert_equal exp.message, x.message
+            assert_equal exp.http_status, x.http_status
+        end
+    end
+
+    def test_validates_RZ0008
+
+        qr = QualifiedResult.new(
+            false,
+            FailureQualifier.new(
+                Reasons.new([
+                    Reason.new('RZ0008', 'anther test message', 'another test details'),
+                ])
+            )
+        )
+
+        exp = RazorResponseValidator::RazorErrorException.new(
+            500,
+            'Oops! Something went wrong!',
+        )
+
+        begin
+            RazorResponseValidator.validate_qualified_razor_response qr
+        rescue => x
+            assert_equal exp.message, x.message
+            assert_equal exp.http_status, x.http_status
+        end
+    end
+
+    def test_validates_RZ0009
+
+        qr = QualifiedResult.new(
+            false,
+            FailureQualifier.new(
+                Reasons.new([
+                    Reason.new('RZ0009', 'test message', 'test details')
+                ])
+            )
+        )
+
+        exp = RazorResponseValidator::RazorErrorException.new(
+            401,
+            'Invalid credentials',
+        )
+
+        begin
+            RazorResponseValidator.validate_qualified_razor_response qr
+        rescue => x
+            assert_equal exp.message, x.message
+            assert_equal exp.http_status, x.http_status
+        end
+    end
+
+    def test_validates_RZ0010
+
+        qr = QualifiedResult.new(
+            false,
+            FailureQualifier.new(
+                Reasons.new([
+                    Reason.new('RZ0010', 'test message', 'test details'),
+                ])
+            )
+        )
+
+        exp = RazorResponseValidator::RazorErrorException.new(
+            400,
+            'test message: test details',
+        )
+
+        begin
+            RazorResponseValidator.validate_qualified_razor_response qr
+        rescue => x
+            assert_equal exp.message, x.message
+            assert_equal exp.http_status, x.http_status
+        end
+    end
+
+    def test_validates_RZ0011
+
+        qr = QualifiedResult.new(
+            false,
+            FailureQualifier.new(
+                Reasons.new([
+                    Reason.new('RZ0011', 'test message', 'test details')
+                ])
+            )
+        )
+
+        exp = RazorResponseValidator::RazorErrorException.new(
+            404,
+            'test message: test details',
+        )
+
+        begin
+            RazorResponseValidator.validate_qualified_razor_response qr
+        rescue => x
+            assert_equal exp.message, x.message
+            assert_equal exp.http_status, x.http_status
+        end
+    end
+
+    def test_validates_unsupported_error
+
+        qr = QualifiedResult.new(
+            false,
+            FailureQualifier.new(
+                Reasons.new([
+                    Reason.new('RZ0015', 'anther test message', 'another test details'),
+                ])
+            )
+        )
+
+        exp = RazorResponseValidator::RazorErrorException.new(
+            500,
+            'Oops! Something went wrong!',
+        )
+
+        begin
+            RazorResponseValidator.validate_qualified_razor_response qr
+        rescue => x
+            assert_equal exp.message, x.message
+            assert_equal exp.http_status, x.http_status
+        end
+    end
+
+    def test_handles_erros_in_correct_priority
+
+        reasons = [
+            Reason.new('RZ0007', 'RZ0007', 'RZ0007'),
+            Reason.new('RZ0009', 'RZ0009', 'RZ0009'),
+            Reason.new('RZ0002', 'RZ0002', 'RZ0002'),
+            Reason.new('RZ0011', 'RZ0011', 'RZ0011'),
+            Reason.new('RZ0010', 'RZ0010', 'RZ0010'),
+            Reason.new('RZ0008', 'RZ0008', 'RZ0008'),
+            Reason.new('RZ0015', 'RZ0015', 'RZ0015'),
+        ]
+
+        exp = [
+            [ 'RZ0007', 401, 'Invalid credentials' ],
+            [ 'RZ0009', 401, 'Invalid credentials' ],
+            [ 'RZ0002', 500, 'RZ0002: RZ0002' ],
+            [ 'RZ0011', 404, 'RZ0011: RZ0011' ],
+            [ 'RZ0010', 400, 'RZ0010: RZ0010' ],
+            [ 'RZ0008', 500, 'Oops! Something went wrong!' ],
+            [ 'RZ0015', 500, 'Oops! Something went wrong!' ],
+        ]
+
+        exp.each do |error, code, message|
+            qr = QualifiedResult.new(
+                false,
+                FailureQualifier.new(Reasons.new(reasons))
+            )
+            begin
+                RazorResponseValidator.validate_qualified_razor_response qr
+            rescue => x
+                assert_equal(
+                    code, x.http_status,
+                    "Expected #{error} to be handled"
+                )
+                assert_equal(
+                    message, x.message,
+                    "Expected #{error} to be handled"
+                )
+            end
+
+            reasons.shift
+        end
+    end
+end
+
+
+# ############################## end of file ############################# #
+
+