restful-capabilities 0.0.2

data/test/unit/microservice/tc_app.rb

@@ -0,0 +1,765 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+#############################################################################
+#
+#  Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+#############################################################################
+
+$:.unshift File.join(File.dirname(__FILE__), *(['..'] * 3), 'lib')
+
+ENV['APP_ENV'] = 'test'
+ENV['RZ_EXPOSE_MICROSERVICE_EXCEPTIONS'] = 'true'
+
+# ##########################################################
+# requires
+
+require 'razor_risk/cassini/testing/suppress_pantheios_logging' unless $DEBUG
+
+require 'razor_risk/cassini/applications/microservices/restful/capabilities/app'
+require 'razor_risk/razor/connectivity/test_doubles/razor_requester/raises_on_send'
+require 'razor_risk/razor/connectivity/test_doubles/razor_requester/returns_given_response'
+require 'razor_risk/razor/connectivity/razor_3/response'
+
+require 'rack/test'
+require 'test/unit'
+
+# ##########################################################
+# Tests
+
+class TestCapabilitiesApp < Test::Unit::TestCase
+
+    include ::Rack::Test::Methods
+
+    include ::RazorRisk::Cassini::Applications::Microservices::RESTful
+    include ::RazorRisk::Razor::Connectivity::TestDoubles::RazorRequester
+    include ::RazorRisk::Razor::Connectivity::Razor3
+    include ::RazorRisk::Razor::Connectivity::EntityConnectors::Exceptions
+
+    RazorEnv = 'env'
+
+    def app
+       Capabilities::CapabilitiesApp
+    end
+
+    def set_razor_response body, **options
+
+        doc = ::Nokogiri::XML::Builder.new do |xml|
+            xml.razorOutbound(
+                environment: RazorEnv,
+                request:     'select',
+                server:      'DataServer',
+            ) do
+                xml.requestReceivedTime  '2020-09-09 14:20:33.844'
+                xml.responseSentTime     '2019-09-09 14:20:33.911'
+                xml.responseReceivedTime '2019-09-09 14:20:33.917'
+                xml.returnCode           (options[:failed] ? 'nack' : 'ack')
+                xml.parent << ::Nokogiri.XML(body).root
+            end
+        end.doc
+
+        rsp = Response.new(doc)
+        rr  = ReturnsGivenResponse.new('conf', RazorEnv, given_response: rsp)
+
+        app.on_init_service(
+            razor_requester: rr,
+            request_options: options[:request_options],
+        )
+    end
+
+    def configure_app **opts
+        opts = {
+            host: 'localhost',
+            port: 5679,
+            authentication_scheme: 'none',
+            executable: 'abc',
+            razor_requester: nil,
+        }.merge(opts)
+
+        app.init_service(**opts)
+    end
+
+    def setup
+        configure_app
+    end
+end
+
+class TestCommon < TestCapabilitiesApp
+
+    # TODO: HEAD does the full razor request as if it is a GET, but returns
+    # empty. This is not ok and it must be changed not do the razor request.
+
+    # TODO: Currently cannot mock raising UnexpectedServerResponseException
+    # as due to restrictuions in RaisesOnSend exception must be a class.
+
+    Routes = {
+        'groups' => [ '/groups' ],
+        'group' => [ '/groups/id' ],
+        'users' => [ '/users' ],
+        'user' => [ '/users/-/id' ],
+        'group_users' => [ '/users/group_id' ],
+        'subjects' => [ '/subjects' ],
+        'subject' => [ '/subjects/id' ],
+        'data_subjects' => [ '/data-subjects' ],
+        'data_subject' => [ '/data-subjects/id' ],
+    }
+end
+
+class TestInvalidVerbs < TestCommon
+
+    InvalidVerbs = [ :post, :put, :delete, :options ]
+
+    InvalidVerbs.each do |verb|
+        Routes.each do |name, args|
+            define_method "test_#{verb}_#{name}" do
+                self.send(verb, *args)
+                assert_false last_response.ok?
+                assert_equal 404, last_response.status
+                assert_equal(
+                    "'#{args.first}' [#{verb.to_s.upcase}] not found",
+                    last_response.body
+                )
+            end
+        end
+    end
+end
+
+class TestHeaders < TestCommon
+
+    Routes.each do |name, args|
+        define_method "test_#{name}_invalid_accept_type" do
+            set_razor_response('<body/>')
+
+            header 'Accept', 'image/png'
+            get(*args)
+
+            assert_false last_response.ok?, last_response.body
+            assert_equal 406, last_response.status
+            assert_match(/invalid accept type/, last_response.body)
+        end
+
+        define_method "test_#{name}_invalid_accept_types" do
+            set_razor_response('<body/>')
+
+            header 'Accept', [ 'image/png', 'application/pdf' ]
+            get(*args)
+
+            assert_false last_response.ok?, last_response.body
+            assert_equal 406, last_response.status
+            assert_match(/invalid accept type/, last_response.body)
+        end
+
+        define_method "test_#{name}_valid_accept_type" do
+
+            set_razor_response(
+                '<body/>',
+                request_options: { validate: false }
+            )
+
+            header 'Accept', 'application/xml'
+            get(*args)
+
+            assert last_response.ok?, last_response.body
+            assert_equal 200, last_response.status
+            assert_match(
+                /application\/xml/,
+                last_response.headers['Content-Type']
+            )
+        end
+
+        define_method "test_#{name}_valid_accept_types" do
+
+            set_razor_response(
+                '<body/>',
+                request_options: { validate: false }
+            )
+
+            header 'Accept', [ 'application/json', 'application/xml' ]
+            get(*args)
+
+            assert last_response.ok?, last_response.body
+            assert_equal 200, last_response.status
+            assert_match(
+                /application\/xml/,
+                last_response.headers['Content-Type']
+            )
+        end
+
+        define_method "test_#{name}_mixed_accept_types" do
+
+            set_razor_response(
+                '<body/>',
+                request_options: { validate: false }
+            )
+
+            header 'Accept', [ 'application/pdf', 'application/xml' ]
+            get(*args)
+
+            assert last_response.ok?, last_response.body
+            assert_equal 200, last_response.status
+            assert_match(
+                /application\/xml/,
+                last_response.headers['Content-Type']
+            )
+        end
+
+        define_method "test_#{name}_application_xml_accept_types" do
+
+            set_razor_response(
+                '<body/>',
+                request_options: { validate: false }
+            )
+
+            header 'Accept', 'application/xml'
+            get(*args)
+
+            assert last_response.ok?, last_response.body
+            assert_equal 200, last_response.status
+            assert_match(
+                /application\/xml/,
+                last_response.headers['Content-Type']
+            )
+            assert_equal '<body/>', last_response.body
+        end
+
+        define_method "test_#{name}_text_xml_accept_types" do
+
+            set_razor_response(
+                '<body/>',
+                request_options: { validate: false }
+            )
+
+            header 'Accept', 'text/xml'
+            get(*args)
+
+            assert last_response.ok?, last_response.body
+            assert_equal 200, last_response.status
+            assert_match(
+                /text\/xml/,
+                last_response.headers['Content-Type']
+            )
+            assert_equal '<body/>', last_response.body
+        end
+
+        define_method "test_#{name}_application_json_accept_types" do
+
+            set_razor_response(
+                '<body/>',
+                request_options: { validate: false }
+            )
+
+            header 'Accept', 'application/json'
+            get(*args)
+
+            assert last_response.ok?, last_response.body
+            assert_equal 200, last_response.status
+            assert_match(
+                /application\/json/,
+                last_response.headers['Content-Type']
+            )
+            assert_equal '{"body":[]}', last_response.body
+        end
+    end
+end
+
+class TestJSONConversion < TestCommon
+
+    Routes.each do |name, args|
+
+        define_method "test_#{name}_json_uses_gdata_scheme" do
+
+            doc = ::Nokogiri::XML::Builder.new do |xml|
+                xml.body do
+                    xml.group 'value', id: 'group 1'
+                    xml.group id: 'group 2'
+                end
+            end.doc.root.to_xml
+            set_razor_response(doc, request_options: { validate: false })
+
+            exp_doc = {
+                'body' => {
+                    'group' => [
+                        { '$t' => 'value', 'id' => 'group 1' },
+                        { 'id' => 'group 2' }
+                    ]
+                }
+            }.to_json
+
+            header 'Accept', 'application/json'
+            get(*args)
+
+            assert last_response.ok?, last_response.body
+            assert_equal 200, last_response.status
+            assert_match(
+                /application\/json/,
+                last_response.headers['Content-Type']
+            )
+            assert_equal(
+                exp_doc,
+                last_response.body
+            )
+        end
+    end
+end
+
+class TestErrorHandling < TestCommon
+
+    Routes.each do |name, args|
+
+        define_method "test_#{name}_RZ0011_error" do
+            doc = ::Nokogiri::XML::Builder.new do |xml|
+                xml.errors do
+                    xml.error do
+                        xml.code 'RZ0011'
+                        xml.message 'This failed'
+                        xml.details 'This failed'
+                    end
+                end
+            end.doc.root.to_xml
+            set_razor_response doc, failed: true
+
+            get(*args)
+
+            assert_false last_response.ok?
+            assert_equal 404, last_response.status
+            assert_equal('This failed: This failed', last_response.body)
+        end
+
+        define_method "test_#{name}_razor_error" do
+            doc = ::Nokogiri::XML::Builder.new do |xml|
+                xml.body
+            end.doc.root.to_xml
+            set_razor_response doc, failed: true
+
+            get(*args)
+
+            assert_false last_response.ok?
+            assert_equal 500, last_response.status
+            assert_equal('Server Error', last_response.body)
+        end
+
+        define_method "test_#{name}_unknown_error" do
+
+            doc = '<body/>'
+            set_razor_response doc, failed: true
+
+            get(*args)
+
+            assert_false last_response.ok?
+            assert_equal 500, last_response.status
+            assert_equal('Server Error', last_response.body)
+        end
+    end
+end
+
+class TestGroups < TestCapabilitiesApp
+
+    def test_validates_xml
+
+        doc = '<body/>'
+        set_razor_response(doc)
+
+        get '/groups'
+
+        assert_false last_response.ok?, last_response.body
+        assert_equal 404, last_response.status
+        assert_equal('Capabilities not found', last_response.body)
+    end
+
+    def test_get
+
+        doc = ::Nokogiri::XML::Builder.new do |xml|
+            xml.body do
+                xml.group id: 'group 1'
+                xml.group id: 'group 2'
+            end
+        end.doc.root.to_xml
+        set_razor_response(doc)
+
+        get '/groups'
+        assert last_response.ok?
+        assert_equal 200, last_response.status
+        assert_equal doc, last_response.body
+    end
+end
+
+class TestGroup < TestCapabilitiesApp
+
+    def test_validates_xml
+
+        doc = ::Nokogiri::XML::Builder.new do |xml|
+            xml.body do
+                xml.capability id: 'cap 1'
+                xml.capability id: 'cap 2'
+            end
+        end.doc.root.to_xml
+        set_razor_response(doc)
+
+        get '/groups/id'
+
+        assert_false last_response.ok?, last_response.body
+        assert_equal 404, last_response.status
+        assert_equal('Capabilities not found', last_response.body)
+    end
+
+    def test_get
+
+        doc = ::Nokogiri::XML::Builder.new do |xml|
+            xml.body(id: 'id') do
+                xml.capability id: 'cap 1'
+                xml.capability id: 'cap 2'
+            end
+        end.doc.root.to_xml
+        set_razor_response(doc)
+
+        get '/groups/id'
+
+        assert last_response.ok?, last_response.body
+        assert_equal 200, last_response.status
+        assert_equal doc, last_response.body
+    end
+end
+
+class TestUsers < TestCapabilitiesApp
+
+    def test_validates_xml
+
+        doc = '<body/>'
+        set_razor_response(doc)
+
+        get '/users'
+
+        assert_false last_response.ok?, last_response.body
+        assert_equal 404, last_response.status
+        assert_equal('Capabilities not found', last_response.body)
+    end
+
+    def test_get
+
+        doc = ::Nokogiri::XML::Builder.new do |xml|
+            xml.body do
+                xml.user id: 'user 1' do
+                    xml.groups do
+                        xml.group id: 'group 1'
+                    end
+                end
+                xml.user id: 'user 2' do
+                    xml.groups do
+                        xml.group id: 'group 2'
+                    end
+                end
+            end
+        end.doc.root.to_xml
+        set_razor_response(doc)
+
+        get '/users'
+        assert last_response.ok?, last_response.body
+        assert_equal 200, last_response.status
+        assert_equal doc, last_response.body
+    end
+end
+
+class TestGroupUsers < TestCapabilitiesApp
+
+    def test_validates_xml
+
+        doc = '<body/>'
+        set_razor_response(doc)
+
+        get '/users/group_id'
+
+        assert_false last_response.ok?, last_response.body
+        assert_equal 404, last_response.status
+        assert_equal('Capabilities not found', last_response.body)
+    end
+
+    def test_validates_group_id
+
+        doc = ::Nokogiri::XML::Builder.new do |xml|
+            xml.body do
+                xml.user id: 'user 1' do
+                    xml.groups do
+                        xml.group id: 'group 1'
+                    end
+                end
+                xml.user id: 'user 2' do
+                    xml.groups do
+                        xml.group id: 'group 2'
+                    end
+                end
+            end
+        end.doc.root.to_xml
+        set_razor_response(doc)
+
+        get '/users/group%201'
+
+        assert_false last_response.ok?, last_response.body
+        assert_equal 500, last_response.status
+        assert_equal 'Server Error', last_response.body
+    end
+
+    def test_get
+
+        doc = ::Nokogiri::XML::Builder.new do |xml|
+            xml.body do
+                xml.user id: 'user 1' do
+                    xml.groups do
+                        xml.group id: 'group 1'
+                    end
+                end
+                xml.user id: 'user 2' do
+                    xml.groups do
+                        xml.group id: 'group 1'
+                    end
+                end
+            end
+        end.doc.root.to_xml
+        set_razor_response(doc)
+
+        get '/users/group%201'
+
+        assert last_response.ok?, last_response.body
+        assert_equal 200, last_response.status
+        assert_equal doc, last_response.body
+    end
+
+    def test_validates_multiple_group_ids
+
+        doc = ::Nokogiri::XML::Builder.new do |xml|
+            xml.body do
+                xml.user id: 'user 1' do
+                    xml.groups do
+                        xml.group id: 'group 2'
+                    end
+                end
+                xml.user id: 'user 2' do
+                    xml.groups do
+                        xml.group id: 'group 1'
+                        xml.group id: 'group 2'
+                    end
+                end
+            end
+        end.doc.root.to_xml
+        set_razor_response(doc)
+
+        get '/users/group%202'
+
+        assert last_response.ok?, last_response.body
+        assert_equal 200, last_response.status
+        assert_equal doc, last_response.body
+    end
+
+    def test_case_sensitive_validation
+
+        doc = ::Nokogiri::XML::Builder.new do |xml|
+            xml.body do
+                xml.user id: 'user 1' do
+                    xml.groups do
+                        xml.group id: 'Group 1'
+                    end
+                end
+                xml.user id: 'user 2' do
+                    xml.groups do
+                        xml.group id: 'group 1'
+                    end
+                end
+            end
+        end.doc.root.to_xml
+        set_razor_response(doc)
+
+        get '/users/group%201'
+
+        assert_false last_response.ok?, last_response.body
+        assert_equal 500, last_response.status
+        assert_equal 'Server Error', last_response.body
+    end
+end
+
+class TestUser < TestCapabilitiesApp
+
+    def test_validates_xml
+
+        doc = ::Nokogiri::XML::Builder.new do |xml|
+            xml.body id: 'id1' do
+                xml.groups do
+                    xml.group id: 'group 2'
+                end
+            end
+        end.doc.root.to_xml
+        set_razor_response(doc)
+
+        get '/users/-/id'
+
+        assert_false last_response.ok?, last_response.body
+        assert_equal 404, last_response.status
+        assert_equal('Capabilities not found', last_response.body)
+    end
+
+    def test_get
+
+        doc = ::Nokogiri::XML::Builder.new do |xml|
+            xml.body id: 'id' do
+                xml.groups do
+                    xml.group id: 'group 2'
+                end
+            end
+        end.doc.root.to_xml
+        set_razor_response(doc)
+
+        get '/users/-/id'
+
+        assert last_response.ok?, last_response.body
+        assert_equal 200, last_response.status
+        assert_equal doc, last_response.body
+    end
+end
+
+class TestSubjects < TestCapabilitiesApp
+
+    def test_validates_xml
+
+        doc = '<body/>'
+        set_razor_response(doc)
+
+        get '/subjects'
+
+        assert_false last_response.ok?, last_response.body
+        assert_equal 404, last_response.status
+        assert_equal('Capabilities not found', last_response.body)
+    end
+
+    def test_get
+
+        doc = ::Nokogiri::XML::Builder.new do |xml|
+            xml.body do
+                xml.subject name: 'subject1' do
+                    xml.action name: 'action1', code: 'a1'
+                end
+                xml.subject name: 'subject2' do
+                    xml.action name: 'action2', code: 'a2'
+                end
+            end
+        end.doc.root.to_xml
+        set_razor_response(doc)
+
+        get '/subjects'
+        assert last_response.ok?, last_response.body
+        assert_equal 200, last_response.status
+        assert_equal doc, last_response.body
+    end
+end
+
+class TestSubject < TestCapabilitiesApp
+
+    def test_validates_xml
+
+        doc = ::Nokogiri::XML::Builder.new do |xml|
+            xml.body name: 'name1' do
+                xml.action name: 'action1', code: 'a1'
+                xml.action name: 'action2', code: 'a2'
+            end
+        end.doc.root.to_xml
+        set_razor_response(doc)
+
+        get '/subjects/name'
+
+        assert_false last_response.ok?, last_response.body
+        assert_equal 404, last_response.status
+        assert_equal('Capabilities not found', last_response.body)
+    end
+
+    def test_get
+
+        doc = ::Nokogiri::XML::Builder.new do |xml|
+            xml.body name: 'name' do
+                xml.action name: 'action1', code: 'a1'
+                xml.action name: 'action2', code: 'a2'
+            end
+        end.doc.root.to_xml
+        set_razor_response(doc)
+
+        get '/subjects/name'
+
+        assert last_response.ok?, last_response.body
+        assert_equal 200, last_response.status
+        assert_equal doc, last_response.body
+    end
+end
+
+class TestDataSubjects < TestCapabilitiesApp
+
+    def test_validates_xml
+
+        doc = '<body/>'
+        set_razor_response(doc)
+
+        get '/data-subjects'
+
+        assert_false last_response.ok?, last_response.body
+        assert_equal 404, last_response.status
+        assert_equal('Capabilities not found', last_response.body)
+    end
+
+    def test_get
+
+        doc = ::Nokogiri::XML::Builder.new do |xml|
+            xml.body do
+                xml.dataSubject name: 'subject1' do
+                    xml.dataAction name: 'action1', code: 'a1'
+                end
+                xml.dataSubject name: 'subject2' do
+                    xml.dataAction name: 'action2', code: 'a2'
+                end
+            end
+        end.doc.root.to_xml
+        set_razor_response(doc)
+
+        get '/data-subjects'
+
+        assert last_response.ok?, last_response.body
+        assert_equal 200, last_response.status
+        assert_equal doc, last_response.body
+    end
+end
+
+class TestDataSubject < TestCapabilitiesApp
+
+    def test_validates_xml
+
+        doc = ::Nokogiri::XML::Builder.new do |xml|
+            xml.body name: 'name1' do
+                xml.dataAction name: 'action1', code: 'a1'
+                xml.dataAction name: 'action2', code: 'a2'
+            end
+        end.doc.root.to_xml
+        set_razor_response(doc)
+
+        get '/data-subjects/name'
+
+        assert_false last_response.ok?, last_response.body
+        assert_equal 404, last_response.status
+        assert_equal('Capabilities not found', last_response.body)
+    end
+
+    def test_get
+
+        doc = ::Nokogiri::XML::Builder.new do |xml|
+            xml.body name: 'name' do
+                xml.dataAction name: 'action1', code: 'a1'
+                xml.dataAction name: 'action2', code: 'a2'
+            end
+        end.doc.root.to_xml
+        set_razor_response(doc)
+
+        get '/data-subjects/name'
+
+        assert last_response.ok?, last_response.body
+        assert_equal 200, last_response.status
+        assert_equal doc, last_response.body
+    end
+end
+
+# ############################## end of file ############################# #
+
+